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 OpenAPI spec

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

Facts

	Rate limit	Special (600 requests per minute)
	Replaced by	GET scheduling/tasks

Query Parameters

limit integer

The maximum number of resources to return for a request.

minimum = 1, maximum = 100, default = 20, default = 20
page string

The page cursor.
resourceId string

Filter tasks by its target resource ID.
sort string

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

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  The choreographer's unique identifier
  
  key string
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
  
  name string
  
  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])*$"
  
  start object
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedule string|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
  
  stateName string
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  events array of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  name string
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  type string
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  source string
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnly boolean
  
  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
  
  correlation array of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeName string
  
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValue string
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
  
  states array of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
  
  enabled boolean
  
  Indicates whether the task is enabled or not
  
  default = false
  
  version string
  
  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-]+)*))?$"
  
  metadata object
  
  Show metadata properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
  
  keepActive boolean
  
  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
  
  resourceId string
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
  
  annotations array of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
  
  description string
  
  Workflow description
  
  specVersion string
  
  Required
  
  Serverless Workflow schema version
  
  minLength = 1
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL to a resource request
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL to a resource request
  
  self object
  
  Show self properties
  
  href string
  
  Required
  
  URL to a resource request

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/tasks

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.getTasks({})

qlik task ls

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

Example 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)
	Replaced by	POST scheduling/tasks

Query Parameters

migrateFrom string

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

Request Body

Required

application/json object
Show application/json properties
- key string
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- name string
  
  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])*$"
- start object
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedule string|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
  
  stateName string
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- events array of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  name string
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  type string
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  source string
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnly boolean
  
  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
  
  correlation array of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeName string
  
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValue string
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- states array of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabled boolean
  
  Indicates whether the task is enabled or not
  
  default = false
- version string
  
  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-]+)*))?$"
- metadata object
  
  Show metadata properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdBy string
  
  The user ID of the user that created the task
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
- keepActive boolean
  
  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
- resourceId string
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotations array of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- description string
  
  Workflow description
- specVersion string
  
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

Responses

201

OK Response

application/json object
Show application/json properties
- id string
  
  The choreographer's unique identifier
- key string
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- name string
  
  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])*$"
- start object
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedule string|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
  
  stateName string
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- events array of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  name string
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  type string
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  source string
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnly boolean
  
  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
  
  correlation array of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeName string
  
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValue string
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- states array of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabled boolean
  
  Indicates whether the task is enabled or not
  
  default = false
- version string
  
  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-]+)*))?$"
- metadata object
  
  Show metadata properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
- keepActive boolean
  
  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
- resourceId string
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotations array of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- description string
  
  Workflow description
- specVersion string
  
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/tasks

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

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

qlik task create \
  --events-correlation-contextAttributeName '' \
  --metadata-orchestration-id 'string' \
  --metadata-orchestration-type 0 \
  --metadata-trigger-id 'string' \
  --metadata-trigger-type 0 \
  --name 'string' \
  --specVersion 'string' \
  --start-schedule string \
  --start-schedule-cron '' \
  --start-schedule-cron-expression '' \
  --start-schedule-cron-validUntil '' \
  --start-schedule-endDateTime '' \
  --start-schedule-interval '' \
  --start-schedule-recurrence '' \
  --start-schedule-startDateTime '' \
  --start-schedule-timezone '' \
  --states-onEvents-actions-functionRef-refName '' \
  --states-onEvents-eventRefs ''

curl "https://{tenant}.{region}.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"}'

Example 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)
	Replaced by	GET scheduling/tasks/{id}

Path Parameters

id string

Required

The task's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The choreographer's unique identifier
- key string
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- name string
  
  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])*$"
- start object
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedule string|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
  
  stateName string
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- events array of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  name string
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  type string
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  source string
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnly boolean
  
  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
  
  correlation array of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeName string
  
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValue string
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- states array of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabled boolean
  
  Indicates whether the task is enabled or not
  
  default = false
- version string
  
  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-]+)*))?$"
- metadata object
  
  Show metadata properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
- keepActive boolean
  
  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
- resourceId string
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotations array of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- description string
  
  Workflow description
- specVersion string
  
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/tasks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.getTask('string')

qlik task get 'string'

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

Example 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)
	Replaced by	PUT scheduling/tasks/{id}

Path Parameters

id string

Required

The task's unique identifier.

Request Body

Required

application/json object
Show application/json properties
- key string
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- name string
  
  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])*$"
- start object
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedule string|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
  
  stateName string
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- events array of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  name string
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  type string
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  source string
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnly boolean
  
  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
  
  correlation array of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeName string
  
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValue string
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- states array of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabled boolean
  
  Indicates whether the task is enabled or not
  
  default = false
- version string
  
  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-]+)*))?$"
