diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml index 118a72a22e..c500f78b61 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/api/camunda/camunda-openapi.yaml @@ -579,11 +579,10 @@ paths: schema: $ref: "#/components/schemas/ProblemDetail" - /administration/clock/pin: - post: + /administration/clock: + put: tags: - - Administration - - Clock control + - Clock summary: Pin the Zeebe engine’s internal clock to a specific time (experimental) description: | Set a precise, static time for the Zeebe engine’s internal clock. When the clock is pinned, @@ -615,7 +614,62 @@ paths: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + /administration/clock/reset: + post: + tags: + - Clock + summary: Reset the Zeebe engine’s internal clock to the system time (experimental) + description: | + Resets the Zeebe engine’s internal clock to the current system time, + enabling it to tick in real-time. This operation is useful for returning the clock to + normal behavior after it has been pinned to a specific time. + :::note + This endpoint is experimental and may undergo changes or improvements in future releases. + ::: + responses: + "204": + description: The clock was successfully reset to the system time + "500": + description: An internal error occurred while processing the request. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + /process-instances: + post: + tags: + - Process Instance + summary: Start process instance + description: | + Creates and starts an instance of the specified process. + The process definition to use to create the instance can be specified either using its unique key + (as returned by Deploy resources), or using the BPMN process ID and a version. + + Waits for the completion of the process instance before returning a result + when awaitCompletion is enabled. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateProcessInstanceRequest" + responses: + "200": + description: The process instance was created. + content: + application/json: + schema: + $ref: "#/components/schemas/CreateProcessInstanceResponse" + "400": + description: The provided data is not valid. + "500": + description: An internal error occurred while processing the request. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" /process-instances/search: post: tags: @@ -700,6 +754,58 @@ paths: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + /decision-definitions/{decisionKey}/xml: + get: + tags: + - Decision Definition + summary: Get decision definition XML (experimental) + description: | + Returns decision definition as XML. + + :::note + This endpoint is experimental and not enabled on Camunda clusters out of the box. + See the [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) + for further details. + ::: + parameters: + - name: decisionKey + in: path + required: true + description: The assigned key of the decision definition, which acts as a unique identifier for this decision. + schema: + type: integer + format: int64 + responses: + "200": + description: > + The XML of the decision definition is successfully returned. + content: + text/xml: + schema: + type: string + "400": + description: > + The Decision Definition Get XML failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: > + The decision with the given key was not found. + 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-requirements/search: post: tags: @@ -731,25 +837,35 @@ paths: description: > The decision requirements search query failed. More details are provided in the response body. - /authorizations: - post: + + /authorizations/{ownerKey}: + patch: tags: - Authorization - summary: Create an authorization - operationId: createAuthorization + summary: Patch an authorization + description: Manage the permissions assigned to the authorization + operationId: patchAuthorization + parameters: + - name: ownerKey + in: path + required: true + description: The key of the owner of the authorization. + schema: + type: integer + format: int64 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AuthorizationAssignRequest" + $ref: "#/components/schemas/AuthorizationPatchRequest" required: true responses: - "204": + "202": description: | - The Authorization was created successfully. + The Authorization was patched successfully. "400": description: | - The Authorization could not be created. + The Authorization could not be patched. More details are provided in the response body. content: application/problem+json: @@ -757,7 +873,7 @@ paths: $ref: "#/components/schemas/ProblemDetail" "401": description: | - The request to create an authorization was unauthorized. + The request to patch the authorization was unauthorized. More details are provided in the response body. content: application/problem+json: @@ -765,18 +881,23 @@ paths: $ref: "#/components/schemas/ProblemDetail" "403": description: | - The request to create an authorization was denied. + The request to patch an authorization was denied. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "409": + description: | + The request to add or remove permissions to an authorization was in conflict. + More details are provided in the response body. "500": description: An internal error occurred while processing the request. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + /users: post: tags: @@ -1131,7 +1252,7 @@ paths: $ref: "#/components/schemas/IncidentSearchQueryResponse" "400": description: > - The incident search query failed. + The Incident Search Query failed. More details are provided in the response body. "401": description: "Unauthorized" @@ -1157,6 +1278,48 @@ paths: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + + /deployments: + post: + tags: + - Resources + summary: Deploy resources + description: | + Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are. + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + resources: + type: array + description: | + The binary data to create the deployment resources. It is possible to have more than one form part with different form part names for the binary data to create a deployment. + items: + type: string + format: binary + tenantId: + type: string + description: The tenant to deploy the resources to. + required: + - resource + responses: + "200": + description: The resources are deployed. + content: + application/json: + schema: + $ref: "#/components/schemas/ResourceResponse" + "400": + description: > + The document upload failed. More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + components: schemas: UserTaskSearchQueryRequest: @@ -1281,15 +1444,54 @@ components: ProcessInstanceFilterRequest: type: object properties: - key: - type: array - items: - type: integer - format: int64 - variables: + running: + type: boolean + active: + type: boolean + incidents: + type: boolean + finished: + type: boolean + completed: + type: boolean + canceled: + type: boolean + retriesLeft: + type: boolean + errorMessage: + type: string + activityId: + type: string + startDate: + type: string + format: date-time + endDate: + type: string + format: date-time + bpmnProcessId: + type: string + processDefinitionVersion: + type: integer + format: int32 + variable: + allOf: + - $ref: "#/components/schemas/ProcessInstanceVariableFilterRequest" + batchOperationId: + type: string + parentProcessInstanceKey: + type: integer + format: int64 + tenantId: + type: string + ProcessInstanceVariableFilterRequest: + type: object + properties: + name: + type: string + values: type: array items: - $ref: "#/components/schemas/VariableValueFilterRequest" + type: string ProcessInstanceSearchQueryResponse: allOf: - $ref: "#/components/schemas/SearchQueryResponse" @@ -1302,14 +1504,11 @@ components: ProcessInstanceItem: type: object properties: - tenantId: - type: string key: type: integer format: int64 - processDefinitionKey: - type: integer - format: int64 + processName: + type: string processVersion: type: integer format: int32 @@ -1327,6 +1526,34 @@ components: endDate: type: string format: date-time + state: + type: string + enum: + - ACTIVE + - INCIDENT + - COMPLETED + - CANCELED + - UNKNOWN + - UNSPECIFIED + incident: + type: boolean + hasActiveOperation: + type: boolean + processDefinitionKey: + type: integer + format: int64 + tenantId: + type: string + rootInstanceId: + type: string + operations: + type: array + items: + $ref: "#/components/schemas/OperationItem" + callHierarchy: + type: array + items: + $ref: "#/components/schemas/ProcessInstanceReferenceItem" DecisionDefinitionSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" @@ -1448,12 +1675,29 @@ components: type: string type: type: string + enum: + - RESOLVE_INCIDENT + - CANCEL_PROCESS_INSTANCE + - DELETE_PROCESS_INSTANCE + - ADD_VARIABLE + - UPDATE_VARIABLE + - MODIFY_PROCESS_INSTANCE + - DELETE_DECISION_DEFINITION + - DELETE_PROCESS_DEFINITION + - MIGRATE_PROCESS_INSTANCE state: type: string + enum: + - SCHEDULED + - LOCKED + - SENT + - FAILED + - COMPLETED errorMessage: type: string completedDate: type: string + format: date-time ProcessInstanceReferenceItem: description: "Process instance reference description" type: object @@ -1501,25 +1745,45 @@ components: format: int64 tenantId: type: string - AuthorizationAssignRequest: + AuthorizationPatchRequest: type: object properties: - ownerKey: - type: string - ownerType: + action: + description: Indicates if permissions should be added or removed. type: string enum: + - ADD + - REMOVE + resourceType: + description: The type of resource to add/remove perissions to/from. + enum: + - AUTHORIZATION + - MESSAGE + - JOB + - APPLICATION + - TENANT + - DEPLOYMENT + - PROCESS_DEFINITION + - USER_TASK + - DECISION_REQUIREMENTS_DEFINITION + - DECISION_DEFINITION + - USER_GROUP - USER - ROLE - - GROUP - resourceKey: - type: string - resourceType: - type: string permissions: type: array items: - type: string + properties: + permissionType: + enum: + - CREATE + - READ + - UPDATE + - DELETE + resourceIds: + type: array + items: + type: string UserWithPasswordRequest: type: "object" properties: @@ -1953,7 +2217,6 @@ components: The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead. type: object - additionalProperties: true properties: retries: type: integer @@ -2060,6 +2323,8 @@ components: type: string eq: type: object + neq: + type: object gt: type: object gte: @@ -2225,6 +2490,233 @@ components: type: string format: date-time description: The date and time when the link expires. + + ResourceResponse: + type: object + properties: + key: + type: integer + format: int64 + description: The unique key identifying the deployment. + deployments: + type: array + items: + $ref: "#/components/schemas/DeploymentMetadata" + tenantId: + type: string + DeploymentMetadata: + type: object + properties: + process: + $ref: "#/components/schemas/DeploymentProcess" + decision: + $ref: "#/components/schemas/DeploymentDecision" + decisionRequirements: + $ref: "#/components/schemas/DeploymentDecisionRequirements" + form: + $ref: "#/components/schemas/DeploymentForm" + DeploymentProcess: + type: object + properties: + bpmnProcessId: + type: string + description: | + The bpmn process ID, as parsed during deployment, together with the version forms a + unique identifier for a specific process definition. + version: + type: integer + format: int32 + description: The assigned process version. + processDefinitionKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this process. + resourceName: + type: string + description: The resource name from which this process was parsed. + tenantId: + type: string + description: The tenant id of the deployed process. + DeploymentDecision: + type: object + properties: + dmnDecisionId: + type: string + description: | + The dmn decision ID, as parsed during deployment, together with the version forms a + unique identifier for a specific decision. + version: + type: integer + format: int32 + description: The assigned decision version. + decisionKey: + type: integer + format: int64 + description: | + The assigned decision key, which acts as a unique identifier for this decision. + dmnDecisionName: + type: string + description: The DMN name of the decision, as parsed during deployment. + tenantId: + type: string + description: The tenant id of the deployed decision. + dmnDecisionRequirementsId: + type: string + description: | + The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment. + dmnDecisionRequirementsKey: + type: integer + format: int64 + description: | + The assigned key of the decision requirements graph that this decision is part of. + DeploymentDecisionRequirements: + type: object + properties: + dmnDecisionRequirementsId: + type: string + description: | + The dmn decision requirements ID, as parsed during deployment; together with the versions forms a unique identifier for a specific decision. + version: + type: integer + format: int32 + description: The assigned decision requirements version. + dmnDecisionRequirementsName: + type: string + description: The DMN name of the decision requirements, as parsed during deployment. + tenantId: + type: string + description: The tenant id of the deployed decision requirements. + dmnDecisionRequirementsKey: + type: integer + format: int64 + description: | + The assigned decision requirements key, which acts as a unique identifier for this decision requirements. + resourceName: + type: string + description: The resource name from which this decision requirements was parsed. + DeploymentForm: + type: object + properties: + formId: + type: string + description: | + The form ID, as parsed during deployment, together with the version forms a + unique identifier for a specific form. + version: + type: integer + format: int32 + description: The assigned form version. + formKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this form. + resourceName: + type: string + description: The resource name from which this form was parsed. + tenantId: + type: string + description: The tenant id of the deployed form. + + CreateProcessInstanceRequest: + type: object + properties: + processDefinitionKey: + description: | + The unique key identifying the process definition, e.g. returned for a process in the + deploy resources endpoint. Cannot be used together with bpmnProcessId. + type: integer + format: int64 + bpmnProcessId: + description: | + The BPMN process ID of the process definition to start an instance of. + Cannot be used together with processDefinitionKey. + type: string + version: + description: | + The version of the process. Only considered when a bpmnProcessId is provided. + By default, the latest version of the process is used. + type: integer + format: int32 + default: -1 + variables: + description: | + JSON object that will instantiate the variables for the root variable scope + of the process instance. + type: object + additionalProperties: true + tenantId: + description: The tenant ID of the process definition. + type: string + operationReference: + description: | + A reference key chosen by the user and will be part of all records resulting + from this operation. Must be >0 if provided. + type: integer + format: int64 + minimum: 1 + startInstructions: + description: | + List of start instructions. By default, the process instance will start at + the start event. If provided, the process instance will apply start instructions + after it has been created. + type: array + items: + $ref: "#/components/schemas/ProcessInstanceCreationStartInstruction" + awaitCompletion: + description: | + Wait for the process instance to complete. If the process instance completion does + not occur within the requestTimeout, the request will be closed. Disabled by default. + type: boolean + default: false + requestTimeout: + description: | + Timeout (in ms) the request waits for the process to complete. By default or + when set to 0, the generic request timeout configured in the cluster is applied. + type: integer + format: int64 + ProcessInstanceCreationStartInstruction: + type: object + properties: + elementId: + description: | + Future extensions might include: + - different types of start instructions + - ability to set local variables for different flow scopes + + For now, however, the start instruction is implicitly a "startBeforeElement" instruction + type: string + CreateProcessInstanceResponse: + type: object + properties: + processKey: + description: | + The key of the process definition which was used to create the process instance. + type: integer + format: int64 + bpmnProcessId: + description: | + The BPMN process ID of the process definition which was used to create the process. + instance + type: string + version: + description: | + The version of the process definition which was used to create the process instance. + type: integer + format: int32 + processInstanceKey: + description: | + The unique identifier of the created process instance; to be used wherever a request + needs a process instance key (e.g. CancelProcessInstanceRequest). + type: integer + format: int64 + tenantId: + description: The tenant ID of the created process instance. + type: string + variables: + additionalProperties: true + description: All the variables visible in the root scope. + type: object + securitySchemes: bearerAuth: type: http diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-document-link-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-document-link-experimental.api.mdx index 548ef7a4a7..b84328c0b0 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-document-link-experimental.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-document-link-experimental.api.mdx @@ -5,7 +5,7 @@ description: "Create a link to a document in the Camunda 8 cluster." sidebar_label: "Create document link (experimental)" hide_title: true hide_table_of_contents: true -api: eJzdV21v2zYQ/isHfmoxWVLStE31zUvSLUPbBYm7AUvygZbOFluKVEkqjmDovw9HSn6JnTQbin1YgMCWebx77p5705I5Prcsu2anOm8qVM6y24gVaHMjaie0Yhk7McgdAgcp1FdwGjgUvTQIBa5EOOFVowoOx5DLxjo08Y26UVmWKe3wRk1KYQFVUWtBdyzgfY1GkAYuYzh3kDfGoHKyBa1kC7apa22cBa5AqFGFlTbt2qp12mAEi1Lk5Y0SFpR2UCFXDmbaQG100eSEHhqLsQdyo1jEam54hQ4NubxkilfIMjaoPS9YxAR5XHNXsogZ/NYIgwXLnGnwYVgmJcL5KeiZj8AKm9M+TjGLmM1LrDjLlsy1NVmyzgg1Z10XrYx7V9aWvzVo2i3TMy7tc217ZQOC7aOZ0dXTmG6DVbTuZ120JLEDItfKoXJ0xutaipwTnuSLJVDLXd16+gVzR4E3ukbjBFo6xftaGLRjtwsjYjNtKu6IFu5w5ESFbJ/3hU9JVQBJwKLEkIje8V4/uasaKflUYqCw6yLmhKPHVcJ/EOrrZfCbdR1JGLS1VjZgPUwP6GMPgCGy3uSCW8h9nRRgmzxHa2eNlC1h+EFRa4zcF69dZEOZbvIfsy767+L+WJz7AB+l6XNi6uNJRTzjQmIRw0fK7gIdF9ICN0iFficKLIY2NDAHU120sS/5R4JfGz2VWP20S8I2qjFcBMneLgRygFsIgtNg/fry/Qm8O3r99vZF6VxtsyRZLBaxmeUjLITTJtZmnphZTv8k9zKGSYkGoeItTBF4UQiyySWsaQdbYy5mIh/o7GEDkRf8ezpnwukTZDdG7NA8hs+X5yAKVE7MWqHmu6b9nRlvJOngU924bCo5Ebwi/nuZOgbbVBU37dDFtg10EbOOu2bDDSaUwzmaTfxCuVeHexP118nkAoIKyHWBfjI4GkS9IXKiEkpUTcWyozSNWMXvw9ObNO1IJzH+DE8UZb7kKmTrA3eEgmqdt94xoazjKv9RzGgj5uKh3e0i7JP4NHjUhTKs0JW6oHGnrU8dmnoZS4YqTJbrydglVJKWBgiau2GA+pbElqF4uixJlqW2rsuWNLy75I6YueNGUAf2RNJxKLIheaTOuSwDgF0S6YAG5eDces+4PLuawC/c4YK3Pqhkclv1cXqc7tVKoo9oHF+cQ/AwpOBGWxjUUn3vVRuEn6PYD1uLeWOEa6/oWgjPFLlBM26Ih1Vq9Pa8dnoOQizqv7wfEua3Pyeec2ppl+tBfnbPqzoU5Eb/Z4fp4dEoPR69Sifpmyw9zF6/jd8dvPkr5OdMewB99uy6QryiscH3ND7YzdSLc19wua6qRvmuq+awEK4EvmdbZBGTIkdlPc5+NRrEPoQT+CNYhIOYaA25NzTbuXBlM41zXSV5uLb6nEo9TSouVNKbsMnJ+OPnT6fj0Yfzk7NPV2ejgziN3b3z4aNiqLjaxBH23+3h9GJzhX350P/leu78j9bnPiEd3rukllwoSpZ+LQnN43q1TLOIZVuLdegft1HfA67ZcjnlFj8b2XX0c9h8qasUwlLDeGT33Qztv1+D97ryFdutjfyOy4akGJXr0Mf+IcQXl/0S/RK+/8KwF1X/I1ftJqQB7UaMu9suYiXyAo0HGQROApTRhNSsFexsovROEm6M8xxr96Ts7cb0uPj9akLdqH9pqHRBdwxf0GsMX7CM3bAbAqx9eHyj878vmeRq3vA5yQe99Pc3n4kHzg== +api: eJzdV21v2zYQ/isHfmoxWVLSdG31zUvSLUPbBYm7AYvzgZbOFluK1EgqjmDovw9HSn6JnTQbin1YgMCWebx77p5704o5vrAsu2FnOm8qVM6y24gVaHMjaie0Yhk7NcgdAgcp1FdwGjgUvTQIBa5EOOVVowoObyGXjXVo4qmaqizLlHY4VZNSWEBV1FrQHQt4X6MRpIHLGC4c5I0xqJxsQSvZgm3qWhtngSsQalRhpU27sWqdNhjBshR5OVXCgtIOKuTKwVwbqI0umpzQQ2Mx9kCmikWs5oZX6NCQyyumeIUsY4Pai4JFTJDHNXcli5jBvxphsGCZMw0+DMukRLg4Az33EVhjc9rHKWYRs3mJFWfZirm2JkvWGaEWrOuitXHvysbyXw2adsf0nEv7XNte2YBg92hudPU0pttgFa37SRctSeyByLVyqByd8bqWIueEJ/liCdRqX7eefcHcUeCNrtE4gZZO8b4WBu3Y7cOI2FybijuihTscOVEhO+R94VNSFUASsCwxJKJ3vNdP7qpGSj6TGCjsuog54ehxnfAfhPp6FfxmXUcSBm2tlQ1Yj9Mj+jgAYIisN7nkFnJfJwXYJs/R2nkjZUsYvlPUGiMPxWsf2VCm2/zHrIv+u7g/Fuc+wCdp+pyY+nhSEc+5kFjE8JGyu0DHhbTADVKh34kCi6ENDczBTBdt7Ev+keDXRs8kVj/sk7CLagyXQbK3C4Ec4BaC4CxYv7l6fwrvTl6/uX1ROlfbLEmWy2Vs5vkIC+G0ibVZJGae0z/JvYxhUqJBqHgLMwReFIJscgkb2sHWmIu5yAc6e9hA5AX/ns6ZcPoE2Y0RezSP4fPVBYgClRPzVqjFvml/Z84bSTr4TDcum0lOBK+J/1amjsE2VcVNO3SxXQNdxKzjrtlygwnlcIFmG79Q7tXxwUT9ZTK5hKACcl2gnwyOBlFviJyohBJVU7HsJE0jVvH78PRjmnakkxh/hieKMl9yFbL1gTtCQbXJW++YUNZxlX8vZrQRC/HQ7m4R9kl8FjzqQhlW6Epd0LjT1qcOTb2MJUMVJqvNZOwSKklLAwTN3TBAfUtiq1A8XZYkq1Jb12UrGt5dckfM3HEjqAN7Iuk4FNmQPFLnXJYBwD6JdECDcnBus2dcnV9P4GfucMlbH1Qyuav6bfo2PaiVRB/ROL68gOBhSMGttjCopfo+qDYIP0exH7YW88YI117TtRCeGXKDZtwQD+vU6O157fQchFjUf3k/JMyvf0w859TSrjaD/PyeV3UoyK3+z47T45NR+m6Uvp4cp9nJSfbqKE6P3vwZ8nOuPYA+e/ZdIV7R2OB7Gh/tZ+rlhS+4XFdVo3zXVQtYClcCP7AtsohJkaOyHme/Gg1iH8IJ/B4swlFMtIbcG5rtQriymcW5rpI8XFt/zqSeJRUXKulN2OR0/PHzp7Px6MPF6fmn6/PRUZzG7t758FExVFxt4wj77+5werG9wr586P9qM3f+R+tzn5AO711SSy4UJUu/loTmcbNeplnEsp3FOvSP26jvATdstZpxi5+N7Dr6OWy+1FUKYalhPLL7bof236/BB135iu3ORn7HZUNSjMp16GP/EOKLq36JfgnffmE4iKr/kat2G9KAdivG3W0XsRJ5gcaDDAKnAcpoQmo2CvY2UXonCTfGeY61e1L2dmt6XP52PaFu1L80VLqgO4Yv6TWGL1nGpmxKgLUPj290/vcVk1wtGr4g+aCX/v4GbdgHww== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -45,7 +45,7 @@ is not meant for production use. The document link was created successfully. -
Schema
+
Schema
The document link creation failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx new file mode 100644 index 0000000000..5e39ea64fb --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx @@ -0,0 +1,44 @@ +--- +id: deploy-resources +title: "Deploy resources" +description: "Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are." +sidebar_label: "Deploy resources" +hide_title: true +hide_table_of_contents: true +api: eJzVWVFz2zYM/is4PnU3RXa7rOu0Jy9ut2xNlkvc7SHNAy3BFhuJVEkqic+n/74DKdmSrSRu6ma3h14sEQTwAR9AgV0yy+eGRZfsHI0qdYyGXQUsQRNrUVihJIvYGItMLQwoiaA05Eoj6EYcXmA4D6HQKkZj0ASQYCyMUBJylWBmAtozUzo334UwSYUBYYBL4FblIoaYZ1kAIsQQUNgUNfAsa6nnGiFxDmBCmqTzYgY2xZwWw4+SBUzj5xKN/VUlCxYt3aPQmLDI6hIDFitpUVpaysvMioJrOyCfDhJuOb02cYq5+2UXBbKIqeknjC0LWKFVgdoKNF5zE6a1KNeaL9hm1CYpwlRIrhdARsAqiDVyi+R6DSlHaddYQzi2FJxCGSOmGdKWlN+gj7hNuXQpIL+BEMCtsCkkYjZDTYrWC5LnaOjZ2er3grd88EEUFvM2LmO1kHMWMFLMLYuY18SqKmAWJZf2OOmT3w6Elybr3qjza51kq0KndJ23y1Wk2VVV+TVTKGl85F8Nh/Rn21A/cULW4QAvikzEnLYNPhnauzsBrnHREhLS4hx1O0ZC2teHvUEopfhcIlzjAkSC0orZQsj5Bh1CVtHe5rGPZ5t5usfTuiQfF5wWuTzzwrvmk7Y0NQ/H4wC4IeYZTCApaVcLUQBWzdGVtiMs4b1B7VqE6wvAP8o6NnVcBLqWARxMgbGYiXhlLMGZkIJcIdJWAatVPZqUH171IuHGiLnEZGWg1ufyUL8br2z++fTsrwxd4yKA21TEKfDYGgodh378ltpl7YRzqKH3Kc9xt0w1O1xPgJlWeW27rRtuV/lzZp5U3CKp+/K6X69dJ6XCZrg6TogZNek84/2h8Thbk1yOa+FdHUxyuT6VnoWtjbU9c3QFok3S5uU+uLky8KUk3QDcStLuVB2fnHqWrmjkNTyYr73ydYViA8O5P5dcQ/4S0h2PN7GAbqmCueYFUYzbbhTdVwAd5Gr2MPitaLc93VOz+moIzsveBtB43aZxG8EXdYOnJqkf1yNt4pf724Rp+sQ99fKMbaKDqNMz+sP29bXaMfn8hdsx/xDSvTbLTpif2jm7rntC7Pu47/e4c/g/WKed2qx8tB6vUZLaNcVuhnmWI5ok91x3zvl2mdGL/+KT0WH7FgRyCL/Rx2LtdC8B3xHR+pdO0HI3xT88lbY3N3cd5/VIyfyEeXjfUJmouHSjellkiicw4yLDJIQT5WZMy0Xm581CqxuRYAJCNhOuMwBTlSz8kH3PGFpoNc0w/357HO26M4IzL1nbBV9zxAgvOPXWL8/fHcHPhz/+dPUitbYw0WBwe3sb6ll8gImwSodKzwd6FtM/knOXM6gRcr6AKQJPEjfx8AzW1byuHqscwNptoFh7fA+3Ar/6wA1DqcUWbUbw4fx4a2TumHZ7ZrzMSAefqtJG04zLa7bO+mPkHIEp85wuSmpidg1UATOW29I8tUv8PpmcgVcBsUqwM+CRIQKRCynyMmfR4XAYsJzf+afXw6H7QqKM74BEAt4VGZeOWptwhPT3SV6bAyaksVzG+8qM0mIuNu12K7sm8dgjqnz95WhTlbCIFco46nCbsogN2rchATOoqcWy6HLJSp2xiC19sVTRYLBMlbFVtCyUttXghjJxw7Xg08zzj5Z9UTVkyVTMs9Qb3E4aLbQ/c454XsqEwxs4f3sxgd+4xVu+8HcFSm+ofjN8M+zVSqL3aBydHYNH6CnXagONWqrnXrVeeBfFVXVFgYxLLezigrbVN0HINepRSXFfUaG257TTsxdiQf3jXUOQP/6ZuBwLOVNue53rbUdY68hlw/DlNq/Ojl15xCrPS+l6pJz7w563gMVZaSwBClgmYqROHi2ZdGfdyux7vwJ/118IL0NKimdO0xrnwqblNIxVPoj9ttXfaaamg5wLOahNmMHR6OTD6Xh08P746O3pxduDl+EwtHfWgSfq5ly2/PAn1fpichPscn0k/B9u2mtSWLyzgyLjwn1AuWgu64K97FxfXgV10V2y5XLKDX7QWVXR688l6gWLLq/WNUpPVcBS5AlqV+HuupUd+QgdTMg4iWclOdF3l18FzaZRHGNhW+Jb175UBaumc/bXxYRIXf8XAoWURa79Ob3B+ic5WVX/Ah4A34A= +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"; + +

