Skip to main content
Version: 8.9

Type Alias: JobFilter

type JobFilter = object;

Job search filter.

Properties​

creationTime?​

optional creationTime?: DateTimeFilterProperty;

When the job was created. Field is present for jobs created after 8.9.

deadline?​

optional deadline?: DateTimeFilterProperty | null;

When the job can next be activated.

deniedReason?​

optional deniedReason?: StringFilterProperty;

The reason provided by the user task listener for denying the work.

elementId?​

optional elementId?: StringFilterProperty;

The element ID associated with the job.

elementInstanceKey?​

optional elementInstanceKey?: ElementInstanceKeyFilterProperty;

The element instance key associated with the job.

endTime?​

optional endTime?: DateTimeFilterProperty;

When the job ended.

errorCode?​

optional errorCode?: StringFilterProperty;

The error code provided for the failed job.

errorMessage?​

optional errorMessage?: StringFilterProperty;

The error message that provides additional context for a failed job.

hasFailedWithRetriesLeft?​

optional hasFailedWithRetriesLeft?: boolean;

Indicates whether the job has failed with retries left.

isDenied?​

optional isDenied?: boolean | null;

Indicates whether the user task listener denies the work.

jobKey?​

optional jobKey?: JobKeyFilterProperty;

The key, a unique identifier for the job.

kind?​

optional kind?: JobKindFilterProperty;

The kind of the job.

lastUpdateTime?​

optional lastUpdateTime?: DateTimeFilterProperty;

When the job was last updated. Field is present for jobs created after 8.9.

listenerEventType?​

optional listenerEventType?: JobListenerEventTypeFilterProperty;

The listener event type of the job.

processDefinitionId?​

optional processDefinitionId?: StringFilterProperty;

The process definition ID associated with the job.

processDefinitionKey?​

optional processDefinitionKey?: ProcessDefinitionKeyFilterProperty;

The process definition key associated with the job.

processInstanceKey?​

optional processInstanceKey?: ProcessInstanceKeyFilterProperty;

The process instance key associated with the job.

retries?​

optional retries?: IntegerFilterProperty;

The number of retries left.

state?​

optional state?: JobStateFilterProperty;

The state of the job.

tenantId?​

optional tenantId?: StringFilterProperty;

The tenant ID.

type?​

optional type?: StringFilterProperty;

The type of the job.

worker?​

optional worker?: StringFilterProperty;

The name of the worker for this job.