Skip to content

API

Introduction

Intellibot Orchestrator APIs are specifically designed to integrate with a wide range of systems like ERP, BPM or any 3rd party systems via RESTful (REST) services. This guide helps you to understand how to access and control resources available within the Orchestrator interface.

Supported Functions

Intellibot provides three basic APIs that assist in communicating, controlling and monitoring the robots.

  1. Start Process – This API triggers the robot to start executing the configured process.

  2. Create Work Item – This API call is used to insert work item into the Intellibot Orchestrator work queue and is deployed to send information to the robot that is going to process the work item. Note that this API call is optional and is required only when we want to send any information to the robot. The automation has to be designed to fetch this information from the Intellibot Orchestrator work queue while execution.

  3. Get Work Item – This API is used to check the status of the work item that was inserted into the Intellibot Orchestrator work queue.

API Functions

Start Process

  1. Users can start a process by calling this API. Intellibot Orchestrator API uses a RESTful web service endpoint to provide users with the ability to start a process. This simple API allows our users to initiate the process remotely.
  2. Start Process method allows users to trigger a process by using the specific Process ID.

    Make a POST request to the https://orchestrator.intellibot.io/api/RobotAPI/Start URL with the following parameter:

    1. ProcessId: The processId of the specific process can be copied from the Details tab in Orchestrator as shown below.

      Screenshot

Example

  1. If the user gives the correct ProcessId and the state of the robot is available then the robot gets started successfully and "Robot started" is received in the response as shown below. The state of a Robot can be checked in orchestrator for a particular process and the state of the Robot should be available.

    POST https://orchestrator.intellibot.io/api/RobotAPI/Start
    REQUEST { "processId":"db3386e511.." }
    RESPONSE { "result":"success", "message":"Robot started. #Robot Robot_Name."}

    Screenshot

  2. If the user gives the correct processId and the state of the Robot is disconnected then "Robot was disconnected" is received in the response as shown below. The state of a Robot can be checked in orchestrator for a particular process. Screenshot

Create Work Item

  1. Intellibot Orchestrator API allows users to Create a work Item remotely.
  2. User should initiate the API to add and execute the defined work item content to the specified queue.
  3. Create work item method allows users to create a work item by providing the Process ID, Queue Name and Content. Work item content is stored as string, and can contain plain text, XML or JSON schema. This content can be accessed by the robot during execution.
  4. This API call is optional and should be used only if the application calling the API needs to send data to the robot.

    Make a POST request to the https://orchestrator.intellibot.io/api/v2/RobotAPI/CreateWorkItem URL with the following parameters:

    1. ProcessId: The processId of the specific process can be copied from the Details tab in Orchestrator as shown earlier.

    2. QueueName: The Queue Name of a required process can be copied from the Queues tab in Orchestrator as shown below. Screenshot

    3. RequestContent: The RequestContent is the input for a work item that can contain plain text, XML, or JSON schema as required.

Example

  1. If the user gives the correct ProcessId, and QueueName which already exists in Orchestrator then the work item gets created successfully as shown below.

    POST https://orchestrator.intellibot.io/api/v2/RobotAPI/CreateWorkItem
    REQUEST { "processId":"db3386e511..", "queueName":"...................", "requestContent":"................." }
    RESPONSE { "result":"success", "workItemId":"db3e5555.....", "message":"Workitem created successfully." }

    Screenshot

    2. If the user gives the incorrect ProcessId and/or QueueName which does not exist in Orchestrator then we get an error as the result. Below is an example where QueueName is passed empty and an error occurred when trying to create a work item.

    Screenshot

Get Work Item

  1. User should initiate the API to fetch the status of each work item post-execution.
  2. Using the Get Work Item method users can collect status of the work items, to check if work items have been processed successfully, or if any exception thrown. This will help the user to find reasons for work item failure.
  3. Get work item method allows users to fetch the status of processed work items by using the specific Process ID and work item ID.
  4. Work item added under a specific queue will show status as Pending once created, In Progress when the robot picks the work item for processing, and Success or Failed post-execution. The status for each work item can be checked using the Work Item ID and Get Work Item method.

    Make a POST request to the https://orchestrator.intellibot.io/api/v2/RobotAPI/GetWorkItem URL with the following parameters:

    1. ProcessId: The processId of the specific process can be copied from the Details tab in Orchestrator as shown earlier.

    2. WorkitemId: The WorkitemId of a specific work item is received in the output when Work item is created as shown below. Screenshot

Example:

  1. If the user gives the correct processId and/or WorkItemId which already exists in the Orchestrator for a particular process then the below-shown response is received.

    POST https://orchestrator.intellibot.io/api/v2/RobotAPI/GetWorkItem
    REQUEST { "processId":"db3386e511..", "workItemId":"d7537b3..........."}
    RESPONSE { "result":"success", "workItem":{ "RequestContent":"...............", "ResponseContent":null, "StartedOn":null, "CompletedOn":null, "Status":"Pending" }, "message":"" }

  2. If the user gives the incorrect ProcessId and/or WorkItemId then the following error response is displayed as shown below.
    Screenshot