Deploy resources

+ + + +Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are. + +## Request + +

Body

required
+ +The resources are deployed. + +
Schema
    deployments object[]
  • Array [
  • process object
    decision object
    decisionRequirements object
    form object
  • ]
+ +The document upload 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}}>
diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-experimental.api.mdx new file mode 100644 index 0000000000..292d74b74b --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-experimental.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-decision-definition-xml-experimental +title: "Get decision definition XML (experimental)" +description: "Returns decision definition as XML." +sidebar_label: "Get decision definition XML (experimental)" +hide_title: true +hide_table_of_contents: true +api: eJztWN9v2zYQ/lcO3EuCyZLTpV2nNyNJs2xJESTOVsDxA0WdLLYSqZKUHcPQ/z4cJdmO7W59KPbkB8P6cbz77u67E48r5vjMsnjCLlFIK7WCS8ykkk5qxaYBS9EKIyt/G7MHdLVRFtJeOF0LA7fw6e42fFbPKo5jpR0+q3EuLaBKKy2VA7p+qdDIEpXjBXCVgtIOUPGkwBS0ggte1irlIIraOjQWdO1AZ+ByhES/hM/qEdHfTXrR9/Bw9TiG0f0N6DmaucTF9CTilbQDp3VhI9EKDnglBwat23sw6NeFZfrT1xrNkl6dPqtMG8hq43I0kKLjsrCh9+5ZsYBV3PASCSWLJyumeIksZn1o/sQlC5ikqFXc5SxgBr/W0mDKYmdq3A3tOEfg1sqZwhS+4LL3+kCoA1jkUuTAhbMUdg61kl9rBJmicjKTaICgO4p+vz5kAbMix5KzeMXcsiKwUjmcoWEBy7QpuWsfvTtnTTMlwLbSyqKlFW+GQ/rbB/3p7vZfsFLSbS0EWpvVRbEE4ymEaehjKLRyqJyHhC8ueikLut4Dap2RasaapmkCdv4tKAc4DNfoPMSMywLTEO60wT6ZwA1CZfRcppiCVN6J3mtIdLrcQ8mrqpCCk+qoMjopsPz5syUE26hfQxvBfSvZ2QWdfEbhKHWtYNJanzx8uIDfzt/+Oj3JnatsHEWLxSI0mRhgKp02oTazyGSCfiR3GsI4R4NQ8iUkCDxNvdO8IK8qNE6iBVuhkJkU4LR3sIMNFNrWvy7ILSxi9nrxJgW7qdiiTG0k26XzCJ4ebnpCLqWa7Zv2azJeF6SDJ7p2cVJw9YU1AXPSFQeN7lqxdVlys66W1waagFnHXW3/k/K/vNnTTYT6fTy+h1YFCJ3ipqw6Q+REKZUs65LF58NhwEr+0t69Gw4b0kkZ/w5PFPXGgitPrV13pIJyw1vvmFTWcSV+VGa0kTO5azdkzSYXrCPxZetRX4rnh0tx3QoW0uVe50zOUfnOtuDW9/1M1+pYkceKPFbkD6zIt4c+jiMFFGVDPERjtAEtRG0MprSVKLx6+kT3tmmrgtYda+1Ya8da+1atNQEr0eU6ZTGboWcObfRjFvUfv8FmH2yj1dZk0PiNbsAsmnk/P9SmYDFbtWXUxFG0yrV1TbyqtHFNNKcczbmRNCv5lNLrttx6GhVa8MI/PpROekFDSu/mzgB1zR0u+NKHl0y+Vv1++H54UCuJfkMjjWSthy0ZtxpEr5Yq/aDaVvh7FPtRxaKojXTLR1rWhidBbtCMakrJmiSdPa+d7lshFnQXH3rq/PH32Gdfqkz75R0L9oFQVtDYFvkwPNtn3P2NLxyhy7JWvnuqWbst4luOdRMvlVQhBSrrud0Nlb3YbfsG/motwllISWmZ0zfNmXR5nYRCl/2gu/5PCp1EJZcq6kzY6GJ09/TxcjS4vbm4+vh4NTgLh6F7cd75SltXcrWFg4apQ0MeDVgn27P96W4YVpvPyPEUYfsUoSOmn36rgktFpeIzuur6yYQd6icsYPHrswZqKdOgawsTtlol3OKTKZqGHntELJ5MN13Et51UWh83Fme8sLvHEttpO3noDjBO4f84rDgYmO4hV0vfDYua7ljAvuBy5+ylmTYBy5GnaLyfrcRICKzc1tr1qQN1kXU7v76i8v8HwPqhVQ== +sidebar_class_name: "get 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"; + +