- metadata object
  
  Show metadata properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdBy string
  
  The user ID of the user that created the task
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
- keepActive boolean
  
  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
- resourceId string
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotations array of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- description string
  
  Workflow description
- specVersion string
  
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The choreographer's unique identifier
- key string
  
  Optional expression that will be used to generate a domain-specific workflow instance identifier
- name string
  
  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])*$"
- start object
  
  One of:
  
  object
  
  Workflow start definition
  
  Show properties
  
  schedule string|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
  
  stateName string
  
  Name of the starting workflow state
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
- events array of objects
  
  Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced
  
  minItems = 1
  
  Show events properties
  
  name string
  
  Unique event name
  
  minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"
  
  type string
  
  CloudEvent type
  
  Can be one of: "com.qlik.v1.task.run.finished"
  
  source string
  
  CloudEvent source
  
  Can be one of: "system-events.task"
  
  dataOnly boolean
  
  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
  
  correlation array of objects
  
  CloudEvent correlation definitions
  
  minItems = 1
  
  Show correlation properties
  
  contextAttributeName string
  
  Required
  
  CloudEvent Extension Context Attribute name
  
  Can be one of: "id""status"
  
  contextAttributeValue string
  
  CloudEvent Extension Context Attribute value
  
  minLength = 1
- states array of objects
  
  State definitions
  
  minItems = 1
  
  One of:
  
  any
  
  any
- enabled boolean
  
  Indicates whether the task is enabled or not
  
  default = false
- version string
  
  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-]+)*))?$"
- metadata object
  
  Show metadata properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
- keepActive boolean
  
  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
- resourceId string
  
  The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.
- annotations array of strings
  
  List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
  
  minItems = 1
- description string
  
  Workflow description
- specVersion string
  
  Required
  
  Serverless Workflow schema version
  
  minLength = 1

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

PUT /api/v1/tasks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

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

qlik task update 'string' \
  --events-correlation-contextAttributeName '' \
  --metadata-orchestration-id 'string' \
  --metadata-orchestration-type 0 \
  --metadata-trigger-id 'string' \
  --metadata-trigger-type 0 \
  --name 'string' \
  --specVersion 'string' \
  --start-schedule string \
  --start-schedule-cron '' \
  --start-schedule-cron-expression '' \
  --start-schedule-cron-validUntil '' \
  --start-schedule-endDateTime '' \
  --start-schedule-interval '' \
  --start-schedule-recurrence '' \
  --start-schedule-startDateTime '' \
  --start-schedule-timezone '' \
  --states-onEvents-actions-functionRef-refName '' \
  --states-onEvents-eventRefs ''

curl "https://{tenant}.{region}.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"}'

Example 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)
	Replaced by	DELETE scheduling/tasks/{id}

Path Parameters

id string

Required

The task's unique identifier.

Responses

204

No Content response.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

DELETE /api/v1/tasks/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.deleteTask('string')

qlik task rm 'string'

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

Starts the specified task.

Facts

	Rate limit	Special (600 requests per minute)
	Replaced by	POST scheduling/tasks/{id}/actions/start

Query Parameters

source string

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

id string

Required

The task's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- message string

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.startTask('string', {})

qlik task start 'string'

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

Example Response

{
  "message": "Task started successfully"
}

Returns runs for the specified task.

Facts

	Rate limit	Special (600 requests per minute)
	Replaced by	GET scheduling/tasks/{id}/runs

Query Parameters

limit integer

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

minimum = 1, maximum = 100, default = 20, default = 20
page string

The page cursor.
sort string

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

id string

Required

The task's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Required
  
  The ID of the task run
  
  log string
  
  log info of the run
  
  status string
  
  Required
  
  task run status
  
  Can be one of: "RUNNING""SUCCEEDED""FAILED"
  
  taskId string
  
  Required
  
  The ID of the task
  
  endedAt string
  
  The UTC timestamp when the task run ended
  
  format = "date-time"
  
  actionId string
  
  Required
  
  The ID of the action
  
  taskMeta object
  
  Required
  
  Show taskMeta properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
  
  taskName string
  
  Required
  
  task name
  
  workerId string
  
  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.
  
  startedAt string
  
  The UTC timestamp when the task run started
  
  format = "date-time"
  
  executedAs string
  
  user ID of on behalf of whom the Task was executed.
  
  resourceId string
  
  Required
  
  The ID of the resource
  
  workerType string
  
  Required
  
  worker type or target system
  
  triggeredBy string
  
  Required
  
  Information about who or what triggered the task run.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL to a resource request
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL to a resource request
  
  self object
  
  Show self properties
  
  href string
  
  Required
  
  URL to a resource request

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.getTaskRuns('string', {})

qlik task run ls 'string'

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

Example 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)
	Replaced by	GET scheduling/tasks/{id}/runs/{runId}/log

Header Parameters

Accept string

The acceptable content types.

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

