Skip to main content
Version: 8.9

Type Alias: ActivatedJobResult

type ActivatedJobResult = object;

Properties​

customHeaders​

customHeaders: object;

A set of custom headers defined during modelling; returned as a serialized JSON document.

Index Signature​

[key: string]: unknown

deadline​

deadline: number;

When the job can be activated again, sent as a UNIX epoch timestamp.

elementId​

elementId: ElementId;

The associated task element ID.

elementInstanceKey​

elementInstanceKey: ElementInstanceKey;

The element instance key of the task.

jobKey​

jobKey: JobKey;

The key, a unique identifier for the job.

kind​

kind: JobKindEnum;

listenerEventType​

listenerEventType: JobListenerEventTypeEnum;

processDefinitionId​

processDefinitionId: ProcessDefinitionId;

The bpmn process ID of the job's process definition.

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

The key of the job's process definition.

processDefinitionVersion​

processDefinitionVersion: number;

The version of the job's process definition.

processInstanceKey​

processInstanceKey: ProcessInstanceKey;

The job's process instance key.

retries​

retries: number;

The amount of retries left to this job (should always be positive).

rootProcessInstanceKey​

rootProcessInstanceKey: ProcessInstanceKey | null;

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

tags​

tags: TagSet;

tenantId​

tenantId: TenantId;

The ID of the tenant that owns the job.

type​

type: string;

The type of the job (should match what was requested).

userTask​

userTask: UserTaskProperties | null;

User task properties, if the job is a user task. This is null if the job is not a user task.

variables​

variables: object;

All variables visible to the task scope, computed at activation time.

Index Signature​

[key: string]: unknown

worker​

worker: string;

The name of the worker which activated this job.