+ Get decision definition XML (experimental) +

+ + + +Returns decision definition as XML. + +:::note +This endpoint is experimental and not enabled on Camunda clusters out of the box. +See the [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) +for further details. +::: + +## Request + +

Path Parameters

+ +The XML of the decision definition is successfully returned. + +
Schema
    + +string + +
+ +The Decision Definition Get XML 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}}>
+ +The decision with the given key was not found. 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/create-authorization.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/patch-authorization.api.mdx similarity index 61% rename from docs/apis-tools/camunda-api-rest/specifications/create-authorization.api.mdx rename to docs/apis-tools/camunda-api-rest/specifications/patch-authorization.api.mdx index 2c16dbec10..33e744155e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-authorization.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/patch-authorization.api.mdx @@ -1,12 +1,12 @@ --- -id: create-authorization -title: "Create an authorization" -description: "Create an authorization" -sidebar_label: "Create an authorization" +id: patch-authorization +title: "Patch an authorization" +description: "Manage the permissions assigned to the authorization" +sidebar_label: "Patch an authorization" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SuYPbVTWpQTp3V5UxUldevEGlluD7IOILgSkZAAA4CWVQ3/e2cB0frueKY5SjMakcDiLXb3PZDaFTg+t5BMoFe7XBv5D3dSK5hGoCs0/uYmgwSEQe5w1ygCg99qtO43nS0hWYHQyqFydMmrqpDC28VfrFY0ZkWOJacrt6wQEtDpFxQOIqgMeXMSLc3qhULzJy63LK0zUs2hicLk2I/uz0aAqi4pmIf7wQgiGN3dDiCCj6O7hyFMG9qv1bUReAq8nT+O30RQoSmltVIruzXPjeFLiEA6LO2RdU0TgZOuoLGdFPaslXM1ClkMdpRSaTCDxJkaw54qrWxIzZvuFf1kaIWRla9CAuMc2Q4sW3DLQsUyZmsh0NpZXRTLzqOiKK663degCF0XGVPasRRbuM6j+qQNsgwdl4Vl3CCrjH6SGWZMKuZyZO2OWaoz7zI6xYzK6LTA8qdDhuzurceGwXLtlwXmMG5ZMEyD98noQ5/9evXul+kPuXOVTeJ4sVh0zExcYCadNh1t5rGZCfqS3Y8dNs7RICv5kqLkWSbJJy/YhpPMVijkTArmtA9wvW1GZQ7x/Teh3Qm6zrQpuYMEaiMhOoj5YXTDZIbKydlSqvmha79mxuuCMHiqa5ekBVdfYcO3Q6f7XmxdltwsmZ4dcdBEYB139TarpXI4R7O9f6nc2zcH2MSo38fjIQsQTOgM2Uwb5nJpW0cURCmVLEm5V91uBCV/Dnc/d7sNYVLFXxGJYvhcFVwF8u6FIxUrN7z1gUllHVfie1VGGzmX+347sK39NYnfh4gar/er7uVxLa7PVuJc0B7jivEDmdeqHTuL8yzOszi/szjf/i9xZqjkWZZnWZ5l+V1l+e7Y+2tPMcqyIR6iMdowLURtDGZskcvCw9OLcOt7LeHOWWlnpZ2VdlRpzT52//izjpKELtfUKKi09RTjLocE4h07CxFYNE9oqOWwgtoUkMAq6KpJ4niVa+uaZFVp45r4iYr2xI3kaRGoStNBfy2vCi14kQefh/WlCcVLbOPu87JWGWfXbDS4H7OP3OGCL32+yeUu9HX3unsUlUxPIPaGNyxEGNi5dWK0sCT9o7DB+DXATTOlRIraSLe8p2UhPSlyg4b+xG+xZu3Po9N9MIJoffGh5dIff489Hei0G236OoNnXlZBq5u+zIaKW+2Ytuuy02TZWO72VjbjOy2VSTs+9RKYaR/ImqCHKSF+oLEhh93O5aEYhjde00KXZa38wa7mbCFdzvhWikVRW0epjaCQApX18RJzttzehhn2V/DILjtEj8Dh9jyfS5fXaUfoMhZh2ctvWug0LrlU8dqFjfu9Tw+f3/cubm/6g8/3g4vLTrfjnp0vA+mo5Gp7HyfFtxPzS+EdPru4Krj0PR+/z9ValxPY0+U0WmtrAqtVyi0+mKJpaPhbjWYJyWS6kSLdNRHkyDM0Xshffan74TF64StM5kXtu2P7rcAmalf0hMDKnbDdefwS41/OmOHd/ZgIvG47ljqjtYYviGZ8AQk8wiMQOyvXtur8+AoKruY1n5N9wKXPv7ZER7E= -sidebar_class_name: "post api-method" +api: eJztWW1z0zgQ/iua/XTMuXEKhQN/M6mBQNvk8sLNXZthFHsTC2zJSHLTXMb//UaS3cZJgB7Dx3SmU0ta7evzbJztBjRdKgiuISx1KiT7l2omOMw8SFDFkhV2GcAl5XSJRKdICpQ5U4oJrghVii05JkQLe0ZbWjwQBUr73E8ggILqOA13RAoqaY4apXFjA5zmCAGIFUf5AdfgAePuagoeSPxaMokJBFqWuOvkJEXyBddELKwzVkezaHnWAQ9UnGJOIdiAXhfGJOMalyjBg4WQOdVu68UZVNXMWUalX4tkbe7Egmvk2jzSoshYbPX6n5VxZLOvXMw/Y6xNuNLkRDNU9m7sXN/sRNLniVGJirBFK+EqFWWWkDkSmiSYECGJxFzcYmJiqo0pLRlfggfIy9wW9/wcPBhFl4OPEcwqE40SpYxxYi/sWjd5NKpM7hpJU2GaJL6zZnxqXNLCX0iRd7btTSfvBqP+P+GkP7gCDy6j8Th8G4EH7wevwYNwOLzo95rTSXQVXk3Ag/NoeDH4+zKyi+Fo0IvG40/n0Zv+Vb8WnY6j0adJOP5gpXv9cX9w9WkU/TntjyJzb0f8XmRfydvRYDqsFyY3gwuXma1kb5WPSkktFjXmdr9dxodLTUKbTPRGUTiJbPJDU4Pp8Nytz6OLaNIuRj/5rsl2cSv744FmOjPbLVoNDdFGDrFgxdrEcUYLwZXz/2n36WEUtLSSFVXEchgToso4RqUWZZatOzccKg/Out3HaIktgrnQBsW1us4NvxQSSYKaskwRKpEUUtwyg3HGLYMbj8lcJNak9y0WFlLMM8x/32dj27eQDJ1kbZc4lhKqiBOcO+vXozc98urs+R+z31KtCxX4/mq16shFfIIJ00J2hFz6chGbXyP3pEMmKUokOV3XXGXGJs3IA3CIKjBmCxY3zbN221LPxff95qFrrO2y/r59lZLBbo8MyXTUJyxBrtlizfhy37S9s6BlZnTQuSh1MM8o/wIPcNs3umtFlXlO5X0vbhuoPFCa6lL9sP0+e7qn2yDq3WQyJE4FiUWCZCEk0SlTjSETRM44yw0Nz7pdD3J651Yvut3K6DQVf0QknOBdkVHuwLsTDuMkf8CtDYxxpSmPf1VlhGRLtmu3A9vUr0F87iJybeGse3qYi/XnmMGc5d7+h6OlecmbvSM5j+Q8kvMXk/PZI8lJ+QFuJsjZkZVHVh5Z+YtZ+eqHrKTJ1leu1hczc3iIrMy88PJFxmL9U4ytPHh+6L065MSUXxqCoJRCEhHHpZSYkFXKMqvZvKA3SamD6BxbwLEFHFvAwRZQeZCjTsX9qMpOp3QKAfgtYit/08ynKjNJQnnbjK9KmUEAG8edKvD9TSqUroJNIaSu/FtTmFsqGZ1nDo7m2HGswU4mYprZ7UM1NAdmRtbE1qN5yRNKXpJRNJ6Qt1Tjiq5tTo3JtuqX3Zfdg1qN6Dc0hsM+cRE6BG51hUatofdBtU74MYrtjE1hXEqm12NzzaVnjlSiNAOELWTU9qx2s3ZC4NUPbxq8vP9rYktuOtroYX4X3dG8cHxs5m/1hKw1/LnetCcz1w0iZ9XMInYhrE81nvajM6VGqZyBbud0H7vDvqVgLPK85LYP8yVZMZ0SupWtOCuVNlnyIGMxcmVdrweljdiFOyEfnUVy2jGVdnBs2u+S6bScd2KR+7G7dv93nom5n1PG/dqE8nvh5fTqPDy56Peiq3F0ctrpdvSdthkthNI55Vt+DA++r+6GvDU4/dmRco0BjXfaLzLK7EekjXNTs/Ua2mwFD4L7efLMqyl3DZvNnCqcyqyqzPbXEuUaguvZA0MtCBKmzHMCwYJmanfovB3Rb6N6yvaE/K9R9MGQmjEgX9uWkZVmBR58wfX2fNxiMUWaoLTeuuOe8+nEjiMfru+NqiuvuRHGMRb6G7KtVwPD1Ps+OQwnvXeGefVcPBeJuSzpykzr6QoCuIEbsP8K0M1Q1e5vIKN8WdKlkXeKzc9/GR92sQ== +sidebar_class_name: "patch api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null hide_send_button: true @@ -25,34 +25,42 @@ import Markdown from "@theme/Markdown"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; -

