Tasks

API for managing tasks and task chains in Qlik Cloud. The requesting user needs the "reload" permission on the target resource to use this set of endpoints. A tenant admin can use GET /v1/tasks and DELETE /v1/tasks/{id} to perform administrative actions, even without the "reload" permission.

Download specification

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

Facts

Rate limit	Special (600 requests per minute)
Categories

Query Parameters

resourceIdstring
Required

Required. Filter tasks by its target resource ID. If not provided, request will fail with 400 (Bad Request).
limitinteger

The maximum number of resources to return for a request.

minimum = 1, maximum = 100, default = 20, default = 20
pagestring

The page cursor.
sortstring

The property of a resource to sort on (default sort is -updatedAt). A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

Can be one of: "+createdAt""-createdAt""+updatedAt""-updatedAt"

default = "-updatedAt"

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  The choreographer's unique identifier
  
  keystring
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
  
  namestring
  Required
  
  The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  startobject
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedulestring|object
  Required
  
  One of:
  
  string
  
  Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)
  
  minLength = 1
  
  object
  
  Start state schedule definition
  
  One of:
  
  any
  
  any
  
  stateNamestring
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  eventsarray of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  namestring
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  typestring
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  sourcestring
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnlyboolean
  
  If true, only the Event payload is accessible to consuming Workflow states. If false, both event payload and context attributes should be accessible
  
  default = true
  
  correlationarray of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeNamestring
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValuestring
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
  
  statesarray of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
  
  enabledboolean
  
  Indicates whether the task is enabled or not
  
  default = false
  
  versionstring
  
  Workflow version
  
  pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
  
  metadataobject
  
  Show metadata properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
  
  keepActiveboolean
  
  If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'
  
  default = false
  
  resourceIdstring
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
  
  annotationsarray of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
  
  descriptionstring
  
  Workflow description
  
  specVersionstring
  Required
  
  Serverless Workflow schema version
  
  minLength = 1
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL to a resource request
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL to a resource request

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/tasks

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "start": {
        "schedule": "string",
        "stateName": "string"
      },
      "events": [
        {
          "name": "string",
          "type": "com.qlik.v1.task.run.finished",
          "source": "system-events.task",
          "dataOnly": true,
          "correlation": [
            {
              "contextAttributeName": "id",
              "contextAttributeValue": "string"
            }
          ]
        }
      ],
      "states": [
        {
          "end": true,
          "name": "string",
          "type": "EVENT",
          "onEvents": [
            {
              "actions": [
                {
                  "name": "string",
                  "retryRef": "string",
                  "condition": "string",
                  "functionRef": {},
                  "retryableErrors": [
                    "string"
                  ],
                  "nonRetryableErrors": [
                    "string"
                  ]
                }
              ],
              "eventRefs": [
                "string"
              ],
              "actionMode": "SEQUENTIAL"
            }
          ],
          "timeouts": {
            "eventTimeout": "string",
            "stateExecTimeout": "string",
            "actionExecTimeout": "string"
          },
          "exclusive": true,
          "compensatedBy": "string"
        }
      ],
      "enabled": false,
      "version": "string",
      "metadata": {
        "usage": "ANALYTICS",
        "ownerId": "string",
        "spaceId": "string",
        "trigger": {
          "id": "string",
          "type": 0
        },
        "tenantId": "string",
        "createdAt": "2018-10-30T07:06:22Z",
        "createdBy": "string",
        "deletedAt": "2018-10-30T07:06:22Z",
        "updatedAt": "2018-10-30T07:06:22Z",
        "disabledCode": "MANUALLY",
        "migratedFrom": "string",
        "orchestration": {
          "id": "string",
          "type": 0,
          "attrs": {}
        }
      },
      "keepActive": false,
      "resourceId": "string",
      "annotations": [
        "string"
      ],
      "description": "string",
      "specVersion": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Query Parameters

migrateFromstring