Path Parameters

id string

Required

The task's unique identifier.
runId string

Required

The run's unique identifier.

Responses

200

OK Response

text/plain object
Show text/plain properties
- logContent string

200

OK Response

application/json object
Show application/json properties
- logContent string
  
  Log content in plain text format

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.getTaskRunLog('string', 'string')

qlik task run log \
  --taskId 'string' \
  --runId 'string'

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

Example Response

[object Object]

Returns the last run of a specific task.

Facts

	Rate limit	Special (600 requests per minute)
	Replaced by	GET scheduling/tasks/{id}/runs/last

Path Parameters

id string

Required

The task's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  Required
  
  The ID of the task run
- log string
  
  log info of the run
- status string
  
  Required
  
  task run status
  
  Can be one of: "RUNNING""SUCCEEDED""FAILED"
- taskId string
  
  Required
  
  The ID of the task
- endedAt string
  
  The UTC timestamp when the task run ended
  
  format = "date-time"
- actionId string
  
  Required
  
  The ID of the action
- taskMeta object
  
  Required
  
  Show taskMeta properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
- taskName string
  
  Required
  
  task name
- workerId string
  
  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.
- startedAt string
  
  The UTC timestamp when the task run started
  
  format = "date-time"
- executedAs string
  
  user ID of on behalf of whom the Task was executed.
- resourceId string
  
  Required
  
  The ID of the resource
- workerType string
  
  Required
  
  worker type or target system
- triggeredBy string
  
  Required
  
  Information about who or what triggered the task run.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.getLastTaskRun('string')

qlik task run last 'string'

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

Example 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)
	Replaced by	GET scheduling/tasks/resources/{id}/runs

Query Parameters

limit integer

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

minimum = 1, maximum = 100, default = 20, default = 20
page string

The page cursor.
sort string

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

id string

Required

Filter tasks by its target resource ID

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Required
  
  The ID of the task run
  
  log string
  
  log info of the run
  
  status string
  
  Required
  
  task run status
  
  Can be one of: "RUNNING""SUCCEEDED""FAILED"
  
  taskId string
  
  Required
  
  The ID of the task
  
  endedAt string
  
  The UTC timestamp when the task run ended
  
  format = "date-time"
  
  actionId string
  
  Required
  
  The ID of the action
  
  taskMeta object
  
  Required
  
  Show taskMeta properties
  
  usage string
  
  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"
  
  ownerId string
  
  The user ID of the owner of the task
  
  spaceId string
  
  The space ID that the Task will operate in
  
  trigger object
  
  Show trigger properties
  
  id string
  
  Required
  
  The ID of the Trigger associated with the task in the choreographer
  
  type integer
  
  Required
  
  trigger type
  
  Can be one of: 0123
  
  tenantId string
  
  The tenant ID that the Task will operate in
  
  createdAt string
  
  The UTC timestamp when the task was created
  
  format = "date-time"
  
  createdBy string
  
  The user ID of the user that created the task
  
  deletedAt string
  
  The UTC timestamp when the task was deleted
  
  format = "date-time"
  
  updatedAt string
  
  The UTC timestamp when the task was last updated
  
  format = "date-time"
  
  disabledCode string
  
  why the Task is disabled
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
  
  migratedFrom string
  
  The ID of the reload-task this one was migrated from (if applicable)
  
  orchestration object
  
  Show orchestration properties
  
  id string
  
  Required
  
  The ID of the orchestration associated with the task in the choreographer
  
  type integer
  
  Required
  
  orchestration system type
  
  Can be one of: 0123
  
  attrs object
  
  Show additional optional properties
  
  string string
  
  taskName string
  
  Required
  
  task name
  
  workerId string
  
  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.
  
  startedAt string
  
  The UTC timestamp when the task run started
  
  format = "date-time"
  
  executedAs string
  
  user ID of on behalf of whom the Task was executed.
  
  resourceId string
  
  Required
  
  The ID of the resource
  
  workerType string
  
  Required
  
  worker type or target system
  
  triggeredBy string
  
  Required
  
  Information about who or what triggered the task run.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL to a resource request
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL to a resource request
  
  self object
  
  Show self properties
  
  href string
  
  Required
  
  URL to a resource request

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code integer
  
  inner object
  
  Show inner properties
  
  code integer
  
  inner object
  
  title string
  
  result any
  
  context string
  
  timestamp string
  
  title string
  
  result any
  
  context string
  
  timestamp string
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tasks.getTasksResourceRuns(
  'string',
  {},
)

qlik task resource-runs 'string'

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

Example 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

Example Response

Create a task

Facts

Query Parameters

Request Body

Responses

201

400

401

403

404

500

503

Example Response

Get a task

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Example Response

Update a task

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

503

Example 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

Example Response

List task runs

Facts

Query Parameters

Path Parameters