Tasks

Download OpenAPI spec

List tasks

Retrieves a paginated list of tasks the requesting user has access to. Results include task metadata such as owner, resource, space, and last run status. Use the filter parameter to narrow results by field values, or sort to control the ordering.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Query Parameters

  • filterstring

    Advanced filter expression using RFC 7644 SCIM syntax. Refer to RFC 7644 for syntax details. All comparisons are case-insensitive. Supported fields: name, enabled, resourceId, ownerId, spaceId, createdAt, updatedAt, updatedBy, lastStatus, lastTriggeredBy, lastStartedAt, lastEndedAt, lastExecutedAs, and triggerType.

  • limitinteger

    Maximum number of tasks to return per page.

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

  • pagestring

    Cursor token for fetching the next page of results.

  • resourceIdstring

    The unique identifier of the resource to filter tasks by.

  • sortstring

    Field and direction to sort results by. Prefix the field name with + for ascending or - for descending order. Defaults to -updatedAt.

    Can be one of: "+createdAt""-createdAt""+enabled""-enabled""+name""-name""+ownerId""-ownerId""+resourceId""-resourceId""+spaceId""-spaceId""+updatedAt""-updatedAt""+updatedBy""-updatedBy""+lastStatus""-lastStatus""+lastTriggeredBy""-lastTriggeredBy""+lastStartedAt""-lastStartedAt""+lastEndedAt""-lastEndedAt""+lastExecutedAs""-lastExecutedAs""+triggerType""-triggerType"

    default = "-updatedAt"

Responses

200

Tasks retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        The unique identifier assigned to the task by the service.

      • keystring

        An optional expression used to generate a domain-specific workflow instance identifier.

      • namestring
        RequiredFilterable

        The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

        minLength = 1, maxLength = 100

      • startobject

        The start definition for a workflow, including optional schedule configuration.

        One of:
        • object

          A scheduled workflow start definition.

          Show properties
          • schedulestring|object
            Required
            One of:
            • string

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

              minLength = 1

            • object

              A structured schedule definition with optional recurrence, date range, and timezone.

              Show properties
              • cronstring|object
                One of:
                • string

                  A cron expression defining when workflow instances should be created automatically.

                  minLength = 1

                • object
                  Show properties
                  • expressionstring
                    Required

                    A cron expression describing when the workflow instance should be created.

                    minLength = 1

                  • validUntilstring

                    The date and time (ISO 8601 format) after which this cron expression is no longer active.
              • intervalstring

                A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

                minLength = 1

              • timezonestring

                The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

                default = "UTC"

              • recurrencestring

                An RRULE recurrence rule string defining when the workflow recurs.

              • endDateTimestring

                The date and time (ISO 8601 format) when the workflow schedule ends.

              • startDateTimestring

                The date and time (ISO 8601 format) when the workflow schedule begins.
          • stateNamestring

            The name of the starting workflow state.

            minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

      • eventsarray of objects

        CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

        minItems = 1

        Show events properties
        • namestring

          A unique name identifying this event definition within the workflow.

          minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • typestring

          The CloudEvents type attribute identifying the kind of event.

          Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

        • sourcestring

          The CloudEvents source attribute identifying the origin of the event.

          Can be one of: "system-events.task""dataset.updated"

        • dataOnlyboolean

          When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

          default = true

        • correlationarray of objects

          Correlation definitions used to match incoming CloudEvents to this workflow instance.

          minItems = 1

          Show correlation properties
          • contextAttributeNamestring
            Required

            The name of the CloudEvent extension context attribute to match on.

            Can be one of: "id""status""appId""spaceId""datasetId"

          • contextAttributeValuestring

            The expected value of the CloudEvent extension context attribute.

            minLength = 1

      • statesarray of objects

        The list of state definitions that compose the workflow.

        minItems = 1

        Show states properties
        • endboolean

          Marks this state as a terminal state in the workflow.

          default = true

        • namestring

          The name of this state, unique within the workflow.

          minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • typestring

          The state type. Must be EVENT for event-driven states.

          Can be one of: "EVENT"

        • onEventsarray of objects

          The events to consume and the optional actions to perform when they are received.

          Show onEvents properties
          • actionsarray of objects

            Actions to perform when the matched events are consumed.

            Show actions properties
            • namestring

              A unique name for this action within the workflow.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • retryRefstring

              A reference to a defined workflow retry policy. If absent, the default retry policy applies.

            • conditionstring

              An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

              minLength = 1

            • functionRefobject

              A reference to a function to invoke, either as a name string or a structured object.

              One of:
              • string

                The name of the referenced function.

                minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

              • object

                A structured function reference with arguments and invocation options.

                Show properties
                • invokestring

                  Specifies whether the function is invoked synchronously or asynchronously.

                  Can be one of: "SYNC""ASYNC"

                  default = "SYNC"

                • refNamestring
                  Required

                  The name of the function to invoke.

                  Can be one of: "app.reload"

                • argumentsobject

                  Arguments to pass to the function.

                  additionalProperties = true

                • selectionSetstring

                  A GraphQL selection set string. Only applicable when the function type is graphql.
            • retryableErrorsarray of strings

              Workflow error references for which this action must be retried. Used only when autoRetries is false.

              minItems = 1

            • nonRetryableErrorsarray of strings

              Workflow error references for which this action must not be retried. Used only when autoRetries is true.

              minItems = 1

          • eventRefsarray of strings
            Required

            References to one or more unique event names defined in the workflow events list.

            minItems = 1, maxItems = 100, uniqueItems = true

          • actionModestring

            Specifies whether actions are performed sequentially or in parallel.

            Can be one of: "SEQUENTIAL""PARALLEL"

            default = "SEQUENTIAL"

        • timeoutsobject

          State-specific timeout durations.

          Show timeouts properties
          • eventTimeoutstring

            The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

          • stateExecTimeoutstring

            The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

          • actionExecTimeoutstring

            The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

        • exclusiveboolean

          When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

          default = true

        • compensatedBystring

          The unique name of a workflow state responsible for compensating this state if it fails.

          minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • enabledboolean

        Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

        default = false

      • versionstring

        The semantic version of the workflow definition.

        pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

      • metadataobject
        Show metadata properties
        • usagestring

          The product domain in which the resource is used. Defaults to ANALYTICS when not present.

          Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

        • ownerIdstring

          The user ID of the task owner.

        • spaceIdstring

          The unique identifier of the space the task operates in.

        • triggerobject
          Show trigger properties
          • idstring
            Required

            The unique identifier of the trigger associated with this task.

          • typeinteger
            Required

            The type identifier of the trigger associated with this task.

            Can be one of: 01234

        • tenantIdstring

          The unique identifier of the tenant the task operates in.

        • topologyobject

          Indicates the task's position in a dependency graph.

          Show topology properties
          • isChildboolean

            When true, this task is triggered by one or more parent tasks.

          • isParentboolean

            When true, this task has one or more downstream dependent tasks.
        • createdAtstring

          The UTC timestamp when the task was created.

          format = "date-time"

        • createdBystring

          The user ID of the user who created the task.

        • deletedAtstring

          The UTC timestamp when the task was deleted.

          format = "date-time"

        • spaceTypestring

          The type of space the task operates in.

          Can be one of: "personal""shared""managed"

        • updatedAtstring

          The UTC timestamp when the task was last updated.

          format = "date-time"

        • disabledCodestring

          The reason the task is currently disabled.

          Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

        • migratedFromstring

          The unique identifier of the legacy reload task this task was migrated from, if applicable.

        • resourceNamestring

          The name of the resource on which the task was created.

        • resourceTypestring

          The type of resource on which the task was created.

        • orchestrationobject
          Show orchestration properties
          • idstring
            Required

            The unique identifier of the orchestration instance associated with this task in the scheduling service.

          • typeinteger
            Required

            The type identifier of the orchestration system handling this task.

            Can be one of: 0123

          • attrsobject

            Additional attributes of the orchestration instance associated with this task in the scheduling service.

            Show additional optional properties
            • stringstring
          • lastRunobject
            Show lastRun properties
            • idstring
              Required

              The unique identifier of the task run.

            • statusstring
              Required

              The current status of the task run.

              Can be one of: "RUNNING""SUCCEEDED""FAILED"

            • endedAtstring

              The UTC timestamp when the task run ended.

              format = "date-time"

            • workerIdstring
              Required

              The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

            • startedAtstring

              The UTC timestamp when the task run started.

              format = "date-time"

            • executedAsstring

              The user ID of the user on whose behalf the task was executed.

            • workerTypestring
              Required

              The type or name of the target system that executed the run.

            • triggeredBystring
              Required

              The identity or event that triggered the task run.
        • scriptOwnerIdstring

          The user ID of the owner whose script context is used when running the task.

        • resourceSubTypestring

          The subtype of resource on which the task was created.
      • keepActiveboolean

        When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

        default = false

      • resourceIdstring

        The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

      • annotationsarray of strings

        A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

        minItems = 1

      • descriptionstring

        A human-readable description of the workflow's purpose.

        maxLength = 1024

      • specVersionstring
        Required

        The Serverless Workflow specification version used by this task.

        minLength = 1

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
          Required

          The URL of the linked resource.
      • prevobject
        Show prev properties
        • hrefstring
          Required

          The URL of the linked resource.
      • selfobject
        Show self properties
        • hrefstring
          Required

          The URL of the linked resource.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks 