ID of the reload-task to migrate from the old system (optional).

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- keystring
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- namestring
  Required
  
  The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- startobject
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedulestring|object
  Required
  
  One of:
  
  string
  
  Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)
  
  minLength = 1
  
  object
  
  Start state schedule definition
  
  One of:
  
  any
  
  any
  
  stateNamestring
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- eventsarray of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  namestring
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  typestring
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  sourcestring
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnlyboolean
  
  If true, only the Event payload is accessible to consuming Workflow states. If false, both event payload and context attributes should be accessible
  
  default = true
  
  correlationarray of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeNamestring
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValuestring
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- statesarray of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabledboolean
  
  Indicates whether the task is enabled or not
  
  default = false
- versionstring
  
  Workflow version
  
  pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
- metadataobject
  
  Show metadata properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdBystring
  
  The user ID of the user that created the task
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
- keepActiveboolean
  
  If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'
  
  default = false
- resourceIdstring
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotationsarray of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- descriptionstring
  
  Workflow description
- specVersionstring
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

Responses

201

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The choreographer's unique identifier
- keystring
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- namestring
  Required
  
  The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- startobject
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedulestring|object
  Required
  
  One of:
  
  string
  
  Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)
  
  minLength = 1
  
  object
  
  Start state schedule definition
  
  One of:
  
  any
  
  any
  
  stateNamestring
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- eventsarray of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  namestring
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  typestring
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  sourcestring
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnlyboolean
  
  If true, only the Event payload is accessible to consuming Workflow states. If false, both event payload and context attributes should be accessible
  
  default = true
  
  correlationarray of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeNamestring
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValuestring
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- statesarray of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabledboolean
  
  Indicates whether the task is enabled or not
  
  default = false
- versionstring
  
  Workflow version
  
  pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
- metadataobject
  
  Show metadata properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
- keepActiveboolean
  
  If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'
  
  default = false
- resourceIdstring
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotationsarray of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- descriptionstring
  
  Workflow description
- specVersionstring
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/tasks

curl "https://your-tenant.us.qlikcloud.com/api/v1/tasks" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"key":"string","name":"string","start":{"schedule":"string","stateName":"string"},"events":[{"name":"string","type":"com.qlik.v1.task.run.finished","source":"system-events.task","dataOnly":true,"correlation":[{"contextAttributeName":"id","contextAttributeValue":"string"}]}],"states":[{"end":true,"name":"string","type":"EVENT","onEvents":[{"actions":[{"name":"string","retryRef":"string","condition":"string","functionRef":{},"retryableErrors":["string"],"nonRetryableErrors":["string"]}],"eventRefs":["string"],"actionMode":"SEQUENTIAL"}],"timeouts":{"eventTimeout":"string","stateExecTimeout":"string","actionExecTimeout":"string"},"exclusive":true,"compensatedBy":"string"}],"enabled":false,"version":"string","metadata":{"usage":"ANALYTICS","ownerId":"string","spaceId":"string","trigger":{"id":"string","type":0},"tenantId":"string","createdBy":"string","updatedAt":"2018-10-30T07:06:22Z","disabledCode":"MANUALLY","migratedFrom":"string","orchestration":{"id":"string","type":0,"attrs":{}}},"keepActive":false,"resourceId":"string","annotations":["string"],"description":"string","specVersion":"string"}'

