Tasks

Download AsyncAPI spec

Published when a new task is created. The event includes the task ID, owner, associated resource, and the scheduled action.

Payload

object

idstring
Required

Identifies the event.

minLength = 1
timestring

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
typestring
Required

Describes the type of event related to the originating occurrence.

minLength = 1
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
dataobject

Represents the full state of a task resource at the time the event was published. All lifecycle events carry this object as their data payload, capturing the task's configuration, ownership, and execution status.
Show data properties
- idstring
  Required
  
  The unique identifier of the task.
- namestring
  Required
  
  The name of the task.
- usagestring
  
  The product domain in which the associated resource is used, such as ANALYTICS or DATA_PREPARATION. Defaults to ANALYTICS when not specified.
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- actionstring
  Required
  
  The action performed on the target resource.
- statusstring
  
  The status in which the task run finished. One of succeeded, failed, or aborted.
  
  Can be one of: "succeeded""failed""aborted"
- enabledboolean
  
  Whether the task is enabled. When true, the task is active and eligible to run.
- ownerIdstring
  Required
  
  The unique identifier of the user that owns the task. Only applicable for user-level tasks.
- spaceIdstring
  
  The unique identifier of the space the task operates in.
- durationstring
  
  The task execution duration in ISO 8601 format.
- createdAtstring
  
  The UTC timestamp when the task was created.
  
  format = "date-time"
- createdBystring
  Required
  
  The unique identifier of the user that created the task.
- deletedAtstring
  
  The UTC timestamp when the task was deleted.
  
  format = "date-time"
- updatedAtstring
  
  The UTC timestamp when the task was last updated.
  
  format = "date-time"
- resourceIdstring
  Required
  
  The unique identifier of the target resource associated with the task's action.
- descriptionstring
  
  A user-provided description of the task.
- actionParamsarray of strings
  
  The list of parameters for the action.
- disabledCodestring
  
  The reason the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
- migratedFromstring
  
  The identifier of the original reload task from which this task was migrated. Empty if the task was not migrated.
- resourceTypestring
  Required
  
  The type of resource the task operates on.
  
  Can be one of: "app"
- statusDetailsstring
  
  Additional details about the final status, such as the failure reason, automation ID, or reload ID.
eventTypestring

Unique identifier for the event type.

Can be one of: "com.qlik.scheduling.task.created"
extensionsobject

Additional event metadata.
Show extensions properties
- useridstring
  
  Unique identifier of the user related to the event.
- tenantidstring
  
  Unique identifier of the tenant related to the event.
- toplevelresourceidstring
  
  Identifier of the top-level resource that triggered the event.

com.qlik.scheduling.task.created

Example payload of the "Task created" event

{
  "id": "A234-1234-1234",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.scheduling.tasks.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "string",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "My task",
    "usage": "ANALYTICS",
    "action": "string",
    "status": "succeeded",
    "enabled": true,
    "ownerId": "00000000-0000-0000-0000-000000000000",
    "spaceId": "string",
    "duration": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "resourceId": "string",
    "description": "This is my task",
    "actionParams": [
      "string"
    ],
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "resourceType": "app",
    "statusDetails": "string"
  },
  "eventType": "com.qlik.scheduling.task.created",
  "extensions": {
    "userid": "ad378d54-3e97-47c0-bc57-cd84dbb93fa2",
    "tenantid": "103359ca-3579-4125-a0dc-d19531b53186",
    "toplevelresourceid": "string"
  }
}

Published when a task is deleted. The event includes the full task state at the time of deletion, including the task ID and owner.

Payload

object

idstring
Required

Identifies the event.

minLength = 1
timestring

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
typestring
Required

Describes the type of event related to the originating occurrence.

minLength = 1
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
dataobject

Represents the full state of a task resource at the time the event was published. All lifecycle events carry this object as their data payload, capturing the task's configuration, ownership, and execution status.
Show data properties
- idstring
  Required
  
  The unique identifier of the task.
- namestring
  Required
  
  The name of the task.
- usagestring
  
  The product domain in which the associated resource is used, such as ANALYTICS or DATA_PREPARATION. Defaults to ANALYTICS when not specified.
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- actionstring
  Required
  
  The action performed on the target resource.
- statusstring
  
  The status in which the task run finished. One of succeeded, failed, or aborted.
  
  Can be one of: "succeeded""failed""aborted"
- enabledboolean
  
  Whether the task is enabled. When true, the task is active and eligible to run.
- ownerIdstring
  Required
  
  The unique identifier of the user that owns the task. Only applicable for user-level tasks.
- spaceIdstring
  
  The unique identifier of the space the task operates in.
- durationstring
  
  The task execution duration in ISO 8601 format.
- createdAtstring
  
  The UTC timestamp when the task was created.
  
  format = "date-time"
- createdBystring
  Required
  
  The unique identifier of the user that created the task.
- deletedAtstring
  
  The UTC timestamp when the task was deleted.
  
  format = "date-time"
- updatedAtstring
  
  The UTC timestamp when the task was last updated.
  
  format = "date-time"
- resourceIdstring
  Required
  
  The unique identifier of the target resource associated with the task's action.
- descriptionstring
  
  A user-provided description of the task.
- actionParamsarray of strings
  
  The list of parameters for the action.