// qlik-api has not implemented support for `GET /api/scheduling/tasks` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task ls
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "TaskExample",
      "events": [
        {
          "name": "event1",
          "type": "com.qlik/active-analytics-orch",
          "source": "dataset.updated",
          "correlation": [
            {
              "contextAttributeName": "appId",
              "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            }
          ]
        }
      ],
      "states": [
        {
          "end": true,
          "name": "Reload",
          "type": "event",
          "onEvents": [
            {
              "actions": [
                {
                  "name": "app.reload",
                  "functionRef": {
                    "refName": "app.reload",
                    "arguments": {
                      "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                      "partial": false
                    }
                  }
                }
              ],
              "eventRefs": [
                "app1-dataset-updated"
              ]
            }
          ],
          "exclusive": false
        }
      ],
      "enabled": true,
      "version": "1.0.0",
      "metadata": {
        "usage": "ANALYTICS",
        "ownerId": 0,
        "spaceId": "",
        "trigger": {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "type": 4
        },
        "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "createdAt": "2025-08-31T23:22:27.929Z",
        "createdBy": 0,
        "updatedAt": "2025-08-31T23:27:51.207Z",
        "orchestration": {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "type": 3,
          "attrs": {
            "last_run_status": "SUCCEEDED",
            "last_run_endedAt": "2025-08-31T23:28:06Z",
            "last_run_startedAt": "2025-08-31T23:28:04Z",
            "last_run_worker_type": "reloads"
          }
        }
      },
      "keepActive": false,
      "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "description": "this is an example of task response",
      "specVersion": "1.16.0"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Create a task

Creates a new task for the specified resource. The task is owned by the requesting user and is disabled by default until explicitly enabled. The resourceId is derived automatically from the task's state definitions and cannot be set directly in the request body.

Facts

Rate limit Tier 2 (100 requests per minute)
Replaces

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • keystring

      An optional expression used to generate a domain-specific workflow instance identifier.

    • namestring
      RequiredFilterable

      The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

      minLength = 1, maxLength = 100

    • startobject

      The start definition for a workflow, including optional schedule configuration.

      One of:
      • object

        A scheduled workflow start definition.

        Show properties
        • schedulestring|object
          Required
          One of:
          • string

            A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

            minLength = 1

          • object

            A structured schedule definition with optional recurrence, date range, and timezone.

            Show properties
            • cronstring|object
              One of:
              • string

                A cron expression defining when workflow instances should be created automatically.

                minLength = 1

              • object
                Show properties
                • expressionstring
                  Required

                  A cron expression describing when the workflow instance should be created.

                  minLength = 1

                • validUntilstring

                  The date and time (ISO 8601 format) after which this cron expression is no longer active.
            • intervalstring

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

              minLength = 1

            • timezonestring

              The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

              default = "UTC"

            • recurrencestring

              An RRULE recurrence rule string defining when the workflow recurs.

            • endDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule ends.

            • startDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule begins.
        • stateNamestring

          The name of the starting workflow state.

          minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

    • eventsarray of objects

      CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

      minItems = 1

      Show events properties
      • namestring

        A unique name identifying this event definition within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The CloudEvents type attribute identifying the kind of event.

        Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

      • sourcestring

        The CloudEvents source attribute identifying the origin of the event.

        Can be one of: "system-events.task""dataset.updated"

      • dataOnlyboolean

        When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

        default = true

      • correlationarray of objects

        Correlation definitions used to match incoming CloudEvents to this workflow instance.

        minItems = 1

        Show correlation properties
        • contextAttributeNamestring
          Required

          The name of the CloudEvent extension context attribute to match on.

          Can be one of: "id""status""appId""spaceId""datasetId"

        • contextAttributeValuestring

          The expected value of the CloudEvent extension context attribute.

          minLength = 1

    • statesarray of objects

      The list of state definitions that compose the workflow.

      minItems = 1

      Show states properties
      • endboolean

        Marks this state as a terminal state in the workflow.

        default = true

      • namestring

        The name of this state, unique within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The state type. Must be EVENT for event-driven states.

        Can be one of: "EVENT"

      • onEventsarray of objects

        The events to consume and the optional actions to perform when they are received.

        Show onEvents properties
        • actionsarray of objects

          Actions to perform when the matched events are consumed.

          Show actions properties
          • namestring

            A unique name for this action within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • retryRefstring

            A reference to a defined workflow retry policy. If absent, the default retry policy applies.

          • conditionstring

            An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

            minLength = 1

          • functionRefobject

            A reference to a function to invoke, either as a name string or a structured object.

            One of:
            • string

              The name of the referenced function.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • object

              A structured function reference with arguments and invocation options.

              Show properties
              • invokestring

                Specifies whether the function is invoked synchronously or asynchronously.

                Can be one of: "SYNC""ASYNC"

                default = "SYNC"

              • refNamestring
                Required

                The name of the function to invoke.

                Can be one of: "app.reload"

              • argumentsobject

                Arguments to pass to the function.

                additionalProperties = true

              • selectionSetstring

                A GraphQL selection set string. Only applicable when the function type is graphql.
          • retryableErrorsarray of strings

            Workflow error references for which this action must be retried. Used only when autoRetries is false.

            minItems = 1

          • nonRetryableErrorsarray of strings

            Workflow error references for which this action must not be retried. Used only when autoRetries is true.

            minItems = 1

        • eventRefsarray of strings
          Required

          References to one or more unique event names defined in the workflow events list.

          minItems = 1, maxItems = 100, uniqueItems = true

        • actionModestring

          Specifies whether actions are performed sequentially or in parallel.

          Can be one of: "SEQUENTIAL""PARALLEL"

          default = "SEQUENTIAL"

      • timeoutsobject

        State-specific timeout durations.

        Show timeouts properties
        • eventTimeoutstring

          The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • stateExecTimeoutstring

          The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • actionExecTimeoutstring

          The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

      • exclusiveboolean

        When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

        default = true

      • compensatedBystring

        The unique name of a workflow state responsible for compensating this state if it fails.

        minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

    • enabledboolean

      Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

      default = false

    • versionstring

      The semantic version of the workflow definition.

      pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

    • metadataobject
      Show metadata properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdBystring

        The user ID of the user who created the task.

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • keepActiveboolean

      When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

      default = false

    • resourceIdstring

      The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

    • annotationsarray of strings

      A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

      minItems = 1

    • descriptionstring

      A human-readable description of the workflow's purpose.

      maxLength = 1024

    • specVersionstring
      Required

      The Serverless Workflow specification version used by this task.

      minLength = 1

Responses

201

Task created successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      The unique identifier assigned to the task by the service.

    • keystring

      An optional expression used to generate a domain-specific workflow instance identifier.

    • namestring
      RequiredFilterable

      The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

      minLength = 1, maxLength = 100

    • startobject

      The start definition for a workflow, including optional schedule configuration.

      One of:
      • object

        A scheduled workflow start definition.

        Show properties
        • schedulestring|object
          Required
          One of:
          • string

            A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

            minLength = 1

          • object

            A structured schedule definition with optional recurrence, date range, and timezone.

            Show properties
            • cronstring|object
              One of:
              • string

                A cron expression defining when workflow instances should be created automatically.

                minLength = 1

              • object
                Show properties
                • expressionstring
                  Required

                  A cron expression describing when the workflow instance should be created.

                  minLength = 1

                • validUntilstring

                  The date and time (ISO 8601 format) after which this cron expression is no longer active.
            • intervalstring

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

              minLength = 1

            • timezonestring

              The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

              default = "UTC"

            • recurrencestring

              An RRULE recurrence rule string defining when the workflow recurs.

            • endDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule ends.

            • startDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule begins.
        • stateNamestring

          The name of the starting workflow state.

          minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

    • eventsarray of objects

      CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

      minItems = 1

      Show events properties
      • namestring

        A unique name identifying this event definition within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The CloudEvents type attribute identifying the kind of event.

        Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

      • sourcestring

        The CloudEvents source attribute identifying the origin of the event.

        Can be one of: "system-events.task""dataset.updated"

      • dataOnlyboolean

        When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

        default = true

      • correlationarray of objects

        Correlation definitions used to match incoming CloudEvents to this workflow instance.

        minItems = 1

        Show correlation properties
        • contextAttributeNamestring
          Required

          The name of the CloudEvent extension context attribute to match on.

          Can be one of: "id""status""appId""spaceId""datasetId"

        • contextAttributeValuestring

          The expected value of the CloudEvent extension context attribute.

          minLength = 1

    • statesarray of objects

      The list of state definitions that compose the workflow.

      minItems = 1

      Show states properties
      • endboolean

        Marks this state as a terminal state in the workflow.

        default = true

      • namestring

        The name of this state, unique within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The state type. Must be EVENT for event-driven states.

        Can be one of: "EVENT"

      • onEventsarray of objects

        The events to consume and the optional actions to perform when they are received.

        Show onEvents properties
        • actionsarray of objects

          Actions to perform when the matched events are consumed.

          Show actions properties
          • namestring

            A unique name for this action within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • retryRefstring

            A reference to a defined workflow retry policy. If absent, the default retry policy applies.

          • conditionstring

            An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

            minLength = 1

          • functionRefobject

            A reference to a function to invoke, either as a name string or a structured object.

            One of:
            • string

              The name of the referenced function.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • object

              A structured function reference with arguments and invocation options.

              Show properties
              • invokestring

                Specifies whether the function is invoked synchronously or asynchronously.

                Can be one of: "SYNC""ASYNC"

                default = "SYNC"

              • refNamestring
                Required

                The name of the function to invoke.

                Can be one of: "app.reload"

              • argumentsobject

                Arguments to pass to the function.

                additionalProperties = true

              • selectionSetstring

                A GraphQL selection set string. Only applicable when the function type is graphql.
          • retryableErrorsarray of strings

            Workflow error references for which this action must be retried. Used only when autoRetries is false.

            minItems = 1

          • nonRetryableErrorsarray of strings

            Workflow error references for which this action must not be retried. Used only when autoRetries is true.

            minItems = 1

        • eventRefsarray of strings
          Required

          References to one or more unique event names defined in the workflow events list.

          minItems = 1, maxItems = 100, uniqueItems = true

        • actionModestring

          Specifies whether actions are performed sequentially or in parallel.

          Can be one of: "SEQUENTIAL""PARALLEL"

          default = "SEQUENTIAL"

      • timeoutsobject

        State-specific timeout durations.

        Show timeouts properties
        • eventTimeoutstring

          The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • stateExecTimeoutstring

          The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • actionExecTimeoutstring

          The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

      • exclusiveboolean

        When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

        default = true

      • compensatedBystring

        The unique name of a workflow state responsible for compensating this state if it fails.

        minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

    • enabledboolean

      Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

      default = false

    • versionstring

      The semantic version of the workflow definition.

      pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

    • metadataobject
      Show metadata properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdAtstring

        The UTC timestamp when the task was created.

        format = "date-time"

      • createdBystring

        The user ID of the user who created the task.

      • deletedAtstring

        The UTC timestamp when the task was deleted.

        format = "date-time"

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • endedAtstring

            The UTC timestamp when the task run ended.

            format = "date-time"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • startedAtstring

            The UTC timestamp when the task run started.

            format = "date-time"

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • keepActiveboolean

      When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

      default = false

    • resourceIdstring

      The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

    • annotationsarray of strings

      A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

      minItems = 1

    • descriptionstring

      A human-readable description of the workflow's purpose.

      maxLength = 1024

    • specVersionstring
      Required

      The Serverless Workflow specification version used by this task.

      minLength = 1

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
POST /api/scheduling/tasks 
// qlik-api has not implemented support for `POST /api/scheduling/tasks` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
      name: 'TaskExample',
      events: [
        {
          name: 'event1',
          type: 'com.qlik/active-analytics-orch',
          source: 'dataset.updated',
          correlation: [
            {
              contextAttributeName: 'appId',
              contextAttributeValue:
                'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
            },
          ],
        },
      ],
      states: [
        {
          end: true,
          name: 'Reload',
          type: 'event',
          onEvents: [
            {
              actions: [
                {
                  name: 'app.reload',
                  functionRef: {
                    refName: 'app.reload',
                    arguments: {
                      appId:
                        'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
                      partial: false,
                    },
                  },
                },
              ],
              eventRefs: ['app1-dataset-updated'],
            },
          ],
          exclusive: false,
        },
      ],
      enabled: true,
      version: '1.0.0',
      metadata: {
        usage: 'ANALYTICS',
        ownerId: 0,
        spaceId: '',
        trigger: {
          id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
          type: 4,
        },
        tenantId:
          'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        createdAt: '2025-08-31T23:22:27.929Z',
        createdBy: 0,
        updatedAt: '2025-08-31T23:27:51.207Z',
        orchestration: {
          id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
          type: 3,
          attrs: {
            last_run_status: 'SUCCEEDED',
            last_run_endedAt:
              '2025-08-31T23:28:06Z',
            last_run_startedAt:
              '2025-08-31T23:28:04Z',
            last_run_worker_type: 'reloads',
          },
        },
      },
      keepActive: false,
      resourceId:
        'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
      description:
        'this is an example of task response',
      specVersion: '1.16.0',
    }),
  },
)
qlik scheduling task create \
  --events-correlation-contextAttributeName '' \
  --metadata-orchestration-id 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
  --metadata-orchestration-lastRun-id '' \
  --metadata-orchestration-lastRun-status '' \
  --metadata-orchestration-lastRun-triggeredBy '' \
  --metadata-orchestration-lastRun-workerId '' \
  --metadata-orchestration-lastRun-workerType '' \
  --metadata-orchestration-type 3 \
  --metadata-trigger-id 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
  --metadata-trigger-type 4 \
  --name 'TaskExample' \
  --specVersion '1.16.0' \
  --start-schedule  \
  --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/scheduling/tasks" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name":"TaskExample","events":[{"name":"event1","type":"com.qlik/active-analytics-orch","source":"dataset.updated","correlation":[{"contextAttributeName":"appId","contextAttributeValue":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}]}],"states":[{"end":true,"name":"Reload","type":"event","onEvents":[{"actions":[{"name":"app.reload","functionRef":{"refName":"app.reload","arguments":{"appId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","partial":false}}}],"eventRefs":["app1-dataset-updated"]}],"exclusive":false}],"enabled":true,"version":"1.0.0","metadata":{"usage":"ANALYTICS","ownerId":0,"spaceId":"","trigger":{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":4},"tenantId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","createdAt":"2025-08-31T23:22:27.929Z","createdBy":0,"updatedAt":"2025-08-31T23:27:51.207Z","orchestration":{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":3,"attrs":{"last_run_status":"SUCCEEDED","last_run_endedAt":"2025-08-31T23:28:06Z","last_run_startedAt":"2025-08-31T23:28:04Z","last_run_worker_type":"reloads"}}},"keepActive":false,"resourceId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","description":"this is an example of task response","specVersion":"1.16.0"}'

Example Response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "TaskExample",
  "events": [
    {
      "name": "event1",
      "type": "com.qlik/active-analytics-orch",
      "source": "dataset.updated",
      "correlation": [
        {
          "contextAttributeName": "appId",
          "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "Reload",
      "type": "event",
      "onEvents": [
        {
          "actions": [
            {
              "name": "app.reload",
              "functionRef": {
                "refName": "app.reload",
                "arguments": {
                  "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                  "partial": false
                }
              }
            }
          ],
          "eventRefs": [
            "app1-dataset-updated"
          ]
        }
      ],
      "exclusive": false
    }
  ],
  "enabled": true,
  "version": "1.0.0",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": 0,
    "spaceId": "",
    "trigger": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 4
    },
    "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "createdAt": "2025-08-31T23:22:27.929Z",
    "createdBy": 0,
    "updatedAt": "2025-08-31T23:27:51.207Z",
    "orchestration": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 3,
      "attrs": {
        "last_run_status": "SUCCEEDED",
        "last_run_endedAt": "2025-08-31T23:28:06Z",
        "last_run_startedAt": "2025-08-31T23:28:04Z",
        "last_run_worker_type": "reloads"
      }
    }
  },
  "keepActive": false,
  "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "description": "this is an example of task response",
  "specVersion": "1.16.0"
}

Get a task

Retrieves the full definition and metadata for a specific task, including its trigger configuration, state definitions, owner, and last run status. Use this operation to inspect a task before updating or starting it.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Path Parameters

  • idstring
    Required

    The unique identifier of the task to retrieve.

Responses

200

Task details retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      The unique identifier assigned to the task by the service.

    • keystring

      An optional expression used to generate a domain-specific workflow instance identifier.

    • namestring
      RequiredFilterable

      The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

      minLength = 1, maxLength = 100

    • startobject

      The start definition for a workflow, including optional schedule configuration.

      One of:
      • object

        A scheduled workflow start definition.

        Show properties
        • schedulestring|object
          Required
          One of:
          • string

            A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

            minLength = 1

          • object

            A structured schedule definition with optional recurrence, date range, and timezone.

            Show properties
            • cronstring|object
              One of:
              • string

                A cron expression defining when workflow instances should be created automatically.

                minLength = 1

              • object
                Show properties
                • expressionstring
                  Required

                  A cron expression describing when the workflow instance should be created.

                  minLength = 1

                • validUntilstring

                  The date and time (ISO 8601 format) after which this cron expression is no longer active.
            • intervalstring

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

              minLength = 1

            • timezonestring

              The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

              default = "UTC"

            • recurrencestring

              An RRULE recurrence rule string defining when the workflow recurs.

            • endDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule ends.

            • startDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule begins.
        • stateNamestring

          The name of the starting workflow state.

          minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

    • eventsarray of objects

      CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

      minItems = 1

      Show events properties
      • namestring

        A unique name identifying this event definition within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The CloudEvents type attribute identifying the kind of event.

        Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

      • sourcestring

        The CloudEvents source attribute identifying the origin of the event.

        Can be one of: "system-events.task""dataset.updated"

      • dataOnlyboolean

        When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

        default = true

      • correlationarray of objects

        Correlation definitions used to match incoming CloudEvents to this workflow instance.

        minItems = 1

        Show correlation properties
        • contextAttributeNamestring
          Required

          The name of the CloudEvent extension context attribute to match on.

          Can be one of: "id""status""appId""spaceId""datasetId"

        • contextAttributeValuestring

          The expected value of the CloudEvent extension context attribute.

          minLength = 1

    • statesarray of objects

      The list of state definitions that compose the workflow.

      minItems = 1

      Show states properties
      • endboolean

        Marks this state as a terminal state in the workflow.

        default = true

      • namestring

        The name of this state, unique within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The state type. Must be EVENT for event-driven states.

        Can be one of: "EVENT"

      • onEventsarray of objects

        The events to consume and the optional actions to perform when they are received.

        Show onEvents properties
        • actionsarray of objects

          Actions to perform when the matched events are consumed.

          Show actions properties
          • namestring

            A unique name for this action within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • retryRefstring

            A reference to a defined workflow retry policy. If absent, the default retry policy applies.

          • conditionstring

            An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

            minLength = 1

          • functionRefobject

            A reference to a function to invoke, either as a name string or a structured object.

            One of:
            • string

              The name of the referenced function.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • object

              A structured function reference with arguments and invocation options.

              Show properties
              • invokestring

                Specifies whether the function is invoked synchronously or asynchronously.

                Can be one of: "SYNC""ASYNC"

                default = "SYNC"

              • refNamestring
                Required

                The name of the function to invoke.

                Can be one of: "app.reload"

              • argumentsobject

                Arguments to pass to the function.

                additionalProperties = true

              • selectionSetstring

                A GraphQL selection set string. Only applicable when the function type is graphql.
          • retryableErrorsarray of strings

            Workflow error references for which this action must be retried. Used only when autoRetries is false.

            minItems = 1

          • nonRetryableErrorsarray of strings

            Workflow error references for which this action must not be retried. Used only when autoRetries is true.

            minItems = 1

        • eventRefsarray of strings
          Required

          References to one or more unique event names defined in the workflow events list.

          minItems = 1, maxItems = 100, uniqueItems = true

        • actionModestring

          Specifies whether actions are performed sequentially or in parallel.

          Can be one of: "SEQUENTIAL""PARALLEL"

          default = "SEQUENTIAL"

      • timeoutsobject

        State-specific timeout durations.

        Show timeouts properties
        • eventTimeoutstring

          The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • stateExecTimeoutstring

          The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • actionExecTimeoutstring

          The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

      • exclusiveboolean

        When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

        default = true

      • compensatedBystring

        The unique name of a workflow state responsible for compensating this state if it fails.

        minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

    • enabledboolean

      Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

      default = false

    • versionstring

      The semantic version of the workflow definition.

      pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

    • metadataobject
      Show metadata properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdAtstring

        The UTC timestamp when the task was created.

        format = "date-time"

      • createdBystring

        The user ID of the user who created the task.

      • deletedAtstring

        The UTC timestamp when the task was deleted.

        format = "date-time"

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • endedAtstring

            The UTC timestamp when the task run ended.

            format = "date-time"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • startedAtstring

            The UTC timestamp when the task run started.

            format = "date-time"

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • keepActiveboolean

      When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

      default = false

    • resourceIdstring

      The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

    • annotationsarray of strings

      A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

      minItems = 1

    • descriptionstring

      A human-readable description of the workflow's purpose.

      maxLength = 1024

    • specVersionstring
      Required

      The Serverless Workflow specification version used by this task.

      minLength = 1

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id} 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "TaskExample",
  "events": [
    {
      "name": "event1",
      "type": "com.qlik/active-analytics-orch",
      "source": "dataset.updated",
      "correlation": [
        {
          "contextAttributeName": "appId",
          "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "Reload",
      "type": "event",
      "onEvents": [
        {
          "actions": [
            {
              "name": "app.reload",
              "functionRef": {
                "refName": "app.reload",
                "arguments": {
                  "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                  "partial": false
                }
              }
            }
          ],
          "eventRefs": [
            "app1-dataset-updated"
          ]
        }
      ],
      "exclusive": false
    }
  ],
  "enabled": true,
  "version": "1.0.0",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": 0,
    "spaceId": "",
    "trigger": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 4
    },
    "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "createdAt": "2025-08-31T23:22:27.929Z",
    "createdBy": 0,
    "updatedAt": "2025-08-31T23:27:51.207Z",
    "orchestration": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 3,
      "attrs": {
        "last_run_status": "SUCCEEDED",
        "last_run_endedAt": "2025-08-31T23:28:06Z",
        "last_run_startedAt": "2025-08-31T23:28:04Z",
        "last_run_worker_type": "reloads"
      }
    }
  },
  "keepActive": false,
  "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "description": "this is an example of task response",
  "specVersion": "1.16.0"
}