const https = require('https')
  const data = JSON.stringify({"key":"string","name":"string","start":{"schedule":"string","stateName":"string"},"events":[{"name":"string","type":"com.qlik.v1.task.run.finished","source":"system-events.task","dataOnly":true,"correlation":[{"contextAttributeName":"id","contextAttributeValue":"string"}]}],"states":[{"end":true,"name":"string","type":"EVENT","onEvents":[{"actions":[{"name":"string","retryRef":"string","condition":"string","functionRef":{},"retryableErrors":["string"],"nonRetryableErrors":["string"]}],"eventRefs":["string"],"actionMode":"SEQUENTIAL"}],"timeouts":{"eventTimeout":"string","stateExecTimeout":"string","actionExecTimeout":"string"},"exclusive":true,"compensatedBy":"string"}],"enabled":false,"version":"string","metadata":{"usage":"ANALYTICS","ownerId":"string","spaceId":"string","trigger":{"id":"string","type":0},"tenantId":"string","createdBy":"string","updatedAt":"2018-10-30T07:06:22Z","disabledCode":"MANUALLY","migratedFrom":"string","orchestration":{"id":"string","type":0,"attrs":{}}},"keepActive":false,"resourceId":"string","annotations":["string"],"description":"string","specVersion":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "key": "string",
  "name": "string",
  "start": {
    "schedule": "string",
    "stateName": "string"
  },
  "events": [
    {
      "name": "string",
      "type": "com.qlik.v1.task.run.finished",
      "source": "system-events.task",
      "dataOnly": true,
      "correlation": [
        {
          "contextAttributeName": "id",
          "contextAttributeValue": "string"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "string",
      "type": "EVENT",
      "onEvents": [
        {
          "actions": [
            {
              "name": "string",
              "retryRef": "string",
              "condition": "string",
              "functionRef": {},
              "retryableErrors": [
                "string"
              ],
              "nonRetryableErrors": [
                "string"
              ]
            }
          ],
          "eventRefs": [
            "string"
          ],
          "actionMode": "SEQUENTIAL"
        }
      ],
      "timeouts": {
        "eventTimeout": "string",
        "stateExecTimeout": "string",
        "actionExecTimeout": "string"
      },
      "exclusive": true,
      "compensatedBy": "string"
    }
  ],
  "enabled": false,
  "version": "string",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": "string",
    "spaceId": "string",
    "trigger": {
      "id": "string",
      "type": 0
    },
    "tenantId": "string",
    "createdBy": "string",
    "updatedAt": "2018-10-30T07:06:22Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "orchestration": {
      "id": "string",
      "type": 0,
      "attrs": {}
    }
  },
  "keepActive": false,
  "resourceId": "string",
  "annotations": [
    "string"
  ],
  "description": "string",
  "specVersion": "string"
}

Response

{
  "id": "string",
  "key": "string",
  "name": "string",
  "start": {
    "schedule": "string",
    "stateName": "string"
  },
  "events": [
    {
      "name": "string",
      "type": "com.qlik.v1.task.run.finished",
      "source": "system-events.task",
      "dataOnly": true,
      "correlation": [
        {
          "contextAttributeName": "id",
          "contextAttributeValue": "string"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "string",
      "type": "EVENT",
      "onEvents": [
        {
          "actions": [
            {
              "name": "string",
              "retryRef": "string",
              "condition": "string",
              "functionRef": {},
              "retryableErrors": [
                "string"
              ],
              "nonRetryableErrors": [
                "string"
              ]
            }
          ],
          "eventRefs": [
            "string"
          ],
          "actionMode": "SEQUENTIAL"
        }
      ],
      "timeouts": {
        "eventTimeout": "string",
        "stateExecTimeout": "string",
        "actionExecTimeout": "string"
      },
      "exclusive": true,
      "compensatedBy": "string"
    }
  ],
  "enabled": false,
  "version": "string",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": "string",
    "spaceId": "string",
    "trigger": {
      "id": "string",
      "type": 0
    },
    "tenantId": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "string",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "orchestration": {
      "id": "string",
      "type": 0,
      "attrs": {}
    }
  },
  "keepActive": false,
  "resourceId": "string",
  "annotations": [
    "string"
  ],
  "description": "string",
  "specVersion": "string"
}

Retrieves details for a specific task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Path Parameters

idstring
Required

The task's unique identifier.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The choreographer's unique identifier
- keystring
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- namestring
  Required
  
  The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- startobject
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedulestring|object
  Required
  
  One of:
  
  string
  
  Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)
  
  minLength = 1
  
  object
  
  Start state schedule definition
  
  One of:
  
  any
  
  any
  
  stateNamestring
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- eventsarray of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  namestring
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  typestring
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  sourcestring
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnlyboolean
  
  If true, only the Event payload is accessible to consuming Workflow states. If false, both event payload and context attributes should be accessible
  
  default = true
  
  correlationarray of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeNamestring
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValuestring
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- statesarray of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabledboolean
  
  Indicates whether the task is enabled or not
  
  default = false
- versionstring
  
  Workflow version
  
  pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
- metadataobject
  
  Show metadata properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
- keepActiveboolean
  
  If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'
  
  default = false
- resourceIdstring
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotationsarray of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- descriptionstring
  
  Workflow description
- specVersionstring
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/tasks/{id}

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "string",
  "key": "string",
  "name": "string",
  "start": {
    "schedule": "string",
    "stateName": "string"
  },
  "events": [
    {
      "name": "string",
      "type": "com.qlik.v1.task.run.finished",
      "source": "system-events.task",
      "dataOnly": true,
      "correlation": [
        {
          "contextAttributeName": "id",
          "contextAttributeValue": "string"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "string",
      "type": "EVENT",
      "onEvents": [
        {
          "actions": [
            {
              "name": "string",
              "retryRef": "string",
              "condition": "string",
              "functionRef": {},
              "retryableErrors": [
                "string"
              ],
              "nonRetryableErrors": [
                "string"
              ]
            }
          ],
          "eventRefs": [
            "string"
          ],
          "actionMode": "SEQUENTIAL"
        }
      ],
      "timeouts": {
        "eventTimeout": "string",
        "stateExecTimeout": "string",
        "actionExecTimeout": "string"
      },
      "exclusive": true,
      "compensatedBy": "string"
    }
  ],
  "enabled": false,
  "version": "string",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": "string",
    "spaceId": "string",
    "trigger": {
      "id": "string",
      "type": 0
    },
    "tenantId": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "string",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "orchestration": {
      "id": "string",
      "type": 0,
      "attrs": {}
    }
  },
  "keepActive": false,
  "resourceId": "string",
  "annotations": [
    "string"
  ],
  "description": "string",
  "specVersion": "string"
}

Updates a specific task. If the task is owned by another user, ownership will be transferred to the requesting user.

Facts

Rate limit	Special (600 requests per minute)
Categories

Path Parameters

idstring
Required

The task's unique identifier.

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- keystring
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- namestring
  Required
  
  The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- startobject
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedulestring|object
  Required
  
  One of:
  
  string
  
  Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)
  
  minLength = 1
  
  object
  
  Start state schedule definition
  
  One of:
  
  any
  
  any
  
  stateNamestring
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- eventsarray of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  namestring
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  typestring
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  sourcestring
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnlyboolean
  
  If true, only the Event payload is accessible to consuming Workflow states. If false, both event payload and context attributes should be accessible
  
  default = true
  
  correlationarray of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeNamestring
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValuestring
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- statesarray of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabledboolean
  
  Indicates whether the task is enabled or not
  
  default = false
