automations

Qlik Application Automation is a visual, no-code approach to connecting applications.

Endpoints

Skip to section
GET/automations
POST/automations
GET/automations/{id}
PUT/automations/{id}
DELETE/automations/{id}
POST/automations/{id}/actions/enable
POST/automations/{id}/actions/disable
POST/automations/{id}/actions/copy
POST/automations/{id}/actions/move
GET/automations/{id}/runs
POST/automations/{id}/runs
GET/automations/{automationId}/runs/{runId}
POST/automations/{automationId}/runs/{runId}/actions/retry
POST/automations/{automationId}/runs/{runId}/actions/stop
POST/automations/{automationId}/runs/{runId}/actions/export
GET/automations/settings
PUT/automations/settings
GET/automations/usage

Retrieves a list of automations

Query Parameters GET /automations

limit
optional, default=100, minimum=1, maximum=200
integer

The number of automations to retrieve.

filter
optional
string

Allowed filters: name, runMode, lastRunStatus, ownerId

sort
optional, default='id'
string

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

Enum:

id

name

runMode

state

createdAt

updatedAt

lastRunAt

lastRunStatus

+id

+name

+runMode

+state

+createdAt

+updatedAt

+lastRunAt

+lastRunStatus

-id

-name

-runMode

-state

-createdAt

-updatedAt

-lastRunAt

-lastRunStatus

Responses GET /automations

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/automations

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations" \
 -H "Authorization: Bearer <API-key>"

Response GET /automations

{
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  },
  "data": [
    {
      "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
      "name": "string",
      "state": "available",
      "description": "string",
      "lastRunStatus": "finished",
      "runMode": "triggered",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z",
      "lastRunAt": "2021-12-23T12:28:21.000000Z"
    }
  ]
}

Create an automation

Request Body POST /automations

Automation object to create

Responses POST /automations

201

Created

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","description":"string","workspace":{},"state":"available","schedules":[{"startAt":"2022-01-01 00:00:00","stopAt":"2022-12-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}]}'

Request POST /automations

{
  "name": "string",
  "description": "string",
  "workspace": {},
  "state": "available",
  "schedules": [
    {
      "startAt": "2022-01-01 00:00:00",
      "stopAt": "2022-12-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ]
}

Response POST /automations

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "name": "string",
  "state": "available",
  "description": "string",
  "schedules": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "startAt": "2021-12-01 00:00:00",
      "stopAt": "2022-12-01 00:00:00",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ],
  "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"
  ],
  "workspace": {},
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "context": "test_run",
    "status": "failed",
    "title": "string",
    "isTestRun": true,
    "isArchived": true,
    "expectedInputs": {},
    "inputs": {},
    "error": {},
    "metrics": {
      "blocks": [
        {
          "connectorId": "string",
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "snippetId": "string",
          "endpointId": "string",
          "apiCalls": 40
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "startTime": "2021-12-23T12:28:21.000000Z",
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z"
  },
  "lastRunStatus": "finished",
  "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
  "runMode": "triggered",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "lastRunAt": "2021-12-23T12:28:21.000000Z"
}

Retrieves an automation

Path Parameters GET /automations/{id}

id
string

The unique identifier for the automation.

Responses GET /automations/{id}

200

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/automations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}" \
 -H "Authorization: Bearer <API-key>"

Response GET /automations/{id}

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "name": "string",
  "state": "available",
  "description": "string",
  "schedules": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "startAt": "2021-12-01 00:00:00",
      "stopAt": "2022-12-01 00:00:00",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ],
  "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"
  ],
  "workspace": {},
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "context": "test_run",
    "status": "failed",
    "title": "string",
    "isTestRun": true,
    "isArchived": true,
    "expectedInputs": {},
    "inputs": {},
    "error": {},
    "metrics": {
      "blocks": [
        {
          "connectorId": "string",
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "snippetId": "string",
          "endpointId": "string",
          "apiCalls": 40
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "startTime": "2021-12-23T12:28:21.000000Z",
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z"
  },
  "lastRunStatus": "finished",
  "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
  "runMode": "triggered",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "lastRunAt": "2021-12-23T12:28:21.000000Z"
}

Update an automation

Path Parameters PUT /automations/{id}

id
string

The unique identifier for the automation.

Request Body PUT /automations/{id}

Automation object to update

Responses PUT /automations/{id}

200

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

PUT/automations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","description":"string","workspace":{},"state":"available","schedules":[{"startAt":"2022-01-01 00:00:00","stopAt":"2022-12-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}]}'