Patch a task

Partially updates a specific task using a JSON Patch document (RFC 6902). Only the fields included in the patch operations are modified. All other fields remain unchanged. If the task is owned by another user, ownership is transferred to the requesting user.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • idstring
    Required

    The unique identifier of the task to update.

Request Body

Required
  • application/jsonarray of objects

    A JSON Patch document as defined by RFC 6902.

    Show application/json properties
    • opstring
      Required

      The patch operation to perform.

      Can be one of: "add""remove""replace""move""copy"

    • pathstring
      Required

      A JSON Pointer (RFC 6901) identifying the field to patch.

    • valuestring|number|integer|boolean|array|object

      The value to use in a JSON Patch operation.

      One of:
      • string
      • number
      • integer
      • boolean
      • array of undefineds
      • object

Responses

200

Task updated successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      The unique identifier assigned to the task by the service.

    • keystring

      An optional expression used to generate a domain-specific workflow instance identifier.

    • namestring
      RequiredFilterable

      The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

      minLength = 1, maxLength = 100

    • startobject

      The start definition for a workflow, including optional schedule configuration.

      One of:
      • object

        A scheduled workflow start definition.

        Show properties
        • schedulestring|object
          Required
          One of:
          • string

            A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

            minLength = 1

          • object

            A structured schedule definition with optional recurrence, date range, and timezone.

            Show properties
            • cronstring|object
              One of:
              • string

                A cron expression defining when workflow instances should be created automatically.

                minLength = 1

              • object
                Show properties
                • expressionstring
                  Required

                  A cron expression describing when the workflow instance should be created.

                  minLength = 1

                • validUntilstring

                  The date and time (ISO 8601 format) after which this cron expression is no longer active.
            • intervalstring

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

              minLength = 1

            • timezonestring

              The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

              default = "UTC"

            • recurrencestring

              An RRULE recurrence rule string defining when the workflow recurs.

            • endDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule ends.

            • startDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule begins.
        • stateNamestring

          The name of the starting workflow state.

          minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

    • eventsarray of objects

      CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

      minItems = 1

      Show events properties
      • namestring

        A unique name identifying this event definition within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The CloudEvents type attribute identifying the kind of event.

        Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

      • sourcestring

        The CloudEvents source attribute identifying the origin of the event.

        Can be one of: "system-events.task""dataset.updated"

      • dataOnlyboolean

        When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

        default = true

      • correlationarray of objects

        Correlation definitions used to match incoming CloudEvents to this workflow instance.

        minItems = 1

        Show correlation properties
        • contextAttributeNamestring
          Required

          The name of the CloudEvent extension context attribute to match on.

          Can be one of: "id""status""appId""spaceId""datasetId"

        • contextAttributeValuestring

          The expected value of the CloudEvent extension context attribute.

          minLength = 1

    • statesarray of objects

      The list of state definitions that compose the workflow.

      minItems = 1

      Show states properties
      • endboolean

        Marks this state as a terminal state in the workflow.

        default = true

      • namestring

        The name of this state, unique within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The state type. Must be EVENT for event-driven states.

        Can be one of: "EVENT"

      • onEventsarray of objects

        The events to consume and the optional actions to perform when they are received.

        Show onEvents properties
        • actionsarray of objects

          Actions to perform when the matched events are consumed.

          Show actions properties
          • namestring

            A unique name for this action within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • retryRefstring

            A reference to a defined workflow retry policy. If absent, the default retry policy applies.

          • conditionstring

            An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

            minLength = 1

          • functionRefobject

            A reference to a function to invoke, either as a name string or a structured object.

            One of:
            • string

              The name of the referenced function.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • object

              A structured function reference with arguments and invocation options.

              Show properties
              • invokestring

                Specifies whether the function is invoked synchronously or asynchronously.

                Can be one of: "SYNC""ASYNC"

                default = "SYNC"

              • refNamestring
                Required

                The name of the function to invoke.

                Can be one of: "app.reload"

              • argumentsobject

                Arguments to pass to the function.

                additionalProperties = true

              • selectionSetstring

                A GraphQL selection set string. Only applicable when the function type is graphql.
          • retryableErrorsarray of strings

            Workflow error references for which this action must be retried. Used only when autoRetries is false.

            minItems = 1

          • nonRetryableErrorsarray of strings

            Workflow error references for which this action must not be retried. Used only when autoRetries is true.

            minItems = 1

        • eventRefsarray of strings
          Required

          References to one or more unique event names defined in the workflow events list.

          minItems = 1, maxItems = 100, uniqueItems = true

        • actionModestring

          Specifies whether actions are performed sequentially or in parallel.

          Can be one of: "SEQUENTIAL""PARALLEL"

          default = "SEQUENTIAL"

      • timeoutsobject

        State-specific timeout durations.

        Show timeouts properties
        • eventTimeoutstring

          The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • stateExecTimeoutstring

          The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • actionExecTimeoutstring

          The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

      • exclusiveboolean

        When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

        default = true

      • compensatedBystring

        The unique name of a workflow state responsible for compensating this state if it fails.

        minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

    • enabledboolean

      Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

      default = false

    • versionstring

      The semantic version of the workflow definition.

      pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

    • metadataobject
      Show metadata properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdAtstring

        The UTC timestamp when the task was created.

        format = "date-time"

      • createdBystring

        The user ID of the user who created the task.

      • deletedAtstring

        The UTC timestamp when the task was deleted.

        format = "date-time"

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • endedAtstring

            The UTC timestamp when the task run ended.

            format = "date-time"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • startedAtstring

            The UTC timestamp when the task run started.

            format = "date-time"

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • keepActiveboolean

      When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

      default = false

    • resourceIdstring

      The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

    • annotationsarray of strings

      A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

      minItems = 1

    • descriptionstring

      A human-readable description of the workflow's purpose.

      maxLength = 1024

    • specVersionstring
      Required

      The Serverless Workflow specification version used by this task.

      minLength = 1

204

Task updated with no content to return.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
PATCH /api/scheduling/tasks/{id} 
// qlik-api has not implemented support for `PATCH /api/scheduling/tasks/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}',
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify([
      {
        op: 'add',
        path: 'string',
        value: 'string',
      },
    ]),
  },
)
qlik scheduling task patch 'string' \
  --op 'add' \
  --path 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","path":"string","value":"string"}]'

Example Response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "TaskExample",
  "events": [
    {
      "name": "event1",
      "type": "com.qlik/active-analytics-orch",
      "source": "dataset.updated",
      "correlation": [
        {
          "contextAttributeName": "appId",
          "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "Reload",
      "type": "event",
      "onEvents": [
        {
          "actions": [
            {
              "name": "app.reload",
              "functionRef": {
                "refName": "app.reload",
                "arguments": {
                  "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                  "partial": false
                }
              }
            }
          ],
          "eventRefs": [
            "app1-dataset-updated"
          ]
        }
      ],
      "exclusive": false
    }
  ],
  "enabled": true,
  "version": "1.0.0",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": 0,
    "spaceId": "",
    "trigger": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 4
    },
    "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "createdAt": "2025-08-31T23:22:27.929Z",
    "createdBy": 0,
    "updatedAt": "2025-08-31T23:27:51.207Z",
    "orchestration": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 3,
      "attrs": {
        "last_run_status": "SUCCEEDED",
        "last_run_endedAt": "2025-08-31T23:28:06Z",
        "last_run_startedAt": "2025-08-31T23:28:04Z",
        "last_run_worker_type": "reloads"
      }
    }
  },
  "keepActive": false,
  "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "description": "this is an example of task response",
  "specVersion": "1.16.0"
}

Replace a task

Replaces the full definition of a specific task with the supplied payload. All fields not included in the request body are reset to their defaults. If the task is owned by another user, ownership is transferred to the requesting user. Use PATCH instead to apply a partial update.

Facts

Rate limit Tier 2 (100 requests per minute)
Replaces

Path Parameters

  • idstring
    Required

    The unique identifier of the task to replace.

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • keystring

      An optional expression used to generate a domain-specific workflow instance identifier.

    • namestring
      RequiredFilterable

      The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

      minLength = 1, maxLength = 100

    • startobject

      The start definition for a workflow, including optional schedule configuration.

      One of:
      • object

        A scheduled workflow start definition.

        Show properties
        • schedulestring|object
          Required
          One of:
          • string

            A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

            minLength = 1

          • object

            A structured schedule definition with optional recurrence, date range, and timezone.

            Show properties
            • cronstring|object
              One of:
              • string

                A cron expression defining when workflow instances should be created automatically.

                minLength = 1

              • object
                Show properties
                • expressionstring
                  Required

                  A cron expression describing when the workflow instance should be created.

                  minLength = 1

                • validUntilstring

                  The date and time (ISO 8601 format) after which this cron expression is no longer active.
            • intervalstring

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

              minLength = 1

            • timezonestring

              The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

              default = "UTC"

            • recurrencestring

              An RRULE recurrence rule string defining when the workflow recurs.

            • endDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule ends.

            • startDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule begins.
        • stateNamestring

          The name of the starting workflow state.

          minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

    • eventsarray of objects

      CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

      minItems = 1

      Show events properties
      • namestring

        A unique name identifying this event definition within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The CloudEvents type attribute identifying the kind of event.

        Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

      • sourcestring

        The CloudEvents source attribute identifying the origin of the event.

        Can be one of: "system-events.task""dataset.updated"

      • dataOnlyboolean

        When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

        default = true

      • correlationarray of objects

        Correlation definitions used to match incoming CloudEvents to this workflow instance.

        minItems = 1

        Show correlation properties
        • contextAttributeNamestring
          Required

          The name of the CloudEvent extension context attribute to match on.

          Can be one of: "id""status""appId""spaceId""datasetId"

        • contextAttributeValuestring

          The expected value of the CloudEvent extension context attribute.

          minLength = 1

    • statesarray of objects

      The list of state definitions that compose the workflow.

      minItems = 1

      Show states properties
      • endboolean

        Marks this state as a terminal state in the workflow.

        default = true

      • namestring

        The name of this state, unique within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The state type. Must be EVENT for event-driven states.

        Can be one of: "EVENT"

      • onEventsarray of objects

        The events to consume and the optional actions to perform when they are received.

        Show onEvents properties
        • actionsarray of objects

          Actions to perform when the matched events are consumed.

          Show actions properties
          • namestring

            A unique name for this action within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • retryRefstring

            A reference to a defined workflow retry policy. If absent, the default retry policy applies.

          • conditionstring

            An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

            minLength = 1

          • functionRefobject

            A reference to a function to invoke, either as a name string or a structured object.

            One of:
            • string

              The name of the referenced function.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • object

              A structured function reference with arguments and invocation options.

              Show properties
              • invokestring

                Specifies whether the function is invoked synchronously or asynchronously.

                Can be one of: "SYNC""ASYNC"

                default = "SYNC"

              • refNamestring
                Required

                The name of the function to invoke.

                Can be one of: "app.reload"

              • argumentsobject

                Arguments to pass to the function.

                additionalProperties = true

              • selectionSetstring

                A GraphQL selection set string. Only applicable when the function type is graphql.
          • retryableErrorsarray of strings

            Workflow error references for which this action must be retried. Used only when autoRetries is false.

            minItems = 1

          • nonRetryableErrorsarray of strings

            Workflow error references for which this action must not be retried. Used only when autoRetries is true.

            minItems = 1

        • eventRefsarray of strings
          Required

          References to one or more unique event names defined in the workflow events list.

          minItems = 1, maxItems = 100, uniqueItems = true

        • actionModestring

          Specifies whether actions are performed sequentially or in parallel.

          Can be one of: "SEQUENTIAL""PARALLEL"

          default = "SEQUENTIAL"

      • timeoutsobject

        State-specific timeout durations.

        Show timeouts properties
        • eventTimeoutstring

          The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • stateExecTimeoutstring

          The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • actionExecTimeoutstring

          The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

      • exclusiveboolean

        When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

        default = true

      • compensatedBystring

        The unique name of a workflow state responsible for compensating this state if it fails.

        minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

    • enabledboolean

      Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

      default = false

    • versionstring

      The semantic version of the workflow definition.

      pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

    • metadataobject
      Show metadata properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdBystring

        The user ID of the user who created the task.

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • keepActiveboolean

      When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

      default = false

    • resourceIdstring

      The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

    • annotationsarray of strings

      A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

      minItems = 1

    • descriptionstring

      A human-readable description of the workflow's purpose.

      maxLength = 1024

    • specVersionstring
      Required

      The Serverless Workflow specification version used by this task.

      minLength = 1

Responses

200

Task replaced successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      The unique identifier assigned to the task by the service.

    • keystring

      An optional expression used to generate a domain-specific workflow instance identifier.

    • namestring
      RequiredFilterable

      The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

      minLength = 1, maxLength = 100

    • startobject

      The start definition for a workflow, including optional schedule configuration.

      One of:
      • object

        A scheduled workflow start definition.

        Show properties
        • schedulestring|object
          Required
          One of:
          • string

            A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

            minLength = 1

          • object

            A structured schedule definition with optional recurrence, date range, and timezone.

            Show properties
            • cronstring|object
              One of:
              • string

                A cron expression defining when workflow instances should be created automatically.

                minLength = 1

              • object
                Show properties
                • expressionstring
                  Required

                  A cron expression describing when the workflow instance should be created.

                  minLength = 1

                • validUntilstring

                  The date and time (ISO 8601 format) after which this cron expression is no longer active.
            • intervalstring

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

              minLength = 1

            • timezonestring

              The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

              default = "UTC"

            • recurrencestring

              An RRULE recurrence rule string defining when the workflow recurs.

            • endDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule ends.

            • startDateTimestring

              The date and time (ISO 8601 format) when the workflow schedule begins.
        • stateNamestring

          The name of the starting workflow state.

          minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

    • eventsarray of objects

      CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

      minItems = 1

      Show events properties
      • namestring

        A unique name identifying this event definition within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The CloudEvents type attribute identifying the kind of event.

        Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

      • sourcestring

        The CloudEvents source attribute identifying the origin of the event.

        Can be one of: "system-events.task""dataset.updated"

      • dataOnlyboolean

        When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

        default = true

      • correlationarray of objects

        Correlation definitions used to match incoming CloudEvents to this workflow instance.

        minItems = 1

        Show correlation properties
        • contextAttributeNamestring
          Required

          The name of the CloudEvent extension context attribute to match on.

          Can be one of: "id""status""appId""spaceId""datasetId"

        • contextAttributeValuestring

          The expected value of the CloudEvent extension context attribute.

          minLength = 1

    • statesarray of objects

      The list of state definitions that compose the workflow.

      minItems = 1

      Show states properties
      • endboolean

        Marks this state as a terminal state in the workflow.

        default = true

      • namestring

        The name of this state, unique within the workflow.

        minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • typestring

        The state type. Must be EVENT for event-driven states.

        Can be one of: "EVENT"

      • onEventsarray of objects

        The events to consume and the optional actions to perform when they are received.

        Show onEvents properties
        • actionsarray of objects

          Actions to perform when the matched events are consumed.

          Show actions properties
          • namestring

            A unique name for this action within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • retryRefstring

            A reference to a defined workflow retry policy. If absent, the default retry policy applies.

          • conditionstring

            An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

            minLength = 1

          • functionRefobject

            A reference to a function to invoke, either as a name string or a structured object.

            One of:
            • string

              The name of the referenced function.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • object

              A structured function reference with arguments and invocation options.

              Show properties
              • invokestring

                Specifies whether the function is invoked synchronously or asynchronously.

                Can be one of: "SYNC""ASYNC"

                default = "SYNC"

              • refNamestring
                Required

                The name of the function to invoke.

                Can be one of: "app.reload"

              • argumentsobject

                Arguments to pass to the function.

                additionalProperties = true

              • selectionSetstring

                A GraphQL selection set string. Only applicable when the function type is graphql.
          • retryableErrorsarray of strings

            Workflow error references for which this action must be retried. Used only when autoRetries is false.

            minItems = 1

          • nonRetryableErrorsarray of strings

            Workflow error references for which this action must not be retried. Used only when autoRetries is true.

            minItems = 1

        • eventRefsarray of strings
          Required

          References to one or more unique event names defined in the workflow events list.

          minItems = 1, maxItems = 100, uniqueItems = true

        • actionModestring

          Specifies whether actions are performed sequentially or in parallel.

          Can be one of: "SEQUENTIAL""PARALLEL"

          default = "SEQUENTIAL"

      • timeoutsobject

        State-specific timeout durations.

        Show timeouts properties
        • eventTimeoutstring

          The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • stateExecTimeoutstring

          The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

        • actionExecTimeoutstring

          The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

          minLength = 1

      • exclusiveboolean

        When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

        default = true

      • compensatedBystring

        The unique name of a workflow state responsible for compensating this state if it fails.

        minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

    • enabledboolean

      Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

      default = false

    • versionstring

      The semantic version of the workflow definition.

      pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

    • metadataobject
      Show metadata properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdAtstring

        The UTC timestamp when the task was created.

        format = "date-time"

      • createdBystring

        The user ID of the user who created the task.

      • deletedAtstring

        The UTC timestamp when the task was deleted.

        format = "date-time"

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • endedAtstring

            The UTC timestamp when the task run ended.

            format = "date-time"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • startedAtstring

            The UTC timestamp when the task run started.

            format = "date-time"

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • keepActiveboolean

      When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

      default = false

    • resourceIdstring

      The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

    • annotationsarray of strings

      A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

      minItems = 1

    • descriptionstring

      A human-readable description of the workflow's purpose.

      maxLength = 1024

    • specVersionstring
      Required

      The Serverless Workflow specification version used by this task.

      minLength = 1

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