- versionstring
  
  Workflow version
  
  pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
- metadataobject
  
  Show metadata properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdBystring
  
  The user ID of the user that created the task
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
- keepActiveboolean
  
  If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'
  
  default = false
- resourceIdstring
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotationsarray of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- descriptionstring
  
  Workflow description
- specVersionstring
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The choreographer's unique identifier
- keystring
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- namestring
  Required
  
  The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- startobject
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedulestring|object
  Required
  
  One of:
  
  string
  
  Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)
  
  minLength = 1
  
  object
  
  Start state schedule definition
  
  One of:
  
  any
  
  any
  
  stateNamestring
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- eventsarray of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  namestring
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  typestring
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  sourcestring
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnlyboolean
  
  If true, only the Event payload is accessible to consuming Workflow states. If false, both event payload and context attributes should be accessible
  
  default = true
  
  correlationarray of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeNamestring
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValuestring
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- statesarray of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabledboolean
  
  Indicates whether the task is enabled or not
  
  default = false
- versionstring
  
  Workflow version
  
  pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
- metadataobject
  
  Show metadata properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
- keepActiveboolean
  
  If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'
  
  default = false
- resourceIdstring
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotationsarray of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- descriptionstring
  
  Workflow description
- specVersionstring
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

PUT /v1/tasks/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/tasks/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"key":"string","name":"string","start":{"schedule":"string","stateName":"string"},"events":[{"name":"string","type":"com.qlik.v1.task.run.finished","source":"system-events.task","dataOnly":true,"correlation":[{"contextAttributeName":"id","contextAttributeValue":"string"}]}],"states":[{"end":true,"name":"string","type":"EVENT","onEvents":[{"actions":[{"name":"string","retryRef":"string","condition":"string","functionRef":{},"retryableErrors":["string"],"nonRetryableErrors":["string"]}],"eventRefs":["string"],"actionMode":"SEQUENTIAL"}],"timeouts":{"eventTimeout":"string","stateExecTimeout":"string","actionExecTimeout":"string"},"exclusive":true,"compensatedBy":"string"}],"enabled":false,"version":"string","metadata":{"usage":"ANALYTICS","ownerId":"string","spaceId":"string","trigger":{"id":"string","type":0},"tenantId":"string","createdBy":"string","updatedAt":"2018-10-30T07:06:22Z","disabledCode":"MANUALLY","migratedFrom":"string","orchestration":{"id":"string","type":0,"attrs":{}}},"keepActive":false,"resourceId":"string","annotations":["string"],"description":"string","specVersion":"string"}'