Create an authorization

+

Patch an authorization

- + -Create an authorization +Manage the permissions assigned to the authorization ## Request -

Body

required
+

Path Parameters

Body

required
    permissions undefined[]
  • Array [
  • ]
-The Authorization was created successfully. +The Authorization was patched successfully.
-The Authorization could not be created. +The Authorization could not be patched. 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 request to create an authorization was unauthorized. +The request to patch the authorization was unauthorized. 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 request to create an authorization was denied. +The request to patch an authorization was denied. 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}}>
+
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
+ +The request to add or remove permissions to an authorization was in conflict. +More details are provided in the response body. + +
An internal error occurred while processing the request. diff --git a/docs/apis-tools/camunda-api-rest/specifications/pin-the-zeebe-engines-internal-clock-to-a-specific-time-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/pin-the-zeebe-engines-internal-clock-to-a-specific-time-experimental.api.mdx index cd86c3cca8..18c9525a71 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/pin-the-zeebe-engines-internal-clock-to-a-specific-time-experimental.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/pin-the-zeebe-engines-internal-clock-to-a-specific-time-experimental.api.mdx @@ -5,8 +5,8 @@ description: "Set a precise, static time for the Zeebe engine’s internal clock sidebar_label: "Pin the Zeebe engine’s internal clock to a specific time (experimental)" hide_title: true hide_table_of_contents: true -api: eJztV91u2zYUfpUDXrWYIrld2nW689J0y7B1QeKuwOJcUNSxxZY/KknFMQwBe4293p5kOKQUO7GD9aKXMWDYFA/P73c+8WxY4EvPyis2rbU00gfHg7SGZexEWfEZhDXBWcWuM1ajF062cbtklxiAQ+tQSI8Z+MCDFBCkRlhYB6FB+AuxQkCzlAb//fsfD9IEdIYrEKQ7h48NmigZ1yA9tNIYrLO5kQEcai6NBx6ijG9RyIXEOhnhpobaogdjA/D6hhuBOcwsiIabJcYjJJjtGNCdD1Dh3CQzwJdcGljJ0AAHg6t4wAeu23xu5qYsS2MDzs2skR7Q1K2VJpCbeNuikxpN4CqHswCar6EzNbrl6IAH60Dq1tkbJEGKHhZd6ByCQ4Xco8+jjTll2+GXDn34ydZrVm7iUjqsWRlchxmjMqAJtMXbVkkRq1R88lSLDfOiQc3pX1i3yEpmq08oAstY62yLLkj0cXeMjxb36zlrEPCWi5DSKw1ga0UDWiolPQprag/BwqqRotnJqW9sp2qocKhdzrLRCSr3Eh3L2MI6zUN69PqY9X22E+HVjlvXGQsyKDod8XcuzUXKDOv7dMy31vgUzsvJ8eFAkmsr7sF3QqD3i06p9eAhRXEAUAcjzueG9Rk7nkwOGxqj2CIHWu64xoCOgKKl99IsKSmPlLB1tlKov9sv5X1rUzhPklBj4FJBKjFwD0mwwppiuLp4dwI/Hr/64fpZE0Lry6JYrVa5W4gjrGWwLrduWbiFoC/JPc9h1qDDiOEKgde1JJtcwRY8Y7LEmLzBbaBS5xHB/4O8uHuHTx+cNMtdZHROsoccM4UPF2cgazRBLtbSLPdNxzML3inSwSvbhbJS3Hymqg1I2jf60IrvtOZuDXZxwECfMSK3bieMR5D9/cs93YSRX2azc0gqQNh65Ediu2SIgiDy1Z1m5fFkkjHNb9Pq9WTSk06q+FdEYoiZFDcRWg/DkQa0dTjgJwYmjQ9EnN+oMtbJpXxoN4/tPnb1AOK3KaLU068OddfUbF8X6Jx1YIXoHPXaqpEqqqfOHm0PBPrUaU+d9tRphzutz5jG0Nialay1PkKHh4aVrOD3bn9FfH8WrSS0eXQ36OiOuGGdU6xkm9Q5fVkUm8b60Jeb1rrQFzdUlhvuJK9UAiNtpw4bkaOs4KpJ1vcrSBuGaxwjO+G6MzWHN3BxejmDn3nAFV/HjJLJ+6rfTN5MDmol0Uc0Ts/PIEWY8LfDCaNaau6DapPw1yju+2tKpOicDOtLOpbSUyF36KYdFeEOF4O9qJ3WSYhlw593I1p+/TiLBSc+u9heH09vuW6Hbtxe9yYRgwubHg83rD2PqXzofApxkr/YR+P5WWwqYbXuTGRWsxxv0Ft9QnU+UOQZU1Kg8dEdKuyO2d/SDvyZLMKLnKqXIDYS6lKGpqtyYXUh0rG730rZqqAJoRhM+OJk+vuH92+nR7+dnZy+vzw9epFP8nAbYpYI8JqbHT/OpfmaMYV4mO+wMt0Vn+0OAM8fZmmzfQM9jUnfdkwaWiTgbShaxWW8nUfIbAYuu2L84SQboyKyk4YGjMRJV2yzqbjHD071PT3+0qFbs/LqekthtOoz1iCv0UUC/IxrQnAq79GMvCFx1ZFXe5NZn40npkJgGx6RvXcxIaa4Y+nzPy5n1PjDVKhtTWcdX9HEyFesZHM2ZyxjNkIvckp8vmGKm2XHlySf9NLnP66YjVE= -sidebar_class_name: "post api-method" +api: eJztV91u2zYUfpUDXrWYIrtd2mW689J0y9AVQeKswOJcUNSxxJY/KknFMQwBe4293p5kOKQUO4mD9aKXMWDYFA/P73c+HW5Y4LVnxRU7VlZ8YdcZq9ALJ9sgrWEFu8AAHFqHQnrMwAcepIAgNcLSOggNwl+IJQKaWhr89+9/PEgT0BmuQJDOHD41aKJkXIP00EpjsMoWRgZwqLk0HniIMr5FIZcSq2SEmwoqix6MDcCrG24E5jC3IBpuaoxHSDDbMaA7H6DEhUlmgNdcGljJ0AAHg6t4wAeu23xhFqYoCmMDLsy8kR7QVK2VJpCbeNuikxpN4CqH0wCar6EzFbp6dMCDdSB16+wNkiBFD8sudA7BoULu0efRxsKwjDn82qEPv9hqzYpNXEqHFSuC6zBjwpqAJtAWb1slBacyTD57qsWGedGg5vQvrFtkBbPlZxSBZax1tkUXJPq4O8ZHi/v1nDcIeMtFSOmVBrC1ogEtlZIehTWVh2Bh1UjR7OTUN7ZTFZQ41C5n2egElbtGxzK2tE7zkB69PWR9n+1EeLXj1nXGggyKTkfcnUlznjLD+j4d8601PoXzenq4P5Dk2op78J0Q6P2yU2o9eEhR7AHU3ojzhWF9xg6n0/2Gxii2yIGWO64xoCOgaOm9NDUl5YkSts6WCvUPj0t539oMzpIkVBi4VJBKDNxDEiyxohiuzt8fw8+Hb366ftGE0PpiMlmtVrlbigOsZLAut66euKWgL8m9zGHeoMOI4RKBV5Ukm1zBFjxjssSYvMFtoFLnEcH/g7y4e4dPH5w09S4yOifZQ46ZweX5KcgKTZDLtTT1Y9PxzJJ3inTw0nahKBU3X6hqA5IeG31oxXdac7cGu9xjoM8YkVu3E8YTyP7x9SPdhJHf5vMzSCpA2GrkR2K7ZIiC0NJI3WlWHE6nGdP8Nq3eTqc96aSKf0MkhphJcROh9TAcaUBbhwN+YmDS+EDE+Z0qY52s5UO7eWz3sasHEL9LEaWefrOvu2Zm+7pA56wDK0TnqNdWjVRRPXX2aHsg0OdOe+60507b32l9xjSGxlasYG0XkcNDwwo24RVlxQeXOiW+PlnGPLobdDQFbljnFCvYJjVNX0wmm8b60Beb1rrQT26oIjfcSV6qhEPaTs01gkZZwVV8vK94tGG4xjGoY647U3E4gvOTizn8ygOu+Domk0zeV300PZru1UqiT2icnZ1CijBBb4cORrXU13vVJuFvUdz315RI0TkZ1hd0LKWnRO7QzToqwB0kBntRO62TEMuGP+9HoPz+aR5rTVR2vp0cT265bodG3E560wi/pU2Ph+HqkcdUPnQ+hTjNXz0G4tlp7Cdhte5MJFVTj8PzVp9QnQ8UecaUFGh8dIcKu2P2Q9qBP5NFeJVT9RLERi6tZWi6MhdWT0Q6dvdbKltO6HIwGUz4yfHsj8uP72YHH06PTz5enBy8yqd5uA0xS631QXOz48eZNN9yQyEK5juETGPii93Z/+XDLG22L5/nG9L3vSENLRLwNkxaxWUczCNkNgOPXbH7PEajwHh5TWx0xTabknu8dKrv6fHXDt2aFVfXW/KiVZ+xBnmFLlLfF1wTdlNhD+bkB4mrjvx5dB3rs/HETAhswxOy96YR4og7aj67nFPHDzdBbSs66viKbol8xQq2YAvGMmYj5iKZxOcbpripO16TfFJLn/8Ak7iAEw== +sidebar_class_name: "put api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null hide_send_button: true @@ -29,10 +29,7 @@ import TabItem from "@theme/TabItem"; Pin the Zeebe engine’s internal clock to a specific time (experimental) - + Set a precise, static time for the Zeebe engine’s internal clock. When the clock is pinned, it remains at the specified time and does not advance. To change the time, the clock must be diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-incident-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-incident-experimental.api.mdx index 05e81f4eab..eae915fddc 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-incident-experimental.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-incident-experimental.api.mdx @@ -5,7 +5,7 @@ description: "Query incident (experimental)" sidebar_label: "Query incident (experimental)" hide_title: true hide_table_of_contents: true -api: eJztWd1v2zYQ/1cIPq2YYytt2nV6c/OxeWtTL3G6BzcPFHWy2FKkSlJJPEP/+0BSsmVLju1hBQbMARLH5H3f747ScYENmWkcTvFIUBaDMPi+hxV8K0CbdzKe43DhvjIFMQ4TwjX0MJXCWNJwgUmec0aJYVIMvmgp7JqmKWTE7XL+McHhdIHNPAccYhl9AWpwD+dK5qAMA+04pHLSKiqiFJnjHmYGMn2InIQBjxuCtFFMzHDZw1LFoNo7PRxDQgpurFZNcVn2Gu5OK4H3PWyY4ZbvFoii6R8FqPmtVObGRwqX95YzJzM4yFwls4ZNTBiYgcI9nEiVEeOXXr209nOWMbMnrXY2DhOz5nErqOu2lUvGd5BIBYdwlp3xGZMZrOLT69DXwbSdoZ1rXjm4b7i/wnxnBN+c2QjmSlLQ+gISJpjF9u+Hso6ENkRQ2J/Rk3RANwOtK2C19hIuH69lDKNu1C+3K2u2kGlDTLf8LzI6wAMQRJgtOlKih9SwB/iYg3L9okEWScmBiDVQ1A3pyuV5vdA2aboAVPpa1rkU2uf/ZRDYjxg0VSz3JuBJCqgWg7wcpAtqc5gUHNUC+p8F/g6N79COYaQhfLRRh8/lJGFKG9upPhFegD6sH3DyT3mf6wg+oIe0hK0cm+HZtGeHnccGsWeDoAoc0ics61bz3+kgHrVrJOsFj1Z7O+HUbUhEDE2XUrZYuzVb20MFSkn14ZlkUpnlHAzEF90iGvWzMs9AZnmVlOacFHqZ6nZkxh6ZiFUUSEECCux/TcKdUXseS63S2ZfumnSCr+H0eL20bmrzWzG4AMp0Jzrqne8chLhSs9un2qAtTnUchtXGrmOybqqO8mzfo9Exo4QwDnEffZDKhsUQxjUiClCu5AOLIUZMIJPC8vhEkYzn9gx1uk7buu4EKUwqFfsL4u0Hba5kxCH7sX3grksborGnrIxDPkuI6CqJkTdxenN1jn4+e/3T/Q+pMbkOB4PHx8e+SugJxMxI1ZdqNlAJtb+W7kUfTVJQgDIyRxEgEscOm4SjVf6RzoGyhFFkpItCZTayWfYPEjtO+c7e0WiYhWLu1WXd57ubEXLJYsmciVlb9frrTiQLE0aciK94hZWuF6R1LbrIMqLmSCYdCqr+Vux+PHn1siXb4u3XyWSMvAhEZQwokQqZlOlakXUiY4JlRYbDsyDo4Yw8+W9vgsCVls34Hp4IBE85J8JBa9MdJlC2ArdzjDUa57+QGanYjG3q7W/2M7t44T2qK/VVG+9XUkUsjuGZZ9Rj6RxL539fOmdtvF9LgxJZiOOpcyydY+lsK53XXc+HI2FAWRBqUA+gkHt/OZbRsYyOZdRZRuWmbP8yxepXrB/gKQfFMhCG8Bc2VGBSGeMQ51I7oBGT4hAPag498BN7bEf3tgS1GyEWiuMQL3x9leFgsEilNmW4yKUy5eDBJu+BKEYi7iFrt30d1vjikhKeeq3tPNsNQTKo/T8nWSFigt6im8vbCfqFGHgkcxf3vLrZWYl+G7wNOqVa0i0Sh+NR1WQ8ShudoxZrW0CnWE+8j+DSDhg10EIxM7+1bD48ERAFaljY4C/RU+lz0t0AyhHhXvXPVY2p3/6cOFjYrnezule7fCJ2lrN+keHmj8G26WLQPTsMei1ALweCDYw35oAdq41pxWq3mlStFupZXtCc1K22uwZ0RhVgM+ZgMF3e0K2Yqos5f/t2v7pD83djwfLmK9i415oufLaaN1Z2rXTFnkiXqqoU20m3FQDKj4Bw0D9tl/145LoXlVlWCHeEiRl6ZCZFpAEiygttLHisnRTsQCVcYOGmOku17/0O+uQ1otO+LQBfpfXJNWMmLaI+ldmAerblZ8RlNMgIE4NKhR6cDz/cXV8MT96Pzi+vby9PTvtB3zz5CbrtFRkRDTt2tZk1z5cAN/BkBjknzA1tnLWLqgNN8bID4ToH9pLU95EpXiwiouFO8bK0y9+sfhxO71dtx36zI10gsU+mxz4+948OJxNrgyXnhZvjb162lL2aY0gp5OZZ2vtGJx1/vJ3YIq2utjMZWx5FHnHP/Q3xZ/wZW1y6eLj6d+sLzImYFb6svFz78zfQ0M3M +api: eJztWv9v4jYU/1cs/7RpKXB33XbjNw7SLVsLDOhNE1dVTvICvjl2znbaMsT/PtlOIJBQ2mmTJo1KLWC/b37v8x7Oe11jTRYKd+c44BGNgWt852EJX3JQ+oOIV7i7th+phBh3E8IUeDgSXBvS7hqTLGM0IpoK3v6sBDdrKlpCSuwuY6MEd+drrFcZ4C4W4WeINPZwJkUGUlNQlkNIK62gIlKSFfYw1ZCq18hJKLC4IkhpSfkCbzwsZAyyvuPhGBKSM220qghvNl7luPNC4J2HNdXM8E2ByGj5aw5yNRVST5yn8ObOcGZkAa8yV4q0YhPlGhYgsYcTIVOi3dK7t8Z+RlOqX0irrI29RO+duObUfds2W8YPkAgJr+HcNPpnTBaw84/XoK+B6ThDPdasOOBL3f0HrE568LtL48FMigiUGkBCOTXY/uW1rAFXmvAIXs7oSBqgm4JSBbBqewkTj0MRQ9CM+u12Yc0RMqWJbpb/WYSvOAFwwvURHUuiepGmDzDKQNp6USELhWBA+B4oyoJ0ZeO8n2iHNE0A2rhcVpngysX/badjXmJQkaSZMwHPloBKMcjJQSqPTAyTnKFSQOsTx/9C4XttxdBCExYc5OFzMUmoVNpUqo+E5aBeVw8Y+bu8z1UE59DXlISjHIfuObTnhJ3nAvHCAhFJsEif0bRZzX+ngjjU7pHsJzza7Z2EU7MhIdHRcivliLXN0fIw8Dw1N4uJPx1df/Tvg2E/GPjDGfZwvzfs+9f348mo70+n98FwOjMr2MMD/9qf+U07vcHg/mNvEvQ+XJuPt+NBb+ZXV25Gg+Dq92eEDvx+MA1Gw/uBfxUMg1kwGtY17u3dBD9Oek3m3B1Hwu7g0/5P/uD22h9gD1+P+r/YN1Pngate4Db6o5uxMWBgZYKUQt48g/JIpBkDDfHgiPIt1GKi4UIbGFerzS6YGlIjUAqh+yRX28So42js8hjRggJJSECCeVclPImx5zOvVmheSjckjalaOfR4vxBNSvNrPhhARFVjLpU7/7IT4kLN6TOVBh05VMPVodg4dakov4Is5eVLLxKWGSWEMohb6EZI4xZNKFOISECZFA80hhhRjvQStpcNFIp4ZW4cVtebuq5bTnK9FJL+CfHxa0kmRcgg/aZ+PdmX1kNjR1kYh1yUEFFFEENn4nxy1Uc/XH77/d1XS60z1W23Hx8fWzKJLiCmWsiWkIu2TCLza+i+bqHZEiSglKxQCIjEscUmYWgXf6QyiGhCI6SF9UJhNjJRdteuE3eiI5V2m/O5pPZBb//Mt5MA2WDRZEX5oq56/+EwFLnuhozwP/AOK02Pk/taVJ6mRK6QSBoUFOUyP32Ze/e2Jtvg7afZbIycCBSJGFAiJNJLqkpF5hAp5TQ1tfey0/FwSp7cp+86HZtaJuIvOAlH8JQxwi20Do9DOUp34LYHo5XC+Q9ERki6oId6W4f1zCwO3InKTH1Xx/uVkCGNY3jmRn9OnXPq/O9T57KO96HQKBE5P3/rnFPnnDrHUufbpvthwDVIA0IF8gEksg815zQ6p9E5jRrTaHMo2z1M0fIR6yt4ykDSFLgm7GvjKtBLEeMuzoSyQCN6ibu4XXKotptvYDPoMCmobMM1lwx38drl16bbbq+XQulNd50JqTftBxO8ByIpCZmDrNl2eVjii4mIsKXTWo+z2eAkhfL8fZLmPCboPZr40xn6kWh4JCvr96yYg+1Ev++87zRKNaRHJPbGQVFkHEorlaMUa0pAo1hH/BLBG9OOVRDlkurV1LA594RAJMhebpy/RU+hz0q37TpLhL3izVWJqZ9/m1lYmKo32U0h/SdiGjz7Yx/bre0c68V2mjutHa8G6G37tILxSte0YbXSrdjtFo2v3ULZ+exU+5q77aZ2ppY5mIhZGMy388wdUzHGdLPKu93E0U0SO9s5YedgCjhfu2hV53tmbWOTPRE2VEUq1oNuMgCkawHhTutNPe3Hga1ekUjTnNuvML5Aj1QvEamAKGK50gY8xs4ITEOlu8bcdnW2aq/dDvroNKI3LZMALkvLb64F1cs8bEUibUeObfsaMhG2U0J5u1Ch2v3eze1w0Lu4Dvr+cOpfvGl1WvrJzRtMrUgJr9hxqszsnXwLcA1Pup0xQm3Txlq7LirQHG8rEC5jYEbKro7M8XodEgW3km02ZvmL0Y+787td2TGfTAMcSOyC6bCP++7qcDEzNhhyltupx+FoauOVHL0ogkw/S3tXqaTj0dS0ZcPiHwFSERseSR6xZ/928Sf8CRtcWn/Y/Lfra8wIX+QurZxc8/MXElAiNw== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -41,7 +41,7 @@ The Incident Search successful response. Operation -
rootCauseInstance object
+
rootCauseInstance object
Process instance reference description @@ -49,7 +49,7 @@ Process instance reference description Decision instance reference description -
  • ]
  • +
  • ]
  • The Incident Search Query failed. More details are provided in the response body. 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 index f5aae87aa0..19b849a2ea 100644 --- 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 @@ -5,7 +5,7 @@ description: "Search for process instances based on given criteria." sidebar_label: "Query process instances (experimental)" hide_title: true hide_table_of_contents: true -api: eJztWFlz2zYQ/isY9CWZUkcSJ035pvho3eZwbSV9kPUAkUsJCQgwwNKyRsP/3lmA1Ek7UieP1oxGIrC72OtbYnfJUUwdj0f8ypoEnGOX2qHQCfBxxFNwiZUFSqN5zG9A2GTGMmNZURPLmtixiXCQMqPZVN6BZomVCFaK7q2+1XEca4Nwq4cz6RjotDBSI6P/9wVYmYNGoZjQKdMGGWgxUUHYqchLnQqWqNIhWMdMicxkDGfAJua+e6tvAPzTqCF9y67Pb4ZscHXJzB3YOwnz8bOeKKTroDHK9ZJA2BGF7FhwuLfQafi6efrL9xLsgrae32qyPCstzsCyFFBI5breulvNI27hewkO35l0weOlf5QWUh5nQjmIeGI0gkbaE0WhZCLIr72vjpy75C6ZQS78rlKfMh6PlhwXBfCYm8lXSJBHvLCmAIsSnOcw1kurqYS1YsEjLhFyd4ycTIJKNwQ5tFJPeRVxY1Ow+zuUGJkoFdKpLuFVFW2YO6oFjiOOEhWsMucfcuWNsXgdPMWrMXEWYgpHqWtNvqGT1AhTsDzimbG5wLD06iXpr2Qu8UBa53UcZLhl8Z5Tt3WrVozvIDMWjuGsWv1zJaaw9k/Ucl4L08MM+7FWtYGHuvsbLA6wqt2zb068xnfCSoK0O9w9u1pokUNrisL3Ft9GfIoPLEPrumonV63kGzH4Ulv2RagSLrxvV7HYpKuLa1NbdyjHj5C2RbkKgHOF0S6452W/Tz/b9Xo4A7Zb1VldxF2Z0HpWKtYI6voq9tOr1LHwRoNCXR6cXhHPpHVIZcUH4YgcIy8q8X95H4NvcOgx+H2QY9c9u/ociSMELTRetpf7bag/5vP6/X8GmdSSEuTvY1m/gHUy5NQBxXlS5LoBRrvuhbCg8Qg1PP2FMvOPJoUGHofzOxQWzwS2VKUN8lQgdFDm4EuVTo9heLgmEDoerS+tqeUZTo4tFF4Iy4RUkHbZB2OhufowYYEugncyhZRJ7a9hTTFhE5MuHq0ohTUTBfmv+5VlW7kBqUaU9bksZDYTjgXCSTh9dH1xyn4/ef3b+NkMsXBxrzefz7s2SzqQSjS2a+y0Z7OEvkT3vMuGM7DAcrFgE2AiTX0qC8XWmGGugERmMmFovIG12owiGOz7AeD87iMRL63kuzftAft8fclkChpltpB6un/09iVsYkqMJ0rob3ydFW3Xtu1TXJnnwi6aG/X2ASHJsfxxHX71ck82pdSfw+EVCyJYYlLwnQNSC1AfREbkUsu8zHl80u9HPBf34elNv1+RTIr4AZZo6iSU0D61ds2RmuXrvPWGNX3LT4qMsXIqd8/t7kKYFs+CRQGMr9vAONCMvGwpD8FaY5lJktJaSNl8JhU0vVdzdt12PGHtCWtPWHsIa1XEc8CZSXnMC+N86gic8Zj3ajh1VqOMXmjoOHV29g6s85fW0ioe82VAThX3esuZcVjFy8JYrHp3FJatPoe2A8KazFEmEWoWTt+PIG1Ql9NYtjPP+EMgzMXCe7SoG/+16Lf9t/1WqUT6gESakAQLQ/5t1IRGLIG7VWwgPkRwRVdaB0lpJS5uiC24ZwLCgh2UFIRVXtTneen0HIh4VP+5aLLlr3+HPuBUz67XY5fze5EXAY3rPtdfakf98VZ4Rk1HuU5F30g2neOqVWx6w1UzWFVjcpaPwGg1O1mLqUcmYS4yXk83wtSiv5pJ9HcmDqNlcNTmLIHWKo+gzHgv1fm9729KvuZCzfvdF/tYurr0JSExeV5q/17QUzaXOGNiI371nI2KhZIJ0L1x1Xyvjn0fdlh9hWcvupR7ASDN62AqcVZOuonJm/Ha6neizKSXC6l79RGudzr48Pnj2aDz/vL0/OPNeedFt9/F+9AuEVxzoTf0CFfS/RHks81p4vNdFyzXL8enSebjk8wajQj32CuUkJrqg4/vsi6bI75XNnmTvTT4C8VvxJdL8uZnq6qKlr0KPB5tgJGeqojPQKQBBgGw/DQEqzMkXYhclb7d3Z1JVFHDMUgSKPBR2vHGa+Dq082QKks9rs1NSjxWzGmUK+Y85rf8lhOifQL5ouXXl1wJPS09rnmQS5//AIz/EFU= +api: eJztWW1z4jgS/isq3ZeZOl6cTGZv1t8YIDu+SYADkq07QqWE3Qbt2pJXkkMoiv9+JcnGBuwErqbu00zVVIzU3Wr1q/RoixVZSuzO8EhwH6REHpOKMB/wvIEDkL6giaKcYRdPgAh/hUIuUJIR04xYogWRECDO0JK+AEO+oAoEJa0n9sRc12VcwRObrqhEwIKEU6aQ/n5NQNAYmCIRIixAjCsEjCwiK6xL4pQFBPlRKhUIiXiqEA+RWgFa8NfWE5sAmF+znPQLGvcnU9QZeYi/gHihsJ5/aJOEyqbiPJJt3xI2SUKbAqQ6GWjmfK04+NtfKYiNnvr4xPTOw1SoFQgUgCI0ki2zuyeGG1jAXylI9ZUHG+xuzU8qIMBuSCIJDexzpoApPUeSJKI+0XZt/yG1cbdY+iuIiZmNomGI3dkWq00C2MV88Qf4CjdwIngCQlGQhoMLIy2jIkKQDW5gqiCWl8gJKURBSZBUgrIl3jUwFwGI0xkdGCFJI6VXlT7e7Rql7c4ygfMGVlRFsI+cf2lTTrhQY2spvJtrzoQs4SJ1BY9LOlGmYAkCN3DIRUyUHfp0rfWPaEzVmbTS6NgJ1cGOT4x6qNtuz/gVQi7gEs5dpX1GZAmFfRoV61Uw1TOc+jrKNniuuUXKmHZ6sYMF5xEQpo1GfEVfoHqOMp8GwJSsng4po3IFQfWsz+MkAlU7rYtOVDcrQAkK8g5CVU0AQnBxD1JmoXcS+GZfVG286ryQigjVI6qCuRRaAVHQVDQGsyQLLmNYJDHLanKNFlkR7oE2pa4ljyAktdXkjIB/IYLqQntJMDASVxvshUQpyDPCP2cpR3K+zayZPGaK3ZpYLRWLBl4Q5a+GCQhTO+vsQgQwdST0O2zetcsvN5pdASNMVcqu1/lE13rSqrzd2RIqE86kNeO14+g/hx14ugJ03KdR1pZl6uvxMI1QLqhl+tIP7zuXFmzFFYm8ozh4ywMhFVLpRvF4blSVymNE/lfetwqyNeglFbmW49g8x/q8o+cx+59nB3ZWLwZ1OZzNX1ZFzihTJh3Pzz9Lfxvx9YAHcHn+/j+Ks1Q15MDSWB+BOt2p99jHDewNul6vP5jiBu4O70d3/Wm/p787g27/znw+DL4Phr8PzNdk1O96t16/h+elDlrdxFZEdkz73dfDarqTNvFDSmEDC85V7p0aEp5r9mZ8H9Y4VGzn3cypXvWsJmEH6h047k+Gd4/957L/jM+eR+Nhtz+ZPHuDyVSP4Abu9bVfq2Y6vd7zY2fsdb7e6Z8Po15n2i+P3A973u2/3xDa63e9iTccPPf6t97Am3rDwemKB3P33m/jTpU683Mid9L91u892NC8G3a/m4+JtcBtx7MTRSjPzzlO7U9zl2RZqbAWzlQQmxmfRNE3CkIX3M35wTU6urciASEI0F9lwncD7+2wP8m4c+lqSnP9WWKcq58Zpp7yXYLK5mUYbi49ihghKCQ0gqCF7rmA/LqMiAANHrzQAAJEmbm658cVtODB5s0zSyL4IoL476dnl0PlOlo1TZmti6wfEZGZmxd29dn4tot+vfn8j/mHlVKJdNvt9XrdEqHfhIAqLlpcLNsi9PV/TfexhaYrEIBiskELQCQIjONIhIoIQTIBn4bUR4qbDWZqI+1Wu793Dkw1tWmfJamg+Bid6aCHsYdMv6DhhrLl6dKHF/cFT5W7iAj7ExdRUXXVP1xFpnFMxCZHYQ4XyApM+v5J79P1iWwdUt+m0xGyIpDPAzBok9KwUbaQ3kRMGY11tbpxnAaOyav99Yvj7LRM7fEzdsI0+hQRZkLreDuUobiI25a9z2bA2I/xDBd0SY/XbR0nux7s2R3ZZPxclYwdhrSVhY5DU4wR9/1UCAjQekUjyPG6fO0MqvqZaz9z7Weu1eXaroFjUCseYBcnXJrQIWqFXdzO0qm5h7/bFgTEGg0ULyCkuRanIsIu3trM2bnt9nbFpdq524QLtWu/aLfkKIzxop62GZZHTsR9Eq3s6qce1BMaksl3doSB/0YUrMnGWDTJwOJC9Bfni1MpVZPWSNSout2hjb9STcjF6uSuFGuJzxG805dmCX4qqNpMNJs1zwKIANFJtRP2cZGtZ6Sbm48hwo3s4zaPln/+PjUO1/VsXED1/Veiz6aH2Oge81QihQLltL9KuKYdKJBM+7uEXWYDe7TS/j7AJ+3Q4RG6CPYyEFmMlq64+Nq5vmk6vzadz9Nrx725cT9dtZyrm//g0rX2LaKjC3yxSD286ByChxYULBhzLHCWD1Ujd6WVagE7p3wHLQOwJppn+7eLQlb2ZGHfJebF64J9NXD2bwLOEeI/29qgK2P5emxnqlHITcRlteI0dvWuc+tgp3V1WpdGnimvPo/jlJkey5ZoTdUKkVIuZO9cuvBG1Ad9Bi8MnJPd2RmU+QNdtXQe22KTt9YlVat00fJ5nD9v7f8uIr5ox4SydraEbHc79w+DXqd553X7g0m/edVyWurVglu69MWElfSwx/vTJ8AP5de8j8cm2BYHjZ8viW+/JGaVTcGraicRoQbGMf7dZi1ohk9aEM6jVz+82UYyw9uttuaDiHY7PWxUwO5sXk7gmU7PFZDApoEFFHHXOqs51bpkOa3T6hhB3jVyjo7vQ6LepJ2XWupoONGQwiJ7Lo15oHkEWeunVLLGLn7CT1hndLJHkMz4FkeELVNbKK1c/e+/Df+UZg== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -42,11 +42,11 @@ for further details. ## Request -

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
      variables object[]
    • Array [
    • ]
    +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
      variable object
    The Process Instance Search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • operations object[]
    • Array [
    • ]
    • callHierarchy object[]
    • Array [
    • ]
    • ]
    The Process Instance Search Query failed. More details are provided in the response body. 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 index 2badad0d77..4b7481ccc3 100644 --- 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 @@ -47,7 +47,7 @@ User task filter request. The User Task Search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • customHeaders object
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • customHeaders object
    • ]
    The User Task Search Query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/reset-the-zeebe-engines-internal-clock-to-the-system-time-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/reset-the-zeebe-engines-internal-clock-to-the-system-time-experimental.api.mdx new file mode 100644 index 0000000000..20134c6b31 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/reset-the-zeebe-engines-internal-clock-to-the-system-time-experimental.api.mdx @@ -0,0 +1,55 @@ +--- +id: reset-the-zeebe-engines-internal-clock-to-the-system-time-experimental +title: "Reset the Zeebe engine’s internal clock to the system time (experimental)" +description: "Resets the Zeebe engine’s internal clock to the current system time," +sidebar_label: "Reset the Zeebe engine’s internal clock to the system time (experimental)" +hide_title: true +hide_table_of_contents: true +api: eJztVs1uGzcQfpXBnBJ0rVXSpHX3ZjhJ6yJNDdtpgdo+cLmzWsZcckPOWhaEBfoafb0+STGkZMs/AXLIsQKE1YrD+Wbm+2bINbJaRKzO8dB6fYWXBTYUdTADG++wwhOKxBG4I/iLqCYgtzCO/v37nwjGMQWnLGjZC+yTmR5DIMcQV5GpBzY9FReOnKqtcQswnAyNvgLjIJCye2Iyg7PORPADBSXQYCKMkdrRQusDBOIxONmfIDZ4F8750CsLNXXq2vgAqmUKgtGpCDWRg8E4R41gKogDadManYKaXbgLV1WV80wXLqGTawZvHAs43QwUTE+OlQXlGujVCkbXUFh40J1yC4rgA5h+CP6axFAqAu3IYyAIZElFirOEceGwwEBx8C5SxGqNL+ev5HG/2Ge3uS1VhDhqTTG2o7UrCMLDtsQ7pcWpwNfz+WNfB+6OHwrBB/A6UdPAsjOWYAhe3G9rGujzSJFnWKD2jsmx+FTDYI1OjJRD8LWl/rtPUQDWGHVHvXoCGY6zJTTEyljw9SfSDCpCNqypkUqdn7w7hJ9evf7x8lnHPMSqLJfL5Sy0eo8awz7MfFiUodXyFbvnIhIKlKioCVTTGMFUVpIZKLChuENyLtYmbODVIJxjgfILK8xhYYF3myWZvLp9YuRg3AILbEVqjBWOweDDNjmAjydHYBpybNrVtqb3oNOeVo1WfKjaj1zVVrkrYZAN2ydBH6LEse9VWIFvnwCYCoyseNxJA0UDCwq78RvH37985Fu098vZ2TFkF6B9Q6n1WDpjAyRJ9MaZfuyxejWfF9irm/z2w3w+iU9h/CsycdJgVrnc7A/SMQ56H2ijn5SYcZGV09+KGR/MwjzEneF0xwVuRPwmZzTJp8CeuPMNVjj4mKSjuMMKS9VIWSLn4VWmJi5Tz2KBkcI1BZmyaxyDxQrXuXemqizXnY88VevBB57KayHmWgWjapvlKMu5x7basV4r22X8xxzKglM9bXM7VP3oGgX7cPL29Ax+VkxLtUo1Fcj7rvfn+/MnvYrpFzweHB9BzjArcGcqbN1Kez/pNht/jeNpupRC6jEYXp3KtlyemlSgcDAKDbfK2OAl7/KejbDY/Hi31cuvf54lyo1rfdq+of5xIMIKhZgjn89ePJbZ8VHqFu37fnRpZLoFLA13oHYS03aMLAkVaI0mF5Ogha8d2Pd5Bf7IiPBiJqRk5Wwn5cJwN9Yz7ftS5223z9r6uuyVceUGIpaHB799/PDmYO/90eHbD6dv917M5jO+4ZS8KLlXbieOk3zWfP2Rv3MewbPdg/P5wzqt7w6X/68W3+5qsdE90w2Xg1XGSScmwaw3I+oc748oOebTjS/dS4jl5pdHzTmu17WK9DHYaZK/P48UVlidX95NJnmbCuxINRTSXLuilXSB1jRwGmF2lIi+eH+Qdr4dpse/n0oj/geWt7IJ +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"; + +

    + Reset the Zeebe engine’s internal clock to the system time (experimental) +

    + + + +Resets the Zeebe engine’s internal clock to the current system time, +enabling it to tick in real-time. This operation is useful for returning the clock to +normal behavior after it has been pinned to a specific time. + +:::note +This endpoint is experimental and may undergo changes or improvements in future releases. +::: + +## Request + +
    + +The clock was successfully reset to the system time + +
    + +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 c3344584a7..5b981505ee 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js +++ b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js @@ -119,26 +119,20 @@ module.exports = [ }, { type: "category", - label: "Administration", + label: "Clock", items: [ { type: "doc", id: "apis-tools/camunda-api-rest/specifications/pin-the-zeebe-engines-internal-clock-to-a-specific-time-experimental", label: "Pin the Zeebe engine’s internal clock to a specific time (experimental)", - className: "api-method post", + className: "api-method put", }, - ], - }, - { - type: "category", - label: "Clock control", - items: [ { type: "doc", - id: "apis-tools/camunda-api-rest/specifications/pin-the-zeebe-engines-internal-clock-to-a-specific-time-experimental", + id: "apis-tools/camunda-api-rest/specifications/reset-the-zeebe-engines-internal-clock-to-the-system-time-experimental", label: - "Pin the Zeebe engine’s internal clock to a specific time (experimental)", + "Reset the Zeebe engine’s internal clock to the system time (experimental)", className: "api-method post", }, ], @@ -147,6 +141,12 @@ module.exports = [ type: "category", label: "Process Instance", items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/start-process-instance", + label: "Start process instance", + className: "api-method post", + }, { type: "doc", id: "apis-tools/camunda-api-rest/specifications/query-process-instances-experimental", @@ -165,6 +165,12 @@ module.exports = [ label: "Query decision definitions (experimental)", className: "api-method post", }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-experimental", + label: "Get decision definition XML (experimental)", + className: "api-method get", + }, ], }, { @@ -185,9 +191,9 @@ module.exports = [ items: [ { type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-authorization", - label: "Create an authorization", - className: "api-method post", + id: "apis-tools/camunda-api-rest/specifications/patch-authorization", + label: "Patch an authorization", + className: "api-method patch", }, ], }, @@ -251,4 +257,16 @@ module.exports = [ }, ], }, + { + type: "category", + label: "Resources", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/deploy-resources", + label: "Deploy resources", + className: "api-method post", + }, + ], + }, ]; diff --git a/docs/apis-tools/camunda-api-rest/specifications/start-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/start-process-instance.api.mdx new file mode 100644 index 0000000000..d5f6a798d5 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/start-process-instance.api.mdx @@ -0,0 +1,68 @@ +--- +id: start-process-instance +title: "Start process instance" +description: "Creates and starts an instance of the specified process." +sidebar_label: "Start process instance" +hide_title: true +hide_table_of_contents: true +api: eJztWF1v3LYS/SsDPiXoWrtO0zbdC1zAsZ173ebDsJ32wesHrjS7YkORCkl5vVjsfy+GpLT6susLpPepAQKvJHJmOHPmzJF2zPG1ZfNbdml0itbChbKOqxTZ3YRlaFMjSie0YnN2apA7tMBVBtZx4+gniLge9ApcjmBLTMVKYAZlsJgs1E2O9RVkuBJKkElwGiqL9Cf1pv3+xl7KFSzb9lC4HA1UVqg1CGehUuJrhfAFtwv1glsw6CqjMIPlFs6wlHoLBq2uTIr25QR0vZfcvL388LGJ6eLMH4rDPRortEoWaqF+5+RjpY1fn+qilOjDjgetNzcBL3GlDcYoyA8n95V0C7XJUQHfcOFOD3aEBVR8KTFLFopNmMGvFVr3VmdbNt/5S2EwY3NnKpywVCuHytEjXpZSpJysTP+wVJwds2mOBadfblsimzO9/ANTxyasNLpE4wRaehrDPmvK8Ct6d91aU8UO6QWRoXJita2zNyzmBDBZJ4cSUN54K0e0baGyXlUAVVZqoVwCp1wp7ajilcUMnF6jL/dGuByWZaEiQC9ituIphXK4RsMmbKVNwV249eNrtp+wzq7xM/Zh0KttF6we9D3MJwv1ZORj6e4cwDoj1JrCjeAbDzQ+7AWYwCclt5BqZUWGBjMISOsmjJBWGn0vMg+1t1s6F6+km3hbkrraPeKB9tKxnpH0718xogxvmc2PjulI3AhCuB0e6pfrTx8hYBRczh1shJQxs07UbNAYaBrRaO2a22BTXeJCPdKSnaCbfuBZ5ivB5WWrM6jJ9hPmUHHlHoNLePokUJKx0pIb365XuEKDRK8D+ydg6oe+59JcW1TEZeSosmg8Sfk0LRFKwqJeAZcSDKbaZDbSjVDrhVoZXYDLhYXGdwIfKutx+u8ZiFUbEs/opwkrhBJFVbA5Vdb3As0KU6VkfKTC74X1EYa2Ea21CfQxOCBTf8zYcG6h/GTxV3iPRBcXh/ifskBMuR2JYKH4yqEB4SDnFpaIKg6hbjq4MXzLJkw4LOxfkytKLHAcPu8qVxkEfHCoqM8sFGKdU1SprDKcLxTAEWRi5THggBzZ8fSFpXwppHBbT0zoQOqUy16/HKytpN6EZrE0295pA0pvJpDrDd6jCSkceKLmFwXNGuHkFjgsQt3f+kl3Hg67YO0tY9RGbSWcpFs1J8UieUkhtLruocnv6c3LYUppQje8MKg/yYqwGT1cRhe1xnqmKTfE5DpNq0DfYW5BnMw3okBdRcTGe00/plITTcKZsH6mU+NGiHcQtdRaIldtqlxxaYl7um5GGCg8gBdCQWFfdsPoqJX6nJ0cHHoOtImahJDjNMzCmdao0Ii0Meqiw1SrlVhXNF9iRlJZWd8/1reYeC6LtLEQ9GQPEVfBNdvv9z4jttTKhuZ6NZuNs/Kw9bltupl9a+X0qF4i0n5cP2xykeY+sqgS2qL3ycH1f5M4zwkxWag6yG+mYv7ONH3/ioIquyD7K8kb5a5AU0ca0TSI4F8UYa38NjkaYlMv/D2MF0ohZrajhCNGCS0vvGY+pWs53gcvn42E/1G4PHagUfnSkXGPy6f+C+OJlD0Rdy+sINlW8yppOT+VkoFOewZTBG6IVPH6CXbwMgEy7jgRlvICUoosobP9MLbvhDS+Q6O4BDRGmzATgsAWskFi/T4Uy/0E2ZRGLyUW3w1Jp68CL8NKyNBxIWuJzKlLaOEykPDt1btT+Pn1Dz/dvcidK+18Ot1sNolZpUeYCadNos16alYp/ad1LxO4IXxCwbeE2EMZ4UBz9dt2SrCOHeeDodqMq+kuR4anux6EWnitjGADnMDnq4uxd8yD6/a4ZHypKzdfSq6+sANKhk77XmxVFNy0SbrlIGhaV7VV3pPvOX2c/ffm5hKCCUh1hnEYh3cvcpS0NfTr2WzCCv4Qrn6czfZkkyr+jJMowIdScsV73yP8cUgc0HeIYM0frG7ub1QZbcRa9P0mfZ1HN8/CifahRQt0uc7YnJXaeuhwl7M5m8ZmOqrDtGzCLBoaFmx+u2OVkWzOdqFl9vPpdJdr6/bzXamN20/vqR4diqLHobVqyHh1nAe3w9LRA8WL5hvWKS8qlXF4A1fn1zfwH+5ww7c+leSya/rN7M1s1CotfcTiyeUFhBMG4LXIoDZLXT1qNix+juH9/o4SmVZGuO01bQvpWSI3aE4qyn4DiOjPW/c61S9ik/jjXQ2TX36/8ZUmIrs6fLE6f+CkMx//wjQbiJUDBhvNcHTcrWRnrh3Wj71Oz0bfSW8772TNSLsbebvwKnwowme+f1bap6qeR4Oktw/BZsnxsJMuLzwhpLooKuWnglqHT0S8VcSoq4kqpEiRxtt8xwibLbfvwxP4Laqp44QAGLqkHgZr4fJqmaS6mKZhW/N3KfVyWnChptGFnZ6efPj88ezk6P3F6fnH6/Oj42SWuIcwhKlZC65acfi3tYFy6B95dxiF/3w6/ps/HccedvjgpqXkQhGreEDsIsvesiHL3k0iU96y3W7JLX42cr+n218rNFs2v707tCNd7ScsR56h8Y31hdqanYYiH91QCLRcVv7DSf9Faz+pd5ykKZbuybV3rWFx+en6hmgofhYvdEZ7DN/QJ3O+YXO2YAvmWaH5EOXv75jkal3xNa0Pdunfn/fc2L0= +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"; + +

    Start process instance

    + + + +Creates and starts an instance of the specified process. +The process definition to use to create the instance can be specified either using its unique key +(as returned by Deploy resources), or using the BPMN process ID and a version. + +Waits for the completion of the process instance before returning a result +when awaitCompletion is enabled. + +## Request + +

    Body

    required
      variables object
      + +JSON object that will instantiate the variables for the root variable scope +of the process instance. + +
      = 1`"} schema={{"description":"A reference key chosen by the user and will be part of all records resulting\nfrom this operation. Must be >0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
      startInstructions object[]
      + +List of start instructions. By default, the process instance will start at +the start event. If provided, the process instance will apply start instructions +after it has been created. + +
    • Array [
    • ]
    + +The process instance was created. + +
    Schema
      variables object
      + +All the variables visible in the root scope. + +
    + +The provided data is not valid. + +
    + +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-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx index 09a0c2c212..a2e4866410 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx @@ -5,7 +5,7 @@ description: "Update a job with the given key." sidebar_label: "Update a job" hide_title: true hide_table_of_contents: true -api: eJztWNtu20YQ/ZXFPiUtTSmpkybsk+o4TdIkNXxpH2wDWXKH0jp7YfYiWRAI9Df6e/2SYnZJXSy5Mdo8KoARkbszszNzzpA8C+rZ2NHikr4zJb3OKAdXWdF4YTQt6EXDmQfCyI0pyUz4CfETIGMxBU0+wzynGW2YZQo8WPSyoJopoAW9MeWvMKcZFeimYX5CM2rhSxAWOC28DXA31vkE0CcxdQyCEb0hIZ4AA7lqAorRYkH9vMEYQnsYg6UZrY1VzKdbzw9p216nYOD8z4bP0eZu7MpoD9rjEmsaKSqGxxjcODzLYjuYKW+g8pivNQ1YL8DhajVhegwOoqPNfN6d/faRJLNUurSXx8yY91aUwQOZMhnA5Vf6SmMFaiOlmQk9Xm1xpGKalEAYvwnOA+87IRwBzRsjtM8I41xgZCbXLK/0TEiJtmKsjQVeYJzvyCcL3gpwn8gBwagaZoQpE7TH8neLpDa2b8VPRAXn4yFIY5zwYgpEB1WCzaNDLxSY4HuHPNhY0L6bGKDbQoQmymXEeWY9Jlpbo+KmKlgL2hNlFGgfS3JizVTwWA7dQcM4WK9NrAUjOkiZakmMJUYJH30LTxoLDuwUXIzRgHUiFnHp4+8//3LJdNkFbFHFtDYx5cqoRgLaGEtqJuQ9LQgOUh7d/uimM4m/+62OCO08MJ5faZptQWzVypM1sCXcbsKv69RXSfHDU7qLbv+r7TSjWHRWSkiHazPatfghJN11nm+Bmu1jxXN5vMQhd7RkLC6sxsLlGpevNyzSEDxN84S2bbJzjdEulf7p8HCb/j2MZsx1Q4wTF6oKnKuDlPOcthk9HA53WzYR98AJZ54R4QhCccqk6CBzz/hqrCklqO+3x9hmiBE5STsJB4/o7OYUcyRtLIFjxS9PXx+Rl4fPfrx+NPG+ccVgMJvNcltXB8CFNzY3djywdYV/uO9xjvS3QBSbp5G1nEor5BLXQCVqUeGA9ynbeBjEzG5KbMI+rS4x5rwVerwOsWDFFsBG5OL0LREctBf1HCG0FTra1CxI9MFKE3xRSqY/0xWEtoPejeKCUswun2ObAdqMOs98+M+UfXN+fkKSC1IZDh1bhesDYRJKaKGCosXhcJhRxW7T1fPhsEWf2PEHZKIJ3DaS6Q1K9ukgHY2FDj8xMZxpTFffqjPGirG4Gzen63TuQPwqZZSYefivZOxfYdL7SU+s2gTN8z2t9rTa0+peWr18AK2WXwbILKHjvZk1ehxru3xWy3lOPqzSdITZtUdeZ9c/Yklp+Hz/1NvTc0/P++n5bNeL5EgTrLJFHIK1+F1URQZyMpsIGd3j+2gfu/tk3nNtz7U91+7jWptRBX5ieNK1qknUwPyEFnRwY0o3WKR3yxYlK9QdOmEsWEkLukh8aYvBYDExzrfFojHWt4MpNmPKrMAP19g7XE686vEiTcVkvL2rb7iA6lufzxFTQXNGXpDT47Nz8gvzMGPpsxNDbrp+MXwx3OkVt97jcXTylqQME+rWJkHvFim9023a/BDHUcxzUAUr/PwMzVJ5SmAW7Chg5Zdo6OJF73idNtGs+/G6x8i7P85jm3GKna6EwuNbhsrNlrC3lFmGaxLHsI2IrE2M3+FlOxNsK2pOMfVh/mQbmydvI8Uqo1TQcc7qcS9rrfxVErW/KLtIUYF28Zid3Npve59WyO8pInmSY1cT9PrxOhZ+Esq8MmpQJbPl/6U05UAxoQddCDc4Gn24+PhqdPD+7dHxx7Pjgyf5MPe3STxpjPOK6bVzrOvFdxNdrB4pD9GVu456uPWDRjKhEWMxk0XHt0tUmR3NaNGpzddZR5pLuliUzMGFlW2Lt78EsHNaXF6vOBZJyYXD35wWNZPuriS9fuJHp51S9Jh8TajeefLuJtPzyHMZ8Ipm9DPMV3J5e91mdAKMg43HS4tH6RAH5+hiZbwlW7dZbzGqKmj8PXs3nuBIruU4OxmdH71BsnSauTIcjS2boXjPZrSgV/QKT21ihZIEifcXVDI9Dmwctf/oGP/9AwSTcGI= +api: eJztWNtu20YQ/ZXFPiUtTSmpkybsk+o4jd0kNXxpH2wDWXKH0jp7YfYiWRAI9Df6e/2SYnZJSbbkxmjzqABGRO7cZ86QPAvq2djR4pIem5JeZ5SDq6xovDCaFvSi4cwDYeTGlGQm/IT4CZCxmIImn2Ge04w2zDIFHixaWVDNFNCC3pjyV5jTjAo00zA/oRm18CUIC5wW3ga47+t8AmiTmDo6QY/ekBAjQEeumoBitFhQP2/Qh9AexmBpRmtjFfPp1st92rbXyRk4/7Phc9S577sy2oP2eMSaRoqKYRiDG4exLDadmfIGKo/5WtOA9QIcnlYTpsfgIBq6m8/x2W8fSVJLpUuyPGbGvLeiDB7IlMkALr/SVxorUBspzUzo8UrEkYppUgJh/CY4D7zvhHAENG+M0D4jjHOBnplc07zSMyEl6oqxNhZ4gX6+I58seCvAfSJ7BL1qmBGmTNAey98dktrYvhU/ERWcj0GQxjjhxRSIDqoEm0eDXigwwfcGebCxoH030UEnQoQmymXEeWY9Jlpbo6JQFawF7YkyCrSPJTmxZip4LIfuRsM4WK9NrAUjOkiZakmMJUYJH20LTxoLDuwUXPTRgHUiFnFp4+8//3JJddkFbFHFtDYx5cqoRgLqGEtqJuQDLQgOUh6dfDTTqcTfvagjQjsPjOdXmmZfGbGuG18d/B+e022Q+l+tpRnFwrJSQgJOm9GujY8B4rZ4vsVkbIYV4/J4iYvsYIlKPFhB/3INr9d3NNKiO007g7Zt0nON0S6V/vlwfxPi/ajMmOsWFScuVBU4Vwcp5zltM7o/HG7XbOJsAyeceUaEIzhuUyZFNxYPrKjGmlKC+n5zVd11MSInSZJw8DiB3S5ijiTBEjhW/PL07QF5vf/ix+snE+8bVwwGs9kst3W1B1x4Y3NjxwNbV/iHck9zhLgFotg8raXl5llNLnENVKIWFS5xn7KNweDMPGbs0+lyxpy3Qo/XRyxYsTFgI3JxekQEB+1FPccR2nAddWoWJNpgpQm+KCXTn+lqhDad3vfiglLMLp9Vdx20GXWe+fCfIfvu/PyEJBOkMhw6tArXO8IklNBCBUWL/eEwo4rdpquXw2GLNrHjj8hEE7htJNN3INmng3A0Frr5iYnh3mK6+ladMVaMxX2/OV2HczfEb1JGCZn7/wrG/jUlvYP0wKpN0DzfwWoHqx2sHoTV60fAavn2j8gSOt6bWaPHsbbLZ7Wc5+TDKk1HmF175HV6/SOWlIbPd0+9HTx38HwYni+2vUiONMEqW5xDsBa/faqIQE5mEyGjeXwf7X13n8U7rO2wtsPaQ1hrM6rATwxP3FU1iTyXn9CCDm5M6QaL9G7ZIi2F3EJHfgUraUEXCS9tMRgsJsb5tlg0xvp2MMVmTJkV+OEae4fHCVf9vEhTMRlvb+sbHiDD1udzwFTQnJFX5PTw7Jz8wjzMWPrsRJd3Tb8avhputYqiD1gcnRyRlGGaurVN0JtFSG81m4QfYzgSdg6qYIWfn6FaKk8JzIIdBaz8cho6f9E6XichmnU/3vYzcvzHeWwzbrHTFRl4eMuQndkg75Y0y3CN4hi2cSJrE/1387KZCbYVeaWY+jB/tjmbJ0cRYpVRKui4Z/W4p65W9iqJ/F6kXaSoQLsYZkep9mLv0wn5PXkkz3Lsahq9fr2OhZ+EMq+MGlRJbfl/KU05UEzoQefCDQ5GHy4+vhntvT86OPx4drj3LB/m/jaRJ41xXjG9Fsc6J3w/0cXqkfIY7rjrqIdbP2gkExpnLGay6PB2iUyyoxktOkb5OutAc0kXi5I5uLCybfH2lwB2TovL6xXGIii5cPib06Jm0t2nndcjfnLaMUVPydfI6K2RdzeZnkecy4BXNKOfYb6ixNvrNqMTYBxsDC8dHqQg9s7RxEp5g5pus15jVFXQ+Adk7zzBEVzLdXYyOj94h2DpeHFlOCpbNkOCns1oQa/oFUZtYoUSBYn3F1QyPQ5sHPn9aBj//QNn9mWy sidebar_class_name: "patch api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -47,7 +47,7 @@ Providing any of those attributes with a null value or omitting it preserves the The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead. -
    +
    The job was updated successfully. diff --git a/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx index eee13263fa..05b6c356cd 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx @@ -5,7 +5,7 @@ description: "Update a user task with the given key." sidebar_label: "Update user task" hide_title: true hide_table_of_contents: true -api: eJztWW1v2zYQ/isHftmbLKtZkrX65qVdm67tgsTZgCUBSktnm41EqnyJYxj678ORki2/pMm67psLBHVM3gvv7nmOOS6Y5RPD0it2aVCD5eaW3UQsR5NpUVmhJEvZZZVzi8DBtXtgJuwU7BRhIu5Qwi3OYxaximteokVNGhdM8hJZykhqyM3t7zhnEROkseJ2yiKm8bMTGnOWWu1w0+xwiqQY1NhbWhm3Cpx3iWyabIolZ+mC2XlF5oS0OEHNIjZWuuQ2fHV8yOr6JphEY39V+ZxkVh6MeWEwYpmSFqWlNV5Vhcg4edP/ZMilxbY1NfqEmaWza1WhtgINrWZTLido0CtaP9bbiz8+QBALYQx783A2bq0WI2cR7njh0MTX8lpSJMaqKNRMyMlqi4GMSxgh8PyTMxbzNi3CAMq8UkLaCHieCzLNi47ktZyJoiBZMZFKY56SnR/hY8ZlLii2r7VylfkIPdB0DhjNodLqTuTeBQlYVnYOhTB2XY7q6OliucOX3OJj+y+sFnLiJUIcLqt/KVZpobSwcxIphRSlKyGJoOT3/uOzJIkgxzF3hYWjhIJx1tHXFKEy2I2+jzaHj9IVxceQL1AaVCmsJTlhoSL39B0FnGq4Qm2Ez9RSzXcmSC4TzY0RE4lIyZXKPppfZ9DjY+DlQhW1qzGp9LuN01QvSmuqO7xDaQFLYYxQEsZKd8yG0o2vJYu2qpyOykcFtohdFddZp/7D2joimkx3oGN8dro4pfrpWVEi28UFuUPwRNQQAp00hvNH8x9v+V2TzVUZ/Qefgpqeq76dZ+tI6vjGtebznV4QnMj2UtSTpXm6O6SAnBEWS7MdjvpLbgai+Eo/J174f3W0Rf6jLeLng51Ot/JrTrKINSzC0oSkPHOw9CiJWMMpLCVS2fSnjpgVln5lJ8seUUeMZ8HkZrcYQOaMVSWEDQ3L2Cmn5hEYnGcZGiNGBcJYq7LTKD3MDVGkKzwj+fU1/gAh71RocjGcjoEYJ8Qd84gYzFtpmdEquGah916zNYZYAufh814294BwnTgPjZjVNe3RaColTaCKg+RwOxDDtSvAjJvmDpCDcT4AY1cU85hieZgkj8pv3V86dNsojuG90gg5Wi4KA1zjMjIgpJdu3YaRyuchHg9cICqtRgWWP21fJDbzfRZ2NnbbmwI3EDaOgvWr899O4MXh0S8330+trUza789ms1iPsx7mwiodKz3p63FGP7TvhxiGU9QIJZ+HnrK8FqyIGkyFmRiLjDLtG1bjDGV5d0dYZ/mw+gU6dVpsoWwAl+enIHKUVoznVKdbplkHY4yPlLPpqODylq3qa9vophXjypLrJZDXDdQRM5ZbZ76WJ94Mh2cQVECmcvRd1WOtMbRGGodJlymOk6QmnZTxJ5xEAt5XBZe+tDaPIySUq7r1BxPSWC6zb5UZpcVEbNqNWRfrTRG/DCcKGD98Aqy3YUlIJ1yOlZN5vAfYHmB7gD0IsBdfATBh2m4200pOfIQRMqc1SlvM911wD9I9SL8dSI92XU4HEijKmuoQtaYhQuYRmMNsKgqv3l/yG9vNFGuPtT3W9lh7CGt1xEq0U5WHgXM29RNqO2Up61NH7FFHNP1FZz5d00CZ5nXNBNvpgqVsEaBTp/3+YqqMrdNFpbSt+3eUlzuuBf3B69NIywFibekUKuOF/3pXCmmBxuTt0U546WTO4Tmcv7oYwmtuccbDX7Vkcl318+R5sntkobR9QOPg7BTCCUMBdkihVUvo3qk2bH6KYj9qN5g5GpxckFgIzwi5Rj1wlIRlYTT2vHb6PWxiUfPht7Zc3v419BknQjtfjfFf3fOyCnBcn7q3A0d2kBwc9pLnvZ+TYXKcJgfp0S/xi+T4b7Y5BvzSzs2x3FVb0Dc7ZmHdxdX86SjpDHo6Iyshx8rHox0MbUWWyoxGx14wiZ9tw+bs1KM/U2XppG8BctIOqFf6soLmyJp4oRAZSuPD1rzTtNvehRX4M1iEZzFVWYBCy/wTYaduFGeq7GdBbPn/qFCjfsmF7DcmTP9k8P7yw8tB793pyasPF696z+IktvfWZ7NSxpZcdvxonpuWl9bNwy5WHe/pT1NNrVm8t/2q4EJS4P2ZFg0pXLEVKbCIpd1nq5uoQfYVWyxG3OClLuqavv7sUM9ZenWzIgLPHLkw9Hn1sPTgEb4/b96gfoCnvXjtPEo7e5VzT0mFo99YxG5xvvEEV9/UEZsiz1F7T8OOk+BPb0h6Vhq23sDqqJUYZBlW9oG9a5cPIoMlE58NhidvCNzNC1ypchLWfEYPgnzGUnbNrsl15YPlecN/v2AFlxPHJ7Q/KKZ//wDfWfoK +api: eJztWW1v2zYQ/isHflm7ybKSOV2rb17abdlLFyTOBiwJUFo622wkUuNLHMPQfx+OlGz5JU3Wdd9cIKhj8l54d89zzHHJLJ8all6zK4MaLDd37DZiOZpMi8oKJVnKrqqcWwQOrt0Dc2FnYGcIU3GPEu5wEbOIVVzzEi1q0rhkkpfIUkZSI27ufsEFi5ggjRW3MxYxjX87oTFnqdUOt82OZkiKQU28pbVxq8B5l8imyWZYcpYumV1UZE5Ii1PULGITpUtuw1evBqyub4NJNPZ7lS9IZu3BhBcGI5YpaVFaWuNVVYiMkzf9j4ZcWu5aU+OPmFk6u1YVaivQ0Go243KKBr2izWP9fPn7ewhiIYxhbx7Oxq3VYuwswj0vHJr4Rt5IisREFYWaCzldbzGQcQljBJ5/dMZi3qZFGECZV0pIGwHPc0GmedGRvJFzURQkK6ZSacxTsvM1fMi4zAXF9ketXGU+QA80nQPGC6i0uhe5d0EClpVdQCGM3ZSjOnq+WO7wLbf41P5Lq4WceokQh6vqX4pVWigt7IJESiFF6UpIIij5g/94lCQR5DjhrrBwklAwzjv6miJUBrvR99Hm8EG6ovgQ8gVKgyqFtSQnLFTknr6ngFMNV6iN8JlaqfnKBMlVorkxYioRKblS2Sfz6wx6fAy9XKiidjUmlX63cZrqRWlNdYf3KC1gKYwRSsJE6Y7ZULrxjWTRTpXTUfm4wBax6+I679R/WNtERJPpDnSMz04Xp1Q/PStKZPu4IHcInogaQqCTxnDxZP7jHb9rsrkuo//gU1DTc9WX82wTSR3fuNZ8sdcLghPZXol6sjTPd4cUkDPCYml2w1F/ys1AFJ/p59QL/6+Otsh/skV8e7zX6VZ+w0kWsYZFWJqQlGcOlp4kEWs4haVEKtv+1BGzwtKv7HTVI+qI8SyY3O4WQ8icsaqEsKFhGTvj1DwCg/MsQ2PEuECYaFV2GqWHuSGKdIVnJL++wR8g5L0KTS6GswkQ44S4Yx4Rg3krLTNaBTcs9N4btsEQK+A8ft6r5h4QrhMXoRGzuqY9Gk2lpAlUcZwMdgMx2rgCzLlp7gA5GOcDMHFFsYgploMkeVJ+5/7SodtGcQy/KY2Qo+WiMMA1riIDQnrp1m0Yq3wR4vHIBaLSalxg+c3uRWI73+dhZ2O3vSlwA2HjOFi/vvjhFN4MTr67fTGztjJpvz+fz2M9yXqYC6t0rPS0rycZ/dC+lzGMZqgRSr4IPWV1LVgTNZgKMzERGWXaN6zGGcry/o6wyfJh9RN06rTYQdkQri7OQOQorZgsqE53TLMOxhgfK2fTccHlHVvX167RbSvGlSXXKyBvGqgjZiy3znwuT/w0Gp1DUAGZytF3VY+1xtAGaQySLlO8SpKadFLGn3ESCfhQFVz60to+jpBQruvWH0xIY7nMvlRmlBZTsW03Zl2sN0X8NpwoYHzwDFjvwpKQTricKCfz+ACwA8AOAHsUYG8+A2DCtN1srpWc+ggjZE5rlLZYHLrgAaQHkH45kJ7su5wOJVCUNdUhak1DhMwjMIf5TBRevb/kN7abKdYBawesHbD2GNbqiJVoZyoPA+ds5ifUdsZS1qeO2KOOaPrLzny6poEyzeuaCbbTBUvZMkCnTvv95UwZW6fLSmlb9+8pL/dcC/qD16eRlgPE2tIpVMYL//W+FNICjcnbo53y0smcw2u4eHc5gh+5xTkPf9WSyU3Vr5PXyf6RhdL2EY3D8zMIJwwF2CGFVi2he6/asPk5iv2o3WDmaHBySWIhPGPkGvXQURJWhdHY89rp97CJRc2HH9py+fnPkc84EdrFeoz/7oGXVYDj5tS9HTiy4+R40Eve9JKT0XGSDgbpt0dxkrz6i22PAT+1c3ssd90W9O2eWVh3cT1/Okk6g57OyErIifLxaAdDO5GlMqPRsRdM4qNd2JyfefRnqiyd9C1ATtsB9VpfVtAcWRMvFCJDaXzYmneadtuvYQX+CBbhKKYqC1BomX8q7MyN40yV/SyIrf4fF2rcL7mQ/caE6Z8Of7t6/3bY+/Xs9N37y3e9oziJ7YP12ayUsSWXHT+a56bVpXX7sMt1x3v+01RTaxYfbL8quJAUeH+mZUMK12xNCixiaffZ6jZqkH3NlssxN3ili7qmr/92qBcsvb5dE4FnjlwY+rx+WHr0CC8umjeol/C8F6+9R2lnr3LhKalw9BuL2B0utp7g6ts6YjPkOWrvadhxGvzpjUjPWsPOG1gdtRLDLMPKPrJ34/JBZLBi4vPh6PQnAnfzAleqnIQ1n9ODIJ+zlN2wG3Jd+WB53vDfL1nB5dTxKe0PiunfP4aH+fI= sidebar_class_name: "patch 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/upload-document-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/upload-document-experimental.api.mdx index 15f20a110c..d1d8b1158c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/upload-document-experimental.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/upload-document-experimental.api.mdx @@ -42,7 +42,7 @@ is not meant for production use. The document was uploaded successfully. -
    Schema
      metadata object
    +
    Schema
      metadata object
    The document upload failed. More details are provided in the response body.