Type Alias Task

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

Properties

annotations?: string[]

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

description?: string
enabled?: boolean
events?: tasks.Events
id?: string
keepActive?: boolean
key?: string
metadata?: tasks.TaskMetadata
name: string
resourceId?: string
specVersion: string
start?: tasks.Startdef
states?: tasks.Eventstate[]
version?: string