activate-jobs.api.mdx

id	title	description	sidebar_label	hide_title	hide_table_of_contents	api	sidebar_class_name	info_path	custom_edit_url	hide_send_button
activate-jobs	Activate jobs	Iterate through all known partitions and activate jobs up to the requested maximum.	Activate jobs	true	true	eJztWVtv4zYW/isHfNkJVrE93Wl31m0XcJNp62ybBomnXSCTB0o6tjihSA1J2XEN//fFIXWzpVxmsfs2AYJE4uG5fudCasccX1k2vWUXOmZ3EdMFGu6EVvOUTRlPnFhzhxc6tixiKdrEiIKW2ZTNHZEiuMzocpUBlxLuld4oKLhxgqgscJVCzQU+6thCWYDT4DIEg59KtA5TyPmDyMt89EGxiFWvf9Dplk13/lEYTNnUmRIjlmjlUDla4kUhReLVHX+0pNSO2STDnNN/blsgmzIdf8TEsYgVhoxzAm27ujuyaZF5LYFWI+AWUlwKhSkI5VX+4erXSyiMTtBaeIWj1Qi++xMxxqnj9v6ciL3hnsH3H1jBtzkqd2rRrEWCHxiM/3kSzKzUs84ItWL7iG20uUczrJPiOYJeeh0CXe1VoVb+Lfk2glxbJ7dQWkxhqQ1IvVoRRVGaQlu0o57giKlSSh5LDA7eR8yJHHXp+prMvG8MutKQT/jSoQGXCQsJBX8jpASlHcTYxDyFeAtcaZehCVSlckJ6lSs58EooyO0JZNxCjKjAIE8yTA/8JJTDFRoWsaU2OXfh1TdvyHM5fyCELvSskjrsxAplAYZOt7iMt8GKCnmj56T+7SuSukSXZL9zI4Lz+s6SwjoK2rqi8UL9LkJWFbR29VsQS8C8cNvI59JaWBFL7GznrvEb8a0RoJWPNS3ZRBcNUIi7j0mMTdAOfMqN4dseAiImHOadJGkwum+Sc/EYRBZtXjeyE50XEgkLmwwVWSGRk2tU0FHYDly0aXDVcFocAmUE8+XQ8vcwiYBTyvJSugZewvp8eGzXd7RLakoSLSUli7CQCksOSX396myitdYckeeYCu5QbiPANapgoNI9s14GZaqwXnc2nQzlJSqu3Dy1T4Ftfm59/D2t9cDYZCLJDgBPGTDq4+CxuPd0qYAQyvJtIG/rxlBC3tGyIwbUaWYNcq+DX9l+H5jaQisbKvRXk8kwvmpTW9DU9ry4N7yUaeujR9qIJxpk2NfuGW9/dqOilW6uv7KZLiV1Uyoxm4w72HDbttmTfvXfe2nUzdreRZ1/SFxc5KrpffPzjuS/2OZ92rB5mbDf0VgRotOXuA6LnyHpqXqNEqkXP2Yet1YnwgeMejlU5DA/H7QkKa3T+c/IUzSDCWnR4ynQQRYIm3kiLYkR5DpFX3S+7bRVCxwsGsGl+BNTuLj57RJSnZSkzmgAkTxNvR+4vOogpyoanzlVhFrRYtf3xY86HvSBQWcqlA74M9el8i6oyEDi0oXZL/BsAMvlhm+p90OhrXBijScvjGmKPJVCDSTIH1SJ68xIuDocSviKCxWBpQB7f7+/nP8bsNBUKEWO1vG8eFaHMH00/XkABdTGm/ZdN/Rq/PUo8w078j2l9Iq5blsnVT474nWbGA5Lm7iBDhzVCb1RzUQyGOqPOv4XbodZ3iNNLFAq8alEECkqJ5YCTTOVPMa0SuW5so6rBB8VcJj4oiInuS8rMk9p/l+VsbqUPKd45RISU7llW8/rR+Umqmk3wmXVYeNgmDu2fvAQsW+7bN150wsdX6OloWLfXT/qwjXBPmJvHuu7hdFrkVLx4o7TeEOz/ppLkT7RewujY4n5X5/rwTO4CpSQouNCQgB7OIMRYRxOYbfXP57BP958/fe7V5lzhZ2Ox5vNZmSWySmmwmkz0mY1NsuEfonuZASLDA2N/1tfBJrcgbbRgi0wEUuR1MlZqe177IGrn+nSx4erplyURvRO0DN4fz3vIeNAdHcmZDzWpZvGkqt71oayL7TXiso852bbgVJHwD5i1nFXdkeRR0vuMW+Cxc+LxRUEFpDoFKu0F7YWREbkQtHZi03fTCZ+PgxP30wmvopTxF9giQJ8KCRXoToemUOHA22wwo83rE6W/1FktBErcSx3dJB2FYjPg0Uhob4eSqiZAvKyIRyiMdqATpLSGH9KErJJ+Fp2fTb1WPySa19y7Uuu9XON7oLQZZruLgttPXS4y9iUjekQNm5HKxYxupPzs/vtjpVGsinbhYTZT8fjXaat2093hTZuP15TNA7mPFoOiVUDRuqEyywI7QeOFrrj9hnPS5VyeAvX724W8BN3uOFb70gSecj67eTtZJArkT7CcXY1h2BhgF2nFNRsKacH2QbilzDe7+/IkUlphNve0Lbgnhi5QTMryfcNHCp5njs9ByIWVf/8WIPk4o+FjzOVsev2MvjdA6eLlyF81Yec9k1zhzkZvB6c9K7vbuu9d/1LrsnB3UtL6VG/1F6jCpN9ZxFy6kMum4xe9/F/NfdpnOg8L5Wv5Wrl50DgHecnsrSOnB4xKRJU1nuCMNUR+0tYgepYDa9HBJyA7rqEr4TLyniU6HychG3N31jqeJxzocaVCDs+m/36/vJ8dvrL/Ozd5c2709ejycg9OB8gSrGcq44es+4N07Glu7Zv/d8+HlTIcPjgxoXkQhH4vf27qhTcskq3TjG4i6qEvmW7Xcwtvjdyv6fXn0o0Wza9vWvzn572EQsnel897mn+Z2fBuNNFuA1bc1n6657ji6h9VO+YJQkW7knau05Fu/rtZkHZUn0YobsDNmWGb+ijCd+wKWP0Acf7zn85oXc7JrlalXxFtIEn/fwHOa4MGg==	post api-method	docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api		true

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; import ParamsDetails from "@theme/ParamsDetails"; import RequestSchema from "@theme/RequestSchema"; import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading";

