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
    )\n","type":"string"}}>
+

Body

required
    )\n","type":"string"}}>
The list of activated jobs. @@ -45,4 +45,12 @@ a set of custom headers defined during modelling; returned as a serialized JSON All variables visible to the task scope, computed at activation time -
  • ]
  • +
  • ]
  • + +The provided data is not valid. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/assign-a-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx similarity index 54% rename from docs/apis-tools/camunda-api-rest/specifications/assign-a-user-task.api.mdx rename to docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx index 834691c2de..a5aa2c555c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/assign-a-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx @@ -1,11 +1,11 @@ --- -id: assign-a-user-task -title: "Assign a user task" +id: assign-user-task +title: "Assign user task" description: "Assigns a user task with the given key to the given assignee." -sidebar_label: "Assign a user task" +sidebar_label: "Assign user task" hide_title: true hide_table_of_contents: true -api: eJztWFlz2zYQ/is7eGkypSUlddOEb47jtG5zeGy5fbA9YwhcSYhBgMYhmaPhf+8sQIrWkWPaPMYzGpPEYs/vW2K5Yp7PHMuv2KVDC567O3aTsQKdsLLy0miWsyPn5Ew74BA6IVhKPwc/R5jJBWq4wxq8efSAxz2IA5axilteokdLhlZM8xJZzkjXmLu7v7BmGZNkqOJ+zjJm8T5IiwXLvQ247c14jtGcmUZzvUvetFbJphNzLDnLV8zXFZmT2uMMLcvY1NiS+/ToxSFrmptkEp1/bYqa9mx7IIz2qD0t8apSUnByZvjJkUerXWNm8gmFp9CtqdB6iS7ubZNC17tBdaswNXYztAFsrJfBedDGwwQBy8rXYCzc6qDULYXe+uC8lXrGMkYLfKKQ5VOuHDYZ40qZ5ccFWiuLPc68rqHAKQ/KZ9GPmF3pwGLrQgFyCtLDkjvgyiIv6s67YgAX6MHPpaOC3EaTt3Rp0QergWtAa40FqcEFMQfBHboUYTQUo/Nz1DCV1sUgg14b9oYerG/5jEs9gEuHyeSS9tUmwJwvUgIdVFLcST2DqTUlzKwJVTJ0HzBg9LKyuEDtwXKBIIwuJGXCDa51n86JMQq53sgngYPSKVLitvN4BCI4b0pIArDgKpCf3MNSKhUDEQKdkxOFyb0ezdEjyrkLyq/dj0GiLiojtQepFyZBcQCn0wiJypqFLLDIYn3ISltKivO6ReA12whtD1JiZE3GvPR0G7sDkTW1ghK1P0+MYU1DchZdZbRLMH8+OtyP8HV0P7m2hKQpwaj4FJzHYsCajB2ORl+iSNy0Q/89HUlw3dJEmLJSSPrhvbEIBXoulQNucZ0yQiTt72KBiSnqlKjP8L+yZqKw/Hm3D2wD4SxJtnYh9QfgDpLgJFm/On97DK8Of/3t5snc+8rlw+FyuRzYqTjAQnpjB8bOhnYq6EdyTyNvLELJ6winIkGXK+g7D7gKhZxK0XXo1m2g8m8A4TNtK62uduCybqTBSrbz0oDL81OQBWovpzUBeMd03BPByXLGJyb4fKK4vmM98HaNbltxoSy5Xb8ONg00GXOe++C++iL45fmObgLcH+PxGSQVIEzR9WbpOkMURCm1LEPJ8sPRKGMlf0h3L0ajhnRSxb8hEg34UCmuI7S2w5Eayh63MTCpnedafK/KGCtnctvugD1uAi2I36SIEvEPv8r1fcQkxhMzpybojvKv/oMe6TrSLq3Rs1gpBBGsRe1V/YPsP8j+g+zfi+xNxkr0c1PQSd24CB06sOdsSCQ9IJK64erRub4Z9i9sOpOjXXRDQLCK5WyVSNTkw+Fqbpxv8lVlrG+GC6rQgltJx5FYUFpOZOtApIzgap4c2S0mLdCk0QV5/BLOTy7G8Dv3uOR1zCrZ2tT5cvRytFcdiW6rOjo7hRRTAt+jhtDpI2bv1ZeEv6gxDiYORbDS1xcknzIxQW7RHgVK/RoNraGoNh5XoxDL2ou3HUb+/Gccy0xd7Lwfek4eOB2QNoeUHmJbA0MairpjbycWYTo10akWRMe8DLrg0IdHZUXr0sbR4NkuYM9OI++EKcugY/PVs7739xqFogOjJU4qKVC76H07XHZi79IK/J1swrMBlTeBr+u6M+nnYTIQphyKtG39f6LMZFhyqYetCTc8Pnp/+eHN0cG70+OTDxcnB88Go4F/8DGpxIqS60d+pPPy48l5O+BV/77534N2iwWPD35YKS411SQGu2qpesV6qrKM5ZtD+CO23mQt467YajXhDi+tahp6fB/Q1iy/uukJGhldSEfXRTtmfiHMJ+fteP0Uvm2Y3xtX+5DrOrYKFeiOZewO662vC81Nk7E58gJt9DRJHCd/Dsakp9ewM983WbfjSAis/GdkN44HxNx1rzz7eDEmIrbfFkpDFGKWL+lTB1+ynF2za/LcxFxFjsfnK6a4ngU+I/mkl/7+BSY7JFE= +api: eJztWFtv2zYU/isHfFmLKba7pV2rNzdtt2y9BImzPSQBQlPHNhuKVHmxIxj678MhJTu+pC22PjqAEUk8PNfvO5TOknk+dSy/YpcOLXju7thNxgp0wsrKS6NZzobOyal2wCF0QrCQfgZ+hjCVc9RwhzV48+ABj3sQeyxjFbe8RI+WDC2Z5iWynJGuEXd3f2HNMibJUMX9jGXM4pcgLRYs9zbgtjejGUZzZhLNrV3yprVKNp2YYclZvmS+rsic1B6naFnGJsaW3KdHL45Z09wkk+j8a1PUtGfbA2G0R+1piVeVkoKTM/3Pjjxa7hoz488oPIVuTYXWS3Rxb5sUut4NqluFibGbofVgY70MzoM2HsYIWFa+BmPhVgelbin01gfnrdRTljFa4GOFLJ9w5bDJGFfKLD7N0VpZ7HHmdQ0FTnhQPot+xOxKBxZbFwqQE5AeFtwBVxZ5UXfeFT24QA9+Jh0V5DaavKVLiz5YDVwDWmssSA0uiBkI7tClCKOhGJ2foYaJtC4GGfTKsDf0YHXLp1zqHlw6TCYXtK82AWZ8nhLooJLiTuopTKwpYWpNqJKhLwEDRi8ri3PUHiwXCMLoQlImXO9ar9M5NkYh1xv5JHBQOkVK3HYehyCC86aEJABzrgL5yT0spFIxECHQOTlWmNxbozl6RDl3QfmV+zFI1EVlpPYg9dwkKPbgdBIhUVkzlwUWWawPWWlLSXFetwi8Zhuh7UFKjKzJmJeebmN3ILKmVlCi9ueJMaxpSM6iq4x2Cea/DI73I3wV3U+uLSFpSjAqPgfnseixJmPHg8HXKBI37dB/T0cSXLc0EaasFJJ++GAsQoGeS+WAW1yljBBJ+7tYYGyKOiXqEf5X1owVlj/v9oFtIJwlydYupP4A3EESHCfrV+fvTuDV8fPfbp7MvK9c3u8vFouenYgjLKQ3tmfstG8ngn4k9zTyxiKUvI5wKhJ0uYJ15wFXoZATKboO3boNVP4NIDzSttLqcgcuq0YarGQ7hwZcnp+CLFB7OakJwDum454ITpYzPjbB52PF9R1bA2/X6LYVF8qS29VxsGmgyZjz3Af3zYPg1192dBPg/hiNziCpAGGKrjdL1xmiIEqpZRlKlh8PBhkr+X26ezEYNKSTKv4dkWjA+0pxHaG1HY7UUK5xGwOT2nmuxY+qjLFyKrft9tjDJtCC+E2KKBH/+Jtc30dMYjwxc2KCLnoHgh0IdiDYowR79R8IJl13mi2s0dOYYQQRrEXtVX04BQ8kPZD0x5H0+b4X1qEGyrIlHKZPHiMiAwtYzKSK6uPbf2u7/QY9cO3AtQPXHuNak7ES/cwUNC4yLkKHpkY569OBeEQHousvHwyXmv76q5EGQ2jn3SQqWMVytkwkavJ+fzkzzjf5sjLWN/05VWjOraRv4lhQWk5k60CkjOBqlhzZLSYt0LirC/KEl0EXHF7C+duLEfzOPS54HZNLJjdVvxy8HOzVSqKPaByenUKKMEHxQXvo1BLP96pNwt+jOI7MHIpgpa8vaFtKzxi5RTsMVI8VRFp7UXscpEQhlrUX7zrg/PnPKNaeWtv5ehz39p7Tp/vm+GyNu61RVhrXdQOZTixid2KiUy2ydsOjWqN1aeOg92wXxWenkYzClGXQsSPraXr54g/SJRQNMizRVEmB2kXf26FnJ/Y+rcDfySI861GpEx67RjyVfhbGPWHKvkjbVv/Hyoz7JZe635pw/ZPhh8uPb4ZH709P3n68eHv0rDfo+XsfU0pEKbl+4Eea46zfIbeDXa4PoP89/m1x4PHe9yvFpaZ6xFCXLXev2Jq7LGP55mj4AX1vspaCV2y5HHOHl1Y1DT3+EtDWLL+6WTM2UryQjq6Ldvj5lTCfnLdD36fwfSPmvXG1D7muY+9Qge5Yxu6w3pp5NzdNxmbIC7TR0yRxkvw5GpGetYadqXOTdTuGQmDlH5HdeF8g1q6a59mnixGRsJ14l4bowyxf0ACeL1jOrtk1eW5iriK/4/MlU1xPA5+SfNJLf/8COgNsig== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -25,7 +25,7 @@ import Markdown from "@theme/Markdown"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; -

    Assign a user task

    +

    Assign user task

    +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    The user task with the given key is in the wrong state currently. More details are provided in the response body. +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx b/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx index f140504e0c..c8c484fd2a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx @@ -1,7 +1,7 @@ --- id: camunda-8-rest-api title: "Camunda 8 REST API" -description: "API for communicating with the Camunda 8 cluster." +description: "API for communicating with a Camunda 8 cluster." sidebar_label: Introduction sidebar_position: 0 hide_title: true @@ -15,7 +15,7 @@ import Export from "@theme/ApiExplorer/Export";

    Camunda 8 REST API

    -API for communicating with the Camunda 8 cluster. +API for communicating with a Camunda 8 cluster.

    diff --git a/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx new file mode 100644 index 0000000000..a38ab297b4 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx @@ -0,0 +1,63 @@ +--- +id: complete-job +title: "Complete job" +description: "Complete a job with the given payload, which allows completing the associated service task." +sidebar_label: "Complete job" +hide_title: true +hide_table_of_contents: true +api: eJztWE1z2zYQ/SsYnJIpTSqpkya8qY7TOs2Hx1bag+PDElyJsEGAAUDLGg3/e2cBUp92ks6kN2lGI5HA7tvFvgcSu+QeZo7nV/ydKfh1wkt0wsrGS6N5zk9M3Sj0yIDdmILNpa+Yr5DN5B1q1sBCGSgTNq+kqBgoZeaOiWgj9SxMBeeMkOCxZA7tnRTIPLjb9IvmCW/AQo0eLYWw5Bpq5Dm/McVfuOAJlxRDA77iCbf4tZUWS5572+JuoJMK2S0umJkGUArWmyEUTHnCnaiwBp4vuV80hCK1xxlanvCpsTX4eOvlMe+66wiHzv9uygXZrNGnoBwmXBjtUXsag6ZRUgBFkt04Cme5j2aKGxSeUramQeslOhq9AyuhUPECylKSF1DnG5MeS3dlupnpKnsqFaW9C69bpcgq+u26hHvp6ZII0JdbGn0R0+ddR1MsusZoF6N8Pjqmn/2AAiysCEAFb4VA56atUouUdwk/Ho2+YbvNLiqnAK2NZwWunabsg7HISvQglWNgkTXW3MkSSyZ1sB/CZYUpF5Foj5SrsaZQWP+yX7btEMfsPM7scVlcTwaOxYlFRL+6eHvCXh+/+O36SeV94/Ism8/nqZ2KIyylNzY1dpbZqaAvzXuaskmFFlkNC0pzTQG2JgpzDQo5lYIqTQn2YTMqbszv2yyLoysuOm+lnm0Sv7WS73JszD5fnDFZovZyuhjkvAUdbKbQKvIBhWl9XijQt3xNq33QXRTX1jXYlXS3AbqEOw++dd8V7q/P93wTsf6cTM5ZdMGEKZFNjWW+km4AoiRqqWXd1jw/Ho0SXsN9vHo5GnXkkyr+A5lohveNAh2otZuO1Kxe8zYkJrXzoMXPqoyxciZ3cVO+KfGexG9iRlHbx9+U874kSeGkyalpdZkepHWQ1kFaj0rr9X+SlnTDE2xujZ6FtUUmWmtRe7U4PPkO8jzI8+fJ88VDL6NjzWiVLfEQrTWWGREUWNIpRwX39E47YPfnhIPWDlo7aO0xrXUJr9FXpqTjvHGBOnSqz3l2YwqXLeOJv8vE6gBKJ3a0d0NnoLWK53wZldPlWbasjPNdvmyM9V12R2XZOkvTcFTYwBxlBKgqou9XkAao/TBkdgJ1q0tgr9jF6eWE/QEe5xAPsQS57frV6NXoQa809RGP4/MzFjOM/NvYEwa3JO4H3cbJP+I49DIcitZKv7gks7g8BYJFO26pCCte9HjBO13HSTzp/7wd2PLun0koOO1nF+s+yek9UPV22xpdIOHUBKCeIvshU/3QupjjKH22T8fzs6AqYeq61WFr1bP4FgUbSyBU6zylnnAlBWoX4ukbS8O093GE/R0R2bOUyhc5NuyoM+mrtkiFqTMRzVa/hTJFVoPUWQ/hspPxh88f34yP3p+dnH68PD16lo5Sf+/DMhHja9CbcQzdmhtT7Ca6XD9F/vf2W193j/c+axRITUwMy7DsBXpFzTjHE56vmnIbGr1Oep1d8eWyAIefreo6uv21Rbvg+dX1WpZBx6V09H/dR3s09ycXfcvtKft+c+/BRPqboBdhc1AtXfGE3+Ji3WTsrruEVwgl2hBgHDyJYRxNyMXaeK/T1yWDxVgIbPwjc7deAEiRq93w/NPlhATWtxlrU5KthTl1PGHOc/6Ff6GgTViioN1wf8kV6FkLs9AwDX7p8y98k4hh +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Complete job

    + + + +Complete a job with the given payload, which allows completing the associated service task. + +## Request + +

    Path Parameters

    Body

      variables objectnullable
      + +The variables to complete the job with. + +
    + +The job was completed successfully. + +
    + +The job with the given key cannot be completed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The job with the given key was not found. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The job with the given key is in the wrong state currently. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/complete-a-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx similarity index 55% rename from docs/apis-tools/camunda-api-rest/specifications/complete-a-user-task.api.mdx rename to docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx index 5044920a20..e8d4ac40c2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/complete-a-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx @@ -1,11 +1,11 @@ --- -id: complete-a-user-task -title: "Complete a user task" +id: complete-user-task +title: "Complete user task" description: "Completes a user task with the given key." -sidebar_label: "Complete a user task" +sidebar_label: "Complete user task" hide_title: true hide_table_of_contents: true -api: eJztV01z2zYQ/SuYPSVTmlRSN3V4UxWndZukHltuD7YPILiUEIMAA4CSNRz+984SpKiPuEk7OcYzGovEYt9+vActGvB84SC9hRuHlnnuHuA+ghydsLLy0mhIYWbKSqFHxzirBzO2ln7J/BLZQq5QswfcxBBBxS0v0aMlpw1oXiKkQLvm3D38gRuIQJLTivslRGDxUy0t5pB6W+Mh8nyJ5JiZokMawb1hoo+KUJ1YYskhbcBvKgKU2uMCLURQGFtyH169OoW2vQ+g6PwvJt/QnjGGgiuHEQijPWpPa7yqlBSc4kk+OgqqOUYz2UcUnrK3pkLrJTpaXXEreabCA89zSV64utwxeirp7dbdTA9qQA2g5A+D0LVStDd4byPgInhuDoCmTNTOm5IFA7biqiYQ7tlaKsUyZFwIdE5mCllhTbmDjivU3jGLrlZe6kVY90vpGOq8MlJ7JvXKhNrF7KJg2nhWWbOSOeYRkz1KjgWvladE72BI9Q7iOz3m5ryVenGcWxuBl54eO/4SxXqySqOvQpehbcnOoquMdqEZLyenx+WY71eXu23hc+bqrhBFrdQmhjaC08nkix6OBMIE11SEDEfXMXtvLLIcPZfKMW5xWyMmdbd/CJ1lJt+EujzB0MqaTGH5wzFTDzt/GSx7XBbIw7hjwTAL6LdXb2fs9elPP98/W3pfuTRJ1ut1bAtxgrn0xsbGLhJbCPqQ3fOYzZdokZV80/Fny3o2aoO5CoUspKCeU4J92Iy6vdf3J4QVVpsjdmy1XlsJh7KaspurCyZz1F4WG2LsEXS3p2MjpMAzU/s0U1w/wMizY9BDFFeXJbfbM2sfoI3Aee5r98Wz6seXR76JXr/N55csuGDC5MgKY4PqeiBKopRalnUJ6elkEkHJH8PTq8mkJZ/U8a/IRDN8rBTXHbUO05GalSNvu8Skdp5r8a06Y6xcyEPcGHY135P4Tcgo6Pz0K6R9LExSOymzMLXOe4G//h9+pBtEu7ZGL7pOIRO1tai92nwX+3exfxf7txJ7G0GJfmlyGieN66hDU2UKCYn0hETqkmZn+GwTsR0PaGxEuxom1doqSKEJImrTJGmWxvk2bSpjfZusqEN7Ax0tB7ENJFJGcLUMgRw3kxZoHB6SnJ2xq/PrOfuVe1zzMFUQ1r7Ps8nZ5LPuyPTQ1fTygoWcAvl2DoTBHyn7s/6C8b967GZnh6K20m+uyT5UIkNu0U5rKv2WDT1Q55aegxFE/Ze3A0d+/3vetZlOsatxLj9/5NSowzF6Z5od+NaRsTAddE+VGS9rnXM2JkHNQ+vCxkn84piWlxeduoQpy1p3R6xejCf86FGo2nkqRwRKCtSui7G/5wxm78IK+ytgshcxNTFQbDhbF9Iv6ywWpkxE2Lb9nymTJSWXOukhXDKbvr/58GZ68u5idv7h+vzkRTyJ/aPvSkfcL7nejWO4Mexc2A5Tbsbflf90w+v76/HRJ5XiUlMHutSaXn63MMoPIkj3b387CryPehXdQtNk3OGNVW1Lrz/VaDeQ3t6PoutUmktH38er2pMpPbvqb3XP2dfeIj+bWf+S6013AKianiCCB9wcXGzb+zaCJfIcbRdrsJiFiE7m5Gf0cHSvbKNhx1QIrPwTtns/+qTH7Ql4+ef1nOTVX2pLk9Ney9d0y+ZrSOEO7ihy01WrU273vgHF9aLmC7IPfunvH1x7kp4= +api: eJztWE1z2zYQ/Ss7OCVTmlRSJ014Ux2ndZukHltuD7YPILiSEIMAA4CSNRz+984C1Lc1cTs5yjMai8Ri3368B1LbMs8njuW37MahBc/dA7tPWIlOWFl7aTTL2ZmpaoUeHXBolmYwl34KfoowkTPU8ICLlCWs5pZX6NGS05ZpXiHLGe0acffwJy5YwiQ5rbmfsoRZ/NZIiyXLvW1wF3k0RXIMZhyQ1uDegOijIlQnplhxlrfML2oClNrjBC1L2NjYivt46+0p67r7CIrO/2rKBe1ZxzDmymHChNEetac1XtdKCk7xZF8dBdXuo5niKwpP2VtTo/USHa3OuJW8UPGCl6UkL1xdbhgdSnq1dTPTnRpQAyj53SB0oxTtjd67hHERPbc7QEMQjfOmgmgAM64aAuEe5lIpKBC4EOicLBTC2JpqAx1nqL0Di65RXupJXPdT6QB1WRupPUg9M7F2KVyMQRsPtTUzWWKZgOxRShzzRnlK9I4tU71j6Z1e5+a8lXqyn1uXMC89XQb+EsV6skqjr2KXWdeRnUVXG+1iM14PTvfLMdquLnerwpfgmlCIcaPUImVdwk4Hg+962BMICK6pCAWuXafw2ViEEj2XygG3uKoRSB32L0OHwpSLWJcDDK2tKRRWP+0zdbfzl9Gyx4VIHuAOomER0W+vPp7B+9M3v9y/mHpfuzzL5vN5asfiBEvpjU2NnWR2LOhDdi9TGE3RIlR8EfizYj2stQGuRiHHUlDPKcE+bKBub/X9gLDiarvHjpXWGyvZrqyGcHN1AbJE7eV4QYzdgw57AhtZznhhGp8XiusHtubZPuguimuqitvVmbUN0CXMee4b992z6ufXe76JXr+PRpcQXYAwJcLY2Ki6HoiSqKSWVVOx/HQwSFjFH+PV28GgI5/U8WdkogEfa8V1oNZuOlJDteZtSExq57kWP6ozxsqJ3MVN2abmexJ/iBlFnZ8+Q9r7wiS1kzLHptFlehTYUWBHgR0U2Pv/ITDplk+zuTV6EiqMIBprUXu1OD4FjyI9ivTHifTNU6+nQw1UZUs8RGuNBSOCAkuYT6UK7sPrfo/d/0w6au2otaPWDmmtS1iFfmpKmmkYF6hDo42cZfRAPKEHosvajQlIl4nVb1SaXaCdLccljVUsZ20UUZdnWTs1znd5Wxvru2xGHdqaKtByFNuSRMoIrqYxkP1m0gLNZJZJnvGq0SWHd3B1fj2C37jHOY+/cAly2/W7wbvBk17J9IDH4eUFxAwjFTeOh6Vb0vmTbqPxcxyHqY5D0VjpF9e0LZanQG7RDhvqx4oiPV7wTtfRiCX9l49L4vzxzyj0no62q/XE6PyRU/d2Bzwbc5YlCQNDxyZA9/zZT4I6itbFjYP01T5XLy+C5ISpqkaHc1dP4isW3yiKUI3zVIyEKSlQuxBhP39bmn2KK/B3RIRXKTU0sm553E6knzZFKkyVibht9b9QpsgqLnXWQ7jsbPj55suH4cmni7PzL9fnJ6/SQeoffSgcyaHiejOO5SRr9a64m267ftD8p7lj31uPjz6rFZeaqh8Sa3s93rK1HlnC8u2Z5IYk75NeVresbQvu8MaqrqPb3xq0C5bf3q9VGGRbSkff1wPEgym9uOpnjS/hubPNJzPrb3K9CCeCauiKJewBFzvj1u6+S9gUeYk2xBotzmJEJyPys/awN+3skuWOoRBY+wO2W28BpMXVkXj51/WIpNWPWitT0l7L5zT75XOWszt2R5GbUK2g2nC/ZYrrScMnZB/90t+/xBTa1w== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -25,7 +25,7 @@ import Markdown from "@theme/Markdown"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; -

    Complete a user task

    +

    Complete user task

    +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    The user task with the given key is in the wrong state currently. More details are provided in the response body. +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx new file mode 100644 index 0000000000..5c05c19cc0 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx @@ -0,0 +1,63 @@ +--- +id: fail-job +title: "Fail job" +description: "Mark the job as failed" +sidebar_label: "Fail job" +hide_title: true +hide_table_of_contents: true +api: eJztWEtz2zYQ/is7uDSZ0pKSOmmim+MkbdI8PLbTHhwfluRShA0CLABa5mj43zsLkHrbyaFHeUZjEsS+v29J7EJ4nDkxvRIfTSquE5GTy6ysvTRaTMVntLfgS4IbkwI6KFAqyr9rkYgaLVbkybL0QmisSEzFjUn/olYkQrJ4jb4UibD0byMt5WLqbUPbNi5LgltqwRRLS94ESyORCJeVVKGYLoRva7YgtacZWZGIwtgKfVx6eSy67jqaIuffmLxlmZXlApWjRGRGe9Ken2FdK5khezG+cezKYteaSW8o8xyuNTVZL8lFvd72l7vBYGUa7TmeftsyLleaRuVQ4h2BosKHRD4a12/PBeerwEZ5MZ10iSBrjf1MzuGMdu2faDDhGhVUcRPEHanUM5iX7dKZWMsRXJbSgXRQo/UyaxRa1ULjqGgUyAIwbLaNdmCajahQ54AapM5kTtqzDovSUZ4wVDyrHVzIUENJqga6rxVKHRxZl53jIDxaT4rzVuqZSIRulMJUUYRQl4QKtG8wu/1aFPvLkGJ2a4oCvKyIPX8iNVTuKRTGhhxouvchlnb04zq8PN6uwx1ayR4FEGCey5j1szWc7EP7x4uvXyCiCnyJHuZSKZDaedReoqfg21I5oA8LymSowGWmpjWi/OIAnTMZy+Xg0d1uhLIE71b2ukR46fmWWf8epTqPtBFd14XcutpoF0N7Pjnen1+GhRxawkh0iTieTPZvra25kznlkKNHFtLGwx0q2Vf7AVbW1qSKql932bkFejiLOyEnj1IN+UU3YJ9ykBquzt+fwuvjF79fPym9r910PJ7P5yNbZEeUS2/syNjZ2BYZ/3jfU2YHWYIKW0gJVmWGVT8AV1MmC5lx2/Ix2uAMV2F/PTabSXy62MH8En+NlWIbRyfw7fwDBPLIomVu75heR6zA1DR+mirUt2JV/12j21ZcU1Vol91500CXCOfRN+6H/bnvY9vA+PPy8gyiCshMTj05uRtFQxxEJbWsmkpMjyeTRFR4H+9eTpiGseI/EYmOvUcHaG2Hw63BWOrxEwKLlMz+r8oYK2dy2+5IrHOxB/HbGFGk4vFj7JtLXwZ1M3lHGuK7d6BXYRp9oNeBXgd6PUqv1z9Nr9vILanD2twaPQu5Jcgaa0l71Y7g8ypMB2jXXn293PBuhdTk7YGeB3oe6PkwPV/s+6A84WODJ8s4DIchMFlgYA7zUqqgPiPnBtv9kfDAtQPXDlx7iGtdIirypcl5amNcgA4Pb6ZifGNSN17Ej8tuzMe9xhJPZsjeDdOfxioxFYtIm246Hi9K43w3XdTG+m58xzXZODDz40ivATbhhFtG07vl4wc8YhrCOsWq0TnCKzh/d3EJf6CnObYhnWxyU/WryavJXq289QGNJ2cfIEYYwbfWEAa1zOy9auPmn1EcZlaOssZK316wWExPSmjJnjRcgSUoentBO9/HTSLpL94PUPn4z2WoNjez89U87N09VnWk4nJ8NdmeJ62QtzlgmWzWrwuwLUzwrgfVbpxcdLIuJmYyerYL4LMPgYeZqapGh2bMQyr+7sK1vGWqcZ7zlQglM9IuBNFPHIdtn+IT+DtahGcjrnkE5tCDZ9KXTTrKTDXOotjyf6pMOq5Q6nFvwo1PTz5/+/L25OjTh9N3Xy7eHT0bTUb+3ofcMkcq1Gt+8BiFPxu3g1ys3jmPjVP7Gnu69+MwImPUBe8XPROveLjqRCKmyyHrQMbrpCfUlVgsUnT0zaqu4+V/G7KtmF5dr+oXCJtLx9erweiDPj8572eoT+HxSe3eCPpF1G3oAKrhO5GIW2pX0+LuuktESZiTDc7Fh6fRhaNLVrES3hnbdskgcZJlVPsH9m684pl2y3539vXiklnUz4wrk7OsxTmzAOdiKr6L7+x0nKzGATCvL4RCPWsicaJe/vsPr+YI7Q== +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Fail job

    + + + +Mark the job as failed + +## Request + +

    Path Parameters

    Body

      variables objectnullable
      + +JSON object that will instantiate the variables at the local scope of the job's associated task. + +
    + +The job is failed. + +
    + +The provided data is not valid. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The job with the given jobKey is not found. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The job with the given key is in the wrong state currently. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx index be42854941..600acc0930 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx @@ -5,7 +5,7 @@ description: "Obtains the current topology of the cluster the gateway is part of sidebar_label: "Get cluster topology" hide_title: true hide_table_of_contents: true -api: eJy1Vt9v2zYQ/leIe9oA1XK6l0BvmZMGHrouSNINWOAHSjpLbCVSISmnnqD/vTiSshRHzQ+g84sl6vh9d/zujteB5YWB5A5WVWssathEkKPJtGisUBIS+Cu1XEjDbIksa7VGaZlVjapUsWdq69f9ZvdccIsPfM+EYQ3XlqntAiLQaBolDRpIOni/XNLf/8GTKWlRWoLnTVOJjBN8/MUQRwcmK7HmT8lvS2SDi0TGR2qN9y0aS+B23yAkoNIvmFmIoNGqQW2FjyrV6itq8xT8jFXCkIMsmDBbcsu4xsFzZkthhugmTFxrvocIZFtVPK0QEqtbjEBYrGeIrrTaiRwNE3KrdO1CZ0oyHoiZVDm+HAhZrfP5Q2qluG+R/fIgbCkIOTj9q8Nm63O2VV4fTzlhE9JigRoi8M75pd/eQx9BqYydJ6QvktfocDXyrBSymCcwVgtZEFyj9A/g6MsroJ7zlTQTBPms1KMVq7nkBebMsfqcpDfpVX/CPYj+ZpEPlOygzpt0P+x/Qfz1+SFlD1teeXZaURIfY5+7txR98V/zrWVkOFR9CIJU46wQO5SzvEH+CFC2NbW0Cnke/Kgq9eAeheSZFTuEDWUd8sqWL/kzNCNvPTj1Kg/8FhKzleNzjjyHTd9HYIWl84CrAQxodYfaCN+vnmoQDiPYzGT/BPZ3Z7uWW+WWQ6neiP9mNCBs2dYp6mmjEnLad18j8nGzelQwK9XKHxTmyD2pHGqRptHIc8YzrYz5Cd4MJSiU/MAzq/S8P5mSW1G0GnM22cG2bktocrM9+y2+hDvs7+cED0oPefcvYors0m+cy70jkkk63IYr7TpcdNDTL4IabalySKBA1xQ41QTEww0IERjUO3e13XXQ6goS6PxN2idx3FGL7pOOWmsf7yjQHdeCfHBtZeztW95WdB6Vynjllo+HjUcdP0S8OmXXFze3Y8yPGvyAebo8Xc7CuY5/BHV2tWY+Joc2nQoGvNLaZhbPGz+L2PcbOrOs1cLub8g+TAjINeqz1vecIFwgcrD07o0gCg8fhiT6459bV8XU9t32oOqK163MORsdgUkLgeXi5EkY5CxlcKbqupUutWXhLg0f0wFxkt2VyJByhuYDXk+JP/ovLGQxO1mQED5NKDiTxHEhbNmmi0zVcea3Hf7TSqVxzYWMA4WJV2d/fv50fvbu43p18enm4t3JYrmw36wLv1HG1lxO/LhEOw6GY84+CrkbB8OfNGgG9Sx+s3FTcSEpkVzQXaigOzh4sxkmnDvoupQb/Kyrvqfl+xb1HpK7zVg09OYvJ7q9qOS+4p5UyzJsrKuuqnWDwvGAS2l3KObLC8qX7+HRHvI= +api: eJy1Vt9v2zYQ/leIe9oA1XK6l0BvXpIGHrouSNINWOAHSjpLbCVSISmnnqD/vTiSshVbTRyg84slivd9d/zuBzuwvDCQPMBF1RqLGlYR5GgyLRorlIQE/kotF9IwWyLLWq1RWmZVoypVbJla+3Vv7J4LbvGJb5kwrOHaMrWeQQQaTaOkQQNJB+/nc/r7P3gyJS1KS/C8aSqRcYKPvxji6MBkJdb8mPy+RDa4SGR8T63xsUVjCdxuG4QEVPoFMwsRNFo1qK3wUaVafUVtjsEXrBKGHGRhC7Mlt4xrHDxnthRmiG7ExLXmW4hAtlXF0wohsbrFCITFeoLoRquNyNEwIddK1y50piTjgZhJlePrgdCuZT59SK0Ujy2yX56ELQUhB6d/ddhsecnWyuvjKUdsQlosUEME3jm/9Nt76CMolbHThPRF8hodrkaelUIW0wTGaiELgmuU/gEcfTkB6iVfSTNBkC9Kvd/Fai55gTlzrD4n6U161Y+4B9HfLPKOku3UeZPuO/tXxF9e7lJ2Z3Li2WlFSXyIfeneUvTFf8vXltHGoepDEKQaZ4XYoJzkDfJHgLKtqaVVyPPgR1WpJ/coJM+s2CCsKOuQV7Z8zZ+hGfndg1MneeBNSMxW7p9z5Dms+j4CKyydB9wMYECrG9RG+H51rEE4jLBnIvtHsL+7vUu5Vm45lOqd+G9CA8KWbZ2iHjcqIcd99xSRD5vVs4K5UK38QWHuuUeVQy3SNBp5znimlTE/wZuhBIWSH3hmlZ72J1NyLYpWY85GFmztTEKTm+zZb/ElzLC/XxI8KD3k3b+IKbJrbziVewcko3S4DyPtNgw66OkXQY22VDkkUKBrCpxqAuJhAkIEBvXGjbaHDlpdQQKdn6R9Escdteg+6ai19vGGAt1wLcgH11b2vX3N24rOo1IZr9zy4WXjWccPEV/wupU5Z+fs9urufh/6sz4/QJ/Pz+eTqK7xTyMubpbMR+hAx3eEAba0tpmE9ZtPAe77FR1k1mpht3dkFq4NyDXqResbUVAz8Dl0evebIAoPH4bM+uOfe1faNAuceZD62BEY9RWYz86OoiFnKa0zVdetdPkuCzdJGB8FNkr4SmRIaURXBl6PaT/6LywkNjubkSg+cyg0k8RxIWzZprNM1XHmzXb/aaXSuOZCxoHCxBeLPz9/uly8+7i8uPp0d/XubDaf2W/WBd8oY2suR35co93fFfdp/Czgbn9X/El3z6CdxW82biouJGWTC7oLRfUAO29Ww6XnAbou5QY/66rvafmxRb2F5GG1ryN68/OKBhpV4VfckmZZho11BVe17u5weOelpNvV9/UVZct3D9Ul1A== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-decision-definitions-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-decision-definitions-experimental.api.mdx new file mode 100644 index 0000000000..b258ee8472 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/query-decision-definitions-experimental.api.mdx @@ -0,0 +1,56 @@ +--- +id: query-decision-definitions-experimental +title: "Query decision definitions (experimental)" +description: "Search for decision definitions based on given criteria." +sidebar_label: "Query decision definitions (experimental)" +hide_title: true +hide_table_of_contents: true +api: eJztWEtz2zYQ/isYnBKXlpjESVPeFNtp1SaOayvpQdYBIpciEhBgANCSRsP/3lmAlCiJ8iOTXjr2jMcmse/db7nYFbVsZmg0pmcQc8OVJGeQcsktV5JOApqAiTUv3GNEr4HpOCOp0iRp6JM1vSFTZiAhSpIZvwVJYs0taM56N/JGHh1dKAtHRxEZZdwQkEmhuLQE/18UoHkO0jJBmEyIVJaAZFPhpZ2yvJQJI7EojQVtbqQqLVEpsRmQqVr0yNCSjBliFZnCmhMWheAxt2LpLF7z924kDaiG7yUY+04lSxqt3CPXkNAoZcJAQGMlLUiLZ6xAQQx97H81GIkVNXEGOXOnQnxKaTReUbssgEZUTb9CbGlAC60K0JaDcRxKO2k1FdOaLWlAuYXcPEZOykEkLUHGai5ntAqo0gno/RPMYspKYVGriWlVBS13x7XASUAttwLWaf67BL28Vtpe+UjRaoKcBZvBo8zVKm/ZxKWFGWga0FTpnFn/6tVLtF/wnNsH0hpn4yC1Wx7vBXXbtmrN+A5SpeExnFVnfC7ZDDbxCTr0dTAdZtjPtagdfGi4G1z+Bct7I/nmBCOZ5LIB/7C7rloUFyyHTppb0IZ7aDwgey2JV74SEf3mkP4O0of7Z0EyaTtFt9LTmLNpf+9d7LeL/zB1V3orjzRTKGl8dl6GoU9Su6uOMiAd7ZfU3daUcQzGpKUgjSzfwX56h3ostK2yTAx3AHNXKlKujcWW8oWJEszjgCvYj/LeBV0f0Mdg9yDHbnh27bnHzick/1dIxhLdLoN78Nuk2PGc/ABmnRySMi4g6ZGPSgNJwDIuDGEaSKHVLU8gIVy6GabBNZmqZHknuAutpgLyX/ZBvm3fgFx6ylov8UVGmCGecOq1j6/en5LfTl7/OnmWWVuYqN+fz+c9ncbHkHCrdE/pWV+nMf4i3fMeGWWggeRsicMWSxLnORNkU77EFBDzlMc4kaGDtdkEs+b9u6ezuNP9QWZdE6XmdHc6HZDPV0PCE5CWp0suZ/uqt2ehqSptNBVMfqOb2uianra1mDLPmV42A+i2ApwwLLPl/S3x1cs92VhVf4xGl8SLILFKwM2uFkfmWhE6kXPJ8zKn0UkYBjRnC//0JgwdyDDjD/BEuhGZSVdau+5wSfJN3TrHuDSWyfhnZUZpPuO7entbWK6L+Mx75PH4uguPA0kwyhrrELRWmqg4LrWGhMwzLpx4/Io2uuvp/wlrT1h7wtohrFUBzcFmKqERLZRxpcNsRiPabz7kx63rf99frSjesTROEW6ELLWgEV158FRRv7/KlLFVtCqUtlX/FjNzyzTHO7tLJB57kDXFI1TMROYN2E8iHkiWQ+Ncsy14S67Or0fkd2ZhzpYuqEV9Bd+Ifhu+DTulIukBiYPLIfEe+hJstYVGLOK7U6wnfojgCgdMA3GpuV1eI5sPzxSYBj0oMQ/r0qj1Oen47IloUP/zvimYP/8ZuZxjS7vaLEDOFywvPCA3N86t+TPcmy5blb47VG6O1rNkeOek2EbNgQExbI9/rYnSb1XG67XIRlS9DfErj8lmceEXEuF63RDuLBPGKx/59poA31UOlalyYa8xs5/AttM07L3Yx+fl0LWZWOV5Kd23Rs7InNuMsFZBNLsqinbGgONotKLSx7ch++BPyBevkbzoYTF7xDWfmBm3WTntxSrvx55t/Xcq1LSfMy77tQrTPx18/HxxNjj+MDw9v7g+P37RC3t24W9D2AJyJlt2+DG3cxX4rL3Ue74bhdXmm/u/WirWcLSwsP1CMC6xRF0+VnXrHNOu1kmbgsM1nG+AY7paoeuftagqfP0dg02j8WTTL/GpCmgGLPGVS78hVuipD+7xCM1BclG6C+julqAKGo5BHENh76SdtL4Gl5+uR9hd6uVprhLk0WyOi1U2pxG9oTcUQVh4/3DDiu9XVDA5Kx0UqZeLP/8CMfrSlA== +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    + Query decision definitions (experimental) +

    + + + +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. + +## Request + +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
    + +The Decision Definition Search successful response. + +
    Schema
      page object
      items object[]
    • Array [
    • ]
    + +The Decision Definition Search Query failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-experimental.api.mdx new file mode 100644 index 0000000000..3406756f5a --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-experimental.api.mdx @@ -0,0 +1,54 @@ +--- +id: query-process-instances-experimental +title: "Query process instances (experimental)" +description: "Search for process instances based on given criteria." +sidebar_label: "Query process instances (experimental)" +hide_title: true +hide_table_of_contents: true +api: eJztWEtz2zYQ/isYnBKXlpTESVPeFD9at4nj2kp6kHWAyKWEBAQYYGlZo+F/7yxA6kk7UienTjzjkQTuLvb1LXd3wVFMHI+H/NqaBJxjl9qh0AnwUcRTcImVBUqjecxvQdhkyjJjWVETy5rYsbFwkDKj2UTeg2aJlQhWis6dvtNHR1cG4egoZoOpdAx0WhipkdH3hwKszEGjUEzolGmDDLQYqyDtVOSlTgVLVOkQrLvTpkRmMoZTYGPz0GGXyKbCMTRsDEtOeCiUTCSquVd3yd+50zziFr6V4PCdSec8Xvif0kLK40woBxFPjEbQSM9EQYIEeaD7xZEbFtwlU8iFf6rUx4zHwwXHeQE85mb8BRLkES+sKcCiBOc5jPXSaiphrZjziEuE3B0iJ5Og0jVBDq3UE15F3NgU7O4TCmEmSoV0q0t4VUVr5g5rgaOIo0QFyxj/XYKd3xqLN8FTvBoRZyEmcJC61uRrOkmNMAHLI54ZmwsMR69ekv5K5hL3pHVex36GGxbvOHVTt2rJ+A4yY+EQzqrVP9diAiv/RC33tTA9zrAba1UbuK+7v8J8D6vaPfvmxGt8L6wkBLn93bOthRY5tKYofGvxbcQn+MgxtJ6rdnLVSr4Wg8+1ZZ+FKuHC+3YZi3W6ugw2VXCLcvQEaVuUqwA4Vxjtgnte9nr0sVlZB1Ng2/WX1eXWlQmdZ6VijaBQxX54lToU3mhQqMu90yvimbQOqaz4IByQY+RFJf4r71PwDQ49BL+Pcmy7Z1ufA3GEoIXGy/Zyvwn1p3xev6nPIJNaUoL8dSjrZ7BOhpzaoziPi1w3wGjXvRAWNB6ghqe/UGZ2ZVJo4LE/v0Nh8UxgS1VaI08FwjHKHHyp0ukhDI/XBELHk/WlNbU8w8mhhcILYZmQCtIO+2AssBRQSOWYsEAt271MIWVS++apKSZsbNL5kxWlsGasIP9lt7JsKtcn1YiyvpeFzGbCsUA4DrcPby5O2W8nr38dPZsiFi7udmezWcdmyTGkEo3tGDvp2iyhf6J73mGDKVhguZhTlyfS1KeyUGyFGeYKSGQmE2oFycBabUYRDPZ9B3D+6RMRL63k2z1xn326uWQyBY0ym0s92b16swkbmxLjsRL6K19lRVvbtnmLK/Nc2HnT+W5eEJIcy+/X4Vcvd2RTSv0xGFyzIIIlJgXfNCP16vVFZEQutczLnMcnvV7Ec/EQfr3p9SqSSRHfwxLte3OhfWptmyM1y1d56w1rJowfFBlj5URu39vZhjAdngWLAhhft4Gxrxl52VIegrXGMpMkpbWQstlUKmimpObueuz4ibWfWPuJtcewVkU8B5yalMe8MM6njsApj3m3htPxcunQDQMdp8nO3oN1vmktreIxXwTkVHG3u5gah1W8KIzFqntPYdmYc+hxQFiTOcokQk3D7bsRpAc05TSWNTuKt+zm/HbAfhcIMzH3Hi3qwX8l+m3vba9VKpE+IrF/fcmChSH/1mpCI5bA3So2EO8juKKW1kFSWonzW2IL7hmDsGD7JQVhmRf1fV46/Q5EPKq/XDTZ8uc/Ax9wqmc3q7XL+YPIi4DG1Zzrm9phb7QRnmEzUa5S0Q+SzeS4HBWb2XA5DFbViJzlIzBc7k5WYuqVSdiLjFbbjbC16C13Er2tjcNwERy1vkugs8ojKDPeS3V+7/qbkq9pqHmv82IXS9eXviQkJs9L7d8LesJmEqdMrMWvWWhx0jMB6huXw/fy2vfhCatbePaiQ7kXANK8DiYSp+W4k5i8mwS25edYmXE3F1J36ytc97T/4dPVWf/4/eXp+dXt+fGLTq+DD2FcIrjmQq/pEVrS3WXhs/W13/NtFyxWL8f/z86xxg3CA3YLJaQmJPtILOoCN+Q7BY43eUYrulCmhnyxILs/WVVVdPyNfMzj4Rps6FcV8SmINCRsgBY/DW49HpAuRK5KP5hubw+qqOHoJwkU+CTtaK1gX3+8HVANqBeruUmJx4oZLV3FjMf8jt9xwp4PtS8v/nzBldCT0iOQB7n09y96h9CK +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Query process instances (experimental)

    + + + +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. + +## Request + +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
      variables object[]
    • Array [
    • ]
    + +The Process Instance Search successful response. + +
    Schema
      page object
      items object[]
    • Array [
    • ]
    + +The Process Instance Search Query failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx new file mode 100644 index 0000000000..7144e69a8f --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx @@ -0,0 +1,55 @@ +--- +id: query-user-tasks-experimental +title: "Query user tasks (experimental)" +description: "Search for user tasks based on given criteria." +sidebar_label: "Query user tasks (experimental)" +hide_title: true +hide_table_of_contents: true +api: eJztWVtv2zYU/isEn9rMsd027Tq9ubm03nrxEqd7cPJAS0cWG4pUSSq2Yei/D4eULNlWEnsosGFoACOWeC48t488xytq2czQYEKvDWhimbmjtx0agQk1zyxXkgb0CpgOExIrTfKKypApMxARJcmM34MkoeYWNGfdG3kjj44+KwtHRwEZJ9wQkFGmuLQEvy8y0DwFaZkgTEZEKktAsqnw0k5ZmsuIkVDkxoI2N1LllqiY2ATIVC26ZGhJwgyxikxhzQmLTPCQW7F0+1zzd28k7VAN33Mw9p2KljRYuUeuIaJBzISBDg2VtCAtrrEMBTE0vffNoP0rasIEUuZWhfgS02CyonaZAQ2omn6D0NIOzbTKQFsOxnEo7aSVVExrtqQdyi2k5hA5MQcRNQQZq7mc0aJDlY5A765g7GKWC4taTUiLotMwd1IKvO1Qy62AdXD/zEEvr5S2l95TtLhFzozN4KDtapU29sSlhRlo2qGx0imz/tWrl7h/wVNu96Q1bo+D2G5YvOPUzb0Va8Z3ECsNh3AWrf4ZsRnU/um06GthajJsltW64ojfJvmO9KTM1S7dVrCbG6J0yENyPcX+Eu9g+WRE3py4iFhmoTUvmTF8JqF9EQRg5Q/bUzpkMuIRs/Beqzx7nASNbKXItArBmDOIueTokT/2NqpkHUpjmQxhf0YLkqFVpnVH0yyV9XZabW+kDho2ZubuwsVunT0tFG1JVvh6N5mSxsf0Zb+/myLjBIhLE5RDSnw3eYjmx7kglQSPnj8cHQ+FFassE8OtYn0sIDHXxiKcfWUiB3MYaAj2T3kfgw3v0ENwo8GxJ3CUQXuyzrcNeMKw/xhMVKsHl+mD+PKQ/Y3yfAh49mDF+h+V0NJu0b+BWfjmANdpcEV/1hrPBge66NjyFByXSjMBh/PFSgg1v84O44pyOIzhcdiGhQUtmbhQOr2EGDTIsD1dd8L3FbThHhz3uN2EubEq/QAsAt1afSyKnFgmRpuwuJVqLWcEgmb7SivUOMqTvU8Mx01ixgVEXfJJaSARWMaFIUwDybS65xFEhEt3e68AikxVtHz0aMm0mgpIf9k9YjZ3NSAjT1nqJd5nhBniCade++Ty4pT8dvL619tnibWZCXq9+Xze1XF4DBG3SneVnvV0HOIH6Z53yTgBDSRlS2wz6hCQGguJySDkMQ+xF0EDy20TDIy374lzza0+kq655nQb/Qfk+nJIeATS8njJ5WxX9WYXMFW5DaaCyTta50Fb37CpxeRpyvSyar02FZTYnj99IL96uSMbc+nDeDwiXgQJVQSua7PYLJaK0IiUS57mKQ1O+v0OTdnCP73p97HcXcT3sES65pBJl1rb5nBJ0jpvnWG8xNIfFBml+Yxv6+1uHPtlEp95i3wVvm6rwoEk6GWEJQJaK01UGOZaQ0TmCRdOPEJRpbu6+f+stZ+19rPWHqi1okNTsImKaEAzZVzqMJvQgPZw3HXsxl09f9WmOFPQ9+6gnqxorgUN6MqXTBH0eqtEGVsEq0xpW/TuMR73THOcUbnw4bIvrSplhAqZSLza3dDhgmQpVCZV07G35PL8akzeMwtztnSuzMqRUy36bf9tv1Uqkj4gcTAaEm+hT7wGGFRisapbxXrifQQX2NQYCHPN7fIK2bx7psA06EGO3l8nRKnPScdnT0Q75ZeLKk1+/2vsIo1AdlkP/M4XDG+hmxMT18L01w1KnXR1X1K/a7Qj9cvtZqJlxbcK9UL7Nb/ffonvb9xPayG704TGTdSPHSfruWHNVo4L/Uzwtp7s+Yldfz2P629N2yYrH6rmHA3fFa54Y+XiVJbWbsQx/au7MO13X+yW8Wjo0ChUaZpLdyTJGZlzmxDWyKBqmEtxnyHgXTVYUSyMhtqPfoWUt2/yoovZ70u0Oolm3Cb5tBuqtBd6tvX/qVDTXsq47JUqTO908On689ng+OPw9Pzz1fnxi26/axe+ZUekSJls7MPfhhsT8mfNWffzbdtX9YH8P5iwl7VqYWF7mWBcYjo6369KNJ3QGk1plVI4ifaYOKGrFRp8rUVR4Gs31KDB5LaGUHwqOjRxrZLLc1fH9NQ78niMm0BykbvefHtYVXQqjkEYQmYfpb1tHAujL1djrL3y94NURcij2Rx/W2BzGtAbekOxzFxwHZa59ysqmJzlrtiol4t/fwM4m89c +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Query user tasks (experimental)

    + + + +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. + +## Request + +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
      + +User task filter request. + +
    + +The User Task Search successful response. + +
    Schema
      page object
      items object[]
    • Array [
    • customHeaders object
    • ]
    + +The User Task Search Query failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx new file mode 100644 index 0000000000..81fb73addf --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx @@ -0,0 +1,60 @@ +--- +id: report-error-for-job +title: "Report error for job" +description: "Reports a business error (i.e. non-technical) that occurs while processing a job." +sidebar_label: "Report error for job" +hide_title: true +hide_table_of_contents: true +api: eJztWE1z2zYQ/Ss7OCVTWlRS54s31XFap3HikZX24OgAgisRNgkwAChZw+F/7yxA6ttpDu1NmtFIBBa72N33QPI1zPG5Zckd+6hTNo1YhlYYWTmpFUvYGCttnAUOaW2lQmsBjdEGnskBDkBpdeZQ5EoKXjwHl3MHWojaWFjmskCojBZorVRz4HCv08E3xSJWccNLdGgocMMUL5El7F6nf+KKRUxS5Iq7nEXM4PdaGsxY4kyN+9ub5AgPuAI9A5ejD8AiZkWOJWdJw9yqIs9SOZyjYRGbaVNyF4Zen7O2nYYQaN1vOlvRmv2IQiuHytEUr6pCCk7B43tLO2gOg+n0HoWjLI2u0DiJlmZ92S50hnRxmEWoqtAZhiouZVFAilByJ3LMYCldDlz1djQKuEDlQkW72NYZqeasjUK4a7SWz49EHPWOymARYlZGL2SGFniWSbLkBfjsH49GiZiqi4KnBYZStRFbcCNpwGe88XKzVYljbfx4++UzhLptZS+VdVw5yR367q6dA3d+oNCCF2CFrrBHwEF5gj8/gNabuNzoZZf/Tlrrxu2l1W6j8G6rkdOIOenIjshzSePjgCXWtmGZrbSyoRwvh+c/aIS0/cZm2mzA3EbsfDg8DpmuXRlk3HFyoLSDBS9kFtJ6AriV0WmB5S+HAN7bGtwES8jQcVn0DeIWgmGKGUgFd+MPF/Du/NWb6bPcucomcbxcLgdmJs4wk06bgTbz2MwEfcnu+QAmORrC9oogvoW2DWXAVijkTApw2pej2zZQs463bZdvYbY5wOz6BKiNZPtAHMHX8RXIDJWTsxWdWgeh/ZoZrwvywVNduyQtuHqgVnVoOAy6H8XWZcnN+tzaDdBGzDruavuvJ9ivLw98EzD+mExuILgIJ0qAlLR9IEqilEqWdcmS8+EwYiV/DFevh8OWfFLHfyITBfhYFVx5aO2nIxWU2mCHH59Y4LT4rzqjjZzL/bgD1m56wToQvw8ZBV6eH6PiJHAunLTkbi4XqCDclXp6zXStTvQ60etErx/S691P0+shcEsqP7Y0Ws19bRFEbQwqV6wGcL1J0wI3W7e+bl1/o4VUZ6sTPU/0PNHzaXq+OvZAOVJAVTaEw/BE6t/jDL167L/JBcb5B90T105cO3HtKa61ESvR5TojPUNbDx2SNRIW3+vUxk14uGxjzzhSLtAselWkNgVLWBNI0yZx3OTaujZpSJFp4wV1ZOd9m6YDuXrQ+BfkPAQ+bB5NkPTSJ3XBy1plHN7C+PJ2Ar9zh0u+8sWkkLuu3w7fDo96JdMnPI5uriBkGKC3dRz0bonXR90G459x7DUdi6I20q1uaVkoT4rcoBnVVP81JLp43jtdByMWdX8+9ED5+PfE95qOsvFGL7p85GUViLil72yAtqvCbMa3+9Z6sM6031UHpcP8aBEaGwoyHLw4hO3NlWef0GVZK38Eq3knG23VSxS1dVSniBVSoLJ+850C15t9CjPwV4gILwbU6wDI/uSdS5fX6UDoMhZh2fo3LXQal1yquAth44vR9dfP70dnn64uLj/fXp69GAwH7tH5mhIzSq629hFUx+4+REnd63Q/4WZz1/mfVMoOIiR/xVXBpSLQ+iI0HY3vSLO0LGLJWrsMTJ5GHRvvWNOk3OJXU7QtDX+v0axYcjfdgMCzPZOW/mcsmfHC7itk28k+G3di1HM4Ln8e3Xc3yNXKw6+o6YpF7AFXG+m1nbYRy5FnaPymwuRFCH02IRebxQdiaBv1K0ZCYOWesN15KiCuro/Imy+3E6JeJ8SWgUyGL0kH5kuWsG/sG21a+7J4VvvxhhVczetAsuCXPv8AAA/kTg== +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Report error for job

    + + + +Reports a business error (i.e. non-technical) that occurs while processing a job. + +## Request + +

    Path Parameters

    Body

    required
      variables objectnullable
      + +JSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error. + +
    + +An error is thrown for the job. + +
    + +The provided data is not valid. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The job with the given jobKey is not found. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The job with the given key is in the wrong state currently. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/unassign-a-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx similarity index 53% rename from docs/apis-tools/camunda-api-rest/specifications/unassign-a-user-task.api.mdx rename to docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx index fe705b994c..0e3b9b6061 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/unassign-a-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx @@ -1,12 +1,12 @@ --- -id: unassign-a-user-task -title: "Unassign a user task" -description: "Removes the assignee of a task with the given key." -sidebar_label: "Unassign a user task" +id: resolve-incident +title: "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." +sidebar_label: "Resolve incident" hide_title: true hide_table_of_contents: true -api: eJztV01v20YQ/SuLOSUoTcqpmzq8CbbSunUCw5bbg6vDcjkUNyZ3mf2QTBD878VwqQ/LblwEOfogUCRn35vHmbccduD40kJ6B7cWDXPc3sMighytMLJxUitI4RprvULLXImMWyuXCpHpgvEhnq2lK4d7S7lCxe6xjSGChhteo0ND6B0oXiOk4C2aObf3f2ILEUhCb7grIQKDX700mEPqjMfDFOYlEjCxEpPfJEtMVpRYc0g7cG1DJFI5XKKBCAptau7Cpfcn0PcLIrKNVhYtrXg3OaHDU7ItA1tzy7wadefMeiHQ2sJXVRtDH8HJZPIixJMnxARXSjuW4R52zD5pgyxHx2VlGTfIGqNXMsecSTUAbJJnmc7b+B8FEQitHCpHOfCmqaTglEPSGJ1VWP/0xVJC3d5TepzplF2FyJGX6ewLCse4ZSEwC+x31x/P2IeTX35dvCmda2yaJOv1OjaFOMJcOm1ibZaJKQT9KO5tzOYlGmQ1b0knz3NJnLwiVQ0aJ9Ey26CQhRTM6UHgmDajUgZ9Y1FDWtRY28W7km9Lb52RarlfeW8kHHbTlN1eXzCZo3KyaKVaPqUe1hTcV4TBM+1dmlVc3VPFnXTVs6SHLNbXNTfbrn1M0EdgHXfevti5P797gk399ft8fsUCBBM6R1Zow1wp7YaIRNRSydrXkJ5MJhHU/CGcvZ9MesKkiv8PJYrhQ1NxNbTWoRypWL3r20GYVNZxJX5UZbSRS3nIG0O/qwWMTXweFPV9PzjzZXM/dSb5naxZaK/y0eEfvgNH2o1p10ar5VApZMIbg8pV7avZX83+avYfZfY+ghpdqXNIIccKHQ4jiCshhYRsekQ2tUm3N4D0yWaYoSECzWozq3hTQQpdMFGfJklXauv6tGu0cX2yogqtuJE8q0Jf0u1gtk0TVVrwarj8XDHpBg1EG5Fnp+x6djNnv3GHax7GCuJ6jHk6OZ08C0ehh1DTqwsWNIXm29sQNnjk7GfxQvA3EYdJyqLwRrr2huLDk8iQGzRTTw9+2w0j0QBL5yEIovHPx02P/PH3fCizVIUelo/lPuO1Vzlnu0SoAGhsSHkSHz9trauLwSFC17VXwzaplrtdeocoKm8dSYqgkgKVHdp4nFY3YZfhDvsrcLLjmAoR2mSzPy6lK30WC10nIizbHrNKZ0nNpUpGCpucTT/dfj6fHl1enM0+38yOjuNJ7B7cIL/R1tVc7eVxO46IjO9eOYeSu9274fsG9rFYDh9c0lRcKuqbQWM3OukOdk6CCNLHw/zWTItoNMQddF3GLd6aqu/p8lePpoX0brHzz2C4XFr6n0Na8MoeDv/7yt5cj58Jb9m3Pgme1TJe5Kod/Ft5OoMI7rE9+DLpF30EJfIczZBfiJgKgY3bW/ufb2Ayx3Y7Op9dzuYz6Pt/AcG3nLc= -sidebar_class_name: "delete api-method" +api: eJztV8tu4zYU/RXirmZQxXKmmWmqroxMpk3n0SCPdpF6QVHXFhOK1JBUHEEQ0N/o7/VLikvKju04yCy66MILQ5Z4eR8855C8HXg+d5DdwJkWskDtYZpAgU5YWXtpNGTwmds7x3yJTA42jDtm0Rl1j8VPrDLOMyXvULWMM8GVYt6w67rgHtmtydlCKsVyZBoFOsdtS+MWHfrg9dbk//z1N3n0VqJL2MwoZRZYsLxlvpQu+Bz9qSGBmlteoUdLOXegeYWQwTKvj9hCApKSrrkvIQGLXxtpsYDM2wa3K/uILTOzzdJialTaCBJwosSKQ9aBb+sYyuMcLSQwM7biPn56dwR9P6VwrjbaoaMZb8ZH9NgMebUeSzpWcXuHxfqCjqBP4Gg83j23tuZeFliwgntODrTx7J4rWVC6wmhPGGYd8LpWUnCamtbW5Aqr724d+enWqtoMMGHn0ZIV6LlUzOS3KALc0TDHgknNbi4+nLAfj97+MH1Vel+7LE0Xi8XIzsQBFtIbOzJ2ntqZoB/ZvR6xqxItsoq3xAReFJJickUF1Wi9RMdcjULOpCAMfKw1JENLH+EfQIhpER1Wkx8hWkHlvJV6vo5UYyVsc2DCri/OWMBDzlqp509Dhzkz3ijywXPT+CxXXN8RUF56tTPodhTXVBVRf+DbZoA+Aee5b9yLTPv+zRPfRItfrq7OWXTBhCmQzYyN2hkCURGV1LJqKsiOxuMEKv4Q396Nxz35JMS/oRLN8KFWXAdqbZcjNauMxYE/oTCpneda/FfIGCvncjvuCPpHLGAg8ftYUd/3QVAviXEhfbmxFdDuMAhsZhq9F9heYHuBPSuwt7tOrIlmtMqWeIjWGsuMEI21WLBFKVVwT3eCZWw6rtH5vdL2StsrbbfS+gQq9KUp6JJrXKAO3XUzSJcHl0u7tTOsT8PNsgmpJODQ3i+vz41VkEEXNdRnadqVxvk+62pjfZ/eE0D33Eqeq0hLGo5aW3JIGcFVGfN4iiUN0B19WeMJrxpdcHbMLk4vr9jP3OOCt2FtKeSm6+Px8XinVzJ9xuPk/IzFCiMT13aHpVuS+U630fhbHIe7vkPRWOnbS5oWlydHbtFOGoJjxZAhXvBO79EIkuHPhyVvfv3jKkAv9cyE6QMFniZCqKB1MfPx6PAp3c7PgmqEqapGh61Tz+MFh68VJlTjPBWUgJICtQvEHnqqpdmnOMJ+jxHZ4YhAicxZ7phz6csmHwlTpSJOWz1zZfK04lKnQwiXnkw+X395Pzn4dHZy+uXy9OBwNB75Bx+KJ0ZXXK/lcRHbotWtbLvY7vGk+F91qgP6Hh98WisuNfExLFs3CPZm1bc6SCDbbGLXNDtNBt3dQNfl3OG1VX1Pn782aFvIbqaPMg26LqSj/wVkM67cdtu7vmKvLoYG+TV7uRneWdLwkes2bBaqoTdI4A7brc68n/YJlMgLtCHLaDERAmu/NvfZ055Et9r6zn+7JLn8C8tKx/c= +sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null hide_send_button: true @@ -25,31 +25,31 @@ import Markdown from "@theme/Markdown"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; -

    Unassign a user task

    +

    Resolve incident

    -Removes the assignee of a task with the given key. +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. ## Request -

    Path Parameters

    +

    Path Parameters

    -The user task was unassigned successfully. +The incident is marked as resolved.
    -The user task with the given key cannot be unassigned. More details are provided in the response body. +The provided data is not valid.
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    -The user task with the given key was not found. +The incident with the incidentKey is not found. -
    +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    -The user task with the given key is in the wrong state currently. More details are provided in the response body. +An internal error occurred while processing the request.
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js index b34b531b67..cd99747304 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js +++ b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js @@ -25,6 +25,36 @@ module.exports = [ label: "Activate jobs", className: "api-method post", }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/fail-job", + label: "Fail job", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/report-error-for-job", + label: "Report error for job", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/complete-job", + label: "Complete job", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Incident", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/resolve-incident", + label: "Resolve incident", + className: "api-method post", + }, ], }, { @@ -33,28 +63,58 @@ module.exports = [ items: [ { type: "doc", - id: "apis-tools/camunda-api-rest/specifications/complete-a-user-task", - label: "Complete a user task", + id: "apis-tools/camunda-api-rest/specifications/complete-user-task", + label: "Complete user task", className: "api-method post", }, { type: "doc", - id: "apis-tools/camunda-api-rest/specifications/assign-a-user-task", - label: "Assign a user task", + id: "apis-tools/camunda-api-rest/specifications/assign-user-task", + label: "Assign user task", className: "api-method post", }, { type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-a-user-task", - label: "Update a user task", + id: "apis-tools/camunda-api-rest/specifications/update-user-task", + label: "Update user task", className: "api-method patch", }, { type: "doc", - id: "apis-tools/camunda-api-rest/specifications/unassign-a-user-task", - label: "Unassign a user task", + id: "apis-tools/camunda-api-rest/specifications/unassign-user-task", + label: "Unassign user task", className: "api-method delete", }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental", + label: "Query user tasks (experimental)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Process Instance", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/query-process-instances-experimental", + label: "Query process instances (experimental)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Decision Definition", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/query-decision-definitions-experimental", + label: "Query decision definitions (experimental)", + className: "api-method post", + }, ], }, ]; diff --git a/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx new file mode 100644 index 0000000000..5dcc35a72d --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx @@ -0,0 +1,59 @@ +--- +id: unassign-user-task +title: "Unassign user task" +description: "Removes the assignee of a task with the given key." +sidebar_label: "Unassign user task" +hide_title: true +hide_table_of_contents: true +api: eJztWE1z2zYQ/SuYPSVTmpRTJ3V409hK69bJeGy5Pbg6gOBKREwCDABK1mj43zsLkJIsyXUmk6MOGooksG8f9j3iYwWOzyykD3Bv0TDH7SNMIsjRCiNrJ7WCFG6x0nO0zBXIuLVyphCZnjLu27OFdIV/N5NzVOwRlzFEUHPDK3RoKPoKFK8QUmgsmjG3j3/hEiKQFL3mroAIDH5rpMEcUmca3E1hXCAFJlRCavpkCcmKAisO6QrcsiYQqRzO0EAEU20q7sKjD2fQthMCsrVWFi31eDc4o8s+2BqBLbhljep458w2QqC106YslzG0EZwNBq+G2BshJrhS2rEMt2LH7LM2yHJ0XJaWcYOsNnouc8yZVD5AnzzLdL6M/1UQgdDKoXKUA6/rUgpOOSS10VmJ1S9fLSW02hql55kO2U1o2eEynX1F4Ri3LDTMAvrD7acL9vHs/W+TN4VztU2TZLFYxGYqTjCXTptYm1lipoJ+1O5tzMYFGmQVXxJPnueSMHlJrGo0TqJltkYhp1Iwpz3BLm1GpQz8uqKGtEhY686bkq9Lb52RarZd+cZI2FXTkN3fXjGZo3JyupRqtg/t+0x5U1IMnunGpVnJ1SNV3ElXHgTdRbFNVXGzVu1zgDYC67hr7KvK/fXdXmzS1x/j8Q0LIZjQObKpNswV0vZARKKSSlZNBenZYBBBxZ/C3YfBoKWYVPHvYKIYPtUlV15au3SkYtVGt56YVNZxJX5WZbSRM7mLG0O7qQV0Ir4MjNq29c583dz7ziS/kzWnulF5fDTY0WBHg71osI8/YDBp+9lsYbSa+RFGJhpjULlyeZwFjyY9mvTnmfT9ofXpUDEaZUM6RGO0YVp4B+ZsUcjSh6dlbo9Nq3O07ui1o9eOXnvJa20EFbpC55BCjiU69PtgV0AKCU2JJzQl2mS1tQtuk35HTTtZNPN+w9yYElJYBRO1aZKsCm1dm65qbVybzKlCc24kz8qgS3odzNaLqNSCl/7xoWLSC9qV9yQveNWonLNzdju6G7PfucMFD1tcgnwe+nxwPjgYlZq+EHF4c8UCwyDFrc9DH5Z8fjBsaPw9gf0e36JojHTLO+oWhidDbtAMG6rGWiIdno9O96ERRN2fT71w/vxn7Gsv1VT77p0G9hOhqqCxIfNBfLqvt5srbxuhq6pR/tupZmGZxLeIibKxjghFUEqBynpld6cofbPr8Ib9HRDZaUxFCcrpP5kz6Yomi4WuEhG6ra9ZqbOk4lIlHYRNLoaf779cDk+ury5GX+5GJ6fxIHZPzpOvtXUVV1t53HdHF5v13i7d1Way+LFjpK5QDp9cUpdcKpKOZ7jqrPUAG2tBBOnzI6a1uyZR55AHWK0ybvHelG1Lj781aJaQPkw2hvIOzKWl/zmkU17a3SOpbWZvbrvDq7fs/w6qDnLpHnK19IYuG7qDCB5xuXNe1k7aCArkORqfX2gxFAJrt9X3xSmZjLH+Pl2OrkfjEbTtf/wi5PA= +sidebar_class_name: "delete api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Unassign user task

    + + + +Removes the assignee of a task with the given key. + +## Request + +

    Path Parameters

    + +The user task was unassigned successfully. + +
    + +The user task with the given key cannot be unassigned. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The user task with the given key was not found. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The user task with the given key is in the wrong state currently. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/update-a-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx similarity index 53% rename from docs/apis-tools/camunda-api-rest/specifications/update-a-user-task.api.mdx rename to docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx index 370e1db0eb..dfa21cc9a4 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-a-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx @@ -1,11 +1,11 @@ --- -id: update-a-user-task -title: "Update a user task" +id: update-user-task +title: "Update user task" description: "Update a user task with the given key." -sidebar_label: "Update a user task" +sidebar_label: "Update user task" hide_title: true hide_table_of_contents: true -api: eJztWOtv2zYQ/1cIflm7ybKTuW2qb16atun6CBJnAxYHCC2dbTYUqfIRxzD0vw9HSpb8yGNdB+xDAgSJzXvf/Y7HW1LLpoYmF/TcgCaWmWt6GdEMTKp5YbmSNKHnRcYsEEZcTUPm3M6InQGZ8huQ5BoWMY1owTTLwYJGiUsqWQ40ocg1ZOb6d1jQiHKUWDA7oxHV8M1xDRlNrHawqXY4AxRM1MRrapRbRZw3CXWadAY5o8mS2kWB6ri0MAVNIzpROmc2fPWyT8vyMqgEY39T2QJ5GgsmTBiIaKqkBWnxjBWF4ClDa7pfDZq03Namxl8htei7VgVoy8HgaTpjcgoGgiAhvkx8RNYd/HD25TMJAkJAA1cWvGTWaj52FsgNEw5MPJIjiTGZKCHUnMtpQ2JIyiQZA2HZV2csZHWCuCEgs0JxaSPCsoyjaiZanCM550IgL59KpSFLUM/P5CplMuMY5XdaucJckQ7R6BEZL0ih1Q3PvAmSQF7YBRHc2HU+rKjHs2UO3jALD9GfWc3l1HOEOJwX/4RtJE9ah1VtKQPtUPrQMXIlnRBXIfhEaaJybi3ycUsK1KVvMHpYmgVow33YV2J+MoFzlTVmDJ9KAMyUVPbBZDkDvuwHni+URH0ao0hPbZzG5CutsYjgBqQlkHNjuJJkonRLbajIeCRptFW8TWWctMo4gHK9sKs0tRBgfGjbcMPkdyzPge6CdOaA+H5S4Ro9i8npg8lDsGNK2FhAsK1EnU0N/AubgpiOK36cZeswaNnGtGaLnVYgFlD3itX3PPN4c1AAGsMt5GY7HOV9ZgaUf6edU8/8HxpaRtRyix/p4aq1lls31VNHfeqo/4+OugU0loYa3RwCBiR1xqqcBIIqOnbGsIJDGbE0BWP4WACZaJW3JiFvnsE8OeEj6c/X/CZc3qgwxcTkeEIwUiGdkEUYea8lgwlzwuJoNaJhuBrRNc9WLfVuZJ5Xg16YF0/DpEXLEmk0mEJJEy6R/V5/OxDDtRlvzkw15GXEOB+AiRNiEWNz6Pd6D/JvDaitMqkEx+ST0kAysIwLQ5iGVWQIl567NpuMVbYI8bhjQiy0GgvIf9meFDfzfRIoK711u2KGBMJx0H5x+vaQvO6/eHX5bGZtYZJudz6fx3qSdiDjVulY6WlXT1L8RbrnMRnOQAPJ2SJgYdWbmiucmAJSPuEpZtoDrTIGs7y7ktfv/3B6z0XrNN+6NAbk/PSY8Ayk5ZMF1umWas/jaxCvnrFyNhkLJq9pU1/bSje1GJfnTK9eDOsKyogay6wzD74Vft3fee29Hw5PSBBBUpWB7wYea5UidCLnkucup0m/14tozm7Dp5e9XokyMeOP8EQSuC0Ek760Nt3hkuRN3XrHuDSWyfRHZUZpPuWbemPaxnpVxG+CRwHj/UfAehuWiHTE5UQ5mVXwfv0dcripQTvXSk59poCkTmuQViyewP4E9iew/yiwlxHNwc5UFpY56cxvf+yMJrSLKO0gSk132dr9lLiswRGv2g45LWhClwE6ZdLtLmfK2DJZFkrbsnuDeblhmuOs4dOIxwFidekIlTLhv96VQjzAFVTt2uEBOT06G5J3zMKchUkCda3LPOgd9HaKQ9JNUYOTYxJ8CiXXagO1PMTzTnmB+F6JfmNlIHWa28UZ0odIjIFp0AOH8V7VQKXIi8XPgYhG1T9v68r48OfQJxd712mzDTu6ZXkRkLe2vFo9+Ol+b7/f6b3s7L0a9l4k/b1kfz9+tXfwF918ht9Hufksvqhr93LHW7Q5bA3QrUcilxPlI1A/DVnuZMZIE0usIXxKeMZevLeNiZNjD+1U5bmTvr/LaXO9NBJTgS8LjbAXPAVpfKiqFWdN9jGckD+CTrIXYy2FSq8b+5TbmRvHqcq7aWBb/R0LNe7mjMtupcJ0Dwefzj+/GXQ+Hh8efT476uzFvdjeWp/BQhmbM9myY3tTu+nwsrnSHr/XrSrMwq3tFoJxicH3Xi0r1F/QBvU0okl753sZVdC9oMvlmBk416Is8etvDvSCJheXDdLDmpQb/L/Zyt7pwrPTaoH7nDxuXbzTlXrjIRe+5wiHn2hEr2Gxsb8usRJnwDLQ3tJAcRjs6QxRTiNha4FcRjXHIE2hsHfQrk0X2AJWrfZkMDx8j5Cu1te5ypBZszlu09mcJnRER2i68sHy3cJ/v6SCyaljU6QPgvHnb/OnZak= +api: eJztWW1v2zYQ/isEv6zdZFnt3DbVNy9N23RtFyTOBiwOEFo622woUuWLHcPQfx+OlGz5JU3Wdd8cIEhk3vvdcycfl9SyiaHpFb00oIll5pZeRzQHk2leWq4kTellmTMLhBHX0JA5t1Nip0AmfAaS3MIiphEtmWYFWNAocUklK4CmFLkGzNz+DgsaUY4SS2anNKIavjquIaep1Q621Q6mgIKJGntNa+VWEedNQp0mm0LBaLqkdlGiOi4tTEDTiI6VLpgNH73s0aq6DirB2N9UvkCetQVjJgxENFPSgrR4xspS8IyhNd0vBk1a7mpToy+QWfRdqxK05WDwNJsyOQEDXtCmWx8u/vhMAlsIY6DNg2/MWs1HzgKZMeHAxEM5lBiJsRJCzbmcrEkMyZgkIyAs/+KMhbxJCzcEZF4qLm1EWJ5zVM1Ei3Mo51wI5OUTqTTkKer5mdxkTOYcY/tOK1eaG9IhGv0gowUptZrx3JsgCRSlXRDBjd3kwzp6PFvu4A2z8BD9hdVcTjxHiMNl+W/YhvKsdVhXlDLQDqUPHSM30glxE4JPlCaq4NYiH7ekRF16htHDgixBG+7DvhLzkwmcq6wxY/hEAmCmpLIPJssZ8MXe93yhJJrTGEV6auM0Jl9pjUUEM5CWQMGN4UqSsdIttaEO46Gk0U7JoqtsJKCB37pSzlrFHM42y7tOWwsHxoe6DTosho7lBdB9wM4dEN9VanSjpzE5fzCZ8Y7dFepc18R/sCmI6bjyx1m2CYuWbUxrtthrBWIDda9YfeczjzcHBaAx3EJhdsNRfcvMgPrvtHPimf9HQ6uIWm7xkR6vGmwVUZYFu7ZbbZ9kzlhVkEBQo9pOGXbe0P5YloExfCSAjLUqWlPGw8pgf3HCdwB/voFXwuVMhQkRk9MxQYQHPyGPsGN4LTmMmRMWx9aQhsE1pBuIXBXq/f5e1kM0zOLzMMVoVSGNBlMqaQI0nye93UAMNubnnJl6gObEOB+AsRNiEWMse0nyIP/O8G+1t1pwTD4pDSQHy7gwhGlYRYZw6bkbs8lI5YsQj3umb6nVSEDxy+4U3s73WaCs9TZjlhkSCEdB+9X522Pyuvfi1fWTqbWlSbvd+Xwe63HWgZxbpWOlJ109zvAX6Z7GZDAFDaRgi9DDVzN13RiJKSHjY55hpv2AqI3BLO/vwJtdNZx+o305zXeg2CeX56eE5yAtHy+wTndUex5fgwjokXI2HQkmb+m6vnaVbmsxriiYXr2NbSqoImoss848+B726/O9zeT9YHBGggiSqRz8FPNYqxWhEwWXvHAFTXtJEtGC3YWnl0lSoUzM+CM8kQTuSsGkL61td7gkxbpuvWNcGstk9qMyozSf8G29MW1jvS7iN8GjgPHeI2C9C0tEOuJyrJzM4wPADgA7AOxegL3+DoBx00yzuVZy4iMMJHNag7RicZiCB5AeQPrjQPpi38tpXxKMssY6BK3xS3vmEZiT+ZQLL96/5Ne66xXQAWsHrB2wdh/WqogWYKcqD9vabOrXu3ZKU9rFidjBiWi6y9Zyt8JtLO7H6vWv04KmdBmgU6Xd7nKqjK3SZam0rbozzMuMaY5feH0a8ThArCkdoTIm/Mf7UogHuGNuXDtmhZM5I0fk/ORiQN4xC3MWvtWiyk3RR8lRslcqkt4jsX92SoKHoQBbTaERi+jeKzYQP0aw31MbyJzmdnGBbCE8I2AadN9hElaFUevz0vE5ENGo/udtUy4f/hr4jGNDO1/vwE/uWFEGOG6urJsFH32ePO91kqNO8nKQHKVJkiav4qSX/E23127fotxeg101BX29Z/e0PmytdlpLIS7HykegWQXtxBILC5eznjGJn+0C5ezU4z1TReGkb/py0qyA1/IygZtajZ1A8Ayk8YGqrzUaso/hhPwZNJJnMdZVKP6m10+4nbpRnKmimwW21d+RUKNuwbjs1ipM97j/6fLzm37n4+nxyeeLk86zOIntnfX5K5WxBZMtO+rbmdVr6razy/WMe/xNTl1dFu5stxSMSwy892lZt4Erum4DNKJp+5bnOqqxfEWXyxEzcKlFVeHHXx3oBU2vrtfQ970i5wb/X9/D3OvCk/P6yuYpedwF0V5Xmu2mXPgmJBw+0YjewmLrxqrCKpwCy0F7SwPFcbCnM0A5awk7V0ZV1HD0swxKew/txusGwn/Ve8/6g+P3COf6wqpQOTJrNsf7MzanKR3SIZqufLB8p/CfL6lgcuLYBOmDYPz5B9EgtHo= sidebar_class_name: "patch api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -25,7 +25,7 @@ import Markdown from "@theme/Markdown"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; -

    Update a user task

    +

    Update user task

    +
    The user task was updated successfully. @@ -66,8 +66,12 @@ The user task with the given key cannot be updated. More details are provided in The user task with the given key was not found. -
    +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    The user task with the given key is in the wrong state currently. More details are provided in the response body. +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>