Activate Jobs of a specific type

GET /jobs

Will activate available jobs of the specific type, and returns the activated jobs.

If no jobs of this type are available, then the connection may be kept open until one or more jobs become available, or the request times out due to long polling.

Query Parameters

type string required
The type of the job to activate
maxJobsToActivate int32
Default value: 32
The maximum number of jobs to activate in this request
worker string
Default value: default
The name of the worker requesting to activate the jobs
jobTimeout string
Default value: 5m
Duration during which the activated jobs are claimed by this worker
Examples:
- durationTenSeconds
- durationFiveMin
- durationOneAndAHalfHour
Duration of ten seconds
Example: 10s
fetchVariables string[]
Names of the variables to fetch with each job.

If empty, all visible variables at the time of activation for the scope of the job will be returned.

Responses

Zero or more jobs activated

application/json

Schema
Example (from schema)

Schema

data object
jobs object[]
Array [
key int64
Key of the job
status string
Possible values: [activatable, activated, failed, error_thrown, completed]
The status of the job
type string
Type of the job
processInstanceKey int64
Key of the process instance which this job belongs to
bpmnProcessId string
BPMN process id of the process which this job belongs to
processDefinitionVersion int32
Version number of the process which this job belongs to
processDefinitionKey int64
Key of the process which this job belongs to
elementId string
Id of the element in the process which this job belongs to
elementInstanceKey int64
Key of the element instance which this job belongs to
customHeaders object
Set of custom headers defined during modelling; returned as a serialized JSON document
worker string
Name of the worker that activated this job
retries int32
Number of retries left for this job
deadline int64
UNIX epoch timestamp specifying when the job can be activated again
variables object
JSON document consisting of all variables visible to the task scope at the time of job activation
]
error string

{
  "data": {
    "jobs": [
      {
        "key": 0,
        "status": "activatable",
        "type": "string",
        "processInstanceKey": 0,
        "bpmnProcessId": "string",
        "processDefinitionVersion": 0,
        "processDefinitionKey": 0,
        "elementId": "string",
        "elementInstanceKey": 0,
        "customHeaders": {},
        "worker": "string",
        "retries": 0,
        "deadline": 0,
        "variables": {}
      }
    ]
  },
  "error": "string"
}