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 int64

    the key, a unique identifier for the job

    type string

    the type of the job (should match what was requested)

    processInstanceKey int64

    the job's process instance key

    processDefinitionId string

    the bpmn process ID of the job's process definition

    processDefinitionVersion int32

    the version of the job's process definition

    processDefinitionKey int64

    the key of the job's process definition

    elementId string

    the associated task element ID

    elementInstanceKey int64

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

    customHeaders object

    a set of custom headers defined during modelling; returned as a serialized JSON document

    property name* any

    Additional properties allowed.

    worker string

    the name of the worker which activated this job

    retries int32

    the amount of retries left to this job (should always be positive)

    deadline int64

    when the job can be activated again, sent as a UNIX epoch timestamp

    variables object

    All variables visible to the task scope, computed at activation time

    property name* any

    Additional properties allowed.

    tenantId string

    The ID of the tenant that owns the job

  • ]
Loading...