Skip to main content
Version: Next

Activate jobs

POST 
/jobs/activation

Iterate through all known partitions and activate jobs up to the requested maximum.

Request​

Body

required
    type stringrequired

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

    worker stringnullable

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

    timeout int64required

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

    maxJobsToActivate int32required

    the maximum jobs to activate by this request

    fetchVariable string[]nullable

    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

    requestTimeout int64nullable

    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.

    tenantIds string[]nullable

    a list of IDs of tenants for which to activate jobs

Responses​

The list of activated jobs.

Schema
    jobs object[]

    The activated jobs.

  • Array [
    • jobKey string

    the key, a unique identifier for the job

    processInstanceKey string

    the job's process instance key

    processDefinitionKey string

    the key of the job's process definition

    elementInstanceKey string

    the unique key identifying the associated task, unique within the scope of the process instance

  • ]
Loading...