Automations

Automations in Qlik Automate are no-code workflows which connect applications together.

Preferred API

This API replaces the legacy Automations API. Use this API for all new implementations.

Endpoints

GET

/api/workflows/automations
POST

/api/workflows/automations
GET

/api/workflows/automations/{id}
PUT

/api/workflows/automations/{id}
DELETE

/api/workflows/automations/{id}
POST

/api/workflows/automations/{id}/actions/change-owner
POST

/api/workflows/automations/{id}/actions/change-space
POST

/api/workflows/automations/{id}/actions/copy
POST

/api/workflows/automations/{id}/actions/disable
POST

/api/workflows/automations/{id}/actions/enable
POST

/api/workflows/automations/{id}/actions/move
GET

/api/workflows/automations/{id}/runs
POST

/api/workflows/automations/{id}/runs
GET

/api/workflows/automations/{id}/runs/{runId}
POST

/api/workflows/automations/{id}/runs/{runId}/actions/export
POST

/api/workflows/automations/{id}/runs/{runId}/actions/retry
POST

/api/workflows/automations/{id}/runs/{runId}/actions/stop
GET

/api/workflows/automations/{id}/runs/{runId}/debug
GET

/api/workflows/automations/settings
PUT

/api/workflows/automations/settings
GET

/api/workflows/automations/usage

Retrieves a list of the automations that the requesting user has access to.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automations

Query Parameters

filterstring

Allowed filters: name, runMode, lastRunStatus, ownerId, spaceId.
limitinteger

The number of automations to retrieve.

minimum = 1, maximum = 200, default = 100, default = 100
listAllboolean

When true, list all automations. Restricted to tenant admins and analytics admins.

default = true
sortstring

The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order).

Can be one of: "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"

default = "id"

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  The unique identifier for the automation.
  
  format = "uuid"
  
  namestring
  Filterable
  
  The name of the automation.
  
  statestring
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
  
  lastRunobject
  
  Show lastRun properties
  
  idstring
  
  The unique identifier of the run.
  
  format = "uuid"
  
  errorarray of objects
  
  List of errors that occurred during the automation run.
  
  titlestring
  
  The title of the automation run.
  
  statusstring
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  contextstring
  
  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).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerIdstring
  
  The unique identifier of the owner of the automation run.
  
  spaceIdstring
  
  The unique identifier of the space in which the automation run is created.
  
  testRunboolean
  
  Indicates if this automation run is a test run.
  
  archivedboolean
  
  Indicates if this automation run is archived.
  
  stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  Indicates if this automation run is a test run.
  
  startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  Indicates if this automation run is archived.
  
  executedByIdstring
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
  
  ownerIdstring
  Filterable
  
  The unique identifier of the owner of the automation.
  
  runModestring
  Filterable
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
  
  spaceIdstring
  Filterable
  
  The unique identifier of the space that contains the automation.
  
  durationinteger
  Filterable
  
  Duration of the last run, indicated in seconds. Calculated from start and stop times.
  
  createdAtstring
  
  format = "date-time"
  
  lastRunAtstring
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  workspaceobject
  
  The workspace contains the JSON representation of the used blocks
  
  snippetIdsarray of strings
  
  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.
  
  descriptionstring
  
  The description of the automation.
  
  endpointIdsarray of strings
  
  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.
  
  connectorIdsarray of strings
  
  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.
  
  lastRunStatusstring
  Filterable
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
  
  executionTokenstring
  
  Execution token required to authorize the execution of the automation.
  
  maxConcurrentRunsinteger
  
  Maximum number of concurrent runs allowed for automation.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  The URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  The URL to a resource request

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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"
    }
  }
}

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations

Request Body

Required

Automation object to create

application/jsonobject
Show application/json properties
- namestring
  Required
  
  The name of the automation.
- spaceIdstring
  
  The unique identifier of the space in which the automation is created.
- schedulesarray of objects
  
  Show schedules properties
  
  stopAtstring
  
  The date and time until the schedule is active.
  
  startAtstring
  
  The date and time when the schedule becomes active.
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  The timezone applied to the start and end times.
- workspaceobject
  
  The workspace generated by the Qlik Automate editor.
- descriptionstring
  
  The description of the automation
  
  default = ""
- maxConcurrentRunsinteger
  
  Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings.
  
  minimum = 1, default = 1, default = 1

Responses

201

Created

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
  
  The name of the automation.
