# Automations
**Base URL:** `https://{tenant}.{region}.qlikcloud.com`
Automations in Qlik Automate are no-code workflows which connect applications together.
## Table of Contents
| Method | Path | Description |
|--------|------|-------------|
| `GET` | [`/api/workflows/automations`](#get-apiworkflowsautomations) | Retrieves a list of the automations that the requesting user has access to. |
| `POST` | [`/api/workflows/automations`](#post-apiworkflowsautomations) | Creates a new automation. The requesting user must be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`. |
| `GET` | [`/api/workflows/automations/{id}`](#get-apiworkflowsautomationsid) | Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: `AutomationsCreator`, `TenantAdmin` or have at least one of the following scopes (depending on whether the automation is in a private or shared space): `automations`, `automations.private` or `automations.shared`. |
| `PUT` | [`/api/workflows/automations/{id}`](#put-apiworkflowsautomationsid) | Updates the full definition of an automation. The requesting user must be the owner of the automation and either be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`. |
| `DELETE` | [`/api/workflows/automations/{id}`](#delete-apiworkflowsautomationsid) | Deletes an automation. The requesting user must meet at least one of the following conditions: |
| `POST` | [`/api/workflows/automations/{id}/actions/change-owner`](#post-apiworkflowsautomationsidactionschange-owner) | Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`. |
| `POST` | [`/api/workflows/automations/{id}/actions/change-space`](#post-apiworkflowsautomationsidactionschange-space) | Changes the space of an automation by specifying a new space. |
| `POST` | [`/api/workflows/automations/{id}/actions/copy`](#post-apiworkflowsautomationsidactionscopy) | Duplicates an existing automation. The requesting user must be the owner of the automation or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`. |
| `POST` | [`/api/workflows/automations/{id}/actions/disable`](#post-apiworkflowsautomationsidactionsdisable) | Disables an automation so that it cannot be run. To disable an automation, the requesting user must meet at least one of the following conditions: |
| `POST` | [`/api/workflows/automations/{id}/actions/enable`](#post-apiworkflowsautomationsidactionsenable) | Enables an automation so that it can be run. To enable an automation, the requesting user must meet at least one of the following conditions: |
| `POST` | [`/api/workflows/automations/{id}/actions/move`](#post-apiworkflowsautomationsidactionsmove) | Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`. |
| `GET` | [`/api/workflows/automations/{id}/runs`](#get-apiworkflowsautomationsidruns) | Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the one of roles: `TenantAdmin`, `AnalyticsAdmin`. Alternatively, the user must have at least one of the following scopes: `admin.automation-runs`, `automation-runs.private`, or `automation-runs.shared`. |
| `POST` | [`/api/workflows/automations/{id}/runs`](#post-apiworkflowsautomationsidruns) | Creates a run for a specific automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement: |
| `GET` | [`/api/workflows/automations/{id}/runs/{runId}`](#get-apiworkflowsautomationsidrunsrunid) | Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement: |
| `POST` | [`/api/workflows/automations/{id}/runs/{runId}/actions/export`](#post-apiworkflowsautomationsidrunsrunidactionsexport) | Retrieves the URL for the debug log of a specific automation run. Depending on the space the automation belongs to, the requesting user must meet the following requirement: |
| `POST` | [`/api/workflows/automations/{id}/runs/{runId}/actions/retry`](#post-apiworkflowsautomationsidrunsrunidactionsretry) | Retries a specific run by creating a new run using the same inputs. Depending on the space the automation belongs to, the requesting user must meet the following requirement: |
| `POST` | [`/api/workflows/automations/{id}/runs/{runId}/actions/stop`](#post-apiworkflowsautomationsidrunsrunidactionsstop) | Forcefully stops an automation run immediately. Depending on the space the automation belongs to, the requesting user must meet the following requirement: |
| `GET` | [`/api/workflows/automations/{id}/runs/{runId}/debug`](#get-apiworkflowsautomationsidrunsruniddebug) | Retrieves the debug log for a specific run of an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement: |
| `GET` | [`/api/workflows/automations/settings`](#get-apiworkflowsautomationssettings) | Retrieves the global automation settings for the tenant. |
| `PUT` | [`/api/workflows/automations/settings`](#put-apiworkflowsautomationssettings) | Updates the global automation settings for the tenant. |
| `GET` | [`/api/workflows/automations/usage`](#get-apiworkflowsautomationsusage) | Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` or `AnalyticsAdmin` role. |
## API Reference
### GET /api/workflows/automations
Retrieves a list of the automations that the requesting user has access to.
- **Replaces:** "GET:/v1/automations"
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Query Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `cursor` | string | No | Pagination cursor returned from a previous request. |
| `filter` | string | No | Allowed filters: `name`, `runMode`, `lastRunStatus`, `ownerId`, `spaceId`. |
| `limit` | integer | No | The number of automations to retrieve. |
| `listAll` | boolean | No | When true, list all automations. Restricted to tenant admins and analytics admins. |
| `sort` | string | No | The field to sort by, with +- prefix indicating sort order. (`?sort=-name` => sort on the `name` field using descending order). Enum: "id", "name", "runMode", "state", "createdAt", "updatedAt", "lastRunAt", "lastRunStatus", "+id", "+name", "+runMode", "+state", "+createdAt", "+updatedAt", "+lastRunAt", "+lastRunStatus", "-id", "-name", "-runMode", "-state", "-createdAt", "-updatedAt", "-lastRunAt", "-lastRunStatus", "maxConcurrentRuns", "+maxConcurrentRuns", "-maxConcurrentRuns" |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No | |
| `links` | object | No | |
Properties of `data`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier for the automation. |
| `name` | string | No | The name of the automation. |
| `state` | string | No | The state of the automation. Enum: "available", "unavailable", "disabled" |
| `lastRun` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation. |
| `runMode` | string | No | Defines how the automation run is started. Enum: "manual", "scheduled", "triggered", "webhook" |
| `spaceId` | string | No | The unique identifier of the space that contains the automation. |
| `duration` | integer | No | Duration of the last run, indicated in seconds. Calculated from start and stop times. |
| `createdAt` | string | No | |
| `lastRunAt` | string | No | The date and time when the last automation run was finished. |
| `updatedAt` | string | No | |
| `workspace` | object | No | The workspace contains the JSON representation of the used blocks |
| `snippetIds` | string[] | No | A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `description` | string | No | The description of the automation. |
| `endpointIds` | string[] | No | A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed. |
| `connectorIds` | string[] | No | A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed. |
| `lastRunStatus` | string | No | The status of the last run of the automation. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "paused", "running", "starting", "stopped", "exceeded limit" |
| `executionToken` | string | No | Execution token required to authorize the execution of the automation. |
| `maxConcurrentRuns` | integer | No | Maximum number of concurrent runs allowed for automation. |
Properties of `lastRun`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier of the run. |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `metrics` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `metrics`
_Properties truncated due to depth limit._
Properties of `links`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No | |
| `prev` | object | No | |
Properties of `next`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No | The URL to a resource request |
Properties of `prev`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No | The URL to a resource request |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations" \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"data": [
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"name": "string",
"state": "available",
"lastRun": {
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40,
"snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
}
],
"network": {
"rxBytes": 0,
"txBytes": 0
},
"totalApiCalls": 0
},
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
},
"ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
"runMode": "triggered",
"spaceId": "5f0f78b239ff4f0001234567",
"duration": "9001",
"createdAt": "2021-12-23T12:28:21.000000Z",
"lastRunAt": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"workspace": {},
"snippetIds": [
"e0e720d0-4947-11ec-a1d2-9559fa35801d"
],
"description": "string",
"endpointIds": [
"9d94bef0-b28c-11eb-8dba-01593c457362",
"53a6fb70-b28f-11eb-b601-b545a40867e0"
],
"connectorIds": [
"0d87808f-27c0-11ea-921c-022e6b5ea1e2",
"0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
],
"lastRunStatus": "finished",
"executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
"maxConcurrentRuns": 10
}
],
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
}
}
}
```
---
### POST /api/workflows/automations
Creates a new automation. The requesting user must be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
- **Replaces:** "POST:/v1/automations"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Request Body
**Required**
Automation object to create
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | The name of the automation. |
| `spaceId` | string | No | The unique identifier of the space in which the automation is created. |
| `schedules` | object[] | No | |
| `workspace` | object | No | The workspace generated by the Qlik Automate editor. |
| `description` | string | No | The description of the automation |
| `maxConcurrentRuns` | integer | No | Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings. |
Properties of `schedules`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `stopAt` | string | No | The date and time until the schedule is active. |
| `startAt` | string | No | The date and time when the schedule becomes active. |
| `interval` | integer | No | time in seconds. |
| `timezone` | string | No | The timezone applied to the start and end times. |
#### Responses
##### 201
Created
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `name` | string | No | The name of the automation. |
| `state` | string | No | The state of the automation. Enum: "available", "unavailable", "disabled" |
| `lastRun` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation. |
| `runMode` | string | No | Defines how the automation run is started. Enum: "manual", "scheduled", "triggered", "webhook" |
| `spaceId` | string | No | The unique identifier of the space that contains the automation. |
| `createdAt` | string | No | |
| `lastRunAt` | string | No | The date and time when the last automation run was finished. |
| `schedules` | object[] | No | |
| `updatedAt` | string | No | |
| `workspace` | object | No | The workspace generated by the Qlik Automate editor. |
| `snippetIds` | string[] | No | A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `description` | string | No | The description of the automation. |
| `endpointIds` | string[] | No | A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `connectorIds` | string[] | No | A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `lastRunStatus` | string | No | The status of the last run of the automation. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "paused", "running", "starting", "stopped", "exceeded limit" |
| `executionToken` | string | No | Execution token required to authorize the execution of the automation. |
| `maxConcurrentRuns` | integer | No | Maximum number of concurrent runs allowed for this automation. |
Properties of `lastRun`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier of the run. |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `metrics` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `metrics`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `blocks` | object[] | No | List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks |
| `network` | object | No | |
| `totalApiCalls` | integer | No | The number of API calls made. |
Properties of `blocks`
_Properties truncated due to depth limit._
Properties of `network`
_Properties truncated due to depth limit._
Properties of `schedules`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `stopAt` | string | No | |
| `startAt` | string | No | |
| `interval` | integer | No | time in seconds. |
| `timezone` | string | No | |
| `lastStartedAt` | string | No | |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'My automation',
spaceId: '5f0f78b239ff4f0001234567',
schedules: [
{
stopAt: '2022-12-01 00:00:00',
startAt: '2022-01-01 00:00:00',
interval: 30,
timezone: 'Europe/Stockholm',
},
],
workspace: {},
description: '',
maxConcurrentRuns: 1,
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"name":"My automation","spaceId":"5f0f78b239ff4f0001234567","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}],"workspace":{},"description":"","maxConcurrentRuns":1}'
```
**Example Response:**
```json
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"name": "string",
"state": "available",
"lastRun": {
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40,
"snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
}
],
"network": {
"rxBytes": 0,
"txBytes": 0
},
"totalApiCalls": 0
},
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
},
"ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
"runMode": "triggered",
"spaceId": "5f0f78b239ff4f0001234567",
"createdAt": "2021-12-23T12:28:21.000000Z",
"lastRunAt": "2021-12-23T12:28:21.000000Z",
"schedules": [
{
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"stopAt": "2022-12-01 00:00:00",
"startAt": "2021-12-01 00:00:00",
"interval": 30,
"timezone": "Europe/Stockholm",
"lastStartedAt": "2022-01-01T12:28:21.000000Z"
}
],
"updatedAt": "2021-12-23T12:28:21.000000Z",
"workspace": {},
"snippetIds": [
"e0e720d0-4947-11ec-a1d2-9559fa35801d"
],
"description": "string",
"endpointIds": [
"9d94bef0-b28c-11eb-8dba-01593c457362",
"53a6fb70-b28f-11eb-b601-b545a40867e0"
],
"connectorIds": [
"0d87808f-27c0-11ea-921c-022e6b5ea1e2",
"0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
],
"lastRunStatus": "finished",
"executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
"maxConcurrentRuns": 10
}
```
---
### GET /api/workflows/automations/{id}
Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: `AutomationsCreator`, `TenantAdmin` or have at least one of the following scopes (depending on whether the automation is in a private or shared space): `automations`, `automations.private` or `automations.shared`.
- **Replaces:** "GET:/v1/automations/{id}"
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `name` | string | No | The name of the automation. |
| `state` | string | No | The state of the automation. Enum: "available", "unavailable", "disabled" |
| `lastRun` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation. |
| `runMode` | string | No | Defines how the automation run is started. Enum: "manual", "scheduled", "triggered", "webhook" |
| `spaceId` | string | No | The unique identifier of the space that contains the automation. |
| `createdAt` | string | No | |
| `lastRunAt` | string | No | The date and time when the last automation run was finished. |
| `schedules` | object[] | No | |
| `updatedAt` | string | No | |
| `workspace` | object | No | The workspace generated by the Qlik Automate editor. |
| `snippetIds` | string[] | No | A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `description` | string | No | The description of the automation. |
| `endpointIds` | string[] | No | A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `connectorIds` | string[] | No | A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `lastRunStatus` | string | No | The status of the last run of the automation. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "paused", "running", "starting", "stopped", "exceeded limit" |
| `executionToken` | string | No | Execution token required to authorize the execution of the automation. |
| `maxConcurrentRuns` | integer | No | Maximum number of concurrent runs allowed for this automation. |
Properties of `lastRun`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier of the run. |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `metrics` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `metrics`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `blocks` | object[] | No | List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks |
| `network` | object | No | |
| `totalApiCalls` | integer | No | The number of API calls made. |
Properties of `blocks`
_Properties truncated due to depth limit._
Properties of `network`
_Properties truncated due to depth limit._
Properties of `schedules`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `stopAt` | string | No | |
| `startAt` | string | No | |
| `interval` | integer | No | time in seconds. |
| `timezone` | string | No | |
| `lastStartedAt` | string | No | |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations/{id}` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}" \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"name": "string",
"state": "available",
"lastRun": {
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40,
"snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
}
],
"network": {
"rxBytes": 0,
"txBytes": 0
},
"totalApiCalls": 0
},
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
},
"ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
"runMode": "triggered",
"spaceId": "5f0f78b239ff4f0001234567",
"createdAt": "2021-12-23T12:28:21.000000Z",
"lastRunAt": "2021-12-23T12:28:21.000000Z",
"schedules": [
{
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"stopAt": "2022-12-01 00:00:00",
"startAt": "2021-12-01 00:00:00",
"interval": 30,
"timezone": "Europe/Stockholm",
"lastStartedAt": "2022-01-01T12:28:21.000000Z"
}
],
"updatedAt": "2021-12-23T12:28:21.000000Z",
"workspace": {},
"snippetIds": [
"e0e720d0-4947-11ec-a1d2-9559fa35801d"
],
"description": "string",
"endpointIds": [
"9d94bef0-b28c-11eb-8dba-01593c457362",
"53a6fb70-b28f-11eb-b601-b545a40867e0"
],
"connectorIds": [
"0d87808f-27c0-11ea-921c-022e6b5ea1e2",
"0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
],
"lastRunStatus": "finished",
"executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
"maxConcurrentRuns": 10
}
```
---
### PUT /api/workflows/automations/{id}
Updates the full definition of an automation. The requesting user must be the owner of the automation and either be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
- **Replaces:** "PUT:/v1/automations/{id}"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Request Body
**Required**
Automation object to update
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | The name of the automation. |
| `schedules` | object[] | No | |
| `workspace` | object | No | The workspace generated by the Qlik Automate editor. |
| `description` | string | No | The description of the automation |
| `maxConcurrentRuns` | integer | No | Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings. |
Properties of `schedules`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `stopAt` | string | No | The date and time until the schedule is active. |
| `startAt` | string | No | The date and time when the schedule becomes active. |
| `interval` | integer | No | time in seconds. |
| `timezone` | string | No | The timezone applied to the start and end times. |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `name` | string | No | The name of the automation. |
| `state` | string | No | The state of the automation. Enum: "available", "unavailable", "disabled" |
| `lastRun` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation. |
| `runMode` | string | No | Defines how the automation run is started. Enum: "manual", "scheduled", "triggered", "webhook" |
| `spaceId` | string | No | The unique identifier of the space that contains the automation. |
| `createdAt` | string | No | |
| `lastRunAt` | string | No | The date and time when the last automation run was finished. |
| `schedules` | object[] | No | |
| `updatedAt` | string | No | |
| `workspace` | object | No | The workspace generated by the Qlik Automate editor. |
| `snippetIds` | string[] | No | A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `description` | string | No | The description of the automation. |
| `endpointIds` | string[] | No | A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `connectorIds` | string[] | No | A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. |
| `lastRunStatus` | string | No | The status of the last run of the automation. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "paused", "running", "starting", "stopped", "exceeded limit" |
| `executionToken` | string | No | Execution token required to authorize the execution of the automation. |
| `maxConcurrentRuns` | integer | No | Maximum number of concurrent runs allowed for this automation. |
Properties of `lastRun`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier of the run. |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `metrics` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `metrics`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `blocks` | object[] | No | List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks |
| `network` | object | No | |
| `totalApiCalls` | integer | No | The number of API calls made. |
Properties of `blocks`
_Properties truncated due to depth limit._
Properties of `network`
_Properties truncated due to depth limit._
Properties of `schedules`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `stopAt` | string | No | |
| `startAt` | string | No | |
| `interval` | integer | No | time in seconds. |
| `timezone` | string | No | |
| `lastStartedAt` | string | No | |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 409
Conflict with the current state of the resource
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `PUT /api/workflows/automations/{id}` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}',
{
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'My automation',
schedules: [
{
stopAt: '2022-12-01 00:00:00',
startAt: '2022-01-01 00:00:00',
interval: 30,
timezone: 'Europe/Stockholm',
},
],
workspace: {},
description: '',
maxConcurrentRuns: 1,
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"name":"My automation","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}],"workspace":{},"description":"","maxConcurrentRuns":1}'
```
**Example Response:**
```json
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"name": "string",
"state": "available",
"lastRun": {
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40,
"snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
}
],
"network": {
"rxBytes": 0,
"txBytes": 0
},
"totalApiCalls": 0
},
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
},
"ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
"runMode": "triggered",
"spaceId": "5f0f78b239ff4f0001234567",
"createdAt": "2021-12-23T12:28:21.000000Z",
"lastRunAt": "2021-12-23T12:28:21.000000Z",
"schedules": [
{
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"stopAt": "2022-12-01 00:00:00",
"startAt": "2021-12-01 00:00:00",
"interval": 30,
"timezone": "Europe/Stockholm",
"lastStartedAt": "2022-01-01T12:28:21.000000Z"
}
],
"updatedAt": "2021-12-23T12:28:21.000000Z",
"workspace": {},
"snippetIds": [
"e0e720d0-4947-11ec-a1d2-9559fa35801d"
],
"description": "string",
"endpointIds": [
"9d94bef0-b28c-11eb-8dba-01593c457362",
"53a6fb70-b28f-11eb-b601-b545a40867e0"
],
"connectorIds": [
"0d87808f-27c0-11ea-921c-022e6b5ea1e2",
"0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
],
"lastRunStatus": "finished",
"executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
"maxConcurrentRuns": 10
}
```
---
### DELETE /api/workflows/automations/{id}
Deletes an automation. The requesting user must meet at least one of the following conditions:
- be the owner of the automation
- be assigned one of the following roles: `AnalyticsAdmin`, `TenantAdmin`
- have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
- **Replaces:** "DELETE:/v1/automations/{id}"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Responses
##### 204
No Content
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `DELETE /api/workflows/automations/{id}` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}',
{
method: 'DELETE',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}" \
-X DELETE \
-H "Authorization: Bearer "
```
---
### POST /api/workflows/automations/{id}/actions/change-owner
Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`.
- **Replaces:** "POST:/v1/automations/{id}/actions/change-owner"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Request Body
**Required**
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `userId` | string | Yes | The unique identifier of the new owner. |
#### Responses
##### 204
No Content
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/actions/change-owner` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/actions/change-owner',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
userId: 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy',
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/change-owner" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"}'
```
---
### POST /api/workflows/automations/{id}/actions/change-space
Changes the space of an automation by specifying a new space.
- **Replaces:** "POST:/v1/automations/{id}/actions/change-space"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Request Body
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `spaceId` | string | Yes | The unique identifier of the new space. |
#### Responses
##### 204
No Content
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/actions/change-space` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/actions/change-space',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
spaceId: '5f0f78b239ff4f0001234567',
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/change-space" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"spaceId":"5f0f78b239ff4f0001234567"}'
```
---
### POST /api/workflows/automations/{id}/actions/copy
Duplicates an existing automation. The requesting user must be the owner of the automation or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
- **Replaces:** "POST:/v1/automations/{id}/actions/copy"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Request Body
**Required**
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Name of the new automation. |
#### Responses
##### 201
Created
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier for the automation. |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/actions/copy` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/actions/copy',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'My automation',
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/copy" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"name":"My automation"}'
```
**Example Response:**
```json
{
"id": "00000000-0000-0000-0000-000000000000"
}
```
---
### POST /api/workflows/automations/{id}/actions/disable
Disables an automation so that it cannot be run. To disable an automation, the requesting user must meet at least one of the following conditions:
- be the owner of the automation
- be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin`
- have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
- **Replaces:** "POST:/v1/automations/{id}/actions/disable"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Responses
##### 204
No Content
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/actions/disable` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/actions/disable',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/disable" \
-X POST \
-H "Authorization: Bearer "
```
---
### POST /api/workflows/automations/{id}/actions/enable
Enables an automation so that it can be run. To enable an automation, the requesting user must meet at least one of the following conditions:
- be the owner of the automation
- be assigned one of the following roles: `AnalyticsAdmin`, `TenantAdmin`
- have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
- **Replaces:** "POST:/v1/automations/{id}/actions/enable"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Responses
##### 204
No Content
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/actions/enable` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/actions/enable',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/enable" \
-X POST \
-H "Authorization: Bearer "
```
---
### POST /api/workflows/automations/{id}/actions/move
Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`.
- **Replaces:** "POST:/v1/automations/{id}/actions/move"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Request Body
**Required**
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `userId` | string | Yes | Unique identifier of the new owner of the automation. |
#### Responses
##### 204
No Content
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/actions/move` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/actions/move',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
userId: 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy',
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/move" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"}'
```
---
### GET /api/workflows/automations/{id}/runs
Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the one of roles: `TenantAdmin`, `AnalyticsAdmin`. Alternatively, the user must have at least one of the following scopes: `admin.automation-runs`, `automation-runs.private`, or `automation-runs.shared`.
- **Replaces:** "GET:/v1/automations/{id}/runs"
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Query Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `cursor` | string | No | Pagination cursor returned from a previous request. |
| `filter` | string | No | Allowed filters: `status`, `context`, `startTime`, `title`, `spaceId`, `ownerId`, `executedById`, `billable`. |
| `limit` | integer | No | The number of runs to retrieve. |
| `sort` | string | No | The field to sort by, with +- prefix indicating sort order. (`?query=-startTime` => sort on the `startTime` field using descending order). Enum: "id", "status", "startTime", "-id", "-status", "-startTime", "+id", "+status", "+startTime" |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No | |
| `links` | object | No | |
Properties of `data`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The context set by the source that triggers the automation. Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `duration` | integer | No | Duration of the run, indicated in seconds. Calculated from start and stop times |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `links`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No | |
| `prev` | object | No | |
Properties of `next`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No | The URL to a resource request |
Properties of `prev`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No | The URL to a resource request |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations/{id}/runs` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs" \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"data": [
{
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"duration": "9001",
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}
],
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
}
}
}
```
---
### POST /api/workflows/automations/{id}/runs
Creates a run for a specific automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
- Private space: be the owner of the automation and have the `automations.private` scope
- Shared space: be editor or operator in shared space and have `automations.shared` scope.
- **Replaces:** "POST:/v1/automations/{id}/runs"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
#### Request Body
**Required**
Run object to create
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `context` | string | Yes | The source that triggers the automation will set the context. Enum: "api" |
#### Responses
##### 201
Created
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier of the run. |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `metrics` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `metrics`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `blocks` | object[] | No | List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks |
| `network` | object | No | |
| `totalApiCalls` | integer | No | The number of API calls made. |
Properties of `blocks`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Type of the block. Enum: "snippetBlock", "endpointBlock" |
| `rxBytes` | integer | Yes | Total amount of received bytes sent by the current block. |
| `txBytes` | integer | Yes | Total amount of sent bytes sent by the current block. |
| `apiCalls` | integer | No | API calls to external resources made by the current block. |
| `snippetId` | string | No | Unique identifier for the snippet block used within the execution. |
| `endpointId` | string | No | Unique identifier for the endpoint block used within the execution. |
| `connectorId` | string | No | Unique identifier for the connector used within the block of the execution. |
Properties of `network`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `rxBytes` | integer | No | The number of received bytes. |
| `txBytes` | integer | No | The number of received bytes. |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/runs` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ context: 'api' }),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"context":"api"}'
```
**Example Response:**
```json
{
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40,
"snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
}
],
"network": {
"rxBytes": 0,
"txBytes": 0
},
"totalApiCalls": 0
},
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}
```
---
### GET /api/workflows/automations/{id}/runs/{runId}
Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
- Private space: be the owner of the automation and have the `automations.private` scope
- Shared space: be editor or operator in shared space and have `automations.shared` scope.
- **Replaces:** "GET:/v1/automations/{id}/runs/{runId}"
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
| `runId` | string | Yes | The unique identifier for the run. |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | The unique identifier of the run. |
| `error` | object[] | No | List of errors that occurred during the automation run. |
| `title` | string | No | The title of the automation run. |
| `status` | string | No | The current status of the automation run. Enum: "failed", "finished", "finished with warnings", "must stop", "not started", "running", "starting", "stopped", "exceeded limit", "queued" |
| `context` | string | No | The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). Enum: "test_run", "editor", "detail", "api_sync", "api_async", "webhook", "lookup" |
| `metrics` | object | No | |
| `ownerId` | string | No | The unique identifier of the owner of the automation run. |
| `spaceId` | string | No | The unique identifier of the space in which the automation run is created. |
| `testRun` | boolean | No | Indicates if this automation run is a test run. |
| `archived` | boolean | No | Indicates if this automation run is archived. |
| `stopTime` | string | No | The date and time at which the automation run stopped. |
| `createdAt` | string | No | |
| `isTestRun` | boolean | No | Indicates if this automation run is a test run. |
| `startTime` | string | No | The date and time at which the automation run started. |
| `updatedAt` | string | No | |
| `isArchived` | boolean | No | Indicates if this automation run is archived. |
| `executedById` | string | No | The unique identifier of the user who executed the automation run. |
| `scheduledStartTime` | string | No | The date and time at which the automation run is scheduled to start. |
Properties of `metrics`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `blocks` | object[] | No | List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks |
| `network` | object | No | |
| `totalApiCalls` | integer | No | The number of API calls made. |
Properties of `blocks`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Type of the block. Enum: "snippetBlock", "endpointBlock" |
| `rxBytes` | integer | Yes | Total amount of received bytes sent by the current block. |
| `txBytes` | integer | Yes | Total amount of sent bytes sent by the current block. |
| `apiCalls` | integer | No | API calls to external resources made by the current block. |
| `snippetId` | string | No | Unique identifier for the snippet block used within the execution. |
| `endpointId` | string | No | Unique identifier for the endpoint block used within the execution. |
| `connectorId` | string | No | Unique identifier for the connector used within the block of the execution. |
Properties of `network`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `rxBytes` | integer | No | The number of received bytes. |
| `txBytes` | integer | No | The number of received bytes. |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations/{id}/runs/{runId}` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs/{runId}',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}" \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"error": [
{}
],
"title": "string",
"status": "failed",
"context": "test_run",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40,
"snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
"connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
}
],
"network": {
"rxBytes": 0,
"txBytes": 0
},
"totalApiCalls": 0
},
"ownerId": "string",
"spaceId": "string",
"testRun": true,
"archived": true,
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"isTestRun": true,
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"isArchived": true,
"executedById": "string",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}
```
---
### POST /api/workflows/automations/{id}/runs/{runId}/actions/export
Retrieves the URL for the debug log of a specific automation run. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
- Private space: be the owner of the automation and have the `automations.private` scope
- Shared space: be editor or operator in shared space and have `automations.shared` scope.
- **Replaces:** "POST:/v1/automations/{id}/runs/{runId}/actions/export"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
| `runId` | string | Yes | The unique identifier for the run. |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | No | |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/runs/{runId}/actions/export` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs/{runId}/actions/export',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/actions/export" \
-X POST \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"url": "https://{tenantname}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/debug"
}
```
---
### POST /api/workflows/automations/{id}/runs/{runId}/actions/retry
Retries a specific run by creating a new run using the same inputs. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
- Private space: be the owner of the automation and have the `automations.private` scope
- Shared space: be editor or operator in shared space and have `automations.shared` scope.
- **Replaces:** "POST:/v1/automations/{id}/runs/{runId}/actions/retry"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
| `runId` | string | Yes | The unique identifier for the run. |
#### Responses
##### 204
OK Response
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/runs/{runId}/actions/retry` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs/{runId}/actions/retry',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/actions/retry" \
-X POST \
-H "Authorization: Bearer "
```
---
### POST /api/workflows/automations/{id}/runs/{runId}/actions/stop
Forcefully stops an automation run immediately. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
- Private space: be the owner of the automation and have the `automations.private` scope
- Shared space: be editor or operator in shared space and have `automations.shared` scope.
- **Replaces:** "POST:/v1/automations/{id}/runs/{runId}/actions/stop"
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
| `runId` | string | Yes | The unique identifier for the run. |
#### Responses
##### 204
OK Response
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `POST /api/workflows/automations/{id}/runs/{runId}/actions/stop` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs/{runId}/actions/stop',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/actions/stop" \
-X POST \
-H "Authorization: Bearer "
```
---
### GET /api/workflows/automations/{id}/runs/{runId}/debug
Retrieves the debug log for a specific run of an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
- Private space: be the owner of the automation and have the `automations.private` scope
- Shared space: be editor or operator in shared space and have `automations.shared` scope.
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The unique identifier for the automation. |
| `runId` | string | Yes | The unique identifier for the run. |
#### Responses
##### 200
OK Response
**Content-Type:** `text/plain`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `text/plain` | string | No | |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 404
Not found
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations/{id}/runs/{runId}/debug` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/{id}/runs/{runId}/debug',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/debug" \
-H "Authorization: Bearer "
```
**Example Response:**
```text
string
```
---
### GET /api/workflows/automations/settings
Retrieves the global automation settings for the tenant.
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `maxConcurrentRunsPerAutomation` | integer | No | Maximum number of concurrent runs allowed per automation. |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations/settings` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/settings',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/settings" \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"maxConcurrentRunsPerAutomation": 10
}
```
---
### PUT /api/workflows/automations/settings
Updates the global automation settings for the tenant.
- **Rate Limit:** Tier 2 (100 requests per minute)
#### Request Body
**Required**
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `maxConcurrentRunsPerAutomation` | integer | No | Maximum number of concurrent runs allowed per automation. |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `maxConcurrentRunsPerAutomation` | integer | No | Maximum number of concurrent runs allowed per automation. |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 409
Conflict with the current state of the resource
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `PUT /api/workflows/automations/settings` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/settings',
{
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
maxConcurrentRunsPerAutomation: 10,
}),
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer " \
-d '{"maxConcurrentRunsPerAutomation":10}'
```
**Example Response:**
```json
{
"maxConcurrentRunsPerAutomation": 10
}
```
---
### GET /api/workflows/automations/usage
Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` or `AnalyticsAdmin` role.
- **Replaces:** "GET:/v1/automations/usage"
- **Rate Limit:** Tier 1 (1000 requests per minute)
#### Query Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `filter` | string | Yes | Indicates how the metrics should be filtered using a SCIM-style expression. Available parameters: - name (specify one or more enums to return specific metrics. Supported enum values: `runs`, `scheduledRuns`, `triggeredRuns`, `webhookRuns`, `duration`, `bandwidthIn`, `bandwidthOut`) - date (return a metric for a specific date or range of dates, e.g. "2025-08-01") |
| `breakdownBy` | string | No | If specified, result will be broken apart for each automation |
#### Responses
##### 200
OK Response
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No | |
Properties of `data`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `date` | string | Yes | The date for the metric |
| `name` | string | Yes | The name for the metric Enum: "runs", "scheduledRun", "triggeredRun", "webhookRuns", "duration", "bandwidthIn", "bandwidthOut" |
| `value` | integer | Yes | The value count of the metric |
| `automation` | object | No | |
Properties of `automation`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `guid` | string | No | The unique identifier for the automation. |
| `name` | string | No | The name for the automation. |
| `ownerId` | string | No | The unique identifier for the user who owns the automation |
##### 400
Bad Request
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 401
Unauthorized
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 403
Forbidden
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 500
Internal Server Error
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
##### 503
Service Unavailable
**Content-Type:** `application/json`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No | |
| `traceId` | string | No | A way to trace the source of the error. |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | Yes | The unique code for the error |
| `title` | string | Yes | A summary of what went wrong |
| `detail` | string | No | May be used to provide additional details |
#### Examples
**JavaScript:**
```javascript
// qlik-api has not implemented support for `GET /api/workflows/automations/usage` yet.
// In the meantime, you can use fetch like this:
const response = await fetch(
'/api/workflows/automations/usage',
{
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
},
)
```
**Qlik CLI:**
```bash
This API is not included yet in qlik-cli
```
**cURL:**
```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/usage" \
-H "Authorization: Bearer "
```
**Example Response:**
```json
{
"data": [
{
"date": "2021-12-15",
"name": "bandwidthIn",
"value": 310179713,
"automation": {
"guid": "00000000-0000-0000-0000-000000000000",
"name": "My Automation.",
"ownerId": "KP1zJiPDn0gsla236GmETadFcxBW-J8F"
}
}
]
}
```
---