409

The request conflicts with the current state of the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
PUT /api/scheduling/tasks/{id} 
// qlik-api has not implemented support for `PUT /api/scheduling/tasks/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
      name: 'TaskExample',
      events: [
        {
          name: 'event1',
          type: 'com.qlik/active-analytics-orch',
          source: 'dataset.updated',
          correlation: [
            {
              contextAttributeName: 'appId',
              contextAttributeValue:
                'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
            },
          ],
        },
      ],
      states: [
        {
          end: true,
          name: 'Reload',
          type: 'event',
          onEvents: [
            {
              actions: [
                {
                  name: 'app.reload',
                  functionRef: {
                    refName: 'app.reload',
                    arguments: {
                      appId:
                        'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
                      partial: false,
                    },
                  },
                },
              ],
              eventRefs: ['app1-dataset-updated'],
            },
          ],
          exclusive: false,
        },
      ],
      enabled: true,
      version: '1.0.0',
      metadata: {
        usage: 'ANALYTICS',
        ownerId: 0,
        spaceId: '',
        trigger: {
          id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
          type: 4,
        },
        tenantId:
          'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        createdAt: '2025-08-31T23:22:27.929Z',
        createdBy: 0,
        updatedAt: '2025-08-31T23:27:51.207Z',
        orchestration: {
          id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
          type: 3,
          attrs: {
            last_run_status: 'SUCCEEDED',
            last_run_endedAt:
              '2025-08-31T23:28:06Z',
            last_run_startedAt:
              '2025-08-31T23:28:04Z',
            last_run_worker_type: 'reloads',
          },
        },
      },
      keepActive: false,
      resourceId:
        'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
      description:
        'this is an example of task response',
      specVersion: '1.16.0',
    }),
  },
)
qlik scheduling task update 'string' \
  --events-correlation-contextAttributeName '' \
  --metadata-orchestration-id 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
  --metadata-orchestration-lastRun-id '' \
  --metadata-orchestration-lastRun-status '' \
  --metadata-orchestration-lastRun-triggeredBy '' \
  --metadata-orchestration-lastRun-workerId '' \
  --metadata-orchestration-lastRun-workerType '' \
  --metadata-orchestration-type 3 \
  --metadata-trigger-id 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
  --metadata-trigger-type 4 \
  --name 'TaskExample' \
  --specVersion '1.16.0' \
  --start-schedule  \
  --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/scheduling/tasks/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","name":"TaskExample","events":[{"name":"event1","type":"com.qlik/active-analytics-orch","source":"dataset.updated","correlation":[{"contextAttributeName":"appId","contextAttributeValue":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}]}],"states":[{"end":true,"name":"Reload","type":"event","onEvents":[{"actions":[{"name":"app.reload","functionRef":{"refName":"app.reload","arguments":{"appId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","partial":false}}}],"eventRefs":["app1-dataset-updated"]}],"exclusive":false}],"enabled":true,"version":"1.0.0","metadata":{"usage":"ANALYTICS","ownerId":0,"spaceId":"","trigger":{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":4},"tenantId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","createdAt":"2025-08-31T23:22:27.929Z","createdBy":0,"updatedAt":"2025-08-31T23:27:51.207Z","orchestration":{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":3,"attrs":{"last_run_status":"SUCCEEDED","last_run_endedAt":"2025-08-31T23:28:06Z","last_run_startedAt":"2025-08-31T23:28:04Z","last_run_worker_type":"reloads"}}},"keepActive":false,"resourceId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","description":"this is an example of task response","specVersion":"1.16.0"}'

Example Response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "TaskExample",
  "events": [
    {
      "name": "event1",
      "type": "com.qlik/active-analytics-orch",
      "source": "dataset.updated",
      "correlation": [
        {
          "contextAttributeName": "appId",
          "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ]
    }
  ],
  "states": [
    {
      "end": true,
      "name": "Reload",
      "type": "event",
      "onEvents": [
        {
          "actions": [
            {
              "name": "app.reload",
              "functionRef": {
                "refName": "app.reload",
                "arguments": {
                  "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                  "partial": false
                }
              }
            }
          ],
          "eventRefs": [
            "app1-dataset-updated"
          ]
        }
      ],
      "exclusive": false
    }
  ],
  "enabled": true,
  "version": "1.0.0",
  "metadata": {
    "usage": "ANALYTICS",
    "ownerId": 0,
    "spaceId": "",
    "trigger": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 4
    },
    "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "createdAt": "2025-08-31T23:22:27.929Z",
    "createdBy": 0,
    "updatedAt": "2025-08-31T23:27:51.207Z",
    "orchestration": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": 3,
      "attrs": {
        "last_run_status": "SUCCEEDED",
        "last_run_endedAt": "2025-08-31T23:28:06Z",
        "last_run_startedAt": "2025-08-31T23:28:04Z",
        "last_run_worker_type": "reloads"
      }
    }
  },
  "keepActive": false,
  "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "description": "this is an example of task response",
  "specVersion": "1.16.0"
}

Delete a task

Deletes a specific task and cancels any scheduled or pending runs associated with it. This action cannot be undone. Tenant admins can delete tasks owned by other users.

Facts

Rate limit Tier 2 (100 requests per minute)
Replaces

Path Parameters

  • idstring
    Required

    The unique identifier of the task to delete.

Responses

204

Task deleted successfully.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
DELETE /api/scheduling/tasks/{id} 
// qlik-api has not implemented support for `DELETE /api/scheduling/tasks/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}',
  {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task rm 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Start a task

Triggers an immediate run of the specified task outside its normal schedule. The optional source parameter identifies what initiated the run, which is recorded in the run history for auditing purposes.

Facts

Rate limit Tier 2 (100 requests per minute)
Replaces

Query Parameters

  • sourcestring

    The origin of the trigger. Defaults to manual. For event-triggered tasks, this can be the name of the triggering task.

    default = "manual"

Path Parameters

  • idstring
    Required

    The unique identifier of the task to start.

Responses

200

Task started successfully.

  • application/jsonobject
    Show application/json properties
    • messagestring

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
POST /api/scheduling/tasks/{id}/actions/start 
// qlik-api has not implemented support for `POST /api/scheduling/tasks/{id}/actions/start` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/actions/start',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task start 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/actions/start" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "message": "Task started successfully"
}

Get ancestor graph

Retrieves the ancestor subgraph for a specific task, with the requested task as the root vertex. Traverses parent relationships breadth-first up to the depth specified by level. Use this to understand all upstream dependencies of a task.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • levelinteger

    Maximum ancestor depth to traverse breadth-first.

    minimum = 1, maximum = 100

  • withTaskboolean

    When true, includes the full task document for each accessible vertex in the response.

    default = false

Path Parameters

  • idstring
    Required

    The unique identifier of the task.

Responses

200