Request PUT /automations/{id}

{
  "name": "string",
  "description": "string",
  "workspace": {},
  "state": "available",
  "schedules": [
    {
      "startAt": "2022-01-01 00:00:00",
      "stopAt": "2022-12-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ]
}

Response PUT /automations/{id}

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "name": "string",
  "state": "available",
  "description": "string",
  "schedules": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "startAt": "2021-12-01 00:00:00",
      "stopAt": "2022-12-01 00:00:00",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ],
  "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"
  ],
  "workspace": {},
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "context": "test_run",
    "status": "failed",
    "title": "string",
    "isTestRun": true,
    "isArchived": true,
    "expectedInputs": {},
    "inputs": {},
    "error": {},
    "metrics": {
      "blocks": [
        {
          "connectorId": "string",
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "snippetId": "string",
          "endpointId": "string",
          "apiCalls": 40
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "startTime": "2021-12-23T12:28:21.000000Z",
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z"
  },
  "lastRunStatus": "finished",
  "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
  "runMode": "triggered",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "lastRunAt": "2021-12-23T12:28:21.000000Z"
}

Delete an automation

Path Parameters DELETE /automations/{id}

id
string

The unique identifier for the automation.

Responses DELETE /automations/{id}

204
object

No Content

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

DELETE/automations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Enable an automation.

Path Parameters POST /automations/{id}/actions/enable

id
string

The unique identifier for the automation.

Responses POST /automations/{id}/actions/enable

204
object

No Content

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{id}/actions/enable

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/enable" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Disables an automation.

Path Parameters POST /automations/{id}/actions/disable

id
string

The unique identifier for the automation.

Responses POST /automations/{id}/actions/disable

204
object

No Content

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{id}/actions/disable

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/disable" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Copy an automation.

Path Parameters POST /automations/{id}/actions/copy

id
string

The unique identifier for the automation.

Request Body POST /automations/{id}/actions/copy

name
application/json
string

Name of the new automation.

Responses POST /automations/{id}/actions/copy

id
application/json
string

Created

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{id}/actions/copy

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/copy" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d 'undefined'

Response POST /automations/{id}/actions/copy

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

Move an automation to a different user.

This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.

Path Parameters POST /automations/{id}/actions/move

id
string<uuid>

The unique identifier for the automation.

Request Body POST /automations/{id}/actions/move

userId
application/json
string

No description

Responses POST /automations/{id}/actions/move

204
object

No Content

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{id}/actions/move

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/move" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"'

Request POST /automations/{id}/actions/move

"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"

Retrieves a list of runs for a specific automation.

Path Parameters GET /automations/{id}/runs

id
string<uuid>

The unique identifier for the automation.

Query Parameters GET /automations/{id}/runs

limit
optional, default=10, minimum=1, maximum=200
integer

The number of runs to retrieve.

filter
optional
string

Allowed filters: status

sort
optional, default='id'
string

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

Enum:

id

status

startTime

-id

-status

-startTime

+id

+status

+startTime

Responses GET /automations/{id}/runs

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/automations/{id}/runs

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs" \
 -H "Authorization: Bearer <API-key>"

Response GET /automations/{id}/runs

{
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  },
  "data": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "context": "test_run",
      "status": "failed",
      "title": "string",
      "isTestRun": true,
      "isArchived": true,
      "error": {},
      "startTime": "2021-12-23T12:28:21.000000Z",
      "stopTime": "2021-12-23T12:28:21.000000Z",
      "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z"
    }
  ]
}

Create a run

Path Parameters POST /automations/{id}/runs

id
string

The unique identifier for the automation.

Request Body POST /automations/{id}/runs

application/json

Run object to create

Responses POST /automations/{id}/runs

201
application/json

Created

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{id}/runs

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"d452d100-9b0b-11ec-b199-8323e1031c3e","context":"editor","inputs":{}}'

Request POST /automations/{id}/runs

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "context": "editor",
  "inputs": {}
}

