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
annotations? description? enabled? events? id? keepActive? key? metadata? name resourceId? specVersion start? states? version?
annotations?: string[]

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

description?: string

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

enabled?: boolean

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

events?: tasks.Events

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

id?: string

The unique identifier assigned to the task by the service.

keepActive?: boolean

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.

key?: string

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

metadata?: tasks.TaskMetadata
name: string

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

resourceId?: string

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.

specVersion: string

The Serverless Workflow specification version used by this task.

start?: tasks.Startdef

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

states?: tasks.Eventstate[]

The list of state definitions that compose the workflow.

version?: string

The semantic version of the workflow definition.

Settings
Member Visibility

On This Page
Properties