Ancestor graph retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • edgesarray of objects
      Show edges properties
      • attrsobject

        additionalProperties = true

      • sourcestring
      • targetstring
    • taskIdstring
    • verticesarray of objects
      Show vertices properties
      • taskobject
        Show task properties
        • idstring

          The unique identifier assigned to the task by the service.

        • keystring

          An optional expression used to generate a domain-specific workflow instance identifier.

        • namestring
          RequiredFilterable

          The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

          minLength = 1, maxLength = 100

        • startobject

          The start definition for a workflow, including optional schedule configuration.

          One of:
          • object

            A scheduled workflow start definition.

            Show properties
            • schedulestring|object
              Required
              One of:
              • string

                A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

                minLength = 1

              • object

                A structured schedule definition with optional recurrence, date range, and timezone.

                Show properties
                • cronstring|object
                  One of:
                  • string

                    A cron expression defining when workflow instances should be created automatically.

                    minLength = 1

                  • object
                    Show properties
                    • expressionstring
                      Required

                      A cron expression describing when the workflow instance should be created.

                      minLength = 1

                    • validUntilstring

                      The date and time (ISO 8601 format) after which this cron expression is no longer active.
                • intervalstring

                  A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

                  minLength = 1

                • timezonestring

                  The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

                  default = "UTC"

                • recurrencestring

                  An RRULE recurrence rule string defining when the workflow recurs.

                • endDateTimestring

                  The date and time (ISO 8601 format) when the workflow schedule ends.

                • startDateTimestring

                  The date and time (ISO 8601 format) when the workflow schedule begins.
            • stateNamestring

              The name of the starting workflow state.

              minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

        • eventsarray of objects

          CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

          minItems = 1

          Show events properties
          • namestring

            A unique name identifying this event definition within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • typestring

            The CloudEvents type attribute identifying the kind of event.

            Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

          • sourcestring

            The CloudEvents source attribute identifying the origin of the event.

            Can be one of: "system-events.task""dataset.updated"

          • dataOnlyboolean

            When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

            default = true

          • correlationarray of objects

            Correlation definitions used to match incoming CloudEvents to this workflow instance.

            minItems = 1

            Show correlation properties
            • contextAttributeNamestring
              Required

              The name of the CloudEvent extension context attribute to match on.

              Can be one of: "id""status""appId""spaceId""datasetId"

            • contextAttributeValuestring

              The expected value of the CloudEvent extension context attribute.

              minLength = 1

        • statesarray of objects

          The list of state definitions that compose the workflow.

          minItems = 1

          Show states properties
          • endboolean

            Marks this state as a terminal state in the workflow.

            default = true

          • namestring

            The name of this state, unique within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • typestring

            The state type. Must be EVENT for event-driven states.

            Can be one of: "EVENT"

          • onEventsarray of objects

            The events to consume and the optional actions to perform when they are received.

            Show onEvents properties
            • actionsarray of objects

              Actions to perform when the matched events are consumed.

              Show actions properties
              • namestring

                A unique name for this action within the workflow.

                minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

              • retryRefstring

                A reference to a defined workflow retry policy. If absent, the default retry policy applies.

              • conditionstring

                An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

                minLength = 1

              • functionRefobject

                A reference to a function to invoke, either as a name string or a structured object.

                One of:
                • string

                  The name of the referenced function.

                  minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

                • object

                  A structured function reference with arguments and invocation options.

                  Show properties
                  • invokestring

                    Specifies whether the function is invoked synchronously or asynchronously.

                    Can be one of: "SYNC""ASYNC"

                    default = "SYNC"

                  • refNamestring
                    Required

                    The name of the function to invoke.

                    Can be one of: "app.reload"

                  • argumentsobject

                    Arguments to pass to the function.

                    additionalProperties = true

                  • selectionSetstring

                    A GraphQL selection set string. Only applicable when the function type is graphql.
              • retryableErrorsarray of strings

                Workflow error references for which this action must be retried. Used only when autoRetries is false.

                minItems = 1

              • nonRetryableErrorsarray of strings

                Workflow error references for which this action must not be retried. Used only when autoRetries is true.

                minItems = 1

            • eventRefsarray of strings
              Required

              References to one or more unique event names defined in the workflow events list.

              minItems = 1, maxItems = 100, uniqueItems = true

            • actionModestring

              Specifies whether actions are performed sequentially or in parallel.

              Can be one of: "SEQUENTIAL""PARALLEL"

              default = "SEQUENTIAL"

          • timeoutsobject

            State-specific timeout durations.

            Show timeouts properties
            • eventTimeoutstring

              The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

            • stateExecTimeoutstring

              The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

            • actionExecTimeoutstring

              The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

          • exclusiveboolean

            When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

            default = true

          • compensatedBystring

            The unique name of a workflow state responsible for compensating this state if it fails.

            minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • enabledboolean

          Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

          default = false

        • versionstring

          The semantic version of the workflow definition.

          pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

        • metadataobject
          Show metadata properties
          • usagestring

            The product domain in which the resource is used. Defaults to ANALYTICS when not present.

            Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

          • ownerIdstring

            The user ID of the task owner.

          • spaceIdstring

            The unique identifier of the space the task operates in.

          • triggerobject
            Show trigger properties
            • idstring
              Required

              The unique identifier of the trigger associated with this task.

            • typeinteger
              Required

              The type identifier of the trigger associated with this task.

              Can be one of: 01234

          • tenantIdstring

            The unique identifier of the tenant the task operates in.

          • topologyobject

            Indicates the task's position in a dependency graph.

            Show topology properties
            • isChildboolean

              When true, this task is triggered by one or more parent tasks.

            • isParentboolean

              When true, this task has one or more downstream dependent tasks.
          • createdAtstring

            The UTC timestamp when the task was created.

            format = "date-time"

          • createdBystring

            The user ID of the user who created the task.

          • deletedAtstring

            The UTC timestamp when the task was deleted.

            format = "date-time"

          • spaceTypestring

            The type of space the task operates in.

            Can be one of: "personal""shared""managed"

          • updatedAtstring

            The UTC timestamp when the task was last updated.

            format = "date-time"

          • disabledCodestring

            The reason the task is currently disabled.

            Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

          • migratedFromstring

            The unique identifier of the legacy reload task this task was migrated from, if applicable.

          • resourceNamestring

            The name of the resource on which the task was created.

          • resourceTypestring

            The type of resource on which the task was created.

          • orchestrationobject
            Show orchestration properties
            • idstring
              Required

              The unique identifier of the orchestration instance associated with this task in the scheduling service.

            • typeinteger
              Required

              The type identifier of the orchestration system handling this task.

              Can be one of: 0123

            • attrsobject

              Additional attributes of the orchestration instance associated with this task in the scheduling service.

              Show additional optional properties
              • stringstring
            • lastRunobject
              Show lastRun properties
              • idstring
                Required

                The unique identifier of the task run.

              • statusstring
                Required

                The current status of the task run.

                Can be one of: "RUNNING""SUCCEEDED""FAILED"

              • endedAtstring

                The UTC timestamp when the task run ended.

                format = "date-time"

              • workerIdstring
                Required

                The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

              • startedAtstring

                The UTC timestamp when the task run started.

                format = "date-time"

              • executedAsstring

                The user ID of the user on whose behalf the task was executed.

              • workerTypestring
                Required

                The type or name of the target system that executed the run.

              • triggeredBystring
                Required

                The identity or event that triggered the task run.
          • scriptOwnerIdstring

            The user ID of the owner whose script context is used when running the task.

          • resourceSubTypestring

            The subtype of resource on which the task was created.
        • keepActiveboolean

          When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

          default = false

        • resourceIdstring

          The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

        • annotationsarray of strings

          A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

          minItems = 1

        • descriptionstring

          A human-readable description of the workflow's purpose.

          maxLength = 1024

        • specVersionstring
          Required

          The Serverless Workflow specification version used by this task.

          minLength = 1

      • attrsobject

        additionalProperties = true

      • taskIdstring

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/graphs/ancestors 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/graphs/ancestors` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/graphs/ancestors',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task graph ancestor ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/graphs/ancestors" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "edges": [
    {
      "attrs": {
        "depth": 1
      },
      "source": "22222222-2222-2222-2222-222222222222",
      "target": "11111111-1111-1111-1111-111111111111"
    }
  ],
  "taskId": "11111111-1111-1111-1111-111111111111",
  "vertices": [
    {
      "attrs": {
        "depth": 0,
        "isChild": false,
        "isParent": true
      },
      "taskId": "11111111-1111-1111-1111-111111111111"
    },
    {
      "attrs": {
        "depth": 1,
        "isChild": true,
        "isParent": false
      },
      "taskId": "22222222-2222-2222-2222-222222222222"
    }
  ]
}

List child tasks

Retrieves a paginated list of tasks that are direct children of the specified task in the dependency graph. A child task is one that is triggered when the parent task completes successfully.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • filterstring

    Advanced filter expression using RFC 7644 SCIM syntax. Refer to RFC 7644 for syntax details. All comparisons are case-insensitive. Supported fields: name, enabled, resourceId, ownerId, spaceId, createdAt, updatedAt, updatedBy, lastStatus, lastTriggeredBy, lastStartedAt, lastEndedAt, lastExecutedAs, and triggerType.

  • limitinteger

    Maximum number of tasks to return per page.

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

  • pagestring

    Cursor token for fetching the next page of results.

  • sortstring

    Field and direction to sort results by. Prefix the field name with + for ascending or - for descending order. Defaults to -updatedAt.

    Can be one of: "+createdAt""-createdAt""+enabled""-enabled""+name""-name""+ownerId""-ownerId""+resourceId""-resourceId""+spaceId""-spaceId""+updatedAt""-updatedAt""+updatedBy""-updatedBy""+lastStatus""-lastStatus""+lastTriggeredBy""-lastTriggeredBy""+lastStartedAt""-lastStartedAt""+lastEndedAt""-lastEndedAt""+lastExecutedAs""-lastExecutedAs""+triggerType""-triggerType"

    default = "-updatedAt"

Path Parameters

  • idstring
    Required

    The unique identifier of the parent task.

Responses

200

Child tasks retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        The unique identifier assigned to the task by the service.

      • keystring

        An optional expression used to generate a domain-specific workflow instance identifier.

      • namestring
        RequiredFilterable

        The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

        minLength = 1, maxLength = 100

      • startobject

        The start definition for a workflow, including optional schedule configuration.

        One of:
        • object

          A scheduled workflow start definition.

          Show properties
          • schedulestring|object
            Required
            One of:
            • string

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

              minLength = 1

            • object

              A structured schedule definition with optional recurrence, date range, and timezone.

              Show properties
              • cronstring|object
                One of:
                • string

                  A cron expression defining when workflow instances should be created automatically.

                  minLength = 1

                • object
                  Show properties
                  • expressionstring
                    Required

                    A cron expression describing when the workflow instance should be created.

                    minLength = 1

                  • validUntilstring

                    The date and time (ISO 8601 format) after which this cron expression is no longer active.
              • intervalstring

                A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

                minLength = 1

              • timezonestring

                The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

                default = "UTC"

              • recurrencestring

                An RRULE recurrence rule string defining when the workflow recurs.

              • endDateTimestring

                The date and time (ISO 8601 format) when the workflow schedule ends.

              • startDateTimestring

                The date and time (ISO 8601 format) when the workflow schedule begins.
          • stateNamestring

            The name of the starting workflow state.

            minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

      • eventsarray of objects

        CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

        minItems = 1

        Show events properties
        • namestring

          A unique name identifying this event definition within the workflow.

          minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • typestring

          The CloudEvents type attribute identifying the kind of event.

          Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

        • sourcestring

          The CloudEvents source attribute identifying the origin of the event.

          Can be one of: "system-events.task""dataset.updated"

        • dataOnlyboolean

          When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

          default = true

        • correlationarray of objects

          Correlation definitions used to match incoming CloudEvents to this workflow instance.

          minItems = 1

          Show correlation properties
          • contextAttributeNamestring
            Required

            The name of the CloudEvent extension context attribute to match on.

            Can be one of: "id""status""appId""spaceId""datasetId"

          • contextAttributeValuestring

            The expected value of the CloudEvent extension context attribute.

            minLength = 1

      • statesarray of objects

        The list of state definitions that compose the workflow.

        minItems = 1

        Show states properties
        • endboolean

          Marks this state as a terminal state in the workflow.

          default = true

        • namestring

          The name of this state, unique within the workflow.

          minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • typestring

          The state type. Must be EVENT for event-driven states.

          Can be one of: "EVENT"

        • onEventsarray of objects

          The events to consume and the optional actions to perform when they are received.

          Show onEvents properties
          • actionsarray of objects

            Actions to perform when the matched events are consumed.

            Show actions properties
            • namestring

              A unique name for this action within the workflow.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • retryRefstring

              A reference to a defined workflow retry policy. If absent, the default retry policy applies.

            • conditionstring

              An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

              minLength = 1

            • functionRefobject

              A reference to a function to invoke, either as a name string or a structured object.

              One of:
              • string

                The name of the referenced function.

                minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

              • object

                A structured function reference with arguments and invocation options.

                Show properties
                • invokestring

                  Specifies whether the function is invoked synchronously or asynchronously.

                  Can be one of: "SYNC""ASYNC"

                  default = "SYNC"

                • refNamestring
                  Required

                  The name of the function to invoke.

                  Can be one of: "app.reload"

                • argumentsobject

                  Arguments to pass to the function.

                  additionalProperties = true

                • selectionSetstring

                  A GraphQL selection set string. Only applicable when the function type is graphql.
            • retryableErrorsarray of strings

              Workflow error references for which this action must be retried. Used only when autoRetries is false.

              minItems = 1

            • nonRetryableErrorsarray of strings

              Workflow error references for which this action must not be retried. Used only when autoRetries is true.

              minItems = 1

          • eventRefsarray of strings
            Required

            References to one or more unique event names defined in the workflow events list.

            minItems = 1, maxItems = 100, uniqueItems = true

          • actionModestring

            Specifies whether actions are performed sequentially or in parallel.

            Can be one of: "SEQUENTIAL""PARALLEL"

            default = "SEQUENTIAL"

        • timeoutsobject

          State-specific timeout durations.

          Show timeouts properties
          • eventTimeoutstring

            The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

          • stateExecTimeoutstring

            The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

          • actionExecTimeoutstring

            The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

        • exclusiveboolean

          When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

          default = true

        • compensatedBystring

          The unique name of a workflow state responsible for compensating this state if it fails.

          minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • enabledboolean

        Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

        default = false

      • versionstring

        The semantic version of the workflow definition.

        pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

      • metadataobject
        Show metadata properties
        • usagestring

          The product domain in which the resource is used. Defaults to ANALYTICS when not present.

          Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

        • ownerIdstring

          The user ID of the task owner.

        • spaceIdstring

          The unique identifier of the space the task operates in.

        • triggerobject
          Show trigger properties
          • idstring
            Required

            The unique identifier of the trigger associated with this task.

          • typeinteger
            Required

            The type identifier of the trigger associated with this task.

            Can be one of: 01234

        • tenantIdstring

          The unique identifier of the tenant the task operates in.

        • topologyobject

          Indicates the task's position in a dependency graph.

          Show topology properties
          • isChildboolean

            When true, this task is triggered by one or more parent tasks.

          • isParentboolean

            When true, this task has one or more downstream dependent tasks.
        • createdAtstring

          The UTC timestamp when the task was created.

          format = "date-time"

        • createdBystring

          The user ID of the user who created the task.

        • deletedAtstring

          The UTC timestamp when the task was deleted.

          format = "date-time"

        • spaceTypestring

          The type of space the task operates in.

          Can be one of: "personal""shared""managed"

        • updatedAtstring

          The UTC timestamp when the task was last updated.

          format = "date-time"

        • disabledCodestring

          The reason the task is currently disabled.

          Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

        • migratedFromstring

          The unique identifier of the legacy reload task this task was migrated from, if applicable.

        • resourceNamestring

          The name of the resource on which the task was created.

        • resourceTypestring

          The type of resource on which the task was created.

        • orchestrationobject
          Show orchestration properties
          • idstring
            Required

            The unique identifier of the orchestration instance associated with this task in the scheduling service.

          • typeinteger
            Required

            The type identifier of the orchestration system handling this task.

            Can be one of: 0123

          • attrsobject

            Additional attributes of the orchestration instance associated with this task in the scheduling service.

            Show additional optional properties
            • stringstring
          • lastRunobject
            Show lastRun properties
            • idstring
              Required

              The unique identifier of the task run.

            • statusstring
              Required

              The current status of the task run.

              Can be one of: "RUNNING""SUCCEEDED""FAILED"

            • endedAtstring

              The UTC timestamp when the task run ended.

              format = "date-time"

            • workerIdstring
              Required

              The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

            • startedAtstring

              The UTC timestamp when the task run started.

              format = "date-time"

            • executedAsstring

              The user ID of the user on whose behalf the task was executed.

            • workerTypestring
              Required

              The type or name of the target system that executed the run.

            • triggeredBystring
              Required

              The identity or event that triggered the task run.
        • scriptOwnerIdstring

          The user ID of the owner whose script context is used when running the task.

        • resourceSubTypestring

          The subtype of resource on which the task was created.
      • keepActiveboolean

        When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

        default = false

      • resourceIdstring

        The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

      • annotationsarray of strings

        A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

        minItems = 1

      • descriptionstring

        A human-readable description of the workflow's purpose.

        maxLength = 1024

      • specVersionstring
        Required

        The Serverless Workflow specification version used by this task.

        minLength = 1

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
          Required

          The URL of the linked resource.
      • prevobject
        Show prev properties
        • hrefstring
          Required

          The URL of the linked resource.
      • selfobject
        Show self properties
        • hrefstring
          Required

          The URL of the linked resource.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/graphs/children 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/graphs/children` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/graphs/children',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task graph children ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/graphs/children" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "TaskExample",
      "events": [
        {
          "name": "event1",
          "type": "com.qlik/active-analytics-orch",
          "source": "dataset.updated",
          "correlation": [
            {
              "contextAttributeName": "appId",
              "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            }
          ]
        }
      ],
      "states": [
        {
          "end": true,
          "name": "Reload",
          "type": "event",
          "onEvents": [
            {
              "actions": [
                {
                  "name": "app.reload",
                  "functionRef": {
                    "refName": "app.reload",
                    "arguments": {
                      "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                      "partial": false
                    }
                  }
                }
              ],
              "eventRefs": [
                "app1-dataset-updated"
              ]
            }
          ],
          "exclusive": false
        }
      ],
      "enabled": true,
      "version": "1.0.0",
      "metadata": {
        "usage": "ANALYTICS",
        "ownerId": 0,
        "spaceId": "",
        "trigger": {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "type": 4
        },
        "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "createdAt": "2025-08-31T23:22:27.929Z",
        "createdBy": 0,
        "updatedAt": "2025-08-31T23:27:51.207Z",
        "orchestration": {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "type": 3,
          "attrs": {
            "last_run_status": "SUCCEEDED",
            "last_run_endedAt": "2025-08-31T23:28:06Z",
            "last_run_startedAt": "2025-08-31T23:28:04Z",
            "last_run_worker_type": "reloads"
          }
        }
      },
      "keepActive": false,
      "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "description": "this is an example of task response",
      "specVersion": "1.16.0"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Get descendant graph

Retrieves the descendant subgraph for a specific task, with the requested task as the root vertex. Traverses child relationships breadth-first down to the depth specified by level. Use this to identify all downstream tasks that will be triggered when this task completes.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • levelinteger

    Maximum descendant depth to traverse breadth-first.

    minimum = 1, maximum = 100

  • withTaskboolean

    When true, includes the full task document for each accessible vertex in the response.

    default = false

Path Parameters

  • idstring
    Required

    The unique identifier of the task.

Responses

200

Descendant graph retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • edgesarray of objects
      Show edges properties
      • attrsobject

        additionalProperties = true

      • sourcestring
      • targetstring
    • taskIdstring
    • verticesarray of objects
      Show vertices properties
      • taskobject
        Show task properties
        • idstring

          The unique identifier assigned to the task by the service.

        • keystring

          An optional expression used to generate a domain-specific workflow instance identifier.

        • namestring
          RequiredFilterable

          The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

          minLength = 1, maxLength = 100

        • startobject

          The start definition for a workflow, including optional schedule configuration.

          One of:
          • object

            A scheduled workflow start definition.

            Show properties
            • schedulestring|object
              Required
              One of:
              • string

                A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

                minLength = 1

              • object

                A structured schedule definition with optional recurrence, date range, and timezone.

                Show properties
                • cronstring|object
                  One of:
                  • string

                    A cron expression defining when workflow instances should be created automatically.

                    minLength = 1

                  • object
                    Show properties
                    • expressionstring
                      Required

                      A cron expression describing when the workflow instance should be created.

                      minLength = 1

                    • validUntilstring

                      The date and time (ISO 8601 format) after which this cron expression is no longer active.
                • intervalstring

                  A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

                  minLength = 1

                • timezonestring

                  The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

                  default = "UTC"

                • recurrencestring

                  An RRULE recurrence rule string defining when the workflow recurs.

                • endDateTimestring

                  The date and time (ISO 8601 format) when the workflow schedule ends.

                • startDateTimestring

                  The date and time (ISO 8601 format) when the workflow schedule begins.
            • stateNamestring

              The name of the starting workflow state.

              minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

        • eventsarray of objects

          CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

          minItems = 1

          Show events properties
          • namestring

            A unique name identifying this event definition within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • typestring

            The CloudEvents type attribute identifying the kind of event.

            Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

          • sourcestring

            The CloudEvents source attribute identifying the origin of the event.

            Can be one of: "system-events.task""dataset.updated"

          • dataOnlyboolean

            When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

            default = true

          • correlationarray of objects

            Correlation definitions used to match incoming CloudEvents to this workflow instance.

            minItems = 1

            Show correlation properties
            • contextAttributeNamestring
              Required

              The name of the CloudEvent extension context attribute to match on.

              Can be one of: "id""status""appId""spaceId""datasetId"

            • contextAttributeValuestring

              The expected value of the CloudEvent extension context attribute.

              minLength = 1

        • statesarray of objects

          The list of state definitions that compose the workflow.

          minItems = 1

          Show states properties
          • endboolean

            Marks this state as a terminal state in the workflow.

            default = true

          • namestring

            The name of this state, unique within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • typestring

            The state type. Must be EVENT for event-driven states.

            Can be one of: "EVENT"

          • onEventsarray of objects

            The events to consume and the optional actions to perform when they are received.

            Show onEvents properties
            • actionsarray of objects

              Actions to perform when the matched events are consumed.

              Show actions properties
              • namestring

                A unique name for this action within the workflow.

                minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

              • retryRefstring

                A reference to a defined workflow retry policy. If absent, the default retry policy applies.

              • conditionstring

                An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

                minLength = 1

              • functionRefobject

                A reference to a function to invoke, either as a name string or a structured object.

                One of:
                • string

                  The name of the referenced function.

                  minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

                • object

                  A structured function reference with arguments and invocation options.

                  Show properties
                  • invokestring

                    Specifies whether the function is invoked synchronously or asynchronously.

                    Can be one of: "SYNC""ASYNC"

                    default = "SYNC"

                  • refNamestring
                    Required

                    The name of the function to invoke.

                    Can be one of: "app.reload"

                  • argumentsobject

                    Arguments to pass to the function.

                    additionalProperties = true

                  • selectionSetstring

                    A GraphQL selection set string. Only applicable when the function type is graphql.
              • retryableErrorsarray of strings

                Workflow error references for which this action must be retried. Used only when autoRetries is false.

                minItems = 1

              • nonRetryableErrorsarray of strings

                Workflow error references for which this action must not be retried. Used only when autoRetries is true.

                minItems = 1

            • eventRefsarray of strings
              Required

              References to one or more unique event names defined in the workflow events list.

              minItems = 1, maxItems = 100, uniqueItems = true

            • actionModestring

              Specifies whether actions are performed sequentially or in parallel.

              Can be one of: "SEQUENTIAL""PARALLEL"

              default = "SEQUENTIAL"

          • timeoutsobject

            State-specific timeout durations.

            Show timeouts properties
            • eventTimeoutstring

              The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

            • stateExecTimeoutstring

              The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

            • actionExecTimeoutstring

              The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

          • exclusiveboolean

            When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

            default = true

          • compensatedBystring

            The unique name of a workflow state responsible for compensating this state if it fails.

            minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • enabledboolean

          Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

          default = false

        • versionstring

          The semantic version of the workflow definition.

          pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

        • metadataobject
          Show metadata properties
          • usagestring

            The product domain in which the resource is used. Defaults to ANALYTICS when not present.

            Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

          • ownerIdstring

            The user ID of the task owner.

          • spaceIdstring

            The unique identifier of the space the task operates in.

          • triggerobject
            Show trigger properties
            • idstring
              Required

              The unique identifier of the trigger associated with this task.

            • typeinteger
              Required

              The type identifier of the trigger associated with this task.

              Can be one of: 01234

          • tenantIdstring

            The unique identifier of the tenant the task operates in.

          • topologyobject

            Indicates the task's position in a dependency graph.

            Show topology properties
            • isChildboolean

              When true, this task is triggered by one or more parent tasks.

            • isParentboolean

              When true, this task has one or more downstream dependent tasks.
          • createdAtstring

            The UTC timestamp when the task was created.

            format = "date-time"

          • createdBystring

            The user ID of the user who created the task.

          • deletedAtstring

            The UTC timestamp when the task was deleted.

            format = "date-time"

          • spaceTypestring

            The type of space the task operates in.

            Can be one of: "personal""shared""managed"

          • updatedAtstring

            The UTC timestamp when the task was last updated.

            format = "date-time"

          • disabledCodestring

            The reason the task is currently disabled.

            Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

          • migratedFromstring

            The unique identifier of the legacy reload task this task was migrated from, if applicable.

          • resourceNamestring

            The name of the resource on which the task was created.

          • resourceTypestring

            The type of resource on which the task was created.

          • orchestrationobject
            Show orchestration properties
            • idstring
              Required

              The unique identifier of the orchestration instance associated with this task in the scheduling service.

            • typeinteger
              Required

              The type identifier of the orchestration system handling this task.

              Can be one of: 0123

            • attrsobject

              Additional attributes of the orchestration instance associated with this task in the scheduling service.

              Show additional optional properties
              • stringstring
            • lastRunobject
              Show lastRun properties
              • idstring
                Required

                The unique identifier of the task run.

              • statusstring
                Required

                The current status of the task run.

                Can be one of: "RUNNING""SUCCEEDED""FAILED"

              • endedAtstring

                The UTC timestamp when the task run ended.

                format = "date-time"

              • workerIdstring
                Required

                The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

              • startedAtstring

                The UTC timestamp when the task run started.

                format = "date-time"

              • executedAsstring

                The user ID of the user on whose behalf the task was executed.

              • workerTypestring
                Required

                The type or name of the target system that executed the run.

              • triggeredBystring
                Required

                The identity or event that triggered the task run.
          • scriptOwnerIdstring

            The user ID of the owner whose script context is used when running the task.

          • resourceSubTypestring

            The subtype of resource on which the task was created.
        • keepActiveboolean

          When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

          default = false

        • resourceIdstring

          The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

        • annotationsarray of strings

          A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

          minItems = 1

        • descriptionstring

          A human-readable description of the workflow's purpose.

          maxLength = 1024

        • specVersionstring
          Required

          The Serverless Workflow specification version used by this task.

          minLength = 1

      • attrsobject

        additionalProperties = true

      • taskIdstring

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/graphs/descendants 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/graphs/descendants` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/graphs/descendants',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task graph descendant ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/graphs/descendants" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "edges": [
    {
      "attrs": {
        "depth": 1
      },
      "source": "22222222-2222-2222-2222-222222222222",
      "target": "11111111-1111-1111-1111-111111111111"
    }
  ],
  "taskId": "11111111-1111-1111-1111-111111111111",
  "vertices": [
    {
      "attrs": {
        "depth": 0,
        "isChild": false,
        "isParent": true
      },
      "taskId": "11111111-1111-1111-1111-111111111111"
    },
    {
      "attrs": {
        "depth": 1,
        "isChild": true,
        "isParent": false
      },
      "taskId": "22222222-2222-2222-2222-222222222222"
    }
  ]
}

List parent tasks

Retrieves a paginated list of tasks that are direct parents of the specified task in the dependency graph. A parent task is one whose completion triggers the current task.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • filterstring

    Advanced filter expression using RFC 7644 SCIM syntax. Refer to RFC 7644 for syntax details. All comparisons are case-insensitive. Supported fields: name, enabled, resourceId, ownerId, spaceId, createdAt, updatedAt, updatedBy, lastStatus, lastTriggeredBy, lastStartedAt, lastEndedAt, lastExecutedAs, and triggerType.

  • limitinteger

    Maximum number of tasks to return per page.

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

  • pagestring

    Cursor token for fetching the next page of results.

  • sortstring

    Field and direction to sort results by. Prefix the field name with + for ascending or - for descending order. Defaults to -updatedAt.

    Can be one of: "+createdAt""-createdAt""+enabled""-enabled""+name""-name""+ownerId""-ownerId""+resourceId""-resourceId""+spaceId""-spaceId""+updatedAt""-updatedAt""+updatedBy""-updatedBy""+lastStatus""-lastStatus""+lastTriggeredBy""-lastTriggeredBy""+lastStartedAt""-lastStartedAt""+lastEndedAt""-lastEndedAt""+lastExecutedAs""-lastExecutedAs""+triggerType""-triggerType"

    default = "-updatedAt"

Path Parameters

  • idstring
    Required

    The unique identifier of the child task.

Responses

200

Parent tasks retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        The unique identifier assigned to the task by the service.

      • keystring

        An optional expression used to generate a domain-specific workflow instance identifier.

      • namestring
        RequiredFilterable

        The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

        minLength = 1, maxLength = 100

      • startobject

        The start definition for a workflow, including optional schedule configuration.

        One of:
        • object

          A scheduled workflow start definition.

          Show properties
          • schedulestring|object
            Required
            One of:
            • string

              A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

              minLength = 1

            • object

              A structured schedule definition with optional recurrence, date range, and timezone.

              Show properties
              • cronstring|object
                One of:
                • string

                  A cron expression defining when workflow instances should be created automatically.

                  minLength = 1

                • object
                  Show properties
                  • expressionstring
                    Required

                    A cron expression describing when the workflow instance should be created.

                    minLength = 1

                  • validUntilstring

                    The date and time (ISO 8601 format) after which this cron expression is no longer active.
              • intervalstring

                A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

                minLength = 1

              • timezonestring

                The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

                default = "UTC"

              • recurrencestring

                An RRULE recurrence rule string defining when the workflow recurs.

              • endDateTimestring

                The date and time (ISO 8601 format) when the workflow schedule ends.

              • startDateTimestring

                The date and time (ISO 8601 format) when the workflow schedule begins.
          • stateNamestring

            The name of the starting workflow state.

            minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

      • eventsarray of objects

        CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

        minItems = 1

        Show events properties
        • namestring

          A unique name identifying this event definition within the workflow.

          minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • typestring

          The CloudEvents type attribute identifying the kind of event.

          Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

        • sourcestring

          The CloudEvents source attribute identifying the origin of the event.

          Can be one of: "system-events.task""dataset.updated"

        • dataOnlyboolean

          When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

          default = true

        • correlationarray of objects

          Correlation definitions used to match incoming CloudEvents to this workflow instance.

          minItems = 1

          Show correlation properties
          • contextAttributeNamestring
            Required

            The name of the CloudEvent extension context attribute to match on.

            Can be one of: "id""status""appId""spaceId""datasetId"

          • contextAttributeValuestring

            The expected value of the CloudEvent extension context attribute.

            minLength = 1

      • statesarray of objects

        The list of state definitions that compose the workflow.

        minItems = 1

        Show states properties
        • endboolean

          Marks this state as a terminal state in the workflow.

          default = true

        • namestring

          The name of this state, unique within the workflow.

          minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • typestring

          The state type. Must be EVENT for event-driven states.

          Can be one of: "EVENT"

        • onEventsarray of objects

          The events to consume and the optional actions to perform when they are received.

          Show onEvents properties
          • actionsarray of objects

            Actions to perform when the matched events are consumed.

            Show actions properties
            • namestring

              A unique name for this action within the workflow.

              minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

            • retryRefstring

              A reference to a defined workflow retry policy. If absent, the default retry policy applies.

            • conditionstring

              An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

              minLength = 1

            • functionRefobject

              A reference to a function to invoke, either as a name string or a structured object.

              One of:
              • string

                The name of the referenced function.

                minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

              • object

                A structured function reference with arguments and invocation options.

                Show properties
                • invokestring

                  Specifies whether the function is invoked synchronously or asynchronously.

                  Can be one of: "SYNC""ASYNC"

                  default = "SYNC"

                • refNamestring
                  Required

                  The name of the function to invoke.

                  Can be one of: "app.reload"

                • argumentsobject

                  Arguments to pass to the function.

                  additionalProperties = true

                • selectionSetstring

                  A GraphQL selection set string. Only applicable when the function type is graphql.
            • retryableErrorsarray of strings

              Workflow error references for which this action must be retried. Used only when autoRetries is false.

              minItems = 1

            • nonRetryableErrorsarray of strings

              Workflow error references for which this action must not be retried. Used only when autoRetries is true.

              minItems = 1

          • eventRefsarray of strings
            Required

            References to one or more unique event names defined in the workflow events list.

            minItems = 1, maxItems = 100, uniqueItems = true

          • actionModestring

            Specifies whether actions are performed sequentially or in parallel.

            Can be one of: "SEQUENTIAL""PARALLEL"

            default = "SEQUENTIAL"

        • timeoutsobject

          State-specific timeout durations.

          Show timeouts properties
          • eventTimeoutstring

            The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

          • stateExecTimeoutstring

            The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

          • actionExecTimeoutstring

            The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

            minLength = 1

        • exclusiveboolean

          When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

          default = true

        • compensatedBystring

          The unique name of a workflow state responsible for compensating this state if it fails.

          minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

      • enabledboolean

        Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

        default = false

      • versionstring

        The semantic version of the workflow definition.

        pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

      • metadataobject
        Show metadata properties
        • usagestring

          The product domain in which the resource is used. Defaults to ANALYTICS when not present.

          Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

        • ownerIdstring

          The user ID of the task owner.

        • spaceIdstring

          The unique identifier of the space the task operates in.

        • triggerobject
          Show trigger properties
          • idstring
            Required

            The unique identifier of the trigger associated with this task.

          • typeinteger
            Required

            The type identifier of the trigger associated with this task.

            Can be one of: 01234

        • tenantIdstring

          The unique identifier of the tenant the task operates in.

        • topologyobject

          Indicates the task's position in a dependency graph.

          Show topology properties
          • isChildboolean

            When true, this task is triggered by one or more parent tasks.

          • isParentboolean

            When true, this task has one or more downstream dependent tasks.
        • createdAtstring

          The UTC timestamp when the task was created.

          format = "date-time"

        • createdBystring

          The user ID of the user who created the task.

        • deletedAtstring

          The UTC timestamp when the task was deleted.

          format = "date-time"

        • spaceTypestring

          The type of space the task operates in.

          Can be one of: "personal""shared""managed"

        • updatedAtstring

          The UTC timestamp when the task was last updated.

          format = "date-time"

        • disabledCodestring

          The reason the task is currently disabled.

          Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

        • migratedFromstring

          The unique identifier of the legacy reload task this task was migrated from, if applicable.

        • resourceNamestring

          The name of the resource on which the task was created.

        • resourceTypestring

          The type of resource on which the task was created.

        • orchestrationobject
          Show orchestration properties
          • idstring
            Required

            The unique identifier of the orchestration instance associated with this task in the scheduling service.

          • typeinteger
            Required

            The type identifier of the orchestration system handling this task.

            Can be one of: 0123

          • attrsobject

            Additional attributes of the orchestration instance associated with this task in the scheduling service.

            Show additional optional properties
            • stringstring
          • lastRunobject
            Show lastRun properties
            • idstring
              Required

              The unique identifier of the task run.

            • statusstring
              Required

              The current status of the task run.

              Can be one of: "RUNNING""SUCCEEDED""FAILED"

            • endedAtstring

              The UTC timestamp when the task run ended.

              format = "date-time"

            • workerIdstring
              Required

              The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

            • startedAtstring

              The UTC timestamp when the task run started.

              format = "date-time"

            • executedAsstring

              The user ID of the user on whose behalf the task was executed.

            • workerTypestring
              Required

              The type or name of the target system that executed the run.

            • triggeredBystring
              Required

              The identity or event that triggered the task run.
        • scriptOwnerIdstring

          The user ID of the owner whose script context is used when running the task.

        • resourceSubTypestring

          The subtype of resource on which the task was created.
      • keepActiveboolean

        When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

        default = false

      • resourceIdstring

        The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

      • annotationsarray of strings

        A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

        minItems = 1

      • descriptionstring

        A human-readable description of the workflow's purpose.

        maxLength = 1024

      • specVersionstring
        Required

        The Serverless Workflow specification version used by this task.

        minLength = 1

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
          Required

          The URL of the linked resource.
      • prevobject
        Show prev properties
        • hrefstring
          Required

          The URL of the linked resource.
      • selfobject
        Show self properties
        • hrefstring
          Required

          The URL of the linked resource.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/graphs/parents 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/graphs/parents` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/graphs/parents',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task graph parent ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/graphs/parents" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "TaskExample",
      "events": [
        {
          "name": "event1",
          "type": "com.qlik/active-analytics-orch",
          "source": "dataset.updated",
          "correlation": [
            {
              "contextAttributeName": "appId",
              "contextAttributeValue": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            }
          ]
        }
      ],
      "states": [
        {
          "end": true,
          "name": "Reload",
          "type": "event",
          "onEvents": [
            {
              "actions": [
                {
                  "name": "app.reload",
                  "functionRef": {
                    "refName": "app.reload",
                    "arguments": {
                      "appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                      "partial": false
                    }
                  }
                }
              ],
              "eventRefs": [
                "app1-dataset-updated"
              ]
            }
          ],
          "exclusive": false
        }
      ],
      "enabled": true,
      "version": "1.0.0",
      "metadata": {
        "usage": "ANALYTICS",
        "ownerId": 0,
        "spaceId": "",
        "trigger": {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "type": 4
        },
        "tenantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "createdAt": "2025-08-31T23:22:27.929Z",
        "createdBy": 0,
        "updatedAt": "2025-08-31T23:27:51.207Z",
        "orchestration": {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "type": 3,
          "attrs": {
            "last_run_status": "SUCCEEDED",
            "last_run_endedAt": "2025-08-31T23:28:06Z",
            "last_run_startedAt": "2025-08-31T23:28:04Z",
            "last_run_worker_type": "reloads"
          }
        }
      },
      "keepActive": false,
      "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "description": "this is an example of task response",
      "specVersion": "1.16.0"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Get task subgraph

Retrieves the combined ancestor-and-descendant subgraph for a specific task, with the requested task as the root vertex. Traverses both parent and child relationships breadth-first up to the depth specified by level. Use this to see the full dependency context for a task in one request.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • levelinteger

    Maximum ancestor and descendant depth to traverse breadth-first.

    minimum = 1, maximum = 100

  • withTaskboolean

    When true, includes the full task document for each accessible vertex in the response.

    default = false

Path Parameters

  • idstring
    Required

    The unique identifier of the task.

Responses

200

Task subgraph retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • edgesarray of objects
      Show edges properties
      • attrsobject

        additionalProperties = true

      • sourcestring
      • targetstring
    • taskIdstring
    • verticesarray of objects
      Show vertices properties
      • taskobject
        Show task properties
        • idstring

          The unique identifier assigned to the task by the service.

        • keystring

          An optional expression used to generate a domain-specific workflow instance identifier.

        • namestring
          RequiredFilterable

          The name that identifies the workflow definition. Combined with version, the name forms a unique identifier for the task.

          minLength = 1, maxLength = 100

        • startobject

          The start definition for a workflow, including optional schedule configuration.

          One of:
          • object

            A scheduled workflow start definition.

            Show properties
            • schedulestring|object
              Required
              One of:
              • string

                A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created. UTC timezone is assumed.

                minLength = 1

              • object

                A structured schedule definition with optional recurrence, date range, and timezone.

                Show properties
                • cronstring|object
                  One of:
                  • string

                    A cron expression defining when workflow instances should be created automatically.

                    minLength = 1

                  • object
                    Show properties
                    • expressionstring
                      Required

                      A cron expression describing when the workflow instance should be created.

                      minLength = 1

                    • validUntilstring

                      The date and time (ISO 8601 format) after which this cron expression is no longer active.
                • intervalstring

                  A repeating time interval in ISO 8601 format that defines when workflow instances are automatically created.

                  minLength = 1

                • timezonestring

                  The timezone name used to evaluate the interval and cron expression. Defaults to UTC.

                  default = "UTC"

                • recurrencestring

                  An RRULE recurrence rule string defining when the workflow recurs.

                • endDateTimestring

                  The date and time (ISO 8601 format) when the workflow schedule ends.

                • startDateTimestring

                  The date and time (ISO 8601 format) when the workflow schedule begins.
            • stateNamestring

              The name of the starting workflow state.

              minLength = 1, pattern = "^[a-z0-9](-?[a-z0-9])*$"

        • eventsarray of objects

          CloudEvent definitions for the workflow. Defines the events that can be consumed or produced by the workflow.

          minItems = 1

          Show events properties
          • namestring

            A unique name identifying this event definition within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • typestring

            The CloudEvents type attribute identifying the kind of event.

            Can be one of: "com.qlik.v1.task.run.finished""com.qlik/active-analytics-orch"

          • sourcestring

            The CloudEvents source attribute identifying the origin of the event.

            Can be one of: "system-events.task""dataset.updated"

          • dataOnlyboolean

            When true, only the event payload is accessible to consuming workflow states. When false, both the payload and context attributes are accessible.

            default = true

          • correlationarray of objects

            Correlation definitions used to match incoming CloudEvents to this workflow instance.

            minItems = 1

            Show correlation properties
            • contextAttributeNamestring
              Required

              The name of the CloudEvent extension context attribute to match on.

              Can be one of: "id""status""appId""spaceId""datasetId"

            • contextAttributeValuestring

              The expected value of the CloudEvent extension context attribute.

              minLength = 1

        • statesarray of objects

          The list of state definitions that compose the workflow.

          minItems = 1

          Show states properties
          • endboolean

            Marks this state as a terminal state in the workflow.

            default = true

          • namestring

            The name of this state, unique within the workflow.

            minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

          • typestring

            The state type. Must be EVENT for event-driven states.

            Can be one of: "EVENT"

          • onEventsarray of objects

            The events to consume and the optional actions to perform when they are received.

            Show onEvents properties
            • actionsarray of objects

              Actions to perform when the matched events are consumed.

              Show actions properties
              • namestring

                A unique name for this action within the workflow.

                minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

              • retryRefstring

                A reference to a defined workflow retry policy. If absent, the default retry policy applies.

              • conditionstring

                An expression that must evaluate to true for this action to be performed. When false, the action is skipped.

                minLength = 1

              • functionRefobject

                A reference to a function to invoke, either as a name string or a structured object.

                One of:
                • string

                  The name of the referenced function.

                  minLength = 1, maxLength = 100, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

                • object

                  A structured function reference with arguments and invocation options.

                  Show properties
                  • invokestring

                    Specifies whether the function is invoked synchronously or asynchronously.

                    Can be one of: "SYNC""ASYNC"

                    default = "SYNC"

                  • refNamestring
                    Required

                    The name of the function to invoke.

                    Can be one of: "app.reload"

                  • argumentsobject

                    Arguments to pass to the function.

                    additionalProperties = true

                  • selectionSetstring

                    A GraphQL selection set string. Only applicable when the function type is graphql.
              • retryableErrorsarray of strings

                Workflow error references for which this action must be retried. Used only when autoRetries is false.

                minItems = 1

              • nonRetryableErrorsarray of strings

                Workflow error references for which this action must not be retried. Used only when autoRetries is true.

                minItems = 1

            • eventRefsarray of strings
              Required

              References to one or more unique event names defined in the workflow events list.

              minItems = 1, maxItems = 100, uniqueItems = true

            • actionModestring

              Specifies whether actions are performed sequentially or in parallel.

              Can be one of: "SEQUENTIAL""PARALLEL"

              default = "SEQUENTIAL"

          • timeoutsobject

            State-specific timeout durations.

            Show timeouts properties
            • eventTimeoutstring

              The maximum duration to wait for the defined events to be received, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

            • stateExecTimeoutstring

              The maximum duration for executing this state, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

            • actionExecTimeoutstring

              The maximum duration for executing a single action, expressed as an ISO 8601 duration string or an expression that evaluates to one.

              minLength = 1

          • exclusiveboolean

            When true, consuming any one of the defined events causes its associated actions to execute. When false, all defined events must be consumed before actions are performed.

            default = true

          • compensatedBystring

            The unique name of a workflow state responsible for compensating this state if it fails.

            minLength = 1, pattern = "^[A-Za-z0-9 ./_\\()\-]{1,100}$"

        • enabledboolean

          Indicates whether the task is enabled. Disabled tasks will not trigger automatically.

          default = false

        • versionstring

          The semantic version of the workflow definition.

          pattern = "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"

        • metadataobject
          Show metadata properties
          • usagestring

            The product domain in which the resource is used. Defaults to ANALYTICS when not present.

            Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

          • ownerIdstring

            The user ID of the task owner.

          • spaceIdstring

            The unique identifier of the space the task operates in.

          • triggerobject
            Show trigger properties
            • idstring
              Required

              The unique identifier of the trigger associated with this task.

            • typeinteger
              Required

              The type identifier of the trigger associated with this task.

              Can be one of: 01234

          • tenantIdstring

            The unique identifier of the tenant the task operates in.

          • topologyobject

            Indicates the task's position in a dependency graph.

            Show topology properties
            • isChildboolean

              When true, this task is triggered by one or more parent tasks.

            • isParentboolean

              When true, this task has one or more downstream dependent tasks.
          • createdAtstring

            The UTC timestamp when the task was created.

            format = "date-time"

          • createdBystring

            The user ID of the user who created the task.

          • deletedAtstring

            The UTC timestamp when the task was deleted.

            format = "date-time"

          • spaceTypestring

            The type of space the task operates in.

            Can be one of: "personal""shared""managed"

          • updatedAtstring

            The UTC timestamp when the task was last updated.

            format = "date-time"

          • disabledCodestring

            The reason the task is currently disabled.

            Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

          • migratedFromstring

            The unique identifier of the legacy reload task this task was migrated from, if applicable.

          • resourceNamestring

            The name of the resource on which the task was created.

          • resourceTypestring

            The type of resource on which the task was created.

          • orchestrationobject
            Show orchestration properties
            • idstring
              Required

              The unique identifier of the orchestration instance associated with this task in the scheduling service.

            • typeinteger
              Required

              The type identifier of the orchestration system handling this task.

              Can be one of: 0123

            • attrsobject

              Additional attributes of the orchestration instance associated with this task in the scheduling service.

              Show additional optional properties
              • stringstring
            • lastRunobject
              Show lastRun properties
              • idstring
                Required

                The unique identifier of the task run.

              • statusstring
                Required

                The current status of the task run.

                Can be one of: "RUNNING""SUCCEEDED""FAILED"

              • endedAtstring

                The UTC timestamp when the task run ended.

                format = "date-time"

              • workerIdstring
                Required

                The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

              • startedAtstring

                The UTC timestamp when the task run started.

                format = "date-time"

              • executedAsstring

                The user ID of the user on whose behalf the task was executed.

              • workerTypestring
                Required

                The type or name of the target system that executed the run.

              • triggeredBystring
                Required

                The identity or event that triggered the task run.
          • scriptOwnerIdstring

            The user ID of the owner whose script context is used when running the task.

          • resourceSubTypestring

            The subtype of resource on which the task was created.
        • keepActiveboolean

          When true, workflow instances are not terminated when there are no active execution paths. Instances can be ended via a terminate end definition or a configured workflowExecTimeout.

          default = false

        • resourceIdstring

          The unique identifier of the resource this task operates on. The value supplied in a request body is ignored and is derived automatically from states.

        • annotationsarray of strings

          A list of terms describing the workflow's intended purpose, subject areas, or other important qualities.

          minItems = 1

        • descriptionstring

          A human-readable description of the workflow's purpose.

          maxLength = 1024

        • specVersionstring
          Required

          The Serverless Workflow specification version used by this task.

          minLength = 1

      • attrsobject

        additionalProperties = true

      • taskIdstring

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/graphs/subgraph 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/graphs/subgraph` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/graphs/subgraph',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task graph subgraph 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/graphs/subgraph" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "edges": [
    {
      "attrs": {
        "depth": 1
      },
      "source": "22222222-2222-2222-2222-222222222222",
      "target": "11111111-1111-1111-1111-111111111111"
    }
  ],
  "taskId": "11111111-1111-1111-1111-111111111111",
  "vertices": [
    {
      "attrs": {
        "depth": 0,
        "isChild": false,
        "isParent": true
      },
      "taskId": "11111111-1111-1111-1111-111111111111"
    },
    {
      "attrs": {
        "depth": 1,
        "isChild": true,
        "isParent": false
      },
      "taskId": "22222222-2222-2222-2222-222222222222"
    }
  ]
}

List task runs

Retrieves a paginated list of execution runs for the specified task, ordered by most recent run by default. Each run record includes the start and end time, status, and the identity that triggered it.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Query Parameters

  • limitinteger

    Maximum number of task runs to return per page.

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

  • pagestring

    Cursor token for fetching the next page of results.

  • sortstring

    Field and direction to sort results by. Prefix the field name with + for ascending or - for descending order. Defaults to -startedAt.

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

    default = "-startedAt"

Path Parameters

  • idstring
    Required

    The unique identifier of the task.

Responses

200

Task runs retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring
        Required

        The unique identifier of the task run.

      • statusstring
        Required

        The current status of the task run.

        Can be one of: "RUNNING""SUCCEEDED""FAILED"

      • endedAtstring

        The UTC timestamp when the task run ended.

        format = "date-time"

      • workerIdstring
        Required

        The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

      • startedAtstring

        The UTC timestamp when the task run started.

        format = "date-time"

      • executedAsstring

        The user ID of the user on whose behalf the task was executed.

      • workerTypestring
        Required

        The type or name of the target system that executed the run.

      • triggeredBystring
        Required

        The identity or event that triggered the task run.

      • logstring

        The raw log output from the task run.

      • taskIdstring
        Required

        The unique identifier of the task.

      • actionIdstring
        Required

        The unique identifier of the action that was executed.

      • taskMetaobject
        Required
        Show taskMeta properties
        • usagestring

          The product domain in which the resource is used. Defaults to ANALYTICS when not present.

          Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

        • ownerIdstring

          The user ID of the task owner.

        • spaceIdstring

          The unique identifier of the space the task operates in.

        • triggerobject
          Show trigger properties
          • idstring
            Required

            The unique identifier of the trigger associated with this task.

          • typeinteger
            Required

            The type identifier of the trigger associated with this task.

            Can be one of: 01234

        • tenantIdstring

          The unique identifier of the tenant the task operates in.

        • topologyobject

          Indicates the task's position in a dependency graph.

          Show topology properties
          • isChildboolean

            When true, this task is triggered by one or more parent tasks.

          • isParentboolean

            When true, this task has one or more downstream dependent tasks.
        • createdAtstring

          The UTC timestamp when the task was created.

          format = "date-time"

        • createdBystring

          The user ID of the user who created the task.

        • deletedAtstring

          The UTC timestamp when the task was deleted.

          format = "date-time"

        • spaceTypestring

          The type of space the task operates in.

          Can be one of: "personal""shared""managed"

        • updatedAtstring

          The UTC timestamp when the task was last updated.

          format = "date-time"

        • disabledCodestring

          The reason the task is currently disabled.

          Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

        • migratedFromstring

          The unique identifier of the legacy reload task this task was migrated from, if applicable.

        • resourceNamestring

          The name of the resource on which the task was created.

        • resourceTypestring

          The type of resource on which the task was created.

        • orchestrationobject
          Show orchestration properties
          • idstring
            Required

            The unique identifier of the orchestration instance associated with this task in the scheduling service.

          • typeinteger
            Required

            The type identifier of the orchestration system handling this task.

            Can be one of: 0123

          • attrsobject

            Additional attributes of the orchestration instance associated with this task in the scheduling service.

            Show additional optional properties
            • stringstring
          • lastRunobject
            Show lastRun properties
            • idstring
              Required

              The unique identifier of the task run.

            • statusstring
              Required

              The current status of the task run.

              Can be one of: "RUNNING""SUCCEEDED""FAILED"

            • endedAtstring

              The UTC timestamp when the task run ended.

              format = "date-time"

            • workerIdstring
              Required

              The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

            • startedAtstring

              The UTC timestamp when the task run started.

              format = "date-time"

            • executedAsstring

              The user ID of the user on whose behalf the task was executed.

            • workerTypestring
              Required

              The type or name of the target system that executed the run.

            • triggeredBystring
              Required

              The identity or event that triggered the task run.
        • scriptOwnerIdstring

          The user ID of the owner whose script context is used when running the task.

        • resourceSubTypestring

          The subtype of resource on which the task was created.
      • taskNamestring
        Required

        The name of the task at the time it was run.

      • resourceIdstring
        Required

        The unique identifier of the resource the task operated on.
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
          Required

          The URL of the linked resource.
      • prevobject
        Show prev properties
        • hrefstring
          Required

          The URL of the linked resource.
      • selfobject
        Show self properties
        • hrefstring
          Required

          The URL of the linked resource.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/runs 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/runs` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/runs',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task run ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/runs" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
      "status": "SUCCEEDED",
      "endedAt": "2018-03-20T09:12:28Z",
      "workerId": "550e8400-e29b-41d4-a716-446655440000",
      "startedAt": "2018-03-20T09:12:28Z",
      "executedAs": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
      "workerType": "reloads",
      "triggeredBy": "manual",
      "log": "string",
      "taskId": "string",
      "actionId": "string",
      "taskMeta": {
        "usage": "ANALYTICS",
        "ownerId": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
        "spaceId": "434f9f7c-4eeb-43f0-8f08-88b91f357c07",
        "trigger": {
          "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
          "type": 1
        },
        "tenantId": "rpxzti_ptV0RS4eGPSsaI0SCKl-6h2a",
        "topology": {
          "isChild": false,
          "isParent": true
        },
        "createdAt": "2018-03-20T09:12:28Z",
        "createdBy": "LP_LlaXYhUUWMr5csy8pFfTHecXePH5Z",
        "deletedAt": "2018-03-20T09:12:28Z",
        "spaceType": "shared",
        "updatedAt": "2018-03-20T09:12:28Z",
        "disabledCode": "MANUALLY",
        "migratedFrom": "c7dba73-dd5a-4725-9dd2-8bd9c8d126d7",
        "resourceName": "sample app",
        "resourceType": "app",
        "orchestration": {
          "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
          "type": 3,
          "attrs": {
            "last_run_status": "SUCCEEDED",
            "last_run_worker_type": "reloads"
          },
          "lastRun": {
            "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
            "status": "SUCCEEDED",
            "endedAt": "2018-03-20T09:12:28Z",
            "workerId": "550e8400-e29b-41d4-a716-446655440000",
            "startedAt": "2018-03-20T09:12:28Z",
            "executedAs": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
            "workerType": "reloads",
            "triggeredBy": "manual"
          }
        },
        "scriptOwnerId": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
        "resourceSubType": "script"
      },
      "taskName": "string",
      "resourceId": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Get task run log

Retrieves the execution log for a specific task run. Set the Accept header to text/plain to receive the raw log as a downloadable file, or application/json (default) to receive it wrapped in a JSON object with a logContent field.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Header Parameters

  • Acceptstring

    The preferred response format for the log content.

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

    default = "application/json"

Path Parameters

  • idstring
    Required

    The unique identifier of the task.

  • runIdstring
    Required

    The unique identifier of the task run.

Responses

200

Task run log retrieved successfully.

  • text/plainobject
    Show text/plain properties
    • logContentstring

200

Task run log retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • logContentstring

      Log content in plain text format.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/runs/{runId}/log 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/runs/{runId}/log` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/runs/{runId}/log',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task run log \
  --taskId 'string' \
  --runId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/runs/{runId}/log" \
-H "Authorization: Bearer <access_token>"

Example Response

[object Object]

Get last task run

Retrieves the most recent execution run for the specified task. Returns a 404 response if the task has never been run. Use this operation to quickly check whether the last run succeeded or failed without paginating through the full run history.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Path Parameters

  • idstring
    Required

    The unique identifier of the task.

Responses

200

Last task run retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required

      The unique identifier of the task run.

    • statusstring
      Required

      The current status of the task run.

      Can be one of: "RUNNING""SUCCEEDED""FAILED"

    • endedAtstring

      The UTC timestamp when the task run ended.

      format = "date-time"

    • workerIdstring
      Required

      The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

    • startedAtstring

      The UTC timestamp when the task run started.

      format = "date-time"

    • executedAsstring

      The user ID of the user on whose behalf the task was executed.

    • workerTypestring
      Required

      The type or name of the target system that executed the run.

    • triggeredBystring
      Required

      The identity or event that triggered the task run.

    • logstring

      The raw log output from the task run.

    • taskIdstring
      Required

      The unique identifier of the task.

    • actionIdstring
      Required

      The unique identifier of the action that was executed.

    • taskMetaobject
      Required
      Show taskMeta properties
      • usagestring

        The product domain in which the resource is used. Defaults to ANALYTICS when not present.

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

      • ownerIdstring

        The user ID of the task owner.

      • spaceIdstring

        The unique identifier of the space the task operates in.

      • triggerobject
        Show trigger properties
        • idstring
          Required

          The unique identifier of the trigger associated with this task.

        • typeinteger
          Required

          The type identifier of the trigger associated with this task.

          Can be one of: 01234

      • tenantIdstring

        The unique identifier of the tenant the task operates in.

      • topologyobject

        Indicates the task's position in a dependency graph.

        Show topology properties
        • isChildboolean

          When true, this task is triggered by one or more parent tasks.

        • isParentboolean

          When true, this task has one or more downstream dependent tasks.
      • createdAtstring

        The UTC timestamp when the task was created.

        format = "date-time"

      • createdBystring

        The user ID of the user who created the task.

      • deletedAtstring

        The UTC timestamp when the task was deleted.

        format = "date-time"

      • spaceTypestring

        The type of space the task operates in.

        Can be one of: "personal""shared""managed"

      • updatedAtstring

        The UTC timestamp when the task was last updated.

        format = "date-time"

      • disabledCodestring

        The reason the task is currently disabled.

        Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

      • migratedFromstring

        The unique identifier of the legacy reload task this task was migrated from, if applicable.

      • resourceNamestring

        The name of the resource on which the task was created.

      • resourceTypestring

        The type of resource on which the task was created.

      • orchestrationobject
        Show orchestration properties
        • idstring
          Required

          The unique identifier of the orchestration instance associated with this task in the scheduling service.

        • typeinteger
          Required

          The type identifier of the orchestration system handling this task.

          Can be one of: 0123

        • attrsobject

          Additional attributes of the orchestration instance associated with this task in the scheduling service.

          Show additional optional properties
          • stringstring
        • lastRunobject
          Show lastRun properties
          • idstring
            Required

            The unique identifier of the task run.

          • statusstring
            Required

            The current status of the task run.

            Can be one of: "RUNNING""SUCCEEDED""FAILED"

          • endedAtstring

            The UTC timestamp when the task run ended.

            format = "date-time"

          • workerIdstring
            Required

            The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

          • startedAtstring

            The UTC timestamp when the task run started.

            format = "date-time"

          • executedAsstring

            The user ID of the user on whose behalf the task was executed.

          • workerTypestring
            Required

            The type or name of the target system that executed the run.

          • triggeredBystring
            Required

            The identity or event that triggered the task run.
      • scriptOwnerIdstring

        The user ID of the owner whose script context is used when running the task.

      • resourceSubTypestring

        The subtype of resource on which the task was created.
    • taskNamestring
      Required

      The name of the task at the time it was run.

    • resourceIdstring
      Required

      The unique identifier of the resource the task operated on.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/{id}/runs/last 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/{id}/runs/last` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/{id}/runs/last',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task run last 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/{id}/runs/last" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
  "status": "SUCCEEDED",
  "endedAt": "2018-03-20T09:12:28Z",
  "workerId": "550e8400-e29b-41d4-a716-446655440000",
  "startedAt": "2018-03-20T09:12:28Z",
  "executedAs": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
  "workerType": "reloads",
  "triggeredBy": "manual",
  "log": "string",
  "taskId": "string",
  "actionId": "string",
  "taskMeta": {
    "usage": "ANALYTICS",
    "ownerId": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
    "spaceId": "434f9f7c-4eeb-43f0-8f08-88b91f357c07",
    "trigger": {
      "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
      "type": 1
    },
    "tenantId": "rpxzti_ptV0RS4eGPSsaI0SCKl-6h2a",
    "topology": {
      "isChild": false,
      "isParent": true
    },
    "createdAt": "2018-03-20T09:12:28Z",
    "createdBy": "LP_LlaXYhUUWMr5csy8pFfTHecXePH5Z",
    "deletedAt": "2018-03-20T09:12:28Z",
    "spaceType": "shared",
    "updatedAt": "2018-03-20T09:12:28Z",
    "disabledCode": "MANUALLY",
    "migratedFrom": "c7dba73-dd5a-4725-9dd2-8bd9c8d126d7",
    "resourceName": "sample app",
    "resourceType": "app",
    "orchestration": {
      "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
      "type": 3,
      "attrs": {
        "last_run_status": "SUCCEEDED",
        "last_run_worker_type": "reloads"
      },
      "lastRun": {
        "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
        "status": "SUCCEEDED",
        "endedAt": "2018-03-20T09:12:28Z",
        "workerId": "550e8400-e29b-41d4-a716-446655440000",
        "startedAt": "2018-03-20T09:12:28Z",
        "executedAs": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
        "workerType": "reloads",
        "triggeredBy": "manual"
      }
    },
    "scriptOwnerId": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
    "resourceSubType": "script"
  },
  "taskName": "string",
  "resourceId": "string"
}