const https = require('https')
  const data = JSON.stringify({"key":"string","name":"string","start":{"schedule":"string","stateName":"string"},"events":[{"name":"string","type":"com.qlik.v1.task.run.finished","source":"system-events.task","dataOnly":true,"correlation":[{"contextAttributeName":"id","contextAttributeValue":"string"}]}],"states":[{"end":true,"name":"string","type":"EVENT","onEvents":[{"actions":[{"name":"string","retryRef":"string","condition":"string","functionRef":{},"retryableErrors":["string"],"nonRetryableErrors":["string"]}],"eventRefs":["string"],"actionMode":"SEQUENTIAL"}],"timeouts":{"eventTimeout":"string","stateExecTimeout":"string","actionExecTimeout":"string"},"exclusive":true,"compensatedBy":"string"}],"enabled":false,"version":"string","metadata":{"usage":"ANALYTICS","ownerId":"string","spaceId":"string","trigger":{"id":"string","type":0},"tenantId":"string","createdBy":"string","updatedAt":"2018-10-30T07:06:22Z","disabledCode":"MANUALLY","migratedFrom":"string","orchestration":{"id":"string","type":0,"attrs":{}}},"keepActive":false,"resourceId":"string","annotations":["string"],"description":"string","specVersion":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "key": "string",
  "name": "string",
  "start": {
    "schedule": "string",
    "stateName": "string"
  },
  "events": [
    {
      "name": "string",
      "type": "com.qlik.v1.task.run.finished",
      "source": "system-events.task",
      "dataOnly": true,
      "correlation": [
        {
          "contextAttributeName": "id",
          "contextAttributeValue": "string"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "string",
      "type": "EVENT",
      "onEvents": [
        {
          "actions": [
            {
              "name": "string",
              "retryRef": "string",
              "condition": "string",
              "functionRef": {},
              "retryableErrors": [
                "string"
              ],
              "nonRetryableErrors": [
                "string"
              ]
            }
          ],
          "eventRefs": [
            "string"
          ],
          "actionMode": "SEQUENTIAL"
        }
      ],
      "timeouts": {
        "eventTimeout": "string",
        "stateExecTimeout": "string",
        "actionExecTimeout": "string"
      },
      "exclusive": true,
      "compensatedBy": "string"
    }
  ],
  "enabled": false,
  "version": "string",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": "string",
    "spaceId": "string",
    "trigger": {
      "id": "string",
      "type": 0
    },
    "tenantId": "string",
    "createdBy": "string",
    "updatedAt": "2018-10-30T07:06:22Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "orchestration": {
      "id": "string",
      "type": 0,
      "attrs": {}
    }
  },
  "keepActive": false,
  "resourceId": "string",
  "annotations": [
    "string"
  ],
  "description": "string",
  "specVersion": "string"
}

Response

{
  "id": "string",
  "key": "string",
  "name": "string",
  "start": {
    "schedule": "string",
    "stateName": "string"
  },
  "events": [
    {
      "name": "string",
      "type": "com.qlik.v1.task.run.finished",
      "source": "system-events.task",
      "dataOnly": true,
      "correlation": [
        {
          "contextAttributeName": "id",
          "contextAttributeValue": "string"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "string",
      "type": "EVENT",
      "onEvents": [
        {
          "actions": [
            {
              "name": "string",
              "retryRef": "string",
              "condition": "string",
              "functionRef": {},
              "retryableErrors": [
                "string"
              ],
              "nonRetryableErrors": [
                "string"
              ]
            }
          ],
          "eventRefs": [
            "string"
          ],
          "actionMode": "SEQUENTIAL"
        }
      ],
      "timeouts": {
        "eventTimeout": "string",
        "stateExecTimeout": "string",
        "actionExecTimeout": "string"
      },
      "exclusive": true,
      "compensatedBy": "string"
    }
  ],
  "enabled": false,
  "version": "string",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": "string",
    "spaceId": "string",
    "trigger": {
      "id": "string",
      "type": 0
    },
    "tenantId": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "string",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "orchestration": {
      "id": "string",
      "type": 0,
      "attrs": {}
    }
  },
  "keepActive": false,
  "resourceId": "string",
  "annotations": [
    "string"
  ],
  "description": "string",
  "specVersion": "string"
}

Deletes a specific task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Path Parameters

idstring
Required

The task's unique identifier.

Responses

204

No Content response.

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

DELETE /v1/tasks/{id}

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Starts the specified task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Query Parameters

sourcestring

Indicates the origin of the trigger. If not provided, defaults to 'manual'. For event-triggered tasks, this can be the name of the triggering task.

default = "manual"

Path Parameters

idstring
Required

The task's unique identifier.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- messagestring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/tasks/{id}/actions/start

curl "https://your-tenant.us.qlikcloud.com/api/v1/tasks/{id}/actions/start" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}/actions/start',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "message": "Task started successfully"
}