<Heading as={"h1"} className={"openapi__heading"} children={"Activate jobs"}

<MethodEndpoint method={"post"} path={"/jobs/activation"} context={"endpoint"}

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

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}

<RequestSchema title={"Body"} body={{ required: true, content: { "application/json": { schema: { type: "object", properties: { type: { description: 'The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />).\n', type: "string", }, worker: { description: "The name of the worker activating the jobs, mostly used for logging purposes.", type: "string", nullable: true, }, timeout: { description: "A job returned after this call will not be activated by another call until the timeout (in ms) has been reached.\n", type: "integer", format: "int64", }, maxJobsToActivate: { description: "The maximum jobs to activate by this request.", type: "integer", format: "int32", }, fetchVariable: { description: "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.\n", type: "array", nullable: true, items: { type: "string" }, }, requestTimeout: { description: "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.\n", type: "integer", format: "int64", default: 0, nullable: true, }, tenantIds: { description: "A list of IDs of tenants for which to activate jobs.", type: "array", items: { type: "string" }, nullable: true, }, }, required: ["type", "timeout", "maxJobsToActivate"], title: "JobActivationRequest", }, }, }, }}

<StatusCodes id={undefined} label={undefined} responses={{ "200": { description: "The list of activated jobs.", content: { "application/json": { schema: { description: "The list of activated jobs", type: "object", properties: { jobs: { description: "The activated jobs.", type: "array", items: { type: "object", properties: { type: { description: "The type of the job (should match what was requested).", type: "string", }, processDefinitionId: { description: "The bpmn process ID of the job's process definition.", type: "string", }, processDefinitionVersion: { description: "The version of the job's process definition.", type: "integer", format: "int32", }, elementId: { description: "The associated task element ID.", type: "string", }, customHeaders: { description: "A set of custom headers defined during modelling; returned as a serialized JSON document.", type: "object", additionalProperties: true, }, worker: { description: "The name of the worker which activated this job.", type: "string", }, retries: { description: "The amount of retries left to this job (should always be positive).", type: "integer", format: "int32", }, deadline: { description: "When the job can be activated again, sent as a UNIX epoch timestamp.", type: "integer", format: "int64", }, variables: { description: "All variables visible to the task scope, computed at activation time.", type: "object", additionalProperties: true, }, tenantId: { description: "The ID of the tenant that owns the job.", type: "string", }, jobKey: { description: "The key, a unique identifier for the job.", type: "string", }, processInstanceKey: { description: "The job's process instance key.", type: "string", }, processDefinitionKey: { description: "The key of the job's process definition.", type: "string", }, elementInstanceKey: { description: "The unique key identifying the associated task, unique within the scope of the process instance.\n", type: "string", }, }, title: "ActivatedJobResult", }, }, }, title: "JobActivationResult", }, }, }, }, "400": { description: "The provided data is not valid.", content: { "application/problem+json": { schema: { description: "A Problem detail object as described in RFC 9457. There may be additional properties specific to the problem type.\n", type: "object", properties: { type: { type: "string", format: "uri", description: "A URI identifying the problem type.", default: "about:blank", }, title: { type: "string", description: "A summary of the problem type.", }, status: { type: "integer", format: "int32", description: "The HTTP status code for this problem.", minimum: 400, maximum: 600, }, detail: { type: "string", description: "An explanation of the problem in more detail.", }, instance: { type: "string", format: "uri", description: "A URI identifying the origin of the problem.", }, }, title: "ProblemDetail", }, }, }, }, "500": { description: "An internal error occurred while processing the request.\n", content: { "application/problem+json": { schema: { description: "A Problem detail object as described in RFC 9457. There may be additional properties specific to the problem type.\n", type: "object", properties: { type: { type: "string", format: "uri", description: "A URI identifying the problem type.", default: "about:blank", }, title: { type: "string", description: "A summary of the problem type.", }, status: { type: "integer", format: "int32", description: "The HTTP status code for this problem.", minimum: 400, maximum: 600, }, detail: { type: "string", description: "An explanation of the problem in more detail.", }, instance: { type: "string", format: "uri", description: "A URI identifying the origin of the problem.", }, }, title: "ProblemDetail", }, }, }, }, }}