Skip to main content
Version: 8.9 (unreleased)

Type Alias: JobActivationRequest

type JobActivationRequest = object;

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

Properties​

fetchVariable?​

optional fetchVariable: string[];

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

A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned.

maxJobsToActivate​

maxJobsToActivate: number;

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

The maximum jobs to activate by this request.

requestTimeout?​

optional requestTimeout: number;

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

The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.

tenantFilter?​

optional tenantFilter: TenantFilterEnum;

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

The tenant filtering strategy - determines whether to use provided tenant IDs or assigned tenant IDs from the authenticated principal's authorized tenants.

tenantIds?​

optional tenantIds: TenantId[];

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

A list of IDs of tenants for which to activate jobs.

timeout​

timeout: number;

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

A job returned after this call will not be activated by another call until the timeout (in ms) has been reached.

type​

type: string;

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

The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)

worker?​

optional worker: string;

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

The name of the worker activating the jobs, mostly used for logging purposes.