Sign in

v1

latestOpenAPI 3.0.02026-08-04181876.9 KB
automations

Update an automation

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.

put/api/v1/automations/{id}

Path parameters

idstring required
Example:00000000-0000-0000-0000-000000000000

The unique identifier for the automation.

Request body

namestring
workspaceobject

The workspace generated by the Qlik Automate editor.

descriptionstring
maxConcurrentRunsinteger

Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings.

Example request

{
  "schedules": [
    {
      "stopAt": "2022-12-01 00:00:00",
      "startAt": "2022-01-01 00:00:00",
      "interval": 60,
      "timezone": "Europe/Stockholm"
    }
  ],
  "maxConcurrentRuns": 10
}

Response

OK Response

idstring uuid
namestring

The name of the automation.

state'available' | 'unavailable' | 'disabled'

The state of the automation.

ownerIdstring

The unique identifier of the owner of the automation.

runMode'manual' | 'scheduled' | 'triggered' | 'webhook'

Defines how the automation run is started.

spaceIdstring

The unique identifier of the space that contains the automation.

createdAtstring date-time
lastRunAtstring date-time

The date and time when the last automation run was finished.

updatedAtstring date-time
workspaceobject

The workspace generated by the Qlik Automate editor.

snippetIdsstring[]

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.

endpointIdsstring[]

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.

connectorIdsstring[]

A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.

lastRunStatus'failed' | 'finished' | 'finished with warnings' | 'must stop' | 'not started' | 'paused' | 'running' | 'starting' | 'stopped' | 'exceeded limit'

The status of the last run of the automation.

executionTokenstring

Execution token required to authorize the execution of the automation.

maxConcurrentRunsinteger

Maximum number of concurrent runs allowed for this automation.

Example response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "metrics": {
      "blocks": [
        {
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "apiCalls": 40
        }
      ]
    },
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "startTime": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z",
    "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": 60,
      "timezone": "Europe/Stockholm",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z"
    }
  ],
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "snippetIds": [
    "e0e720d0-4947-11ec-a1d2-9559fa35801d"
  ],
  "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
}