- statestring
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- lastRunobject
  
  Show lastRun properties
  
  idstring
  
  The unique identifier of the run.
  
  format = "uuid"
  
  errorarray of objects
  
  List of errors that occurred during the automation run.
  
  titlestring
  
  The title of the automation run.
  
  statusstring
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  contextstring
  
  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).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerIdstring
  
  The unique identifier of the owner of the automation run.
  
  spaceIdstring
  
  The unique identifier of the space in which the automation run is created.
  
  testRunboolean
  
  Indicates if this automation run is a test run.
  
  archivedboolean
  
  Indicates if this automation run is archived.
  
  stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  Indicates if this automation run is a test run.
  
  startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  Indicates if this automation run is archived.
  
  executedByIdstring
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- ownerIdstring
  
  The unique identifier of the owner of the automation.
- runModestring
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
- spaceIdstring
  
  The unique identifier of the space that contains the automation.
- createdAtstring
  
  format = "date-time"
- lastRunAtstring
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
- schedulesarray of objects
  
  Show schedules properties
  
  idstring
  
  format = "uuid"
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  lastStartedAtstring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- workspaceobject
  
  The workspace generated by the Qlik Automate editor.
- snippetIdsarray of strings
  
  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.
- descriptionstring
  
  The description of the automation.
- endpointIdsarray of strings
  
  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.
- connectorIdsarray of strings
  
  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.
- lastRunStatusstring
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
- executionTokenstring
  
  Execution token required to authorize the execution of the automation.
- maxConcurrentRunsinteger
  
  Maximum number of concurrent runs allowed for this automation.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations

// 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,
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-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

{
  "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
}

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.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automations/{id}

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
  
  The name of the automation.
- statestring
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- lastRunobject
  
  Show lastRun properties
  
  idstring
  
  The unique identifier of the run.
  
  format = "uuid"
  
  errorarray of objects
  
  List of errors that occurred during the automation run.
  
  titlestring
  
  The title of the automation run.
  
  statusstring
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  contextstring
  
  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).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerIdstring
  
  The unique identifier of the owner of the automation run.
  
  spaceIdstring
  
  The unique identifier of the space in which the automation run is created.
  
  testRunboolean
  
  Indicates if this automation run is a test run.
  
  archivedboolean
  
  Indicates if this automation run is archived.
  
  stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  Indicates if this automation run is a test run.
  
  startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  Indicates if this automation run is archived.
  
  executedByIdstring
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- ownerIdstring
  
  The unique identifier of the owner of the automation.
- runModestring
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
- spaceIdstring
  
  The unique identifier of the space that contains the automation.
- createdAtstring
  
  format = "date-time"
- lastRunAtstring
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
- schedulesarray of objects
  
  Show schedules properties
  
  idstring
  
  format = "uuid"
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  lastStartedAtstring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- workspaceobject
  
  The workspace generated by the Qlik Automate editor.
- snippetIdsarray of strings
  
  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.
- descriptionstring
  
  The description of the automation.
- endpointIdsarray of strings
  
  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.
- connectorIdsarray of strings
  
  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.
- lastRunStatusstring
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
- executionTokenstring
  
  Execution token required to authorize the execution of the automation.
- maxConcurrentRunsinteger
  
  Maximum number of concurrent runs allowed for this automation.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations/{id}

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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
}

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	PUT v1/automations/{id}

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

Required

Automation object to update

application/jsonobject
Show application/json properties
- namestring
  
  The name of the automation.
- schedulesarray of objects
  
  Show schedules properties
  
  stopAtstring
  
  The date and time until the schedule is active.
  
  startAtstring
  
  The date and time when the schedule becomes active.
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  The timezone applied to the start and end times.
- workspaceobject
  
  The workspace generated by the Qlik Automate editor.
- descriptionstring
  
  The description of the automation
  
  default = ""
- maxConcurrentRunsinteger
  
  Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings.
  
  minimum = 1, default = 1, default = 1

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
  
  The name of the automation.
- statestring
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- lastRunobject
  
  Show lastRun properties
  
  idstring
  
  The unique identifier of the run.
  
  format = "uuid"
  
  errorarray of objects
  
  List of errors that occurred during the automation run.
  
  titlestring
  
  The title of the automation run.
  
  statusstring
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  contextstring
  
  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).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerIdstring
  
  The unique identifier of the owner of the automation run.
  
  spaceIdstring
  
  The unique identifier of the space in which the automation run is created.
  
  testRunboolean
  
  Indicates if this automation run is a test run.
  
  archivedboolean
  
  Indicates if this automation run is archived.
  
  stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  Indicates if this automation run is a test run.
  
  startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  Indicates if this automation run is archived.
  
  executedByIdstring
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- ownerIdstring
  
  The unique identifier of the owner of the automation.
- runModestring
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
- spaceIdstring
  
  The unique identifier of the space that contains the automation.
- createdAtstring
  
  format = "date-time"
