Execute an integration (automation) in an account
POST /accounts/{account_externalid_or_guid}/blends/{blend_name_or_guid}/run
Executes an integration (automation) in a customer account. This creates a run (job) of the integration.
Note that you can reference the automation by its guid, or by its name. This makes it possible to find
automations in multiple accounts, by using unique pre-defined names for automations.
Note that integrations can also be executed in other ways: automations can be scheduled, they can be triggered through a webhook, or they can be executed manually from the Qlik Application Automation for OEM Admin backend.
Use async=false (default) to execute the automation synchronously, which means the API call will wait for the automation to finish, and the automation response will be the response of the API call. When async=true, the API call will create the job but will not wait for the automation to finish, so the automation response will not be available. The async
parameter can be added in the querystring or in the POST body (see example below).
If the automation has input parameters, add them in the POST body. Example POST body:
{
"async": true,
"inputs": {
"inputname1": "value1",
"inputname2": "value2"
}
}
Query Parameters
| Name | Description | Type |
|---|---|---|
| async | Optional, default is false. Set to true to execute the automation asynchronously. Can be in querystring or in post body. | boolean |
Path Parameters
| Name | Description | Type |
|---|---|---|
| account_externalid_or_guid | External id or guid of the customer account | string |
| blend_name_or_guid | Name or guid of the automation to be executed inside the given customer account | string |
Body Parameters
| Name | Description | Type |
|---|---|---|
| Inputs | Input parameters | json |
Examples
{
"async": true,
"inputs": {
"input_param1": "some value",
"input_param2": "some value"
}
}
Results
200
{}
400
{}
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!