Type Alias: JobSearchResult
type JobSearchResult = object;
Properties
businessId
businessId: BusinessId | null;
The business ID of the owning process instance, inherited when the job was created.
This is null for jobs created before version 8.10 and for jobs whose owning process
instance has no business ID.
creationTime
creationTime: string | null;
When the job was created. Field is present for jobs created after 8.9.
customHeaders
customHeaders: object;
A set of custom headers defined during modelling.
Index Signature
[key: string]: string
deadline
deadline: string | null;
If the job has been activated, when it will next be available to be activated.
deniedReason
deniedReason: string | null;
The reason provided by the user task listener for denying the work.
elementId
elementId: ElementId | null;
The element ID associated with the job. May be missing on job failure.
elementInstanceKey
elementInstanceKey: ElementInstanceKey;
The element instance key associated with the job.
endTime
endTime: string | null;
End date of the job.
This is null if the job is not in an end state yet.
errorCode
errorCode: string | null;
The error code provided for a failed job.
errorMessage
errorMessage: string | null;
The error message that provides additional context for a failed job.
hasFailedWithRetriesLeft
hasFailedWithRetriesLeft: boolean;
Indicates whether the job has failed with retries left.
isDenied
isDenied: boolean | null;
Indicates whether the user task listener denies the work.
jobKey
jobKey: JobKey;
The key, a unique identifier for the job.
kind
kind: JobKindEnum;
lastUpdateTime
lastUpdateTime: string | null;
When the job was last updated. Field is present for jobs created after 8.9.
listenerEventType
listenerEventType: JobListenerEventTypeEnum;
priority
priority: number;
The priority of the job. Higher values indicate higher priority. Jobs created before 8.10 have no stored priority; they appear last when sorting by this field and are excluded when filtering by this field. The API returns 0 for such jobs.
processDefinitionId
processDefinitionId: ProcessDefinitionId;
The process definition ID associated with the job.
processDefinitionKey
processDefinitionKey: ProcessDefinitionKey;
The process definition key associated with the job.
processInstanceKey
processInstanceKey: ProcessInstanceKey;
The process instance key associated with the job.
retries
retries: number;
The amount of retries left to this job.
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.
state
state: JobStateEnum;
tenantId
tenantId: TenantId;
type
type: string;
The type of the job.
worker
worker: string;
The name of the worker of this job.