Skip to main content

Introduction

Overview​

This REST API enables seamless integration of your application with the IntelliBuddies Control Room using straightforward HTTP requests. It provides streamlined management functionality, allowing for efficient interaction and control.

Base URL​

The base URL for all API endpoints is:

http://<Control Room server>/api

Authentication​

Authentication is required for accessing endpoints. Authentication is done via the API key.

APIs Information​

The below table gives the list of all APIs and their usage

| Endpoints | Description |   | --------------- | --------------- |   | Get API Key | Generates a new API key for accessing the API. | | Create User | Create users by setting appropriate roles. | | Get Process Definition | Getting Process Definition by providing the Process Name. | | Create Process Instance | Getting Process Instance by providing the Process Name. | | Get Task Id | Getting the Task Id by providing the Process Instance. | | Complete Task | Completing the Task by providing the Task Id. | | Create Environment Variable | Create users by setting appropriate roles. | |||