Returns runs for the specified task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Query Parameters

limitinteger

The maximum number of task runs to return for a request.

minimum = 1, maximum = 100, default = 20, default = 20
pagestring

The page cursor.
sortstring

The property of a resource to sort on (default sort is -startedAt). A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

Can be one of: "+startedAt""-startedAt""+endedAt""-endedAt""+status""-status""+taskId""-taskId""+actionId""-actionId"

default = "-startedAt"

Path Parameters

idstring
Required

The task's unique identifier.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  The ID of the task run
  
  logstring
  
  log info of the run
  
  statusstring
  Required
  
  task run status
  
  Can be one of: "RUNNING""SUCCEEDED""FAILED"
  
  taskIdstring
  Required
  
  The ID of the task
  
  endedAtstring
  
  The UTC timestamp when the task run ended
  
  format = "date-time"
  
  actionIdstring
  Required
  
  The ID of the action
  
  taskMetaobject
  Required
  
  Show taskMeta properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
  
  taskNamestring
  Required
  
  task name
  
  workerIdstring
  Required
  
  The ID of the worker who is carrying out the real job. e.g. App.Reload job is carried out by Reload Engine, in this case, workerId will be reloadId from reload engine. Or, if we are using Automation, workerId will be Automation runId.
  
  startedAtstring
  
  The UTC timestamp when the task run started
  
  format = "date-time"
  
  executedAsstring
  
  user ID of on behalf of whom the Task was executed.
  
  resourceIdstring
  Required
  
  The ID of the resource
  
  workerTypestring
  Required
  
  worker type or target system
  
  triggeredBystring
  Required
  
  Information about who or what triggered the task run.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL to a resource request
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL to a resource request

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/tasks/{id}/runs

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}/runs',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "string",
      "log": "string",
      "status": "RUNNING",
      "taskId": "string",
      "endedAt": "2018-10-30T07:06:22Z",
      "actionId": "string",
      "taskMeta": {
        "usage": "ANALYTICS",
        "ownerId": "string",
        "spaceId": "string",
        "trigger": {
          "id": "string",
          "type": 0
        },
        "tenantId": "string",
        "createdAt": "2018-10-30T07:06:22Z",
        "createdBy": "string",
        "deletedAt": "2018-10-30T07:06:22Z",
        "updatedAt": "2018-10-30T07:06:22Z",
        "disabledCode": "MANUALLY",
        "migratedFrom": "string",
        "orchestration": {
          "id": "string",
          "type": 0,
          "attrs": {}
        }
      },
      "taskName": "string",
      "workerId": "string",
      "startedAt": "2018-10-30T07:06:22Z",
      "executedAs": "string",
      "resourceId": "string",
      "workerType": "string",
      "triggeredBy": "manual"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Get specific run log of a task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Header Parameters