- disabledCodestring
  
  The reason the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
- migratedFromstring
  
  The identifier of the original reload task from which this task was migrated. Empty if the task was not migrated.
- resourceTypestring
  Required
  
  The type of resource the task operates on.
  
  Can be one of: "app"
- statusDetailsstring
  
  Additional details about the final status, such as the failure reason, automation ID, or reload ID.
eventTypestring

Unique identifier for the event type.

default = "com.qlik.scheduling.task.deleted"
extensionsobject

Additional event metadata.
Show extensions properties
- useridstring
  
  Unique identifier of the user related to the event.
- tenantidstring
  
  Unique identifier of the tenant related to the event.
- toplevelresourceidstring
  
  Identifier of the top-level resource that triggered the event.

com.qlik.scheduling.task.deleted

Example payload of the "Task deleted" event

{
  "id": "A234-1234-1234",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.scheduling.tasks.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "string",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "My task",
    "usage": "ANALYTICS",
    "action": "string",
    "status": "succeeded",
    "enabled": true,
    "ownerId": "00000000-0000-0000-0000-000000000000",
    "spaceId": "string",
    "duration": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "resourceId": "string",
    "description": "This is my task",
    "actionParams": [
      "string"
    ],
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "resourceType": "app",
    "statusDetails": "string"
  },
  "eventType": "com.qlik.scheduling.task.deleted",
  "extensions": {
    "userid": "ad378d54-3e97-47c0-bc57-cd84dbb93fa2",
    "tenantid": "103359ca-3579-4125-a0dc-d19531b53186",
    "toplevelresourceid": "string"
  }
}

Published when a task's configuration or properties are updated. The event includes the updated task state along with a list of changed fields in _updates, identifying what was modified and the old and new values. Use this to detect configuration drift or audit changes to scheduled tasks.

Payload

object

idstring
Required

Identifies the event.

minLength = 1
timestring

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
typestring
Required

Describes the type of event related to the originating occurrence.

minLength = 1
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
dataobject

Represents the full state of a task resource at the time the event was published. All lifecycle events carry this object as their data payload, capturing the task's configuration, ownership, and execution status.
Show data properties
- idstring
  Required
  
  The unique identifier of the task.
- namestring
  Required
  
  The name of the task.
- usagestring
  
  The product domain in which the associated resource is used, such as ANALYTICS or DATA_PREPARATION. Defaults to ANALYTICS when not specified.
  
  Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- actionstring
  Required
  
  The action performed on the target resource.
- statusstring
  
  The status in which the task run finished. One of succeeded, failed, or aborted.
  
  Can be one of: "succeeded""failed""aborted"
- enabledboolean
  
  Whether the task is enabled. When true, the task is active and eligible to run.
- ownerIdstring
  Required
  
  The unique identifier of the user that owns the task. Only applicable for user-level tasks.
- spaceIdstring
  
  The unique identifier of the space the task operates in.
- durationstring
  
  The task execution duration in ISO 8601 format.
- createdAtstring
  
  The UTC timestamp when the task was created.
  
  format = "date-time"
- createdBystring
  Required
  
  The unique identifier of the user that created the task.
- deletedAtstring
  
  The UTC timestamp when the task was deleted.
  
  format = "date-time"
- updatedAtstring
  
  The UTC timestamp when the task was last updated.
  
  format = "date-time"
- resourceIdstring
  Required
  
  The unique identifier of the target resource associated with the task's action.
- descriptionstring
  
  A user-provided description of the task.
- actionParamsarray of strings
  
  The list of parameters for the action.
- disabledCodestring
  
  The reason the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""APP-SCRIPT-UPDATED""OWNER-DELETED""OWNER-DISABLED"
- migratedFromstring
  
  The identifier of the original reload task from which this task was migrated. Empty if the task was not migrated.
- resourceTypestring
  Required
  
  The type of resource the task operates on.
  
  Can be one of: "app"
- statusDetailsstring
  
  Additional details about the final status, such as the failure reason, automation ID, or reload ID.
- _updatesarray of objects
  
  The list of fields updated in this task, with the old and new values for each changed field.
  
  Show _updates properties
  
  pathstring
  
  The JSON path of the field that was updated.
  
  newValuestring
  
  The new value of the field after the update.
  
  oldValuestring
  
  The previous value of the field before the update.
eventTypestring

Unique identifier for the event type.

default = "com.qlik.scheduling.task.updated"

com.qlik.scheduling.task.updated

Example payload of the "Task updated" event

{
  "id": "A234-1234-1234",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.scheduling.tasks.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "string",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "My task",
    "usage": "ANALYTICS",
    "action": "string",
    "status": "succeeded",
    "enabled": true,
    "ownerId": "00000000-0000-0000-0000-000000000000",
    "spaceId": "string",
    "duration": "string",
    "createdAt": "2018-10-30T07:06:22Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "deletedAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "resourceId": "string",
    "description": "This is my task",
    "actionParams": [
      "string"
    ],
    "disabledCode": "MANUALLY",
    "migratedFrom": "string",
    "resourceType": "app",
    "statusDetails": "string",
    "_updates": [
      {
        "path": "string",
        "newValue": "string",
        "oldValue": "string"
      }
    ]
  },
  "eventType": "com.qlik.scheduling.task.updated"
}