- lastRunAtstring
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
- schedulesarray of objects
  
  Show schedules properties
  
  idstring
  
  format = "uuid"
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  lastStartedAtstring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- workspaceobject
  
  The workspace generated by the Qlik Automate editor.
- snippetIdsarray of strings
  
  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.
- descriptionstring
  
  The description of the automation.
- endpointIdsarray of strings
  
  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.
- connectorIdsarray of strings
  
  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.
- lastRunStatusstring
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
- executionTokenstring
  
  Execution token required to authorize the execution of the automation.
- maxConcurrentRunsinteger
  
  Maximum number of concurrent runs allowed for this automation.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

409

Conflict with the current state of the resource

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

PUT /api/workflows/automations/{id}

// 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,
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-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

{
  "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
}

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

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	DELETE v1/automations/{id}

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

204

No Content

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

DELETE /api/workflows/automations/{id}

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/actions/change-owner

Path Parameters

idstring
Required

The unique identifier for the automation.

format = "uuid"

Request Body

Required

application/jsonobject
Show application/json properties
- userIdstring
  Required
  
  The unique identifier of the new owner.

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/actions/change-owner

// 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',
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/change-owner" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"}'

Changes the space of an automation by specifying a new space.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/actions/change-space

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

application/jsonobject
Show application/json properties
- spaceIdstring
  Required
  
  The unique identifier of the new space.

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/actions/change-space

// 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',
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/change-space" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"spaceId":"5f0f78b239ff4f0001234567"}'

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/actions/copy

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

Required

application/jsonobject
Show application/json properties
- namestring
  Required
  
  Name of the new automation.

Responses

201

Created

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier for the automation.
  
  format = "uuid"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/actions/copy

// 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',
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/copy" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"My automation"}'

Example Response

{
  "id": "00000000-0000-0000-0000-000000000000"
}

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

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/actions/disable

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/actions/disable

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/disable" \
-X POST \
-H "Authorization: Bearer <access_token>"

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

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/actions/enable

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/actions/enable

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/enable" \
-X POST \
-H "Authorization: Bearer <access_token>"

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/actions/move

Path Parameters

idstring
Required

The unique identifier for the automation.

format = "uuid"

Request Body

Required

application/jsonobject
Show application/json properties
- userIdstring
  Required
  
  Unique identifier of the new owner of the automation.

Responses

204

No Content

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/actions/move

// 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',
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/actions/move" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"}'

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.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automations/{id}/runs

Query Parameters

filterstring

Allowed filters: status, context, startTime, title, spaceId, ownerId, executedById, billable.
limitinteger

The number of runs to retrieve.

minimum = 1, maximum = 200, default = 10, default = 10
sortstring

The field to sort by, with +- prefix indicating sort order. (?query=-startTime => sort on the startTime field using descending order).

Can be one of: "id""status""startTime""-id""-status""-startTime""+id""+status""+startTime"

default = "id"

Path Parameters

idstring
Required

The unique identifier for the automation.

format = "uuid"

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  format = "uuid"
  
  errorarray of objects
  
  List of errors that occurred during the automation run.
  
  titlestring
  
  The title of the automation run.
  
  statusstring
  Filterable
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  contextstring
  Filterable
  
  The context set by the source that triggers the automation.
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  ownerIdstring
  Filterable
  
  The unique identifier of the owner of the automation run.
  
  spaceIdstring
  Filterable
  
  The unique identifier of the space in which the automation run is created.
  
  testRunboolean
  
  Indicates if this automation run is a test run.
  
  archivedboolean
  
  Indicates if this automation run is archived.
  
  durationinteger
  Filterable
  
  Duration of the run, indicated in seconds. Calculated from start and stop times
  
  stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAtstring
  
  isTestRunboolean
  
  Indicates if this automation run is a test run.
  
  startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAtstring
  
  isArchivedboolean
  
  Indicates if this automation run is archived.
  
  executedByIdstring
  Filterable
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  The URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  The URL to a resource request

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations/{id}/runs

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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"
    }
  }
}

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/runs

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

Required

Run object to create

application/jsonobject
Show application/json properties
- contextstring
  Required
  
  The source that triggers the automation will set the context.
  
  Can be one of: "api"

Responses

201

Created

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier of the run.
  
  format = "uuid"
- errorarray of objects
  
  List of errors that occurred during the automation run.
- titlestring
  
  The title of the automation run.
- statusstring
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
- contextstring
  
  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).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
- metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
- ownerIdstring
  
  The unique identifier of the owner of the automation run.
- spaceIdstring
  
  The unique identifier of the space in which the automation run is created.
- testRunboolean
  
  Indicates if this automation run is a test run.
- archivedboolean
  
  Indicates if this automation run is archived.
- stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
- createdAtstring
  
  format = "date-time"
