diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml
index 504314e280..3b7ae92e1e 100644
--- a/api/camunda/camunda-openapi.yaml
+++ b/api/camunda/camunda-openapi.yaml
@@ -2,7 +2,7 @@ openapi: "3.0.3"
info:
title: Camunda 8 REST API
version: "0.1"
- description: API for communicating with the Camunda 8 cluster.
+ description: API for communicating with a Camunda 8 cluster.
license:
name: Camunda License Version 1.0
url: https://github.com/camunda/camunda/blob/main/licenses/CAMUNDA-LICENSE-1.0.txt
@@ -15,13 +15,13 @@ servers:
variables:
host:
default: localhost
- description: The hostname of the C8 REST Gateway.
+ description: The hostname of the Camunda 8 REST Gateway.
port:
default: "8080"
- description: The port of the C8 REST API server.
+ description: The port of the Camunda 8 REST API server.
schema:
default: http
- description: The schema of the C8 REST API server.
+ description: The schema of the Camunda 8 REST API server.
paths:
/topology:
@@ -32,7 +32,11 @@ paths:
description: Obtains the current topology of the cluster the gateway is part of.
responses:
"200":
- $ref: "#/components/responses/TopologyResponse"
+ description: Obtains the current topology of the cluster the gateway is part of.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/TopologyResponse"
/jobs/activation:
post:
tags:
@@ -53,12 +57,221 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/JobActivationResponse"
-
+ "400":
+ description: >
+ The provided data is not valid.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /jobs/{jobKey}/failure:
+ post:
+ tags:
+ - Job
+ summary: Fail job
+ description: |
+ Mark the job as failed
+ parameters:
+ - name: jobKey
+ in: path
+ required: true
+ description: The key of the job to fail.
+ schema:
+ type: integer
+ format: int64
+ requestBody:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/JobFailRequest"
+ responses:
+ "204":
+ description: The job is failed.
+ "400":
+ description: >
+ The provided data is not valid.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: >
+ The job with the given jobKey is not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "409":
+ description: >
+ The job with the given key is in the wrong state currently.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /jobs/{jobKey}/error:
+ post:
+ tags:
+ - Job
+ summary: Report error for job
+ description: |
+ Reports a business error (i.e. non-technical) that occurs while processing a job.
+ parameters:
+ - name: jobKey
+ in: path
+ required: true
+ description: The key of the job.
+ schema:
+ type: integer
+ format: int64
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/JobErrorRequest"
+ responses:
+ "204":
+ description: An error is thrown for the job.
+ "400":
+ description: >
+ The provided data is not valid.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: >
+ The job with the given jobKey is not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "409":
+ description: >
+ The job with the given key is in the wrong state currently.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /jobs/{jobKey}/completion:
+ post:
+ tags:
+ - Job
+ summary: Complete job
+ description: |
+ Complete a job with the given payload, which allows completing the associated service task.
+ parameters:
+ - name: jobKey
+ in: path
+ required: true
+ description: The key of the job to complete.
+ schema:
+ type: integer
+ format: int64
+ requestBody:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/JobCompletionRequest"
+ responses:
+ "204":
+ description: The job was completed successfully.
+ "400":
+ description: >
+ The job with the given key cannot be completed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: The job with the given key was not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "409":
+ description: >
+ The job with the given key is in the wrong state currently.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /incidents/{incidentKey}/resolution:
+ post:
+ tags:
+ - Incident
+ summary: Resolve incident
+ description: >
+ Marks the incident as resolved; most likely a call to Update job will be necessary
+ to reset the job’s retries, followed by this call.
+ parameters:
+ - name: incidentKey
+ in: path
+ required: true
+ description: Key of the incident to resolve.
+ schema:
+ type: integer
+ format: int64
+ responses:
+ "204":
+ description: The incident is marked as resolved.
+ "400":
+ description: The provided data is not valid.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: The incident with the incidentKey is not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
/user-tasks/{userTaskKey}/completion:
post:
tags:
- User task
- summary: Complete a user task
+ summary: Complete user task
description: Completes a user task with the given key.
parameters:
- name: userTaskKey
@@ -78,8 +291,20 @@ paths:
responses:
"204":
description: The user task was completed successfully.
+ "400":
+ description: >
+ The user task with the given key cannot be completed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
"404":
description: The user task with the given key was not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
"409":
description: >
The user task with the given key is in the wrong state currently.
@@ -88,10 +313,9 @@ paths:
application/problem+json:
schema:
$ref: "#/components/schemas/ProblemDetail"
- "400":
+ "500":
description: >
- The user task with the given key cannot be completed.
- More details are provided in the response body.
+ An internal error occurred while processing the request.
content:
application/problem+json:
schema:
@@ -100,7 +324,7 @@ paths:
post:
tags:
- User task
- summary: Assign a user task
+ summary: Assign user task
description: Assigns a user task with the given key to the given assignee.
parameters:
- name: userTaskKey
@@ -119,8 +343,20 @@ paths:
responses:
"204":
description: The user task's assignment was adjusted.
+ "400":
+ description: >
+ The assignment of the user task with the given key cannot be completed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
"404":
description: The user task with the given key was not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
"409":
description: >
The user task with the given key is in the wrong state currently.
@@ -129,10 +365,9 @@ paths:
application/problem+json:
schema:
$ref: "#/components/schemas/ProblemDetail"
- "400":
+ "500":
description: >
- The assignment of the user task with the given key cannot be completed.
- More details are provided in the response body.
+ An internal error occurred while processing the request.
content:
application/problem+json:
schema:
@@ -141,7 +376,7 @@ paths:
patch:
tags:
- User task
- summary: Update a user task
+ summary: Update user task
description: Update a user task with the given key.
parameters:
- name: userTaskKey
@@ -160,8 +395,20 @@ paths:
responses:
"204":
description: The user task was updated successfully.
+ "400":
+ description: >
+ The user task with the given key cannot be updated.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
"404":
description: The user task with the given key was not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
"409":
description: >
The user task with the given key is in the wrong state currently.
@@ -170,10 +417,9 @@ paths:
application/problem+json:
schema:
$ref: "#/components/schemas/ProblemDetail"
- "400":
+ "500":
description: >
- The user task with the given key cannot be updated.
- More details are provided in the response body.
+ An internal error occurred while processing the request.
content:
application/problem+json:
schema:
@@ -182,7 +428,7 @@ paths:
delete:
tags:
- User task
- summary: Unassign a user task
+ summary: Unassign user task
description: Removes the assignee of a task with the given key.
parameters:
- name: userTaskKey
@@ -193,37 +439,373 @@ paths:
type: integer
format: int64
responses:
- "204":
- description: The user task was unassigned successfully.
- "404":
- description: The user task with the given key was not found.
- "409":
+ "204":
+ description: The user task was unassigned successfully.
+ "400":
+ description: >
+ The user task with the given key cannot be unassigned.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: The user task with the given key was not found.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "409":
+ description: >
+ The user task with the given key is in the wrong state currently.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /user-tasks/search:
+ post:
+ tags:
+ - User task
+ summary: Query user tasks (experimental)
+ description: |
+ Search for user tasks based on given criteria.
+
+ **Note**: This endpoint is experimental and not enabled on Camunda clusters
+ out of the box. It has to be enabled explicitly for a cluster.
+ requestBody:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/UserTaskSearchQueryRequest"
+ responses:
+ "200":
+ description: >
+ The User Task Search successful response.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/UserTaskSearchQueryResponse"
+ "400":
+ description: >
+ The User Task Search Query failed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /process-instances/search:
+ post:
+ tags:
+ - Process Instance
+ summary: Query process instances (experimental)
+ description: |
+ Search for process instances based on given criteria.
+
+ **Note**: This endpoint is experimental and not enabled on Camunda clusters
+ out of the box. It has to be enabled explicitly for a cluster.
+ requestBody:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ProcessInstanceSearchQueryRequest"
+ responses:
+ "200":
+ description: >
+ The Process Instance Search successful response.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ProcessInstanceSearchQueryResponse"
+ "400":
+ description: >
+ The Process Instance Search Query failed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /decision-definitions/search:
+ post:
+ tags:
+ - Decision Definition
+ summary: Query decision definitions (experimental)
+ description: |
+ Search for decision definitions based on given criteria.
+
+ **Note**: This endpoint is experimental and not enabled on Camunda clusters
+ out of the box. It has to be enabled explicitly for a cluster.
+ requestBody:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/DecisionDefinitionSearchQueryRequest"
+ responses:
+ "200":
description: >
- The user task with the given key is in the wrong state currently.
+ The Decision Definition Search successful response.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/DecisionDefinitionSearchQueryResponse"
+ "400":
+ description: >
+ The Decision Definition Search Query failed.
More details are provided in the response body.
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ProblemDetail"
- "400":
+ "500":
description: >
- The user task with the given key cannot be unassigned.
- More details are provided in the response body.
+ An internal error occurred while processing the request.
content:
application/problem+json:
schema:
$ref: "#/components/schemas/ProblemDetail"
components:
- responses:
- TopologyResponse:
- description: Obtains the current topology of the cluster the gateway is part of.
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TopologyResponse"
-
schemas:
+ UserTaskSearchQueryRequest:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryRequest"
+ description: User task search query request.
+ type: object
+ properties:
+ filter:
+ $ref: "#/components/schemas/UserTaskFilterRequest"
+ UserTaskSearchQueryResponse:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryResponse"
+ description: User task search query response.
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: "#/components/schemas/UserTaskItem"
+ UserTaskFilterRequest:
+ description: User task filter request.
+ type: object
+ properties:
+ key:
+ type: integer
+ format: int64
+ state:
+ type: string
+ assignee:
+ type: string
+ elementId:
+ type: string
+ candidateGroup:
+ type: string
+ candidateUser:
+ type: string
+ processDefinitionKey:
+ type: integer
+ format: int64
+ processInstanceKey:
+ type: integer
+ format: int64
+ tenantIds:
+ type: string
+ bpmnDefinitionId:
+ type: string
+ UserTaskItem:
+ type: object
+ properties:
+ key:
+ type: integer
+ format: int64
+ state:
+ type: string
+ assignee:
+ type: string
+ elementId:
+ type: string
+ elementInstanceKey:
+ type: integer
+ format: int64
+ candidateGroup:
+ type: array
+ items:
+ type: string
+ candidateUser:
+ type: array
+ items:
+ type: string
+ bpmnProcessId:
+ type: string
+ processDefinitionKey:
+ type: integer
+ format: int64
+ processInstanceKey:
+ type: integer
+ format: int64
+ formKey:
+ type: integer
+ format: int64
+ creationDate:
+ type: string
+ format: date-time
+ completionDate:
+ type: string
+ format: date-time
+ followUpDate:
+ type: string
+ format: date-time
+ dueDate:
+ type: string
+ format: date-time
+ tenantIds:
+ type: string
+ externalFormReference:
+ type: string
+ processDefinitionVersion:
+ type: integer
+ format: int32
+ customHeaders:
+ type: object
+ additionalProperties:
+ type: string
+ ProcessInstanceSearchQueryRequest:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryRequest"
+ type: object
+ properties:
+ filter:
+ allOf:
+ - $ref: "#/components/schemas/ProcessInstanceFilterRequest"
+ ProcessInstanceFilterRequest:
+ type: object
+ properties:
+ key:
+ type: array
+ items:
+ type: integer
+ format: int64
+ variables:
+ type: array
+ items:
+ $ref: "#/components/schemas/VariableValueFilterRequest"
+ ProcessInstanceSearchQueryResponse:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryResponse"
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: "#/components/schemas/ProcessInstanceItem"
+ ProcessInstanceItem:
+ type: object
+ properties:
+ tenantId:
+ type: string
+ key:
+ type: integer
+ format: int64
+ processDefinitionKey:
+ type: integer
+ format: int64
+ processVersion:
+ type: integer
+ format: int32
+ bpmnProcessId:
+ type: string
+ parentKey:
+ type: integer
+ format: int64
+ parentFlowNodeInstanceKey:
+ type: integer
+ format: int64
+ startDate:
+ type: string
+ format: date-time
+ endDate:
+ type: string
+ format: date-time
+ DecisionDefinitionSearchQueryRequest:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryRequest"
+ type: object
+ properties:
+ filter:
+ allOf:
+ - $ref: "#/components/schemas/DecisionDefinitionFilterRequest"
+ DecisionDefinitionFilterRequest:
+ type: object
+ properties:
+ decisionKey:
+ type: integer
+ format: int64
+ dmnDecisionId:
+ type: string
+ dmnDecisionName:
+ type: string
+ version:
+ type: integer
+ format: int32
+ dmnDecisionRequirementsId:
+ type: string
+ decisionRequirementsKey:
+ type: integer
+ format: int64
+ tenantId:
+ type: string
+ DecisionDefinitionSearchQueryResponse:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryResponse"
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: "#/components/schemas/DecisionDefinitionItem"
+ DecisionDefinitionItem:
+ type: object
+ properties:
+ decisionKey:
+ type: integer
+ format: int64
+ dmnDecisionId:
+ type: string
+ dmnDecisionName:
+ type: string
+ version:
+ type: integer
+ format: int32
+ dmnDecisionRequirementsId:
+ type: string
+ decisionRequirementsKey:
+ type: integer
+ format: int64
+ tenantId:
+ type: string
TopologyResponse:
description: The response of a topology request.
type: object
@@ -337,36 +919,13 @@ components:
type: object
properties:
changeset:
- allOf:
- - $ref: "#/components/schemas/Changeset"
- description: |
- JSON object with changed task attribute values.
-
- The following attributes can be adjusted with this endpoint, additional attributes
- will be ignored:
-
- * `candidateGroups` - reset by providing an empty list
- * `candidateUsers` - reset by providing an empty list
- * `dueDate` - reset by providing an empty String
- * `followUpDate` - reset by providing an empty String
-
- Providing any of those attributes with a `null` value or omitting it preserves
- the persisted attribute's value.
-
- The assignee cannot be adjusted with this endpoint, use the Assign task endpoint.
- This ensures correct event emission for assignee changes.
- type: object
- nullable: true
+ $ref: "#/components/schemas/Changeset"
action:
description: >
A custom action value that will be accessible from user task events resulting
from this endpoint invocation. If not provided, it will default to "update".
type: string
nullable: true
- Variables:
- description: A map of variables.
- type: object
- additionalProperties: true
Changeset:
description: |
JSON object with changed task attribute values.
@@ -385,6 +944,7 @@ components:
The assignee cannot be adjusted with this endpoint, use the Assign task endpoint.
This ensures correct event emission for assignee changes.
type: object
+ nullable: true
additionalProperties: true
properties:
dueDate:
@@ -420,6 +980,7 @@ components:
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
@@ -435,6 +996,7 @@ components:
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
type: array
+ nullable: true
items:
type: string
requestTimeout:
@@ -445,11 +1007,18 @@ components:
immediately, even when no job is activated.
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
JobActivationResponse:
description: The list of activated jobs
type: object
@@ -514,6 +1083,63 @@ components:
tenantId:
description: the id of the tenant that owns the job
type: string
+ JobFailRequest:
+ type: object
+ properties:
+ retries:
+ description: >
+ The amount of retries the job should have left
+ type: integer
+ format: int32
+ default: 0
+ errorMessage:
+ description: >
+ An optional message describing why the job failed. This is particularly useful if a job
+ runs out of retries and an incident is raised, as this message can help explain why an
+ incident was raised.
+ type: string
+ nullable: true
+ retryBackOff:
+ description: >
+ The backoff timeout (in ms) for the next retry.
+ type: integer
+ format: int64
+ default: 0
+ variables:
+ additionalProperties: true
+ description: >
+ JSON object that will instantiate the variables at the local scope of the job's
+ associated task.
+ type: object
+ nullable: true
+ JobErrorRequest:
+ type: object
+ properties:
+ errorCode:
+ description: >
+ The error code that will be matched with an error catch event.
+ type: string
+ errorMessage:
+ description: >
+ An error message that provides additional context.
+ type: string
+ nullable: true
+ variables:
+ additionalProperties: true
+ description: >
+ JSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error.
+ type: object
+ nullable: true
+ required:
+ - errorCode
+ JobCompletionRequest:
+ type: object
+ properties:
+ variables:
+ additionalProperties: true
+ description: The variables to complete the job with.
+ type: object
+ nullable: true
ProblemDetail:
description: >
A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457).
@@ -541,6 +1167,81 @@ components:
type: string
format: uri
description: A URI identifying the origin of the problem.
+ SearchQueryRequest:
+ type: object
+ properties:
+ sort:
+ type: array
+ items:
+ allOf:
+ - $ref: "#/components/schemas/SearchQuerySortRequest"
+ page:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryPageRequest"
+ type: object
+ SearchQueryPageRequest:
+ type: object
+ properties:
+ from:
+ type: integer
+ format: int32
+ limit:
+ type: integer
+ format: int32
+ searchAfter:
+ type: array
+ items:
+ type: object
+ searchBefore:
+ type: array
+ items:
+ type: object
+ SearchQuerySortRequest:
+ type: object
+ properties:
+ field:
+ type: string
+ order:
+ type: string
+ default: asc
+ required:
+ - field
+ SearchQueryResponse:
+ type: object
+ properties:
+ page:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryPageResponse"
+ type: object
+ SearchQueryPageResponse:
+ type: object
+ properties:
+ totalItems:
+ type: integer
+ format: int64
+ firstSortValues:
+ type: array
+ items:
+ type: object
+ lastSortValues:
+ type: array
+ items:
+ type: object
+ VariableValueFilterRequest:
+ type: object
+ properties:
+ name:
+ type: string
+ eq:
+ type: object
+ gt:
+ type: object
+ gte:
+ type: object
+ lt:
+ type: object
+ lte:
+ type: object
securitySchemes:
bearerAuth:
type: http
diff --git a/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx
index 6ff2ca29f7..cd8525d74c 100644
--- a/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx
+++ b/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx
@@ -5,7 +5,7 @@ description: "Iterate through all known partitions and activate jobs up to the r
sidebar_label: "Activate jobs"
hide_title: true
hide_table_of_contents: true
-api: eJzNWG1v20YS/iuL/XIJwEhK7nAI2BdAtdM7pa1rxE57gO0PQ3Ikrr3cZXaHlllB/72Y5astynVwX+ovFrWz8/rMzEPtJMHGy/hKfrSJvIlkhj51qiRljYzlitABoaDc2WqTC9Ba3Bm7NaIER4qlvACTCUhJ3bNkVQqygnIUDr9U6AkzUcCDKqqCBa+NJ4dQsEQhEkjvOvFUKzQkwPNTLcBhrzSbXRsZyVbhDzarZbwLj8phJmNyFUYytYbQEB9BWWqVArs3v/UcyU76NMcC+BPVJcpY2uQWU5KRLJ0t0ZFCP5zuniSCPby1ieDTiJ3McK0MZkKZ4P0P57+cidLZFL0Xr3C2mYlv/0BMMCbwd6csHLIVFHx3LUuoCzT0xqO7VyleSzH//nWIsvXOk1NmI/eR3Fp3h27aJQMFCrsOLjRyXdKU2YjWaR+JwnrStag8ZmJtndB2s2GJsnKl9ein7JIq0FZ0aBhCJhxS5TgDsCZ0gnLlRcr42CqthbEkklEFRVILMJZydI1UZUjp4GFrR7xSRhT+tcjBiwTRCIeQ5piNs6IM4QadjOTaugKo+erf/2J/C3j4aBN/aZet0emUdWDkxDD2euQmdRNEC7O/MvrPd2x0jZTmv4FTkOgJgyC08sQVum9lgs1wq4V6SGZ/+o1Qa4FFSXUUmu1eeZVoHF0H6rPGertyWxMKy0c+tWWPCtYeKpJgX7JxRsE5qGUkFWExwn+Pg33fd5fH8HA5NHtvKrVFqZELv83RsNMagTNhGpeUH2HDuh5EvabLx6iYidV66vg7sYgEcDdCpanHkvIB68dufcu3tOUGsFpzIygvMuU5w1mYZ6NLfDaEo4oCMwWEuo4E3qNpAjT2IKzZS4FLaMDQKvPP4Wd16kNJg6wPtd7mKs0fQZgx/RWlDU1OjFue/sseSZ/aDtjvm/L70hrfTMd3i8U0ADo/h6qyMzP5FXP5pUqHCI+M8CA0xHssD0du32E9PTnukJtSVEZ9qVCoDA2ptULXN96tTV5Y8aM7hk/GrfvK57bSvEJ5YmxzILEFP+zW11OTu91DK+MJTIo/HQvo1ib/8P3WUq04x/myMJKyMOetrWzaBIv0Flano9BGlrN+PT4TzbBDf0PnVQOeQ4P3zeHLDT033Q9MH03lHdb/r8kmp6iRicGxfIL3NlWhFZhYiFZcrE6nUtcp+ysgtJDmIFpY1x1/eGIw6mS3ivKW+zzaN0/R9NIhmFaebPFfhAzd5CD0GEZBIyfyRrCnYVnFMYvCZhgG+jcjfuIF33YKtPoDM/Hx4tczkdm04tRMzBLIslAv0OejucAc8+vJWDOih/EVCMajMTEUyyG5dgRN1L2wlQkJaMWExjU13LlR2Y8K0FuomUKJ0npF6h5fvwztGUKmlZmYTGHFdSMpBfOY2sEGlImEb+k7iM9nq/8JLC1vJ1WgJyjKl6GgpzmHPiyZDfUsqONF7ctD6IWAwyjs6ir4RWN2xJ58bbW7zTxdE5V11W7kBPF4tlvjD7fBiE51K7ejqRm/eT23jJv1G7Yx01yk3GYylqUNJLUEymUs57z05kO8MpL8bhGa6WonK6dlLHfNst3H8/kut5728a60jvbz+3fySfL5uAk7MCsZS21T0Hlj9HBV88G4AU7ei08fLi7Ff4BwC/UsjFPrnuh8v3i/mFTHok9VLc9XookpaBsTh05fTlRO6muEn9W4399wztLKKaovWL7JRILg0C0rTnPPHVpDQS0/N0Iyaj/82CH74++XoejMdj4N768fHoAJ5SEpGybM8E3/IraYfMlZHLyFXHV3bw7J++IR3xwk95FUZm2DRy0MT6CoTAZiSBaDpFu+cjF7e5BqTiizodQWRWUC1TObsCuavPcaU1154rRHUqsUGd/xTjKARoZ/bk5Eu/DF2xmDpYEyF8DH8/lGUV4ls9QW87S51v9PtE3mBSgzb034+cnyl89np8s3P69OPpxdfHjzdraY0QOFEnE/FWBGfiyf8OpHse4GYvv3+pmkBRThA81LDcpws4Sk7dphcSXbgEbj4iZqW/5K7nYJePzs9H7PX3+p0NUyvroZJgQ/7SPZLOEwXwJplidNRt5csgssrqtAwJ/S/n3U3VimKZb0rOzNaOad/3pxyU3W/gTE617G0sGWfx6CrYzltbyWMpI2VCn0b/h+JzWYTQUblm/08t+fCielIg==
+api: eJztWVtvGzcW/isHfNkYO5aUbtqmaruAaqdbZVvXsJW2gO0HzsyRhjaHnJAcyaqg/14ccm6SRomC7r7FgGDN8PBcv3MhtWGOLywb37G3OmYPEUvRJkYUTmjFxmzq0HCH4DKjy0UGXEp4UnqloODGCaKywFUKPHFiSZSPOrZQFuA0uAzB4PsSrcMUcv4s8jIf3CsWser1Dzpds/HGPwqDKRs7U2LEEq0cKkdLvCikSDhJGj5aUmrDbJJhzumbWxfIxkzHj5g4FrHC6AKNE2jb1c2eTaTWo46BViPgFlKcC4UpCOVV/uH6lysojE7QWniBg8UAvvsTMcax4/bpkoi94Z7B9/es4OsclTu3aJYiwXsGw3+feSsr7awzQi3YNmIrbZ7Q9KukeI6g516FQFc7VagFVErbCHJtnVxDaTGFuTYg9WJBFEVpCm3RHsiNmCql5LHE4N5txJzIUZfuUBHuPWPQlYY8wucODbhMWEgo9CshJSjtIMYm4inEa+BKuwxNoCqVE9JrXMmBF0JBbs8g4xZiRAUGeZJh2vWSUA4XaFjE5trk3IVXX70iv+X8+a2O7UxPKqH9LqwgFjDodAvKeB2MqGD3MaH/+oKEztEl2W/ciOC6Q1dJYR1FbFnReJl+F6Gqhlmz+i2IOWBeuHXk82gprIgldrZz13iN+Nbh18oHmpZsoosGJcTdRyTGJmRdj3Jj+Pog/BETDvNOfjT43DZ5OTuGj1mb0o3oROeFRALCKkNFRkjk5BkVVBS2gxVtGlA1nGa7KBnAdN63/D2MIuCUrbyUrsGWsD4Xju36jnZJTQmipaREERZSYckhqS9dnU201poj8hxTwR3KdQS4RBUMVPrArMFJQKbi6nVn41FfUqLiyk1T+yGsTS+tD7+ntR4Xq0wk2Q7cCf+HMDgW9gNVKhyEgnwXyNua0ZeND7TsiAG1kUmD25sq37bbwNQWWtlQm78YjfrhVVvaYobMGbBP6AqnMm19dKSBeKLWY8c8eWT3E67769QTUgmAUon3JYJIUTkxF2iaNH/U8WmF8XiHo5VuoXhhM11KasNUn1YZd7Ditu3PZ339quqCU2UdVwn+95hBjzr+h216pqjIyc7TzIiLXF1XstJ+EUTSSJhedkzrSE6b5vwBa9oO/hsaKwJ4DgUuw+Lpgj7USw5EH3XlE67/rsjgU5RIY8kxf3JrdSJ8KtBYAxU5TC/7XFcz+xgQKkiTERWs1/X0sicwqmlXwmXV5LXT3fbRdOqskJTW6fwn5Cma3lJq0ZeCQAdZIGyGwLQkmyHXKfp28W1nGrJAu43gUvyJKby9/fUKUp2U5JqeWsLT1MeLy+tOXaiq/SeOgqHIt+XLjzM7ZaINlkFnqhLUE/dcl8o7oCIDiXMXxvXAsikVXK74mgY2KLQVTizx7DS0p8hTKVRPZfINtC5JCVe7gyRfcKEisIRD7+x3V9M/AAtN/U3kaB3Pi9NQ0AxVhzpMaPZqZq56CqvOKz4XPA4jPwmUXi/XncVIk0+Ndt3b+2Mi0jragQ4clWe9UvawG3SGtbrl1m04pSPctruy14xD+6268atjDbgweilSSgXuOI05NPAvuRTVmHOkDRdGxxLzf36sHU/gOlBCio4LCcGD4SBGhHE4it3d/HgB37z68uuHF5lzhR0Ph6vVamDmyTmmwmkz0GYxNPOEPkR3NoBZhoaOAWuPqyYg0PZlsAUmYi6SOuCV2r5f7oxxHzlT7p+xGgiWRrD9Y/QE3t1MDyrijujudMh4rEs3jiVXT6wN56HQfSm2zHNu1p0S2hGwjZh13JXdyeVoFu/zJmD8NJtdQ2ABiU6xGleErQWREblQdAZj41ejkR8Vw9NXo5EvDBTxEyxRgM+F5Cpk3J45dEzQBiv8eMPqJvE/iow2YiH25Q52kq4C8WWwKKTUl30pNVFAXjaEQzRGG9BJUhrjz0tCNo2ull1NZJ9z7XOufc61Y7lGd0LoMp2yMSu0v9EpuMvYmA3pzDZs2zWLGF3M+VnwbsNKI9mYbULCbMfD4SbT1m3Hm0Ibtx0uKRo7swMth8SqASN1wmUWhB4Gjha689sFz0uVcngNN29uZ/Af7nDF196RJHKX9evR61EvVyI9wnFyPYVgYYBdpxTUbCmne9kG4lMYb7cP5MikNMKtb2lbcE+M3KCZlOT7Bg6VPM+dngMRi6ovP9Ygefv7zMeZythNeyP85pnTFUwfvuqpuX3TXGWOeq8JRwf3eHf13ofD667Rzi1MS+lRP9deowqTh84i5NQHSjYavDzE//XUp3Gi87xUvparhT//AO84P5GldeT0iEmRIE1s4w0jTHXE/hxWoDrCwssBASeguy7hC+GyMh4kOh8mYVvzP5Y6HuZcqGElwg4vJr+8u7qcnP88vXhzdfvm/OVgNHDPzgeIUiznqqPHZO+uacfSTdu3/m+/IFTIcPjshoXkQhH4vf2bqhTcsUq3TjF4iKqEvmObTcwtvjNyu6XX70s0aza+e2jzn562EQsnRF89/I0OuwjGnc/CxdiSy9LfDu3fSW2jesckSbBwH6R96FS0619vZ5Qt1a8jdBZlY2b4in454Ss2ZvfsnrGIae9wn4j+/YZJrhYlXxB94Et/fwFmcgbf
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
@@ -33,7 +33,7 @@ Iterate through all known partitions and activate jobs up to the requested maxim
## Request
-Body
required