List task runs for a resource

Retrieves a paginated list of task runs for a given resource, identified by id. Returns run history across all tasks associated with that resource, ordered by the most recent run by default.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Query Parameters

  • limitinteger

    Maximum number of task runs to return per page.

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

  • pagestring

    Cursor token for fetching the next page of results.

  • sortstring

    Field and direction to sort results by. Prefix the field name with + for ascending or - for descending order. Defaults to -startedAt.

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

    default = "-startedAt"

Path Parameters

  • idstring
    Required

    The unique identifier of the resource to retrieve task runs for.

Responses

200

Task runs retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring
        Required

        The unique identifier of the task run.

      • statusstring
        Required

        The current status of the task run.

        Can be one of: "RUNNING""SUCCEEDED""FAILED"

      • endedAtstring

        The UTC timestamp when the task run ended.

        format = "date-time"

      • workerIdstring
        Required

        The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

      • startedAtstring

        The UTC timestamp when the task run started.

        format = "date-time"

      • executedAsstring

        The user ID of the user on whose behalf the task was executed.

      • workerTypestring
        Required

        The type or name of the target system that executed the run.

      • triggeredBystring
        Required

        The identity or event that triggered the task run.

      • logstring

        The raw log output from the task run.

      • taskIdstring
        Required

        The unique identifier of the task.

      • actionIdstring
        Required

        The unique identifier of the action that was executed.

      • taskMetaobject
        Required
        Show taskMeta properties
        • usagestring

          The product domain in which the resource is used. Defaults to ANALYTICS when not present.

          Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

        • ownerIdstring

          The user ID of the task owner.

        • spaceIdstring

          The unique identifier of the space the task operates in.

        • triggerobject
          Show trigger properties
          • idstring
            Required

            The unique identifier of the trigger associated with this task.

          • typeinteger
            Required

            The type identifier of the trigger associated with this task.

            Can be one of: 01234

        • tenantIdstring

          The unique identifier of the tenant the task operates in.

        • topologyobject

          Indicates the task's position in a dependency graph.

          Show topology properties
          • isChildboolean

            When true, this task is triggered by one or more parent tasks.

          • isParentboolean

            When true, this task has one or more downstream dependent tasks.
        • createdAtstring

          The UTC timestamp when the task was created.

          format = "date-time"

        • createdBystring

          The user ID of the user who created the task.

        • deletedAtstring

          The UTC timestamp when the task was deleted.

          format = "date-time"

        • spaceTypestring

          The type of space the task operates in.

          Can be one of: "personal""shared""managed"

        • updatedAtstring

          The UTC timestamp when the task was last updated.

          format = "date-time"

        • disabledCodestring

          The reason the task is currently disabled.

          Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED""APP-MOVED-SPACE""OWNER-MOVED"

        • migratedFromstring

          The unique identifier of the legacy reload task this task was migrated from, if applicable.

        • resourceNamestring

          The name of the resource on which the task was created.

        • resourceTypestring

          The type of resource on which the task was created.

        • orchestrationobject
          Show orchestration properties
          • idstring
            Required

            The unique identifier of the orchestration instance associated with this task in the scheduling service.

          • typeinteger
            Required

            The type identifier of the orchestration system handling this task.

            Can be one of: 0123

          • attrsobject

            Additional attributes of the orchestration instance associated with this task in the scheduling service.

            Show additional optional properties
            • stringstring
          • lastRunobject
            Show lastRun properties
            • idstring
              Required

              The unique identifier of the task run.

            • statusstring
              Required

              The current status of the task run.

              Can be one of: "RUNNING""SUCCEEDED""FAILED"

            • endedAtstring

              The UTC timestamp when the task run ended.

              format = "date-time"

            • workerIdstring
              Required

              The unique identifier of the worker that executed the job. For example, a reload run carries the reload ID from the engine, and an automation run carries the automation run ID.

            • startedAtstring

              The UTC timestamp when the task run started.

              format = "date-time"

            • executedAsstring

              The user ID of the user on whose behalf the task was executed.

            • workerTypestring
              Required

              The type or name of the target system that executed the run.

            • triggeredBystring
              Required

              The identity or event that triggered the task run.
        • scriptOwnerIdstring

          The user ID of the owner whose script context is used when running the task.

        • resourceSubTypestring

          The subtype of resource on which the task was created.
      • taskNamestring
        Required

        The name of the task at the time it was run.

      • resourceIdstring
        Required

        The unique identifier of the resource the task operated on.
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
          Required

          The URL of the linked resource.
      • prevobject
        Show prev properties
        • hrefstring
          Required

          The URL of the linked resource.
      • selfobject
        Show self properties
        • hrefstring
          Required

          The URL of the linked resource.