Response POST /automations/{id}/runs

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "context": "test_run",
  "status": "failed",
  "title": "string",
  "isTestRun": true,
  "isArchived": true,
  "expectedInputs": {},
  "inputs": {},
  "error": {},
  "metrics": {
    "blocks": [
      {
        "connectorId": "string",
        "type": "endpointBlock",
        "rxBytes": 18329921,
        "txBytes": 18329921,
        "snippetId": "string",
        "endpointId": "string",
        "apiCalls": 40
      }
    ],
    "network": {
      "rxBytes": 0,
      "txBytes": 0
    },
    "totalApiCalls": 0
  },
  "startTime": "2021-12-23T12:28:21.000000Z",
  "stopTime": "2021-12-23T12:28:21.000000Z",
  "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z"
}

Retrieves a run

Path Parameters GET /automations/{automationId}/runs/{runId}

automationId
string

The unique identifier for the automation.

runId
string

The unique identifier for the run.

Responses GET /automations/{automationId}/runs/{runId}

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/automations/{automationId}/runs/{runId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{automationId}/runs/{runId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /automations/{automationId}/runs/{runId}

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "context": "test_run",
  "status": "failed",
  "title": "string",
  "isTestRun": true,
  "isArchived": true,
  "expectedInputs": {},
  "inputs": {},
  "error": {},
  "metrics": {
    "blocks": [
      {
        "connectorId": "string",
        "type": "endpointBlock",
        "rxBytes": 18329921,
        "txBytes": 18329921,
        "snippetId": "string",
        "endpointId": "string",
        "apiCalls": 40
      }
    ],
    "network": {
      "rxBytes": 0,
      "txBytes": 0
    },
    "totalApiCalls": 0
  },
  "startTime": "2021-12-23T12:28:21.000000Z",
  "stopTime": "2021-12-23T12:28:21.000000Z",
  "scheduledStartTime": "2021-12-23T12:28:21.000000Z",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z"
}

Retry a run.

This action allows you to retry a specific run by creating a new run using the same inputs.

Path Parameters POST /automations/{automationId}/runs/{runId}/actions/retry

automationId
string

The unique identifier for the automation.

runId
string

The unique identifier for the run.

Responses POST /automations/{automationId}/runs/{runId}/actions/retry

204
object

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{automationId}/runs/{runId}/actions/retry

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{automationId}/runs/{runId}/actions/retry" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Stop a running automation.

Force a run to be stopped immediately.

Path Parameters POST /automations/{automationId}/runs/{runId}/actions/stop

automationId
string

The unique identifier for the automation.

runId
string

The unique identifier for the run.

Responses POST /automations/{automationId}/runs/{runId}/actions/stop

204
object

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{automationId}/runs/{runId}/actions/stop

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{automationId}/runs/{runId}/actions/stop" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Export a run.

Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.

Path Parameters POST /automations/{automationId}/runs/{runId}/actions/export

automationId
string

The unique identifier for the automation.

runId
string

The unique identifier for the run.

Responses POST /automations/{automationId}/runs/{runId}/actions/export

url
application/json
string

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/automations/{automationId}/runs/{runId}/actions/export

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{automationId}/runs/{runId}/actions/export" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Response POST /automations/{automationId}/runs/{runId}/actions/export

{
  "url": "https://<bucket>.s3.<region>.amazonaws.com/<run>.json"
}

Retrieves the automation settings.

Responses GET /automations/settings

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/automations/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/settings" \
 -H "Authorization: Bearer <API-key>"

Response GET /automations/settings

{
  "automationsEnabled": true
}

Update the automation settings.

Request Body PUT /automations/settings

application/json

No description

Responses PUT /automations/settings

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

PUT/automations/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/settings" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"automationsEnabled":true}'

Request PUT /automations/settings

{
  "automationsEnabled": true
}

Response PUT /automations/settings

{
  "automationsEnabled": true
}

Retrieves all automation usage for a tenant

Limitations:

  • Maximum 1000 metrics per API call

Query Parameters GET /automations/usage

filter
string

Indicates how the metrics should be filtered

breakdown
optional
string

If specified, result will be broken apart for each automation

Responses GET /automations/usage

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/automations/usage

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/usage" \
 -H "Authorization: Bearer <API-key>"

Response GET /automations/usage

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

BadRequest

Bad Request

Unauthorized

Unauthorized

Forbidden

Forbidden

NotFound

Not found

InternalServerError

Internal Server Error

ServiceUnavailable

Service Unavailable

ErrorResponse

object

Properties

errors

No description

traceId
string

A way to trace the source of the error.

Error

object

Properties

code
string

The unique code for the error

title
string

A summary of what went wrong

detail
optional
string

May be used to provide additional details

UsageList

object

Properties

data

No description

UsageObject

object

Properties

name
string

The name for the metric

Enum:

runs

scheduledRun

triggeredRun

webhookRuns

duration

bandwidthIn

bandwidthOut

date
string

The date for the metric

value
integer

The value count of the metric

automation

No description

AutomationUsageObject

object

Properties

name
string

The name for the automation.

guid
string

The unique identifier for the automation.

ownerId
string

The unique identifier for the user who owns the automation

AutomationList

object

Properties

links
optional

No description

data

No description

AutomationDetailRequestObject

object

Properties

name
string

No description

description
string

No description

workspace
object

The workspace generated by the Qlik Application Automations editor.

state
default='available'
string

No description

Enum:

available

unavailable

disabled

schedules

No description

AutomationDetailResponseObject

object

Properties

id
string<uuid>

No description

ownerId
string

No description

name
string

No description

state
default='available'
string

No description

Enum:

available

unavailable

disabled

description
string

No description

schedules

No description

snippetIds
Array<string>

A list of snippets used inside the workspace.

endpointIds
Array<string>

A list of endpoints used inside the workspace.

connectorIds
Array<string>

A list of connectors used inside the workspace.

workspace
object

The workspace generated by the Qlik Application Automations editor.

lastRun

No description

lastRunStatus
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

paused

running

starting

stopped

executionToken
string

No description

runMode
string

No description

Enum:

manual

scheduled

triggered

webhook

createdAt
string<date-time>

No description

updatedAt
string<date-time>

No description

lastRunAt
string<date-time>

No description

AutomationListObject

object

Properties

id
string<uuid>

No description

ownerId
string

No description

name
string

No description

state
default='available'
string

No description

Enum:

available

unavailable

disabled

description
string

No description

lastRunStatus
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

paused

running

starting

stopped

runMode
string

No description

Enum:

manual

scheduled

triggered

webhook

createdAt
string<date-time>

No description

updatedAt
string<date-time>

No description

lastRunAt
string<date-time>

No description

ScheduleRequestObject

object

Properties

startAt
string

No description

stopAt
string

No description

interval
integer

time in seconds.

timezone
string

No description

ScheduleResponseObject

object

Properties

id
string<uuid>

No description

startAt
string

No description

stopAt
string

No description

lastStartedAt
string<date-time>

No description

interval
integer

time in seconds.

timezone
string

No description

RunList

object

Properties

links
optional

No description

data

No description

RunDetailRequestObject

object

Properties

id
optional
string<uuid>

No description

context
string

The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).

Enum:

test_run

editor

detail

api_sync

api_async

webhook

lookup

inputs
optional
object

No description

RunDetailResponseObject

object

Properties

id
string<uuid>

No description

context
string

The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).

Enum:

test_run

editor

detail

api_sync

api_async

webhook

lookup

status
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

running

starting

stopped

title
string

No description

isTestRun
boolean

No description

isArchived
boolean

No description

expectedInputs
object

No description

inputs
object

No description

error
object

No description

metrics
optional

No description

startTime
string<date-time>

No description

stopTime
string<date-time>

No description

scheduledStartTime
string<date-time>

No description

createdAt
string<date-time>

No description

updatedAt
string<date-time>

No description

RunListObject

object

Properties

id
string<uuid>

No description

context
string

No description

Enum:

test_run

editor

detail

api_sync

api_async

webhook

lookup

status
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

running

starting

stopped

title
string

No description

isTestRun
boolean

No description

isArchived
boolean

No description

error
object

No description

startTime
string<date-time>

No description

stopTime
string<date-time>

No description

scheduledStartTime
string<date-time>

No description

createdAt
string

No description

updatedAt
string

No description

SettingsObject

object

Properties

automationsEnabled
boolean

No description

v2.1.1
Was this page helpful?