Acceptstring

The acceptable content types.

Can be one of: "application/json""text/plain"

default = "application/json"

Path Parameters

idstring
Required

The task's unique identifier.
runIdstring
Required

The run's unique identifier.

Responses

200

text/plain

OK Response

text/plainobject
Show text/plain properties
- logContentstring

200

application/json

OK Response

application/jsonobject
Show application/json properties
- logContentstring
  
  Log content in plain text format

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/tasks/{id}/runs/{runId}/log

curl "https://your-tenant.us.qlikcloud.com/api/v1/tasks/{id}/runs/{runId}/log" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}/runs/{runId}/log',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "logContent": "Task run log content"
}

Returns the last run of a specific task.

Facts

Rate limit	Special (600 requests per minute)
Categories

Path Parameters

idstring
Required

The task's unique identifier.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The ID of the task run
- logstring
  
  log info of the run
- statusstring
  Required
  
  task run status
  
  Can be one of: "RUNNING""SUCCEEDED""FAILED"
- taskIdstring
  Required
  
  The ID of the task
- endedAtstring
  
  The UTC timestamp when the task run ended
  
  format = "date-time"
- actionIdstring
  Required
  
  The ID of the action
- taskMetaobject
  Required
  
  Show taskMeta properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
- taskNamestring
  Required
  
  task name
- workerIdstring
  Required
  
  The ID of the worker who is carrying out the real job. e.g. App.Reload job is carried out by Reload Engine, in this case, workerId will be reloadId from reload engine. Or, if we are using Automation, workerId will be Automation runId.
- startedAtstring
  
  The UTC timestamp when the task run started
  
  format = "date-time"
- executedAsstring
  
  user ID of on behalf of whom the Task was executed.
- resourceIdstring
  Required
  
  The ID of the resource
- workerTypestring
  Required
  
  worker type or target system
- triggeredBystring
  Required
  
  Information about who or what triggered the task run.

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/tasks/{id}/runs/last

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/{id}/runs/last',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "string",
  "log": "string",
  "status": "RUNNING",
  "taskId": "string",
  "endedAt": "2018-10-30T07:06:22Z",
  "actionId": "string",
  "taskMeta": {
    "usage": "ANALYTICS",
    "ownerId": "string",
    "spaceId": "string",
    "trigger": {
      "id": "string",
      "type": 0
    },
    "tenantId": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "string",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "orchestration": {
      "id": "string",
      "type": 0,
      "attrs": {}
    }
  },
  "taskName": "string",
  "workerId": "string",
  "startedAt": "2018-10-30T07:06:22Z",
  "executedAs": "string",
  "resourceId": "string",
  "workerType": "string",
  "triggeredBy": "manual"
}

Returns a list of task runs for a specified resourceId.

Facts

Rate limit	Special (600 requests per minute)
Categories

Query Parameters