400

The request is malformed or contains invalid parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

401

Authentication credentials are missing or invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

403

Access denied. You lack permission to perform this operation.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

404

The requested resource was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

500

An unexpected error occurred on the server.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.

503

The service is temporarily unavailable. Retry the request after a short delay.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codeinteger
      • innerany
      • titlestring
      • resultany
      • contextstring
      • timestampstring
    • traceIdstring

      A trace identifier for correlating the error to a specific service request.
GET /api/scheduling/tasks/resources/{id}/runs 
// qlik-api has not implemented support for `GET /api/scheduling/tasks/resources/{id}/runs` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/scheduling/tasks/resources/{id}/runs',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik scheduling task resource-runs 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/scheduling/tasks/resources/{id}/runs" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
      "status": "SUCCEEDED",
      "endedAt": "2018-03-20T09:12:28Z",
      "workerId": "550e8400-e29b-41d4-a716-446655440000",
      "startedAt": "2018-03-20T09:12:28Z",
      "executedAs": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
      "workerType": "reloads",
      "triggeredBy": "manual",
      "log": "string",
      "taskId": "string",
      "actionId": "string",
      "taskMeta": {
        "usage": "ANALYTICS",
        "ownerId": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
        "spaceId": "434f9f7c-4eeb-43f0-8f08-88b91f357c07",
        "trigger": {
          "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
          "type": 1
        },
        "tenantId": "rpxzti_ptV0RS4eGPSsaI0SCKl-6h2a",
        "topology": {
          "isChild": false,
          "isParent": true
        },
        "createdAt": "2018-03-20T09:12:28Z",
        "createdBy": "LP_LlaXYhUUWMr5csy8pFfTHecXePH5Z",
        "deletedAt": "2018-03-20T09:12:28Z",
        "spaceType": "shared",
        "updatedAt": "2018-03-20T09:12:28Z",
        "disabledCode": "MANUALLY",
        "migratedFrom": "c7dba73-dd5a-4725-9dd2-8bd9c8d126d7",
        "resourceName": "sample app",
        "resourceType": "app",
        "orchestration": {
          "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
          "type": 3,
          "attrs": {
            "last_run_status": "SUCCEEDED",
            "last_run_worker_type": "reloads"
          },
          "lastRun": {
            "id": "0c42b269-51d4-453a-a8ea-55734d209aa9",
            "status": "SUCCEEDED",
            "endedAt": "2018-03-20T09:12:28Z",
            "workerId": "550e8400-e29b-41d4-a716-446655440000",
            "startedAt": "2018-03-20T09:12:28Z",
            "executedAs": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
            "workerType": "reloads",
            "triggeredBy": "manual"
          }
        },
        "scriptOwnerId": "z1w_5hWRq-wIxXON_slIRrsF0YxpYjA",
        "resourceSubType": "script"
      },
      "taskName": "string",
      "resourceId": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}