For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: JobActivationRequest

type JobActivationRequest = object;

Properties​

fetchVariable?​

optional fetchVariable?: string[];

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;

The maximum jobs to activate by this request.

requestTimeout?​

optional requestTimeout?: number;

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;

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[];

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

timeout​

timeout: number;

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

type​

type: string;

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

withLease?​

optional withLease?: boolean | null;

Whether to activate the jobs with a lease. When true, each activated job is assigned a distinct, opaque lease token, returned as ActivatedJobResult.leaseToken. The lease fences the complete, fail, and throw-error commands against a superseded activation of the same job (for example, after the job timed out or failed and was re-activated by another worker): a command carrying a stale lease token is rejected rather than racing with the newer activation. Once a job has been activated with a lease, it is served only to leasing workers of that job type; a homogeneous fleet per job type is recommended. Omit or set to false to activate jobs without a lease.

worker?​

optional worker?: string;

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