Task Engine | Qntrl | Bridge | Online Help | Execute API's hosted in private network

Task Engine

In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in Bridge can be utilized in the following two modules within Qntrl.

  1. API Lookup fieldSearch for specific information in a large amount of API response data and extract the desired information. Check API Lookup for more details. 
  2. Circuit - Within the Circuit workflow, the Task Engine is utilized to execute tasks that necessitate access to APIs within a restricted environment. Check Task Engine for more details. 
Prerequisite

While creating Credentials for Task Engine, choose the credential type as API key or OAuth 2.0Click here to learn how to create a credential.

 

Request data  

{
    "task_name": "api_task",
    "credential": {
          "name": "<CREDENTIAL_NAME>"
     },
     "task_details": {
          "method": "<METHOD_NAME>",
          "url": "<API_URL>",
          "parameters" : {
                 "<PARAMETER_NAME>" : "<PARAMETER_VALUE>"
          },
          "headers" : {
                 "<HEADERS_NAME>" : "<HEADERS_VALUE>"
          }
    }
}

where,
Keys
Description
 task_name
 
A system-defined name for the respective modules. 'api_task' is the task name for
Task Engine.
 credential
 
 JSON object that contains the name of the API credential. 
 name
 (optional)
 Name of the API credential.
 task_details
 A JSON object that contains details of the task.
 method
 API method used - GET/POST/DELETE.
 URL
 API URL to be invoked.
 parameters
 (optional)
 JSON that contains the name and values of API parameter.
 headers
 (optional)
 JSON object that contains header name and values for API.