Skip to main content

Introduction

Overview

The Control Room REST API enables seamless integration with the IntelliBuddies Control Room via simple HTTP requests. It offers robust management capabilities, ensuring smooth interaction and control over account-related operations.

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

EndpointsDescription
Get API KeyGenerates a new API key for accessing the API.
Create UserCreate users by setting appropriate roles.
Get Process DefinitionGetting Process Definition by providing the Process Name.
Create Process InstanceGetting Process Instance by providing the Process Name.
Get Task IdGetting the Task Id by providing the Process Instance.
Complete TaskCompleting the Task by providing the Task Id.
Create Environment VariableCreate users by setting appropriate roles.