Skip to main content
Version: 8.9 (unreleased)

Type Alias: JobFilter

type JobFilter = object;

Defined in: gen/types.gen.ts:3521

Job search filter.

Properties

creationTime?

optional creationTime: DateTimeFilterProperty;

Defined in: gen/types.gen.ts:3605

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


deadline?

optional deadline: DateTimeFilterProperty | null;

Defined in: gen/types.gen.ts:3525

When the job can next be activated.


deniedReason?

optional deniedReason: StringFilterProperty;

Defined in: gen/types.gen.ts:3529

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


elementId?

optional elementId: StringFilterProperty;

Defined in: gen/types.gen.ts:3533

The element ID associated with the job.


elementInstanceKey?

optional elementInstanceKey: ElementInstanceKeyFilterProperty;

Defined in: gen/types.gen.ts:3537

The element instance key associated with the job.


endTime?

optional endTime: DateTimeFilterProperty;

Defined in: gen/types.gen.ts:3541

When the job ended.


errorCode?

optional errorCode: StringFilterProperty;

Defined in: gen/types.gen.ts:3545

The error code provided for the failed job.


errorMessage?

optional errorMessage: StringFilterProperty;

Defined in: gen/types.gen.ts:3549

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


hasFailedWithRetriesLeft?

optional hasFailedWithRetriesLeft: boolean;

Defined in: gen/types.gen.ts:3553

Indicates whether the job has failed with retries left.


isDenied?

optional isDenied: boolean | null;

Defined in: gen/types.gen.ts:3557

Indicates whether the user task listener denies the work.


jobKey?

optional jobKey: JobKeyFilterProperty;

Defined in: gen/types.gen.ts:3561

The key, a unique identifier for the job.


kind?

optional kind: JobKindFilterProperty;

Defined in: gen/types.gen.ts:3565

The kind of the job.


lastUpdateTime?

optional lastUpdateTime: DateTimeFilterProperty;

Defined in: gen/types.gen.ts:3609

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


listenerEventType?

optional listenerEventType: JobListenerEventTypeFilterProperty;

Defined in: gen/types.gen.ts:3569

The listener event type of the job.


processDefinitionId?

optional processDefinitionId: StringFilterProperty;

Defined in: gen/types.gen.ts:3573

The process definition ID associated with the job.


processDefinitionKey?

optional processDefinitionKey: ProcessDefinitionKeyFilterProperty;

Defined in: gen/types.gen.ts:3577

The process definition key associated with the job.


processInstanceKey?

optional processInstanceKey: ProcessInstanceKeyFilterProperty;

Defined in: gen/types.gen.ts:3581

The process instance key associated with the job.


retries?

optional retries: IntegerFilterProperty;

Defined in: gen/types.gen.ts:3585

The number of retries left.


state?

optional state: JobStateFilterProperty;

Defined in: gen/types.gen.ts:3589

The state of the job.


tenantId?

optional tenantId: StringFilterProperty;

Defined in: gen/types.gen.ts:3593

The tenant ID.


type?

optional type: StringFilterProperty;

Defined in: gen/types.gen.ts:3597

The type of the job.


worker?

optional worker: StringFilterProperty;

Defined in: gen/types.gen.ts:3601

The name of the worker for this job.