limitinteger

The maximum number of task runs to return for a request.

minimum = 1, maximum = 100, default = 20, default = 20
pagestring

The page cursor.
sortstring

The property of a resource to sort on (default sort is -startedAt). A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

Can be one of: "+startedAt""-startedAt""+endedAt""-endedAt""+status""-status""+taskId""-taskId""+actionId""-actionId"

default = "-startedAt"

Path Parameters

idstring
Required

Filter tasks by its target resource ID

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  The ID of the task run
  
  logstring
  
  log info of the run
  
  statusstring
  Required
  
  task run status
  
  Can be one of: "RUNNING""SUCCEEDED""FAILED"
  
  taskIdstring
  Required
  
  The ID of the task
  
  endedAtstring
  
  The UTC timestamp when the task run ended
  
  format = "date-time"
  
  actionIdstring
  Required
  
  The ID of the action
  
  taskMetaobject
  Required
  
  Show taskMeta properties
  
  usagestring
  
  resource usage. Normally it means in which product domain the resource is used. if this field is not presented, it has default of ANALYTICS
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
  
  ownerIdstring
  
  The user ID of the owner of the task
  
  spaceIdstring
  
  The space ID that the Task will operate in
  
  triggerobject
  
  Show trigger properties
  
  idstring
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  typeinteger
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantIdstring
  
  The tenant ID that the Task will operate in
  
  createdAtstring
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBystring
  
  The user ID of the user that created the task
  
  deletedAtstring
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAtstring
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCodestring
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFromstring
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestrationobject
  
  Show orchestration properties
  
  idstring
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  typeinteger
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrsobject
  
  additional properties
  
  taskNamestring
  Required
  
  task name
  
  workerIdstring
  Required
  
  The ID of the worker who is carrying out the real job. e.g. App.Reload job is carried out by Reload Engine, in this case, workerId will be reloadId from reload engine. Or, if we are using Automation, workerId will be Automation runId.
  
  startedAtstring
  
  The UTC timestamp when the task run started
  
  format = "date-time"
  
  executedAsstring
  
  user ID of on behalf of whom the Task was executed.
  
  resourceIdstring
  Required
  
  The ID of the resource
  
  workerTypestring
  Required
  
  worker type or target system
  
  triggeredBystring
  Required
  
  Information about who or what triggered the task run.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL to a resource request
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL to a resource request

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codeinteger
  
  innerany
  
  titlestring
  
  resultany
  
  contextstring
  
  timestampstring
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/tasks/resources/{id}/runs

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tasks/resources/{id}/runs',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "string",
      "log": "string",
      "status": "RUNNING",
      "taskId": "string",
      "endedAt": "2018-10-30T07:06:22Z",
      "actionId": "string",
      "taskMeta": {
        "usage": "ANALYTICS",
        "ownerId": "string",
        "spaceId": "string",
        "trigger": {
          "id": "string",
          "type": 0
        },
        "tenantId": "string",
        "createdAt": "2018-10-30T07:06:22Z",
        "createdBy": "string",
        "deletedAt": "2018-10-30T07:06:22Z",
        "updatedAt": "2018-10-30T07:06:22Z",
        "disabledCode": "MANUALLY",
        "migratedFrom": "string",
        "orchestration": {
          "id": "string",
          "type": 0,
          "attrs": {}
        }
      },
      "taskName": "string",
      "workerId": "string",
      "startedAt": "2018-10-30T07:06:22Z",
      "executedAs": "string",
      "resourceId": "string",
      "workerType": "string",
      "triggeredBy": "manual"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Tasks

Endpoints

List tasks

Facts

Query Parameters

Responses

200

400

401

403

404

500

503

Response

Create a task

Facts

Query Parameters

Request Body

Responses

201

400

401

403

404

500

503

Request

Response

Get a task

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Response

Update a task

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

503

Request

Response

Delete a task

Facts

Path Parameters

Responses

204

400

401

403

404

500

503

Start a task

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

500

503

Response

List task runs

Facts