- isTestRunboolean
  
  Indicates if this automation run is a test run.
- startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- isArchivedboolean
  
  Indicates if this automation run is archived.
- executedByIdstring
  
  The unique identifier of the user who executed the automation run.
- scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/runs

// 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' }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"context":"api"}'

Example Response

{
  "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"
}

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.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automations/{id}/runs/{runId}

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier of the run.
  
  format = "uuid"
- errorarray of objects
  
  List of errors that occurred during the automation run.
- titlestring
  
  The title of the automation run.
- statusstring
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
- contextstring
  
  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).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
- metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
- ownerIdstring
  
  The unique identifier of the owner of the automation run.
- spaceIdstring
  
  The unique identifier of the space in which the automation run is created.
- testRunboolean
  
  Indicates if this automation run is a test run.
- archivedboolean
  
  Indicates if this automation run is archived.
- stopTimestring
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
- createdAtstring
  
  format = "date-time"
- isTestRunboolean
  
  Indicates if this automation run is a test run.
- startTimestring
  
  The date and time at which the automation run started.
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- isArchivedboolean
  
  Indicates if this automation run is archived.
- executedByIdstring
  
  The unique identifier of the user who executed the automation run.
- scheduledStartTimestring
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations/{id}/runs/{runId}

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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"
}

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/runs/{runId}/actions/export

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- urlstring

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/runs/{runId}/actions/export

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/actions/export" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "url": "https://{tenantname}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/debug"
}

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/runs/{runId}/actions/retry

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

204

OK Response

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/runs/{runId}/actions/retry

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/actions/retry" \
-X POST \
-H "Authorization: Bearer <access_token>"

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.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automations/{id}/runs/{runId}/actions/stop

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

204

OK Response

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /api/workflows/automations/{id}/runs/{runId}/actions/stop

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/actions/stop" \
-X POST \
-H "Authorization: Bearer <access_token>"

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.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

200

OK Response

text/plainstring

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations/{id}/runs/{runId}/debug

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/{id}/runs/{runId}/debug" \
-H "Authorization: Bearer <access_token>"

Example Response

string

Retrieves the global automation settings for the tenant.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

OK Response

application/jsonobject
Show application/json properties
- maxConcurrentRunsPerAutomationinteger
  
  Maximum number of concurrent runs allowed per automation.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations/settings

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/settings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "maxConcurrentRunsPerAutomation": 10
}

Updates the global automation settings for the tenant.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/jsonobject
Show application/json properties
- maxConcurrentRunsPerAutomationinteger
  
  Maximum number of concurrent runs allowed per automation.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- maxConcurrentRunsPerAutomationinteger
  
  Maximum number of concurrent runs allowed per automation.

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

409

Conflict with the current state of the resource

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

PUT /api/workflows/automations/settings

// 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,
    }),
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"maxConcurrentRunsPerAutomation":10}'

Example Response

{
  "maxConcurrentRunsPerAutomation": 10
}

Retrieves paginated usage metrics for automations. The requesting user must be assigned the TenantAdmin or AnalyticsAdmin role.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automations/usage

Query Parameters

filterstring
Required
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")
breakdownBystring

If specified, result will be broken apart for each automation

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  datestring
  RequiredFilterable
  
  The date for the metric
  
  namestring
  RequiredFilterable
  
  The name for the metric
  
  Can be one of: "runs""scheduledRun""triggeredRun""webhookRuns""duration""bandwidthIn""bandwidthOut"
  
  maxLength = 50
  
  valueinteger
  Required
  
  The value count of the metric
  
  automationobject
  
  Show automation properties
  
  guidstring
  
  The unique identifier for the automation.
  
  namestring
  
  The name for the automation.
  
  maxLength = 50
  
  ownerIdstring
  
  The unique identifier for the user who owns the automation

400

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /api/workflows/automations/usage

// 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',
    },
  },
)

This API is not included yet in qlik-cli

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automations/usage" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "date": "2021-12-15",
      "name": "bandwidthIn",
      "value": 310179713,
      "automation": {
        "guid": "00000000-0000-0000-0000-000000000000",
        "name": "My Automation.",
        "ownerId": "KP1zJiPDn0gsla236GmETadFcxBW-J8F"
      }
    }
  ]
}

Automations

Endpoints

List automations

Facts

Query Parameters

Responses

200

400

401

403

500

503

Example Response

Create an automation

Facts

Request Body

Responses

201

400

401

403

500

503

Example Response

Get an automation

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Example Response

Update an automation

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

409

500

503

Example Response

Delete an automation

Facts

Path Parameters

Responses

204

401

403

404

500

503

Change automation owner

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

503

Change automation space

Facts

Path Parameters

Request Body

Responses

204

400

401