diff --git a/api/administration-sm/generation-strategy.js b/api/administration-sm/generation-strategy.js index 3d0908043a2..bcb96fc2b6c 100644 --- a/api/administration-sm/generation-strategy.js +++ b/api/administration-sm/generation-strategy.js @@ -1,21 +1,17 @@ const { makeServerDynamic } = require("../make-server-dynamic"); const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); -const outputDir = "docs/apis-tools/administration-sm-api/specifications"; -const specFile = "api/administration-sm/administration-sm-openapi.yaml"; - -function preGenerateDocs() { - makeServerDynamic(specFile); +function preGenerateDocs(config) { + makeServerDynamic(config.specPath); } -function postGenerateDocs() { +function postGenerateDocs(config) { removeDuplicateVersionBadge( - `${outputDir}/administration-api-self-managed.info.mdx` + `${config.outputDir}/administration-api-self-managed.info.mdx` ); } module.exports = { - outputDir, preGenerateDocs, postGenerateDocs, }; diff --git a/api/administration-sm/version-8.6/administration-sm-openapi.yaml b/api/administration-sm/version-8.6/administration-sm-openapi.yaml new file mode 100644 index 00000000000..4e5c73fef9f --- /dev/null +++ b/api/administration-sm/version-8.6/administration-sm-openapi.yaml @@ -0,0 +1,249 @@ +openapi: 3.0.0 +components: + examples: {} + headers: {} + parameters: {} + requestBodies: {} + responses: {} + schemas: + ConsoleSMAdminApi.UsageMetricsInstances: + properties: + total: + type: number + format: double + description: The number of usage metrics for a specific type. + required: + - total + type: object + additionalProperties: false + ConsoleSMAdminApi.UsageMetricsTaskUsers: + properties: + total: + type: number + format: double + description: The number of usage metrics for a specific type. + assignees: + items: + type: string + type: array + description: The users that tasks have been assigned to. + required: + - total + - assignees + type: object + additionalProperties: false + ConsoleSMAdminApi.UsageMetricsForCluster: + properties: + id: + type: string + description: The identifier of the cluster. + processInstances: + $ref: "#/components/schemas/ConsoleSMAdminApi.UsageMetricsInstances" + description: The usage metrics for started process instances. + decisionInstances: + $ref: "#/components/schemas/ConsoleSMAdminApi.UsageMetricsInstances" + description: The usage metrics for executed decision instances. + taskUsers: + $ref: "#/components/schemas/ConsoleSMAdminApi.UsageMetricsTaskUsers" + description: The usage metrics for assigned task users. + required: + - id + - processInstances + - decisionInstances + - taskUsers + type: object + additionalProperties: false + ConsoleSMAdminApi.Status: + type: string + enum: + - healthy + - unhealthy + - unknown + ConsoleSMAdminApi.ClusterType: + type: string + enum: + - automation + - management + ConsoleSMAdminApi.AppType: + type: string + enum: + - zeebe-broker + - zeebe-gateway + - operate + - tasklist + - optimize + - modeler + - console + - identity + - unknown + ConsoleSMAdminApi.App: + properties: + type: + $ref: "#/components/schemas/ConsoleSMAdminApi.AppType" + description: + What application is running in the cluster, like Zeebe, Operate, + Tasklist, ... + id: + type: string + description: Unique identifier of the application + status: + $ref: "#/components/schemas/ConsoleSMAdminApi.Status" + description: Indicates if an application is healthy or not + url: + type: string + description: The public URL of the application + generation: + type: string + description: This is the current version of the running application + readiness: + type: string + description: The readiness URL of the application + metrics: + type: string + description: The metrics URL of the application + required: + - type + - id + - status + - url + - generation + type: object + additionalProperties: false + ConsoleSMAdminApi.Cluster: + properties: + uuid: + type: string + description: Unique identifier of the cluster + name: + type: string + description: Name of the cluster + namespace: + type: string + description: Namespace the cluster is running in. + status: + $ref: "#/components/schemas/ConsoleSMAdminApi.Status" + description: Indicates if a cluster is healthy or not + generation: + type: string + description: This is the current version of the running cluster + type: + $ref: "#/components/schemas/ConsoleSMAdminApi.ClusterType" + description: + We're distinguishing between automation and management clusters. + Management clusters include applications that act globally in an + installed context, like Console or Modeler. Automation clusters are + the Zeebe clusters including applications like Operate, Tasklist and + Optimize. + apps: + items: + $ref: "#/components/schemas/ConsoleSMAdminApi.App" + type: array + description: The list of applications running in the cluster + required: + - uuid + - name + - namespace + - status + - generation + - type + - apps + type: object + additionalProperties: false + securitySchemes: + bearer: + type: http + scheme: bearer + bearerFormat: JWT +info: + title: Administration API (Self-Managed) + description: Access the administration API of Console Self-Managed. + version: 1.0.0 + contact: + url: https://www.camunda.com + license: + name: License + url: https://docs.camunda.io/docs/reference/licenses/ +paths: + /admin-api/usage-metrics: + get: + operationId: getUsageMetrics + responses: + "200": + description: Ok + content: + application/json: + schema: + $ref: "#/components/schemas/ConsoleSMAdminApi.UsageMetricsForCluster" + "403": + description: Forbidden + "500": + description: Server-side error + description: Returns usage metrics for a specific cluster for a given time + range. The usage metrics are aggregated over the time range and include + number of started process instances, executed decision instances, and + assigned task users. + summary: Get usage metrics for clusters + tags: + - Usage Metrics + security: + - bearer: [] + parameters: + - description: The unique identifier of the cluster + in: query + name: id + required: true + schema: + type: string + - description: + The start timestamp of the time range as UNIX timestamp in + milliseconds + in: query + name: start + required: true + schema: + format: double + type: number + - description: The end timestamp of the time range as UNIX timestamp in milliseconds + in: query + name: end + required: true + schema: + format: double + type: number + /admin-api/clusters: + get: + operationId: getClusters + responses: + "200": + description: Ok + content: + application/json: + schema: + items: + $ref: "#/components/schemas/ConsoleSMAdminApi.Cluster" + type: array + "403": + description: Forbidden + "500": + description: Server-side error + description: + Returns a list of all automation and management clusters. Each + cluster entry contains the running apps and their status. + summary: Get current clusters + tags: + - Clusters + security: + - bearer: [] + parameters: [] +servers: + - url: "{schema}://{host}:{port}" + variables: + host: + default: localhost + description: The hostname of the API server. + port: + default: "8080" + description: The port of the API server. + schema: + default: http + description: The schema of the API server. diff --git a/api/camunda/generation-strategy.js b/api/camunda/generation-strategy.js index 305cb90d63c..c63445b0bdd 100644 --- a/api/camunda/generation-strategy.js +++ b/api/camunda/generation-strategy.js @@ -1,11 +1,9 @@ const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); const replace = require("replace-in-file"); -const outputDir = "docs/apis-tools/camunda-api-rest/specifications"; -const specFile = "api/camunda/camunda-openapi.yaml"; const fs = require("fs"); -function preGenerateDocs() { - const originalSpec = fs.readFileSync(specFile, "utf8"); +function preGenerateDocs(config) { + const originalSpec = fs.readFileSync(config.specPath, "utf8"); console.log("adjusting C8 spec file..."); @@ -18,14 +16,16 @@ function preGenerateDocs() { ]; replace.sync({ - files: specFile, + files: config.specPath, from: specUpdates.map((x) => x.from), to: specUpdates.map((x) => x.to), }); } -function postGenerateDocs() { - removeDuplicateVersionBadge(`${outputDir}/camunda-8-rest-api.info.mdx`); +function postGenerateDocs(config) { + removeDuplicateVersionBadge( + `${config.outputDir}/camunda-8-rest-api.info.mdx` + ); } function addDisclaimer(originalSpec) { @@ -256,7 +256,6 @@ function addFrequentlyLinkedDocs() { } module.exports = { - outputDir, preGenerateDocs, postGenerateDocs, }; diff --git a/api/camunda/version-8.6/camunda-openapi.yaml b/api/camunda/version-8.6/camunda-openapi.yaml new file mode 100644 index 00000000000..ac27f0ce578 --- /dev/null +++ b/api/camunda/version-8.6/camunda-openapi.yaml @@ -0,0 +1,3853 @@ +# Disclaimer: This is a modified version of the Camunda REST API specification, optimized for the documentation. + +openapi: "3.0.3" +info: + title: Camunda 8 REST API + version: "0.1" + 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 +externalDocs: + description: Find out more + url: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/overview/ + +servers: + - url: "{schema}://{host}:{port}/v2" + variables: + host: + default: localhost + description: The hostname of the Camunda 8 REST Gateway. + port: + default: "8080" + description: The port of the Camunda 8 REST API server. + schema: + default: http + description: The schema of the Camunda 8 REST API server. + +paths: + /topology: + get: + tags: + - Cluster + summary: Get cluster topology + description: Obtains the current topology of the cluster the gateway is part of. + responses: + "200": + description: Obtains the current topology of the cluster the gateway is part of. + content: + application/json: + schema: + $ref: "#/components/schemas/TopologyResponse" + /license: + get: + tags: + - License + summary: Get status of Camunda license + description: Obtains the status of the current Camunda license + responses: + "200": + description: Obtains the current status of the Camunda license + content: + application/json: + schema: + $ref: "#/components/schemas/LicenseResponse" + /jobs/activation: + post: + tags: + - Job + summary: Activate jobs + description: | + Iterate through all known partitions and activate jobs up to the requested maximum. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/JobActivationRequest" + responses: + "200": + description: The list of activated jobs. + content: + 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" + /jobs/{jobKey}: + patch: + tags: + - Job + summary: Update a job + description: Update a job with the given key. + parameters: + - name: jobKey + in: path + required: true + description: The key of the job to update. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/JobUpdateRequest" + responses: + "204": + description: The job was updated successfully. + "400": + description: > + The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The job with the 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" + + /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 user task + description: Completes a user task with the given key. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task to complete. + schema: + type: integer + format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskCompletionRequest" + + 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. + 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/{userTaskKey}/assignment: + post: + tags: + - User task + summary: Assign user task + description: Assigns a user task with the given key to the given assignee. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task to assign. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskAssignmentRequest" + 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. + 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/{userTaskKey}: + patch: + tags: + - User task + summary: Update user task + description: Update a user task with the given key. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task to update. + schema: + type: integer + format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskUpdateRequest" + 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. + 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/{userTaskKey}/assignee: + delete: + tags: + - User task + summary: Unassign user task + description: Removes the assignee of a task with the given key. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task. + schema: + type: integer + format: int64 + responses: + "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 (alpha) + description: | + Search for user tasks based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + 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" + + /clock: + put: + tags: + - Clock + summary: Pin internal clock (alpha) + description: | + 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 pinned again with a new timestamp. + + :::note + This endpoint is an [alpha feature](/reference/alpha-features.md) and may be subject to change + in future releases. + ::: + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ClockPinRequest" + responses: + "204": + description: > + The clock was successfully pinned to the specified time in epoch milliseconds. + "400": + description: The required timestamp parameter is missing or it is negative. + 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" + /clock/reset: + post: + tags: + - Clock + summary: Reset internal clock (alpha) + 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 an [alpha feature](/reference/alpha-features.md) and may be subject to change + 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: Create 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" + examples: + "By process definition key": + summary: "Create a process instance by processDefinitionKey." + value: + processDefinitionKey: 12345 + variables: {} + "By process definition ID": + summary: "Create a process instance by processDefinitionId and version." + value: + processDefinitionId: "1234-5678" + version: 1 + variables: {} + 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: + - Process instance + summary: Query process instances (alpha) + description: | + Search for process instances based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + 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" + /process-instances/{processInstanceKey}/cancellation: + post: + tags: + - Process instance + summary: Cancel process instance + description: Cancels a running process instance. + parameters: + - name: processInstanceKey + in: path + required: true + description: The key of the process instance to cancel. + schema: + type: integer + format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/CancelProcessInstanceRequest" + responses: + "204": + description: The process instance is canceled. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The process instance 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" + /process-instances/{processInstanceKey}/migration: + post: + tags: + - Process instance + summary: Migrate process instance + description: | + Migrates a process instance to a new process definition. + This request can contain multiple mapping instructions to define mapping between the active + process instance's elements and target process definition elements. + + Use this to upgrade a process instance to a new version of a process or to + a different process definition, e.g. to keep your running instances up-to-date with the + latest process improvements. + parameters: + - name: processInstanceKey + in: path + required: true + description: The key of the process instance that should be migrated. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/MigrateProcessInstanceRequest" + responses: + "204": + description: The process instance is migrated. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The process instance 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" + /process-instances/{processInstanceKey}/modification: + post: + tags: + - Process instance + summary: Modify process instance + description: | + Modifies a running process instance. + This request can contain multiple instructions to activate an element of the process or + to terminate an active instance of an element. + + Use this to repair a process instance that is stuck on an element or took an unintended path. + For example, because an external system is not available or doesn't respond as expected. + parameters: + - name: processInstanceKey + in: path + required: true + description: The key of the process instance that should be modified. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ModifyProcessInstanceRequest" + responses: + "204": + description: The process instance is modified. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The process instance 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" + + /flownode-instances/search: + post: + tags: + - Flow node Instance + summary: Query flow node instances (alpha) + description: | + Search for flow node instances based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryRequest" + responses: + "200": + description: > + The Flow node instance search successful response. + content: + application/json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponse" + "400": + description: > + The Flow node 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 (alpha) + description: | + Search for decision definitions based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionDefinitionSearchQueryRequest" + responses: + "200": + description: > + 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" + "500": + description: > + An internal error occurred while processing the request. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + /decision-definitions/{decisionDefinitionKey}/xml: + get: + tags: + - Decision definition + summary: Get decision definition XML (alpha) + description: | + Returns decision definition as XML. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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: decisionDefinitionKey + 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: + - Decision requirements + summary: Query decision requirements (alpha) + description: | + Search for decision requirements based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionRequirementsSearchQueryRequest" + responses: + "200": + description: > + The decision requirements search successful response. + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponse" + "400": + description: > + The decision requirements search query failed. + More details are provided in the response body. + + /decision-instances/search: + post: + tags: + - Decision instance + summary: Query decision instances (alpha) + description: | + Search for decision instances based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionInstanceSearchQueryRequest" + responses: + "200": + description: > + The decision instance search successful response. + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionInstanceSearchQueryResponse" + "400": + description: > + The decision 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/evaluation: + post: + tags: + - Decision definition + summary: Evaluate decision + description: | + Evaluates a decision. + You specify the decision to evaluate either by using its unique key (as returned by + DeployResource), or using the decision ID. When using the decision ID, the latest deployed + version of the decision is used. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/EvaluateDecisionRequest" + examples: + "By decision definition key": + summary: "Evaluate the decision by decisionDefinitionKey." + value: + decisionDefinitionKey: 12345 + variables: {} + "By decision definition ID": + summary: "Evaluate the decision by decisionDefinitionId." + value: + decisionDefinitionId: "1234-5678" + variables: {} + responses: + "200": + description: The decision was evaluated. + content: + application/json: + schema: + $ref: "#/components/schemas/EvaluateDecisionResponse" + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The decision 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" + + /messages/publication: + post: + tags: + - Message + summary: Publish a message + description: | + Publishes a single message. + Messages are published to specific partitions computed from their correlation keys. + The endpoint does not wait for a correlation result. + Use the message correlation endpoint for such use cases. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/MessagePublicationRequest" + responses: + "200": + description: The message was published. + content: + application/json: + schema: + $ref: "#/components/schemas/MessagePublicationResponse" + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + description: Internal server error. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + /messages/correlation: + post: + tags: + - Message + summary: Correlate a message + description: | + Publishes a message and correlates it to a subscription. + If correlation is successful it will return the first process instance key the message correlated with. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/MessageCorrelationRequest" + responses: + "200": + description: The message is correlated to one or more process instances + content: + application/json: + schema: + $ref: "#/components/schemas/MessageCorrelationResponse" + "400": + description: The provided data is not valid + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + description: Unauthorized + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: Not found + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + description: Internal server error + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + /documents: + post: + tags: + - Documents + summary: Upload document (alpha) + description: | + Upload a document to the Camunda 8 cluster. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, + which is not meant for production use. + ::: + parameters: + - name: storeId + in: query + required: false + description: The ID of the document store to upload the document to. + schema: + type: string + - name: documentId + in: query + required: false + description: > + The ID of the document to upload. If not provided, a new ID will be generated. + Specifying an existing ID will result in an error if the document already exists. + schema: + type: string + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + metadata: + $ref: "#/components/schemas/DocumentMetadata" + required: + - file + encoding: + metadata: + contentType: application/json + responses: + "201": + description: The document was uploaded successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/DocumentReference" + "400": + description: > + The document upload failed. More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + /documents/{documentId}: + get: + tags: + - Documents + summary: Download document (alpha) + description: | + Download a document from the Camunda 8 cluster. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, + which is not meant for production use. + ::: + parameters: + - name: documentId + in: path + required: true + description: The ID of the document to download. + schema: + type: string + - name: storeId + in: query + required: false + description: The ID of the document store to download the document from. + schema: + type: string + responses: + "200": + description: The document was downloaded successfully. + content: + application/octet-stream: + schema: + type: string + format: binary + "404": + description: > + The document with the given ID was 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" + delete: + tags: + - Documents + summary: Delete document (alpha) + description: | + Delete a document from the Camunda 8 cluster. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, + which is not meant for production use. + ::: + parameters: + - name: documentId + in: path + required: true + description: The ID of the document to delete. + schema: + type: string + - name: storeId + in: query + required: false + description: The ID of the document store to delete the document from. + schema: + type: string + responses: + "200": + description: The document was deleted successfully. + "404": + description: > + The document with the given ID was 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" + /document/{documentId}/links: + post: + tags: + - Documents + summary: Create document link (alpha) + description: | + Create a link to a document in the Camunda 8 cluster. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, + which is not meant for production use. + ::: + parameters: + - name: documentId + in: path + required: true + description: The ID of the document to link. + schema: + type: string + - name: storeId + in: query + required: false + description: The ID of the document store to link the document from. + schema: + type: string + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/DocumentLinkRequest" + responses: + "201": + description: The document link was created successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/DocumentLink" + "400": + description: > + The document link creation failed. More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + /users/search: + post: + tags: + - User + summary: "Query users (alpha)" + description: | + Search for users based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + operationId: "findAllUsers" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/UserSearchQueryRequest" + required: true + responses: + "200": + description: "OK" + content: + application/json: + schema: + $ref: "#/components/schemas/UserSearchResponse" + "400": + description: "Bad request" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + description: "Unauthorized" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + description: "Forbidden" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: "Not found" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + description: "Internal server error" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + /incidents/search: + post: + tags: + - Incident + summary: Query incidents (alpha) + description: | + Search for incidents based on given criteria. + + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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. + ::: + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/IncidentSearchQueryRequest" + responses: + "200": + description: > + The incident search successful response. + content: + application/json: + schema: + $ref: "#/components/schemas/IncidentSearchQueryResponse" + "400": + description: > + The incident search query failed. + More details are provided in the response body. + "401": + description: "Unauthorized" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + description: "Forbidden" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: "Not found" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + description: "Internal server error" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + /incidents/{incidentKey}: + get: + tags: + - Incident + summary: Get incident by key (alpha) + description: | + Returns incident as JSON. + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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: incidentKey + in: path + required: true + description: The assigned key of the incident, which acts as a unique identifier for this incident. + schema: + type: integer + format: int64 + responses: + "200": + description: > + The incident is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/IncidentItem" + "400": + description: > + The incident Get failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: > + The incident 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" + /deployments: + post: + tags: + - Resource + 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/DeploymentResponse" + "400": + description: > + The document upload failed. More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + /resources/{resourceKey}/deletion: + post: + tags: + - Resource + summary: Delete resource + description: | + Deletes a deployed resource. + This can be a process definition, decision requirements definition, or form definition + deployed using the deploy resources endpoint. Specify the resource you want to delete in the `resourceKey` parameter. + parameters: + - name: resourceKey + in: path + required: true + description: | + The key of the resource to delete. + This can be the key of a process definition, the key of a decision requirements + definition or the key of a form definition + schema: + type: integer + format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/DeleteResourceRequest" + responses: + "200": + description: The resource is deleted. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The resource 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" + + /element-instances/{elementInstanceKey}/variables: + post: + tags: + - Element instance + summary: Update element instance variables + description: | + Updates all the variables of a particular scope (for example, process instance, flow element instance) with the given variable data. + Specify the element instance in the `elementInstanceKey` parameter. + parameters: + - name: elementInstanceKey + in: path + required: true + description: | + The key of the element instance to update the variables for. + This can be the process instance key (as obtained during instance creation), or a given + element, such as a service task (see the `elementInstanceKey` on the job message). + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/SetVariableRequest" + responses: + "204": + description: The variables were updated. + "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" + + /signals/broadcast: + post: + tags: + - Signal + summary: Broadcast signal + description: Broadcasts a signal. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/SignalBroadcastRequest" + responses: + "200": + description: The signal was broadcast. + content: + application/json: + schema: + $ref: "#/components/schemas/SignalBroadcastResponse" + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The signal 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" + +components: + 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 + processDefinitionId: + type: string + variables: + type: array + items: + $ref: "#/components/schemas/UserTaskVariableFilterRequest" + UserTaskVariableFilterRequest: + type: object + properties: + name: + type: string + value: + 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 + processDefinitionId: + 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 + priority: + type: integer + description: The priority of a user task. The higher the value the higher the priority. + minimum: 0 + maximum: 100 + default: 50 + ProcessInstanceSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/ProcessInstanceFilterRequest" + ProcessInstanceFilterRequest: + type: object + properties: + 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 + description: The bpmn process ID. + 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: + type: string + ProcessInstanceSearchQueryResponse: + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/ProcessInstanceItem" + ProcessInstanceItem: + type: object + properties: + key: + type: integer + format: int64 + processDefinitionName: + type: string + description: The process name. + processDefinitionVersion: + 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 + 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" + CancelProcessInstanceRequest: + type: object + nullable: true + properties: + operationReference: + description: | + A reference key chosen by the user that will be part of all records resulting from this operation. + Must be > 0 if provided. + type: integer + format: int64 + minimum: 1 + + FlowNodeInstanceSearchQueryRequest: + description: Flow node instance search request + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/FlowNodeInstanceFilterRequest" + FlowNodeInstanceFilterRequest: + type: object + properties: + flowNodeInstanceKey: + type: integer + description: The key of this flow node instance. + format: int64 + processInstanceKey: + type: integer + description: The process instance key. + format: int64 + processDefinitionKey: + type: integer + description: The process definition key. + format: int64 + state: + type: string + description: The state, one of ACTIVE, COMPLETED, TERMINATED. + type: + type: string + description: The flow node type + flowNodeId: + type: string + description: The flow node id + flowNodeName: + type: string + description: The flow node name + treePath: + type: string + description: The path of keys from process instance to this flow node instance separated by '/' + incident: + type: boolean + description: Shows whether this flow node instance has an incident related to + incidentKey: + type: integer + description: The key of incident if field incident is true + format: int64 + tenantId: + description: The tenant id + type: string + FlowNodeInstanceSearchQueryResponse: + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/FlowNodeInstanceItem" + FlowNodeInstanceItem: + type: object + properties: + flowNodeInstanceKey: + type: integer + format: int64 + processInstanceKey: + type: integer + format: int64 + processDefinitionKey: + type: integer + format: int64 + startDate: + type: string + endDate: + type: string + flowNodeId: + type: string + flowNodeName: + type: string + treePath: + type: string + type: + type: string + state: + type: string + incident: + type: boolean + incidentKey: + type: integer + format: int64 + tenantId: + type: string + DecisionDefinitionSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/DecisionDefinitionFilterRequest" + DecisionDefinitionFilterRequest: + type: object + properties: + decisionDefinitionKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this decision definition. + decisionDefinitionId: + type: string + description: The DMN id of the decision definition. + decisionDefinitionName: + type: string + description: The DMN name of the decision definition. + version: + type: integer + format: int32 + description: The assigned version of the decision definition. + decisionRequirementsId: + type: string + description: the DMN id of the decision requirements graph that the decision definition is part of. + decisionRequirementsKey: + type: integer + format: int64 + description: The assigned key of the decision requirements graph that the decision definition is part of. + tenantId: + type: string + description: The tenant id of the decision definition. + IncidentSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/IncidentFilterRequest" + IncidentFilterRequest: + type: object + properties: + key: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this incident. + processDefinitionKey: + type: integer + format: int64 + description: The process definition key associated to this incident. + processDefinitionId: + type: string + description: The bpmn process id associated to this incident. + processInstanceKey: + type: integer + format: int64 + description: The process instance key associated to this incident. + errorType: + type: string + description: Incident error type with a defined set of values. + enum: + - UNSPECIFIED + - UNKNOWN + - IO_MAPPING_ERROR + - JOB_NO_RETRIES + - CONDITION_ERROR + - EXTRACT_VALUE_ERROR + - CALLED_ELEMENT_ERROR + - UNHANDLED_ERROR_EVENT + - MESSAGE_SIZE_EXCEEDED + - CALLED_DECISION_ERROR + - DECISION_EVALUATION_ERROR + - FORM_NOT_FOUND + errorMessage: + type: string + description: Error message which describes the error in more detail. + flowNodeId: + type: string + description: The flow node id associated to this incident. + flowNodeInstanceKey: + type: integer + format: int64 + description: The flow node instance key associated to this incident. + creationTime: + type: string + description: Date of incident creation. + format: date-time + state: + type: string + description: State of this incident with a defined set of values. + enum: + - ACTIVE + - MIGRATED + - RESOLVED + - PENDING + jobKey: + type: integer + format: int64 + description: The job key, if exists, associated with this incident. + treePath: + type: string + description: The path from process instance via flow node ids and flow node instance keys leading to this incident. + tenantId: + description: The tenant id of the incident. + type: string + IncidentSearchQueryResponse: + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/IncidentItem" + IncidentItem: + type: object + properties: + key: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this incident. + processDefinitionKey: + type: integer + format: int64 + description: The process definition key associated to this incident. + processDefinitionId: + type: string + description: The bpmn process id associated to this incident. + processInstanceKey: + type: integer + format: int64 + description: The process instance key associated to this incident. + errorType: + type: string + description: Incident error type with a defined set of values. + enum: + - UNSPECIFIED + - UNKNOWN + - IO_MAPPING_ERROR + - JOB_NO_RETRIES + - CONDITION_ERROR + - EXTRACT_VALUE_ERROR + - CALLED_ELEMENT_ERROR + - UNHANDLED_ERROR_EVENT + - MESSAGE_SIZE_EXCEEDED + - CALLED_DECISION_ERROR + - DECISION_EVALUATION_ERROR + - FORM_NOT_FOUND + errorMessage: + type: string + description: Error message which describes the error in more detail. + flowNodeId: + type: string + description: The flow node id associated to this incident. + flowNodeInstanceKey: + type: integer + format: int64 + description: The flow node instance key associated to this incident. + creationTime: + type: string + description: Date of incident creation. + format: date-time + state: + type: string + description: State of this incident with a defined set of values. + enum: + - ACTIVE + - MIGRATED + - RESOLVED + - PENDING + jobKey: + type: integer + description: The job key, if exists, associated with this incident. + format: int64 + treePath: + type: string + description: The path from process instance via flow node ids and flow node instance keys leading to this incident. + tenantId: + description: The tenant id of the incident. + type: string + OperationItem: + description: " Operation" + type: object + properties: + id: + type: string + batchOperationId: + 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 + properties: + instanceId: + type: string + processDefinitionId: + type: string + processDefinitionName: + type: string + DecisionDefinitionSearchQueryResponse: + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/DecisionDefinitionItem" + DecisionDefinitionItem: + type: object + properties: + decisionDefinitionKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this decision definition. + decisionDefinitionId: + type: string + description: The DMN id of the decision definition. + decisionDefinitionName: + type: string + description: The DMN name of the decision definition. + version: + type: integer + format: int32 + description: The assigned version of the decision definition. + decisionRequirementsId: + type: string + description: the DMN id of the decision requirements graph that the decision definition is part of. + decisionRequirementsKey: + type: integer + format: int64 + description: The assigned key of the decision requirements graph that the decision definition is part of. + tenantId: + type: string + description: The tenant id of the decision definition. + AuthorizationPatchRequest: + type: object + properties: + 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 + permissions: + type: array + description: The permissions to add/remove. + items: + properties: + permissionType: + description: Specifies the type of permissions. + enum: + - CREATE + - READ + - UPDATE + - DELETE + resourceIds: + type: array + description: A list of resource IDs the permission relates to. + items: + type: string + UserRequest: + type: "object" + properties: + password: + type: "string" + username: + type: "string" + name: + type: "string" + email: + type: "string" + UserCreateResponse: + type: "object" + properties: + userKey: + description: The key of the created user + type: "integer" + format: "int64" + UserSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/UserFilterRequest" + UserFilterRequest: + type: object + properties: + username: + type: "string" + name: + type: "string" + email: + type: "string" + UserResponse: + type: "object" + properties: + id: + type: "integer" + format: "int64" + key: + type: "integer" + format: "int64" + username: + type: "string" + name: + type: "string" + email: + type: "string" + UserSearchResponse: + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + type: array + items: + $ref: "#/components/schemas/UserResponse" + TopologyResponse: + description: The response of a topology request. + type: object + properties: + brokers: + description: A list of brokers that are part of this cluster. + type: array + nullable: true + items: + $ref: "#/components/schemas/BrokerInfo" + clusterSize: + description: The number of brokers in the cluster. + type: integer + format: int32 + nullable: true + partitionsCount: + description: The number of partitions are spread across the cluster. + type: integer + format: int32 + nullable: true + replicationFactor: + description: The configured replication factor for this cluster. + type: integer + format: int32 + nullable: true + gatewayVersion: + description: The version of the Zeebe Gateway. + type: string + nullable: true + LicenseResponse: + description: The response of a license request. + type: object + properties: + validLicense: + description: True if the Camunda license is valid, false if otherwise + type: boolean + nullable: false + licenseType: + description: Will return the license type property of the Camunda license + type: string + BrokerInfo: + description: Provides information on a broker node. + type: object + properties: + nodeId: + description: The unique (within a cluster) node ID for the broker. + type: integer + format: int32 + host: + description: The hostname for reaching the broker. + type: string + port: + description: The port for reaching the broker. + type: integer + format: int32 + partitions: + description: A list of partitions managed or replicated on this broker. + type: array + items: + $ref: "#/components/schemas/Partition" + version: + description: The broker version. + type: string + Partition: + description: Provides information on a partition within a broker node. + type: object + properties: + partitionId: + description: The unique ID of this partition. + type: integer + format: int32 + role: + description: Describes the Raft role of the broker for a given partition. + type: string + enum: + - leader + - follower + - inactive + health: + description: Describes the current health of the partition. + type: string + enum: + - healthy + - unhealthy + - dead + UserTaskCompletionRequest: + type: object + properties: + variables: + additionalProperties: true + description: The variables to complete the user task with. + type: object + nullable: true + 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 "complete". + type: string + nullable: true + UserTaskAssignmentRequest: + type: object + properties: + assignee: + description: The assignee for the user task. The assignee must not be empty or `null`. + type: string + nullable: false + allowOverride: + description: > + By default, the task is reassigned if it was already assigned. Set this to `false` + to return an error in such cases. The task must then first be unassigned to + be assigned again. Use this when you have users picking from group task + queues to prevent race conditions. + type: boolean + nullable: true + 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 "assign". + type: string + nullable: true + UserTaskUpdateRequest: + type: object + properties: + changeset: + $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 + 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 + * `priority` - minimum 0, maximum 100, default 50 + + 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 + additionalProperties: true + properties: + dueDate: + type: string + format: date-time + description: The due date of the task. Reset by providing an empty String. + nullable: true + followUpDate: + type: string + format: date-time + description: The follow-up date of the task. Reset by providing an empty String. + nullable: true + candidateUsers: + type: array + description: The list of candidate users of the task. Reset by providing an empty list. + items: + type: string + nullable: true + candidateGroups: + type: array + description: The list of candidate groups of the task. Reset by providing an empty list. + items: + type: string + nullable: true + priority: + type: integer + format: int32 + description: The priority of the task. + minimum: 0 + default: 50 + maximum: 100 + nullable: true + ClockPinRequest: + type: object + properties: + timestamp: + description: The exact time in epoch milliseconds to which the clock should be pinned. + type: integer + format: int64 + required: + - timestamp + JobActivationRequest: + type: object + properties: + type: + description: > + the job type, as defined in the BPMN process (e.g. ) + type: string + worker: + description: the name of the worker activating the jobs, mostly used for logging purposes + type: string + nullable: true + timeout: + description: > + a job returned after this call will not be activated by another call until the + timeout (in ms) has been reached + type: integer + format: int64 + maxJobsToActivate: + description: the maximum jobs to activate by this request + type: integer + format: int32 + fetchVariable: + description: > + a list of variables to fetch as the job variables; if empty, all visible variables at + the time of activation for the scope of the job will be returned + type: array + nullable: true + items: + type: string + requestTimeout: + description: > + The request will be completed when at least one job is activated or after the + requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. + If the requestTimeout < 0, long polling is disabled and the request is completed + immediately, even when no job is activated. + 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 + properties: + jobs: + type: array + items: + $ref: "#/components/schemas/ActivatedJob" + ActivatedJob: + type: object + properties: + key: + description: the key, a unique identifier for the job + type: integer + format: int64 + type: + description: the type of the job (should match what was requested) + type: string + processInstanceKey: + description: the job's process instance key + type: integer + format: int64 + processDefinitionId: + description: the bpmn process ID of the job's process definition + type: string + processDefinitionVersion: + description: the version of the job's process definition + type: integer + format: int32 + processDefinitionKey: + description: the key of the job's process definition + type: integer + format: int64 + elementId: + description: the associated task element ID + type: string + elementInstanceKey: + description: > + the unique key identifying the associated task, unique within the scope of the + process instance + type: integer + format: int64 + customHeaders: + description: a set of custom headers defined during modelling; returned as a serialized JSON document + type: object + additionalProperties: true + worker: + description: the name of the worker which activated this job + type: string + retries: + description: the amount of retries left to this job (should always be positive) + type: integer + format: int32 + deadline: + description: when the job can be activated again, sent as a UNIX epoch timestamp + type: integer + format: int64 + variables: + description: All variables visible to the task scope, computed at activation time + type: object + additionalProperties: true + tenantId: + description: The ID of the tenant that owns the job + type: string + 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 + JobUpdateRequest: + type: object + properties: + changeset: + $ref: "#/components/schemas/JobChangeset" + required: + - changeset + JobChangeset: + description: | + JSON object with changed job attribute values. + + The following attributes can be adjusted with this endpoint, additional attributes + will be ignored: + + * `retries` - The new amount of retries for the job; must be a positive number. + * `timeout` - The duration of the new timeout in ms, starting from the current moment. + + Providing any of those attributes with a null value or omitting it preserves the persisted attribute’s value. + + The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead. + type: object + properties: + retries: + type: integer + format: int32 + description: The new amount of retries for the job; must be a positive number. + nullable: true + timeout: + type: integer + format: int64 + description: The duration of the new timeout in ms, starting from the current moment. + nullable: true + + ProblemDetail: + description: > + A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). + There may be additional properties specific to the problem type. + type: object + properties: + type: + type: string + format: uri + description: A URI identifying the problem type. + default: about:blank + title: + type: string + description: A summary of the problem type. + status: + type: integer + format: int32 + description: The HTTP status code for this problem. + minimum: 400 + maximum: 600 + detail: + type: string + description: An explanation of the problem in more detail. + instance: + type: string + format: uri + description: A URI identifying the origin of the problem. + 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 + neq: + type: object + gt: + type: object + gte: + type: object + lt: + type: object + lte: + type: object + DecisionRequirementsSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/DecisionRequirementsFilterRequest" + DecisionRequirementsFilterRequest: + type: object + properties: + decisionRequirementsKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this decision requirements. + decisionRequirementsName: + type: string + description: The DMN name of the decision requirements. + version: + type: integer + format: int32 + description: The assigned version of the decision requirements. + decisionRequirementsId: + type: string + description: the DMN id of the decision requirements. + tenantId: + type: string + description: The tenant ID of the decision requirements. + DecisionRequirementsSearchQueryResponse: + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/DecisionRequirementsItem" + DecisionRequirementsItem: + type: object + properties: + decisionRequirementsKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this decision requirements. + decisionRequirementsName: + type: string + description: The DMN name of the decision requirements. + version: + type: integer + format: int32 + description: The assigned version of the decision requirements. + decisionRequirementsId: + type: string + description: the DMN id of the decision requirements. + resourceName: + type: string + description: The name of the resource from which this decision requirements was parsed. + tenantId: + type: string + description: The tenant ID of the decision requirements. + EvaluateDecisionRequest: + type: object + oneOf: + - $ref: "#/components/schemas/EvaluateDecisionRequestByKey" + - $ref: "#/components/schemas/EvaluateDecisionRequestById" + EvaluateDecisionRequestByKey: + type: object + allOf: + - $ref: "#/components/schemas/EvaluateDecisionRequestBase" + properties: + decisionDefinitionKey: + description: | + The unique key identifying the decision to be evaluated. + Cannot be used together with decisionDefinitionId. + type: integer + format: int64 + EvaluateDecisionRequestById: + type: object + allOf: + - $ref: "#/components/schemas/EvaluateDecisionRequestBase" + properties: + decisionDefinitionId: + description: | + The ID of the decision to be evaluated. + Cannot be used together with decisionDefinitionKey. When using the decision ID, the latest + deployed version of the decision is used. + type: string + EvaluateDecisionRequestBase: + type: object + properties: + variables: + description: The message variables as JSON document. + additionalProperties: true + type: object + tenantId: + description: The tenant ID of the decision. + type: string + EvaluateDecisionResponse: + type: object + properties: + decisionDefinitionKey: + description: The unique key identifying the decision which was evaluated. + type: integer + format: int64 + decisionDefinitionId: + description: The ID of the decision which was evaluated. + type: string + decisionDefinitionName: + description: The name of the decision which was evaluated. + type: string + decisionDefinitionVersion: + description: The version of the decision which was evaluated. + type: integer + format: int32 + decisionRequirementsId: + description: The ID of the decision requirements graph that the decision which was evaluated is part of. + type: string + decisionRequirementsKey: + description: The unique key identifying the decision requirements graph that the decision which was evaluated is part of. + type: integer + format: int64 + output: + description: | + JSON document that will instantiate the result of the decision which was evaluated. + type: string + failedDecisionDefinitionId: + description: The ID of the decision which failed during evaluation. + type: string + failureMessage: + description: Message describing why the decision which was evaluated failed. + type: string + tenantId: + description: The tenant ID of the evaluated decision. + type: string + decisionInstanceKey: + description: The unique key identifying this decision evaluation. + type: integer + format: int64 + evaluatedDecisions: + type: array + items: + $ref: "#/components/schemas/EvaluatedDecisionItem" + EvaluatedDecisionItem: + type: object + description: List of decisions that were evaluated within the requested decision evaluation. + properties: + decisionDefinitionKey: + description: The unique key identifying the decision which was evaluate. + type: integer + format: int64 + decisionDefinitionId: + description: The ID of the decision which was evaluated. + type: string + decisionDefinitionName: + description: The name of the decision which was evaluated. + type: string + decisionDefinitionVersion: + description: The version of the decision which was evaluated. + type: integer + format: int32 + decisionDefinitionType: + description: The type of the decision which was evaluated. + type: string + output: + description: | + JSON document that will instantiate the result of the decision which was evaluated. + type: string + tenantId: + description: The tenant ID of the evaluated decision. + type: string + matchedRules: + type: array + items: + $ref: "#/components/schemas/MatchedDecisionRuleItem" + evaluatedInputs: + type: array + items: + $ref: "#/components/schemas/EvaluatedDecisionInputItem" + MatchedDecisionRuleItem: + type: object + description: The decision rules that matched within this decision evaluation. + properties: + ruleId: + description: The ID of the matched rule. + type: string + ruleIndex: + description: The index of the matched rule. + type: integer + format: int32 + evaluatedOutputs: + type: array + items: + $ref: "#/components/schemas/EvaluatedDecisionOutputItem" + EvaluatedDecisionInputItem: + type: object + description: The decision inputs that were evaluated within this decision evaluation. + properties: + inputId: + description: The ID of the evaluated decision input. + type: string + inputName: + description: The name of the evaluated decision input. + type: string + inputValue: + description: The value of the evaluated decision input. + type: string + EvaluatedDecisionOutputItem: + type: object + description: The evaluated decision outputs. + properties: + outputId: + description: The ID of the evaluated decision output. + type: string + outputName: + description: The name of the evaluated decision output. + type: string + outputValue: + description: The value of the evaluated decision output. + type: string + DecisionInstanceSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + allOf: + - $ref: "#/components/schemas/DecisionInstanceFilterRequest" + DecisionInstanceFilterRequest: + type: object + properties: + key: + type: integer + format: int64 + description: The key of the decision instance. + state: + $ref: "#/components/schemas/DecisionInstanceStateEnum" + description: The state of the decision instance. + evaluationFailure: + type: string + description: The evaluation failure of the decision instance. + processDefinitionKey: + type: integer + format: int64 + description: The key of the process definition. + processInstanceKey: + type: integer + format: int64 + description: The key of the process instance. + decisionDefinitionKey: + type: integer + format: int64 + description: The key of the decision. + decisionDefinitionId: + type: string + description: The ID of the DMN decision. + decisionDefinitionName: + type: string + description: The name of the DMN decision. + decisionDefinitionVersion: + type: integer + format: int32 + description: The version of the decision. + decisionDefinitionType: + $ref: "#/components/schemas/DecisionInstanceTypeEnum" + description: The type of the decision. + tenantId: + type: string + description: The tenant ID of the decision instance. + DecisionInstanceSearchQueryResponse: + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/DecisionInstanceItem" + + DecisionInstanceItem: + type: object + properties: + key: + type: integer + format: int64 + description: The key of the decision instance. + state: + $ref: "#/components/schemas/DecisionInstanceStateEnum" + description: The state of the decision instance. + evaluationDate: + type: string + format: date-time + description: The evaluation date of the decision instance. + evaluationFailure: + type: string + description: The evaluation failure of the decision instance. + processDefinitionKey: + type: integer + format: int64 + description: The key of the process definition. + processInstanceKey: + type: integer + format: int64 + description: The key of the process instance. + decisionDefinitionKey: + type: integer + format: int64 + description: The key of the decision. + decisionDefinitionId: + type: string + description: The ID of the DMN decision. + decisionDefinitionName: + type: string + description: The name of the DMN decision. + decisionDefinitionVersion: + type: integer + format: int32 + description: The version of the decision. + decisionDefinitionType: + $ref: "#/components/schemas/DecisionInstanceTypeEnum" + description: The type of the decision. + result: + type: string + description: The result of the decision instance. + tenantId: + type: string + description: The tenant ID of the decision instance. + + DecisionInstanceTypeEnum: + enum: + - DECISION + - DECISION_TABLE + - LITERAL_EXPRESSION + - RELATION + - UNSPECIFIED + - UNKNOWN + DecisionInstanceStateEnum: + enum: + - EVALUATED + - FAILED + - UNKNOWN + - UNSPECIFIED + + MessageCorrelationRequest: + type: object + properties: + name: + description: > + The message name as defined in the BPMN process + type: string + correlationKey: + description: The correlation key of the message + type: string + default: "" + variables: + description: The message variables as JSON document + additionalProperties: true + type: object + nullable: true + tenantId: + description: the tenant for which the message is published + type: string + nullable: true + MessageCorrelationResponse: + description: | + The message key of the correlated message, as well as the first process instance key it + correlated with. + type: object + properties: + messageKey: + description: The key of the correlated message + type: integer + format: int64 + tenantId: + description: The tenant ID of the correlated message + type: string + processInstanceKey: + description: The key of the first process instance the message correlated with + type: integer + format: int64 + MessagePublicationRequest: + type: object + properties: + name: + description: The name of the message. + type: string + correlationKey: + description: The correlation key of the message. + type: string + default: "" + timeToLive: + description: Timespan (in ms) to buffer the message on the broker. + type: integer + format: int64 + default: 0 + messageId: + description: | + The unique ID of the message. Only useful to ensure only one message with the given ID + will ever be published (during its lifetime). + type: string + nullable: true + variables: + description: The message variables as JSON document. + additionalProperties: true + type: object + nullable: true + tenantId: + description: The tenant of the message sender. + type: string + nullable: true + required: + - name + - correlationKey + MessagePublicationResponse: + description: The message key of the published message. + type: object + properties: + messageKey: + description: The key of the message + type: integer + format: int64 + tenantId: + description: The tenant ID of the message. + type: string + + DocumentReference: + type: object + properties: + documentType: + type: string + description: Document discriminator. Always set to "camunda". + enum: + - camunda + storeId: + type: string + description: The ID of the document store. + documentId: + type: string + description: The ID of the document. + metadata: + $ref: "#/components/schemas/DocumentMetadata" + DocumentMetadata: + type: object + additionalProperties: true + properties: + contentType: + type: string + description: The content type of the document. + fileName: + type: string + description: The name of the file. + expiresAt: + type: string + format: date-time + description: The date and time when the document expires. + size: + type: integer + format: int64 + description: The size of the document in bytes. + DocumentLinkRequest: + type: object + properties: + expiresAt: + type: string + format: date-time + description: The date and time when the link expires. + nullable: true + DocumentLink: + type: object + properties: + url: + type: string + description: The link to the document. + expiresAt: + type: string + format: date-time + description: The date and time when the link expires. + + DeploymentResponse: + type: object + properties: + deploymentKey: + 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: + processDefinition: + $ref: "#/components/schemas/DeploymentProcess" + decisionDefinition: + $ref: "#/components/schemas/DeploymentDecision" + decisionRequirements: + $ref: "#/components/schemas/DeploymentDecisionRequirements" + form: + $ref: "#/components/schemas/DeploymentForm" + DeploymentProcess: + type: object + properties: + processDefinitionId: + type: string + description: | + The bpmn process ID, as parsed during deployment, together with the version forms a + unique identifier for a specific process definition. + processDefinitionVersion: + 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: + decisionDefinitionId: + 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. + decisionDefinitionKey: + type: integer + format: int64 + description: | + The assigned decision key, which acts as a unique identifier for this decision. + name: + type: string + description: The DMN name of the decision, as parsed during deployment. + tenantId: + type: string + description: The tenant ID of the deployed decision. + decisionRequirementsId: + type: string + description: | + The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment. + decisionRequirementsKey: + type: integer + format: int64 + description: | + The assigned key of the decision requirements graph that this decision is part of. + DeploymentDecisionRequirements: + type: object + properties: + decisionRequirementsId: + 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. + decisionRequirementsName: + 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. + decisionRequirementsKey: + 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 + oneOf: + - $ref: "#/components/schemas/CreateProcessInstanceRequestByKey" + - $ref: "#/components/schemas/CreateProcessInstanceRequestById" + CreateProcessInstanceRequestByKey: + type: object + allOf: + - $ref: "#/components/schemas/CreateProcessInstanceRequestBase" + 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 processDefinitionId. + type: integer + format: int64 + CreateProcessInstanceRequestById: + type: object + allOf: + - $ref: "#/components/schemas/CreateProcessInstanceRequestBase" + properties: + processDefinitionId: + description: | + The BPMN process ID of the process definition to start an instance of. + Cannot be used together with processDefinitionKey. + type: string + processDefinitionVersion: + description: | + The version of the process. Only considered when a processDefinitionId is provided. + By default, the latest version of the process is used. + type: integer + format: int32 + default: -1 + CreateProcessInstanceRequestBase: + type: object + properties: + 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 that 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 + fetchVariables: + description: | + List of variables names to be included in the response. + If empty, all visible variables in the root scope will be returned. + type: array + items: + type: string + 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: + processDefinitionKey: + description: | + The key of the process definition which was used to create the process instance. + type: integer + format: int64 + processDefinitionId: + description: | + The BPMN process ID of the process definition which was used to create the process. + instance + type: string + processDefinitionVersion: + 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 + MigrateProcessInstanceRequest: + type: object + properties: + targetProcessDefinitionKey: + description: The key of process definition to migrate the process instance to. + type: integer + format: int64 + mappingInstructions: + type: array + items: + $ref: "#/components/schemas/MigrateProcessInstanceMappingInstruction" + operationReference: + description: > + A reference key chosen by the user that will be part of all records resulting from this operation. + Must be > 0 if provided. + type: integer + format: int64 + minimum: 1 + required: + - targetProcessDefinitionKey + - mappingInstructions + MigrateProcessInstanceMappingInstruction: + type: object + description: | + The mapping instructions describe how to map elements from the source process definition to the target process definition. + properties: + sourceElementId: + description: The element ID to migrate from. + type: string + targetElementId: + description: The element ID to migrate into. + type: string + required: + - sourceElementId + - targetElementId + ModifyProcessInstanceRequest: + type: object + properties: + activateInstructions: + type: array + items: + $ref: "#/components/schemas/ModifyProcessInstanceActivateInstruction" + terminateInstructions: + type: array + items: + $ref: "#/components/schemas/ModifyProcessInstanceTerminateInstruction" + operationReference: + description: > + A reference key chosen by the user that will be part of all records resulting from this operation. + Must be > 0 if provided. + type: integer + format: int64 + minimum: 1 + ModifyProcessInstanceActivateInstruction: + type: object + description: | + Instructions describing which elements should be activated in which scopes and which variables should be created. + properties: + elementId: + description: The ID of the element that should be activated. + type: string + ancestorElementInstanceKey: + description: | + The key of the ancestor scope the element instance should be created in. + Set to -1 to create the new element instance within an existing element instance of the + flow scope. + type: integer + format: int64 + default: -1 + variableInstructions: + type: array + items: + $ref: "#/components/schemas/ModifyProcessInstanceVariableInstruction" + required: + - elementId + ModifyProcessInstanceVariableInstruction: + type: object + description: Instructions describing which variables should be created. + properties: + variables: + description: | + JSON document that will instantiate the variables for the root variable scope of the process instance. + It must be a JSON object, as variables will be mapped in a key-value fashion. + additionalProperties: true + type: object + scopeId: + description: | + The ID of the element in which scope the variables should be created. + Leave empty to create the variables in the global scope of the process instance + type: string + default: "" + required: + - variables + ModifyProcessInstanceTerminateInstruction: + type: object + description: Instructions describing which elements should be terminated. + properties: + elementInstanceKey: + description: The ID of the element that should be terminated. + type: integer + format: int64 + required: + - elementInstanceKey + + SetVariableRequest: + type: object + properties: + variables: + description: JSON object representing the variables to set in the element’s scope. + additionalProperties: true + type: object + local: + description: | + If set to true, the variables are merged strictly into the local scope (as specified by the `elementInstanceKey`). + Otherwise, the variables are propagated to upper scopes and set at the outermost one. + + Let’s consider the following example: + + There are two scopes '1' and '2'. + Scope '1' is the parent scope of '2'. The effective variables of the scopes are: + 1 => { "foo" : 2 } + 2 => { "bar" : 1 } + + An update request with elementInstanceKey as '2', variables { "foo" : 5 }, and local set + to true leaves scope '1' unchanged and adjusts scope '2' to { "bar" : 1, "foo" 5 }. + + By default, with local set to false, scope '1' will be { "foo": 5 } + and scope '2' will be { "bar" : 1 }. + type: boolean + default: false + operationReference: + description: > + A reference key chosen by the user that will be part of all records resulting from this operation. + Must be > 0 if provided. + type: integer + format: int64 + minimum: 1 + required: + - variables + + DeleteResourceRequest: + type: object + nullable: true + properties: + operationReference: + description: | + A reference key chosen by the user that will be part of all records resulting from this operation. + Must be > 0 if provided. + type: integer + format: int64 + minimum: 1 + + SignalBroadcastRequest: + type: object + properties: + signalName: + description: The name of the signal to broadcast. + type: string + variables: + additionalProperties: true + description: The signal variables as a JSON object. + type: object + tenantId: + description: The ID of the tenant that owns the signal. + type: string + required: + - signalName + SignalBroadcastResponse: + type: object + properties: + signalKey: + description: The unique ID of the signal that was broadcast. + type: integer + format: int64 + tenantId: + description: The tenant ID of the signal that was broadcast. + type: string + + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/api/generate-api-docs.js b/api/generate-api-docs.js index e8dd7335ebd..e6591537d92 100644 --- a/api/generate-api-docs.js +++ b/api/generate-api-docs.js @@ -1,60 +1,161 @@ const { execSync } = require("child_process"); -// More strategies to come, for other APIs. +// Each API has a custom strategy, for modifying the schema or generated docs. const operate = require("./operate/generation-strategy"); const tasklist = require("./tasklist/generation-strategy"); const adminsm = require("./administration-sm/generation-strategy"); const camunda = require("./camunda/generation-strategy"); +const zeebe = require("./zeebe/generation-strategy"); const apiStrategies = { operate, tasklist, adminsm, camunda, + zeebe, }; -// Execute a command as if we were in the terminal -function runCommand(command) { - const result = execSync(command, { stdio: "inherit" }); - return result; -} - // API name must be passed in as an arg. -const api = process.argv[2]; -if (api === undefined) { +const requestedAPI = process.argv[2]; +if (requestedAPI === undefined) { const validAPIs = Object.keys(apiStrategies).join(", "); console.log(`Please specify an API name. Valid names: ${validAPIs}`); process.exit(); } // The API name must be recognized. -const strategy = apiStrategies[api]; +const strategy = apiStrategies[requestedAPI]; if (strategy === undefined) { const validAPIs = Object.keys(apiStrategies).join(", "); - console.error(`Invalid API name ${api}. Valid names: ${validAPIs}`); + console.error(`Invalid API name ${requestedAPI}. Valid names: ${validAPIs}`); + process.exit(); +} + +// Version is an optional argument. If not provided, we assume "vNext". +const requestedVersion = process.argv[3]; + +// Hack: zeebe API is removed at version 8.7, don't allow regeneration in vNext. +if (requestedAPI === "zeebe" && requestedVersion === undefined) { + console.error("Zeebe API docs are no longer in active development."); process.exit(); } +// Find the corresponding configuration in docusaurus.config.js. +const configs = loadAPIConfigs(); +const apiConfig = buildAPIConfig(configs, requestedAPI, requestedVersion); + // All APIs will execute these same steps, with custom-per-API steps // implemented by each API's generation-strategy.js. const steps = [ // Remove old docs - () => runCommand(`docusaurus clean-api-docs ${api} -p api-${api}-openapi`), + () => runCommand(buildCleanCommand(apiConfig)), // Run any custom steps before generation - strategy.preGenerateDocs, + () => strategy.preGenerateDocs(apiConfig), // Generate the docs - () => runCommand(`docusaurus gen-api-docs ${api} -p api-${api}-openapi`), + () => runCommand(buildGenerateCommand(apiConfig)), // Run any custom steps after generation - strategy.postGenerateDocs, + () => strategy.postGenerateDocs(apiConfig), // Run prettier against the generated docs. Twice. Yes, twice. // I don't know why, but the first run always leaves an extra blank line, // which the second execution removes. - () => runCommand(`prettier --write ${strategy.outputDir}`), - () => runCommand(`prettier --write ${strategy.outputDir}`), + () => runCommand(`prettier --write ${apiConfig.outputDir}`), + () => runCommand(`prettier --write ${apiConfig.outputDir}`), ]; // Run the steps! steps.forEach((step) => step()); + +// ---------- vvvvvvv helper functions vvvvvvv ---------- + +// Execute a command as if we were in the terminal +function runCommand(command) { + const result = execSync(command, { stdio: "inherit" }); + return result; +} + +// Load the API configs from the docusaurus.config.js file. +function loadAPIConfigs() { + const config = require("../docusaurus.config"); + const apiConfigs = config.plugins + .filter( + (plugin) => + Array.isArray(plugin) && plugin[0] === "docusaurus-plugin-openapi-docs" + ) + .reduce((acc, plugin) => { + const [_, options] = plugin; + configObject = options.config; + const apiName = Object.keys(configObject)[0]; + acc[apiName] = configObject[apiName]; + return acc; + }, {}); + + // Reduce should give a shape like this: + // { + // "operate": { + // "specPath": "api/operate/operate-openapi.yaml", + // "outputDir": "docs/apis-tools/operate-api/specifications", + // ... + // "versions": { + // "8.6": { + // "specPath": "api/operate/version-8.6/operate-openapi.yaml", + // "outputDir": "versioned_docs/version-8.6/apis-tools/operate-api/specifications", + // ... + // } + // } + // }, + // "tasklist": { + // .... + + return apiConfigs; +} + +// Find the API config for the given API and version. +function buildAPIConfig(apiConfigs, requestedAPI, requestedVersion) { + const apiConfig = apiConfigs[requestedAPI]; + if (apiConfig === undefined) { + console.error( + `No configuration found for API ${requestedAPI}. Check docusaurus.config.js.` + ); + process.exit(); + } + + let matchingConfig = apiConfig; + + if (requestedVersion !== undefined) { + matchingConfig = apiConfig.versions[requestedVersion]; + if (matchingConfig === undefined) { + console.error( + `No config found for API ${requestedAPI} version ${requestedVersion}. Check docusaurus.config.js.` + ); + process.exit(); + } + } + + return { + apiName: requestedAPI, + specPath: matchingConfig.specPath, + outputDir: matchingConfig.outputDir, + version: requestedVersion || "next", + }; +} + +// Build the command to clean the API docs. +function buildCleanCommand(apiConfig) { + const { apiName, version } = apiConfig; + if (version === "next") { + return `docusaurus clean-api-docs ${apiName} -p api-${apiName}-openapi`; + } + return `docusaurus clean-api-docs:version ${apiName}:${version} -p api-${apiName}-openapi`; +} + +// Build the command to generate the API docs. +function buildGenerateCommand(apiConfig) { + const { apiName, version } = apiConfig; + if (version === "next") { + return `docusaurus gen-api-docs ${apiName} -p api-${apiName}-openapi`; + } + return `docusaurus gen-api-docs:version ${apiName}:${version} -p api-${apiName}-openapi`; +} diff --git a/api/operate/generation-strategy.js b/api/operate/generation-strategy.js index 47d5f7dc2d6..892500ee571 100644 --- a/api/operate/generation-strategy.js +++ b/api/operate/generation-strategy.js @@ -1,19 +1,17 @@ const { makeServerDynamic } = require("../make-server-dynamic"); const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); -const outputDir = "docs/apis-tools/operate-api/specifications"; -const specFile = "api/operate/operate-openapi.yaml"; - -function preGenerateDocs() { - makeServerDynamic(specFile); +function preGenerateDocs(config) { + makeServerDynamic(config.specPath); } -function postGenerateDocs() { - removeDuplicateVersionBadge(`${outputDir}/operate-public-api.info.mdx`); +function postGenerateDocs(config) { + removeDuplicateVersionBadge( + `${config.outputDir}/operate-public-api.info.mdx` + ); } module.exports = { - outputDir, preGenerateDocs, postGenerateDocs, }; diff --git a/api/operate/version-8.6/operate-openapi.yaml b/api/operate/version-8.6/operate-openapi.yaml new file mode 100644 index 00000000000..823e7248016 --- /dev/null +++ b/api/operate/version-8.6/operate-openapi.yaml @@ -0,0 +1,1999 @@ +--- +openapi: 3.0.1 +info: + title: Operate Public API + description: + To access active and completed process instances in Operate for monitoring + and troubleshooting + contact: + url: https://www.camunda.com + license: + name: License + url: https://docs.camunda.io/docs/reference/licenses/ + version: 1.0.0 +servers: + - url: "{schema}://{host}:{port}" + variables: + host: + default: localhost + description: The hostname of the API server. + port: + default: "8080" + description: The port of the API server. + schema: + default: http + description: The schema of the API server. +tags: + - name: ProcessDefinition + description: Process Definition API + - name: DecisionDefinition + description: Decision Definition API + - name: DecisionInstance + description: Decision Instance API + - name: FlownodeInstance + description: Flownode Instance API + - name: Variable + description: Variable API + - name: ProcessInstance + description: Process Instance API + - name: DecisionRequirements + description: Decision Requirements API + - name: Incident + description: Incident API +paths: + "/v1/variables/search": + post: + tags: + - Variable + summary: Search variables for process instances + operationId: search + requestBody: + description: Search variables + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryVariable" + examples: + All: + description: Returns all variables (default return list size is 10) + value: {} + Size: + description: "Returns 20 variables " + value: + size: 20 + Filter and sort: + description: + Returns all variables with 'processInstanceKey' '9007199254741196' + sorted ascending by name + value: + filter: + processInstanceKey: "9007199254741196" + sort: + - field: name + order: ASC + Paging: + description: + "Returns next variables for 'processInstanceKey' ascending + by 'name'. (Copy value of 'sortValues' field of previous results) " + value: + filter: + processInstanceKey: "9007199254741196" + sort: + - field: name + order: ASC + searchAfter: + - small + - 9007199254741200 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsVariable" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-instances/search": + post: + tags: + - ProcessInstance + summary: Search process instances + operationId: search_1 + requestBody: + description: Search process instances + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryProcessInstance" + examples: + All: + description: + Returns all process instances (default return list size + is 10) + value: {} + Sorted by field: + description: Returns process instances sorted ascending by bpmnProcessId + value: + sort: + - field: bpmnProcessId + order: ASC + Sorted and paged with size: + description: + "Returns max 3 process instances after 'bigVarProcess' + and key 6755399441055870 sorted ascending by bpmnProcessId \nTo + get the next page copy the value of 'sortValues' into 'searchAfter' + value.\nSort specification should match the searchAfter specification" + value: + size: 3 + sort: + - field: bpmnProcessId + order: ASC + searchAfter: + - bigVarProcess + - 6755399441055870 + Filtered and sorted: + description: + Returns max 50 process instances, filtered by processVersion + of 2 sorted ascending by bpmnProcessId + value: + filter: + processVersion: 2 + size: 50 + sort: + - field: bpmnProcessId + order: ASC + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsProcessInstance" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-definitions/search": + post: + tags: + - ProcessDefinition + summary: Search process definitions + operationId: search_2 + requestBody: + description: Search examples + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryProcessDefinition" + examples: + All: + description: All process instances (default size is 10) + value: {} + Size of returned list: + description: Search process instances and return list of size 5 + value: + size: 5 + Sort: + description: Search process instances and sort by name + value: + sort: + - field: name + order: ASC + Sort and size: + description: + Search process instances, sort descending by name list + size of 5 + value: + size: 5 + sort: + - field: name + order: DESC + Sort and page: + description: + "Search process instances,sort by name and page results + of size 5. \n To get the next page copy the value of 'sortValues' + into 'searchAfter' value.\nSort specification should match the searchAfter + specification" + value: + size: 5 + sort: + - field: name + order: ASC + searchAfter: + - Called Process + - "2251799813687281" + "Filter and sort ": + description: Filter by version and sort by bpmnProcessId + value: + filter: + version: 1 + size: 50 + sort: + - field: bpmnProcessId + order: ASC + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsProcessDefinition" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/incidents/search": + post: + tags: + - Incident + summary: Search incidents + operationId: search_3 + requestBody: + description: Search incidents + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryIncident" + examples: + All: + description: Returns all incidents (default return list size is 10). + value: {} + Return 20 items: + description: Returns max 20 incidents. + value: + size: 20 + Sort by field: + description: Returns incidents sorted descending by 'creationTime' + value: + sort: + - field: creationTime + order: DESC + Filter by field: + description: + Returns incidents filtered by 'type'. Field 'message' + can't be used for filter and sort + value: + filter: + type: UNHANDLED_ERROR_EVENT + Filter and sort: + description: + Filter by 'type' and 'processDefinitionKey', sorted descending + by 'creationTime'. + value: + filter: + type: CALLED_ELEMENT_ERROR + processDefinitionKey: "2251799813686167" + sort: + - field: creationTime + order: DESC + Page by key: + description: + Returns paged by using previous returned 'sortValues' + value (array). + value: + searchAfter: + - 2251799813687785 + Filter, sort and page: + description: + Returns incidents filtered by 'type' and 'processDefinitionKey', + sorted descending by 'creationTime' and paged from previous 'sortValues' + value. + value: + filter: + type: CALLED_ELEMENT_ERROR + processDefinitionKey: "2251799813686167" + sort: + - field: creationTime + order: DESC + searchAfter: + - 1646904085499 + - 9007199254743288 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsIncident" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/flownode-instances/search": + post: + tags: + - FlownodeInstance + summary: Search flownode-instances + operationId: search_4 + requestBody: + description: Search flownode-instances + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryFlowNodeInstance" + examples: + All: + description: + Returns all flownode instances (default return list size + is 10). + value: {} + Return 20 items: + description: Returns max 20 incidents. + value: + size: 20 + Sort by field: + description: Returns flownode instances sorted descending by 'endDate' + value: + sort: + - field: endDate + order: DESC + Filter by field: + description: Returns flownode instances filtered by 'incident'. + value: + filter: + incident: true + Filter and sort: + description: Filter by 'incident' , sorted descending by 'startDate'. + value: + filter: + incident: true + sort: + - field: startDate + order: DESC + Page by key: + description: + Returns paged by using previous returned 'sortValues' + value (array). Choose an existing key from previous searches to + try this. + value: + searchAfter: + - 2251799813687785 + Filter, sort and page: + description: + Returns flownode instances filtered by 'incident' , sorted + ascending by 'startDate' and paged from previous 'sortValues' value. + value: + filter: + incident: true + sort: + - field: startDate + order: ASC + searchAfter: + - 1646904085499 + - 9007199254743288 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsFlowNodeInstance" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/drd/search": + post: + tags: + - DecisionRequirements + summary: Search decision requirements + operationId: search_5 + requestBody: + description: Search examples + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryDecisionRequirements" + examples: + All: + description: All decision requirements (default size is 10) + value: {} + Size of returned list: + description: + Search decision requirements and return list of size + 5 + value: + size: 5 + Sort: + description: Search decision requirements and sort ascending by name + value: + sort: + - field: name + order: ASC + Sort and size: + description: + Search decision requirements, sort descending by name, + and return list of size 5 + value: + size: 5 + sort: + - field: name + order: DESC + Sort and page: + description: |- + Search decision requirements, sort ascending by name, and return page of size 5. + To get the next page, copy the value of 'sortValues' into 'searchAfter' value. + Sort specification should match the searchAfter specification. + value: + size: 5 + sort: + - field: name + order: ASC + searchAfter: + - Invoice Business Decisions + - "2251799813686550" + "Filter and sort ": + description: Filter by version and sort by decisionRequirementsId + value: + filter: + version: 1 + size: 50 + sort: + - field: decisionRequirementsId + order: ASC + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsDecisionRequirements" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/decision-instances/search": + post: + tags: + - DecisionInstance + summary: Search decision instances + operationId: search_6 + requestBody: + description: Search examples + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryDecisionInstance" + examples: + All: + description: All decision instances (default size is 10) + value: {} + Size of returned list: + description: Search decision instances and return list of size 5 + value: + size: 5 + Sort: + description: Search decision instances and sort ascending by decisionName + value: + sort: + - field: decisionName + order: ASC + Sort and size: + description: + Search decision instances, sort descending by decisionName, + and return list of size 5 + value: + size: 5 + sort: + - field: decisionName + order: DESC + Sort and page: + description: |- + Search decision instances, sort ascending by decisionName, and return page of size 5. + To get the next page, copy the value of 'sortValues' into 'searchAfter' value. + Sort specification should match the searchAfter specification. + value: + size: 5 + sort: + - field: decisionName + order: ASC + searchAfter: + - Invoice Classification + - "2251799813686550" + "Filter and sort ": + description: Filter by decisionVersion and sort by decisionId + value: + filter: + decisionVersion: 1 + size: 50 + sort: + - field: decisionId + order: ASC + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsDecisionInstance" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/decision-definitions/search": + post: + tags: + - DecisionDefinition + summary: Search decision definitions + operationId: search_7 + requestBody: + description: Search examples + content: + application/json: + schema: + "$ref": "#/components/schemas/QueryDecisionDefinition" + examples: + All: + description: All decision definitions (default size is 10) + value: {} + Size of returned list: + description: Search decision definitions and return list of size 5 + value: + size: 5 + Sort: + description: Search decision definitions and sort ascending by name + value: + sort: + - field: name + order: ASC + Sort and size: + description: + Search decision definitions, sort descending by name, + and return list of size 5 + value: + size: 5 + sort: + - field: name + order: DESC + Sort and page: + description: |- + Search decision definitions, sort ascending by name, and return page of size 5. + To get the next page, copy the value of 'sortValues' into 'searchAfter' value. + Sort specification should match the searchAfter specification. + value: + size: 5 + sort: + - field: name + order: ASC + searchAfter: + - Decide the Dish + - "2251799813686550" + "Filter and sort ": + description: Filter by version and sort by decisionId + value: + filter: + version: 1 + size: 50 + sort: + - field: decisionId + order: ASC + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ResultsDecisionDefinition" + "400": + description: Data invalid + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Not Found + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/variables/{key}": + get: + tags: + - Variable + summary: Get variable by key + operationId: byKey + parameters: + - name: key + in: path + description: Key of variable + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/Variable" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-instances/{key}": + get: + tags: + - ProcessInstance + summary: Get process instance by key + operationId: byKey_1 + parameters: + - name: key + in: path + description: Key of process instance + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ProcessInstance" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + delete: + tags: + - ProcessInstance + summary: Delete process instance and all dependant data by key + operationId: delete + parameters: + - name: key + in: path + description: Key of process instance + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ChangeStatus" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-instances/{key}/statistics": + get: + tags: + - ProcessInstance + summary: Get flow node statistic by process instance id + operationId: getStatistics + parameters: + - name: key + in: path + description: Key of process instance + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: + Success. Returns statistics for the given process instance, + grouped by flow nodes + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/FlowNodeStatistics" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-instances/{key}/sequence-flows": + get: + tags: + - ProcessInstance + summary: Get sequence flows of process instance by key + operationId: sequenceFlowsByKey + parameters: + - name: key + in: path + description: Key of process instance + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + "*/*": + schema: + type: array + items: + type: string + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-definitions/{key}": + get: + tags: + - ProcessDefinition + summary: Get process definition by key + operationId: byKey_2 + parameters: + - name: key + in: path + description: Key of process definition + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/ProcessDefinition" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/process-definitions/{key}/xml": + get: + tags: + - ProcessDefinition + summary: Get process definition as XML by key + operationId: xmlByKey + parameters: + - name: key + in: path + description: Key of process definition + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + text/xml: + schema: + type: string + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/incidents/{key}": + get: + tags: + - Incident + summary: Get incident by key + operationId: byKey_3 + parameters: + - name: key + in: path + description: Key of incident + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/Incident" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/flownode-instances/{key}": + get: + tags: + - FlownodeInstance + summary: Get flow node instance by key + operationId: byKey_4 + parameters: + - name: key + in: path + description: Key of flownode instance + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/FlowNodeInstance" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/drd/{key}": + get: + tags: + - DecisionRequirements + summary: Get decision requirements by key + operationId: byKey_5 + parameters: + - name: key + in: path + description: Key of decision requirements + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/DecisionRequirements" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/drd/{key}/xml": + get: + tags: + - DecisionRequirements + summary: Get decision requirements as XML by key + operationId: xmlByKey_1 + parameters: + - name: key + in: path + description: Key of decision requirements + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + text/xml: + schema: + type: string + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/decision-instances/{id}": + get: + tags: + - DecisionInstance + summary: Get decision instance by id + operationId: byId + parameters: + - name: id + in: path + description: Id of decision instance + required: true + schema: + type: string + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/DecisionInstance" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] + "/v1/decision-definitions/{key}": + get: + tags: + - DecisionDefinition + summary: Get decision definition by key + operationId: byKey_6 + parameters: + - name: key + in: path + description: Key of decision definition + required: true + schema: + type: integer + format: int64 + responses: + "200": + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/DecisionDefinition" + "400": + description: Invalid request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: Forbidden + content: + "*/*": + schema: + "$ref": "#/components/schemas/Error" + "404": + description: Requested resource not found + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: API application error + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + security: + - bearer-key: [] + - cookie: [] +components: + schemas: + Error: + type: object + properties: + status: + type: integer + format: int32 + message: + type: string + instance: + type: string + type: + type: string + QueryVariable: + type: object + properties: + filter: + "$ref": "#/components/schemas/Variable" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + Sort: + type: object + properties: + field: + type: string + order: + type: string + enum: + - ASC + - DESC + Variable: + type: object + properties: + key: + type: integer + format: int64 + processInstanceKey: + type: integer + format: int64 + scopeKey: + type: integer + format: int64 + name: + type: string + value: + type: string + truncated: + type: boolean + tenantId: + type: string + ResultsVariable: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/Variable" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + ProcessInstance: + type: object + properties: + key: + type: integer + format: int64 + processVersion: + type: integer + format: int32 + processVersionTag: + type: string + bpmnProcessId: + type: string + parentKey: + type: integer + format: int64 + parentFlowNodeInstanceKey: + type: integer + format: int64 + startDate: + type: string + endDate: + type: string + state: + type: string + enum: + - ACTIVE + - COMPLETED + - CANCELED + incident: + type: boolean + processDefinitionKey: + type: integer + format: int64 + tenantId: + type: string + parentProcessInstanceKey: + "$ref": "#/components/schemas/ProcessInstance" + QueryProcessInstance: + type: object + properties: + filter: + "$ref": "#/components/schemas/ProcessInstance" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsProcessInstance: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/ProcessInstance" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + ProcessDefinition: + type: object + properties: + key: + type: integer + format: int64 + name: + type: string + version: + type: integer + format: int32 + versionTag: + type: string + bpmnProcessId: + type: string + tenantId: + type: string + QueryProcessDefinition: + type: object + properties: + filter: + "$ref": "#/components/schemas/ProcessDefinition" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsProcessDefinition: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/ProcessDefinition" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + Incident: + type: object + properties: + key: + type: integer + format: int64 + processDefinitionKey: + type: integer + format: int64 + processInstanceKey: + type: integer + format: int64 + type: + type: string + enum: + - UNSPECIFIED + - UNKNOWN + - IO_MAPPING_ERROR + - JOB_NO_RETRIES + - EXECUTION_LISTENER_NO_RETRIES + - CONDITION_ERROR + - EXTRACT_VALUE_ERROR + - CALLED_ELEMENT_ERROR + - UNHANDLED_ERROR_EVENT + - MESSAGE_SIZE_EXCEEDED + - CALLED_DECISION_ERROR + - DECISION_EVALUATION_ERROR + - FORM_NOT_FOUND + message: + type: string + creationTime: + type: string + state: + type: string + enum: + - ACTIVE + - MIGRATED + - RESOLVED + - PENDING + jobKey: + type: integer + format: int64 + tenantId: + type: string + QueryIncident: + type: object + properties: + filter: + "$ref": "#/components/schemas/Incident" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsIncident: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/Incident" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + FlowNodeInstance: + type: object + properties: + key: + type: integer + format: int64 + processInstanceKey: + type: integer + format: int64 + processDefinitionKey: + type: integer + format: int64 + startDate: + type: string + endDate: + type: string + flowNodeId: + type: string + flowNodeName: + type: string + incidentKey: + type: integer + format: int64 + type: + type: string + enum: + - UNSPECIFIED + - PROCESS + - SUB_PROCESS + - EVENT_SUB_PROCESS + - START_EVENT + - INTERMEDIATE_CATCH_EVENT + - INTERMEDIATE_THROW_EVENT + - BOUNDARY_EVENT + - END_EVENT + - SERVICE_TASK + - RECEIVE_TASK + - USER_TASK + - MANUAL_TASK + - TASK + - EXCLUSIVE_GATEWAY + - INCLUSIVE_GATEWAY + - PARALLEL_GATEWAY + - EVENT_BASED_GATEWAY + - SEQUENCE_FLOW + - MULTI_INSTANCE_BODY + - CALL_ACTIVITY + - BUSINESS_RULE_TASK + - SCRIPT_TASK + - SEND_TASK + - UNKNOWN + state: + type: string + enum: + - ACTIVE + - COMPLETED + - TERMINATED + incident: + type: boolean + tenantId: + type: string + QueryFlowNodeInstance: + type: object + properties: + filter: + "$ref": "#/components/schemas/FlowNodeInstance" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsFlowNodeInstance: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/FlowNodeInstance" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + DecisionRequirements: + type: object + properties: + id: + type: string + key: + type: integer + format: int64 + decisionRequirementsId: + type: string + name: + type: string + version: + type: integer + format: int32 + resourceName: + type: string + tenantId: + type: string + QueryDecisionRequirements: + type: object + properties: + filter: + "$ref": "#/components/schemas/DecisionRequirements" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsDecisionRequirements: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/DecisionRequirements" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + DecisionInstance: + type: object + properties: + id: + type: string + key: + type: integer + format: int64 + state: + type: string + enum: + - FAILED + - EVALUATED + - UNKNOWN + - UNSPECIFIED + evaluationDate: + type: string + evaluationFailure: + type: string + processDefinitionKey: + type: integer + format: int64 + processInstanceKey: + type: integer + format: int64 + decisionId: + type: string + decisionDefinitionId: + type: string + decisionName: + type: string + decisionVersion: + type: integer + format: int32 + decisionType: + type: string + enum: + - DECISION_TABLE + - LITERAL_EXPRESSION + - UNSPECIFIED + - UNKNOWN + result: + type: string + evaluatedInputs: + type: array + items: + "$ref": "#/components/schemas/DecisionInstanceInput" + evaluatedOutputs: + type: array + items: + "$ref": "#/components/schemas/DecisionInstanceOutput" + tenantId: + type: string + DecisionInstanceInput: + type: object + properties: + id: + type: string + name: + type: string + value: + type: string + DecisionInstanceOutput: + type: object + properties: + id: + type: string + name: + type: string + value: + type: string + ruleId: + type: string + ruleIndex: + type: integer + format: int32 + QueryDecisionInstance: + type: object + properties: + filter: + "$ref": "#/components/schemas/DecisionInstance" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsDecisionInstance: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/DecisionInstance" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + DecisionDefinition: + type: object + properties: + id: + type: string + key: + type: integer + format: int64 + decisionId: + type: string + name: + type: string + version: + type: integer + format: int32 + decisionRequirementsId: + type: string + decisionRequirementsKey: + type: integer + format: int64 + decisionRequirementsName: + type: string + decisionRequirementsVersion: + type: integer + format: int32 + tenantId: + type: string + QueryDecisionDefinition: + type: object + properties: + filter: + "$ref": "#/components/schemas/DecisionDefinition" + size: + type: integer + format: int32 + searchAfter: + type: array + items: + type: object + sort: + type: array + items: + "$ref": "#/components/schemas/Sort" + ResultsDecisionDefinition: + type: object + properties: + items: + type: array + items: + "$ref": "#/components/schemas/DecisionDefinition" + sortValues: + type: array + items: + type: object + total: + type: integer + format: int64 + FlowNodeStatistics: + type: object + properties: + activityId: + type: string + description: The id of the flow node for which the results are aggregated + active: + type: integer + description: The total number of active instances of the flow node + format: int64 + canceled: + type: integer + description: The total number of canceled instances of the flow node + format: int64 + incidents: + type: integer + description: The total number of incidents for the flow node + format: int64 + completed: + type: integer + description: The total number of completed instances of the flow node + format: int64 + ChangeStatus: + type: object + properties: + message: + type: string + deleted: + type: integer + format: int64 + securitySchemes: + cookie: + type: apiKey + name: OPERATE-SESSION + in: cookie + bearer-key: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/api/tasklist/generation-strategy.js b/api/tasklist/generation-strategy.js index 3aa55a0c793..384db0851dd 100644 --- a/api/tasklist/generation-strategy.js +++ b/api/tasklist/generation-strategy.js @@ -2,30 +2,26 @@ const replace = require("replace-in-file"); const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); const { makeServerDynamic } = require("../make-server-dynamic"); -const outputDir = "docs/apis-tools/tasklist-api-rest/specifications"; -const specFile = "api/tasklist/tasklist-openapi.yaml"; - -function preGenerateDocs() { - fixImproperlyFormattedBreaks(); - makeServerDynamic(specFile); +function preGenerateDocs(config) { + fixImproperlyFormattedBreaks(config.specPath); + makeServerDynamic(config.specPath); } -function postGenerateDocs() { - removeDuplicateVersionBadge(`${outputDir}/tasklist-rest-api.info.mdx`); +function postGenerateDocs(config) { + removeDuplicateVersionBadge(`${config.outputDir}/tasklist-rest-api.info.mdx`); } module.exports = { - outputDir, preGenerateDocs, postGenerateDocs, }; -function fixImproperlyFormattedBreaks() { +function fixImproperlyFormattedBreaks(specPath) { // The source spec has many `
` tags in it, which is valid HTML, // but docusaurus does not like it. Make them `
` instead. console.log("fixing break tags..."); replace.sync({ - files: specFile, + files: specPath, from: /
/g, to: "
", }); diff --git a/api/tasklist/version-8.6/tasklist-openapi.yaml b/api/tasklist/version-8.6/tasklist-openapi.yaml new file mode 100644 index 00000000000..32ee7c05dfd --- /dev/null +++ b/api/tasklist/version-8.6/tasklist-openapi.yaml @@ -0,0 +1,1055 @@ +--- +openapi: 3.0.1 +info: + title: Tasklist REST API + description: + Tasklist is a ready-to-use API application to rapidly implement business + processes alongside user tasks in Zeebe. + contact: + url: https://www.camunda.com + license: + name: License + url: https://docs.camunda.io/docs/reference/licenses/ + version: v1 +servers: + - url: "{schema}://{host}:{port}" + variables: + host: + default: localhost + description: The hostname of the API server. + port: + default: "8080" + description: The port of the API server. + schema: + default: http + description: The schema of the API server. +security: + - cookie: [] + bearer-key: [] +tags: + - name: Form + description: API to query forms. + - name: Task + description: API to query and manage tasks. + - name: Variables + description: API to query variables. +paths: + "/v1/tasks/{taskId}/variables": + post: + tags: + - Task + summary: Save draft variables + description: + "This operation performs several actions:
  1. Validates + the task and draft variables.
  2. Deletes existing draft variables for + the task.
  3. Checks for new draft variables. If a new variable's `name` + matches an existing one but the `value` differs, it is saved. In case of duplicate + draft variable names, the last variable's value is kept.
NOTE:" + operationId: saveDraftTaskVariables + parameters: + - name: taskId + in: path + description: The ID of the task. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/SaveVariablesRequest" + required: true + responses: + "204": + description: On success returned. + content: + "*/*": {} + "400": + description: + An error is returned when the task is not active (not in the + `CREATED` state).
An error is returned if the task was not claimed + (assigned) before, except the case when JWT authentication token used.
An + error is returned if the task is not assigned to the current user, except + the case when JWT authentication token used. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "404": + description: + An error is returned when the task with the `taskId` is not + found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "500": + description: + An error is returned if an unexpected error occurs while persisting + draft task variables. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/tasks/{taskId}/variables/search": + post: + tags: + - Task + summary: Search task variables + description: + This method returns a list of task variables for the specified + `taskId` and `variableName`.
If the request body is not provided or if + the `variableNames` parameter in the request is empty, all variables associated + with the task will be returned. + operationId: searchTaskVariables + parameters: + - name: taskId + in: path + description: The ID of the task. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/VariablesSearchRequest" + responses: + "200": + description: On success returned. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/VariableSearchResponse" + "404": + description: + An error is returned when the task with the `taskId` is not + found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/tasks/search": + post: + tags: + - Task + summary: Search tasks + description: + Returns the list of tasks that satisfy search request params.
+ operationId: searchTasks + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskSearchRequest" + responses: + "200": + description: On success returned. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/TaskSearchResponse" + "400": + description: + An error is returned when more than one search parameters among + `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` + are present in request + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/tasks/{taskId}/unassign": + patch: + tags: + - Task + summary: Unassign a task + description: Unassign a task with `taskId`. Returns the task. + operationId: unassignTask + parameters: + - name: taskId + in: path + description: The ID of the task. + required: true + schema: + type: string + responses: + "200": + description: On success returned. + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskResponse" + "400": + description: + An error is returned when the task is not active (not in the + CREATED state).
An error is returned if the task was not claimed (assigned) + before. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "404": + description: + An error is returned when the task with the `taskId` is not + found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/tasks/{taskId}/complete": + patch: + tags: + - Task + summary: Complete a task + description: + Complete a task with `taskId` and optional `variables`. Returns + the task. + operationId: completeTask + parameters: + - name: taskId + in: path + description: The ID of the task. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskCompleteRequest" + responses: + "200": + description: On success returned. + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskResponse" + "400": + description: + An error is returned when the task is not active (not in the + CREATED state).
An error is returned if the task was not claimed (assigned) + before.
An error is returned if the task is not assigned to the current + user. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: User has no permission to access the task (Self-managed only). + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "404": + description: + An error is returned when the task with the `taskId` is not + found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/tasks/{taskId}/assign": + patch: + tags: + - Task + summary: Assign a task + description: + Assign a task with `taskId` to `assignee` or the active user. Returns + the task. + operationId: assignTask + parameters: + - name: taskId + in: path + description: The ID of the task. + required: true + schema: + type: string + requestBody: + description: + When using REST API with JWT authentication token following request + body parameters may be used. + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskAssignRequest" + responses: + "200": + description: On success returned. + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskResponse" + "400": + description: + An error is returned when the task is not active (not in the + CREATED state).
An error is returned when task was already assigned, + except the case when JWT authentication token used and `allowOverrideAssignment + = true`. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "403": + description: + An error is returned when user doesn't have the permission + to assign another user to this task. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "404": + description: + An error is returned when the task with the `taskId` is not + found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/variables/{variableId}": + get: + tags: + - Variables + summary: Get a variable + description: Get the variable details by variable id. + operationId: getVariableById + parameters: + - name: variableId + in: path + description: The ID of the variable. + required: true + schema: + type: string + responses: + "200": + description: On success returned. + content: + application/json: + schema: + "$ref": "#/components/schemas/VariableResponse" + "404": + description: + An error is returned when the variable with the `variableId` + is not found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/tasks/{taskId}": + get: + tags: + - Task + summary: Get a task + description: Get one task by id. Returns task or error when task does not exist. + operationId: getTaskById + parameters: + - name: taskId + in: path + description: The ID of the task. + required: true + schema: + type: string + responses: + "200": + description: On success returned. + content: + application/json: + schema: + "$ref": "#/components/schemas/TaskResponse" + "403": + description: User has no permission to access the task (Self-managed only). + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "404": + description: + An error is returned when the task with the `taskId` is not + found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" + "/v1/forms/{formId}": + get: + tags: + - Form + summary: Get a form + description: + Get the form details by `formId` and `processDefinitionKey` required + query param. The `version` query param is optional and is used only for deployed + forms (if empty, it retrieves the highest version). + operationId: getForm + parameters: + - name: formId + in: path + description: The ID of the form. + required: true + schema: + type: string + - name: processDefinitionKey + in: query + description: Reference to the process definition. + required: true + schema: + type: string + - name: version + in: query + description: The version of the form. Valid only for deployed forms. + required: false + schema: + type: integer + format: int64 + responses: + "200": + description: On success returned. + content: + application/json: + schema: + "$ref": "#/components/schemas/FormResponse" + "404": + description: + An error is returned when the form with the `formId` and `processDefinitionKey` + is not found. + content: + application/problem+json: + schema: + "$ref": "#/components/schemas/Error" +components: + schemas: + Error: + type: object + properties: + status: + type: integer + description: + An integer that represents the HTTP status code of the error + response. For example, 400 indicates a 'Bad Request' error, 404 indicates + a 'Not Found' error, and so on. + format: int32 + message: + type: string + description: + A string that provides a brief description of the error that + occurred. + instance: + type: string + description: Error instance UUID for lookup (e.g., in log messages). + SaveVariablesRequest: + type: object + properties: + variables: + type: array + description: Variables to update or add to the task. + items: + "$ref": "#/components/schemas/VariableInputDTO" + VariableInputDTO: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: + The value of the variable. When specifying the variable value, + it's crucial to maintain consistency with JSON values (serialization for + the complex objects such as list) and ensure that strings remain appropriately + formatted. + IncludeVariable: + type: object + properties: + name: + type: string + description: The name of the variable. + alwaysReturnFullValue: + type: boolean + description: Always return the full value of the variable? + default: false + VariablesSearchRequest: + type: object + properties: + variableNames: + type: array + description: Names of variables to find. + items: + type: string + includeVariables: + type: array + description: An array of variable names that should be included in the response. + items: + "$ref": "#/components/schemas/IncludeVariable" + description: Request object to search tasks variables by provided variable names. + DraftSearchVariableValue: + type: object + properties: + value: + type: string + description: The value of the variable. + isValueTruncated: + type: boolean + description: + Does the `previewValue` contain the truncated value or full + value? + previewValue: + type: string + description: A preview of the variable's value. Limited in size. + description: The draft value of the variable. + VariableSearchResponse: + type: object + properties: + id: + type: string + description: The unique identifier of the variable. + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + isValueTruncated: + type: boolean + description: + Does the `previewValue` contain the truncated value or full + value? + previewValue: + type: string + description: A preview of the variable's value. Limited in size. + draft: + "$ref": "#/components/schemas/DraftSearchVariableValue" + DateFilter: + type: object + properties: + from: + type: string + description: + Start date range to search from in date-time format outlined + in section 5.6 of the RFC 3339 profile of the ISO 8601 standard. + format: date-time + to: + type: string + description: + End date range to search to in date-time format outlined in + section 5.6 of the RFC 3339 profile of the ISO 8601 standard. + format: date-time + description: A range of due dates for the tasks to search for. + TaskByVariables: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: + The value of the variable. When specifying the variable value, + it's crucial to maintain consistency with JSON values (serialization for + the complex objects such as list) and ensure that strings remain appropriately + formatted. + operator: + type: string + description: + "The comparison operator to use for the variable.
* `eq`: + Equals" + enum: + - eq + TaskOrderBy: + type: object + properties: + field: + type: string + enum: + - completionTime + - creationTime + - followUpDate + - dueDate + - priority + order: + type: string + description: "* `ASC`: Ascending
* `DESC`: Descending" + enum: + - ASC + - DESC + description: Sort results by a specific field. + TaskSearchRequest: + type: object + properties: + state: + type: string + description: The state of the tasks. + enum: + - CREATED + - COMPLETED + - CANCELED + - FAILED + assigned: + type: boolean + description: Are the tasks assigned? + assignee: + type: string + description: Who is assigned to the tasks? + assignees: + type: array + description: The assignee is one of the given assignees. + items: + type: string + description: The assignee is one of the given assignees. + taskDefinitionId: + type: string + description: What's the BPMN flow node? + candidateGroup: + type: string + description: Given group is in candidate groups list. + candidateGroups: + type: array + description: At least one of the given groups is in candidate groups list. + items: + type: string + description: At least one of the given groups is in candidate groups list. + candidateUser: + type: string + description: Given user is in candidate user list. + candidateUsers: + type: array + description: At least one of the given users is in candidate user list. + items: + type: string + description: At least one of the given users is in candidate user list. + processDefinitionKey: + type: string + description: + Reference to process definition (renamed equivalent of TaskQuery.processDefinitionId + field). + processInstanceKey: + type: string + description: + Reference to process instance (renamed equivalent of TaskQuery.processInstanceId + field) + pageSize: + type: integer + description: Size of tasks page (default = 50). + format: int32 + followUpDate: + "$ref": "#/components/schemas/DateFilter" + dueDate: + "$ref": "#/components/schemas/DateFilter" + taskVariables: + type: array + description: + An array of filter clauses specifying the variables to filter + for.
If defined, the query returns only tasks to which all clauses + apply.
However, it's important to note that this filtering mechanism + is
designed to work exclusively with truncated variables. This means
variables + of a larger size are not compatible with this filter, and
attempts + to use them may result in inaccurate or incomplete query results. + items: + "$ref": "#/components/schemas/TaskByVariables" + tenantIds: + type: array + description: + An array of Tenant IDs to filter tasks. When multi-tenancy + is
enabled, tasks associated with the specified tenant IDs are returned;
if + disabled, this parameter is ignored. + items: + type: string + sort: + type: array + description: + An array of objects specifying the fields to sort the results + by. + items: + "$ref": "#/components/schemas/TaskOrderBy" + searchAfter: + type: array + description: + Used to return a paginated result. Array of values that should + be copied from sortValues of one of the tasks from the current search + results page.
It enables the API to return a page of tasks that directly + follow the task identified by the provided values, with respect to the + sorting order. + items: + type: string + searchAfterOrEqual: + type: array + description: + Used to return a paginated result. Array of values that should + be copied from sortValues of one of the tasks from the current search + results page.
It enables the API to return a page of tasks that directly + follow or are equal to the task identified by the provided values, with + respect to the sorting order. + items: + type: string + searchBefore: + type: array + description: + Used to return a paginated result. Array of values that should + be copied from sortValues of one of the tasks from the current search + results page.
It enables the API to return a page of tasks that directly + precede the task identified by the provided values, with respect to the + sorting order. + items: + type: string + searchBeforeOrEqual: + type: array + description: + Used to return a paginated result. Array of values that should + be copied from sortValues of one of the tasks from the current search + results page.
It enables the API to return a page of tasks that directly + precede or are equal to the task identified by the provided values, with + respect to the sorting order. + items: + type: string + includeVariables: + type: array + description: + An array used to specify a list of variable names that should + be included in the response when querying tasks.
This field allows + users to selectively retrieve specific variables associated with the tasks + returned in the search results. + items: + "$ref": "#/components/schemas/IncludeVariable" + implementation: + type: string + enum: + - JOB_WORKER + - ZEEBE_USER_TASK + priority: + description: Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks. + type: object + properties: + eq: + type: integer + minimum: 0 + maximum: 100 + gte: + type: integer + minimum: 0 + maximum: 100 + gt: + type: integer + minimum: 0 + maximum: 100 + lt: + type: integer + minimum: 0 + maximum: 100 + lte: + type: integer + minimum: 0 + maximum: 100 + description: Request object to search tasks by provided params. + TaskSearchResponse: + type: object + properties: + id: + type: string + description: The unique identifier of the task. + name: + type: string + description: The name of the task. + taskDefinitionId: + type: string + description: User task ID from the BPMN definition. + processName: + type: string + description: The name of the process. + creationDate: + type: string + description: + When was the task created (renamed equivalent of `Task.creationTime` + field). + completionDate: + type: string + description: + When was the task completed (renamed equivalent of `Task.completionTime` + field). + assignee: + type: string + description: The username/id of who is assigned to the task. + taskState: + type: string + description: The state of the task. + enum: + - CREATED + - COMPLETED + - CANCELED + - FAILED + sortValues: + type: array + description: + Array of values to be copied into `TaskSearchRequest` to request + for next or previous page of tasks. + items: + type: string + isFirst: + type: boolean + description: A flag to show that the task is first in the current filter. + formKey: + type: string + description: Reference to the task form. + formId: + type: string + description: + Reference to the ID of a deployed form. If the form is not + deployed, this property is null. + formVersion: + type: integer + description: + Reference to the version of a deployed form. If the form is + not deployed, this property is null. + format: int64 + isFormEmbedded: + type: boolean + description: + Is the form embedded for this task? If there is no form, this + property is null. + processDefinitionKey: + type: string + description: + Reference to process definition (renamed equivalent of `Task.processDefinitionId` + field). + processInstanceKey: + type: string + description: + Reference to process instance id (renamed equivalent of `Task.processInstanceId` + field). + tenantId: + type: string + description: The tenant ID associated with the task. + dueDate: + type: string + description: The due date for the task. + format: date-time + followUpDate: + type: string + description: The follow-up date for the task. + format: date-time + candidateGroups: + type: array + description: The candidate groups for the task. + items: + type: string + candidateUsers: + type: array + description: The candidate users for the task. + items: + type: string + variables: + type: array + description: + An array of the task's variables. Only variables specified + in `TaskSearchRequest.includeVariables` are returned. Note that a variable's + draft value is not returned in `TaskSearchResponse`. + items: + "$ref": "#/components/schemas/VariableSearchResponse" + implementation: + type: string + enum: + - JOB_WORKER + - ZEEBE_USER_TASK + priority: + description: The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks. + type: integer + minimum: 0 + maximum: 100 + default: 50 + TaskResponse: + type: object + properties: + id: + type: string + description: The unique identifier of the task. + name: + type: string + description: The name of the task. + taskDefinitionId: + type: string + description: User task ID from the BPMN definition. + processName: + type: string + description: The name of the process. + creationDate: + type: string + description: + When was the task created (renamed equivalent of `Task.creationTime` + field). + completionDate: + type: string + description: + When was the task completed (renamed equivalent of `Task.completionTime` + field). + assignee: + type: string + description: The username/id of who is assigned to the task. + taskState: + type: string + description: The state of the task. + readOnly: true + enum: + - CREATED + - COMPLETED + - CANCELED + - FAILED + formKey: + type: string + description: Reference to the task form. + formId: + type: string + description: + Reference to the ID of a deployed form. If the form is not + deployed, this property is null. + formVersion: + type: integer + description: + Reference to the version of a deployed form. If the form is + not deployed, this property is null. + format: int64 + isFormEmbedded: + type: boolean + description: + Is the form embedded for this task? If there is no form, this + property is null. + processDefinitionKey: + type: string + description: + Reference to process definition (renamed equivalent of `Task.processDefinitionId` + field). + processInstanceKey: + type: string + description: + Reference to process instance id (renamed equivalent of `Task.processInstanceId` + field). + tenantId: + type: string + description: The tenant ID associated with the task. + dueDate: + type: string + description: The due date for the task. + format: date-time + followUpDate: + type: string + description: The follow-up date for the task. + format: date-time + candidateGroups: + type: array + description: The candidate groups for the task. + items: + type: string + candidateUsers: + type: array + description: The candidate users for the task. + items: + type: string + implementation: + type: string + enum: + - JOB_WORKER + - ZEEBE_USER_TASK + priority: + description: The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks. + type: integer + minimum: 0 + maximum: 100 + default: 50 + TaskCompleteRequest: + type: object + properties: + variables: + type: array + description: Variables to update or add to task during the task completion + items: + "$ref": "#/components/schemas/VariableInputDTO" + description: + Request object with variables to update or add to task during the + task completion. + TaskAssignRequest: + type: object + properties: + assignee: + type: string + description: |- + When using a JWT token, the assignee parameter is NOT optional when called directly from the API. + The system will not be able to detect the assignee from the JWT token, therefore the assignee parameter needs to be + explicitly passed in this instance. + allowOverrideAssignment: + type: boolean + description: |- + When `true` the task that is already assigned may be assigned again. Otherwise the task + must be first unassigned and only then assigned again. + default: true + description: Request params used to assign the task to assignee or current user. + DraftVariableValue: + type: object + properties: + value: + type: string + description: The draft value of the variable + VariableResponse: + type: object + properties: + id: + type: string + description: The ID of the variable + name: + type: string + description: The name of the variable + value: + type: string + description: The full value of the variable + draft: + "$ref": "#/components/schemas/DraftVariableValue" + tenantId: + type: string + description: The tenant ID associated with the variable + FormResponse: + type: object + properties: + id: + type: string + description: The unique identifier of the embedded form within one process. + processDefinitionKey: + type: string + description: + Reference to process definition (renamed equivalent of `Form.processDefinitionId` + field). + title: + type: string + description: The title of the form. + schema: + type: string + description: The form content. + version: + type: integer + description: + The version field is null in the case of an embedded form, + while it represents the deployed form's version in other scenarios. + format: int64 + tenantId: + type: string + description: The tenant ID associated with the form. + isDeleted: + type: boolean + description: + Indicates whether the deployed form is deleted or not on Zeebe. + This field is false by default, in the case of an embedded form. + securitySchemes: + cookie: + type: apiKey + description: Cookie-based authentication is only available on Self-Managed clusters. + name: TASKLIST-SESSION + in: cookie + bearer-key: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/api/zeebe/generation-strategy.js b/api/zeebe/generation-strategy.js new file mode 100644 index 00000000000..38b93256112 --- /dev/null +++ b/api/zeebe/generation-strategy.js @@ -0,0 +1,45 @@ +const replace = require("replace-in-file"); +const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); + +function preGenerateDocs(config) { + hackChangesetDescription(config.specPath); +} + +function postGenerateDocs(config) { + removeDuplicateVersionBadge(`${config.outputDir}/zeebe-rest-api.info.mdx`); +} + +module.exports = { + preGenerateDocs, + postGenerateDocs, +}; + +function hackChangesetDescription(specPath) { + // This is a temporary hack, until https://github.com/camunda/camunda-docs/issues/3568 is resolved. + // The OpenAPI generator plugin we're using does not use the correct `description` property + // for the `UserTaskUpdateRequest` object. Instead of picking up the actual property description, + // it picks up the description of the first merged schema in the `allOf` property (i.e. from the `Changeset` schema). + // This adjustment replaces the description of the `Changeset` schema with the current description of + // the `UserTaskUpdateRequest.changeset` property. + console.log("hacking changeset description..."); + replace.sync({ + files: `${specPath}`, + from: /^ description: A map of changes.$/m, + to: ` 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.`, + }); +} diff --git a/api/zeebe/version-8.6/zeebe-openapi.yaml b/api/zeebe/version-8.6/zeebe-openapi.yaml new file mode 100644 index 00000000000..7bc6a5925e1 --- /dev/null +++ b/api/zeebe/version-8.6/zeebe-openapi.yaml @@ -0,0 +1,428 @@ +openapi: "3.0.3" +info: + title: Zeebe REST API + version: "0.1" + description: API for communicating with the Zeebe cluster. + license: + name: Zeebe Community License Version 1.1 + url: https://github.com/camunda/camunda/blob/main/licenses/ZEEBE-COMMUNITY-LICENSE-1.1.txt +externalDocs: + description: Find out more + url: https://docs.camunda.io/docs/apis-tools/zeebe-api-rest/overview/ + +servers: + - url: "{schema}://{host}:{port}/v1" + variables: + host: + default: localhost + description: The hostname of a Zeebe Gateway. + port: + default: "8080" + description: The port of the Zeebe REST API server. + schema: + default: http + description: The schema of the Zeebe REST API server. + +paths: + /topology: + get: + tags: + - Cluster + summary: Get cluster topology + description: Obtains the current topology of the cluster the gateway is part of. + responses: + "200": + $ref: "#/components/responses/TopologyResponse" + /user-tasks/{userTaskKey}/completion: + post: + tags: + - User task + summary: Complete a user task + description: Completes a user task with the given key. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task to complete. + schema: + type: integer + format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskCompletionRequest" + + responses: + "204": + description: The user task was completed successfully. + "404": + description: The user task with the given key was not found. + "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" + "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" + /user-tasks/{userTaskKey}/assignment: + post: + tags: + - User task + summary: Assign a user task + description: Assigns a user task with the given key to the given assignee. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task to assign. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskAssignmentRequest" + responses: + "204": + description: The user task's assignment was adjusted. + "404": + description: The user task with the given key was not found. + "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" + "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" + /user-tasks/{userTaskKey}: + patch: + tags: + - User task + summary: Update a user task + description: Update a user task with the given key. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task to update. + schema: + type: integer + format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskUpdateRequest" + responses: + "204": + description: The user task was updated successfully. + "404": + description: The user task with the given key was not found. + "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" + "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" + /user-tasks/{userTaskKey}/assignee: + delete: + tags: + - User task + summary: Unassign a user task + description: Removes the assignee of a task with the given key. + parameters: + - name: userTaskKey + in: path + required: true + description: The key of the user task. + schema: + 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": + 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" + "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" + +components: + responses: + TopologyResponse: + description: Obtains the current topology of the cluster the gateway is part of. + content: + application/json: + schema: + $ref: "#/components/schemas/TopologyResponse" + ProblemResponse: + description: Response for exceptional uses cases, providing more details. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + schemas: + TopologyResponse: + description: The response of a topology request. + type: object + properties: + brokers: + description: A list of brokers that are part of this cluster. + type: array + nullable: true + items: + $ref: "#/components/schemas/BrokerInfo" + clusterSize: + description: The number of brokers in the cluster. + type: integer + format: int32 + nullable: true + partitionsCount: + description: The number of partitions are spread across the cluster. + type: integer + format: int32 + nullable: true + replicationFactor: + description: The configured replication factor for this cluster. + type: integer + format: int32 + nullable: true + gatewayVersion: + description: The version of the Zeebe Gateway. + type: string + nullable: true + BrokerInfo: + description: Provides information on a broker node. + type: object + properties: + nodeId: + description: The unique (within a cluster) node ID for the broker. + type: integer + format: int32 + host: + description: The hostname for reaching the broker. + type: string + port: + description: The port for reaching the broker. + type: integer + format: int32 + partitions: + description: A list of partitions managed or replicated on this broker. + type: array + items: + $ref: "#/components/schemas/Partition" + version: + description: The broker version. + type: string + Partition: + description: Provides information on a partition within a broker node. + type: object + properties: + partitionId: + description: The unique ID of this partition. + type: integer + format: int32 + role: + description: Describes the Raft role of the broker for a given partition. + type: string + enum: + - leader + - follower + - inactive + health: + description: Describes the current health of the partition. + type: string + enum: + - healthy + - unhealthy + - dead + UserTaskCompletionRequest: + type: object + properties: + variables: + additionalProperties: true + description: The variables to complete the user task with. + type: object + nullable: true + 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 "complete". + type: string + nullable: true + UserTaskAssignmentRequest: + type: object + properties: + assignee: + description: The assignee for the user task. The assignee must not be empty or `null`. + type: string + nullable: false + allowOverride: + description: > + By default, the task is reassigned if it was already assigned. Set this to `false` + to return an error in such cases. The task must then first be unassigned to + be assigned again. Use this when you have users picking from group task + queues to prevent race conditions. + type: boolean + nullable: true + 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 "assign". + type: string + nullable: true + UserTaskUpdateRequest: + 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 + 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. + + 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 + additionalProperties: true + properties: + dueDate: + type: string + format: date-time + description: The due date of the task. Reset by providing an empty String. + nullable: true + followUpDate: + type: string + format: date-time + description: The follow-up date of the task. Reset by providing an empty String. + nullable: true + candidateUsers: + type: array + description: The list of candidate users of the task. Reset by providing an empty list. + items: + type: string + nullable: true + candidateGroups: + type: array + description: The list of candidate groups of the task. Reset by providing an empty list. + items: + type: string + nullable: true + ProblemDetail: + description: > + A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). + There may be additional properties specific to the problem type. + type: object + properties: + type: + type: string + format: uri + description: A URI identifying the problem type. + default: about:blank + title: + type: string + description: A summary of the problem type. + status: + type: integer + format: int32 + description: The HTTP status code for this problem. + minimum: 400 + maximum: 600 + detail: + type: string + description: An explanation of the problem in more detail. + instance: + type: string + format: uri + description: A URI identifying the origin of the problem. + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/docs/apis-tools/administration-sm-api/specifications/versions.json b/docs/apis-tools/administration-sm-api/specifications/versions.json new file mode 100644 index 00000000000..71ac271e29b --- /dev/null +++ b/docs/apis-tools/administration-sm-api/specifications/versions.json @@ -0,0 +1,12 @@ +[ + { + "version": "1", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + }, + { + "version": "8.6", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + } +] diff --git a/docs/apis-tools/camunda-api-rest/specifications/versions.json b/docs/apis-tools/camunda-api-rest/specifications/versions.json new file mode 100644 index 00000000000..71ac271e29b --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/versions.json @@ -0,0 +1,12 @@ +[ + { + "version": "1", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + }, + { + "version": "8.6", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + } +] diff --git a/docs/apis-tools/operate-api/specifications/versions.json b/docs/apis-tools/operate-api/specifications/versions.json new file mode 100644 index 00000000000..71ac271e29b --- /dev/null +++ b/docs/apis-tools/operate-api/specifications/versions.json @@ -0,0 +1,12 @@ +[ + { + "version": "1", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + }, + { + "version": "8.6", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + } +] diff --git a/docs/apis-tools/tasklist-api-rest/specifications/versions.json b/docs/apis-tools/tasklist-api-rest/specifications/versions.json new file mode 100644 index 00000000000..71ac271e29b --- /dev/null +++ b/docs/apis-tools/tasklist-api-rest/specifications/versions.json @@ -0,0 +1,12 @@ +[ + { + "version": "1", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + }, + { + "version": "8.6", + "label": "Unused but required field", + "baseUrl": "Unused but required field" + } +] diff --git a/docusaurus.config.js b/docusaurus.config.js index 60fb962e5c5..505d238ec5e 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -78,6 +78,18 @@ module.exports = { groupPathsBy: "tag", }, hideSendButton: true, + version: "1", + label: "Unused but required field", + baseUrl: "Unused but required field", + versions: { + 8.6: { + specPath: "api/operate/version-8.6/operate-openapi.yaml", + outputDir: + "versioned_docs/version-8.6/apis-tools/operate-api/specifications", + label: "Unused but required field", + baseUrl: "Unused but required field", + }, + }, }, }, }, @@ -96,6 +108,18 @@ module.exports = { groupPathsBy: "tag", }, hideSendButton: true, + version: "1", + label: "Unused but required field", + baseUrl: "Unused but required field", + versions: { + 8.6: { + specPath: "api/tasklist/version-8.6/tasklist-openapi.yaml", + outputDir: + "versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications", + label: "Unused but required field", + baseUrl: "Unused but required field", + }, + }, }, }, }, @@ -114,6 +138,19 @@ module.exports = { groupPathsBy: "tag", }, hideSendButton: true, + version: "1", + label: "Unused but required field", + baseUrl: "Unused but required field", + versions: { + 8.6: { + specPath: + "api/administration-sm/version-8.6/administration-sm-openapi.yaml", + outputDir: + "versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications", + label: "Unused but required field", + baseUrl: "Unused but required field", + }, + }, }, }, }, @@ -132,6 +169,48 @@ module.exports = { groupPathsBy: "tag", }, hideSendButton: true, + version: "1", + label: "Unused but required field", + baseUrl: "Unused but required field", + versions: { + 8.6: { + specPath: "api/camunda/version-8.6/camunda-openapi.yaml", + outputDir: + "versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications", + label: "Unused but required field", + baseUrl: "Unused but required field", + }, + }, + }, + }, + }, + ], + [ + // Zeebe REST API docs generation (removed at v8.7) + "docusaurus-plugin-openapi-docs", + { + id: "api-zeebe-openapi", + docsPluginId: "default", + config: { + zeebe: { + specPath: "inactive", + outputDir: "inactive", + sidebarOptions: { + groupPathsBy: "tag", + }, + hideSendButton: true, + version: "1", + label: "Unused but required field", + baseUrl: "Unused but required field", + versions: { + 8.6: { + specPath: "api/zeebe/version-8.6/zeebe-openapi.yaml", + outputDir: + "versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications", + label: "Unused but required field", + baseUrl: "Unused but required field", + }, + }, }, }, }, diff --git a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx index 43b170c8562..4b5a2e85e93 100644 --- a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx @@ -5,48 +5,162 @@ description: "Returns a list of all automation and management clusters. Each clu sidebar_label: "Get current clusters" hide_title: true hide_table_of_contents: true -api: eJzFV21v2zYQ/iuEvuyLIntvQGEMA7ygKzI0a9E4KLAgH2jpbLGmSJWk6rmG/vvujrIlvyQxsDcgiCXy7uHdcy88bRNbg5NBWXNTJJNkCeFaNz6A80maOPC1NR58Mtkm343H9FOAz52qSQPl361QLLcmgAm0K+taq5zxRp88iWwTn5dQSXpSASrGqh0dG1REbhpV0G/Y1ICYPjhlloh7eNS9UZ8bEKrAo9RCgRN2IUIJIo8GJ22aGFnBy0i/o9QTyr6W+YUILDrEEMoL1xiDCkKZjCB9kKHxp7TdmIJYAi/UQsghQAlSh3IjrBPGBjz42BAwTZVMHpJOEFcaM3xeGbs2ySMqqqBJ8xojaDXc3U6LSplprbK7aBXatwTTRf9ln2clmod/7HHjHIZBfME8wd0dmTvvB6RGzGP/P8I3DkShfEDxRvmStOYQ1gBGyCbYio0S0hSikkYuoaLjOlyfidvTReQcHwsQgxwka2UQMg9iqe1car1BMYTF/xgbraEQnL1/hlRotQLRsUX839oCNLhMTHuD9odJF2P/B8Acjm0gbw6sYOh3XGmQipn0K42+s3vvkJNKfYXsmVj3jOBiz8fzUe7qeEaYGAi0xz9Tg0/EidnrPTlM8WHyd/QxHempq6nIsuc8/Ep6V3NnV5g2afe6RIi1pLSOTQoIoAPkxcgccRJDFXsR8YBPsVGEi6tiWtc7rv5WOxrQdXkLMMcs/7d9oHH6kgYAom7maKW4//D2CXf/pY5ydIoDiUUG3l9m9V78GcMrQP38QsBO+Ek4NvFzoxwUFCMG5LTa50Pk/ICvx32Q7fwT5BR0WRSK9qR+P6jWhdQeXkjlvvcm0jkuolM3uAmh/Qe96nx9n/jEl3Z34w7vzoGHA9/SHQfchv45T6+Pb5rO27Yle38Yf39aeL9aN1cFli0p/XhuqLkDh2l45bG2BThno/OHMh8gNA7Zkj2JWl90db2Webm/8XHLbfgKksr445T3jIKLyonIKvdQufQUgf2ghnR6wAKiZjd52CZzwNvJ4eNji1u1dBgcFsQVTvTSdrNeQtuhxJeRJEqvZK1GeT8AembCMyr3iGQbp7l2MhptS+tDO9nW1oUWhb9Ip+Rcx/uE9iKzC9lofEy0zaXm5XOpSBtmMJdN39+IeDoPUnTGIdyr8avx+RaFok+g9JNoj1OGUJ/FicJnkdp2QPkdyUWnd8TvW0gHzlD03gmk3QOmImYLrv/2ccY5pszCsvphwou7W8EpT2acGDvNc2pt3IRICPMxVh0bjfb3KJQ+XYdFxW+zcTbu5ncckXgU5yCT2R4jvF6vs1xWjSlkltuKKMQ+AfhFQLJx2E7edivpkXJhc7/XVpbfRw4WgH0+h1EH5EfseI3hx2oZwL6BsL8UBhl54Pq2//T4XwsyBpumyFGtUW9wpcbywhFuV17E96BwY508JNvtXHq4d7ptaRlHC7eJ9borK67nlO77got7m6xg04W/Dlx/uuEOePwN1g6r/s3rGbXbhsza5+lRXjL6rp+azQD7p19YQMxwUDM/40a0IdArnoOV8RcY7wHV +api: eJzFV9tu2zgQ/RViXnYXYGzvDSj0ZgRtkUWzKRoHBdbwA02NLdYUqZBUs66gf18MKcvyJYmBvT1ZooaHM2dmDscN2AqdCMqamxwyWGO41rUP6DxwcOgrazx6yBr4aTKhnxy9dKqiHZDB3QY4SGsCmkBfRVVpJSPe+Isnkwa8LLAU9KQClhGrcnRsUAm5rlVOv2FbIWTgg1NmDfzoqAejHmtkKkcT1EqhY3bFQoFMJoeh5WBEia8j/S5KfGazr4S8ECGaDjGY8szVxiizZsqMCNIHEWp/StuNyYkl9EytmBgCFCh0KLbMOmZsAH7iCJq6hGwOnSFwqM3weWPsk4EFh6CCpp3X1nir8f52mpfKTCs1uk9etRzWaLrsvx7zrFCePIwR186hCewrOq+s2ZG5i35AasI8jv8zfueQ5coHZda18gXtWmJ4QjRM1MGW0SkmTM5KYcQaSzquw/Ujdnu6yJSRus6RDWqQvBWBCRnYWtul0HrLFMEyZXwQWmPOYvX+GTjTaoOsY4v4v7U5anQjNt071B8mXMr9H4hLPPaBojnwIkLfxU5DzmbCb7TyIYZ3VwVVqm84eiHXe0aAw56Pl7Pc9fGMMFtOnelf6MFn8hTZ20dyWOLD4u/oi3Tw01A5G41eivAb7btaOrtBB7x7XYuAT4LKOokUEkAHGBcTc8RJSlXSIuIBOCShCBd3xbSqdlz9LTka0HW5BJhjlv9bHaidvkQAkFX1UivJHj59eCbcf0lRjk5xKHJl0PvLvO7NX3C8xOCUvBCwM34WLrr4WCuHOeUoAsay6ushcX7A16JPsl1+QUlJF3mu6JvQHwfduhLa4yulvNdeEM7FJjoNI4qQXR1q1fn+PokpXtrdjTu8OwcRDmLjOw6iDP1zkV4f3zRdtG1L/v4y+fm08d5Zt1R5jjHrv54bau7RfUV35VWODJ2zKfhDm08Yamc8E3sStb7o6norZNHf+GiC28YrSCjjj0veR5RQoHIssRo1VKw9ZaAf1BYcPMrakdhl8waWKBw6yOaLdsGhEk6UGA2z+SIWemG7WQ/ocyggg7EgSq9EpcZyPwD6yISPqFEjoEnTXJuNx01hfWizprIutMDhq3BKLHW6T+hbYnYlah0gA22l0HH5XCnSBzOYy6Yfb1g6PQ5SdMYh3JvJm8l5ibIuPIOyn0T3OEUI1VmcZHwWqW0HlN+TXQp6R3wvIR14hKL3zoB3D++sKwU58dvnWawxZVY2bu8KPta58iF1UXTi+3vUq6s0/+Q/nHg+lZJ0LirS6Wa76gecIQxVVSe8kMGPo8lo0o31QkbaU+4pGp+Nx09PTyMpytrkYiRtScxqJdH4OEGkGRw+dCv8aHNupe93Kxvfxw5X6NBIHHdAfhz5qKwPpTAD2PcY+rtiUKgHJDT7fyT/a5+mGqDhclxpoczgpk1dN4e+64jvQT+n9plD0yyFxwen25aWH2t029TGu26Lbc5pDMhjzzewwW1XCFWIbanrKIzHf83aoRi8fzsjFa7Jrb58j8o1ou9k1mwH2E2TLGZ2g6YlMUhOBHqHdtG27V8VCQwO sidebar_class_name: "get api-method" -info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api +info_path: versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/administration-api-self-managed 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get current clusters

+ - + Returns a list of all automation and management clusters. Each cluster entry contains the running apps and their status. -## Request + -
+ -Ok + -
Schema
  • Array [
    • apps object[]required
    - -The list of applications running in the cluster - -
  • Array [
  • ]
  • ]
- -Forbidden - -
- -Server-side error - -
+ diff --git a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx index 1de2f6077bd..0a4b7e86ad7 100644 --- a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx @@ -5,59 +5,152 @@ description: "Returns usage metrics for a specific cluster for a given time rang sidebar_label: "Get usage metrics for clusters" hide_title: true hide_table_of_contents: true -api: eJzlV9tu4zYQ/RVCTy3g2O4NWARFgXTRXaRo2sXGQQsEeRhTY5kbidSSlLOGoH/vDClZsi0b2zZBH/YlkcThmTO3Q7pOTIkWvDL6Ok0ukwz9nYMMb9BbJV0ySSy60miHLrmsk2/nc/6XopNWlbyL9vzxSGbSaI/a8yqUZa5kwJx9cGxSJ06usQB+Ki179CoCqpT/+m2JBOTIp84IbB9/sUahUgJXK4VWmJXw9EXmlfNop0kzYUyJzl1r50HLiHyMUXFgooiRiZWxgsytx1S0+4XqAKbJ5ICoNx7yAVddFUu0ZEY4BVDcSWqqZY6j7KMxMz/mAMKVKCk0KRia4mk46R8rZZGSc996fph0ns3yA0pPfiBNFTuB/N2A6gpyh2SsfM7Wr6l2Jsfbm6u0UPqqVNNhffuMNcxbKseN8E/TiJ9QVpzHDuELT6QH93jn0H52AsE5lWlKIO+kddr6vyaOUhIZtUPqsXDHc9rsMgnWwnbUb4iF5hV8iM2JNWxQLBH1IGhzqlZDHi9Tt8WuVIcMSJlGhGVsSoYFfxmWb4x9HeWOaDLR7+ffHfcWWS1VSkLJlflhTKlv0W7QXjhSU4HWGhui3rd5j76y2p3vk1Z828+Z2lA9vSpQWNAZTsVxm4NFAVlmMQNWCkM8goz3uwTolISDoNNhv57U6Mk53ZkEtBNz5SFzXOKQYtEddVQ6R3hW+S0t1skSibOlx4eGlkqwQLGEob4fnWqtPlZnDiryq9iWjCzPiiY4eg1t1vedtxV1RX9aHkxcMxlzHVIUMklPRdk5HqbWibvfr/8a2CgtCpXnikI2OnUn2AXkswSPxWdfnk5QRqrOSxAm3P9Il2pNdV6b9jbEIgB+TS8z4NG8gFLNQmtfFLs7kgtzFTujsiTSSR1dNpezWb02zjeXdWmsb8h4A1YB+Q6KymtxTldQ5UwsNxLy8HlMT3mBQ+1SdvXuWkTv8SJEPvbhXs1fzUeR2PQESp+uHmftfTmKE41HkUIyu5m6ZbsYdDdZu/ZuwQMUv7cGk/bhTVe0X/9cBMVSemXC9n31FLc3Iugn0zgieyWDfjDLUElFQxUuqYE08e9RWCS4oHHjN9P5dN5ecUGG/MYiM21HFX56eppKKCqdwlSaglNIF2CkSzPbtp35W/tlcrA5NdLtdisT3mcWV2iRhGzWArlZCLyk8hegB7Bv0Y9Idas57jAJdX9P/yKEPraXx09+VuagwskY0l+3U32f7KaaK7M319S8cTzvk7pegsM7mzcNf46iE84B5XiW092BfjLdX71vRelr8ZnHxSj7R9x2p8YG8ooNkiCx/5bI8xweZ7h2Z8jz0H2Og+MM2Xh+9FQfer0ONwFqCYQ0XAvqdgvrSjkM8Oj3796Z8vaXBV8KK+6+nQAeCF5A7+7WejvA/vHnYCAW5hH1T0lH2/Mr+SHJ/Rs/aYl5 +api: eJzlV01v2zgQ/SvEnFqAsb1fQKFbUGyKLDa7RZNgFzB8GJNjm41EKiSVNBD034uhJFuxZW93kWAPvSSWPHx8fDPzhq7BleQxGmcvNWSwpngbcE1XFL1RASR4CqWzgQJkNfw4m/E/TUF5U/IqyODPO5CgnI1kI3+LZZkblTCnnwOH1BDUhgrkT6XnHaNpAY3mv/GpJMggRG/sGuQe/s2GhNFko1kZ8sKtRNyQUHkVIvkJNJIxFYVwaUNEq1rkQ4yKDyaK9mRi5bwIEX0kLbr1wvQAE5B7RKOLmA+42qpYkgcJK+cLjJCBdtUyp1H2bTAzP+SAIpSkzMoowdATaBoW/b4ynjRk827nhex3dsvPpCJIQK0Nb4L5xwHVFeaBJEQTc45+72xwOV1fnevC2PPSTIb53SnWMG9lAhfCv5WRvpCqWMce4TsXMmK4uw3kv1lADMGsLWnBK0XFS/9X4SR0jLomjVSEwz5ttkqi9/g0um86i4gbjOlsQWzwgcSSyA4O7Y7lasjjdfJ2s03VPgOjYcRYxrpkmPDXYXnh/PvW7qBpmOjPs58Oa+vC+aXRmixn5pcxp74m/0D+LBhNgrx3Pp36ecwnipW34XSddObbvV6bB7IimoKER7umiTgsc/QkcL32tEZ2CvdAPtn4bpVAq4WxKq/0sF6PerQ85TsyoR3pq4jrwClOEot+1C0kBFKVN/EJsnkNS0JPHrL5ollIKNFjQTE19Xy0q625r04MKpBgOPa+Is+9YrHgxKcy29Vd9BXJwbTc67hGjm2dJEpKhohF2W88lDaI2z8u/x7EGCsKk+cmkHJWhyPsEvJJgofm89yejlAmq1+FMNnTev4z3YWEguLGdbchNgGMG8hgityaZ1iaaSrts2J7Rwqpr9rKqHwOGdTtlk02ndYbF2KT1aXzsQEJD+gNLvPWWvm7tk9XWOVMLHcK8/R6zE/5Cz5qL9n5x0vR7t5ehJzfg3s3ezcbReLQIyg7uXY4mxjLUZw2eBQpidn31DXHtYfuO2tb3h14guLnLkB2Hy76pP32101yLGNXLi3v3DOZpgmxvcgmEm+uKV+dXaHFNem3B8zPVTITpoyHi91KdIYshjDsHZznFuKHyWwy626+qJLsbe75NCGbTh8fHycKi8pqnChXsLK5UWQDcWxXsL93b+TeYu1U2K42Lj1PPa3Ik1U07YDCNOlRuhALtAPYDxRHHLyzorAvR727vn8X/t9WXaQvcVrmaNLATPLXXbPPYdvsnJln7b6QXdfOoa6XGOjW503Dr1svSuPBBG5xvZ3zR+V+86nzqrfiG6fIKPs7euqHyQPmFQdAct7/SuRlZsoJrv1oeRm6LzFPTpBtx8qO6mJn4+mCIGFDqNNtoe6WsMOUwwMe/Cx+Nmo+/HrDd8WKq2/ri3s+mND7K7d9GmDXdRtx4+7INjxlWhKRn6FZNE3zFavQk7I= sidebar_class_name: "get api-method" -info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api +info_path: versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/administration-api-self-managed 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get usage metrics for clusters

+ Returns usage metrics for a specific cluster for a given time range. The usage metrics are aggregated over the time range and include number of started process instances, executed decision instances, and assigned task users. -## Request - -

Query Parameters

- -Ok - -
Schema
    processInstances objectrequired
    - -The usage metrics for started process instances. - -
    decisionInstances objectrequired
    - -The usage metrics for executed decision instances. - -
    taskUsers objectrequired
    - -The usage metrics for assigned task users. - -
- -Forbidden - -
- -Server-side error - -
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sidebar.js b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sidebar.js deleted file mode 100644 index 5c1953863bc..00000000000 --- a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sidebar.js +++ /dev/null @@ -1,30 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/administration-sm-api/specifications/sm-admin-api", - }, - { - type: "category", - label: "Usage Metrics", - items: [ - { - type: "doc", - id: "apis-tools/administration-sm-api/specifications/get-usage-metrics", - label: "Get usage metrics for clusters", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Clusters", - items: [ - { - type: "doc", - id: "apis-tools/administration-sm-api/specifications/get-clusters", - label: "Get current clusters", - className: "api-method get", - }, - ], - }, -]; diff --git a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sidebar.ts b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sidebar.ts new file mode 100644 index 00000000000..7a427bc25ef --- /dev/null +++ b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sidebar.ts @@ -0,0 +1,36 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "version-8.6/apis-tools/administration-sm-api/specifications/administration-api-self-managed", + }, + { + type: "category", + label: "Usage Metrics", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/administration-sm-api/specifications/get-usage-metrics", + label: "Get usage metrics for clusters", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Clusters", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/administration-sm-api/specifications/get-clusters", + label: "Get current clusters", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx index 5d84abb5475..2c017af2d29 100644 --- a/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx +++ b/versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Administration API (Self-Managed)

+ Access the administration API of Console Self-Managed.
-

- Authentication -

+
@@ -53,9 +61,7 @@ Access the administration API of Console Self-Managed. >

Contact

- - URL: https://www.camunda.com - + URL: [https://www.camunda.com](https://www.camunda.com)

License

diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx index 5370a7cc20c..8b8d03ceb6e 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx @@ -5,52 +5,288 @@ 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: eJztWVtz2zYW/isYvmwylSW1m7ZZ9TKj2mmrtHU9ttLdGccPIAlJiEmCBUDJqkb/vd8BeJNIJcrs7lucsSMSB+f6nQugXWD50gST++C1CoOHQRALE2mZW6myYBLMrNDcCmZXWhXLFeNJwh4ztclYzrWVRGUYz2LGIyvXRPlOhYYVObMKmwTT4s9CGCtilvInmRbp8G0WDILy9Q8q3gaTnXuUWsTBxOpCDIJIZVZklpZ4nicy4iRp9M6QUrvARCuRcvpkt7mAmip8JyILvrlWuYBiwjSruyObSC1oyWh1wLhhsVjIDBrKzKn8w81v1wyMImEMeyaGyyH79i8hQjGx3DxeEbEz3DH47m2Q820KZS+M0GsZibcBG33/3FlZamesltky2A+CjdKPQverlPFUMLVwKni6yqnYzEqlzYClythkywoDjRdKs0Qtl0SRFzpXBoYfyx0EWZEkPEyEdy/0sDIVqrBdRbjzjBa20OQRvkD8IVsaFlHoNxJ/MmVZKOqIxyzcAgIKGmpPVWRWJk7jUg57Btem5jlbwduhEBkkcMQwbntJIuRLOGcQwKqUW//qqxfkN2AH8DRzNS2F9ruwhJjHIABYgxIaOiNK2H1I6D+/IKELYaPVH1xL77quqxJpLEVsXdI4mW4XoaqCWb36DZMLJtLcbgcuj9bSSLxvbee29hrxrcIPqFGgaclEwHeFEuLuIhKKOmRtj3Kt+bYT/kEgrUhb+VHjc1/n5fwUPuZNSteiI5XmiSAgbFYILYxIBCfPZF5F+L3BCuyoQFVzmh+iZMhmi77l79gYjqNs5UVia2yBPeXCqV3f0q5EUYKoJKFEwYZYGnJI7EpXaxOtNebINBWxhNoJIibWsM0ZmKmOWcOzgEzF1ekeTMZ9SSkyntlZbN6HtdmVceF3tMbhYrOSQFwb7oT/LgxOhb2jSokDX5DvPXlTM/qy8YGWLTGgNjKtcXtb5tt+75maHP3C1+YvxuN+eFWWNpghc4bBR3SFc5k2PjrRQBxR47FTnjyx+1Fs++sUFgjJRSbhHiZjGCUXEklRpTnknlcYT3c4WmkXimdmpYqE2jDVp80KabrhpunPz/v6VdkFZ5mxPIvEL6cMgoB/mLpnypKc7DzPjHJn01tncb+gME+zWs7sqmVgS35cs3mPTY2sP4Q20kOoK3DtF88X9L6O0hF90qHw3H8r0ntWJIKGk1P+5MaoSLqEoOGGleRwbZ/rKmYfgkMJbDKiBPe2mmGOBA4q2o1Eg866Pe4YU+dODFFhrEp/FjxGAPsKqhGuIHg6tvKE9SgYF2QzZq1YuKbxTWsmQt3HbvTsRP6F59d3v1+zWEUFuaanovA4dvHiyU2rOpQ1/yMHQl/qmyLmhpqDYtEECwrrshD1xD1VmNKIe0mGnr2wfmj3LOuCwZMN39LYhgZqYMlaPD8P7TF8Ct/11CfXRqvCFPHscJzkSy6zAVwMBZ2z31zP/sNErqjLoQkBCGl+Hgrq0aqrw5QmsHryqmax8tTicsHhcODmgcLpZdsTGWnysdGuOnx/j2rKmafDR4jEWct0e0JrZKsab9WMYzrI7dsrRy3ZN+GyJ7841YaReGskL1KBW07DDo39a2C+HHZONGNsgx/Tzz7UlKfsxlMi5SzHccF70B/HiDD0B7L72x8v2b9efPn1w7OVtbmZjEabzWaoF9EFZjOr9FDp5QiP9Et0GB+hvqbDwNbhqg4Ia7ozM7mI0HKjKuCl2q5rHgxzHzhZHp+0agiifgTHh+kpe3M761TEA9HtGTHgIeatSZjw7DFowtkVeizFFGnK9bZVQlsCwAgJZIv2/HIyi495EzB+ns9vmGeB3IhFObRIUwkiI1I0KZzEggnw5QZG//TVeOwKA0X8DEsyJp5ymO8z7sgcOiwoxNlzc4ZVTeJ/FBmlJU7WR3KHB0lXgvjKW+RT6su+lIIt5GVNOBRaw2Uqigqt3alJJnWjq2SXc9mnXPuUa59y7VSu0c2QsCuFhhpgOHHQ4XaFpxGd3EZNu8YKXc+5WfB+B73gkmDnE2YPnO9W2L6f7HKl7X60pmgczA607BOrAkyiIp6svNBu4GihPb9d8rTIYs5esttXd3P2E/o0pirnSBJ5yPrl+OW4lyuRnuA4vZkxb6GHXasUVGwpp3vZeuJzGO/3D+RIFC5pt3e0zbsnFFwLPS3I9zUcSnmOOz17IrzxH36sQPL633MXZypjt8298KsnThcxffiqpubmTX2hOe69LBx3bvPuq70P3Uuv8cFdTEPpUL9QTqMSk11nEXKqA2UwHn7exT8cSmmMuRJ7XS1HDtD5B6Nuwy9KcDIhpw8CFHxBExvkEqZaYn/1K6w8wrLPhwQcj+6qhC/BuQiHEDeK/Lb6/zBR4SjFtD0qRZjR5fS3N9dX04tfZ5evru9eXYDj0D5ZFyBKsZRnLT2mRzdOB5bumr71f/seoUSGFU92hOolMwK/s39XloL7oNStVQwQc5/Q98FuF3Ij3uhkv6fXEKJxqL1/aPKfnsDUnxBd9XD3OsGlN+5i7q/HMBoX7o7o+GZqP6h2TKNI5Pa9tA+tinbz+92csqX8joTOonir+Ya+P8HfSfAW//CgnMNdIrr3uwB1fFnwJdF7vvTzN/JLCPs= +api: eJztWVtz2zYW/itn8LLxLC0p3bSbsu3OqHa6VbZ1PbbS7ozjB5A8EmGDAAOAklWN/vvOAXiTRCXO7O5bPKOxSByc63cugLbM8aVl8R17qxN2H7EMbWpE6YRWLGYzh4Y7BJcbXS1z4FLCo9JrBSU3ThCVBa4y4KkTK6J80ImFqgSnweUIBj9UaB1mUPAnUVTF6L1iEatf/6izDYu3/lEYzFjsTIURS7VyqBwt8bKUIuUkafxgSakts2mOBadvblMii5lOHjB1LGKl0SUaJ9B2q9sDm0itB50ArUbALWS4EAozEMqr/OP1r1dQGp2itfACR8sRfP8nYoKx4/bxkoi94Z7BD+9ZyTcFKndu0axEiu8ZjP9x5q2stbPOCLVku4ittXlEM6yS4gWCXngVAl3jVKGWUCttIyi0dXIDlcUMFtqA1MslUZSVKbVFeyQ3YqqSkicSg3t3EXOiQF25Y0W494xBVxnyCF84NOByYSGl0K+FlKC0gwTbiGeQbIAr7XI0gapSTkivcS0HXggFhT2DnFtIEBUY5GmOWd9LQjlcomERW2hTcBdeffOK/Fbwp7c6sXM9rYUOu7CGWMCg0x0ok00woobdp4T+7SsSukCX5r9zI4Lrjl0lhXUUsVVN42X6XYSqBmbt6ncgFoBF6TaRz6OVsCKR2NvOXes14tuEXysfaFqyqS5blBB3H5EE25D1PcqN4Zuj8EdMOCx6+dHic9fm5fwUPuZdSreiU12UEgkI6xwVGSGRk2dUUFHYHla0aUHVcprvo2QEs8XQ8g8wiYBTtvJKuhZbwvpcOLXre9olNSWIlpISRVjIhCWHZL509TbRWmeOKArMBHcoNxHgClUwUOkjs0bPAjIVV687iydDSYmKKzfL7MewNru0Pvye1npcrHOR5ntwJ/wfw+BU2I9UqXEQCvJdIO9qxlA23tOyIwbURqYtbm/qfNvtAlNbamVDbf5qMhmGV2NphxkyZ8Q+oys8l2nnoxMNxBN1HjvlyRO7H3EzXKcekUoAVEp8qBBEhsqJhUDTpvmDTp5XGE93OFrpF4oXNteVpDZM9Wmdcwdrbrv+fDbUr+ouOFPWcZXiv04Z9KCTv9i2Z4qanOx8nhn1zq63zrJhQUlZqFbO7LJnYE9+1rL5iE2drN/RWBEgdCxwFRafL+hjHeVI9EmHPuLmvxUZPIsSaTg55U9urU6FTwgabqAmh9nlkOsaZp+CQw1sMqIG96aZYQ4ERg3tWri8nr/2etwhpp47MaSVdbr4GXmGZrCgWvQFIdBBHgjbUTCryGYodIa+aXzXm4ks0G4juBR/YgZvb3+7gkynFblmoKLwLPPx4vK6Vx3qmv+ZA2Eo9V0R80PNXrHogmXQmboQDcS90JXyDqjJQOLChaE9sGwLBpdrvqGxDUpthRMrPHse2jPkmRRqoD75NtoUppSr/XGSL7lQEVjCoXf2u6vZvwFLTV1OFGgdL8rnoaAdrY51mNIE1k5ezSxWn1p8LngcRn4eqLxerj+RkSafG+2mww/3qK6cBTpwVKT1WtnjntAb2ZrG2zTjjA5yu/7KQUsOTbjuya9OteHS6JXIKBW44zTs0Ni/4lLUw86JZlwanUgs/vqppjyF60AJGTouJAQPhuMYESbhQHZ389MFfPvq67/fv8idK208Hq/X65FZpOeYCafNSJvl2CxS+hDd2QjmORo6DGw8rtqAQNedwZaYioVIm4DXavuuuTfMfeJkeXjSaiFYGcEOD9NTeHczO6qIe6L7MyLjia5cnEiuHlkXzmOhh1JsVRTcbHoltCdgFzHruKv688vJLD7kTcD4eT6/hsACUp1hPbQI2wgiIwqh6CTG4leTiR8Yw9M3k4kvDBTxZ1iiAJ9KyVXIuANz6LCgDdb48YY1TeJ/FBltxFIcyh3tJV0N4stgUUipr4dSaqqAvGwIh2iMNqDTtDLGn5qEbBtdI7uey77k2pdc+5Jrp3KNbobQ5TpjMSu1v9cpuctZzMZ0cht37ZpFjK7n/Cx4t2WVkSxm25Awu3g83ubaul28LbVxu/GKorE3O9BySKwGMFKnXOZB6HHgaKE/v13wolIZh9dw8+Z2Dv/kDtd84x1JIvdZv568ngxyJdITHKfXMwgWBtj1SkHDlnJ6kG0gfg7j3e6eHJlWRrjNLW0L7kmQGzTTinzfwqGW57nTcyBiUf3lpwYkb/+Y+zhTGbvp7oXfPHG6iBnCVzM1d2/aC83J4GXh5Og2767Ze3986TXZu4vpKD3qF9prVGPy2FmEnOZAySajl8f4v575NE51UVTK13K19Ocf4D3np7KyjpweMSlSpIkt3jLCVE/sL2EF6iMsvBwRcAK6mxK+FC6vklGqi3EatrX/E6mTccGFGtci7Phi+uu7q8vp+S+zizdXt2/OX44mI/fkfIAoxQquenpMD26c9izddn3r//Y7Qo0Mh09uXEouFIHf27+tS8Edq3XrFYP7qE7oO7bdJtziOyN3O3r9oUKzYfHdfZf/9LSLWDgh+urh73XYRTDufB6ux1ZcVv6O6PBmahc1O6ZpiqX7KO19r6Jd/3Y7p2ypfyOhsyiLmeFr+v2Er1nMWMS0d7ZPQv9uyyRXy4oviTbwpL//AOFjB/8= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Activate jobs

+ - + Iterate through all known partitions and activate jobs up to the requested maximum. -## Request + -

Body

required
    )\n","type":"string"}}>
+ -The list of activated jobs. +)\n', + type: "string", + }, + worker: { + description: + "the name of the worker activating the jobs, mostly used for logging purposes", + type: "string", + nullable: true, + }, + timeout: { + description: + "a job returned after this call will not be activated by another call until the timeout (in ms) has been reached\n", + type: "integer", + format: "int64", + }, + maxJobsToActivate: { + description: "the maximum jobs to activate by this request", + type: "integer", + format: "int32", + }, + fetchVariable: { + description: + "a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned\n", + type: "array", + nullable: true, + items: { type: "string" }, + }, + requestTimeout: { + description: + "The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.\n", + type: "integer", + format: "int64", + default: 0, + nullable: true, + }, + tenantIds: { + description: + "a list of IDs of tenants for which to activate jobs", + type: "array", + items: { type: "string" }, + nullable: true, + }, + }, + required: ["type", "timeout", "maxJobsToActivate"], + title: "JobActivationRequest", + }, + }, + }, + }} +> -
Schema
    jobs object[]
  • Array [
    • customHeaders object
    - -a set of custom headers defined during modelling; returned as a serialized JSON document - -
    variables object
    - -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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx index d80124c01ce..8f41c021eab 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx @@ -5,55 +5,259 @@ description: "Assigns a user task with the given key to the given assignee." sidebar_label: "Assign user task" hide_title: true hide_table_of_contents: true -api: eJztWNty2zYQ/RUMX5pMbUlJndTRm+M4rdtcPLbcPtieMUhCEmISYAFQMoejf+9ZgBR1c5Jp8yhn7JDEYq/nLMitI8cnNhreRNdWGOa4fYjuDqJU2MTIwkmtomF0Yq2cKMs4K1shNpduytxUsImcCcUeRMWcXnnA/R4hetFBVHDDc+GEIUN1pHADraRrBFV/igoykgwV3E1xbcQ/pTQijYbOlGLTmxFskDk99uY6l2A/WCWbNpmKnEfDOnJVQeakcmIiDJbG2uTchUevj6LF4i6YFNa91WlFezY9SDR2K0dLvCgymXBypv/Fkkf1tjEdfxGJo9CNLoRxUli/t0kKXW8H1a4yOLgeWo+treeldUxpx2LBRF445MKwe1Vm2T2F3vhgnZFqgnta4HGGZ2OeWbE4iHiW6fnnmTBGpjuceVuxVIx5mbkD74fPrrTMiMaFlMkxk47NOUCR4XFatd6lPXYlHLZBHgW59ybv6dIIVxoAQzHYhcNSMVsmU5ZwK2yI0Bvy0cGsYmNprA+yVEvDUBQvU5EyPuFS9RjAG0zOaV+lSzbls5BAywqZPCATbGx0ziZGl0UwhIqj5qSxMAKYdczwRDDUOpWUCdu7VV06Y60zwdVaPgkclM4kJG4zjycsQSwwGgTYjGcl+cmROZllPpAkEYgF2oJ7HZq9R5Rzizos3fdBCpUWGuBFCmc6QLHHzsceEgDcDEVND3x9yEpTSorztkHgbbQW2g6k+MgQmpOObn13ILKGVpDDtcvAGNCH5OBmgYwFmL8cHO1G+DK6n2xTQtIUYJR+Qa4AnwjajgaDr1HEb9qi/46OlHDV0CTReZEJ0s8+aiOQFMdlBrO4blNGiKT9bSwsRjcIiXqC/9iJbOU/b/eBTSBcBMnGLgv9AeGwIBgH6zeX70/Zm6NXv949mzpX2GG/P5/Pe2acHApgUpueNpM+bumX5J573iCGnFceTmmALs9Y13mYLUQixzJpO3TjNqPyrwHhibYVVustuCwbaWlktHVosOvLc4a8KifHFQF4y7Tf48EJeR7r0g3jjKuHqAPettFNK7bMc26Wx8G6ASiyjrvSfvMg+OXllm4C3O+j0QULKoChtO3NIGFjiILIpZJ5mUdD4BZ3/DHcvR4MFqSTKv4dkaAvPhYI30NrMxyAI+9w6wOTCn6p5EdVRhs5kZt2YWilCTQgfhciCsQ/+ibXdxGTGE/MHOtSpb09wfYE2xPsSYK9+Q8EQ/6a02xuNBygDOMULI2BU1m1PwX3JN2T9MeR9NWuF1bEQlk2hMPwyaMTz8AUnyky8+r9239ju/kG3XNtz7U9157iGhZz4aY6pXGRth46NDUaRn06EA/pQLT9emW4tOh3X400GBJm1k6iSoM0RXUg0QLYr6dQuRjWhTZu0Z9RhWbcSPom9gWl5UC2FkQZPsCzaXBku5i0QOOuNshTnuOFl7Njdnl2NWK/4VCe88onl0yuqz4eHA92aiXRJzSeXJyzEGGA4kp7aNUSz3eqDcLfo9iPzKxAM5OuuqJtIT2xwJuEOSmpHkuINPa8dj9I8UJ4Ei7et8D54++Rrz21tstuHHf2yOnTfX181uFuY5QVxnXtQKYV89gda+9Ug6zt8KjWAEbYOOi92EYxUkBkTHSOvb4jA8n+5YuvpCvJaJBhiKZo2wKvUGS3GXq2Yh/CCvsrWGQvelTqgMe2EU+guYx7MNdPwrbl/3Gm437Opeo3Jmz/9OTj9ad3J4cfzk/PPl2dHUJjzz06n1IiSs7Vih9hjtO9Q24GW3cH0P8e/zY4cOLR9dFupKJ6+FDrhrs3UcddbBiuj4ZX6AvYBQreRHUdcyuuTbZY0GPgxVR4ftcx1lM8lZau02b4+ZUwn102Q9/n7PtGzDvjah5yVfnekZV0h0uo25h5L+4gPhU8BRnI0yBxGvw5HJGeTsPW1Hlx0O44SRJRuCdk194XiLXL5nnx+WpEJGwm3rkm+kSGz2kAj7/D6Bb/cKN9rjy//fM6wpExKfmE5INe+vkXOgNsig== +api: eJztWFtv2zYU/isHfFmLKbK7pV3rNzdNt2y9BImzPaQBQlPHNhuKVHmxIxj678MhJTu+pC22PjqAEUk8PNfvO5TOknk+dWxwza4cWvDc3bGbjBXohJWVl0azARs6J6faAYfQCcFC+hn4GcJUzlHDHdbgzYMHPO5BzFnGKm55iR4tGVoyzUtkA0a6Rtzd/YU1y5gkQxX3M5Yxi1+CtFiwgbcBt70ZzTCaM5Nobu2SN61VsunEDEvOBkvm64rMSe1xipZlbGJsyX169OKYNc1NMonOvzZFTXu2PRBGe9SelnhVKSk4OdP77Mij5a4xM/6MwlPo1lRovUQX97ZJoevdoLpVmBi7GVoOG+tlcB608TBGwLLyNRgLtzoodUuhtz44b6WesozRAh8rZIMJVw6bjHGlzOLjHK2VxR5nXtdQ4IQH5bPoR8yudGCxdaEAOQHpYcEdcGWRF3XnXZHDJXrwM+moILfR5C1dWvTBauAa0FpjQWpwQcxAcIcuRRgNxej8DDVMpHUxyKBXhr2hB6tbPuVS53DlMJlc0L7aBJjxeUqgg0qKO6mnMLGmhKk1oUqGvgQMGL2sLM5Re7BcIAijC0mZcPknvU7n2BiFXG/kk8BB6RQpcdt5HIIIzpsSkgDMuQrkJ/ewkErFQIRA5+RYYXJvjeboEeXcBeVX7scgUReVkdqD1HOToJjD2SRCorJmLgssslgfstKWkuL81CLwE9sIbQ9SYmRNxrz0dBu7A5E1tYIStb9IjGFNQ3IWXWW0SzD/pX+8H+Gr6H5ybQlJU4JR8Tk4j0XOmowd9/tfo0jctEP/PR1JcN3SRJiyUkj64b2xCAV6LpUDbnGVMkIk7e9igbEp6pSoR/hfWTNWWP682we2gXCeJFu7kPoDcAdJcJysX1+8PYFXx89/u3ky875yg15vsVjkdiKOsJDe2NzYac9OBP1I7mnkjUUoeR3hVCTocgXrzgOuQiEnUnQdunUbqPwbQHikbaXV5Q5cVo00WMl2Dg24ujgDWaD2clITgHdMxz0RnGzA+NgEPxgrru/YGni7RretuFCW3K6Og00DTcac5z64bx4Ev/6yo5sA98dodA5JBQhTdL1Zus4QBVFKLctQssFxv5+xkt+nuxf9fkM6qeLfEYkGvK8U1xFa2+FIDeUatzEwqZ3nWvyoyhgrp3Lbbs4eNoEWxG9SRIn4x9/k+j5iEuOJmRMTdJEfCHYg2IFgjxLs1X8gmHTdabawRk9jhhFEsBa1V/XhFDyQ9EDSH0fS5/teWIcaKMuWcJg+eYyIDCxgMZMqqo9v/63t9hv0wLUD1w5ce4xrTcZK9DNT0LjIuAgdmhoNWI8OxCM6EF1v+WC41PTWX400GEI77yZRwSo2YMtEombQ6y1nxvlmsKyM9U1vThWacyvpmzgWlJYT2ToQKSO4miVHdotJCzTu6oI84WXQBYeXcHF6OYLfuccFr2NyyeSm6pf9l/29Wkn0EY3D8zNIESYoPmgPnVri+V61Sfh7FMeRmUMRrPT1JW1L6Rkjt2iHgeqxgkhrL2qPg5QoxLL24m0HnD//GcXaU2u7WI/jTu85fbpvjs/WuNsaZaVxXTeQ6cQidicmOtUiazc8qjValzb282e7KD4/i2QUpiyDjh1ZT9PLF3+QLqFokGGJpkoK1C763g49O7F3aQX+ThbhWU6lTnjsGvFU+lkY58KUPZG2rf6PlRn3Si51rzXheifD91cf3gyP3p2dnH64PD16lvdzf+9jSokoJdcP/EhznPU75Hawy/UB9L/Hvy0OPN77XqW41FSPGOqy5e41W3OXZWywORp+QN+brKXgNVsux9zhlVVNQ4+/BLQ1G1zfrBkbKV5IR9dFO/z8SphPLtqh71P4vhHz3rjah1zXsXeoQHcsY3dYb828m5smYzPkBdroaZI4Sf4cjUjPWsPO1LnJuh1DIbDyj8huvC8Qa1fN8/zj5YhI2E68S0P0YZYvaADPF8lrE/MUuR2fLZniehr4lGSTTvr7F5rBa44= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign user task

+ Assigns a user task with the given key to the given assignee. -## Request + -

Path Parameters

Body

required
+ -The user task's assignment was adjusted. + -
- -The assignment of the user task 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 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx index e531316f43d..83f4c6c24db 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx @@ -5,52 +5,223 @@ description: "Broadcasts a signal." sidebar_label: "Broadcast signal" hide_title: true hide_table_of_contents: true -api: eJztWMFy2zYQ/RUMTu1UFpXUSV3dFNlpnaaOx5Lbg+LDkoQkJCTAAqAlDYf/3l2ClChRctOZHGWPZYJY7Nt9+xYkVHAHC8uHMz6RCwUJf+rxWNjIyMxJrfiQvzMa4gisswyYrYz6vMeN+CcX1r3T8YYPi2oojYj50Jlc9HiklRPK0RRkWSIjIHfBF0s+C26jpUiBrtwmE4iiwy8icug3MzoTxklhK7sK7w5SQaP9wKZLwRTOMD1nDq+9LXOahU3IFGgNYJ2RasHLHn8GIyFMPADEsSR/kNy3gH0OXbgaYuuBAZHyYfLpjvkEWoB1RgiIRIByt/HxFG6vmwS8HV6CY3qlbCurI4mUvRbpszZTWEInXULGvqjbEj74ouFiv9xmWllPxOvB4Hh8dc4rTHWP1+9a4T/E5jh6riSG3CKpqTKR1ImphpIY2UIYvDHXJgXnb729/O9i1CX4f3Ctipzk3TNdE395imuk5lnGImYxOGDSMqUdqi2R8QuM4yLUYvpTl/l9gBG795YsFg5kUkuWNOwNQwSWis0e3o/Zr5dvfnn6YelcZodBsFqt+mYeXQhsFm362iwCHNIf2f3YZxi8ESyFDQsF2/UU29Wa2UxEci4jalDnc62CIRL7n1WncQ6F4meLA9JbJc6N5IdNO2KPD7cMKVVOzje4oAtdrZlDnpAPCHXuhmEC6ivflbMLeohi8zQFs2lUsw+AjqwDl7fSOCHRn193fJMsfp9O75l3wSIdC4ZrEAf1UQNREqlUMs1TPkR14QjWfvR2MCjJJ1X8GzJRTKwzTL+S1mE6KI5UY529tyoxqTAuFX2vymgjF/IQt7/XWrWIr31GTUNdvrh51Z0017k6d9K5k86ddLKT3hx7NGEuxLIhHQpjkDIdRbnBNw+2Wsqkch8Jaxvs+t3w3GnnTjt32vFOw8lUuKXG91CeaVtJB9wSR4F/Ztlg+6qJc1aYZ2HonFZgZEgKL3zLlKj0YokOymGRaePK4JnqsXfGoWnfWo1kEh1BsvSw3dLRRPtgNYYUn5vArtjDzWTKfgMnVrCpqCTIfddXg6vBUa9kesLj6P6W+Qy98FqbQeOWuvqoW2/8LY7L8omIxI1Lus2Elnl6QgFGmFFO7G8FUeNV3mnsjfCOv3jfyOTD39Oq0rSRPeyOxDdrSDPfhu0j7E5n7QLtnUpaB1Wp5roKqVZRNzlyhLLwbAz6r7qKRQKo8SKd4tpq90XVrqRb4rl15y9KcuuIpB7HLVrQSQVxlY+5MfvoZ9hfHpG96lOhvRqbTXeBnvOwj3BB5Jdt/4eJDoMUpApqCBuMR38+3l2PLj7ejm/uJjcX6LHv1q4ilJoiBdWKY3uaqt/qDpMtdg+bU19a1MV1Yu0C3DGkIpqrDIq6/ZqDtKVSbxsQheObaMaLIgQrHk1SlnQbK27w6Dp72pWURuh2KSBGxVDHfqXTLR/76C6mFASZJzkF0zk8l71mxSiKROZetH1q7SP3nyZTCrv+SibFXRfvGljR1zX4OeSf8RcHumKsEn91v+C4ey5yWJC990s//wIkFT00 +api: eJztWN9zm0YQ/ldu9qmdYiGnTurypthO6zR1PLbcPrh6WGAlLoE7fHdY1jD8753lQEI/7KYzebRmNBKwt9/ut/sdLDU4XFiI7uFWLhTmMAsgJZsYWTqpFUTw3mhME7TOChS2NRpBAIYeKrLuvU5XENXtoTSUQuRMRQEkWjlSji9hWeYyQXYXfrHsswabZFQg/3OrkiACHX+hxEEApdElGSfJtnYt3hUWxEfbgU0zEgoLEnouXEZdbMJpEfchc6AdgHVGqgU0ATyikRjnHgDTVLI/zK8HwD6HfbgOYu1BIJPy8fbzlfAJDAC7jJoAHClU7jI9nMLleZ+AtxMuQyf0UtlBVgcSaYIB6fdDpmYBOOlyNvZFXZfwxhcNmsYvt6VW1hPxZjw+HF+X8xLtNq/ftcJ/0OoweqXkQzUkqa8yk7QXUwcllaMFGQhgrk2Bzp96d/LfxehK8P/gBhV5lnfPdEf8yXNcl0Y/ypRSkaJDIa1Q2olHzGX6AuOl0XFOxU/7zG8DTMS1txQpOZR517Lcw94wplRIJe5vPpyJX0/e/jL7IXOutFEYLpfLkZknR5RKp81Im0Vo5gl/2e7HkZhmZEgUuBIxiY2mxKbWwpaUyLlMWKDO59oGwySO/lF7wtltFH+13iF9UOLKSNgV7UTc3VwKmZJycr6SarEP3a6ZY5WzD4x15aI4R/UVNuXcB91FsVVRoFn1XbMN0ARgHbpqkMYzLfrzmz3f3Ba/T6fXwrsQiU5JzLURLpO2B+IkCqlkURUQnYzHART45I/ejccN++SKf0MmStBTmaNqW2s3HalEoQ11/dMmJpV1qJLvVRlt5ELu4o62pNU18bnPqBfUyYubV6ekua7Uq5JelfSqpGeV9PbQrWmiBLNsuA/JGG2ETpLKGErFMpN56z4ha3vs7tnwVWmvSntV2mGlNQEU5DKdQgSltm3roMsggtDfs2y4ftSEACyZRzI8p9VQmRwiqL1kmigM60xb10R1qY1rwkeux9aMw5e9tPqWyXWCeeZh90vHF4aD1RkWlUpRnIqbi9up+A0dLXHVUsmQ265Px6fjg17Z9BmPk+tL4TP0jTfYDHq3rOqDbr3xtzhumhkTmVRGutUtL/P0xISGzKRi9tcN0eG13vnYG0HQ/fnQt8nHv6dtpXkju9mMxBdPWJRehsMRdtNnwwJtTSWDQVWquW5D6rpoPzl2RMZ6Nsaj4/2Ovb5shZfooqhUu/uqhVhKlwkckJXklXVMUgC5TIgnlagG5WPuzT75K+IvjyiOR1xo3439pruQLqviUaKLMPHL1r9xruOwQKnCDsKGZ5M/767OJ0efLs8urm4vjo5H45F7ci2hLIoC1SCO9TTVPdXtJltvbjbPvbToiuvoyYVljlIxzW0GdSe/fpC2XOq1AGdBJ6J7qOsYLd2ZvGn49ENFZgXR/WxTUj5qAsgIUzKtYr/ydAtnPrqjKQfB5nnFwewNz03Qr5gkCZXuRdvZYB+5/nw75bC7VzKFTnmNwSW/rsElRAAB6JattvHbczXkqBYVLtjW++TPv0I6PDg= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Broadcast signal

+ - + Broadcasts a signal. -## Request - -

Body

required
    variables object
    - -The signal variables as a JSON object. - -
- -The signal was broadcast. - -
Schema
- -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 signal is not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx index c8c484fd2ab..eb8e1dac584 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Camunda 8 REST API

+ API for communicating with a Camunda 8 cluster.
-

- Authentication -

+
diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx index 3125499a15d..987fd254367 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx @@ -5,51 +5,206 @@ description: "Cancels a running process instance." sidebar_label: "Cancel process instance" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/isEn1ossZwu7VI9DPDcdMvWdobjdA9pHiiJstlSpEZScQxB/33nkJJvstEU2KNTpJHIcz/fR+mopo7NLY3v6cTolFtLhLKOqZTThzOacZsaUTqhFY3pGJelJYyYSimh5qTc0xnQM1oywwruuEGrNVVwA7qt5E0r+BdfgahAqyVzC7g2/N9KGJ7R2JmK77ueLTj5xldE58TB5b5f4jRJfXQYgU0XvGA0rqlblehcKMfn3MBWrk3BXFh6c0mb5iF45tb9prMV6mwCyZm0EEmqQV053GNlKUXKMKjoq8XI6r43nXzlqQNnqpKSJZJ3KUHUJTdOcIvSeO0tTXnODceKw+pu2iNiuk2ffrrQliuSrHwVKssNXDBHlkJKkkBdmHFYIwa3hqfaZBb+2ko67FZudAHywpK178EX9bGyDnV/JUMicizto8h4BjuQwvcKeEYLoURRFTS+aBqQFw7zbaEy2W36NBQaqo6iEFeplQ3FeDW87Gc/O9RpiD50GkKkYOZyODyq6RMhGXMM1ZR25JFJkSFGjjQVlKBhxU/95u43ZhIkScYdE5KEphNmSRBMwLFQ5H76fkzeXr7+5eHFwrnSxlG0XC4HJk/PeSacNgNt5hHc4i/KvRwQCN5wUrAVdoVlIAY+mSQb+BBb8lTkIkXct3zwwWC7dhq3xuIu9sLuGrHWGcDHdncrI+g+B0fkbnpDoKTKiXyFgOq59jo5A7yBPEt05eJEMvWNbqDRd7rvxVZFwcw217ccgCEAgqvsd+n986uebYTFH7PZhAQTJNUZJ6ATSNE6GmyDGtAFd+wp3L0ZDhu0iR1/RiaK8KcS0vfQ2k8HwFFo6HOw5hNbn7z/T2e0EXOx7xccbdG0BfG7kFHg5eWPUBE5letKnTh14tSJU0c59frQQwpywSobxCE3Bkqm07Qy8OpBlgsh14TrfLfvKSemnZh2YtphpsEmjB4LneFcoa2HDo4XMY1aMp13Ydqo7s8kTRTeLaVPGkcJbh67SaYyUDZaB1I1wIUa3sZdE9elNq6JHrFjj8wIfOX3DcbtQL4OVFKnTC5CYP3m4gaOS13SY1bAk5WRKzK9vp2R35njS7byxUaXu6avhlfDg1ZR9IjF0eSGhAwDNLeOi84s8v6g2SD8HMN+yLIcjjbhVreoFsqTcGa4GVXYnzVkWn/eOt4HIVgJF+87IP35z8xjAY+66WaAu35iRRmIemi+Gnqc5to7XI8q+6FjH6HpIdfh4KKPWEgPiZfqAnT96QuoXQq3gNl4Yy+VMFphCc4oHNEcZh302w7EndiHsEM+B4/kYoBtDFjrDt05WK6SAbgDfHq19d9E6iQqmFBR68JG49HHu0/vRucfbsbXn26vz8HiwD05Xy4kRcHUThwI+N7L3X7O9eaZ88zvAG1DHX9yEZwjMOs3bV51S8p72iMl6MUHPxXs8BLwFLh1T+s6YZbfGdk0uAxAMDDF3z9sqOi5mwmL15uh/mhyL6bt/P+S/NBHh4PptotMrfzZICu8g0uwevibSPMAWgvOMsA8xh0ExyG68xma2xjqfY1ozjqNUZry0h2R3XlNQHKuz8zJ37cz5Fr7KaSAJwysGrbEDzTwf0y/wD+40b5ynsZ+vabwpJhXbI7ywS7+/AfloVm8 +api: eJztWFtv2zYU/isHfGoxRVK6rOv0MMBL0y1b2xmOuz2keaCkI4stRaokFccQ9N+HQ8p3B22BPcaAYYk8PNfvo3nYM8cXlmW3bGp0gdaCUNZxVSC7i1iJtjCidUIrlrFLGpYWOJhOKaEW0B6siVnEWm54gw4Nae2Z4g2yjI2S16PgX7hiEROkteWuZhEz+KUTBkuWOdPhoel5jfAZV6ArcDUe2QWnofDekQe2qLHhLOuZW7VkXCiHCzQsYpU2DXdh6OUFG4a7YBmt+02XK1qzdaTi0mLECq0cKkdzvG2lKDg5lXyy5Fl/bE3nn7BwLGKqk5LnEtchtUa3aJxAS9L07DXNsEKDlPGsPwh7AmY96cMvam1RQb7yWegsGnA1d7AUUkKO0HLjKEdcSjBYaFNaMGg76ahaldENuFpY2NiOP6p3nXW09ldIQVSU2ntRYhl/VCz6agIj1gglmq5h2fkwRMwJR/GOUJnuF30WEs2GgUQN2lYrG5LxIr04jn5+qtLCjpXGMmZDxC7S9NGVPhAoueO0TGkH91yKkjDySFFbo3OJzQ/HxT0szDRIQomOCwmh6MAtBMEcSxAKbmdvLuGXi59+vntWO9faLEmWy2VsquIMS+G0ibVZJKYq6Etyz2OY12gQGr6iqvCyFGSTS9jCB2yLhahEQbgf+eCdoXLtFW6DxX3shdkNYq0zQi12q9sZwQ45OIEPs2sQJSonqhUB6si0X1PxTpIOnuvOZbnk6jPbQuPY6KEV2zUNN7tc3zEwRMw67jr7VXr/+OJIN8Hij/l8CkEFFLpEqLQJpBgNxbugvkjTiDX8Iby9TNOBdFLFvyESBfjQSq48tA7DEQoabXDEjw9ss/P+P5XRRizEod2Y7dJ0BPHrEFHg5cX3UJE4VelOPXHqiVNPnHqUUz+d+pOaKKAsG8IhGqMN6KLojMESlrWQG8KtbY/nlCemPTHtiWmnmTZErEFX65L6Cm09dKi9yFgykuls7aZN+uOeZEjC2VL6oKmVQHO/7mQ6I1nG+kCqIUuSvtbWDVnfauOG5J4qds+NoCO/LzBNB/KtQSV1wWUdHDsuLk1Qu7QO+pI3nSo5vILZ1c0cfucOl3zlk00m91W/Sl+lJ7WS6CMaJ9NrCBEGaO5sF2u1xPuTaoPwtyj2TZbFojPCrW5oWUhPjtygmXRUnw1kRnteO70HIRaND2/WQPrz37nHAm11s20Dd/XAmzYQ9VR/lXqcVtob3LQqh65THdHYEGsanx8jdnrtiVfopumU333VApbC1cB3UlHIzjpKQcSkKFBZ79fYEK/F3oYZ+CdYhPOYyhiwtt50F8LVXR4XukmKsGzzm0udJw0XKhlN2ORy8u7D+9eTs7fXl1fvb67OzuM0dg/Op4tI0XC15wcB/uhwdxhzv/3P+cZ7gLGgDh9c0kouFEHMx9WPpLxlR6RkEctOXhXs8fIuGrl1y/o+5xY/GDkMNPylQ7Ni2e3dloqeu6Ww9Lxt6h8N7tls7P+fw3ddOpwMdxzkauX3BtnRG4vYZ1ydvhMZ7oaI1chLNN7vIHgZvDubk7qtoqPbiCFar5gUBbbuEdm9YwKRc7NnTv++mRPXxquQRpe01vAlXdDwZXBe+6x5CvuxnkmuFh1fkGzQSZ//AJGmWMA= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Cancel process instance

+ Cancels a running process instance. -## Request + -

Path Parameters

Body

    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
+ -The process instance is canceled. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + title: "CancelProcessInstanceRequest", + }, + }, + }, + }} +> -
- -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 process instance is not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx index 6dcef1c1af3..9f8de3c3c9c 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx @@ -5,59 +5,247 @@ description: "Complete a job with the given payload, which allows completing the sidebar_label: "Complete job" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SsYnJKpTSqpkzq6qYrTOk1Sjyy3B8cHEIQk2CTAAqBkDof/vbsAKerDctKZ9CZnHBMEsG8X+x5AbE0dm1s6vKUfdULvTmgqLDeycFIrOqRjnReZcIIwcq8TspJuQdxCkLlcCkUKVmWapSdktZB8QViW6ZUlPMyRau6HMms1l8yJlFhhlpIL4ph9iL4qekILZlgO9g26UFMFDUAFqD9EBd0SfSiYW8CzEf+U0oiUDp0pxa6jU0B6EBXRMw+KzjrduSIimG/5QuSMDmvqqgJRpHJiLgx0zbTJmQuv3p7RprkLcMK6X3Va4ZwefcYyC/Bcw3TlsI8VRSY5Q0/ie4vu1PtoOrkX3GHIRhfCOCks9i6ZkSzJQoOlqUQrLLvaGHQo3PXUzUjX0WOqMOxdeFVmGc4KdpsGRkiHTSRAm27AmITwYS1wiBG20MoGL18PzvDPvkMelq0JgAkvORfWzgCziigYOhsMnpm7zS5MJ2dKaUcS0RuNyGdtBEmFYzKzhMEzLOlSpoAnlZ/fuUsSyF4g2oF0wUxYi/yn/bRtuzgiV2Fki0vCegK5SRiYBPTbyYcxeXf25pe7FwvnCjuM49VqFZkZPxWQW20ibeYxNPEXx72MCIQPMeSswjB7CpCeKMQWgsuZ5JhpDLB1m2ByQ3zPsyz0rrlonQF1bhK/NJLucmxEbiaXBNZVOTmrOjlvQfs5M1ZmaIMlunTDJGPqgfa02gfdRbFlnjOzlu42ABiyjrnSflO4P7/es43E+n06vSLBBHAoFQTmAI60HRAGkUsl8zKnQ+AntNhjaL0dDBq0iRn/jkgUEY8FhO+ptRsOkCPveesDkwr8UvxHZUYbOZe7uAC0IfGWxO9DREHbZ8/KeV+SqHDU5EyXKo2O0jpK6yitg9J695+kBSvXnmArowEa1xZOvtIYcAdO0OPJd5TnUZ4/TJ5vnvoYhVhwlQ3yUBgDS6a5V2CKt5zMm8dv2g67vScctXbU2lFrh7QGnXDLX+gUr/PaeurgrX5IYzgKbVyHG38T8/UFFG/swiy7ykBpYG1oHZTTAOHrBdhphnWhjWviJaZl6y6N3UFhHXMyzVm2COj7GcQOLD90kY1ZDt+3jJyTycX1lPwGJ/GKhUssQm6bPh+cD560ikMPWBxdXZIQYeDfxp7QmUVxP2k2DP4ew76WYQXsYNJV1zgtLE8i4PPBjEpMwpoXLZ63ju0wCN6Ehw8dWz7+PfUJx/1s0tdJLh4ZZm+3rNF4Es60B2opsu8y5g+SHWIcRK/26QhhoaqAIjDXb61ASf8VxTaWgGeldRj6CYX9V8C3EOK2haVu2KfQQ/4KiORVhOkLHOt21DlYLpMI4GIepq3/JplO4pxJFbcQNh6PPt98eT86/XQ5vvhyfXEKFiP36PwyIeNzpjb96Ko1wPvdQOv+FPnfy29t3p14dDHsKVIhE/0y1K1Ab7EYZ2HocF2U29AocCvo7JbWdcKsuDFZ0+BrIIWp4P1dL0uv41RafO7raAdjfzFpS24vybeLe08G0r5kqvKbQ1ZiCx7BVF9kbO5g5EKwFIiODobOcXDjdIom+sl7lb7mpJsx4lwU7sDYrQ8AVOR6N7z683qKAmvLjDmcHfDWsBVWPOH/If0K/6Ch/RJ57fr3NYUzYF6yuS+Yerv48y98k4hh +api: eJztWE1z2zYQ/SsYnJIpTSqpkzq8qY7TOk1Sj620B9eHJbgSYYMAA4CWNRr+984CpD7tJJ1Jb9KMRiKB3beLfQ8kdsk9zBzPr/l7U/CbhJfohJWNl0bznJ+aulHokQG7NQWbS18xXyGbyXvUrIGFMlAmbF5JUTFQyswdE9FG6lmYCs4ZIcFjyRzaeymQeXB36T+aJ7wBCzV6tBTCkmuokef81hR/4IInXFIMDfiKJ9zil1ZaLHnubYu7gU4qZHe4YGYaQClYb4ZQMOUJd6LCGni+5H7REIrUHmdoecKnxtbg463Xx7zrbiIcOv+rKRdks0afgnKYcGG0R+1pDJpGSQEUSXbrKJzlPpopblF4StmaBq2X6Gj0HqyEQsULKEtJXkBdbEx6Kt2V6Wamq+ypVJT2LrxulSKr6LfrEu6lp0siQF9uafRlTJ93HU2x6BqjXYzy5eiYfvYDCrCwIgAVvBUCnZu2Si1S3iX8eDT6iu02u6icArQ2nhW4dpqyj8YiK9GDVI6BRdZYcy9LLJnUwX4IlxWmXESiPVGuxppCYf3Tftm2Qxyzizizx2VxPRk4FicWEf368t0pe3P86pebZ5X3jcuzbD6fp3YqjrCU3tjU2Flmp4K+NO95yiYVWmQ1LCjNNQXYmijMNSjkVAqqNCXYh82ouDG/r7Msjq646LyVerZJ/NZKvsuxMft8ec5kidrL6WKQ8xZ0sJlCq8gHFKb1eaFA3/E1rfZBd1FcW9dgV9LdBugS7jz41n1TuD+/3PNNxPp9Mrlg0QUTpkQ2NZb5SroBiJKopZZ1W/P8eDRKeA0P8er1aNSRT6r4d2SiGT40CnSg1m46UrN6zduQmNTOgxY/qjLGypncxU35psR7Er+NGUVtH39VzvuSJIWTJqem1WV6kNZBWgdpPSmtN/9JWtINT7C5NXoW1haZaK1F7dXi8OQ7yPMgzx8nz1ePvYyONaNVtsRDtNZYZkRQYEmnHBXc0zvtgN2fEw5aO2jtoLWntNYlvEZfmZKO88YF6tCpPufZrSlctown/i4TqwMondjR3g+dgdYqnvNlVE6XZ9myMs53+bIx1nfZPZVl6yxNw1FhA3OUEaCqiL5fQRqg9sOQ2SnUrS6BnbDLs6sJ+w08ziEeYgly2/XJ6GT0qFea+oTH8cU5ixlG/m3sCYNbEvejbuPk73EcehkORWulX1yRWVyeAsGiHbdUhBUverzgna7jJJ70f94NbHn/9yQUnPazy3Wf5OwBqHq7bY0ukHBqAlBPkf2QqX5oXcxxlL7Yp+PFeVCVMHXd6rC16ll8i4KNJRCqdZ5ST7iSArUL8fSNpWHahzjC/oqI7EVK5YscG3bUmfRVW6TC1JmIZqvfQpkiq0HqrIdw2en44+dPb8dHH85Pzz5dnR29SEepf/BhmYjxNejNOIZuza0pdhNdrp8i/3v7ra+7xwefNQqkJiaGZVj2Ar2mZpzjCc9XTbkNjd4kvc6u+XJZgMPPVnUd3f7Sol3w/PpmLcug41I6+r/uoz2Z+7PLvuX2nH27ufdoIv1N0IuwOaiWrnjC73CxbjJ2N13CK4QSbQgwDp7GMI4m5GJtvNfp65LBYiwENv6JuVsvAKTI1W548efVhATWtxlrU5KthTl1PGEeAzZheYJuw70lV6BnLcxCszT4pM+/bfWHZQ== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx index bc4353d7eaa..632614213c8 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx @@ -5,59 +5,253 @@ description: "Completes a user task with the given key." sidebar_label: "Complete user task" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isYnJKpTCqpkzq6qYrTus3DI8vtwfYBJEEJCQmwAChZw+F/7y5AihJpTdxOjnLGDkEs9vl9ALgVtWxp6OSO3hquiWXmG30Y0YSbWIvCCiXphM5UXmTcckMYKVsxshF2ReyKk6VYc0m+8W1AR7RgmuUgq1FpRSUMQAOuWsCiP/kWZAQqLZhdwbPm/5RC84ROrC553/IC1INiolJnqTNuFYkbr9CqiVc8Z3RSUbst0KCQli+5hqlU6ZxZ/+rtOa3rB2+UG/urSra4pvMhZZkBJ2IFy6XFOVYUmYgZ+hN+NehUNbSmoq88thi9VgXXVnCDs2umBYsyP2BJIlALy673hI4FvVu6H2kvB1gADL7vhCyzDNd67fWIsthrrnqGpiQujVU58QJgNCvRCLOgO8tIxGEm5sYI0EZSDZKddQ5Ft4ZobsrMCrn083YlDOEyKRSkmwi5Vj53AblKiVSWQIbWIuHJiIjGSsJTBiow0HvahnpPg3vZxWasBhPD2CA4KywOHX4RYg1YwebcVxlKjnLgaKGk8cV4PT4fpmNxmF1mdolPiCldIlIwDzAHdefj8Xc1DAhCYiYxCZDYneqAfFKaQxYsExkwDJ7bHEH+3PrWdRIBYH1ejiAUVkJy8p+GSO1X/tpLNnaJBw+BmL1g5K3fzT/MyLvzN788vFhZW5hJGG42m0Cn8RkHOCsdKL0MYYi/KPcyIJAEiCFnW4efHepJxw1iCh6LVMRYcwywcZtgtQ/qfoRYfrYaoGPH9VIL2qfVlNzOrwjkVVqRbhGxA9NujUMjyLNIlXYSZUx+ox3Ohkb7VkyZ50zv9qxDA6DIWGZL89296ufXA90Ir98Xi2viVQCGEqCl0p51jSEMIhdS5GVOJ4BSGLFHP3o7HteoEyv+jEgk4Y8FhO+g1Q8HwJF3uHWBCQl+yfhHVUZpsRR9u2Boj/MNiN/7iDzPz59B7SExke3IzFSVMglOBDsR7ESwowR79z8IBvlrTrONVuAAZhhOwVJrcArO1NMpeCLpiaQ/jKRvnrqeQiyYZY045FpDylTsGJiQzUpkTr277je2m8+kE9dOXDtx7RjXYDLndqUS7Gko46CDrY0JDfFAPMMD0YTVXgekDuPdNyr2Lrhet+2SUkOaaOVJVAP2qxWorCdVobStwzVW6KCrgNOebC2IMvjizlbekWExcQJ7Mm2QM5bDhZeRCzK/vFmQ3+BQ3jD/hYsmD1VfjC/GT2pF0SMap9dXxEfoobi3PbRqkedPqvXCz1HsujqGw2Ym7PYGl/n0RBxuEnpaYj12EGnsOe049kLwxj98aIHzx98LV3vc2uZdx+jykWH1+g2evT5LC0KH0FQ50w1+hkFgRaH8fuE4eDXEKgSKlAPQwFq37wJe3RWL7SUlzkpjMRkjCpszh4sS2m36b63YRz9D/vIWyasAC+pR1263S9BcRgGYC2O/bPd/lKkozJmQYWPChLPpp9vP76dnH69ml59vLs9AY2AfrUsc0iFnct+PtpO1uyv2w626g+Y/9R2b2lr+aEPYQoTE7LvAqoaPd7TjIyyYHPYk9ygJUPK0uqNVFTHDb3VW1/gaMKC38P6hY6GjbSIMPncNxKMhvZg3vcaX5Lm9zScja14yuXU7QlbiCB5BYa/dWj+A+IqzBCCOvnqJmffobIF6Og2Dbmc9aldM45gX9ojswS0AubjbEq+/3CyQWk2rNYcDBN5qtsHeL/yd0Hv4BwPlsuVY695XFA6CZcmWKO/14s+/xBTa1w== +api: eJztWE1z2zYQ/Ss7OCVTmlRSJ3V4Ux2ndZukHltuD44PILiSEIMAA4CSNRz+984C1Lc1cTs5yjMai8Ri3368B1LbMs8njuV37NahBc/dA7tPWIlOWFl7aTTL2bmpaoUeHXBolmYwl34KfoowkTPU8ICLlCWs5pZX6NGS05ZpXiHLGe0acffwJy5YwiQ5rbmfsoRZ/NZIiyXLvW1wF3k0RXIMZhyQ1uDegOijIlQnplhxlrfML2oClNrjBC1L2NjYivt46+0p67r7CIrO/2rKBe1ZxzDmymHChNEetac1XtdKCk7xZF8dBdXuo5niKwpP2VtTo/USHa3OuJW8UPGCl6UkL1xdbRgdSnq1dTPTnRpQAyj53SB0oxTtjd67hHERPbc7QEMQjfOmgmgAM64aAuEe5lIpKBC4EOicLBTC2JpqAx1nqL0Di65RXupJXPdT6QB1WRupPUg9M7F2KVyOQRsPtTUzWWKZgOxRShzzRnlK9AtbpvqFpV/0OjfnrdST/dy6hHnp6TLwlyjWk1UafR27zLqO7Cy62mgXm/F6cLpfjtF2dblbFb4E14RCjBulFinrEnY6GHzXw55AQHBNRShw7TqFT8YilOi5VA64xVWNQOqwfxk6FKZcxLocYGhtTaGw+mmfqbudv4qWPS5E8gB3EA2LiH53/eEc3p2++eX+xdT72uVZNp/PUzsWJ1hKb2xq7CSzY0EfsnuZwmiKFqHii8CfFethrQ1wNQo5loJ6Tgn2YQN1e6vvB4QVV9s9dqy03ljJdmU1hNvrS5Alai/HC2LsHnTYE9jIcsYL0/i8UFw/sDXP9kF3UVxTVdyuzqxtgC5hznPfuO+eVT+/3vNN9Pp9NLqC6AKEKRHGxkbV9UCURCW1rJqK5aeDQcIq/hiv3g4GHfmkjj8jEw34WCuuA7V205EaqjVvQ2JSO8+1+FGdMVZO5C5uyjY135P4fcwo6vz0GdLeFyapnZQ5No0u06PAjgI7CuygwN79D4FJt3yaza3Rk1BhBNFYi9qrxfEpeBTpUaQ/TqRvnno9HWqgKlviIVprLBgRFFjCfCpVcB9e93vs/mfSUWtHrR21dkhrXcIq9FNT0kzDuEAdGm3kLKMH4gk9EF3WbkxAukysfqPS7ALtbDkuaaxiOWujiLo8y9qpcb7L29pY32Uz6tDWVIGWo9iWJFJGcDWNgew3kxZoJrNM8pxXjS45nMH1xc0IfuMe5zz+wiXIbddng7PBk17J9IDH4dUlxAwjFTeOh6Vb0vmTbqPxcxyHqY5D0VjpFze0LZanQG7RDhvqx4oiPV7wTtfRiCX9lw9L4vzxzyj0no626/XE6OKRU/d2Bzwbc5YlCQNDxyZA9/zZT4I6itbFjYP01T5Xry6D5ISpqkaHc1dP4isW3yiKUI3zVIyEKSlQuxBhP39bmn2MK/B3RIRXKTU0sm553E6knzZFKkyVibht9b9QpsgqLnXWQ7jsfPjp9vP74cnHy/OLzzcXJ6/SQeoffSgcyaHiejOO5SRr9a64m267ftD8p7lj31uPjz6rFZeaqh8Sa3s93rG1HlnC8u2Z5IYk75NeVnesbQvu8NaqrqPb3xq0C5bf3a9VGGRbSkff1wPEgym9uO5njS/hubPNJzPrb3K9CCeCauiKJewBFzvj1u6+S9gUeYk2xBotzmNEJyPys/awN+3skuWOoRBY+wO2W28BpMXVkXj1182IpNWPWitT0l7L5zT75fMYtQmVCooN91qmuJ40fEK20Sf9/Qtrj9nb sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Complete user task

+ Completes a user task with the given key. -## Request + -

Path Parameters

Body

    variables objectnullable
    + -The variables to complete the user task with. + -
- -The user task was completed successfully. - -
- -The user task 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 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/correlate-a-message.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/correlate-a-message.api.mdx index 4f39e87aae3..a6cfc2303af 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/correlate-a-message.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/correlate-a-message.api.mdx @@ -5,57 +5,279 @@ description: "Publishes a message and correlates it to a subscription." sidebar_label: "Correlate a message" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SsYnNqpLCqJk7q6KbLTKo0djS23B9sHkIREJCTAAqBllcP/3l2CFClRktWZXjojZxyZxGI/3r63FJFTyxaGDh/oNTeGLTh96tGQm0CL1Aol6ZBOMz8WJuKGMJI4I8JkSAKlNY+ZhQVhiVWwbDJ/vbP/KCfztRHcIMKAQRCAi3kW456liGOiuc20JDbiZC60sSTVCm2IkMYyGXDyna/K5Tr4OnAIHmwEgWiPav5Xxo39qMIVHeblpdA8pEOrM96jgZKWS4tLLE1jEZQped8MlphTE0Q8YfiXXaUcilb+Nx5Y8AvZpFxbwQ2uSpZw/NxEaNZKDi0IMyTkcyEhQ+FK+zi9vqkrK/Ot4hirhVzQAjNcI/U7X+0O0kYTUVHzNjAdr9jJOctiKJtiiGemBfNjV8r+EtZmWMfnu683JFRBliB8PcrCUOAeFk9byDiQt7GTWRyjI7cOCUALmLSTsBsfy3CrZK40WUYiiDaaDuRJKyKGOwrdCoWxhMXLmtfjBrpbRxVaFGinuUmVNA6Ut4PBYWwgjRb9gPRKcgIJJ0rzDnMN/RfE2x+z1elW7Gq1h01achASfL4iImEf5U7xHCZ9FWkvKw/m13gXAMSCa7gBHU6Ydbc+nNODxJg1xJhcHhOmUVSFwaSC4Jj894B3YPocU98rbHT8q+h4vo+BkNSzCCFqyCxDHkplQaqxCPezDPaAJpKfXmPbiEydJYwty0RMHBPcHEND302yh9tPY/LL+fufn36IrE3N0POWy2Vfz4MzDmNB6b7SCw8u8RftfuwTyB2kkbAV8WEwrqcHaThGTMoDMRcB6sm6UstkENhjCOpW885QWPch04JuP9ZG5P52QgBRacV8BRu6oTcGKPNVZod+zOR32jS0G3Q7ismShOk1wzYDgCOgmM1aZezh0bu3Hd/Iit9msylxLoCZIS+np41wWrpAWEQipEiyhA6BXHDFXtzVh8GgQJ/Y8SMqkYS/pFC+e/xslQPkKEeg81YWVqvnP+qM0mIhtuP2N8RVkfjSVVTr6V2X7/eSZTYCj3/zk3pO6jmpZ796zrt8v1H4JS2TJ+mcpHOSzj7pvN/1RW4CEGskoeH6mWvCtVb6JKOTjE4y2ikjWEw4fFODF0OaKlNSh8FL15B61fuY8VqHIrDshIUnWjkkB7jQ3KmmALLnEfgohnmqtC28Z2zJxpkILjt11ayJVcDiyEXudg8XygOfqqoxS+CxyMgFub26m5Ff4S1xyVYlmhhy0/XF4GKw0yua7vE4mk6q0eG415oHtVsU9k63zvgYx0XxhEAG0Fy7usNtDh6fM831KMMGrDlRxSu947Uzgjvuj081Uz7/OSubjbPstjmsu3phSeqU6A7XGpJtn4g1K+2mbZwetN7+hZyrMs2KXN2C0RFQxSE06L/pEhlAQT0GKoG95VAGMuNbP2EtAIM4MxaB61GY3Bzf5ZtqarMvboX84SKSN31svmNoPYsX4Dnz+xDOC9y29acfK99LmJBeFcJ449H1/c3l6OzLZHx1c3d1Bh779sWWIKNWEibbedTHFs0p7na9efMY+p8c+lYUtPzFejDahMTGl5jm1Zx4qE+vzCah8Jjbqf2B5rnPDL/XcVHgbaCmBrY9PDU8wyvwHHEWArVxtHwvCTl2eJ3NMA80jzPMp3PQV/TqHSOAIrUHbZ9aM2/69W6GUqpOtRN4QsBdzZZ44g3/D+kj/IMLVcJfqrS8n1OY9IsMuzykzi/+/AMz9VEJ +api: eJztWFFv2zYQ/isEnzZMsdw27Tq9uWm6uWtTI3G2hzQPlHS22FKkSh7juIb++3CibMl2nGbAXgY4QGBLPN7xvvu+k3UrjmLueHLDP4JzYg78NuI5uMzKCqXRPOETnyrpCnBMsDIYMaFzlhlrQQkExyQyNEww59PNzsFnPZ5tjKTRTDrmfJaBczOvaM9CKsUsoLeaYQFsJq1DVllDNkxqh0JnwL7CslleB98EztlCYjH4rHnELXzz4PCNyZc8WTWX0kLOE7QeIp4ZjaCRlkRVKZk1R4q/OEpxxV1WQCnoGy4r4Ak36RfIkEe8sqYCixIcrWpRAn1uIzTtHY4smHAsh5nUkDMZUnsz+Xixzqw5bxvHoZV6zms64QapP2H5cJA+moSKmfWB2fNKlZwJr5AnnELcCStFqkIqh1PYmFEe768+XbDcZL4k+CIu8lzSHqEmPWQCyLvYaa8UOQrrdcQRtNA4zvfjUxphlc2MZYtCZsVW0aVjVUvE/IFEd0JRLIl0ueb1WQfdZaAKr2uys+Aqo10A5flw+Dg20vXph4YZDcxYVhoLe8x1/F8Q73DMXqV7sdvViIq0AKXo8wcikvhZPyiex0nfRjrIykfP13mXGmEOlkd8ZmwpMNx6dcofJca0I8b47VPCdIpqMRi3EDzl/AfAe6T7PCW/H7Ax8K+l4+khBlbW3MkccpYLFMRDbZDdCSXzwyyrrEkVlL/8iG0jNgmWLAcUUrHAhNDHyDANnezm8t0Z++305a+3PxWIlUvieLFYDOwsO4FcorEDY+exnWX0T3Y/D9i0AAusFEuWAuu6B+s4xlwFmZzJjPSEIdXmMATsUwgaVld7TWFTB28l332sjdj15ZjJHDTK2VLq+X7orQYqUuMxSZXQX3lX0P2gu1GcL0thNwzbDlBH3KFA30vjAI9ePN/zTaz4YzqdsOCCZSaHpntiQd0yBKIkSqll6UuenA6HES/Ffbh6NRzW5JMq/oRMNIP7SgkdHj876UgdWmDw1iS2Vs9/VBlj5Vzuxh1siasl8duQ0VpPL/b5fq2Fx8JY+R2O6jmq56iew+o53ef7haEfaV4fpXOUzlE6h6Tz8qEfcmONYImEDuwdWAbWGnuU0VFGRxk9KKM64iVgYXKe8Mq4hjoCC57wuH0fc3FvKMIjHoRFE60V91bxhK+CauokjleFcVgnq8pYrOM7KsnWTISWg7rWrFEmE6oIkferRwvNwKfN6kyUXueCvWaX51dT9rtAWIhlgyaF3Hb9evh6+KBXMj3gcTQZt60jcK/XD9ZuSdgPug3GT3Fc17cEZOatxOUVbQvwpCAs2JGnAmw40cZrvNN1MOJR++Xdminv/542xaZedtkN687vRVkFJYbhWkey3YlYt9Iv2tb0oPf2L/XMNMdsybWfMDkC6wJCw8GzfSJPxo0eM1OWXjdNWc+bt34megBmyjsk4CKuZAb0Lt9lszb7EFbYXyEiezag4geGrnvxXGLh00FmyjgL2zafqTJpXAqp4zaEi89GH68v3o5OPozPzi+uzk+eDYYDvMcGZNJKKXT/HOuxRTfF3c131T2G/idD35aCCPcYV0pITYVvMF21feJmPb1y24SiMXdQ+w1frVLh4Nqquqbb3zzYJU9ubjue0VUd8QJEDrZpLV8bQp4FvE6mdA4yV57Oszfoq6P1jlGWQYWP2t72et7k09WUpNROtUuT0x4rFjTxFgua60bcNNA3Cm3urbgSeu6pwgkPPunvHwLGUA0= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Correlate a message

+ - + Publishes a message and correlates it to a subscription. If correlation is successful it will return the first process instance key the message correlated with. -## Request + -

Body

required
    variables objectnullable
    + -The message variables as JSON document + -
- -The message is correlated to one or more process instances - -
Schema
- -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}}>
- -Unauthorized - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Internal server error - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx index 55b0a9f7c1f..6ce050ce7dc 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx @@ -5,48 +5,153 @@ description: "Create a link to a document in the Camunda 8 cluster." sidebar_label: "Create document link (alpha)" hide_title: true hide_table_of_contents: true -api: eJzdV1tv2zYU/iuEnhLMlmw3XTO9eU66ZWi7wHE2YHEeKImy2EqkSlJxDEH/feeQki+Rk2ZDsYfFiC2Sh+f6nYtqz9CV9sI770LGVcGE0d79wEuYjhUvDZfCC72ZYtQwQknOxRdiJDwlLTXhgpiMkRktKpFQck7ivNKGKX8pliIMQyENW4pFxjVhIiklxzuaUEFoXmaUpMC6UswnV4bElVLAM98QKeBLV2UplbHEXAwLVki12UnWRio2WIp1xuMMeYIoUjAKR6lUpFQyqWK0gFSa+VaZpfAGXkkVLRioiGbXnoAF2NixvUqAhKPVJTUZPCv2teKKJV5oVMWeumYBtl9dEJlaL2x1Ax+hr3y4r+OMFdQLa89sSpSkjeJi5TXNYCvcmrKT/LVianMgOqW5fq1sy6zT4PAoVbJ4Wad7J5Vp87NMNkjRUyKWwgAzPKNlmfOYoj7BZ41K1X3eMvrMYoOOV7JkynCm8ZQ9lsBWT01fjYEHASyowbAA8IaGg5eOWZ9YWIqEIAVZZ8yB0Rre8kdzRZXnNMqZCyE43jPc4HIL+g9wY+7sBicgBVwtpdBO18lojD9HFOg8a0WuqSaxzZUEwBvHTOsURG9Qh+/ktUrlx/zV16xL1f34+x4Y9p/5/Tk/tw4+G41e41PrT0zilPKcJT75iOhOmIElVAZ4Bgc98ARc3paiLnIkAgT7NuWfcT7cBFQUP/SDcKjVlFw7ylYuccEhEG5HGDnpd/P3M/LT2dt39yeZMaUOg2C9XvsqjYcs4ZCWvlSrAJb4j3SnPgGLwYaCbkgELk2ADGTSnOzCTnTJYp7yuAtnqzbB4Dn7XsaMO30h2JXivTBPye38ioBfheHpBi70Rds7Ka1y5EEjWZkwyikGeBv4byF1CnlSFBTKelvFDgUAI22gP+yZARXSsBVT+/rD1pvJUaD+ulhcE8eCxDJhtjMYbEatIDSi4IIXVeGFAElY0Ue3+nE0apAnRvwVlghEPpjv0PrEHABHscOtNYwL0EvE3ysyUvEVfyr3MAlbEF84ixqXhtAJM5lgu5PaQge7XugFXRYG9a4zNgGmpMYGwtRD10BtSfJqlzwNYL7OgFUT1ti8m+ABI/NAFccKbAOJxy7JOvDkMqZ55hToBxEPsFF2xu1mjfnlzYL8AsVoTTfWqSjykPX56Hx0lCuSPsNxen1FnIUOgntloWOL+X2UrSN+DWPbbDWDoYebzQ1ec+6JGFQ1Na0wDltotPIsd1w7IthxD+87wPz258LGHEvafNfILx9pUbqE3Kv/0NcmZ8PxaDiaLCaTcDQOJ2P/zdt3fzl8ptIq0KKnbwrGFUDgbB/54z5SwVxMuFgWcNdWXUDrmpsMJsj+xAj3oTQzKN0otx2NOrIP7oT84SSSsY9hddjriu0KOFeRD+KC2F3b/ka5jIKCchG0InQwm368/XQxHX64ml1+urkcAkffPBrrPkyGgop9PdwMfNicTuwMe/rU8HrXcP5ns3OLRsMeTQDFDqbVZtDNJK5y3G0naSAPD6ZqVzwA9K4A3Hl1HVHNblXeNLjtxl4sKQnXWC2eGXz33fvvZ+Cjpnxhm4Nx/IHmFVJ5mKtdEfuHKp7M2wn6lHz7beGoVu0mFZt9lTpt93zc3AN1xmgCpQGVdAQzp8pwgWx2DHpjKL6QuBtTmF1L8yLt/V7ruP79ZoGlqH1jKKDRwq6ia3yHge/QW8IHFtK6x1Y5u1970DBXFV0hveOLf38D940Glw== +api: eJztV99T4zYQ/lc0eoKpYwfKFc5vKXBtOndXBnLtTCEPG3sT686SfJJM8GT8v3dWsklCAkc7N30qMxAcrXa/3W9/ecUdLCxPb/mFzmqJylk+jXiONjOickIrnvJzg+CQASuF+sKcZsDyTpoJxVyB7BxkrXJgZywra+vQxHfqTqVpqrTDOzUphGWo8koLumMZKHYLZVUAmyO42uD0IMm0rLQiCAmCKZsBZBlam3i58HfQSdtY5ocxGzuW1cagcmXDtCobZuuq0sZ5A0INJEptmjVa67TB6E4tC5EVhENpxySCcmyuDauMzuuMvGa1xdg7cKd4xCswINGhoVCtuAKJPOW92nHOIy4oUhW4gkfc4NdaGMx56kyNT8M5KZCNL5ie+8g9YnPaxzfmEbdZgRJ4uuKuqciSdUaoBW/b6NG4d2Vt+WuNptkyPYfSvta2V9Yj2D6aGy1fxjQNVtG6n3XekMQOiEwrh8rRGVRVKTIgPMlnS6BWu7r17DNmjgJvdIXGCbR0ig+VMGhHbhdGxOfaSHBECzgcOCGR7/M+96msckYSbFlgSGDveKef3FV1WcKsxEBh20bcCUePj4XyXqgv18Fv3rYkYdBWWtmA9Xh4RB97APSR9SaXYFnm6ytntvYJP6/LsiEM3ylqtSn3xWsXWV/em/zHvI3+u7g/F+cuwCfD4Wti6uNJRTwHUWIesw+U3Tk6EKVlYJAK/V7kmPftq2eOzXTexL7knwl+ZfSsRPnDLgnbqEbsKkh2dlkgh4FlQXAWrN9evztnb0/enE4PCucqmybJcrmMzTwbYC6cNrE2i8TMM/olucOYTQo0yCQ0bIYM8lyQTSjZmnZmK8zEXGQ9nR1sRuQF/17OmXD6Atm1ETs0j9in6zETOSon5o1Qi13T/s4c6pJ0wEzXLp2VQAQ/Ev+tTB0xW0sJpum72LaBNuLWgas33OBCOVyg2cQvlPvxeG+i/jqZXLGggmU6Rz8ZHA2wzhA5IYUSspY8PRkOIy7hITz9NBy2pJMYf4UnijK/BBWy9Yk7QjG5zlvvmFDWgcq+FzPaiIV4ane7CLskvggetaEMJbpC5zTutPWpQ1Mv5UlfhclqPRnbhErS0gBBc98PUN+S+CoUT5smyarQ1rXpioZ3m9wTM/dgBHVgTyQdhyLrk6fUGZRFALBLIh3QoOydW+8n15c3E/YLOFxC44NKJrdVnw3Phnu1kugzGkdXYxY8DCm40RZ6tVTfe9UG4dco9sPWYlYb4ZobuhbCM0MwaEY18fCYGp09r52egxCPun/e9Qnz258Tzzm1tOv1IL98AFmFgtzo//x4eHwyGJ4Ojt9Ojt6kb47S47N4eHr0V8jPufYAuuzZdYV4RWOD78P4aDdTr8a+4DItZa1811ULthSuYLBny+QRL0WGynqc3WrUi70PJ+yPYJEdxURryL2+2S6EK+pZnGmZZOHa4+es1LNEglBJZ8Im56MPnz5ejAbvx+eXH28uB0fxMHYPzoePikGC2sQR9ubt4XTgF9nDp46v1gPn/327z2CHDy6pShCKsqvbY0K3uX3cvnnE061NPDScadQ1jVu+Ws3A4idTti19HVZlakO5sNRhnlmWNyn593vzXle+YLO1wt9DWZMUp/ruG98/hHhw3W3dh+zbbxh7UXVfgmo2IfVoN2LcTtuIFwg5Gg8yCJwHKIMJqVkr2Fld6SUm3BhlGVbuRdnpxri5+v1mQu2re8uQOqc7Bpb03gPLAFb70Piu6L9b8RLUooYFyQad9PM3iPIsbQ== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create document link (alpha)

+ Create a link to a document in the Camunda 8 cluster. :::note -This endpoint is an alpha feature. It currently only supports an in-memory document store, +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, which is not meant for production use. ::: -## Request + -

Path Parameters

Query Parameters

Body

+ -The document link was created successfully. + -
Schema
- -The document link creation 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx index fb9494e3a00..f2de4e8ae8f 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx @@ -5,29 +5,32 @@ description: "Creates and starts an instance of the specified process." sidebar_label: "Create process instance" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SsYnJKpTcmOnbjqSZadVm0+PLaSHGwfIHIlISFBFgAtazj6790FSIqiKNeTtD3VGUciAey+xb59C7jgVswNH9zyK52GYAyTylihQuD3BzwCE2qZWZkqPuAjDcKCYUJFDOdoS1/r+SydMbsAZjII5UxCxDJvMbhTE3xfPrEIZlJJMslsynID9BE60259bS9E49OmPZA4rnGJVHMm0Xuu5J85sG+wulMvhGEabK4Vzpyu2AVkcbrCVybNNTp+ecDSai25Ob96/6HGNL5wQQn2ANogMoR8p74I8jHDVTQ/TJMsBge7DDRrbRiCxclQoiA/gtznsb1TywUoJpZocbSxIw0DJaYxROiPH3ANGI2x52m04oPCPUoNER9YncMBD1NlQVkaElkWy1CQld5XQ8kpuAkXkAj6ZlcZYLrS6VcILdpNFXycYYp3R6y0MdSZLRkwLuO5LuGs/oAVXx987+pxxNf3z5uMXjg8CtogQ4Gcr7pYg+l28eZJIvSqNom7vZuR2sBFvR6jCRD8g4hzIDtdE/jg6PjVySnN0pIyRHDWa4TXDWl88SOIxpFjX8W9J8Hhbg44gTs8ff3mjKb6VYh4B+3aIUYKZqkyfkeP+3362K7rSReZl1hPviojQvTd5EPDGWgrvf/uze4ChFluF1pjw5cLGS4cRhSQqKUg7Vh8dZXAJMYxB40vsFgTYf2r1yfEvc7d7gLXFo8fA4r4KqhNpMZqFJFOXJ+rpHeBKxnxH+7eq+MGyqqm92a2VG0ZIZ9I2HWFtKTbDoJfCCF2AgcWlVQDhujE1anGnVIAkemqNiLRCwjmARvRc9wtOy+fTRAsAaHsPlb40QYf9gUUdCW5WbxcRJFLlSDIdf34PrDteBjHzle9nD1II/ELenMDOk0tMyFaabgty5P04W+E2YsH91py8oR8PGBCIxYJK6ixKXSKKiZRPHDdade6IZ0dLGgMkoHW2GfTMMy1dkmWcc3EqmOX6X5CjXABBp78tKtKLc/sys/EorBCxsxvBxNUJTRxihhw+26v347Yzyenb+5fLKzNzKDXWy6XgZ6Fh4D5SXWQ6nkPH+mX5r0M2IT4yRKxIsZu0sg2OlidaEKidVlxDgzlZouKe0TUjxYtCjX4mmvJd3jCPl2Pq6JbVXu65dqtmQk8sOB8MU1zO5jGQn3jG5bsOm17KZtgQ30aDtAQ8srmjTD2S0rbNvHst8nkinkTeCKLoDyeIeFKRxREgjqX5AkfIF3xSTz6p9f9/ppsUsafEYli8Jhh+KJ15nPhIDkSOut5ay6w+tz8z2Qm1XIu236DrYotSXzhIyrbfQJ2kdIhIUuNo46wC3zqlcV0WME0OGZAU7NwR8Nc46bwwpfMGpleLNDAelBkqbbr3sMxb0kUDfvSqigTp6GIF97tbupoQImkvieMRJKrSLAzdn15M2G/ovgsxcptJbncNn3WP+t3WqWpeywOr8bMR+iJ1xCDyixVdadZP/k5htd0uDWAwiXt6oaW+e2ZgtCghzntfk2I0p+zTs9+Er7xX95WNPn9y8RlmoTsenMruPRn4/0HqX7rDNjsWBs2kpY4Vl/DDMXKcbbvKlNbEn6dhzTqeQHIMNi2QBG37jJ8MBOxweY0AxsuPm8w3FaL7uv7zUQmgNqCPl3VzFK3QVUX2tnq5hmX94Oj3frBdJAM4A0N17pegDW0xMsiHgk29sI4N5ZSdsCxYQA1NfRLjGy4fedHWHnAYkcB0c7XRtUC5mg5nwborhf6ZfXnNE6nvURI1StdmN5o+P7Th4vh4bvx6PLDzeUhWgzso2+9VKKJUE0c/hzWPjC0Yy42HfD/W/m/fCsvS9fCo+1hP5CKxMQxoijF9ZbviivS3QvkLS+KqTDwScfrNb3GvaE74u39plbpCY0uQESoBlR17o7LRz7JhxOCUN8Kdy9gdDn3K4ZhCJl9cu59o0dcfbyZkPqUf3FIsKPiWy2W9NcI/H/A7/Cfk4xSEQr/vuDYGee5mNN8b5d+/gKdcnHU +api: eJztWltv27gS/isEn1ocRXbSy/b4AAvk1nO820uQpLsPcR4oaWRxS5EqScURDP/3xZCSLEty1nu6fUuAwJZEDocz33wzQ3lNLVsaOrujV1rFYAzh0lgmY6D3AU3AxJoXlitJZ/RcA7NgCJMJMZZpi1/b8USlxGZATAExTzkkpPASw4W8zaC5IgmkXHIUSawipQH8iJ1oN7+VFzNJoq484DYDTUrD5ZJwa0gp+bcSyFeoFvIFM0SDLbWEhEQVuYBCqIpoMKrUMZiXAVHNXFzm7Orjp1an+YXbFCMPoA1XMlzIhfyd4Rqp0m58rPJCgFO73mjRMxiJIFUaai1wHYbLl8Iu5CoDSdiKcXu+lcMNAckiAUm4kDSgGr6VYOyZSio6W7tLriGhM6tLCGispAVp8RErCsFjhlImfxh0zpqaOIOc4TdbFUBnVEV/QGxpQJWEzymd3Q2fMCH2PCm0KkBbDgYlPjDNUVF3sQuKX24+fyJ+GrEZs2TFhahtYnnj1FZAa0+tlG1vExOrAhZyj2W9eQbKJ4mDERNXHWXRVpuAWpBM2nkyVBix6J+i23srbsEZblc0VnO5pJuA4jLO6teQggaMkoH8U6Kbh4hMEmfKgERI4kKlAd2xUwSkYNqiGkwIoiFWOjE1bBBCqVY5sRk3pF07XMiPpbE49+cp4Skq/8CTBkW10lxaWIKmAU2Vzpn1t96+pgHNueR5mdPZ8SagLpDn0lhdxih9xMUfuHEauqHOKc3YkJxVaDNWChuMB4Xbpp/J7EI6hnBX8ADShmS+1f8pCYj4akSDhWSpBU24JRkzJAKQNZnsmoNpzSoaUG4hN2NBsgt4EJDDOH7el7bUQODRgkSuMCTnywy1ikWZwGwhCTkiCU8dCCzBhcy4+fxQFnHBbYU0aMASoWImegGzlZYKtfLRYpCj3itNpFoFJFMreADtTThYCamG58gZ3IqKMLLwfj9zjHXpN7ug3Sld4zUBgHHFrcBbdbaY105yqYEredNDk5vT472hSZFpW2IY+B/Tg58MDi6jgzr0nCi0jVSWqDguNVlxm3HpSccz7C3PQZU1Yut7bTzGQhlIQnLBjeNmjNwa4juIipQSwPBG/ZTOUiYMkk8KNs5+28+ZTUBtnSxZDgZ3GkEDpIS0SptCSYMsOE8J5IWtAscWD9xwJM+tmGYGcqsDSburJjUeFBQdf+9abIRN/QPygkuSm5e7Ft1JoI3Ldty5pQ+idJ0mMQisIlPvniVI0Dxuhdp6wVjJlC9LvbVTLErjqMA4tuCHEmIX1r7E6YH7us7LzADd3Pepot7XRZs5foVqPOtsyxXCE5CWp1VTjQzzT0AgXIbbkgbNyDq4x2kLmfSqHAIyKRRHYj1nLgYil3MSYtUSXPmE4UAGSs//aWNVaIZN8FxzPNcczzXHc83xXHM81xzPNccPqzn2JZ3+Kcfe1OOYwDPmzpFOuJB/r5D4FapwLI6DodK/+cOWcc3rk5iexiH5LEWFjjA8AXSEP1kZK2jQKZ001c8aAs+y7J51cC7u9gBvvjrphuPR8eEV0jxxrj1kMNoPHhlC2AHgrBrz4VdfeZoyz5muWpE7dWNzVlWNu44G9IGJEvZXtscnr16/CXbKsw3ueVyl+cX3aDRP3Llccyr3pHIYAhSVO3rz9qd3OLSB1/FA283G84wnOWfRk+l0HIjD2oCZNt3T7ziW+3/bCCzw9sfxKuNx5nSso7V7tvpkkbufrEZi9/sJ5xBFw4VsVP1xnPIjrffqpKNlE9N/1SDWzSEH3Whaw22gwX/q9O2UXWWgsR5zx86ONRZSAiRmLNoQRC9ch3mO12Kcdl4eDJC/2fvs29BoB7TTCe7vwPqvK06F6PWBTfEyKFnCQat3AIt78qCeS14/QR8uA5GEWYZpRboeVPAkxL29GZt3iinYgpZMENBaaV9V+nTHRYvE5vSgdvcTbFRoFQnI/zVkpX4jeeVHkgQs46LpshlGCQ6MfO1zd/3+nPz79Zuf7l9k1hZmNpmsVqtQp/ERJNwqHSq9nOg0xn8c9zIkt4hPkrMKEbt1I9nyYPOuJ0ZY1xHnlEHfjDfkuyTqn/Zryg5eS83pACfky/V87ERmu3Q3w1MWqdLOIsHkV7pFyXDR/ip1EuywT2cB3xXbslsSP1lv9HH2v9vbK+JFkFglUNfAvgbChcJuF/56Og1ozh791dvpdIMy0eMH7EQSeCwEk6z3NsxtB2tyfAvmpbmNtW8U/xnPKM2XvL9u2O8U8eaF31Gd7nOwmcIioVDGQYfZjM7opA6mo0ZNQwNqQGOycMdUpRZ0Rtc+ZDazyWSdKWM3s3WhtN1MHk5oj6LwsQ+tBjKuv878skPX4QNsxpotnbO8lAkj78j15c0t+S+zsGKVMyUuuSv63fTddFQqDt0j8fRqTvwOPfA6ZNCIxageFesHHyJ4g8WtgbjU3FY3OM2bJwKmQZ+WaP0WEPV6TrrrdN0gGtRf3jcw+eX3W+dpJLLr7fvSS18b7y+kpr0asJuxtmgcO2ubjp5X3e2c17TJ6n7k5MF16MMG/a6ZdD/seKcualLlDNRkoYGpuzUunYbHw/i5mjsaiFWel9LlArn0fRvruK5uYpEgBI8Bk9psTRGRnWU/+CekLrDIcYiw87HRpIAlt1kZhbHKJ7Gf1n5GQkWTnHE5qZcwk/PTj18+XZwefZifX366uTw6DqehffSpF0M0Z7Krh6/D+gVDf8/rbQZ8/r3CD/69Qh26Fh7tpBCMSyQTh4h1Ta53dEiu90FNkHd0vY6YgS9abDZ4+1sJ2CPe3W9jFa82Ac2AJaBd1Lkel557Jx/dogptVzhswPAFhJ9xGsdQ2CfH3ndyxNXnm1tkn/q3GLlKcI5mK/ydBlvRGXV00Z5eu3trKphclmyJY71M/PsTLV2e5Q== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create 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 @@ -36,44 +39,285 @@ The process definition to use to create the instance can be specified either usi Waits for the completion of the process instance before returning a result when awaitCompletion is enabled. -## Request + -

Body

required
    oneOf
    variables object
    + -JSON object that will instantiate the variables for the root variable scope -of the process instance. +0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + startInstructions: { + description: + "List of start instructions. By default, the process instance will start at\nthe start event. If provided, the process instance will apply start instructions\nafter it has been created.\n", + type: "array", + items: { + type: "object", + properties: { + elementId: { + description: + 'Future extensions might include:\n - different types of start instructions\n - ability to set local variables for different flow scopes\n\nFor now, however, the start instruction is implicitly a "startBeforeElement" instruction\n', + type: "string", + }, + }, + title: "ProcessInstanceCreationStartInstruction", + }, + }, + awaitCompletion: { + description: + "Wait for the process instance to complete. If the process instance completion does\nnot occur within the requestTimeout, the request will be closed. Disabled by default.\n", + type: "boolean", + default: false, + }, + fetchVariables: { + description: + "List of variables names to be included in the response.\nIf empty, all visible variables in the root scope will be returned.\n", + type: "array", + items: { type: "string" }, + }, + requestTimeout: { + description: + "Timeout (in ms) the request waits for the process to complete. By default or\nwhen set to 0, the generic request timeout configured in the cluster is applied.\n", + type: "integer", + format: "int64", + }, + }, + title: "CreateProcessInstanceRequestBase", + }, + ], + properties: { + processDefinitionKey: { + description: + "The unique key identifying the process definition, e.g. returned for a process in the\ndeploy resources endpoint. Cannot be used together with processDefinitionId.\n", + type: "integer", + format: "int64", + }, + }, + title: "CreateProcessInstanceRequestByKey", + }, + { + type: "object", + allOf: [ + { + type: "object", + properties: { + variables: { + description: + "JSON object that will instantiate the variables for the root variable scope\nof the process instance.\n", + type: "object", + additionalProperties: true, + }, + tenantId: { + description: "The tenant ID of the process definition.", + type: "string", + }, + operationReference: { + description: + "A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be >0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + startInstructions: { + description: + "List of start instructions. By default, the process instance will start at\nthe start event. If provided, the process instance will apply start instructions\nafter it has been created.\n", + type: "array", + items: { + type: "object", + properties: { + elementId: { + description: + 'Future extensions might include:\n - different types of start instructions\n - ability to set local variables for different flow scopes\n\nFor now, however, the start instruction is implicitly a "startBeforeElement" instruction\n', + type: "string", + }, + }, + title: "ProcessInstanceCreationStartInstruction", + }, + }, + awaitCompletion: { + description: + "Wait for the process instance to complete. If the process instance completion does\nnot occur within the requestTimeout, the request will be closed. Disabled by default.\n", + type: "boolean", + default: false, + }, + fetchVariables: { + description: + "List of variables names to be included in the response.\nIf empty, all visible variables in the root scope will be returned.\n", + type: "array", + items: { type: "string" }, + }, + requestTimeout: { + description: + "Timeout (in ms) the request waits for the process to complete. By default or\nwhen set to 0, the generic request timeout configured in the cluster is applied.\n", + type: "integer", + format: "int64", + }, + }, + title: "CreateProcessInstanceRequestBase", + }, + ], + properties: { + processDefinitionId: { + description: + "The BPMN process ID of the process definition to start an instance of.\nCannot be used together with processDefinitionKey.\n", + type: "string", + }, + processDefinitionVersion: { + description: + "The version of the process. Only considered when a processDefinitionId is provided.\nBy default, the latest version of the process is used.\n", + type: "integer", + format: "int32", + default: -1, + }, + }, + title: "CreateProcessInstanceRequestById", + }, + ], + title: "CreateProcessInstanceRequest", + }, + examples: { + "By process definition key": { + summary: "Create a process instance by processDefinitionKey.", + value: { processDefinitionKey: 12345, variables: {} }, + }, + "By process definition ID": { + summary: + "Create a process instance by processDefinitionId and version.", + value: { + processDefinitionId: "1234-5678", + version: 1, + variables: {}, + }, + }, + }, + }, + }, + }} +> -
    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust 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 [
  • ]
    • 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 that will be part of all records resulting from this operation.\nMust 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha.api.mdx index 841c0c56569..f55e820ae85 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha.api.mdx @@ -5,52 +5,154 @@ description: "Delete a document from the Camunda 8 cluster." sidebar_label: "Delete document (alpha)" hide_title: true hide_table_of_contents: true -api: eJztV0tv4zYQ/isETwnqSN5ttk11M2Jv62K7CBKnPSQ50NLY4q5EakkqjiHov3eGlPyK06ZoT0UOiSVx+H3z5rDhTiwtT+74WKd1CcpZ/jDgGdjUyMpJrXjCx1CAAyZY1smwhdElczmwS1HWKhPsgqVFbR2Y6F7dqyRJlHZwr2a5tAxUVmmJu/BZKCaKKhdsAcLVBiI2dSytjUHUYs20wn+2riptnBeW6qyEUpv1lts6bWBwr1a5THPCRCpWgiC1tGGV0VmdkuasthB5Ze4VH/BKGFGiHYbMbbjCF7Sth51mKCLJ2kq4HJ8NfKulgYwnztRw6JIZ2j4dM73wXtjo5jTLvLMiRLBpDqXgScPduiIu64xUS962gw29N2bL/a0Gs94jX4jCvpbdg2112F+kkP21Vg/EayutLFhafz8c0s9z6g3mStiOK8OopSlYu6iLYh3xdsDPh+d/t1263Cu5lI+gyCICpHAuNGZV5MOWauVQmKBEVRUyFQQVY5jnBZTffbGE2+yYtU84YldBEhV1QhZMz79A6pjXnATnqLtU7O764yX76fzDjw8nuXOVTeJ4tVpFZpGeQSbRsZE2yxhf6Y/kTiOGxqC/S7Fmc6yODMWQUxSUghUYJ8EyW0EqFzKlqJClndqMfB/s66IQ1KI03WzexugwVgOOmV4KdAqvjeSH6TFit9dTJjN0m1ysccNzar9nIeqCMMRc1y6ZF0J9pcA56YqjpIcsti5LgaXZ5eE+AQJZhzW+YwbmuIMlmF398dP3759hU5r8MptdsQDBUp2Br25HDaUjIiNKqWRZlzw5Hw7xTTyFtx+Gw5YwKeKvsEQxeKrQfJ9ah+ZgcpRUVwHNGyYV6qXS/yoy2silPOSNqE/0seBdEo+DRW1Lax+O1eeIeiY2OcpDMAZdplPfXzOGDbPw8FSnPTd1GrDurdbeau2t1l6qNVzEySHXGQ0M/rzz8wTOCQmP++PMxs12mGjppAXz2E8btUHf8CZUTosJ3+TaujZpaNJp40cKy6MwUiCzjyIthwrrM6fQqSj852MRpAWaKXrLtoPZ9eRmxn4WDlYiHMxEuQ99MbwYHkUl0RcQR1dTFiwM+bfTE3pYKu6jsEH4NcB+KrGAHUy69Q1tC+6ZgzBgRjWFYJMXHZ9Hp/cghF/Cw8c+W379Y+YDLtVC++1d4J8rQlHBEAbNh9G750mGylKtpLrEvb5hYqL5wUYcGY5xP3ZVwAmLeLsZsBf7FFbY74GRvYsoKCFz+j65ROR6HiFdnIZtm995oedxKaSKOwobX45+u/08Hp19ml5OPt9MzhAxck/OG19hwpRC7ejRjfmb8ezET+qnhzY322Pif3Iz6NLHwZOLsTXhJN52fm+6Kr/b3BMsyic7lwZMz1Cqd7xp5sLCrSnalj6HWZ6KP5OW6vqFaX7Xn/9msD9qxVdY790yHkVRkxSnuuobzj9U8uS6u52cstdcg47q1X0Uar2rVK/vjn/bB5TOQWRYyKRmEBjhXaNyO1tfHFfIzk3vHk8+TWYTTP8/AQwvKiQ= +api: eJztV01z2zYQ/SsYnOwpTcqp07q8aWynVSfNeBylPdg+QOBSRIIPBlha5mj43zsLkpIsy6077a052JKIxb59eLvLxZqjWAae3/JLJxsDFgO/T3gBQXpVo3KW5/wSNCAwwYrBhpXeGYYVsAthGlsIds6kbgKCT+/snc3z3DqEOzuvVGBgi9opi0wFJiy7FbquBCtBYOPh/iiTztTOEnQGwuv2REgJIWTRrv9/MliH1BTHKZshk433YFG3zFndstDUtfMYAZQ9MWCcb7fxBnQekju7qpSsKA7rkBkQRMV5VntXNJLYsiZAGgncWZ7wWnhhAMHTEa25FQZ4zke3s4InXNEJ1QIrnnAPXxvloeA5+gb2j3FeAZtdMlfGk9vEho4V8YBTnvAgKzCC52uObU1YAb2yS951yQY+ktlif23At0/AS6HDa9Gjs20MTxdJ5r+O6p5wQ+1sgEDrbyYT+ngOvfG5EmHAKlhootJlo3Wb8i7hZ5Ozv9uusIpBLtUDWGJEDknO0jW2SKNs0lkEi+RK1LVWUpCrrPZuocF89zmQ3/UOraeAU3bdW7ICUCjN3OIzSGQxcjJcQMGUZbc37y7YT2dvf7w/qhDrkGfZarVKfSlPoFDofOr8MvOlpD+yO07ZvAIPzIiWLYCJolCEKTSlYA0eFQQWapCqVJJUIaZD2IzOvuc3qNCHRWm62bzVaF+rhJfOG4E8541XfD89puzTzYypAiyqslV2+Rw67ilFo8mHWLgG84UW9gsJhwr1QdB9lNAYI3w75uFTgC7hAQU2OzS4sghL8LvxK4vfv3nmm9Lkl/n8mvUumHQFxOpGakIDEJEwyirTGJ6fTSYJN+Kx//XDZNKRT1L8FUwsg8daCxtTa5+OssxQXfXeIjFlAwor/ytlnFdLtY+bUp8YteBDEl/2jLqO1t4eqs8p9UwET3kI3jvPnIz9tWCrSunonup0xKZOAwG/1dq3WvtWay/VWpdwA1i5ggaG+L6L8wRWPOfZ+DoL2Xo7THT0pgX/ME4bjdc85+u+cro8y9aVC9jla5p0uuyBZHkQXomF7pORlvsKGzNHOyl0fHxIQVqgmWJkth3mbq4+ztnPAmEl+hczQT51fT45nxz0SqYveJxez1jPsM+/nZ4wuqXiPui2N36N4ziVBJCNV9h+pG398SxAePDThiTY5MWAF73T796IJ8OXd2O2/PrHPAqubOni9kH454GQKuBDH/kkPX2eZNezWCvSGdPY2DDtsh9sxIGBmidcKwk2xHQeZsDR7H2/wn7vEdlpSqL0mTP2yaXCqlmk0plM9ts2nwvtFpkRymYDRMgupr99+nA5PXk/u7j68PHq5DSdpPiIkXztAhphd+IYrgab8ewojuvH+5zX29fE//g2MaQcwiNmtRbKUhFErdZDZ7jd3C0CT3i+c9G4T4byvuXr9UIE+OR119Hjfv6nhlGoQL3ghRvArgb/5jJwkMUXaJ/cTB6EbsiKUy2OTeofBnl0M9xojtlrrk4H4xoeCtvuBjXGu3O+3X2X8ApEAT6G2RtMpYQad7a+OOIQz02/v7x6fzW/4l33J31MUOA= sidebar_class_name: "delete api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete document (alpha)

+ Delete a document from the Camunda 8 cluster. :::note -This endpoint is an alpha feature. It currently only supports an in-memory document store, +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, which is not meant for production use. ::: -## Request + -

Path Parameters

Query Parameters

+ -The document was deleted successfully. + -
- -The document with the given ID was not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx index 2075c8028d7..a1195a85f4e 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx @@ -5,53 +5,209 @@ description: "Deletes a deployed resource." sidebar_label: "Delete resource" hide_title: true hide_table_of_contents: true -api: eJztWN1v2zYQ/1cIPrWYYzld2mV+GOAl6Zat7QLH2R6SAKWls81WIjWSimMI+t93R0qy5Q+kD3sZ5hRJRfI+eL/73UlkyZ2YWz6852OwujAx8MceT8DGRuZOasWH/BJScGCZYAnkqV5Bwkwt3H9Qk4W0LBaKTQElcqNjsBYlZ1JJMtDD51hafEKtvwtpIAPluhLasJk22cbcg2p9FVaqOXMLqN23zi0DleRaKtdntzk6ma28WLPOVrpgS6Eccxp1KQgmlRf53Mj8DqvPLBdGZLhqMBze4+2QcCm5wgGisKGBMpKAyYVb4HMdVsKHzhSwjd4E3X2FFdOz7ubaPW1h6Nby++HsCOzFlsBr5AnbjsYO0BiBjReQCT4suVvlFCxiCnMwuETiwoWpd2e8qh5DwGDdzzpZkc46/plILQIQa1RXjtZEnqcyFuQp+mIJkHLXm55+gdihM1WkqZim0CCJ4edgnARL0vTsLY1hBgYUchVnu2iPEIh60YccL7QFxDUwo7BAaAjHljJNCW3MtfO44NBArE1iKUVF6oh0M6MzlMfktL4xWx8L60j3JzZgckY5epIJJIE8LwHY4xkinxUZH55WFcpLR/HWRdYU4TggjHCTDG4o18oGFN4MBrthTzaZJW3NrKTPUfvskEKzcZYIJ0hLaceeRCpR72ASUQkTlH23m8ztRNwESdyLEzJlIclM0OZIcIqOsRrvx+8v2I9nb394fLVwLrfDKFoul30zi08gkU6bvjbzCIf0S3Kv+ww3b4BlYuV7TpJ4IouUrenCrO8HMqYycyFWvxlKTydRLfe6XAurLUOtM8iHzWwWRvLtUh+xu/E1Q0iVw17UdK2Oa68zE8gvlBdTXbjhNBXqK19TYdfpthdbZJkwbUvpOkBD1glX2BfL+fs3O7aJFr9OJjcsmGCxToA6RiiC2lF/k8TILhyJ5zB6NxhUZJMy/g2RKAbPOYYvQqfqhoPkyLSBmj8+MKlwX3Xd/wuZ0UbO5bZfdLRRljWJL0NEoRzPBmcvVyDV0kwX6lhLx1o61tLBWnq77+WEsRDKhngIxiBkOo4Lg58YbLmQKTSfRY3v+nvkWGnHSjtW2v5Kw0U80ix0QscWbT116PQy5FF7nIrKjTNOFflvSNoIpgbMU3McKgxixMtQQRUSv8RPbFcNy1wbV0VPlJ4nYSR9x/ts0nKotIZBqY5Fugi72M0kLdCZq4nwQmT4GhXsnI2vbifsF+FgKVYeWXLZNX0+OB/stUqiByyObq5ZiDDwcKM3NGapyPeaDcLfYtifnCxgH5NudUtqAZ4pCANmVFAyWn7U/rx1GgchnAkP7xvW/PbXxCee+tp4fSq7ehZZHqpy36Fp4Ek5095hTZndrVMeMekh1kH/dJeeGB5VWawz1PWtFim6lG6Bx8y1vTjF8xJB0OPYjwHPMeS3PlU3Yh/CCvszeGSnfUpj4FrTYedouZj20V0UB7X2/2mqp1EmpIpqFza6GH28+3Q5OvlwfXH16fbqBC323bPzcFEFZEJt7CMcv9ovuO1Yy/WL5X93HVJT0sGzi7DtSUVF4jNT1j3kvr0csSg/7N6UtG0E6R9awT0vy6mwcGfSqqJp5K1Z4fzjunP4VpNIS8/ri4WDOXk1ru8gXrP/wn3LXkjrSaFWvoOmBY3wES1tXT9Vjyi+AJFgSyCcgsRFQONkQnbWFnZuYKpeozGKY8jdAdnOJxP1rvb9cfPH7YRaUX39k+HbljYolnQXhn+H/AH/4UD7TPku5+dLjm/NeSHmJB/s0s8/ZB4kmw== +api: eJztWE1v3DYQ/SsDnhJUltapm6Y6FNg6Tus2SY31pj3YBsKVRismFKmQlNfCQv+9GFLSfhrJoZeiNrCwJA5nOG/eG4lcM8eXlqU3bIZWNyZDdhexHG1mRO2EVixlr1GiQwsccqylbjEH0xvHt2peCgsZV7BA4FAbnaG1kGMhlCAHEeSYCSu0AoNfGmGwQuV2LbSBQptq69mtGmM1VqgluBL78GNwC6jyWgvlYriuMRNF682GcWh1AyuuHDgNuU8ChPImHwebP7D9CDU3vEKHJr5VLGLjLeGyZopXyFK2NYNFTBAwNXcli1ifVs5SZxrcR29eInzGFnSxu7hxTXsYuo39cTh3DI5iS+AN9oTtzowDoFnEbFZixVm6Zq6tKVmhHC7RsIiROXfh0csz1nV3IWG07hedtzRnk3/BpcWIZVo5VI7GeF1LkXGKlHyyBMj6MJpefMLMsYipRkq+kDggWRtdo3ECLVnTtfc0wwINqgzp6S7aUzDDoE85K7VFBYvAjMYiocEdrISUhHbNjfO4SAkGM21ySyVqpCPSFUZX4Kg4Y+z4Vr1rrKO5P8MEREE1uhc55oE8XwMwYpVQomoqlp52XcSccJRvL7JBhLOAMOs6sjFoa61sQOHFZHKY9nybWcL2zMpj1kXs7LEJw8Ih547TLKUd3HMp8pg9WsTa6IXE6rvDYu4X4ipYQo6OCwmhyMBpcWS4wJzUeDN7cw4/nf3w492z0rnapkmyWq1iU2QnmAunTazNMjFFRj+yex7DvESDUPHW95w890TmEjZ0Aev7gchIZi7k6hdD5dkp1Mi9Xa6F0ZGh1hmhltvVbIxg+1KfwofZJYgclRNFO3StndB+TsEbST74QjcuXUiuPrMNFQ6D7kexTVVxM7aU3QBdxKzjrrFflfP3Lw58Ey1+m8+vILiATOdIHSOIoA8Ub5P4bDKJWMUfwt3LyaQjn1Txb8hEAT7UkiseOtVuOkJBpQ32/PGJCWUd73X/L1RGG7EU+3Fjti3LnsSvQ0ZBjmeTs68rkLRU6EY9aelJS09aelRLPxx7OU0VEMqGeIjGaAM6yxpjMIdVKSQOn0VD7P575ElpT0p7UtpxpXURq9CVOqdti7aeOrR7SVkybqeS9dYep0v8NyQtJGIWzf2wHWqMZClbBwV1aZKsS21dl65rbVyX3FN57rkR9B3vq0nDQWkDg6TOuCzDKg4rSQO05xoyPOdVo3IOr2B2cT2HX7nDFW89shRy1/WryavJUa9k+ojH6dUlhAwDD7d6w+CWRH7UbTD+Fsd+52Qxa4xw7TVNC/AskBs004aKMfKjj+e9030wYlF/8WZgze9/z33hqa/NNruyiwde1UGVxzZNE0/KQvuAPWUOl051RGNDrpP49JCeV5deZZmuqkb5VquWsBKuBL4FRSYbS3trFjEpMlTWr6vfVQ9mb8MI/BUiwmlMZQxcGzrsUriyWcSZrpIsTBv/L6ReJBUXKulD2OR8+u7D+9fTk7eX5xfvry9OTuNJ7B6ch4sUUHG1tY6w/Rq/4PZzXW9eLP+745Cekg4fXFJLLhSJxFdm3feQm/FwxLKIpbsnJWMbuYv6VnDD1usFt/jByK6jx18aNC1Lb+42ncO3mlxYut4cLDxak2ez/gziOfwXzluOQto/5Kr1HVQ2dMci9hnbveOn7q6LWIk8R+NxChbnAY2TOfnZeDg4gemiYcY0y7B2j9jufDJR7xrfH1d/Xs+pFfXHP5XO/fkYX9FZGF+FVWtfJd/h/LM1k1wtG74k2+CT/v4B5Kcjnw== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete resource

+ Deletes a deployed resource. This can be a process definition, decision requirements definition, or form definition deployed using the deploy resources endpoint. Specify the resource you want to delete in the `resourceKey` parameter. -## Request + -

Path Parameters

Body

    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
+ -The resource is deleted. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + title: "DeleteResourceRequest", + }, + }, + }, + }} +> -
- -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 resource is not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx index 4128d208bf6..5d3eb6b7c2c 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx @@ -5,41 +5,288 @@ description: "Deploys one or more resources (e.g. processes, decision models, or sidebar_label: "Deploy resources" hide_title: true hide_table_of_contents: true -api: eJzVWdty2zYQ/RUMn5IpTSlpmrrqk2olrdrY9dhK+6D4ASQhCQkJsABoWaPhv3cXoHiRKFt2FHc6k4wNAns7e3Zx8dozdK69wdS7YlrmKmLeje/FTEeKZ4ZL4Q28EcsSudJECkakIqlUjKhytSYvWDAPSKYkDDTTPolZxDVIwsKYJfABZGZSpfpl8ElMFlwT+EcFoUamPCIRTRKf8IAFhHGzYIrAh4Z+CtZi6wGLUZWwbswILE1xEpR6vqfYPznT5hcZr7zB2g65YrE3MCpnvhdJYZgwOJXmieEZVaaHTp3E1FD8rCPQZ38zq4xB1DL8zCIDqiG0jCnDmXaaS8caS6lSdOVtwzZZMBJyQdWKoBFiJIkUo4ah62VIKThVxxqQsUFwMqk1DxOGIgt6yxzkZgGgYfDoN8EIyBIAIzGfzZhCRfWEoClAB2Nrq9sL2vDBgcgNS5txaaO4mMMEKqaAnuc0eUXhe4AnFWYcd63fBcKtRuvOqPWrTrKRgVVa521aIe3dFIWb05kU2iH/ut/HH7uGuokTeC0O0CxLeERRrPdZo+zhBKhB+4OtGss5aJ8z1UQLPr190wlHLjjwlXxhK8JjUMVnK0BuixgAid8w18W47Yzt8bmszhGbccGdG48WOTTTYZaKTTsg45FPqEZOaqjeOEepRoQ+JH7ObNFbKmP8t0zZ7mFbBqGfRIlViRNntpsAe3UGjWYGHWRjLK58RToX/m4MfzndD2bt+9edoVEoy7mAQDYWS1+DTmNfQY/KEBDEJ8sFjxaERkYjlpR0A2Kws5ZOWIc2lXABveCw1G0kbPsgMyXT0nZTN1lWCbVmntQHxqOyhdetvXYdlXKTsGrrQapcumlXEm6DeQydd2UO9TgGOldb2rPweWOtZPHtkUhbBdFk7S4ux6BtZeqx/N0KXRxM3dH5hWNtRSun6N50HZW/letNWK/cfmbb92MI19RfQqkaqshc0QzpRU0bN3t6wAOAnN0fucO3y80jta2v9t+62NkKRuXifREc3g2emp7uoB5oDj/vbw560x321MYzNodWRF2doonZ4VvLvvps2Xv+Ym2Z3xvmUVtiC+Cn9se2344Kx97vuz1u7f73lmerJAuH1sOliasOza+97zzLlowrj1xx1vlmgeGH/+LMaGP7FgSyEX6j02LpdCcB3yPRuqfOmaH2xn//DbZb+Kq8gHruPvpm3xU0llFuL/Y5SFLwlfIEwifn0t5IDQzd7RSYfwsZiQkXm/uwNUBCGa/clXzPpRUkw4Sl3+1eXtvuDMmlW1naJa7qkBNuYeisT6/en5Gf3vzw482LhTGZHvR6y+UyULPohMXcSBVINe/BEP/jupcBgVAhhpSuSAjsi2N7eqQJqeu5rh+492OApdsE0Xbx3d8M3Ow97xFQ7TvEGZKPV+Oda3XLtJWZ0TxBHTSUuRmECRVfvDrvD9FzSHSepvisUlKzbQAUaUNNrp/aJ36bTC6JU0EiGbPWHQ8NYRApnNnTHLoqcBFG9M6N3vb7difDjB8QiSDsLoPwLbW2w+HCvT45bTYwLsAvER0rM1LxOd+2267tksQjF1Hh6i+Fri6heL1MaksdahYw6jVfTCALTGGT9QbTNfgEcHhrVywFcHy9ANFisM6kMkXvFjNxSxWnYMwmDqddUW3IksiIJgtncDdpONE85ZzRNBcxJafk6t31hPxKDVvSlXsuAJNt1af9036nVly6R+PwckxchI5yjTawUYv13KnWLT5EcVHcIJAR5NSsrlHMwRMy6GJqmCPuFRVKe1Y7jt0i+OJ+eb8hyO9/T2yOuZhJK17metcRr7Hpev3g1S6vwFksj0imIGt7JHDLbve0EViU5NpgQL4HjZRhJwe77o5Zmf3gZkj5VEReBZgUx5xNa5yD5jwMwFwvcmLVzzCRYS+lXPRKE7p3Njz/eDEannwYn727uH53AhoDc2ds8EjdlIqGH267qZ8xt4Nd11vC/+JhvmSFYXemB02G2zOUhXNdVuy09cYJTHNVN/XW65Bq9lElRYGf4fyi4HQ0vamLFEegbsFoDBTDEv+CByjvzEF0MkHjuDzJ0Ymup//C3wgNo4hlprF855UYy6DqOpd/Xk+Q1eVfHBBT+IqKrV6//hWdLIp/AcYV8tw= +api: eJzVWVFz2zYM/is4Pq03RXa7ruu0Jy9uN29Nlkvc7SHNAyXBFhuJVEkqic+n/74DKduyLSdO6ma3h5wtEwQ+AB9AgZkzy6eGRZfsHI2qdILsKmApmkSL0golWcSGWOZqZkBJBKWhUBpBN9IGvsNwGkKpVYLGoAkgxUQYoSQUKsXcBLRnonRhXoSf5DgTBoQBLoFbVYgEEp7nAYgQQ0BhM9TA87yln2uE1CHAlFRJB2MCNsOCFsNPkgVM45cKjf1VpTMWzd2j0JiyyOoKA5YoaVFaWiqq3IqSa9sjUEcpt5x+NkmGhftmZyWyiKn4MyaWBazUqkRtBRqvuQHWEuVa8xnbDNs4Q4iF5HoGZASsgkQjt0jQG5cKlHblawgjS8EplTEizpG2ZPwGfchtxqXLAeEG8gBuhc0gFZMJalK0WpC8QEPPzlY3Ct7C4IMoLBZtv4zVQk5ZwEgxtyxiXhOr64BZlFzaUdolvx0IL03WvVGHa5Vkq0KndJW3y2Wk2VVd+zVTKml85F/1+/SxbaibOCFb4wAvy1wknLb1Phvauz8BVkH7E2ctcSEtTlG3oyWkffO6MxyVFF8qhGucgUhRWjGZCTndIEbI6qBlrotxmxnbgbmpziFOhBQexqO37JvpuCzkoh3AaBgAN8RJgymkFe1qeRiAVVN0Re+oTP7foHbdw7UM4J9kE6smTgJdNwEOpsRETESyNJYusRKd62Dbh7+97gez9sOrTte4MWIqMV1abLCGnca+gh5LQ9c4C+A2E0kGPLGGYsmhOyCWOmsDwgFaVMIpL3C/1C12uPYBE62KxnZbN9wuE+rMPKkPjIZNC1+19hV0Uipsjsujh6hy5pd9SfgD5jF03t6zL+K0kKsj7Vn4vLDWsPjmQKRdOtFm7XZcDkHbpanH8nfDdbk3dYcnp561S1p5Rfem66D8XUJvh/Xcn2eufT+GcG39TSh1SxVMNS+JXtyux829PdALgJrc77mPbxfMA7Wtr8bvIHa2gmEjvMuD/bvBU9PT7dQDzeGX3c3BLLrDjtp4xuaw5lFXp2jHbP+jZVd9rtl7/mJdM7/TzYO2xLUAP7U/ruP2VDj0ed+NeO30v7c810qy9tF6uDRJat/8unnnWY5kkjxwxTnw7QKjH/6Ld0bn27cgkPPwG70tNqA7CfieiNa9dIKWu4n//gm2e/N5M4AyP4++3jWCpiqp3GBflbniKUy4yDEN4US5idRykfvptNTqRqSYgpCLedgZgFilMz+S7xhaS63iHIvvt4fXdTgDOPOSjV3wVUec8IKxt355/v4Yfn79409X32XWlibq9W5vb0M9SY4wFVbpUOlpT08S+iO5FyGMM9QIBZ9BjMDT1L098hxW9byqH6ucgw1soGh7/+5vBn71nvuISost4gzg4/loa6xeM+32THiVkw4eq8pGcc7lNVvl/SF6DsBURUHXKg011w3UATOW28o8tU/8Ph6fgVcBiUpxbcYjQ+REIaQoqoJFr/v9gBX8zj+96ffdSUYZ38MTCXhX5lw6am26I6S/ffLanGNCGstlcqjMKC2mYtPuem03JB56j2pffwXaTKUsYqUyjjrcZixivfaNScAMamqyLLqcs0rnLGJzXyx11OvNM2VsHc1LpW3du6FM3HAteJx7/tGyL6oFWXKV8DzzBreTRgvtt5xjXlQy5fAWzt9djOE3bvGWz/x1gdIbqt/23/Y7tZLoDo2DsxF4Dz3lWm1goZbquVOtF95HcV1fUSCTSgs7u6BtPjwxco16UFHcl1Ro7Dnt9OyFWNB8eb8gyB//jF2OhZwot73J9TYQ1jp0WT98uc2rs5Erj0QVRSVdj5RTf9zzlmNJXhlLDgUsFwlSJ4/mzYy5NPvBr0BzVQQvQ0qKZ86iNU6Fzao4TFTRS/y25Wecq7hXcCF7jQnTOx6cfDwdDo4+jI7fnV68O3oZ9kN7Z53zRN2CyxYOf9ysrjE3nZ2vjoT/xcV8wwqLd7ZX5ly4dygXznlTsZdrd5xXQVN1l2w+j7nBjzqva/r5S4V6xqLLq1WR0lMdsAx5itqV+DW9QLFjH6KjMRkn8bwiEF1X/3Ww2DRIEixtS3zrlpjKYNl1zv66GBOrm/84UExZ5Pqf0xusvhLIuv4XxhXy3A== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

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 [
    • processDefinition object
    decisionDefinition 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha.api.mdx index 5848d75d3fc..82c78c1e525 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha.api.mdx @@ -5,56 +5,162 @@ description: "Download a document from the Camunda 8 cluster." sidebar_label: "Download document (alpha)" hide_title: true hide_table_of_contents: true -api: eJztV0tz2zYQ/isYnOypTCqp0zq8aWwnVSfNeGy5Odg+gORKREICDABa1mj437sLkHpZSt1pTx17xjYfi/2+fXJ3yZ2YWZ7c8QudNRUoZ/nDgOdgMyNrJ7XiCb6aq1KLnAmWd1JsanTFXAHsXFSNygU7Y1nZWAcmulf3KkkSpR3cq0khLQOV11riKbwWiomyLgSbgnCNgYiNHcsaY1BruWBa4R/b1LU2zgtLdVJBpc1ijW2dNjC4V/NCZgXpRChWgSBa2rDa6LzJiDtrLESezL3iA14LIypAimTwkiu8Qet6teMcRSTZWwtX4LWB7400kPPEmQZ2nTJB28cXTE+9F1bcnMbr4K4IddisgErwZMndoiY064xUM962gxUBb84a/XsDZrEFPxWlfSm+V7bJYvs1he3HvB4I2dZaWbD0/u1wSP+eg690zoVdoUGOwcsysHbalOWCoDKtHIqRElHXpcwEKYl15sCdICyIit4dYjTgGNNK4HmeSiXQNS3+DPjp8PTveElXeOtn8hEUOYuYUq5MNaZs5HPiADvMobSE6qevlvRustsGHLGrIMlycEKWTKdfIXOMXOIFU/SIVOzu+sM5e3/67teHo8K52iZxPJ/PIzPNTiCXGLNIm1mMt/RLcscRQ2MwlJVYsBSYyFEMMUVJ+V2DcRIsszVkciozCjhZ2tFm5MJgX+fMQItqYHV47eofuLwxku9m3ojdXo+ZzNFtcrrAA8+h/ZmpaErSIVLduCQthfrGMXBOunIv6C6KbaoK492n+DYAKrIOG8iGGVg+DmZgNvnjo5/fPtNNafLbZHLFggqW6Rx863DUrTogMqKSSlYN5ufpcIh34inc/TIctqSTIv4CSxSDpxrN96m1aw4mR0UlG7R5w6RCXir7ryKjjZzJXdyIWlAfC94l8UWwKBTYu32FP6KGjB2U8hCMQZfpzDfvnGE3Lr16qv4em5oYWPdaa6+19lprh2oNX+JYUmj81PMZ+MyhCSThcf8ts/FyPaa09P0G89jPMY1Bx/BlKJsWs31ZaOvaZEkzVBs/UkwehZECYX0I6XUorz5tSp2J0j/eFz56QbNKb9Z65Lu+vJmwj8LBXCy8OwlyW/XZ8Gy4VyuJHtA4uhqzYGFIvo2G0Kulyt6rNgi/RLGfdSxg+5JucUPHgntSEAbMqKEQrJKiw/Pa6T4I4ZNw8aFPld+/THy0pZpqf7yL+nMiFBUMYWA+jN48zzAkS4WS6QrP+m6JWeanGrFn7Mbz2FIB5zbC7WbLXuxTeMP+DIjsTURBCZnTN8kZam7SCOHiLBxb/U9LncaVkCruIGx8Pvrj9vPF6OTT+Pzy883lCWqM3JPzxteYMJVQGzxWK8RqOjvyW8DxrtXL9Vfif7N3dCnk4MnF2Jtwym873y+7Sr9bbSEW5ZONlQRTNJTrHV8uU2Hh1pRtS4/DnkANIJeWavvAprDp0X+3NOy14xsstnaYR1E2JMWpuvq28w9pHl13u88xe9matZdZ91CoxSatnvGGj9sHlC4AtxfjiQaBEa4xtds4enB7IUtXDfzjJTWAvwAplk5Z +api: eJztV0tT40YQ/itTc4KKLJkNm2x0cwG7cWqzRYE3OQCH0ahtze48tDMtjMql/57qkWQMmA2p5BYOYFvT09/XT3VvOIpV4PkVP3WyMWAx8JuElxCkVzUqZ3nOT93aaidKJlg5SLGld4ZhBexEmMaWgr1jUjcBwafX9trmeW4dwrVdVCowsGXtlEWmAhOWXQldV4ItQWDj4eYgk87UzhJ4BsLrdiKkhBCyKNf/nwzSITXlYcrmyGTjPVjULXNWtyw0de08RgBlJwaM8+0934DOQ3Jt15WSFfGwDpkBQaY4z2rvykaSvawJkEYDri1PeC28MIDgyUkbboUBnvNR7bzkCVfko1pgxRPu4VujPJQ8R9/AY0cuKmDzU+aW0XNbbuhYObg45QkPsgIjeL7h2NaEFtAru+Jdl2wJRHPu0b814NsH8Euhw0vxo7JdFg+PKdTf53VDyKF2NkCg8zfTKX08Bd/qXIuwRYOShSYGfNlo3RKUdBbBIikRda2VFKQkcxIBJwE9CENnzzFK+NJ5I5DnvFBW+JZ3Xdcl/Hh6/He8FFbR+pW6BUvOIqaUK0vX2DKNOfEMu9q7QoP54UsgvbvsHgLO2HkvyUpAoTRzxReQyMglUbCAkinLri7en7Bfjt/+fHNQIdYhz7L1ep36pZxAqdD51PlV5peS/kjuMGWLCjwwI1pWABNlqQhTaMrvGjwqCCzUINVSSQo4WTrQZuTC3r7BmT0tqoHt5XtXf8fljVf8cebN2OeLOVMlWFTLVtnVU+h4ZykaTTpE4RrMCy3sV94lHBXqvaCPUUJjjPDtmOIPAbqEBxTY7JjBlUVYgd/lryz++OaJbkqTXxeLc9arYNKVEFsHUocbgMgIo6wyjeH58XSacCPu+l8/Tacd6aSIv8ASy+Cu1sLG1HpsjrLMUMn22qJhygYUVv5XkXFerdRj3JRa0BgLPiTxaW9RX2Bv9xX+jBoygqc8BO+dZ07G5l2ydaV0VE/VP2JTE4OAr7X2WmuvtfZcrXUJN4CVK3nOVxAzhyaQnGfjuyxkm/sxpaP3N/jbcY5pvOY53/Rl0+VZtqlcwC7f0AzVZbcUk1vhlSh0n4l03JfXmDbaSaHj433howOaVUaz7sfEi7PLBfsgENaije4kyIeq303fTfdqJdFnNM7O56y3sE++nYYwqqXK3qu2F36J4jjrBJCNV9he0rXePQUID37WUAi2STHgRe30uxfiyfDl/Zgqv/25iNFWduni9SHqT4lQVMCHnvk0PXqaYefzWCjSGdPY2C3tqp9qxJ5RnSdcKwk2xFweZstR7GN/wv7oEdlRSkHpM2dskiuFVVOk0plM9te2n4V2RWaEstkAEbKT2e+fP53OJh/nJ2efLs8mR+k0xTuMxtcuoBF2h8d27dhOZwdxFTh8bPXm/i3xv95VhrRDuMOs1kJZKoQYr83QHa62m0vgCc931pibZCjxK77ZFCLAZ6+7jh73uwU1jVIF6gfPbBe7Ufh3i8ZeO75C+2DvuRW6ISlOFTm2qn9I8+Bi2JcO2ctWs73MhofCtru0RsY7Pu5uuoRXIErwkWgvMJMSaty5+uzGQ5Zum/6HM2oafwE1iHUV sidebar_class_name: "get api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Download document (alpha)

+ Download a document from the Camunda 8 cluster. :::note -This endpoint is an alpha feature. It currently only supports an in-memory document store, +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, which is not meant for production use. ::: -## Request + -

Path Parameters

Query Parameters

+ -The document was downloaded successfully. + -
Schema
    - -string - -
- -The document with the given ID was not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx index c3396d51826..1128051da21 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx @@ -5,31 +5,31 @@ description: "Evaluates a decision." sidebar_label: "Evaluate decision" hide_title: true hide_table_of_contents: true -api: eJztWltz2jgU/isaPW1nCdA0abO80ZDu0m2TDEnb2UnyIGwBam3LK8khHob/vudIvhEbSEl3+7CkkxRbOud8564LC2rYVNPeDR1wT2ghI+LziYiEgY/0rkV9rj0lYvvYo2f3LEiY4ZowmOcI2rfRXzIhOobnSUrMjBdDxEjCMxLCBQwpMk5JokU0JcJokkTi74STbzwlvzBNFDeJirgPk26jAY8DmY64lony+IsWkSqjXBExHLTJlxmPmsda9kWAkA28R47cv43uubIT5GSVQAAkzX1Qibao4oBNm7fST2lvYR+F4j7tGZXwFvVkZHhkcIjFcSA8hkbqfNVoqQXV3oyHDD+ZNOZgOzn+yj0DfGXELyZg8vqIESbgFTPnPhllSNI/eUqXrR0Ihz5d3m2dB7wpf2BhHHCNyN+mpWnKsEB3WQ2TMGQqrbBbNea4pB4UxKBBGwAjAUcmjTNo7+Xhq6NjnKYEGzs0yyWgW4NoONgZ0NDfggdM16OI5+D49ZsTWgO1tMAU17GMtLPbYbfreFVz57oKZQ7RnmeGBbBzNMVKxlwZ4SSvMWcTlkruCR9EQ/LWEmg+E96sDjbDIADylCt4MZEqZMa9en2EYdRsxyYcw0EtDTeL1UYB0GYh5yzkzWIiGPmBgj67CtIsa1152cWcrw6rAEauCIXgL/0dBlUVMjJVLJ7BODNb0WFBjJkywHCjXaqwnhVwPxbopgCViYkTU0f6/urinPjSSxCDEz4XQUBEpA0D0HlVgYRPAvMkF9tuUrPdhImA+4Pn54ljRPwEOedisTGvk5oo/pFrzaYNqZINEPd2jBzns3S7/R2IRpFQ18Bw69RyoxXtSp7FCmNT6A2tXzz+/WEHIVOo1Gi1TeFToMwdqCvFmSnFUiAThoe6qWivovwgtA2kHI3Owo6rqjXmsH4SURZ7tl1XTPRIgf+4Kex7ws/sCSWAa0vUmGUwsrOmP71U/jsVBMwJqyp/lGSr3d2Sd2VZp5CXs0TGvUzb9eVmNVuRx/a8yNnj7EbtLJvI5w/NnAQObWG2KfgKG1/Y4HimAeseIy7odN0+bmC7hdby3BDjTysVu3D+XG4wapUBh3bhvaxv6Ip25NwyBBfQZXXiR+fqYuOHUeImVXw6jJ7v0nJPbZltbmlPzQ3LayfXW8pG/9iRnR2/he8z3L6O8yavW8fVnV6ft3ZKeSLg9rPUbW+P1u1owT/3sFIA3MwwXIVH0qBqYtOuFohg/xz+Wt/drgrok0s3E6xiYIFJXLwRpvP1Ka78I3IzendKfjs6fnP3y8yYWPc6nfl83lYT74D7wkjVlmragUf8xXkv2gTAK6x8KRlzwnzfNlAWkDLgsiMt4eExlnG6WjDokJVOtWYzbrJ2vOrASjWFFXstd/rk02hYW3ytiLY0EwY9FVNzDPWhNw5Y9I2W/qwLfSwlOyzJA3BVADCCFm6Saq6v7QZN2f/H9fUlcSyIJ31OgMbleSYIlQhh2RImIe1BdGE7fnBPr7tdu7pBjz9BE6gYDzGob0PrsToQHKFUPIuftstLt2H4QZ6RSkzFY7ntlTTNgnjgNMoT6mjLEVGWSxOZRPtc2ufSPpfW5tJxU3PqYwc1XGEccqXAZNLzEqVw2TETgWXvcV1cGmR76n2m7TNtn2nNmYZ7Zm5mEi9EYqlt6DAzg6dO3rUOyksZ3SlX8jBTc4VHIPbeK1FgIrpwCbSEuF/MgN2yt4ilMsvO/eGjWxaKwy7R8gAKpMeCmQNRdyQOVBfupyyELsrICRmdXV2T32GhO2epNSyKXGV90j3pNnLFqWs49i+HxGnowrBSGnK2mOONbN3kpzBe4h2e5lDGhEmvkMyZZ8yZ4qqfoC+K8MjkWe747CbBG/fhXR40779cW79jWRuVV55n7h5ww/lh99FVWPWcZmUfNJEWVhZXdQXR2/nRGe22X9ZjGIyAqejJEGhtPcZzadg9ElYxmBck2qChWhSKNsfdC8iN7NauEPvBjZDssI68bKOzXUTmZXgKnJNxG8R1PEdW/D8O5LgTMhF1MhG6c9r/+Ol80D/4MDw9O786OwCObfNgrFExTUIWVXAUV5O5VR9ruyj7z//rvj2LW8MfTAdKo4gweqxjFlmduaFNdYYWJxfCfWfBVYsbuliMmeafVLBc4mvQHC+Hb+7KuMUnEDLjzIfUwNJk77bpqfPAgT1QLW6H6zezeBfvKPqex2Ozce5dpXxeXlxdYypm3y0IodnAW8Xm+L0D+Nujt/APvywQm/xywb5fUGga08Te3VDHF3/+ARLR3Gg= +api: eJztWt1v2zYQ/1cIPrWYYrtd+jG/pXG6eW3TIElbDEkeaOlscZNIlR9xBMP/+3CkZEmWbKdxuz4sAYJEInmfv7sjj1pQw2aaDq/oCEKuuRQkgikX3HAp6E1AI9Ch4pl7HNKTW5ZYZkATRqJiQe9a/CUt0RmEfJoTE8NqiBhJoFhCgJsYFJnkxGouZoQbTazgXy2QfyAnT5gmCoxVAiIyya/FCLJE5uegpVUhPA2IVMXKBovxqEe+xCC6xwL3IkGRDYkcRYiuxS0oN0FOmwu4JlZD1LsWNKAKvlrQ5o2McjpcuEeuIKJDoywENJTCgDA4xLIs4SFDI/X/1mipBdVhDCnD/0yeAR1SOfkbQkMDKgV8nNLhVXuEJcmGkUzJDJThoJHiLVOcTRL/0PTQZQwkBa3ZDMhqGmGa/Hnx8ZREMrQpCNNDZlHkvMySsxpxr1uT/TKgBgQTZhx1M/SjZDxaNyjyKWhpo7iY0SUS4yaBGppK6J0XBmca6PJmXemS5miFz3eQd8tTgxWPQBg+zVvYMJJMYIVOdPkxE0IafIsYIEbOwCF2zk1M2tzHBUwK/bgwMANFAzqVKmXGv3p5eC+Nc1RlGTwiYk9EbBKnLcf+/n8H+X0zz7UoUw+5V+b5dgPl48gZaMc8dBzcsTQrkPImrySo8j4GjkthNk2ZymvkmjJP8g1moQHFBbAlbJ89//XwRdDA7RIV3SDRePRggcbRDnkQNBTlOXjx8tVr2hJq6QRToDMptLfb88GgG2grUeZM18BF9ygXPzQLzmMexm1hd+a0YL/g2862xH0Xk1OWQjcbwVL4jow++0Dt5rUpih9izl+f1wU497sMTMn6GwyqasvITLEsJiZmZqd0mHcypgyR0612qYu1F+C+r6DbACqtyaxpS9ooe575nCcJ4UIbJgwvs4oCbRNzLxd3Je2AThlPIBrtHyeeEIksUi7ZdtdSz9Uq+OArfptTMUD82wlSnMf5bvt7ITpZfuNWoKK5ZVNQQW/s/BLCt8OO60qlTqttg89KytKBupacmVIspwHlBlLdlbSbUr7n2gGplEYXsANVtwbuM7gosOfKdc1Eawr8x0XhsSb8zJpQCXDpFnVGWZ49XNOfnip/TAZJmQljiM5tsdt9WPA2tnUKaXlLFNSrsN2cbprRijR2x0VJHmd3aufIiAjuuilxHNpBbBv4Vjb+6MCxpwHbHiMedLptHz+w20IbaW7B+P1SxUMof64OGK3MgEMPod1x8FuVI++WsYGULusTP3hXrw5+iBI/qebTsdjfpdXR1RHbXtLuGxuO1oNc71Z2+seNPNjxO+ju4fZNlLd53Tmu7fT2vI1Tqo6AP89Sf7w93HSizZS85RHKzQzDXTj2SG5ZwredajMlJwmkv7RPt00GR+TMzyQRGMYT4vGG3alif4o7f0Guzt8ek98OX7y6eRIbk+lhvz+fz3tqGh5AxI1UPalmfTUN8RfnPe2RyxixmLIcOzpVa4tUgCt61jzEZpDxujph0CGNSrXhMG6Kctx0YC2bWsVbsXNEPp2PW5uvBmu3ZspsgjTYRFoznCRM/EMrf7aZrnMpmiUlAJsMlgHVhhlbj/WN1aAr+v+4vDwjngQJZQRkKpWP84IRKpFywVOb0uHhYIDl+M4/vRwM3O4GPX4PTQSBuyxhwkFrXR0uSCoVFPjp+bj0B4bv5Bmp+Iyv8+01wrQA8chrVAbU4Y4WURFLU2nFYyw9xtJjLG2MpRddxekIK6gBhTgEpaQiMgytUrjtiHniyIegV7354kz9GGmPkfYYad2RhmdmMLHEC5FMagcdZmI6pP2yah1UlzK6X+3kaUA1KGyBuMtKqxI6pAsfQMthv7+IpTbL4SKTyiz7t8/XblkoDvtAKwGUyJAlsRei7UgcqG/cj1lqRcTIa3J+cnFJfmcG5ix3hkWWTdKvB68HnVRx6gaKR2dj4jX0MKylhpIsxngnWT/5PoSXeIenIbSKm/wCl3nzTIApUEcWfbGCR8HPUcdnP4kGxT9vS9D8+eXS+R3T2nn1TcOJvwfc0j8crF2F1fs0jXPQVDqxCly1FURvl60zOug9a2P4bOxCMZRpaoXLx9iXxotXVjNYmFht0FABTXgIeHoZLqhwR7sV2/d+hBTNOvKsh872iCzT8Iyb2E56oUz7oV+2+jtJ5KSfMi76BQvdPz768Ol0dHTwfnx8cnpxcvCsN+iZO+OMimGSMlGTY3U1WVp1XdtFVX/+Xx/UFLg1cGf6WcK4QPQ4xyyKPHNFu/IMXXUuio+SfLa4oovFhGn4pJLlEl9/tYCXw1c3FW7xaRnQGFgEyqUmd7dNj70HDlxDdXU73L6ZxW8y/IqjMITMbJ17U0ufZx8vLjEUi4+HUhnhGsXm+GERm9MhxS+BMlNeLLh3C5owMbPu3oZ6mvjzL8pHPaY= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Evaluate decision

+ Evaluates a decision. @@ -37,30 +37,411 @@ You specify the decision to evaluate either by using its unique key (as returned DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used. -## Request + -

Body

required
    oneOf
    variables object
    + -The message variables as JSON document. + -
    variables object
    - -The message variables as JSON document. - -
- -The decision was evaluated. - -
Schema
    evaluatedDecisions object[]
  • Array [
    • matchedRules object[]
  • Array [
    • evaluatedOutputs object[]
  • Array [
  • ]
  • ]
    • evaluatedInputs object[]
  • Array [
  • ]
  • ]
- -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 decision is not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx index 31df6c76e49..76b2410080c 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx @@ -5,59 +5,265 @@ description: "Mark the job as failed" sidebar_label: "Fail job" hide_title: true hide_table_of_contents: true -api: eJztWEtX3DYU/is62hROh/EkJSmZ3YRACw2PA0O7ICxkWx4LbMmVZAYfH//33ivZnieERZeTBGLrcZ/fdyXfmlo2M3R8T89VSB8GNOYm0qKwQkk6phdMPxGbcvKoQsIMSZjIePxD0gEtmGY5t1zj7ppKeIENsO4vXsG0wO0Fsyk8a/5vKTSP6djqkq/rmIL4J14RlfSarHKahrDXRCnPGR3X1FYFahDS8hnXMJUonTPrhz4f0qZ58Kq4sV9VXOGeheaEZQZURwq2S4tzrCgyETG0Ing0aEq9qU2Fjzyy6K5WBddWcOPlWt0+bjrDclVKi/60y3q/TKrKLCYpe+Yk44l1gXzTr98+UoxXwsoMRkbNgHKtlb7gxrAZ39Q/kUS5Z5aR3C8ifkUo5IzM06o3xudySKapMAT+QUKtiMqM6awipeFJmRGREOYW61IaosoVr5iM4YcIGYkYYooyNBOGxwOEikWxnQkRrEt5VhD+UmRMSGfI8t456zYPl4NiQJOcwbsss4yFGfcQagYuA9VXFj1dJcn2NIQwqRIAlcg5Wr4HanOzTyC8LgaSv1jnSzX8eR4AX2t5eGZaoEUOBCyOhY/69RJOtqH9/PbqknhUgRUMPBcZxFkay6QVzHJnWy+cMOsGMhVBRk0EwpeI8gvMG6Mi3BcTy8zTiis9eNeiB9ZbYfEVWX8KOLjxtAEONS62plDSeNc+jg63xxdhIbqSMKSw73A02r4UyPMMeY5JzCzDTVJZ8DETbbZfYSVsA6PzXzfZuQZ6cu1XAtQtmNPFFzDVYh9UQ/bvb06PyZfDT78/7KXWFmYcBPP5fKiT6IBD/pQeKj0L4BV/cN0+soNrTnJWkRCY3aeZLOoBMQWPRCIiLFvWe+uMwSxsz8dqMfGz9Qbme/yVWtB1HE3I3c0ZceQRSYXc3lC9jFjKQuDAOMyYfKKL/G8qXddiyjxnuq/OqwpAEODWluan9bmtY+vA+HM6vSZeBIlUzFtyYjXyitCJXEiRlzkdA77gjb34t88jpKHP+Ds8kb72SAetdXewNCjNW/w4xzwlo/8rM0qLmVjXC4qWuNiC+Jv3yFPx8C32zYVNnbiZeOaS+LO3o1cCh9COXjt67ej1Jr2+vJteT55boAXH5lqBaowt3G5KrcGcrBqSi4WbcDbrpaOv3dedrSSEK+qOnjt67uj5Oj0/bbtQTvCzAb47EYfuY4ioyDEwhq8KuIui+Ai+Ozrd7Sfhjms7ru249hrXYDLnNlUxdm2UcdDB5s2YBnAUmqD2l8smwM+9UnPszHD93HV/Sg2BobWnTQNor1MQ0ozrQmnbBM+Yk5UPZpz29Opg475wU696M304gS2mzq1jlsP1lpEjcnNyOyV/wDE8Z5ULJ6pcFX00OhptlYpLX5E4uT4j3kMPvqWC0IlFZm8V6xe/R7DrWRkO5UvY6ha3+fCEHO4OelJiBnpQtPqcdHz3i2DEP5x2UDn/Z+qyjcXsZtEPO3lheeGp2LevRuv9pAXyVhsso9X8NQ62iXLWtaDa9BOTDgjxgRkNP2wCGGKBPIxUDntdMcYmFd672FLcoqw0FuM1oFCxOdyeUG/bceyWffcz5G+vkXwYYs49MLsaPAPJZTgEdUHkt/X/h5kKg5wJGbQqTHA8ubi7/DY5+H52fHJ5e3IAEof2xbrYIkdyJpfswDYKXhvXnawXZ85b7dQ2x5a/2MC1yBB1zvq6ZeI9NlcNLB33TdaOjAAiT6h7WtchM/xOZ02Dw5B9XcH4wyJ/jrCxMPi8aIy+avPeTdtD3Sdvd2q3etAOMlm5CpCV+AaPIGbRLW4eYGXKWQxoRuP85LE34WCKIhabN9q2zaDbMYkiXthX1q4c8Ui7vt5dX91OkUVtzziH0wFGNZsjC+D3mP6Av/DiO6u+AYzjNYUqPys9cbxc/PMfr+YI7Q== +api: eJztWEtz2zYQ/is7uDSZ0pKSOmmim+MkbdI8PLbTHlwfluRShA0CDABa5mj43zsLkHrbyaFHeUZjEsS+v29J7EJ4nDkxvRIfTSquE5GTy6ysvTRaTMVntLfgS4IbkwI6KFAqyv/VIhE1WqzIk2XphdBYkZiKG5P+Ra1IhGTxGn0pEmHpeyMt5WLqbUPbNi5LgltqwRRLS94ESyORCJeVVKGYLoRva7YgtacZWZGIwtgKfVx6eSy67jqaIuffmLxlmZXlApWjRGRGe9Ken2FdK5khezG+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+XvDdlWTK+uV/ULhM2l4+vVYPRBn5+c9zPUp/D4pHZvBP0i6jZ0ANXwnUjELbWraXF33SWiJMzJBufiw9PowtElq1gJ74xtu2SQOMkyqv0Dezde8Uy7Zb87+3pxySzqZ8aVyVnW4pxZgPPocJyqxuEvry2EQj1rImmiTv77D582B/E= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx index ef8aa6c543d..dc57507cd72 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx @@ -5,62 +5,388 @@ description: "Search for users based on given criteria." sidebar_label: "Query users (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWU1z2zYQ/SsY9JJMrY+kTprqpjh26zZNXEtOD7IOIAlKSECABUDLqob/vbsA9UkqkTvtjc44FoHFLvDwHpZarKhjM0sHE3pnuaHTM5pwGxuRO6EVHdARZyaek1QbUoCBJRGzPCFakZl44IqAqeNGsO69uleDwUBpx+/VeC4s4SrJtVCOwGemCJP5nJGUM1cYDg0JAVswYpEMDi9YVqiEkVgW1mEoXTiiU+LmnET6ESKMOPdPk7XpG3J7ORqT4c010Q/cPAi+mD7rsVzYjtNa2l4cDDvQ1DHculpDZz2umyXf/VVws8Su5/cKV5wWBsIZknDHhLRdv8J7Rc+ozrlhCNF1AiClQiVDKRFBC52GgyPr3upkSQcrGmvluHL4keW5FLEf2PtsEeAVtfGcZ8z3Svkxha1YUbfMOfjV0WceO/CYGwzoBLd+hDbeW2XFjGFLMIKNyOxT/KSCy2THkXVGqBktYXkmATLUepAcKSukw6g2pmUZFisMT5BCwSFwyAkn+YY9fyCsI5j0bQCGllMcmbMZf9J0jc525gTM4jOY5RmFrcqYC00/vMT5S5EJd6Kt9XMcpm5vxTVQ9+dWbga+5eCSP2Vk2YjPDaCxxeesIV7DoOMD6nstqwWeCjfKXbGMNxLkaAdQWciGnp35o0yu/HT2+bDb37TGfbY5U3DfYHOtbJjyy34f/+yfYB9/g6WdrMFDTE5F66lkdtoxeX1AkWaavj5HYFNhrEMRfWKy4PZpVJXs3479GlkD8k9h686IfTgO439jXrXhyYkofuHLEy3/V/pvkWgm/m4/GJw38fotS0iVaY4THGCC9Jp9Xyf6vrMhuQmWVa4jAWjCLAmGEeRoocjk9uqC/HT+6sfps7lzuR30eovFomvSuMMT4bTpajPrwSP+ot3zLhlDCuUkY0sSQd5PwAxiMkm2W0hszmORipg47RN8NW2CKHZ9wv2GmnxvPV1ttrUwgh6+2gzJ3e01EQnAJtIlDKiH3s94EbyQDCLJ1Be63bWmHLkfxRZZxsxy/SqzHwDziINXom8fA5CtDn0DsuSX8fiGBBck1gn3r2oO37+qQLiITCiRFZA9gUnwxB7D0+t+v0SfrpG0tZUowh9zWL6n1uFygBwZJMKKP35hQsG8VPxf7Yw2YiYO43b3tFWR+F1Y0Vo8L+p8v1OscHPw+DfkklY9rXpa9RxTzw91vl9pE4kEArTSaaXTSueodM7rfP+gHQBVqDbrtNJppXNMOq+avvBcA8QGSQhfkx64IdwYbVoZtTJqZdQoI+jMOHzJwQp1rn2VIGduDk89X8rvhQImxUomCsr6slVhAA+6CmopgeSrOYwtB6tcG1f2HnArHpgRWLb3O4fdQVVrtkgdMzkPEeu7hh1YP1mv5qCW/zNzfMGWHsW8KnRvXb/pv+k3ekXTIx7xdiCsMHBu5xxYu0VBN7oNxqc4LrGoZXkMm+qWIxwW4IkAZG6GBQK/4UIVz3vH52AELeHD1Zohv/459puMZ9jt9lbh8pFleVDgtq67LVhtqXb4XJWndgpW4S5hsrkM2NpWdwCh0D/dlutDGb6/KbL3D0rok1VAYrc4jm2ll0WqPQwVaeuAIruAimEH+t0XdYEA6KjzWGcw1h/2IJKFcHPCdjaoukTCEwAyAsdaGsSt8FibvQ895FOISF50kVxBAeszfgaei6gL4dZ3R5u/kdRRDxBVvSqE7V0Mf7/78G7YeX99cflhdNkBj133GCqiqMGMqZ15+Kpoda/2zN+PPT9c7871UXsX13wXV2nK8UfXgzNaKF++NTKU5VF3Ey8OS9e0xCuqcGxN6GqFKN4ZWZbY7MNC+3R7yuETeJxzlgR+hyoyvQgb0xljfDSXhS9dH94vlGfrEcM45rn7qu1059C++Tga45lQ3SNmkOKg1bAF3jHC/wN6D//8bSR68MeNb19RSFWzwguWBr/48w/0TFIP +api: eJztWdty2zYQ/RUM+mJPKVFOnDTlm+LYrds0cW05fZD1AJFLESkIMMDStqrhv3cWoKwL5cTupG/yjC8k9gIszgHkswuOYuZ4MubXDiyfRDwDl1pZoTSaJ/wKhE0LlhvLagfWsalwkDGj2UzegmaplQhWiv6NvtFJkmiDcKNHhXQMdFYZqZFJx4RmY6GqQrAcBNYWJgdxasrKaNDoYhBWzXsiTcG52NuFn73W2vXL7JAJnTFtkIEWUxUmcSLKWmeCpap2SNMzNTKTMyyATc19/0ZfAfin8dL0Dbs8vRqx4cU5M7dgbyXcTQ5iUUnXQ2OUi9Ng2BOV7Flw2HnRW/r1y+yHLzXYOQ0d3miqUl5bLMCyDFBI5fq+KjeaR9xUYAWV9TzjCc+lzoZKUdUdj7iFLzU4fGuyOU8WPDUaQSP9KapKydQ7xp8dbcqCu7SAUvhRpT7mPBkvOM4r4Ak308+QIo94ZSkhSnDew1gfrbUS1oo5j7hEKN1z4uQSVLYWyKGVesabiBubge2OEKByUSukrC7lTRMWKy1kBLsQcBJxlKjgAXF/UlmvjMXLUBjeTMizEjN41nStKdfmJDXCDCyPeG5sKTC8evmC5q9kKfGJts7PcZjjxoo7Rd2cW/Pg+BZyY+E5ns3O+lyIGazqE+3It8PpcYfuXqt2gU8tNx0RWpSwEyCPDkAppNoxsjZ/osmZn84mHtbHd61xE21oa/AvXGW0C1N+MRjQr81T7+PvPHo6B7dr8tRqPRfMaFCo8y2I7Ibp62MqbC6tQyLRJ6FqcM+DqhL/1fdrYA2Vfw5a1zw2y7Gd/xvz6rhnT6zi3zB/ouX/Cv9VJXYDf328ifjxLly/FRlrb5rHAV5ZM1VQ/tgF+mawIbsIlu1dx0KhmXAsGE4hY1Kz8eXZCfv5+NVPk4MCsXJJHN/d3fVtnvYgk2hs39hZbPOUvsnusM9GBVhgpZizKTCRZZJyCsVWW8hcBanMZcrQ+Au+nTajKvb9hfsNNvnR7nX1sK21lXz749CQXV+eM5mBRpnPpZ51U2/eeFNTYzJVQv/NV7u2647czOLqshR2vvwos5mA7hEUWH/7GHj5ohN7VAD7dTS6YCEES00G/uMd0me2NhEtopRalnXJk+PBIOKluA9PrweDhmLiTtB2VqIZ3FdKaA+t7eVIzUpjocWPX5jUDoVOv9fOGCtncjtvf4NbLYjfhRUtyXPUxfu1FjUWxsp/INuzZ8+ePXseZc/LLt7PjJ3KLAO9p86eOnvqPEqd4y7ePxhkuan1/tbZU2dPnceo82rXPzznGulfMsUc2FuwDKw1dk+jPY32NNpJoybiJWBhSKGujFcJKoEFT3js5f84CJiclEwilPOyVW0VT/gisKVJ4nhRGIdNsqiMxSa+pa24FVaSbO93joYDq5ZoUSYVqggZu7tGA6SfLFezpeX/IhDuxNxXsWqF7lXoN4M3g51RyfSRiNQdCCsMmFs7B5ZhidA7wwbjpwRuSNRykNZW4vyK3EJ5piAs2GFNhX/AQpvPR6fnYMSj9o+zJUJ++2vkN5nOsMtVV+H0XpRVYOBK110JViuobT+38tSaYBV6CeOHZsDKtu0BBKF/spLrgww/eBDZB1sS+ngRKrEujtO7xtMiN74MLWi7BSV0gXVhBwb9oy5BLs49z1NTlrX2h72esTuJBRNrG9Q2kegEUDIF0tKSxbIeS7P3YYR9ChnZUZ/AFRiwPONnEot62k9NuewdPfyeKjONSyF13KZw8cnwj+sP74a99+cnpx+uTntH/UEf74MiShwshV6bh1dF217cgW+SHW6vd619tO/ffb/+XctDhHuMKyWk9pKvVUHKJ66OPaEcX0KZ2lrhqBvzxYIqf21V09Brn5Yn48nqZKSnJuIFiCxwIijP/CRsZm9E+clc1V7u3u5JNNHSY5imUOFXbSdrB/3Fx6sRnSNt77E0GflYcUd9SXHHE+67l+Ttjyf/bsGV0LPaE5yHmPT1L/KRd88= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query users (alpha)

+ - + Search for users based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

required
    sort object[]
  • Array [
  • ]
    • page object
    filter object
+ -OK + -
Schema
    page object
    items object[]
  • Array [
  • ]
- -Bad request - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Unauthorized - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Internal server error - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx index 0bd48cbb727..2ec96af97d0 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx @@ -5,44 +5,143 @@ 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: eJy1Vk1v2zgQ/SsETy3gWm57CXLzOmngRdsNknQXaOADJY9ltpSoJSmnruD/vjMkZSm2mjhAFzBg8eu9Gc6bGTbcidzy83s+U7V1YPhixJdgMyMrJ3XJz/lfqROytMytgWW1MVA65nSllc63TK/CfDjsv3Ph4EFsmbSsEsbhljEfcQO20qUF5Gr4u8mE/v4PnkyXDk8SvKgqJTNB8Mk3SxwNt9kaCnFMfoeArYlEJjpqA//WYB2Bu20FuFmn3yBzOK6MrsA4GbxKjf4Oxh6DT5mSlgxkcQvaLxwTBlrLcQLdiN71mIQxYovDslZKpAqnnKlhxKWDYoDo2uiNxCkmy5U2hXed4U9EYlbqJTzvCO2aL4cvqS4lXgd79SDRZEKORr/22Gx+wZDZxydQ9tgkRiZHhY14MC5MvX/HdyO+1tYNE9JKKQrwuAZEhrT5MIF1BtcIrtLmF3C0cgLUU7ZSzCRBPhnqbhcrRClyWDLPGjRJozJE/Yi7DfqLg7ynZPvovCju+/PPBB+D3Ep2f+TEuzOaRHyIfeFHKYTkvxErx2hjm/XRCYqaYLncQDnIG8M/4lDWBZU0BWIZ7VBKP/hPWYrMIQRfkOpAKLd+zp62GIXdrVEnWRCOUDDrsvteol3IjwYgAt0Hv27BOM1usETIUK+OYxAvI+4ZUH8P9g+/d4468dMxVW/lz4EYEDZanSJ2r1DJsl93TwnyYbF6lDAzXZe/SMyOu5c5VCJtham6ZCIz2trfYE2bgkjwAbWgzbA92EhWMq8NZmrvBFv5I7HIDdbsl9gSe9jfTwU8RrrV3VeAFNhVODikvQOSnhzuYku7iY0ORbGj9QLcWmPK8xx8URCUEzxpOyBOWTAb39ruG14bhatN6KS78yRpqETvzhsqrbtkQ45uhJFkgy8rXW1fiVrRfSidCeWnDx8bjyp+9HgmirpcCnbGbi5v7zrXH9X5FvpscjYZRPWFfxhxej1nwUMP2n8jtLBr56pB2LD5FODdbkEXidVEuu0tHYvPBkCVm2kdClGMZuTz6DQOm3AmfHxolfXnP3c+takX+OMx1MeG8F5d4ZPx2yNvyFiSdaYLPOv1jt2ROglW3Q6vJ3hMCiAZ0ZNBFH3aj2GFRWGzt2MKSlAOuWZRNjki1+kY6ZIsHNv/p0qnSYGvwSRS2GQ2/fTl88X0zcf57PLz7eUbRBy7H847X6FgsMf27LgC170VOxk/crjp3oq/6e0ZY+fgh0sqhYCkJu90E5Pqnu+tWbSPnnveNKmw8MWo3Y6mscWaLc4vujyiUehX1NAoC7/DlmKWZVA5n3Cq9m+HwzcviW6f31eXpJb/AA/VJdQ= +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 +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get cluster topology

+ - + Obtains the current topology of the cluster the gateway is part of. -## Request + -
+ -Obtains the current topology of the cluster the gateway is part of. - -
Schema
    brokers object[]nullable
    - -A list of brokers that are part of this cluster. - -
  • Array [
    • partitions object[]
    - -A list of partitions managed or replicated on this broker. - -
  • Array [
  • ]
  • ]
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha.api.mdx index 0991f335d07..36732439332 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha.api.mdx @@ -5,61 +5,196 @@ description: "Returns decision definition as XML." sidebar_label: "Get decision definition XML (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isY9mJPLVJJndTlTWM7blo747HltjO2DyC5FJGQAAOAeoyG/z27ACnJktzmkOlJB43wWOzz2yUWy8DyiQnix+ACUmGEkiyDXEhhcRg8nwQZmFSL2k3j4A5so6VBmh1ixg375+Y6fJJPMo5jqSw8yXEhDAOZ1UpIy3DMka6sC85y4MgKcCFjSItEPCkhY8jonFeNzDhLy8ZY0IapxjKVM1sAS9QcJdwDuNljT3rG7i7vx2x0+5GpKeipgNnzUcRrYQZWqdJEqScc4NJAg7E7C4P+XFhlP31tQC9o6/hJ5kqzvNEoTqO1lovShM7CJxmcBDXXvALSEn24DCRO0E29ey5W3vkTFkgtyIc1twWONXxthIYsiK1uYNvRY7SOGyMmEn3yBRa9/Xscf8JmhUgLxlNrKAicNVKgBUxkIK3IBSpORliKRX8+RA1MWkDFg3gZ2EVNamOMYAIat5C+4tYvvT8N2vaZFDa1kgYMnXg7HNLfrtIIgX/RlSBgmjQFY/KmLBdMO0BBFjpvpgo1kNapBHMbzauSxjuKGquFnKBabXsSnL6mygrR6zCwK7BOxRzjiFLZjdLQh5VxHNdaTdFxGRPSGdFbjcjLFjta8rouRcqJdYQnEcHVz58NabCp9UvVRuzWU3ZymUo+Q2opdJ4w8dIf7z6cs99O3/36fFRYW5s4imazWajzdACZsEqHSk8inNKP6I5DhmajDRVfsATxk2XOaF6SVTVoKwDdX6NbcpEyq5yBndqMXOvt65zs1SKMrw6vQ7Adig3INFoE23AesYe7jz0gF3hgV7Q7k/OmJB48wZyPk5LLLwGG2Apb7hW6LcU0VcX1KlteCkBGxmLVMf8J+V/e7vAmQP0+Ht8yz4KlKoN1WnWCyIgKoVY1VRAjLnHG5372fjhsiSdF/DsskQzmNZrvoLVtDoKjWuPWGSYk6iXTHxUZpcVEbMtFQetYBB2IL7xFfSqe7k/FVSmYCVs4nhMxBekq2wyBT1+AXGFBPmTkISMPGfnjMvLdvo8j2kJe1oRD0BpdptK00XgZoatE6djTJ7qXTVcVvCIdcu2Qa4dcey3XcBMbgULhhT6YgEMOXfTjIOo/foP1PdhEy709QuuuvBgp7EX6nqLR6LJg6ROqxTxYFsrYNl7WSts2mlK0plwL6p9ccGnbJ14PqFKlvHTL+wJLG9S49AZvNVVX3MKML5yjSeRL1mfDs+FerkT6Ckdq07yFHpYbpaJnSzm/l60n/h7GrmkxgIVN2MU9HfPuSQBvFXrUUHBWcOnkOe4090S44gcfehD98ffY4UBgX+iOd3jYVYSigiH0mg/DN7vYQ2UphVJV4VlXRxF/7oLENwzrumBKLiy2gBcfkts1mj3Ztd9hf3mJ7E1IQfHI6cvnBDk3SYji+uZ39Z+UKokqLmTUiTDR+ejm4dPFaHD98fzy0/3lADmGdm6d8TUCpuJyQw9qq/a1e9RqHbmG/3jb/uX6S3J4Vth+VuhQ6ZpgLIRCUp64cC67svIY7CsreDR+7fGBKgtmhK8Oj8FymXADD7psW1p2uuH687qYuOqTCeM8GMQ5L832O8VmEI/uuheNY/Z/vF7sdVG3yOXCFcWyoRkOUYdXn2XaZzxYAM8w38liTztKU6jtBpfVgwSVlVWlv7qkevANA/ewdw== +api: eJztWEtz2zYQ/is76MWeUqScOmnKm8Z2Urd2xmPLbWZkHUBwKSIBAQYPyRoN/3sHICkpktzm4OlJB4kEuNjntwssVsTSmSHphFwi44YrCTkWXHLLlSTTiORomOZ1GKbkHq3T0kC+TwzUwOfbm/hJPsk0TaWy+CTHJTeAMq8Vlxa4ASphQkVdUiiQWqdxepIwVdVKorQmQarFckAZQ2OSQNf+DzpqE1f5KVCZg1QWUNJMYA5KwgWtnMwpMOGMRW1AOQuqAFsiZOo5fpIPiGE06Unfw/3VwxhGd9eg5qjnHBfTk4TW3AysUsIkrCUc0JoPNBq7NzHo18VV/tM3h3rpP50+yUJpKJy2JWrI0VIuTBy88iRJRGqqaYVeS5JOVkTSCklKepderj36Jy5JRLj3e01tSSKi8ZvjGnOSWu1wNzjjEoEaw2cSc/iKy97+A8GKYFFyVgJl1vjAUXCSf3MIPEdpecFRgzfC+vj162MSEcNKrChJV8Qua682lxZnqElECqUratupd+ekaaZeYVMradD4FW+GQ//YV/rz7c2/6OphY1yAROGEWIIOIMQ8Dt5kSlqUNqiEzzZ5roR/31PUWM3ljDRN00Tk/CVV1lmwCQN8RBtULCgXmMdwqzT2YQWqEWqt5jzHHLgMRvRWQ6by5Z6WtK4FZ9SzTmqtMoHVz1+M12Bb6+9VG8FdS9nJBZV9QWZ96FrCrJU+uf9wAb+dv/11elJaW5s0SRaLRawLNsCcW6VjpWeJLpj/ebrTGMYlaoSKLiFDoHkejKbCW1WjthwNmBoZLzgDq4KBndrgXdva1zm5VctjfL14E4LdUGxBxmlOduE8gsf76x6QSy5n+6LDmoI64XnQTDmbZoLKr6SJiOVWHBS6K8W4qqJ6nS3fC2giYiy1zvwn5H95s8fbA+r38fgOWhbAVI6btOoEeSMqLnnlKpKeD4cRqehzO3o3HDaep4/4D1giAZ9rQWWA1q45XEK1wW0wjEtjqWSvFRml+Yzvyo1Js4kF6UB82VrUp+L54VRcl4IFt2XgOeNzlKGyLagJO0ChnDxm5DEjjxn5ihn59tDmOJLgvaw9DlFrpUEx5rTG3B8lRGDvt+hetj+qoLHHXDvm2jHXXsq1JiIV2lLlJCUzDMjxB/2UJP3mN9icg02yOtgjNOHIGxGDet73FE4LkpJVm1BNmiSrUhnbpKtaadskcx+tOdXc908huP5zm3g9oIRiVITpQ4H1H3zj0hu801R9pBYXdBkc7UV+z/r98P3wIFdP+gJH36a1Fraw3CoVPVuf8wfZtsQ/wjg0LQaZ09wuH/yy1j0ZUo165Hxw1nDp5AXuftwSkah7+dCD6I+/xwEHXBYqLO/wsK+Ijwpq02o+jM/2sXd3HVKIqapyMtRROWsPSHTLsK4L9sklOENpAsq7RrMnu2m/wF+tRDiLfVBa5PTlc8Zt6bKYqapvftfPTKgsqSiXSSfCJBej28dPl6PBzfXF1aeHq8FZPIztsw3G18rYisotPXxbdajd863WSej6T3ftX212kuNVxGtcRXRIDo1zLSiXPrcCBFZdKZqQQ6WIRCR96cLCV6Np1FWUCVmtMmrwUYum8dNBN5JOppsCFCpWzk3wIEkLKszu3cZ24E/uu1uQU/g/bjwOuqibpHIZCqlwfkQi8hWXL17lNNMmIiXSHHWwuKUdMYa13eKyvsTwpWi9O3y88jXkH8yc1zM= sidebar_class_name: "get api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision definition XML (alpha)

+ Returns decision definition as XML. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx index ab9841f58ba..e2812193920 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx @@ -5,56 +5,285 @@ description: "Returns incident as JSON." sidebar_label: "Get incident by key (alpha)" hide_title: true hide_table_of_contents: true -api: eJztGdly2zbwVzDsiz21JCdN0lRvrEQ7TGxKo8PJ1PZoIBKUkJIEA4CSNRr9e3cBUtblWE3TNz94RC4We19cLx1NJ8pp3jp+FvKIZdq5P3MipkLJc81F5jSdHtOFzBThJQahinzsd4L6XdZsNjOh2V02mHJFWBblggMCPNOM0CSfUhIzCtcZACICuIBExwmLiMhIi6ZFFlESJoXSTCoiCk1ETPSUkbF4APp9xszbbYX6nvS8/oC4XZ+IGZMzzub3Jw2ac1XTQiSqEVrEGoBqkim9B6hV9+pp9Mu3gskFHp3eZbGQJC4ksJMkYpryRFkN7zLnzMmppClDKcFYSyeDFzBNZZJPbAE4HK2VUz2FZ8m+FVyyyGlqWbBdkw5AJ6oUn2Rgib/ZotK6ondG5lMeTgkNtUJzU1JkHIQl5pTHHGREeTWavbpUB7YqnLKUOs2loxe5lVCzCZNwBPgp1Rb07o2zWt2jlCoXmWIKb7w+P8effUnXjgdmqghDplRcJMmCSBMZLKobE4UCeEEAAQ2a5wkPKdJofFVIaLkvmhh/ZaFG20qRM6m5FQPMcYz8z5n0B024MuKgim0W84wj9U8/LlFJCwKqImbcDYKKkFMNompxjAh+tCGB0pJnk4P8xnmarZny6FhGfqY0zUL2EzTlJamj9GRSCjkw3J7TrqpPxNwhiEzmXIODrXGBhWKmfMxoUjCF2cCyIsXaNgz6Xa/lX/heG6DD4FPQ+RzAk98ZXbvdrh9cjrxer9MD0MfOn6OgM+p5g57v9QHQ6gRtf+B3gjWK92XQc1uD0Y17NfTW0JZ7deW1R96Vd+0FgzV4GHxwg7Y5QcjIu4FTgF97/b576Y36/l9A40vL89pGuJJMG8TtbzJ9BCBbd0ugi07vGoQejC46w6Dt3FeGvQZ/0MkRtvWMSVOLXuaNxRgzZQqTNTrPSCqgltvyaDwYJ2IeiIgdG6CID30gYsdE55r4fw/PDb7/JkBDyUwVG/D0CDu2gRBG4LpgVtfrm0JGgFXTSBAYgCz6CMp9XZLeEvHoBIBw9W88DDv/sucOTKRBI+1c3ZjHrgcxHlyayPkqxk+Zed+qgGxrLY8Je+BKq7NNkxrx9nrUbiM6c7RkrIt986gQwg5LYinS/Zoz43QrwpQZOw77XpGE0QiYHPY8tDKaaRvW+zLYU4zhnc6NCm6rsEJiXCdso4j5mqVwgEdvnu26l+DVGPIN+iy5fkw/0E2asjsDtAhzE+WoOjoMUNHiu30ZbsIglv6635+3ZXFJ12KWfInt29hTqxphuN/2Llrkjzdvf78/mWqdq2ajMZ/P6zIOayziWsi6kJMGvOIf4p3WCegJOqR0QcbQvaPI9DqakMeJgKichdCtQ+slo7ARBo1s9fv+OKGf6C7rKCwk3wszlwx7fjUpLEyM7LI2d2JaJEiDjmF0bY4Tmv3tPLr7uWB2YZpKUyrX4982g7I6FOrZmvfb64OJ8mEw6BJLgoQY/ut5p2SESqQwYaRYJSAQ4Y0+2Ld35+crpIkeP0KTDNI/B/VNaO2qc6BtVIn4kzwjJJ/wXb71rdQrg7htNapy780zuVdWMEYmfMbs7DaHwMcPmVjAd8VLRr5k5EtG/ryMfHuoG4IuaGWJcWgHURGGhZQ4YUyhL1ZzQMUbv73hS/8l115y7SXXnso1OEyZngoYcJ0JM5FjJnCnUTU/1Vhu7LdWuF1iclZtwAoJlnGWNm9WEO7LqVB61VzmQupVY4ZOmVHJcdtnfIjHNr+quElESBMDPuQ/PMA1W6XXzgrwEr4w5nRhtxjAcpv0+/P354c/HgD1CYq4VLQa2ujbqAgVWUztg2Qt8jGEzd5NMahfXC/6eM2aZ8xgeJBusfUVVPIz1PHdIgHEPlxUsfLx88C4m2exMNdLt+8Lgl4BF1rJz+uv9kMMhMVMCUUKd025hDArPzQf6ZU7W8whqKkM5hvkW65FK7Qre0JuLEfyqo5OsZFTVckJUC7GdWBXrWrXv+NEjBsp5VmjZKEaLfd6GLTd2pXf8oK+VwOKdf2gjfI5BExKsw058MtpPcqNF2Z8OzFr6dNdvZePjeJl4b3RVzR70A2obTzDnDCuW5aV4na9/laA39zchUOI23S/dZbLMVVsKJPVCsFGAIDfP1YHU04iroyZnGZME7W7MN/0zkmvXK2fkv9tjX5Q+RJIs4UpbUmBb/BoFtZb/wpY4SJlymgEuYrKWQw3DFmuN+7ubcmxNKyL8qWHOf0PfXvSwA== +api: eJztWV9z4rYW/yoa9SWZGsy2abvXb77gpN5NDANO2mmSYWT7GLRrS15JhjAM3/2OJJsQYBu6d/uWhwQsHZ2/v3OOfFhjRWYSe/c4ZCnNgCn86OAMZCpopShn2MNjULVgEtGGAhGJPkyGUfeBeZ7HuIIHFs+pRMCyilOmEJWIMHRPimpOUA5E1QIez9yUlxVnwJR0gYhi1SFpClK6hs7+7zTUsltm54iwDDGuEDCSFJAhzlCflDXLCEqLWioQEvFaIZ4jNQeU8KfuA5sAmKf7lvQ9GgeTGPmjEPEFiAWF5eOZSyoqO4rzQrqpJeyQinYESHWw0GnPdcvshy81iJXeOn9gORcor4Wag0AZKEILab3ywLCDKyJICVpL7N2vMSMlYA+3bvwIK+xgqj1cETXHDhbwpaYCMuwpUcN+GOI5ICIlnTHI0GdYtVa3/By0nNN0jkiqpA4RQTWjX2pAZpfmFATS+iodqvZQFztYpnMoCfbWWK0qq6GCGQjs4JyLkii79OsF3mwetZay4kyC1Cd+6vX0x6GmW7BQiWRt4pzXRbFCwqAJsq5xUcqZ0qDz1phUVUFTonm4n6RmtD5UjSefIFXat4JXIBS1anyG1Sn6v+bSb3ThxqijTRxAThnV3D9+u0YNL5RtmZlwEyl5SomCDCl+igphtqOBVIKy2VF5SVWyrVCanSooZFIRlsJ3sJQ2rE6yE4TgIjbSXrOurWnInEGaGC2pmiNinQsZkmDKx4IUNUidDcDqUtfD22gyCvrhZRgMsINvo4/R8I8IOzgcTm/80SiMrqbBeDwcYwd/GP53Gg2n4yAeh8EEO7g/jAZhHA6jLUnwZzz2+/H0zr++Dbarff/6OhhMg+vgJoji7fJt9LsfDcyOXpkGd0EUYwffBJOJfxVMJ+FfwTT4sx8EA6Ncw2YQ9MPJrtDnBS3Wf6HQ5XB8M42G8fRyeBsN8GPr2BuQksxO8G1gXFpa8iZvLEUC0hQm63TKUMkFNOXRRDAv+DLiGZwKUE2PGM/gFHRumf//8NyR+08AmgowVSym5Ql+HBAFGoHbgtke7+4qmREFHaUZbhwsFVEncJ6ohvULFU9OAL8fh3eBhl14NfZjg7RxMBle35mvoyAahNGVQc4nnnzNzYde/cQTW2tpjuCJSiWdXZca9Q561H4jcrASACPdN0+CkO6wKBe8PKw5C0peIEyaa8fx2EtUAMkomx2PvAJGmLKwPtTB7moM73VubeBLEzaaGVUF7BSxUEGJNxu9dfFq170ChXJCC8i66OY5/SQiwpTdBc0g07mp9Wg7Okp4tvrbvlwJnhRQ/njYn1/q4qORpWzkItu3dU9ta4SRfj++7KP/XPzy2+PZXKlKeq67XC67Ik87kFHFRZeLmSvyVP9puvMuiucgAJVkhRJAJMtMryMFer4RIFlBSnOa2igZg40y2snWvr+/TqivdJctCmtBD2Dmo9tx2N4UVgYj+6LNmZzUheZBEl4rLykI+4yfw/0amH0k67IkYnv9eymgqQ61fLXm/fzT0UT5PY5HyLJAqYb/9r7TCNJGlJTRUleJi17PwSV5sk+/9nobzVNH/ARLGIKnqiDMQGvfnCNto03E7xQZLuiM7svtvki9BsQDa1Gbexev5F5TwQDN6ALs3W1JpHmRyXnN3jLyLSPfMvI7ZuQvx7qhz5D2stA4tBdRnqa1EPqGMafF9t2jla3fvUGqt1x7y7W3XPtarm0cXIKa8wx7eAYGOeYGjt22+Ul3vTPf2ujpEohFOwGrRYE9vLZ5s/Fcdz3nUm28dcWF2rgLHZQFEVRP+0wM9bbNrxY3BU9JYZaPxU9v6DFba9feCPCKKFiSlZ1icLHH+n3vfe/4ywMX6isc9VDRWmjRt1MRWrY6tY+ytcSnMDZzNwlpLahaTfQx654EiADh1y/eghp5hrt+tkTYab5ctlj58Edswk1Zzs3xJuyHiuiogJBW81733SHERqHJlJSXZc1MuWSz9kXzmV8zs9U5VNAUmDRgbsaiLdm13UF3ViJ619VBschpq+SMqnmddFNetqPa7WdS8MQtCWVuI0K6ff/mNhr4neuwH0SToPOu2+uqJ2WMr7hUJWE7eug3p+1VLlmZ69uZmU2f79u9fm4Ub0Pybx2SN6hV8KTcqiCU6Twy4V431eV+OzKX2MHe7vz80WlKxD1erxMi4VYUm41eNgpg7/7xuaKYEpRRadyEvZwUcn/IvhvRs3Ezjj9H/9ro/ajxzSJhK1MOi1o/YccOuV/8fLDRw5c5kAyEMc5S+GkKldo5ezBZ1+VkW8ivAl0H/gdRufl8 sidebar_class_name: "get api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get incident by key (alpha)

+ Returns incident as JSON. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 incident is successfully returned. + -
Schema
- -The incident Get 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 incident 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license.api.mdx index b581b01f02d..27de7c051dd 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license.api.mdx @@ -5,36 +5,67 @@ description: "Obtains the status of the current Camunda license" sidebar_label: "Get status of Camunda license" hide_title: true hide_table_of_contents: true -api: eJydVE1v2zAM/SuCzmmc9hTkFnRZ0aHrhjZdD0UPssPE6mTJk+i0geH/PlK2k7RugGEnWxT1Hj8eWUtUmyBnT/JGZ2ADyOeRXEHIvC5ROytn8keKStsgMAcRUGEVhFvHU1Z5DxbFpSoqu1LCdBAj6SGUjn4JuZYXkwl/TqP2OO/Rh6iZs0h+DKbKkuyKwZKXwIi1DFkOhRpSLQmsD4jB95Bk/VNBwDFh464E8nXpC2RI59K7EjzqNoWtMnrVV2hI4CsQ+tOohQ4iPh6JtTIhujny8686ptTRps4ZUJYMtjJGpYaM0b8ZyQ5pGT0/Uj9qYygNrLyN9D0t44ouh93pinb0Ab22G9kQG2pk8l4Od13d6K7h6wIwdyu630CsksKcDskBMYDfgmdF1bLyhi7rti/NLEnq3AVsZnXpPDbJ9oL8t8przjeWma/bHNeqMvQrjcuUieaPsuSu8oVVBXxMcCruFvdLcaUQXtVuLClwpnwPPZ1MJ5+isusJxPnPa9FmGEGPFdfD5ojlp7Ct878AN80zF5LGQuPunp+15UlBefDzimte973r+CJ6lFJ0Ikv789X5QnFc3x6XscHarl183jV6GAh3hVrYRj4Znw+y4WDXzovMFfQ2jqHdiFeNOc3WAS8zVUBOaK9h5uV+HdF2OhO/WkZxPuamtMrh1ALJZkPIVTomuiRrn+2/qXFpUtAm6SUYksv594fbL/Ozm+vLxe394owQx/iGMfmSBFMoexTHFRzvneGEvMu8Pqyg/1qLXcsQ3jApDT1nEcVc626UnvalIgm04/Ak6zpVAR68aRo2087yO7I/H6aHTwSVg1pR73n2fsOOO5VlUGIcM1Mx9WBvstT2Q321YI38BUgnF3I= +api: eJydVMFO4zAQ/RVrzqEpnFBuFdtFu2LZFZTlgHpw3Glj1rGDPS5UUf59NU5SCgVptbk4icfvzZt54xZIbgIUD3ClFdqAsMxghUF53ZB2Fgr4WZLUNgiqUASSFINw6/SlovdoSVzIOtqVFGaAyMBjaJwNGKBo4Ww65eVz1BHnLfoxqnKW0BKDyaYxWkkGyx8DI7YQVIW1PKZaVCjGhBh8Dyk8PkUMNIEMaNcgFODKR1QEGTTeNehJ9xK20ujVWKFjAh9R6A+zFjqIdDgTa2lCCnNUoX/WSdJAWzpnUFrIwEZjZGkQihTfZTAgLVLke+p7bYzwSNHbRD/SMq4YNOw+r+hAH8hru4Guy4A0Mfloh5uhbtDxk0GNVLkVFLDBVCVJFRSQvyIG9Fv07KgWojdQQNv3pSvyvK1coK5oG+epy7dnkMFWes16U5l5u9e4ltEQFGCckib9fm9L7ipvWFnje4Hn4mZ+uxCXkvBZ7ibQZcCUb6HPp+fTD1E59BPE2a9voleYQA8dN8JWRM2HsH3wvwB33ZILqaLXtLvlY315SpQe/SxyzduxdwNfQk9WSkGQDS9fna8l5/X9fpEarO3apeNDo48T4a6gD33m08npkRpOdu28UK6uo01jaDfiWVMl5IEwZWIgFrT3MPNyvw5oB5+J3z2jOJ1wU3rnsLRQ5PlGUxXLiXJ1rvpj+7U0rsxrqe1owZBfzH7cXX+ZnVx9u5hf385PTifTCb1QEt+4QLW0B3lc4uG9czwhb5S3r1fQf12LQ8sIXyhvjNSWTZS0tsMoPexLtcyGcXiAti1lwDtvuo5/P0X0Oygelq/Tw19dBhXKFfo0e39wx51SChtKY2YiUx/dm2y1/VBfztkjfwFIJxdy sidebar_class_name: "get api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get status of Camunda license

+ - + Obtains the status of the current Camunda license -## Request + -
+ -Obtains the current status of the Camunda license - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx index 0eff1841ebd..824e95bc191 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx @@ -5,31 +5,31 @@ description: "Migrates a process instance to a new process definition." sidebar_label: "Migrate process instance" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isYXppMLUpJnTTVoTOq7bRu49Qjy+1B9gEilyJiEmAAULKGo//eXYCSaJGK08elM3LGDkkA+/y+BbBVYPncBMNpcK1VBMYwIY3lMoLg/iSIwURaFFYoGQyDKzHX3IJhnBV7k5lV+FXCcjsSQyKkoJXhnZykwjANn0swlkVcskhJy4VkeZlZUWTAcl4UQs6dQF1GtM6QUCdmNzwDuwSQzKbAOM5awJ3ct+UbwyCDHKRFS2XMLNdzsB2GbaehhXfy1qAXZCdqLQv0NIYvOroAbUiIShrTlMYJd5KzWCQJaBTeofeEQTgPSdIDQMFWqtRMl1Ju/Cc9Bm3oWdWLMeBsKWxKLt/JjOK/kylyfFpsnQhOgoJrnoNF2zCnVSDxBTNXz7+shf8GK5wqKKcFtyk+U26EhjgYYvRhP/ETjPYDrMhVCnw7Jim3zKSqzGLMEMs9TuIQBZsohZwHwyqwq4JMEdLCHDQOJUrn3PpPb0+D9fre24EO/qTiFa3ZN4tgg77SEAIiExEnC/ufDJlZtZWp2SeILIVFqwK0FWDcqENEDfjzbV4oLDh60PcOBGEOa28PREZREJ51/SSoAX7ZgH/DD641dymzkJsu/9o2dxLKT8MUpWrpbOfFjiuJVrnzwiAgIzjgLk04yKgag0+C7aVdeC2XcXeEayPY5XkzpGRRI37oCHpE0fIG/COZGHHVIXPd5MC0ZXRbJYLVCpvBri5ePyXZVSujTguFxqF2DK5AYKFtWT/CWlkPOuxFqTJY9GYrF/3SgPaUW4osI8Ih6a2rQ/iqIVI6pmprqLYiAuq8YmXb6g7ZVYllBJf+yAZMOGgvRIyUdQl8Dq8IV0x4XubB8NV+5L7ArW6UPxvIsa8JGD2vyxS4zGPr9eC0O/ctIqL3u7KEYk4Hg4MrXSQYVl5Oy6SybMEz4crZgQKEi2aIjG/bhWg/sdd+JnIG97+MeQIzvqNmjDaz6fj9Gfvh9M339y9Sawsz7PeXy2Wok6gHsbBKh0rP+/hKvzTvZcjQeE20X1FaeRy7sPOM7djITAGRSES04XFtNqN8P8n8obrpRqs97jTgUWrRKkYjdju+ZBhSaUWyIkC2VLs1CUe8Uq2bqdIOZxmXD47qHhttpftaTJnnXDc3qYYCFIRAsKV5dif67nVnOf1lMrlmXgQeXvBokNBWT6SqFYVNViC6COyP/u3tYLAmmZTxr/AEzyWPBbrvoLXvDp2ZFObZS3OObQ9s/01mlBZzsa83dLVrw9MaxOfeI8/L079DReJUokp55NSRU0dOHeTUm65NCn2hKGvCIWiNIVNRVGrcftkyFdmWcBvd9ZH6yLQj045M62Ya3b/ApiqmC7EyDjp0Lx4G/ZpMve29vF+1L9Prvj9bkmGYKtCLzf271BizoPKMWiMRKjzK2/WwKpS26/6C0rXgWnC0yGWXhj3zNojKVMSz1FvVziwN0CV/4/EZz3Fb5ewdG1/cTNjPeOBd8pWLNKl8Kvrd4N2gUypNPSBxdH3JvIcel41asRFLpO8U6yd/jWDXDDCAdU3Y1Q0t8+GZAdegRyUlZ4uXWp+TTu9+En7xD+83KPr1z4kDAtW58a7RcPHI86Jm6RcaA4MDl/RpxxV3B+HWTXV747zvvgsOHCcS5cypEduOFMHG959weBC+arMDo0kkj1SOa12lR4a4RhJvRD7K8B5IET8JcDsAvFeR3rprtJn2wY+wP+qO16uQUOOhvSnwc5RczkJU14/8su3/s0zN+jkXsl+rMP2z0dXtx/NR78Pl2cXHm4seSgzto3XZIQLmXDbsqK+FrZPkvtPVboM79ir/B73Kmr4WHm0ftwwhqaA4WFV1/Z0GrfqL64ad7cxdCUZm+TI6Dapqxg3c6my9ps+YVI1Unt7vqq4jcCwMPSM9E56Z/f5nE1cvxnWv4yX7F13RTs83vT65cptCVtIbPj5Q9elq4a7vcVUKmHztvPATz7ytvQmJ2wlq9UvXJ5sVoyiCwh6Y++RwSEVru1Ne/34zoSJb92pzPFfgV82X1E/Gv8PgDv8FVOa2/Uz3vQrwfDAv+Zzme7n08xddWKFG +api: eJztWN1v2zYQ/1cOfFmLKbLTpV2nhwFekm7Zmi5InO0h8QMtnS22FKmSlB3D0P8+HCnZjiU33cfLgAQIEpvH+/z9juStmeNzy5I7dmV0itaCUNZxlSKbRCxDmxpROqEVS9ilmBvu0AKHck8YnAYOCpeblQxnQgnaGd+rcS4sGPxcoXWQcgWpVo4LBUUlnSglQsHLUqi5V2iqlPZZUurVbJen6JaIClyOwFMnFniv9n35xgJKLFA5C1xl4LiZo+txbCMW36t7dWsRHPnpNFTl3PAMvxjoAo0lJXq2I6YNOH2vOGRiNkODqs9uBBjPY9L0CbGEla4MmEqpNn6yY6Eqj5w+yrhDWAqXU8j3SlL+tzpFURq92ATBIlZywwt0aKima6Z4gSxhjfxFo/w3XLGICappyV3OIka1EQYzljhT4X7hxznCJ1xRqJT4bk5y7sDmupIZTBGKgJMsZhGzaY4FZ8mauVVJrgjlcI6GRWymTcFd+OrNCavrSfADrftJZyvas+8WwQaVoyVellKknDwcfLTk5rprTE8/YuooLUaXaJxA61c9IhrAn23qQmlJ1odj70GQ0220BzKjKQlPhh6xBuAXO/DfiYMbw33JHBa2L76uz72ECmJThFwvve+83HJlZnTho7C6MikeCJcEDjKqweCjZAdt58HKRdaf4cYJuDjbTSl5tJM/64xQc8pWcOAf6RTqUU1anfUuB+46TndNTiLmhJO47YtXj0l22amot0Kp8ai9Rt8gUux6PwLTLnrspbm2qGC68tmvLJpAuaWQkghXcuN8H5ISDKbaZNRtLfVWNW/rKixsbMdwWVlHW3+EIQgP7YXIMAsFfAqvESuEEkVVsOR4P3Nf4FY/yp9M5HXoCayugy1bamUDtl4NT/pr3yGisDttqY7YyXB4cKfPBGTccdqmtIMFl8K3swMNqDR6KrH4ttuI9gt7FSQhQ8eFhEBg4FtqZiAU3F2/O4UfTl5/P3mRO1faZDBYLpexmaVHmAmnTazNfGBmKf2S3MsYxjkaov2KysqzzKedS9iyEWyJqZiJtOVx4zZQvR9V/lDf9KvrPe7swKMyotOMRnB7fQEiQ+XEbEWA7Jj2e2a8kqSDT3Xlkqnk6pOnesBG1+i+FVsVBTe7h9SOgTpi1nFX2SdPou9e9bbTX8bjKwgqINUZwoyOeiJVYyjeZcXJcEhgfwif3gyHNemkin9FJArwoZRceWjth0N3Jm2wwY8PbHNh+28qo42Yi327se9dLU8bEJ+FiAIvT/4OFYlTM12pZ049c+qZUwc59brvkBopusOgIRyiMdqATtPKGMxgmQu5IVxru7lSPzPtmWnPTOtnGr2/0OU6owexth469C5O2KAh09HmXT5Ydx/T9SDcLcmxiFk0i/b9XRnJErYOjKqTwWCda+vqZF1q4+rBgsq14EbwqQwgpeXAvBZRUqdc5sGrbmVpgR75bcSnvKhUxuEtXJ/fjOFn7nDJVz7TZPKx6rfDt8NerSR6QOPo6gJChAGXO72iVUuk71UbhL9GsR8GWEwrI9zqhraF9EyRGzSjioqzwUtjz2unz0GIRc0/71oU/frn2AOB+tz1dtBw/sCLsmHpFwYDwwOP9LueJ+4Wwp2X6ubFOel/Cw49J2bau9Mgtpspgk2YP7GEDePjLjuuLjzJU10UlfKdXs3DIInvZD6VlXWU8YhJkaKyPg3N1KgVex9W4I9m4nUcE2oCtNsGPxcur6ZxqotBGrZt/k6lng4KLtSgMWEHp6PL2w9no6P3F6fnH27Oj47jYewenK8OEbDgaseP5lnYuUnuB73eHnDPs8r/wayyoa/DBzcoJReKGoqH1brpv3es039ZxJLecea2BU+ipo3esfV6yi3eGlnX9PXnCs2KJXeTbdf1BM6Epf8zlsy4tPvzz11cvbhuZh0v4V9MRXsjb2d9auUPBVnRJxaxT9R9+ka49aSOWI48Q+OjCIKnwdejManbKurMS+uo3TFKUyzdAdlHl0NqWpuT8ur3mzE12WZWW+iM9hq+pHkyXwbndbmZZfrv1kxyNa/4nGSDTvr5C+sXoEo= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Migrate process instance

+ Migrates a process instance to a new process definition. @@ -40,22 +40,203 @@ Use this to upgrade a process instance to a new version of a process or to a different process definition, e.g. to keep your running instances up-to-date with the latest process improvements. -## Request + -

Path Parameters

Body

required
    mappingInstructions object[]required
  • Array [
  • ]
    • = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
+ -The process instance is migrated. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + required: ["targetProcessDefinitionKey", "mappingInstructions"], + title: "MigrateProcessInstanceRequest", + }, + }, + }, + }} +> -
- -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 process instance is not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx index e5e565fec20..14c59f50ea7 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx @@ -5,31 +5,31 @@ description: "Modifies a running process instance." sidebar_label: "Modify process instance" hide_title: true hide_table_of_contents: true -api: eJztWcty2zYU/RUMN02m1sOpk6ZadEZ1nFZpHh5bTheyFxAJSahJggVAyxqN/r3nAiRFipLtTjvpxukkFQngPs89uADXgeVzEwwmwblWoTCGydRYnoYiuDkKImFCLTMrVRoMgk8qkjMpDONM52kq0znLdhZ1r9PxQhqmxV+5MJaFPGWhSi2XKUvy2MosFm6yzkOSaphVjOPnHbeCYbKIRSJSy9SM2YWo5Ct9nWKmFTqRaTHVLROValqyFQBDrtMrIyBFOiVaZFxqmL5rMmZwyzDJ2Dy8ZSptmKGxVt3SqxwOW5FGImIZtwsoeI9Rcc8T+HTEpiLkufE+3MPOlMfMrIwVCclOlWX8jsuYTxEArIuUMOl3FmaZTKUR4wbLMhFaEUFycBRkXPNEQBAlZx2keEAKCuNHhe2/ixWmSkoO2YTfFHipRRQMEGKxm8ExQnorVrvRbYbCLFQeR3CIJT7hUReCTbgQCQ8G68CuMjKFojEXGkMzpRNu/as3J8Fmc+PtAAB+UdGK1uyaRZhAfGmIZ1ksQ04W9v40ZOa6rUxN/0RsKCxaZUJboNCtLZAzqiGqtoprzV2AkAWzT1ozOnUpzA9NCeTLhQwXJSRMLT6l+ggRLGaZEPahQpBS/+KOa0lJr68LteDbRDc8KrSMInpoJ2/0rsxdidCdlFUmUc4Kd+EV3Ag2RwEl2VilzwotNRjtVVfDSrnUe9gwoYJPy0MMwclLYakCO8f0rx9x61OxbMtYSlSsr8F7aSzFvzXHm3SdzmK19Pb4UD6GTEr4jIOGgkHnGOEoc/Mt4PMQDlooqCa30/Lh8stnsEeYb7O/lHFcBMfKMrhbfTMiMbzRCiRUvi7SeIAIEM6RBWGDwQlTzCn1bh8RVW2FO91EFShjXwecUNO543Eu2IybBcz22eFRJMkJHp/XnPV80IzshugGU55eBc362wnAvsL7KDj2DpFkdrWDyu06CKUX81hNicwfClgdfkW51cAWgBPr1DypJRhcaaWNRbm/rs6bFP+1jVFI2xG3ZY3HxA3bjOmMq3bW/4lKK/17qkE8ka0eJcemksf3sf1BrpnxWLTHe6Lq5JJ7bsu7EDOhBbVbLZeGaA6KQUfE4UIZkbLpyrmIXkPXyh/eoWNwfRPHoxah0hH1YYa6LkR+plXim6FKd5d9Kir8Z9ZnckaovpNRuTE9zqbwTSZ5EgyOHYQeisSF7wcIui6s1PUYn95X/ZP9+Wy1JzB+25JAzEm/f3Clc4RF3PKy/wIlSZf4A80HFqHOku/bTchuXs79TAAbjW1cECPxYoF0T4STi/en7KeT1z/evFhYm5lBr7dcLrt6FnYEmFDprtLzHh7pL8172WUwXhOZrhzvVoTJtgXBDLpEhCAk2iqoyBlD6Wok7kDP5EfXLbaqsptr2arnIbu6GDGEFDvMbEV4aqluEB6fqtwOpjFPb4MtNNpKd7WYPEm4rjeoNQW0LVhuc/NoF/rDq5ZsgsVv4/E58yJwKolEsTUCH4Wibh3UQBee+L1/etPvb0gmZfwJnlD7ksF9B61dd+gwpJBnL805Vp26/pvMKC3ncldvN6iXaQHid94jX5cn/6QUqaZmKk+fa+q5pp5r6mBNvd63ScEXirK7JRBaI2QqDHONToNapLgquFJ3cZx+rrTnSnuutP2VhsFE2IWK6DJMGQcduhMbBL2imDqlmaa3bl+kbXq+t/T1RDdeQt+V12+5RtiCtS+qDWphjWbcbgbrTGm76d1RxhqHdhr2xVeCKlYhjxfesHZyaYDu+EqnT3mCnZWzt+zi7HLMfsUZYslXLtiksin6bf9tf69UmnpA4vB8xLyHHpo1uijFUt3vFesnP0Wwuws0AtQm7eqSlvnwTAXXQg9zyk8FmUKfk07PfhLe+B/vSyB9+GPssEBUd7G9ZzzzV7GH7wUnjeu1LUIfuhXrHB+6Jpo0r2nqdxbVjdsNuX/gaD3Zf7Dt05J9x8O+q7OZcgErqqAdesIhQOtz1e8etysO6SHiCFWCtQ7tdC6XdsF4LZVhjKMhpfAowBYjcFYjvcUtdDntox9hX71GdtwlGPpaKTeNOSTn0y7U9UK/rPr/NFbTXsJl2itUmN7p8NPV53fDzsfR6dnny7MOJHbtvXXppqJOeFqzw580W83prs/r7Z75/A3jW37DKOraQlgP24lMiWkcPNYFN0+CFjdj3WDvZ44GPaNIPMVOgvV6yo240vFmQ6+RNI06mtxsC9cVWyQN/UZ5znhsdj+N1DHy4qK49XnJ/sUHk73Ol7dp6cptGHFOT/h5S6W/7+sOKASeCh6BCMkLP/HU29oZk7itoNanlM1RuWIYhiKzB+Y2ekfin2ojPf9yOSYCLj7jwD9aq/mSPjXh30Fwjf8CYqzqxtC9XwdoH+Y5n9N8L5f+/A1KWAIj +api: eJztWd9v4zYS/lcGfLkWJ8tOL223fijgy2bv3NvdBom3fbDzQEtjiw1FqiRlxzD0vx+GlGTZsjdb9NB7SYAktkTOz+8bksM9c3xt2XjO7oxO0FoQyjquEmSPEUvRJkYUTmjFxuyDTsVKoAUOplRKqDUUJ5PihZplwoLB30u0DhKuINHKcaEgL6UThUQ/2JQJSbXgNPDEiQ13CFwBSsxROdArcBm28rVZKKfBocmFqof6adiqpikHAfFCLdQni+DIHKfBYMGFAd4zGVzGHQgL1pXJE2h1ZIYBp/UTPSqVUA5ViikU3GXxQr3TBvCZ54XECJaY8NIGH54dGsUl2J11mJNspR3wDReSLyWS1FSjVX9zYNAWWqXALeBzgYnDNF4oFrGCG56jQ0PJ2TPFc2RjVhs/rW3/D+5YxAQlh2xiEaPAC4MpGztT4mkGZxnCE+5Oo3scCpvpUqawRMhDwtOYRcwmGeacjffM7QoyhaKxRsMittIm5y48+u6aVdVjsAOt+6dOdzTn1CzCBCpHr3hRSJFwsnD4myUz931levkbJo7CYnSBxgm0fm6NnGkHUZ1Z3BjuA+Qwt+ekHUenKwXCqyWBfJuJJGsgYTvxadSnIFQ9yia6IIaotH6w4UZQ0rvzEoP8kOgjj2ot05S+9JM3fdvkrkHoScpakyhntbvWGaHWrIoYJdk6bW5rLR0YnVXXwUozNXh4ZEILn56HIFS8UA/oiIGDK/ob3vj5Crd9GVvhMhE4+Cyso/j3xgSTFmol9TbYE0L5EjIp4SteSsfGg6sqYk1u/gr4fA4HPRS0g/tp+enh54+Q6qQ8ZH8rpKyD40QT3IO+FRWxDMFo7drHdRovFIJ4oaYO8tI6jynwSoPbEZWqg3Cvm0oFL4rAA06oGWy4LBFW3GZCq5AdnqaCnODyruNsqAfHka2o3OgCv5wFx/w7CcA54r1HvkHAvHC7E1Qe5gnlH6ylXlIx/1zAuvCr6dYBG2NV1S3N806CHyPmhJPYrK+7u+MS/0sfo6w6FXeoGi+Jm/QrpjeuXVn/T6W01X+GDfiF1erF4nis5OV17HyQO2a8FO3Zmah6ueSeX/LucYUGabvVc2kCpnnpC3GSaYsKljvvYmnRdOi/RCi48fsmLiUYTLRJaR9madel1rAyOg+boVZ3DB9qhv8IIxArQvVGpM3C9HI1zYUSeZmz8ZWH0OcicR/2AwRdH1ba9diQ3m9G1+fz2dueCNvZklQRux6NLs70jkDKHW/2XxsuhU/8hc1HYfRSYv73/ibkNC93YSSk6LiQdWGkulgjPRTC+f27G/jh+tvvH7/KnCvseDjcbrexWSUDTIXTJtZmPTSrhH5p3NcxzDI0VEx3vu62BRMOhABbYCJWIqGyVZcibwyl6yhxF/ZM4e2+V63a7JZG9Pg8gU/3UxApKidWO8JTT/VRweNLXbrxUnL1xA7Q6Cs91WLLPOemu0HtKKBlwXFX2hd3of/4piebYPHv2ewOgghIdIr10ihsoyjugvp6NIpYzp/Dt+9Go4pkUsa/wBPavhSSKw+tU3foMKQN1vjxjrWnrv9NZrQRa3GqN2ZdmtYgfhs8Cry8/iNUJE6tdKleOfXKqVdOXeTUt+cWqYkCirLvEqAx2oBOktIY9MdG2RKu0V0fp1+Z9sq0V6adZ1oVsRxdplNqhmnroUM9sTEb1mQaNGba4b7fSKuGYW8Z+EQdLzSbpv1WGsnGbB9IVY2Hw32mravG+0IbVw03lLGjQzu9DuRrQCV1wmUWDOsnl15Qj69x+obnpUo5vIH724cZ/Is73PKdDzapPBb9ZvRmdFYqDb0gcXI3heBhgGanXDRiifdnxYbBXyLY9wItJqURbvdA00J4lsgNmklJ+WkhU+vz0ul7GMSi+sO7Bkg//TrzWKBSd3/oM96GVuzlvuD8qL12QOjnumKDq0ttovlxm6bbs2g7bo/k/oWj9fz8wXZEU84dD0eeZyvtA1azoB96wiEaG3I1iq/6jLub+sKR6DwvlUc7ncuFy4B3UpnI0jpKYcSkSFBZH9e6C90Mex/ewC9BI1zFBMPAlWbRWAuXlcs40fkwCdPa/0upl8OcCzWsVdjhzeTDp49vJ4P305vbjw+3g6t4FLtn59NNpM656tgRTpq9zempz/vDmvl6h/FX3mHUvHb47IaF5EJRpfHw2Ne1ec56tZlFbHz2muOoPD9GdYmds/1+yS1+MrKq6PHvJZodG88fD8T1ZEuFpc8pG6+4tKdXI12MfHVfd32+hj9xYXLW+aabpnZ+wZAlfWMReyLqn7vdqR6riGXIUzTeizDwJtg6mJG4g6DeVUoVNTMmSYKFuzD2aO9I9addSO9+fphRAa6vcXKd0lzDt3TVxLfBeF203UL/bM8kV+uSr2lskEk//wVU0AEn sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Modify process instance

+ Modifies a running process instance. @@ -39,27 +39,242 @@ to terminate an active instance of an element. Use this to repair a process instance that is stuck on an element or took an unintended path. For example, because an external system is not available or doesn't respond as expected. -## Request + -

Path Parameters

Body

required
    activateInstructions object[]
  • Array [
    • variableInstructions object[]
  • Array [
    • variables objectrequired
    + -JSON document that will instantiate the variables for the root variable scope of the process instance. -It must be a JSON object, as variables will be mapped in a key-value fashion. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + title: "ModifyProcessInstanceRequest", + }, + }, + }, + }} +> -
  • ]
  • ]
    • terminateInstructions object[]
  • Array [
  • ]
    • = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
- -The process instance is modified. - -
- -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 process instance is not found. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha.api.mdx index 993b60b1883..48866f80e70 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha.api.mdx @@ -5,29 +5,32 @@ description: "Set a precise, static time for the Zeebe engine’s internal clock sidebar_label: "Pin internal clock (alpha)" hide_title: true hide_table_of_contents: true -api: eJztV8FuGzcQ/RViTzEqa5XUSV3dVMdpXSSBYcsNUNkHanekZbxLbkmuZUEQ0N/o7/VL+obctWRLRnMoerINyyI5nJk382ZIrhIv5y4ZTpKT0mS3yU0vycllVtVeGZ0Mk0vyQoraUqYc9YTz0qtMeFWRmBkrfEHid6IpCdJzpenvP/9yQmlPVstSZKyzf62/FKSDaJgQyolaaU15TygvLFVSaSekDyKuhqmZojwakToXuSEntIEj+Z3UGUHj2IiskHpOYQ9L9rYMVI3zAj5FK0LOYUAslC8ARdMiyANJVUPTtR4Oh1BOUFrAM9J5bYCAvZRaTGRZF1LMSPrG0s2r1NKMLMGLNKwctiuuX+UHwdtKLtm2a6ZfKQOmztNrDSdmDQsDc0nSYVOwfq2TXmLpjwZO/WTyZTJchaGylCdDbxvqJZlBULXnJVnXpcokJyj96jhLq8RlBcLI3/yyJuTNBOvQW1tTk/WKXFjtkPPgcabHCB/dS3aZAw9nqTZZISpVlsg9HMgdo1kUCrObYLvCNGW+CXcfRlsnmAhzspgAVyrp49S7o2S97m0hnGy5BQJ65UveHRh5rvRFjAw2xW2uNtpFOG8GR/uBRNcW0iEPWUbOzZqyXHaEAIo9VNuLGBlKYPVoMNhvqEOx4ZSopZUVoQSYQpVyTum5QK2owClNc6TujjhMzyQVKZuWVH23m9zH9kfiPEqKnLxUpYhJF0AdBafwC6gmFx9OxI9Hb3+4eVV4X7thmi4Wi76dZYeUK29s39h5iiH/sdxBXwAbeNpyWeYQg02U9IZOXfiyLpyt24KT3w+c/hcuhtUHxjpvEahtrjRWJU/70UhcXZwJlSNsarbkyO6YDntmsilZh5yaxg+npdS3nMeWW7tGn1pxTVVJuxRmtscAFHEjbLZgPMP179/s6GbW/DIen4uoQmQm73opN8ZoiEFUSquqqZIhyIeRvI+jd4PBmnVyxr8BCUh9XwN+oNZTOCBHZZDnqC0AQyv23GT/o8wYq3AuPLHbDw2gq/OWxO8joljlb/fVG7A8HC1kLUJmsqyxXH1oSmVQz7Xe2W5b6kulvVTaS6XtrzQs4qgqDE7hpG4Cc6QvMEjDCYqxI3tHlq+IKziDOCSrWCVrkHtVGOfXw1VtrF+nd5yCO2mVhJWQMV6O1dSxBFplGab3ZYsXNA7PDsWJrBqdS3EsLk4vx+Jn6WkhlyF6bPKx6uPB8WCvVhZ9RuPo/ExEhJFrW/XfqeVC3qs2Cn+L4vX6hgOJXqX88pK3xfBMSVqyo4Yj/sCB1l7QzuMohJn45UPHjF+/jENyuXddbC6Pp/e4g7SVt7nsDQLfZiZOt/erHY85fch1hDjov95lHlBxAWWmwt7QRcG+9ma90ZeVuIAz8l6CVku4rbFdTuyW2Y9xRfwWLYrXfc5epFjXPOfQ3Ez7MJdmcdvD/2lppim/HNLWhEtPRp+uPr8fHX48Ozn9fHl6CI19f+9DlGowq5J6yw/cLJ+8VMSrcKU/eAp7tTk+Xt5D/9d7qK0GT/c+RVdV4Roe2LFqe9Qkybo3a+wzk2S1mkLNlS3Xa55GUVi8piY3m7bEIygqSOYoKm5qt7RkVsYMH47ZLIuXDZvfeWute92OEd4VtX9G9tHFgqv/ocueX425lttnXoUjCZNWLvgJiM9hco1fDEwgX2gTYX6V4GiZN3LO8lEt//wDv315Tg== +api: eJztV19v2zYQ/yoHPrWYIrld2mV689J0y9AVQeKswOw8nKmzxVYiVZKKYxgC9jX29fZJhiOl2IkdrA/DnmJAsEge73d/fnciN8Lj0ol8Kk4rI7+Im0QU5KRVjVdGi1xckQeExpJUjhJwHr2S4FVNsDAWfEnwB9GcgPRSafr7z78cKO3JaqxAss50pj+VpINomADloFFaU5GA8mCpRqUdoA8iriGpFoqKCIK6gMKQA208YHGLWlI60xMDskS9pLCHJZMdgLp1HubUowAuUWlYKV8CgqZVkHce6yad6ZnO81wbTzM9KZUD0kVjlPZsJWqYYtWUCAtC31q6eZFZWpAlLSkLK0f9ikvr4mWwtsY1Y7t2/pmkBz9YOtNKw6JlYbBUETpyaUCfaZEIS19bcv4nU6xFvglDZakQubctJUIa7Ul7XsKmqZRETlD22XGWNsLJkmrkN79uSOTCBHSRiMaahqxX5MLq4DkPHmZ6UhLQHbLJHHilgRojS6hVVSlH0ujCsTerUslyJ9iuNG1VbMOdimQwgomwJCsSsTC2Rh+n3h6Lrkt2PJzumHWTCK98xbsDIy+UvoyREV0Xt7nGaBfdeT06PuxING2FDlwrJTm3aKtqPRDCm0NUO+hxOtOiS8TxaHQYaPBiyylo0GJNnixTqFbOKb0EY5nryoGmJXp1SxymJ5LaWDOvqP5uP7kP8cdwESWhII+qgph0QAdRcE4FezW9fH8KPx6/+eHmRel94/IsW61WqV3IIyqUNzY1dpnZheSH5V6mMCnJ0sBlLArFmFjBlk5D+OQQzt5s4OSngdP/wsWwes9Y563Sy12utFaJx/1oDNeX56AK0l4t1hzZPeiwZ4FtxTpwblqfzyvUXziPPbf2QR+juLau0a7BLA4AdIngRtjuuPEE179/vaebWfPLZHIBUQVIUwy9lBtjBGInaqVV3dYiPx6NElHjXRy9HY061skZ/wZPNNBdU6EO1HrsjtJQG0s9f4JjSjvPTfY/yoyxaqke46ahAQx13pP4XfQoVvmbQ/U21ttPC1lrLBgpW8vVtypVFdRzrQ/YfUt9rrTnSnuutMOV1iWiJl+aQuSiaQNz0JciF1n4gopEOLK3ZPmIuBGtrUQuNrFKujzLNqVxvss3jbG+y245BbdoFc6rSDxejtU0sKQyEqswfShbvKCxpsGLU6xbXSCcwOXZ1QR+Rk8rXIfoMeRD1Sejk9FBrSz6hMbxxTlEDyPXdup/UMuFfFBtFP4WxV13w4GUrVV+fcXbYnjmhJbsuOWI33OgxwvaeRyFRNK/vB+Y8eunSUgu967L7eHx7A7rpq+87WFvFPi2MHG6P1/tWczpI+uii6P01T7zLs5DAUlT160OXVQvh5P1Vp+sWufZ80RUSpJ2wRxO7A7sh7gCv0dEeJVy9iLFhua5VL5s56k0dSbjtvv/eWXmGd8csh7CZafj364/vhsffTg/Pft4dXb0Kh2l/s6HKDXG+Rr1jh0XSj+6qcCLcKR/+djtzfbz8Xwf+r/uQ301eLrzWVOhCsfwwI5N36OmQg531thnpmKzmaOja1t1HU9/bcmuRT692bYlHnWJKAkLsqGpfaE1szJm+GjCsCxetQy/d9fqkmHHWEpq/BOyDw4WXP33XfbiesK13F/zalPwVosrvgLiSuRCJMIE4oUWEeY2okK9bHHJslEl//4B7St4Ug== sidebar_class_name: "put api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Pin internal clock (alpha)

+ - + 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. @@ -38,18 +41,129 @@ This endpoint is an [alpha feature](/reference/alpha-features.md) and may be sub in future releases. ::: -## Request + -

Body

required
+ -The clock was successfully pinned to the specified time in epoch milliseconds. + -
- -The required timestamp parameter is missing or it is negative. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/publish-a-message.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/publish-a-message.api.mdx index 292680ce941..4a312302dd9 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/publish-a-message.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/publish-a-message.api.mdx @@ -5,51 +5,203 @@ description: "Publishes a single message." sidebar_label: "Publish a message" hide_title: true hide_table_of_contents: true -api: eJztWF1T4zYU/SsaPS1TiLNbdpfmLQW2ZctCBkL7EPIg23KsxZZcSU7IePzfe6/lxHacsHSmbwUGEklX9/OcK8sFtWxh6GhGv3Fj2ILT+TENuQm0yKxQko7oJPcTYWJuCCNGyEXCSepkB4+y3gVrmpOslgyJVcRkPBCRCEjGtBWoy5BApVluYT3SKiU25kLDnNY8YShAnvjagNJpzAmXYaaEtCRUoF0qS1ZMWBIpDW6092hu8sTCrgfDUeXGuY7QVhvuN3kQkxykA2Y42qPHVPO/c27srypc01FRDYXmIR1ZnfNjGihpubS4xLIsEUGl1vtuMEMFNUHMU4bf7DrjkDPlf+eBBb2ZVhmH+LnBVclSjp/dBGO4uEJU1A5gANtrdcZqSDwt0ZFtUH/w9X5dOxn9oVoseMQgiTCFNqxI+VRdi+U+X2HNZEySd0KS1Bxhpf08irju5B4s49DX6onrlkUoAV9wDRNQiJRZN/XptO3DEFyo9VyF+yPMpYBykauL3djIrUzWWNsoT9A1Lk2u0R2YVbLxbyVsXG1cQJQSFD3KlUgSwpcQiN9G8rswxyQRYQ1JRMQxOUcOM7tZlHmSMD/hDjQQxZJpgRNmfxQbZ7ZihBny9f72BjAf5CngDTPHwrBiD0smLSw5WO6irecBgJZJeyiNbnUnh8QAWTpFOxRgedziycyBu4fQOeLJ4p5Nh6n6iSPQnWMdLUunzGTQJVy6PgyHL2dtBcnalmlA/wVHD+tssaVBQJ83B9hdCx7kZZ+LryDGa4vY50K/fZQv18Jlvy7G6aH8Q8xLEUJeQmYZEa43L1kiXioCbALcpD/9qBhjMnGSJOSWiYS4VCMxnKAPhqHzzO6+nJNfTj9+nr+Lrc3MyPNWq9VAR8EJB7ooPVB64cEQ/1DuaEDAeWgFKVsjwRtWkaaIzZkFrcO6WCtnMI8dzh9AgFstesTZ1hR6Cd09X8fk4e6KQEqlFdEae03PdKdFM1/lduQnTD7RpqJ9o7tWTJ6mTDcA7xgARcYym7fCOIDJnz/0dCMsfp9OJ8SpgAMo5NVJa2PAR20Ig0iFFGme0hGgC0bs2Y0+DbHnu4q/IhI4zp8zCN+dcDvh4LGkoM5OWxWYkOCXDP6ryigtFmLX7qDDrhrEFy4iR6iP+wh1BSnWCELDNR49XGul33j0xqM3Hu3nUfVsaGMFhyHNlKmgw2wMI68+94yXNYcaLDtm4RWnAOcgL7RwrCkB7EUMOspRkSltS2+JJek8tOGyY9cGNYkKWBI7y/3q4UL7Uf6cpbkMGTkjd5f3U/Ibs3zF1lU20WRX9dnwbLhXK4oe0DieXNW9w2Gv1Q82apHYe9U64dcoLss5JjKA4tr1PW5z6fE5XPv0OMcCbDFR26u049gJwYz78mWDlK9/TatiYy+7a65fl88szRwT3XWpAdnu5adZaV9Zhp3rQyPTLmznqap1vRIyUlUoNQD7SUFFACeXxeHgfR/skDjkLNx1YW+FQwB8deFgrSQHSW6se8wGsHJ88Goi3ohduxXyp7NI3g8QIA7Fm369AM25PwBzXuC2bT/9RPleyoT0ahPGOx9/e7i5GJ9cX51f3txfnoDGgX22VSGQTymTLT/qqz843jywdqItmoPq//GeoMa45c/Wg94pJKKmKkhRN6LZBn0Ge1OrFQGFXDuZ0aLwQeWDTsoSpwH7GuA8mzcgxRFojjmDu1jVu54qxJ+7dJ9M0Q8UT3L0p3fhKY83O8ZBwDP7ouy81VQnt/dT5Gr9IiSFIwhmNVvhSxL4P6KP8AsDVUGgagPVfEHhKFnkCJIRdXrx5x+EMmPQ +api: eJztWEtz2zYQ/is7OCVTWlJSJ015U22nVZqHxpbbg+0DSK5ExCDA4CFZo+F/7yxBmZQoOe5Mb41mNBKIxT6/bwFwwxxfWBbfsE9oLV8gu4tYhjY1onRCKxazqU+ksDla4GCFWkiEIsgOblWzygI3CGUjmYHTYEtMxVykUHLjBOmykOqi9A4zmBtdgMtRGEi1MSg5CcA9ru3gVs1yBFRZqYVykGm0oLSDFRcO5toA31lj0HrpBrfq2iKp3Dq3I/SojdZbn+bgLULKLZI9FjGD3zxa95vO1ize1ENhMGOxMx4jlmrlUDma4mUpRVqrHX61lKENs2mOBad/bl0ii5lOvmLqWMRKo0s0TqClWcULpN/dBFO4NAN63g1gwKKtOuuMUAtWkSOPQf2J68O69jL6XbVU8Dn30rGYkQ0nCpzpj2J5yFdRoC25ghdCQWFfUqUTP5+j2cm9VvUwMfoeTceiUA4XaFjE5toU3IVHb0+7PoyqiDV6JtnhCL0S3zzC5Hw/Nvii5JpqO/eSXENlvSF35Bq0av1bCZfXCxdiiQom57dqJaQEXKKBpIvkF5mnJIFwFqSYIyXnZcDMfhaVl5InEgNoqogtuRH0wB6OYuvMoxhwCx+uvnyGTKe+QOUoczzLavZwOe1gKcByH209DxwqrtyxNIbZvRyCRZXtFO1YgFXU4clNAHcPoXeEJ0drth2m7ieBQJeBdayqgjJbamVDul6PRk9nbcVtW6YB+xccPa6zw5YWAX3eHGF3I3iUl30uPoMYzy1inwv99lE9XYuQ/aYYp8fyXxq9FBlmkHHHQYTevORSPFWE0uhEYvHT94oxhmmQhAwdFxJCqokYQTDBDISCm8v3Z/Dr6Ztf7l7kzpU2Hg5Xq9XAzNMTzITTZqDNYmjmKX1J7uUAZjkahIKvieAtq6AtYrtnOR1A0DhDedzh/BEEhNlNjziPNfVGsP39dQzXlxMQGSon5mvqNT3TOy2aJ9q7OJFc3bO2on2j+1asLwpuWoDvGKgiZh13vhPGEUz+/Lqnm2Dxx2w2haACUp1hvdO6XNitIQqiEEoUvmDx6WgUsYI/hNHbEfX8UPFnRKIAH0rJVdjh9sKhbUkbbPBTByaUdVyl/1VltBELsW93sMOuBsTnIaJAqDeHCDVRDg2B0KKhrQeN0eYHj37w6AePDvOoPhu6XGcsZqW2NXS4y1nMhs2+Z4dlu6mxiAVm0RVnw7yRLGabwJoqHg43ubauijelNq4aLqkkO4c2mg7s2qJG6pTLPFjuV48mukf5M154lXF4B5cXVzP4nTtc8XWdTTK5q/rd6N3ooFYSPaJxPJ00vSNgr9MPtmqJ2AfVBuHnKK6qO0pk6o1w6ytaFtKTIDdoxp4K8IiJxl6tncZBiEXNn/dbpHz4e1YXm3rZZXv9unjgRRmYGK5LLcj2Lz/tTPfKMtq5PrQy3cLunKo61yuh5roOpQFgPymkCI0NWRwNXvXBPp3UnE11UXhV41AtwoWDd5KcSm9dOGZLkSIdvNqIt2Ifwwz8FSzCqwEBJKB4268XwuU+GaS6GKZh2eNvInUyLLhQw8aEHZ6NP11/Ph+ffJycXXy+ujh5NRgN3IOrC0F8Krjq+NFc/YF3Dqw70W7ajer/8Z6gwbjDBzcsJReKUFMXZNM0opst+iz1pk4ruouadnLDNpuEW7w2sqro8TePZs3im7sWpDSqIpYjz9DUveu+RvxZSPfJjPwgcenJn96Fp4q2K8ZpiqV7Uvau01SnX65mxNXmRUihM1pj+IpekvAVvSKImK7LX7eA+tmGSa4WngASs6CTPv8AB+di1A== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Publish a message

+ - + Publishes a single message. Messages are published to specific partitions computed from their correlation keys. The endpoint does not wait for a correlation result. Use the message correlation endpoint for such use cases. -## Request + -

Body

required
    variables objectnullable
    + -The message variables as JSON document. + -
- -The message was published. - -
Schema
- -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}}>
- -Internal server error. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha.api.mdx index 60a82c59d2f..a58e9adea96 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha.api.mdx @@ -5,53 +5,328 @@ description: "Search for decision definitions based on given criteria." sidebar_label: "Query decision definitions (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWUtz2zYQ/isY9JJM9UqapKluiu20bmPHtZT0IOsAkaCEhARYALSs0fC/dxcgRUqULDnjQw/yUwQW+8Lut8ByRS2bGdof03MeCCOUJCGPhBQWPtJJi4bcBFqk7rFPh5zpYE4ipYGsQW/IlBkeEhiciXsuCay0XAvWuZN3st/vS2X5nRzNhSFchqkS0hL4zCRhcTpnJOLMZprDQEiAFojYNPYMz1iSyZCRIM4M8DREZZaoiNg5J1P1ABKGnLuncUn6ntxeDEdkcHNJ1D3X94IvJi+6LBWmbZWKTTfwhG0YamtubGOgXa7rJOFP/2ZcL3Hq5Z1EB0SZBnHoCMtEbDrOwjtJW1RzoDX2gwqXtL9yj0LzkPYjFhveooGSlkuLcyxNYxEw9F73m0Efr6gJ5jxhbjaOP0ewOStqlykH/6vpNx5YEJFqlXJtBTduhdKOW0HFtGZLIALnJ+YpfCLB47DGyFgt5IzmLap0yHVzBuMjYllsUaoJaJ63auaOC4YQRlbYmK8D6G905RCUvvWeovkEV6Zsxp+krlZJTSeIJj4DLVsUtidh1g/98hr1j0Ui7JG0xuk4iOyGxQ2nbuqWrxd+4MCSP2VlvtM/N+CNyj+tHfJ2LNq/oLnXcWHgse4uM/58nfB/8eVBn757Q7dRZARZyowRMwm5/Z0vW2QxFwArLLAABvBDMinADiJCSBMBQaQd5FgEjh2408Fda2p3uSOUd6lyfnUNkkowOZ7/NUv48RIkUB+SAWhjhAeBQ3H6qE8LPseadOszNgFnm2OcZvc7TddYkZlm6Rzmmd2nBqJ/yjQi+V6NninInltVQHAm7bEx5qkPhlktqc8b8fbRZewmZO6n3gUKucdnk0Kt9jn9utfzqd0I2VK/iiMpqr/JgoAbE2UxKXl1XN179rr21IJglWXx5RbM7o0Y8EUktLFYiL6yOOPmaXAfsx9d+xjge4c+BfH3rth2z7Y+B/Q84f8J/0/4///BfwS2TfA4gPolMLg1b34A6R0fEsH1hocdcgXH2vK2Qxh8Bni4hxQNiZDOprIawIUsXD5aEmAlXOySn5ulYVO/AbnxlIVc4qEJQcITTr308e3HM/Lbm7e/Tl7MrU1Nv9tdLBYdHQVtHgqrdEfpWRce8RfpXnYI2A42JGxJphApYegsZzGpQI+YFHwTiYBY5Qws1Ca4396+A/XIzTbjYx26mRaNcBmQL7eXJfQtYUFT9Oa9awpX4f40ZvI7rWLjUFAOoIwnCdPrvNgUgLcZC5fxw4V0Dxb9MRrdEM+CBCrkFYAXgtCIBOItyeAOB8EJT+zBP73r9RwW4I4fYYkk/CEF811obZsDwZFUcesMExL0ksFz7YzSYia25W7mchHE594in49vd+Uj2IJe1hiHXGtwmQqCTMNtGktk7Njj2auUXXQaTrl2yrVTru3LNZhMuJ0rKNU0VcaFDrNzeOqWVbhda2J2fRuHYj9H40nKXTwyDe6hK588OcT8ag6s8v4qhRtA3r3HnblnWmDD0m0kTvskK4MnVgGL516B5ibiRP2MuNXF/J1ZvmBL59S0aPdVrN/33vd2ckXSPRyxL+ot9CFYg4WSLeb3Trae+BjGOV5LDAcQE3Y5xGXePVNwMteDDPdhHRqFPMcdnz0RjPgPH8uA+fOfkdtzhLTbqtl68cCS1Cdk1d3ac2vp7bsx1EN/94m/olif13v7D9NNfo3Dba9+mqw1XX1bd7zuy1asinas77lOqs6p74j21v3O3lY3c7zy21HvU+JY7lI1Um4vikRq7mrdYtrrvGomLew8Yk+gEljrChAk7kJYuNvVoqTo4SMqQZXieEYFudI7tyT75GfI1+Iu86qDEe7TsKw7M+CcTTsgrmzdr/9PYzXtJkzIbiHCdM8GV1+uzwftT5dnF9fDizZw7NgHf7FGXEiYrOnhz74733K8cG8rXm6bv6oq8OlFyVEvSoq0t/zBdqGqCIlR77Z4VUD0mO6CaFrGML5a8EA7pqsVOvWLjvMch50WMD6pcBmfQMCcs9AnA/2O6UfP/La1R6gOkseZa49s97DyVrliEAQ8tY/STmpV5+bzcIQoVrwQSqBGw6hmC3xZBH/79A6+Ma9Tbx++NcLxFYVaO8tcdlPPF7/+Azj7sEg= +api: eJztWV9v2zYQ/yoE95JgsuR2bdfpzU3SLVubZonbPTh+OEsniy1FqiQVxzD03QeSku1YduwUGbCHBGhSisfj/f0deVxQA1NN4xE9xYRpJgVJMWOCGSYFHQc0RZ0oVrphTK8RVJKTTCqSduk1mYDGlEhBpuwWBUkUM6gYhDfiRsRxLKTBGzHMmSYo0lIyYQjTBAQZAS9zIBmCqRSOj6JEFqUUKIyOEBSf9yBJUOvI0fnfvYZah0V6TECkREhDUMCEeyFOoKhECiThlTaoNJGVITIjJkcykXfhjbhGdKNRS/qWXJ1dD8ng8pzIW1S3DGfjowhKpntGSq6jxBP2oGQ9hdp0PvTadWGR/vS9QjW3U8c3whotq5TJ0RrPAOM6dFa5ETSgCr9XqM07mc5pvHBDpjClcQZcY0ATKQwKY+egLDlLwFo8+qqtXxZUJzkW4GY5/5TReLSgZl4ijamcfMXE0ICWSpaoDEPtVkjluDVUoBTMaUCZwUI/hk/GkKdrjLRRTExpHVCpUlTdGRtTGVTc2F11Qus6WFN31DAcB9Qww3EZdH9bU15LZa68pWg9titLmOKjxFWyWJOJCYNTVDSgmVQFGP/pl5dWfs4KZg6k1U7GQWbuadwx6n3Z6uXCd5hJhY9ZWW+1zyVMcWWfYMt+WxbtXtD1NW8UPNTcLUqcLkHiL5zvtembV3QTeYY5EtCaTQWm5BvOAzLLWZITSIwmoAmQSrDvFRKWojAsY6gcTBkLNluwKrRe60p3viWUt4ly+vGCsLQFk8P5X0CBh+8goMB9e9yi0syDwL44fdCmDZ9DVbryGVtYhD7EaGa30dQaKzJVUObE5GB2iWErRgnKIvlOiZ4oyJ5aVIMChDk0xjz13jBbS+rTTry9dxl7HzJ3U28Dhdrjsy6l0D6nX/b7PrU7IdvKt+JImhODrlz5zipOWl6hq3tPXtceWxCMNMDPN2B2Z8TUAc2Y0sYWoi/AK9SPg3sOP7r2IcD3Bn0M4u9csWmeTXn2yPmM/8/4/4z//x/8t8B2Hzz2oH4LDG7Nqx9AeseHZMA4piH5KBW2tx0CCkmp5C1LMSVMOJ3aakAmMp0/WBJKJScci5+7peG+fANy6SmbfYmHJgsSnnDidx9dvT8hv716/ev4KDem1HEUzWazUGVJD1NmpAqlmkYqS+w/S3cckmGOCkkBczJBAmnqNAdOVqBHdIkJy1hCjHQKNmIT62+v35565Ga78bEM3UqxTrgMyOer8xb65kxMu1vfv3dNZGXiCQfxja5iY19QDoiuigLUMi/ub2BvMwZMtb+Q7sCiP4bDS+JZkESmuALwZiOrRMEEK6qCxq/6/YAWcOdHb/p9hwXW4wdoIgjelRyEC61NdZggxSpunWJMaAMieSrPSMWmbHPf+7ncBPGp18jn4+tt+TgQxFpZ2ThEpaQiMkkqpTC1JZI79vbs1e7ddBqec+05155zbVeu1QEt0OQypTEtpXahAyanMY3aKtxba3xGvo1DbT9H2ZOUu3hUitOYLnzy1HEULXKpTR0vSqlMHd1az9yCYrZh6Rxpp32StcHDZQI89wJ0nWgn1s+IG13M38HgDObOqGXT7luxftt/29/K1ZLu4Gj7ol5DH4JrsNCytfm9la0nPoRxba8lGpNKMTO/tsu8eSYICtWgsn5Yhkazn+Nux56IBs1/3rcB8+c/Q+dzC2lXq2br2R0UpU/IVXdrx62lv+vGsB7620/8K4rleb2/+zDd5dc53PbXT5NrTVff1h0t+7IrVk071vdcx6vOqe+I9pf9zv5GN3O08O5Y71Pab7VL1Uw6XzSJ1PXqusa0H77oJu3lucOeRBZFJVwBElMyYyYnsBYlTQ/fohJnCdozarygwhu3JfvgZ8iX5i7zIrQR7tOwrTtTZvJqEiayaFv3y78TLidRAUxEzRY6Ohl8/HxxOuh9OD85u7g+670I+6G58xdriwsFiDU5/Nl368vIkXuyON5Uf7GqwM+PK//Z40oDFQbvTFRyYMJmiguLRQPrI7oN1mkb9/Y5woPziC4W1hGfFa9r+9lJQePReIXldlQHNEdIfQLRbzZl6Yl3dW9oxbHkvHItlc2+Vx20KwZJgqV5kHa8VqkuP10PLfI1j0iFTO0aBTP7wAQzGlOLA6XXzb4y2W8LykFMK4cG1PO0P/8CGV/WCA== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query decision definitions (alpha)

+ Search for decision definitions based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx index fde29473bec..fd465bcfc99 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx @@ -5,53 +5,386 @@ description: "Search for decision instances based on given criteria." sidebar_label: "Query decision instances (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWW2T2jYQ/isa9Usy5S1pkqZ8IwfX0pDL9eCSznA3HWHLoMS2XEmGYxj+e3clGwyYt85N+4XL3MWW90W72mdX0i6oYWNNm0Pa5p7QQsZExNqw2OP0sUJ9rj0lEgPjtEn7nClvQgKpiL9NrcmIae4TGBqLKY8J8BmuBKs9xA9xs9mMpeEP8WAiNOGxn0gRGwLPLCYsTCaMBJyZVHEY8AnQAhEbhU7gFYvS2GfEC1MNMjWRqSEyIGbCyUg+gYY+5/ZtmJO+J3ed/oC0brtETrmaCj57fFFnidBVI2Wo654jrMJQVXFtdgaqOV8t8n/4O+Vqjp9ePsRofpAqUIduMEyEumYtfIhphSoOtNp8kP6cNhf2VSju02bAQs0r1JOx4bHBbyxJQuExdG79m0YPL6j2Jjxi9msYfg5gYRbUzBMO3pejb9wzoCJRMuHKCK4th1RWWkbFlGJzIALnR/ocOYHgoV8QpI0S8ZguK1Qqn6vdLxgdAUtDg1q1R5fLSsHcYSYQgsgIE/JV+PyBruzDpO+cp+jyETkTNuZnTVfJqDAniCY+hllWKCxPxIwb+uk1zj8UkTAn0mo7x1ZgNizecerm3JYrxg8cRPJzOJel/rkFb6z9UynRV8K0n2F3rcPMwFPd/Z3Pj3rw3Ru6nTEGgElgzcG6kzVq1ueGGeuzXV776QB3hfI4jTDaOl9avfvWoNOGsetWt2cf7m8+3nz+emOf+redq+51F8YLIZknvW4msY/6OigS5sWnLEwtPK8B5OnGuhYwsD3nNRsJHN9h88HRkD51mwciFsj28Vl8nYkFpbncorbc4OfVtWFXbu1zG5bL3aOkW5LEyiR227nA9qebY0JvWHTi6sdAeYbgL1DOhEv9x7JTmbapYz/RNQOroQxnqHtXyBpdbcBOv/sZkZQ//jVofeh1YKDXHXTuWr2/On/eQs3NqO46vdbAPRaht4bkARDiNHMMQq1ksTl1TR11YWnLELfcr/na5sXNwrQ3VZQk3qWrgTqRsXZ583WjUe7xnZkRV0GITj3EUpCGJJdUszuLZ985nFtyjTQs7G4Vsr0oBk8EQmmDpf4LZESuzyuoIfu3vIdKqnPoOTV1L8e2e7bnc2SelwpbrLDtbILbGF9Z7wNB1QhIw0dqrn/Ynktdv9T1S13/3+s6lDZ7cjzF9Y72MNj+230CFsHNQnNwd5CXEMvx5uwdgb18sDmH+zXyCQ6Y+b0DYcqCdCp87gOftSXfNZCR9OcHtw7AOQp59OPuFmJzdi1y6ygzvcSVMMIwCyHhyGkf3l1fkV/evP358cXEmEQ36/XZbFZTgVflvjBS1aQa1+EVf5HuZY2A5WBDxOZkxAnzfRvQLCTr4kh0Ap4JhEeMzLOSnQyus7PvyL4lg8fe2pIqsRMmLXJ/1yXg19iIYA4Mu6o3b0BGMjXNUcji73QdF8eCsQXbvShiqphxCwqy0p0e33DtySO/DQa3xIkgnvS5vbszeAeXKUIjIkgjEeYDCE14Y0/u7V2jYbMNrvgJlsSEPyVgvquQW+ZAcETruLWGra4Zn2dlpBJjsa13E8VZELedRQ6Nb8vQ2EIMwkEA45ArBS6TnpcqBVE+mwAK87qY687u/C5Yu2DtgrV9WIOPETcTCSWaJlLb0GFmAm/1vPJVV82Euit9FO9VFW6G7PE0VeAcunDQWULELyYgaNlcJHBOXNanuC5TpgQ2Duwy4mcHsTx0QumxcOLU7y4hfihu9La6Cb/C0WLG5m6/nV27r0W/b7xvlEpF0j0SsT/hLHQBWEgKuVhEd6lYR3yK4CUeXjWHFCbMvI9szj0jcDJXrRRXYRUYmT4rHd8dEYy4h+s8XH7/OrArjgntbt306DyxKHFwXN8y27Nto/TktQ7E8vNSo/xo09h7Din9ghvDIprKzwGHKFYb+kZxs1nokrg+zHDVSFkLy/onrknyuG51uBZGY9WgaGy1H4YLt27FxgKOLS2iA2kXLcPb7vIjFvI500bt1S62IUQwRXkyAl5bpwDfM2EmhBXCKWu6YfKCYsZxIwt6Y+ewnKznvpDMS+RVDaHg8JqXpzFITkc1UJf32lb/j0I5qkdMxPVMha5ftT7d37Rb1V73qnPT71RBYs08uXsaTB8RiwvzsBvtsqbkC9tcfLlt/GJdpi9dzRO6mlluMPzJ1KHwiBgj3i7vIsviQ7qbxWkevXgqdLl4SBcLdOm9CpdLHLZzgPHHderGNxA/4cx3MHD5g165Java4y6Sh6m9Z9u+DF1Wco6W5/HEHKR9LJSl28/9ASa6rHcbQRGHUcVm2NeFv036AP8Q0TaMbA614wsKxXicWlxTJxd//gE+Htdo +api: eJztGV1v2zbwrxDcS4LJltu1Xac3N3Y2r26SxU47wDEKWjpZXClSJak4hqH/PpCUbNmWnWTItpcESCKJ98H7PvJWWJO5wsEE9yCkigqOKFea8BDw1MMRqFDSTFPBcYBHQGSYoFhIFO1CKzQjCiIkOJrTO+AolFSDpKR9y295EARcaLjl44QqBDzKBOUaUYUIRxPCsoSgGIjOJUxP/FCkmeDAtfKBSLZskTAEpXwL5/62SmjVTqNTRHiEuNAIOJkxt4kzkuY8IihkudIgFRK5RiJGOgE0E/ftWz4CsG+TCvQ9uu6Pxqh7NUDiDuQdhcX0xCcZVS0tBFN+6ABbJKMtCUrvfWhVeO00+uF7DnJplk5vuVFZnEudgFGdJpSpttXKLccelvA9B6U/iGiJg5V9pRIiHMSEKfBwKLgGrs0ayTJGQ2IM4v+ljFVWWIUJpMSuMnYZ42CywnqZAQ6wmP0FocYezqTIQGoKymIIaamVUERKssQephpS9RQ6MQUW1QgpLSmf48LDQkYg91eMR8UkZ9pwVSEuCq8m7qQkOPWwpprB2uX+MKocCamvnaZwMTWYGZnDk7YrRVrbE+Ua5iCxh2MhU6Ldp59em/0zmlL9SFhl99iN9ZbEe0rd3luxRvwAsZDwFMyiUT9XZA4b/XgN/BqQDiPs25qVAj5W3d9g+aAG373Bu1lmnAD6BssqWPcyTdvqXBNtdbaPa5eOYHsYeJ4ab+t/7g5vuuN+D3v4vDsY2oebi48Xl18u7NPoqn82OB/0e3WXrBLloKQ4Mvz6hmThYbgjLLfheU4oy7fsWouB3T1v0FDs8I6Ln0lhMmIPYsqpQfv4LLouyaJoTbfOrRL4eXltyVVJ+9yCVXQPMBk0JLEmioNeRbD36eIhohckfaT1OUnhCYQ/g1TUpf6HslMTtzuH/kjVjC2HpjgzvPeJbKKr1z8bjAaXJpKqx6/j7odhH3t4OBj3r7vDr/0/r677oxLquj/sjt1jPfQ2IXkkCM02qxjUwAnXj7Wpg66ZtiniisOcz21e3C5MB1NFQ+ItXA1UmeDK5c3XnU6zxvd2hlwFQSq3DVKcM1RRatvO4tk7h6eWXC00YYOdQnYwigsPx1QqbUr9Z8JyUE8rqIz8U9xjJdUp9Ck19SDGrnp29/PAPl8qbL3C9soN7sb4WvqIaGhpmsJDNTc6Ls9LXX+p6y91/X+v6xKUPTk+RvUO9niw/bd9gimC24XmaHdQlRCL8ebJHYG9fLA5B6I2+iQkVPcOiEgbpHc0gghRbmWpugY0E9HyaOuQSTFjkP6430Js766LrhxkyRe5EoaIyUIGcOa4T67Pz9Avb97+PD1JtM5U4PuLxaIt47AFEdVCtoWc+zIOza+BO22jcQISUEqWaAaIRJF1aMLQpjgilUFIYxoiLaqsZDdj7Ozke6BvKcPjYG3JJd1zky66uR4gGgHXNF5SPt9nvX0DMhO5DmaM8G944xcPOWMXqTxNiaxn3BqDsnTnDzdcB/LIb+PxFXIkUCgisPd92tzblYyMECnlNDX54E2n4+GU3Lu3d52OzTbG4o+QhCO4zxjhrkLuiEM5Sjd+awVbX00+j2WEpHO6y3c7iksn7jmJXDS+bYrGrolBDdL4IUgpJBJhmEsJEVoklK3rYsW7vPN7ibWXWHuJtUOxVng4BZ2ICAc4E8q6DtEJDrBfVb7WegDhu9KHzb2qNM2QPZ7mkuEAr1zoFIHvrxKhdBGsMiF14d8Zu9wRSc3gwJrRLLsQq1yHiZCwxLHfN6FZqDd6O9OEX4mGBVm6fru8dt+Qft9532mkakAPUDTzCSehc8BaUqjImuhuJOuAH0O4MIdXBWEuqV6ODJpTzwyIBNnNjRXWjlHys9TNuwPCXvlwXrnL71/G1uImoV1vhh79e5JmLhw3t8z2bNtpPHltHLH5vNRpPtp0Dp5DGldMY1iPpuZzwDGIdUPfqTebtSmJm8NM1oOUDbFyfuKGJNPNqMONMDrrAUVnZ/wwWTm71QcL5lthIzoW1mhlvO2b38RCtWfcab/aj+2rgU1RoUjTnNs6xedoQXWCSM2dyqGbSV6MhmAa2WCFuVNYBTZ0K6jUEnrVNqHg4rUqT3Oqk3zWDkVazdrW/2dMzPyUUO6XLJR/1v10c9HrtoaDs/7FqN961e609b27pzHpIyW8tg/baDcNMk/shPF0V/jVpky/TEL/pUlomU803Gs/Y4RyEyXWJVZl5p/g/cyPK483J0mXvyd4tTJmuJGsKMxnuwccTKabdG/eCg8nQCIXOi7n4DNn5pY9Ihtwltu7ud0L1MKrMLphCJk+CjutlbKry9HYJMdy3puKyOBIsjCzYLLAATYZwLqdzbn22wozwue5zQPY0TQ/fwMxEv0o sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query decision instances (alpha)

+ Search for decision instances based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

    sort object[]
  • Array [
  • ]
    • page object
    filter object
+ -The decision instance search successful response. + -
Schema
    page object
    items object[]
  • Array [
  • ]
- -The decision 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha.api.mdx index 0f1190cf9d6..3810e8d691c 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha.api.mdx @@ -5,49 +5,234 @@ description: "Search for decision requirements based on given criteria." sidebar_label: "Query decision requirements (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/isE99ICvrUrhsBvbpIO2Zo0i93uwc4DLdE2W4pUScqOIei/7xxSshVbju1iwB7WNEht8twvn85RTh2bW9of0yseCSu0IoZ/z4ThCVfO0scWjbmNjEgd3NE+HXJmogWZaUPiJg4yZZbHBE7nYskVAVbHjWCdiZqofr+vtOMTNVoIS7iKUy2UI/CZKcJkumBkxpnLDIeDmAAtELGpDAIvWZKpmJFIZhZkWqIzR/SMuAUnU/0EGoac+2/jivSCPFwPR2Rwf0P0kpul4KvHV12WCtt2WkvbjQJhG47ahlu3d9Cu+DpJ/Mv3jJs1Xr2eKIzALDOgDiPhmJC24z2cKNqiGBLgfq/jNe3ntIxQTPszJi1v0UgrB+HCO5amUkQM49v9ajHIObXRgifM30r5aQb5yalbpxwSoKdfeeRARWp0yo0T3HoObby0kooZw9ZABMFP7DlyZoLLuCbIOiPUnBYtqk3Mzf4NFsiMZdKhVhvRomjV3B2XAqGOnHCSbyroLwzlEIx+CJGixSNypmzOzzLX6KRmE1QTn4OVLQrpSZgLR7++RfulSIQ7kdZ6Gwcz98zjvaA+t63YML7nIJKfw1k0xuceorGNT6tBXwPTYYb9XMvSwVPDXbX8Q63j/+Tro1H97R3dBZIR9CmzVswVdPc3vm6R1UIAsrAIQITBL8mUAE+IiEGLgDIyHnUcQkcj9HQwc00W3rGENxfurkFXt3dEAXUFK4f1ACpYEZr1WD296Hkp57jCJsduGjp1V5sr3RLxcR0ASUy5U6SiD4Ga3FwdE1yr06sGLz74MnyOAy/RN9V6EWDHplrZUKpve71QsbtmNz+2QuMSm0URt3aWSVJJ63hA/9cB+1ykc9oxebODHwe7DaIxE8Y6RNgvTGbcnodjkv0o70tIFgJ6DpQd5NgNz649R+z8CWz/K2CDXtaZifjpAasHq+ImOG2U2TycLbKCJKfMwBj8H4IqIsXzbjwKpVWvea53PwSffkAmMxiGwXlyC0NQNRsTBp+h55ZQ9TERqgqs1wnje7xGnEXNCXcLDdGiqba+UZlbwLdupbhdV9wNiilOXgZLziNpZiRw5AGUi363my9AVtHPU4C0orvE0l0y2EpgtfDtj9fB3WqUlTpichEs2A8CXtQrZGff+J05vmJrn/60HMy3oi96F71GqUh6QCJuMMFDL3T7uNmKXTiXNooNxKcILhBnLY8yWNrWQ2QL4ZlCkLkZZJiITRGX+rx0/B6I4CR8+FBhxR9/j3xe8VH5sF2Lrp9Ykkr+fA49CMO9lwBw208b8DpAj124pd52Zm3NCYvUeLMJbcnLBShsOY/bXSXsIL3NhtHb2R/GeQhrfTPAMwyKgD3Sx7Rs0v3s1L2ivc6bvRRjBvH5EekEeP1gouZkJRw8cmrZLrfmDkU7I46dDnpVCGBF9jHckC8leL/pYKWGdsJ8W+ilOUjOph1QVy3Lm/+nUk+7CROqW6qw3cvB7ee7q0H7483l9d3wug0SO+4pPPGxwROmanZ4JDoAMa/8C4LXu/7n29Hs58uJ015OlA3s+JPrphLShXXvk5yXaDumjWhLqzLGfT5g5pjmOUb1s5FFgcfeDDh/3EIsfgMNC87i0A/0G/Y0vQyJa4/QHiSHWRP7a3e+LloVxwCm89S9SPtYe4LcfxqOEJDKtzCJjpHHsBW+oYG/fTqBf9javpg81vnzHAZgNc98g9MgF3/+AZqLvSs= +api: eJztWFtv2zYU/isE99ICsuV2xVDoLU3SIVubtnHaPTh+OJaOLLYUqZKUHcPQfx8OKdmOLedSbNjDmockIs/98pGHa+5gbnky4WeYCiu0Yga/18JgicpZPo14hjY1onJCK57wMYJJC5Zrw7I+DjYDixnTis3FAhVLjXBoBAxv1I1KkkRphzfquhCWocoqLZRjwjJQbAKyKoDlCK42OH0Wp7qstCKhMYKRqwGkKVobe7rwe9BS22GZPWegMqa0Y6hgJoMRp1DWKgOWyto6NJbp2jGdM1cgm+nb4Y0aI/qvSUf6ml2dj6/ZyccLphdoFgKX02cxVMIOnNbSxmkgHEAlBgatO1gYdHzDMvvle41mRVvPbxRFLa+NK5Ci50BIO/RRuVE84hRGtO6NzlY8WfM2qhlPcpAWI55q5VA52oOqkiIFykn81VJi1tymBZbgd6X8kPNksuZuVSFPuJ59xdTxiFdGV2icQOs5tPHSWiowBlY84sJhaZ8iJxcosx1B1hmh5ryJuDYZmsMdKqocaulIq01500Q77k5agdOIO+EkbqruE4VyrI27CpHizZQ4K5jjk8w1utyxSSiHczQ84rk2Jbiw9OtLsl+KUrhH0lpv40nu7nh8ENS7tjUbxjeYa4NP4Wx64/MR5riNT9Sjr4fpOMNhrmXr4GPD3cHE1Q5K/ImrB6P62yu+Dz7XBTKwVswVZuwbriK2LERaMEidZWAZsFqJ7zUykaFyIhdoPFI5gpteuBpS5vosvIQS+wt336Cz95dMQYkdrBzXs0BjRWjWh+rpXs9bOQ8r7HPsoqdT97W51i2RPazDoQLlHiOVfAjU7OLsIcE7dXrW48VbX4Z3ceA++r5abwLs2EorG0r15WgUKnbf7P6jLjQus7U/l/Jask7a0AP6Pw7YT0U6px3Iiz38ONptTcRzYawjhP0Cskb7NByT8KO89yFZCOhToOwox3549u15wM6fwPa/AjaDVtcmxccHbDdYHTej20abzePZYkuwrAJjMfsPQZWQ4m43PgilXa95rlc/BJ/+gsxyEBKzIXuvDXZ3YwYGWWX0QmSYMaG6wHqdbKazFeEsaS7RFTrjCa+09Y0KruAJjzvFg13FcVDM6eZlqOQ8ktZG8oSvAyg3SRyvC21dk6wrbVwTL6h0F2AEjRa+/Wk7uNtdZaVOQRbBgsMg0MZuhezNG7+DwyWsfPqr9mK+Ff169HrUK5VIj0ikCSZ46IVuj5ut2MK5qldsIH6M4IZw1mJaG+FWY2IL4ZkhGDQnNSViU8StPi+dvgMRj9p/3nZY8cdf1z6vdFRebcei81soK4l376FHYXh0HwBu+2kDXkfoqQu31NvO3BlzwiA12UxCW/J2AApTznQ7q4QZZLSZMEZ788NkHcK6OxnQGgVFqFz7mLZNepidXa/4aPjiIMWUQTo/Ul2WtfIXEzVnS+EKBjvZbqfmISc7U6ROT9ZchQB2ZO/CDvvSgveLIVVqaCfKt03ieC5cUc+GqS67YXnzdyb1LC5BqLhVYePTk/efL89OBu8uTs8vx+eDF8PR0N2GE58avAS1Y4dHoiMQ88y/Ejzf93+9vZr9fND49x402qZ3eOviSoJQ1Cu+MNYtQk94L0LzrvTpDSDg7ISv15SJz0Y2DS17M3gymW5hmb6aiBcIWegh/o1wgJ+GZA+uyR4il7W/7u3fyZuo4zhJU6zcvbTTnVPn44fxNYFY+3JT6ox4DCzpVQeWPOEEBb74PDb6tTWXoOa1BwQeZNLP365C4us= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query decision requirements (alpha)

+ Search for decision requirements based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

    sort object[]
  • Array [
  • ]
    • page object
    filter object
+ -The decision requirements search successful response. + -
Schema
    page object
    items object[]
  • Array [
  • ]
- -The decision requirements search query failed. More details are provided in the response body. - -
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx index c4fda7854ce..659a18a4e4c 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx @@ -5,53 +5,318 @@ description: "Search for flow node instances based on given criteria." sidebar_label: "Query flow node instances (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWd132jYU/1d0tIe2Z2Do1nYdbzQhW7YmzQLtHkgehC2DWtvyJDmEw/H/vnslGxtsCHR7THfagaR7r3Q/fveDNTVsrulgSi8iuSSJDDi5TLRhic/pfYcGXPtKpEbIhA7omDPlL0goFQk3x0VxXJMZ0zwgMiFz8cATAoSGK8G8u+QuGQwGiTT8LpkshCY8CVIpEkPgM0sIi9IFIyFnJlMcFgLgbOAQm0WO4RmLsyRgxI8yDTw1kZkhMiRmwclMPoKEMef227Q8+p7cjsYTMry5JPKBqwfBl/cveywVumukjHTPdwe7sNRVXJvGQrek8+Lgh38yrla49eouse/PFIhTJOCGiUh79oV3Ce1QxeGsNh9ksKKDtf0qFA/oIGSR5h3qy8TwxOAeS9NI+Ay12/uqUcVrqv0Fjxl+2tb9RUPhRDtzFAJBNIuiTyEYc03NKuVAJGdfuY87qZIpV0ZwbWVIZeUXp5hSbAWHwFyx3T+WTyh4FNQYaaNEMqd5h0oVcNXcQYcKWRYZlKp9muedmoKmBUPwOyNMxDce9xcqfwyXvi2emt8jZcrm/KTrKhnX7gT+x+dwyw4Fg8bMuKWff8L7RyIW5sizzgzD0Gy9uKHU7bvlG8IPHFjyUyjzVv3cgDYq/XRa5LUQ7Sdo2joqHni0usFjr8FhSzz5k69aNbrt5xMI4m985aIb4KEJNN6OFd69QSuAbMAgfbqwgrAKK5B+UMQ5D0UikMPpQoIN7X4xcA3D22Nnl6092gGE5Kiv4dnk8suoQ84+Xd18HE1G5x0yGd1eXV4P4bOHrB3HYzhXardngXZjzpaIP8xBBHX6axaffIcEafD+ivMbZhbH0adwEvUCmgY/guBv2trIfV4G6JoyBeoNyGxFXvReoHyR+CIowLuQP4NkwlnSuMB4IZeaLBfcpol9QhbMJsCSL2B5ZEUaWRd3cuRs+ImQWEytrWhiVMZbPQ/yEkuMM3CTt9tFa3Z2Ab8GLhc7UX9hcWMbuPedbQOm3OUIncpEO1z5qd9vv+D+FKkzH+0eZhEpWXk2WR+djI8FvVNzkpGGRZc7SN+ebZyNQqG0wVz4hUUZ16dlnIh9L+2hnOMUekrS2Uuxq57d+zxxz+9NQd+dTv5DkmgFfmXOW8EfdqFm3rt3CJufhN6DuLo3aexPVIdx8ghYOwxMx0MPhtW26x4EnNIpLcWbE0CmaIssGxJCO8ADj1xBUVd2B4QpWwI8wLMRim2nUgIRNDDB6iAaASU0QvGPT7UIQ3LjThZyiYsKwrDuwIMzJ316e3FGfn3z9pf7lwtjUj3o9ZbLpadCv8sDYaTypJr34Cv+xXOvPAJPhzfEbEVm0KEFgXVtFpEq3ohOuS9C4bukah9sL4MGc+97Agr3FCcbd8iUaCS9Ifl8e0msO4lwBQRN0dtdxwxax8EsYsk3WjnGU9XEEDJIHDO1KpvObQFFLGRPYzh0DG1p+/fJ5IY4FsRH38IW09YMhSB8RAyAEmfQwYBvwjf26L696/dz5IkWP+IlCeGPKTzfutbuc8A54spvPResxTTg/7GMVGIuduV6W2FcOPG5e5ELx7dt4TjEwgmKC/RDrhSoTPp+pqCXhLoLorAs90rZRaP8HGvPsfYca/tiDTZj6Fkk5FqaSjtWSm1lQHtYRmDm625Gfj1XX1OcZagHrrSteDMFyqFrFzo5ePx6AYzywTqF0jPvPaBdHpgSON6zZsRtF2Kl60TSZ9HCiW+aEDewJSyftjPz+w3KkiVbWZWmxairYv2+/77f3i7C0T0ccYroXugcsAYKJVuM7vYe3R4+hnGO9bDmAGHCrMZI5tQzAyVzNcy26rNCnuVu6yt7CFbch4vSXf74e2ItjoB2W40mR48sTl04VpOd1nK5314M9/eVuv1NYVg5b8OZa/Vqc9WVqTXqTXVarVUVJnazOzVlv14x1gtW6wzTzeCyYlfMK91Q8r4aLbqRYX8zEOzvjPuma2ez+iAP13IbzaG0BitirWl6jAMIGucrfe91M67BPRCefBkDrc1RENtLYRaE1VypGIsjcEEi41jFgtzEqbE89tHtkC9OInntYRi4WC1T0xw4ZzMPxJXT8M3/Z5Gc9WImkl4hQvfOhlefr8+H3Y+XZ6Pr8agLHD3z6No+hI6YJbV7FOVxy+8GL+38/9Xu69dVjn7+5eGYXx6KKDP80fQg7QjbbFkDrwsMn9ImhtPSf3Hu7pB4StdrVOlnFeU5Lts7wPp9Bdz4DdgvOAtcINBvGHr0zNmsO8HL4PEos4377nQl75QUQ9/nqTl49r6WlG4+jScIc8XvKzE8BlYVW+JvL/DvgN7BfxjT1o8sgtr1NYVUPM9sZFPHF//8C1IvXOc= +api: eJztWd1z2zYS/1cwuIcmcxSppGmb8k215Tu3iePaSu5B1gNELkXUIMAAoGWNhv97ZwFSn5Qs5e7e4hnbErEfwH78drFcUstmhsZjeiXUnEiVArmWxjKZAJ0ENAWTaF5ariSN6T0wneQkU5pkK3LekBsyZQZSoiSZ8SeQJNHcguYsfJAPMo5jqSw8yFHODQGZlopLS7ghTJIxE2XOSAbMVhomr6JEFaWSIK2JgGmx6LEkAWMiR+f/9hpqExbpa8JkSqSyBCSbCr+JC1ZUMmUkEZWxoA1RlSUqIzYHMlXP4YO8B3Dfxi3pe3I3vB+Rwe01UU+gnzjMJ68iVnLTs0oJEyWesMdK3tNg7N6DXssXFuk/vlagF7j0+kE6m1Xa5qBJCpZxYUJnlQdJA6rhawXG/qbSBY2X7ivXkNI4Y8JAQBMlLUiLa6wsBU8YeiT6y6BbltQkORQMP23762rPScR4FzYKaUCZEJ8yGo+X1C5KoDFV078gwZVSqxK05WCcDqWd/oaKac0WNKDcQuHWT5WTcRDphiBjNZczWgdU6RT0/goGYcYqYVGrSWhdBxsGGjcCJwG13ApYRemfaPx7pe1dc9R6gpwlm8FZ29Wq2NgTlxZmoGlAM6ULZv2jH9/i/gUvuD2R1rthkNmtE+8ZdXtv9YrxN8iUhnM460773LIZrO0TdOjrYDrMsO9r0RzwZHMLNb9RKbQY9AcsOi26HeejHMgjLHx2c9MBTuGOF35+h14otUJYOV9Zw7hOq0dYHFVxCRmXHCWcryRd8R5WYyyz0J07u2IdaUCUBLTX4GJ0/WUYkItPH28/DEfDy4CMhncfr28Go+FliKK9xFMkr83uaOtg7c6OjD8ugaeb/DesOHsPEnlw/xrgltn8NP6S2Rzt8ggLQzD5931t1aEoIwZKppmFlEwX5IfoB9TPZcLTBrwb/VOlBDC5t4H7XM0NmefgysQhJTlzRbOVSzQIp9KqTXVnZ85KHs+Iw9SNJ4ZYXUFn5FmQTFrv4H3ZfhW9GewC/ga4XO1k/ZXDjW3gPkTbBUy1rxGmVNJ4XHnb73dv8HCJNJXrObJKkFZU6Ir1ycX4VNA7tyZZZZm43kH67mrjfZRxbSzWwi9MVGDOqziCfSvvsZrjDXpO0TnIsWue3f28sM9vLUHfXE7+iyLRCfzaXnaCfx1QkOnBtWPY/CL0HsXVg0XjcKE6jpMnwNpxYDodejCttkP3KOC0Qek43p0BMs1VyokhGeMC0pB8VBra2wFh2rUATzwFhGJ3U2mBiExVujiKRqVWUwHFP1+6IgzIrads9BKfFYRh34GEU699fHd1QX5999Mvk1e5taWJo2g+n4c6S3qQcqt0qPQs0lmCv0j3OiSjHDSQgi3IFAhLUxfaTJB1vhFTQsIznvii6g7sNoMO8+d7AQoPNCercKg03yt6A/L57pq4cOLZgsvZvurtW8dUVTaeCiYf6TowXuomBsRURcH0or10bitocqF6GcN/fNtZtv89Gt0SL4IkGFt4xXQ9Q6MID1FwyYuqoPG7fj+gBXv2337u92uUiR4/4SSSwHMpmHShtXscLkmxjtvQJ2szQfjfeEZpPuO7esOtNG6C+NKfyKfjT13pOMDGyYLGOAStlSYqSSqtISXznItV193qbi7K33Pte659z7VDuVYHtACbq5TGtFRurFS6zoBG2EZg5eutxoSR768pzjL0E2jjOt5KCxrTpU+dOo6iZa6MreNlqbStoyf0yxPTHMd7zo247FOsDR2hEiZyr37fhbiAV8L2aDszv38xC3O2cCYtm1HXWvT7/vt+93VRaXtAIk4R/Ql9AG6AQisWs7v7ju6ITxFcYz9sIKk0t4t7ZPPmmQLToAfVVn/W6HPSXX/liGjQfLhqw+X3/4ycxxHQ7tajyeEzK0qfjuvJTme73O9uhvuHWt3+qjFcB+9eMG/0q/tPfZu6wb3qTtfP1h0m3mZ3esr+Zse42bC6YBivBpdrcc280g8lJ+vRoh8Z9lcDwf7OuG+89D7bHOThs9plc6acw5pc23c95gFo42OlH77Zz+vbawdPiSqKSroaJWdkzm1O2EYoNWNxBC7BE8AuNl5S6c3Ykn3wK+SL10jehJgGPlfb0jTjNq+mYaKKdhq++j8VahoVjMuoUWGii8HHzzeXg96H64vhzf2w9ybsh/bZX/sQOgomN/bRtMcd7xpeuZcAr3dPv1zX6O9vK/5fbyuazLTwbKNSMO4uaC4olg3uj+k+7tM25nFW79F7TJdLdMNnLeoaH7s90Hg8WYM9fqsDmgNLffLQR0xXeuH93BvhZpBcVO6yvzuRqYOWY5AkUNqjtJONQnb76X6E0Ni8kylUijyazfF9DZvTmCIGuLhziOueLalgclY5JKBeJv78DeKXgqc= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query flow node instances (alpha)

+ Search for flow node instances based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

    sort object[]
  • Array [
  • ]
    • page object
    filter object
+ -The Flow node instance search successful response. + -
Schema
    page object
    items object[]
  • Array [
  • ]
- -The Flow node 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx index 0f25906416d..20b8484105c 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx @@ -5,62 +5,511 @@ description: "Search for incidents based on given criteria." sidebar_label: "Query incidents (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWltz27YS/isY9iWZ6mbFTXP0pki0q9aWVF3cTm2PBiIhCSlJsAAoWdXov59dgNSViuU2D2fmKE5iEVjsLhbfXrjCytF0qpzao9OKPO6zSDvPBcdnypM81lxETs3pMyq9GZkISXhKpMiYKuYTEZEpn7OIALlmktPSU/QU1Wq1SGj2FA1mXBEW+bHgkSbwmUaEBvGMkgmjOpEMBnwCtEBEx4Fl2KBhEvmUeEGigKciItFETIieMTIWLyChz5h5esxIP5Ge2x+QerdFxJzJOWeL53dlGnNV1EIEquxZwiIMFSVT+migmK0rhf53fyVMLnHq/VOEu54kEsRJ4jNNeaBKZodPkVNwJANapT8Lf+nUVuaRS+Y7tQkNFCs4nog02hTmaBwH3KNo0/IXhYZdOcqbsZCa2SDoTOAYVo5exgyMLsZfmKdBRCxFzKTmTJkVQhpuKRWVki6BCIwfqrfwmXAW+DuMlJY8mjrrgiOkz+TxDIJiQpNAo1TlOet1YWe7jylDwI7mOmAb1PyKpuyD0j1rKWf9jCtjOmVvUleKcEcnQBObgpYFB44npNoOfaii/gEPuT6TVhkd6xO9t+Mjo+7rtt4s/MyAJXvLynWufbpgja19CjnychadXnB81kG6wXPN/SdbvmrBj9fOYaAYgE9Spfg0Ak8GHgWymHGIHNSDgEHhL0kiDloTE0M4QEaaqKIxTGShpYQHA+p4TKkmm/CII/df/rlGKS/w3owZ6oaKCo9TDapqcY4KrRx/yZM3jsNoI5T75wpqRUrTyGPfYKc8ZXXWPpmUQg6MtNd2l6UIYtYQJCYLruGArXFBhGImVs9pAOAsAQcWJSHGh2G733UbrZuW24TRYfuXdue3NnxqdUb39W631b4dub1epwdDP3c+j9qdUc8d9FpuHwYanXazNWh12hsS9/dBr94YjB7qd0N3M9qo3925zZF759677cFmeNj+qd5umhkcGbkPMAvj926/X791R/3WH8Dj94brNo1yKZsmqNvfFbodQLH1PYVuOr17UHowuukM203nOTPsPZxHGuu+blvXmDS05KnfWIoxUybbWaPziIQQdNJcZE5wEohFW/jsXIAiPSRdn52Dzg3zfw/PHblvAagnmcmaAx6eYccmMEIEZixItry0q6QPVEWNDDGYa3h6nXNfp6z3VDzbAQCurQcXYde67dUHBmlQtXTuHszHrgsYb98a5HwR439hZlhtgy+fEPbClVaFXRsbfY+trCVjXapn50EoBkqCSfk45sw53UOYMjVe/tkrEjDqg5D8k4fSiUbawvpYBzuLGE6Lw+3awmFZs5NCsyB2Y7LifllySJOXbte28lGxiJTNltVKJV/DDUZsuUBU4qGtJklAMgYlU0Z+8zLxrfWVFpoGrYOq5STqMCxwqTTWdQ8G6G+rngL6T9d+rX6yBn1LAXVyxaF5DvV5Rc9LOXUppy7l1KWcupRT/+vl1DepnvLy4/9dOYXFw36Czi2ispRrKK/PLZxMQ45MwEOZXyL3W4cFa0gTqOdA76M3o+ZZcUXGwl9ihWVkXR3LGkY00TMh+d/MP12GAftxwMLvj8uxfW510rWUqXLElgOYqrPQY1R87N00yH+uf/jx+d1M61jVyuXFYlGSE6/IfK6FLAk5LcMj/kO69yUCVoGNhnRJxlAU+L5JoTQg20KDqJh5UAR49vCNVYwyeHa2zHylBjyRtDbgTiQ/Qm+dDHutrABZGugdit5vHY5FomvjgEZ/OlusvOYjdSidw5ACBlJs7gtIg07yevH6oZrrfz8NBl1iWRAPvWpTRqWCcBMhFC4hBh+ALTzRF/v0sVJZI0888TN2EkFUiWH7BlqH28nJRpl/f6OTAaxP+aHc0p5HpyBu2h1lnvrhGO83Qo65DwIurnNxnYvrnHSd62O8t4UGQyXRJetcXOfiOqdc54e8+rAFJpYIQsXknEn7Hndxo4sbXdwo141gMmTwkgOvfU4slIGOeTF1ypvbHGX7nuXgF9voVMq0jBMJNnFW1mPWAPTVDNava6tYSL0uz/E45lRyvLlhTg+nrWdliAmER4OZlXp8cjgR0ZBlOzq4znELb9wLurRdvfTew5b1p8qnSv7LNJCe4IgXROwOLe52YkHGFp06l60lPofxGhvKinlwsHrZx2XWPGMwMpP1ZK8rkMoz3PHZEsGI/XCToeTn3wbmoDGO9ba3TtwXGsbWC7df85t+c+VU2zdvApsCW2jmtVAre63Ng/7jfm9uB+M7rbSc0QP++50pp1qpXhevKsVKdVCt1ipXtepV6cPHyh/OpsW0bQJlLZ7KbudlK3Hb+di56GKv0jxu7sJsydMrMPaey/P2toq9hVLZ3DGpHNwgeVzZk9+9G4JjaxMKJsIce+qoxwBCbwLXs4irlK6OgwKADGObJ0JYaxIcBIa0Ybbll96bwqgHWZBhuwXkop/tiL2zM+TBSiRXJXQm6/FZXpsC52RcAnHZdanN73EgxuWQ8qicilDlRv1+2G7Wi3ethtvuu0XgWNIv9tsXjDshjXb0MO2gnetk78y1sPeHe15t0/rlGtrpa2hpLNHsRZchP3HT8TKHuUqD/aOzsZmTQRRva9mQ/eisVmjJoQzWaxw2omH8eRvh8Qm4zhj1LdZtmHEa9oCKJjAgeZCYr8gOv8dcF7IVdc9jsf4q7fNO0up2+vj1wji9YxdC5IBRSRcwiP/XnCf4Qbc1oDGh1oyvHEjV08TGJMsX//wXsoQNgg== +api: eJztWm1z2zYS/isY3JdkjqJkx2lSflMk2mVrSzpJdjuVPRqIXIpISIABQMs6jf77DQBS747l1h9upvJMHJNc7C4Wz75wuQusyFRib4QDFtIImMIPDo5AhoLminKGPTwAIsIExVwgWhJJNCESIsQZmtJHYCgUVIGgxL1n98zzPMYV3LNhQiUCFuWcMoWoRIShEUnzhKAYiCoEPLyrhzzLOdNM60BEOq+RMAQp64bO/q6V1NLNoveIsAgxrhAwMkmtEi2SFSwiKEwLqUBIxAuFeIxUAmjCn9x7NgAwV6OK9DPq+4MhavYCxB9BPFKYPbyrk5zKmuI8lfXQEtZITmsCpNq7UavWuVn0r+8FiLl+9P6eaUvFhVAJCBSBIjSVrrHKPcMOFvC9AKm+8GiOvYW5pAIi7MUkleDgkDOlz8FbYJLnKQ2JPof6V6kPY4FlmEBGzNM07cbYGy2wmueAPcwnXyFU2MG54DkIRUGaFVwYbiUVEYLMsYOpgky+hk9MIY02GEklKJvipYO5iEDsP9FAikmRKi1Vhni5dDa2OyoZPjhYUZXCCmn/0aYccKH61lJ4+aBX5mQKr1JX8GxDJ8oUTEFgB8dcZETZWx/Otf4pzag6klYaHZux2trxnlG3dVuuFn6BmAt4zcrlQfv0yBTW9nEOyDuw6PkF+2edlhs81tzfYP6iBX+6wLvBZZgAIlLSKYMIfYO5g2YJDRNEQiURkYiggtHvBSATd2hMQZhIpHRoqcKRqw8mF1zHjTbElFHN/be/rlHJC0UrZlo3rSgPKVEQIcWPUSE44C+H5E3yjK2E0uhYQQGTirAQ3mCntGR11D5BCC6GRtpLu6vSCjJrkCZGM6oSRKxxIUISTKx+JGkB0sUOBlZkOj7cdgY9vxVcBn4bO/i281un+3sHOzjojm+avV7QuRr7/X63jx38a/fLuNMd9/1hP/AH2MGtbqcdDINuZ0Xi/zHsN1vD8V3z+tZf3W01r6/99ti/9m/8znB1+7bzS7PTNk/0nbF/53eG2ME3/mDQvPLHg+BPf+z/0fL9tlGuZNP2W8FgU+j6hhbb3FLostu/GXe6w/Fl97bTxg+VYW9AyjLW/di2vjFpZslLv7EUE5Am21mjU4YyLqDMReYE45TPOjyCYwGq6RHjERyDzhXzvw/PDbmvAWgowGTNIc2OsGObKNAIrFigarm7qWREFNSUZqiDuSLqCM4DVbLeUvFoB2i2hsGdr2EXXPWbQ4O0vj/oXt+ZP3t+px10rgxyvvLJ3zDzVz6xwZfGCJ6oVNLZtLHRd9/KSgD0iEqOg1BOVIJ0Ut6POY+UbCFMmhrv8NlLlAKJKJsePnkFjDBlYb2vg32qMVwWh+u1zm5Zs5FCqyB2abLidlmyS3Mo3S5t5SNzzqTNlueNxmENVxix5QKShamG4yJFFQPXlJFvXia+tr5SXJE02KlankWdDgtUSKXrujsD9NdVTyn5q2t/VD9Zg76mgHp2xa55dvV5Qc9TOXUqp07l1KmcOpVT/+/l1JtUT4fy4z+unNLFw3aCPlhEVSnXUF4cWziZhhyKCU0hctHN2mElIsIE6kcaQaS9WWteFVdowqO5rrCMrLN9WbeMFCrhgv4XoufLsFzwSQrZv/fLsW1uTdSzlKVyyJYDOlVXoceoOOpfttDPFx8/PbxLlMqlV6/PZjNXxGENIqq4cLmY1kUc6n+a7r2LhgkIQBmZowkgEkUmhZIUrQsNJHMIaUxDe/jGKkYZfXa2zHyhBnwmaa3AXQi6h94muu0HVQEyN9DbFb3dOpzwQnmTlLBveI2Vl3ykiWSRZUTMK2xuCyiDTvFy8frh/KD//TIc9pBlgULtVasyqhSkN5FRRjMdfC4aDQdn5Mle/dRoLDVPfeJH7IQheMpTwgy0drdzIBtV/v1GJ8MFndJdue6WR5cgbtsdVZ76YR/vl1xMaBTBD95gTq5zcp1/vOtc7OO9wxWKecFOWefkOifXec51Ph6qDwOmQGgQShCPIOx73MmNTm50cqODbrR0cAYq4RH2cM6lgY55McX11QRI3b5nYf1hWzuVNC3jQqTYwwvrMUuvXl8kXKqlt8i5UMv6oz6ORyKontwwp6cfW8+qEJPykKSJlbp/cvoBIxlUO9oZ57giCmZkbrt65dzDmvXnxufG4ZdpLtQzHPWAiN2hxd1GLKjYaqc+yNYSH8N4qRvKEsJCUDUf6GXWPBMgAkSz2OoKlPIMd31tibBT/nFZoeTX34fmoHUc66+nTvwnkuXWC9ef+U2/ufFc2/fQA90UWEPzUAu1sdXafLapt92l20D7RlPtwN0dSds9KnzeOL+oNT7Vzn8enn30Pp5555/dxqezP/Gq2bRuB1XNnsZmD2Ytcd0D2Rh5sUM1o9VUzJq8HIaxEy8P67kVO4/SWE2bNHZmSUYLi4HNKRF9b2mCQswNAEqX3YeS9isQ0mKv4Z7th4deYKJcyLOsYCbVsWnVOlvzKyeodPxLaQi68eItsPa4DbHX9gm6sxLRmavdyvp+leGmVCXFxA15Vg1Orf6fpHxSzwhl9VKErLeaN7eddrN2HbT8zsCvnbkNVz3Z7zA6AmWEbehhGkMbw2jvzJTY+909L9YJ/jTE9rZDbGUkUvCk6nlKqOmXGQAsylQxwis74wrWetbLBvwRXiy09W9Fulzq20Y09kYP6/ygr5YOToBE1j9skMIte6g1E1Y0eVqYD2y7X0GXTrWiGYaQqx/SPmykvF53oD9OTMoJvYxHeo0gMz29R2bYw9rNDchMkDb3FjglbFrYGGZ56p//AVb1Nmo= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query incidents (alpha)

+ - + Search for incidents based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

    sort object[]
  • Array [
  • ]
    • page object
    filter object
+ -The incident search successful response. + -
Schema
    page object
    items object[]
  • Array [
  • ]
- -The incident search query failed. More details are provided in the response body. - -
- -Unauthorized - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Internal server error - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
+ diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx index 4d69bf8894f..024ebcd1ce5 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx @@ -5,53 +5,385 @@ description: "Search for process instances based on given criteria." sidebar_label: "Query process instances (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWW1z4jgS/isq35eZuvCSbHZvlm8eIDu+SYADkq07Qk3JtgzatS2vJIdQFP/9WpKNDTZvV1P3aTKViSW1WlK/PN1qbSyJF8LqzKwRZx4RAtFYSBx7xJrfWD4RHqeJpCy2OtaEYO4tUcA4Sg6IBXKxID5iMVrQNxIjmCYJp7j5Gr/GnU4nZpK8xtMlFYjEfsJoLBF84xjhMFliFBAsU06gw0dAC0TYDQ3DLo7S2MfIC1MBPAViqUQsQHJJkMveYYUJIbo1y0k/oXF/MkX2yEHsjfA3SlbzDy2cUNGQjIWi5RnCBnQ1OBGy0tHI5zUj/29/pYSv1dDH11idPkg5LMeRTySmoWjqE77G1o3FCdAK+Zn5a6uz0U3KiW91AhwKcmN5LJYklmoMJ0lIPaxk2/pDKAFvLOEtSYT1aBgOA1DLxpLrhIDwmfsH8SQsAaJPCJeUCD2Dcc0to8Kc4zUQgfAjcQ2fgJLQLzESktN4YW1vLMZ9wqsjyjgCnIZSrSo8a7u9KR13ljEEG5JUhmRnPf9SopzApsdGUtZ2rmYmeEGu2i5nUWlPYE1kAbu8sUA9EZam66c7tf+QRlReSCv0Hu1A7p24ItT9vW13Ez8TYEmumbmtlc8IpFHI56ZmvZpJxydUdR1mB7xU3DyNY6X04gQuuBHBsRIa9iS4fP0YjT3qg8GL+uGAxlQsiV8/6rEoCYk8OqyAJzw2ygnYKRGPJJD1BIRzxp8AxDLTqxi+PheVa6feLwD4uOxhWTO5ZFo+EDQkjYheMvavm+AmUZzhct0uDgF6qhARpuzg2ek1FZus2SNK3or2BWCUGsi5wCveMAC5G17loDGO6qX6hsOUiAt8JJ9SNvdcFlnUeck29qANuoQoIDksveUQNqQB9ogKE8zBNg+YfiXrs3L55V5NByTHsazlfXzPlb0eJ61z7q3BWZGwWBgx3rXb6k/VEvKAnrNDWfwWqaf6gzREOaOmDl7fPThdi+qSSRw6B3ZwSgMB5UKqaPJyqVWVMDTE/+vcU6htBHoNbB+dcSiew/2c2efh9D8vNuwKXgxqvbkOfnLkUf7/PbDnDALunPhyrzX0DyFbDZhPrvf6/wfuwxr15CROI5Vd2d2p89KHDmfQdXr9wRQ+u8On0WN/2u+pb3vQ7T/qz+fB18Hw94H+moz6XefBgf55KTjXx8clFraO7DsUraerKPi7ACiAHGMy184REpbv7KRX7BspKo5z1t/qV70otJiO4wqE+8nw8aX/raw/rbNvo/Gw259MYGQyVT0w0usrvdaN2L3etxd77NifH1XzedSzgbDU8zTsOQ//PsG0BxYxcYYD+HhwBs4UPqsr7o09Ob+N7brtzC+x3En3S7/3bEzzcdj9qj8mRgIPtmMGClOeX5Kp7RLFa7ysBMeFMsFm9IgHIesLhV6A6fXlxnV4h4YAGxCAG/gqE541vNNmX/G4S+nqYfxEBjLOt58J5jjlWYLakKcn3F+bwGgmKICrN/Gb6AmuXPlNHAG2qxD0BrjmgxZ0VSBPcpALt/KTmQ7MhGwy+ns149nfnK22piizdZHRI8IiU7NrVp+NH7ro1/uf/zH/sJQyEZ1Wa7VaNXngNYhPJeNNxhctaKpfRfexieDgcIYIr5FLEPZ9rTgcosJCkEiIRwPqIcn0AbNtI6VWc74zadYRbNp5ScppJbjb6HnsIB0vaLCGCdWl92sCLktlxw1x/KdVWMW5FMKG7DSKMKg3K/DsL5ABTHo+P4TsoS49+TKdjpBhgTwI/7qYJVVVKltIHSICd4kUWoFlQgu/m9Yv7fZW8VQav+AkMSLvCRxfm9bhccA4osJum+aqnNXdvo9mGKcLerhu89DZVWfPnMg44891zghnUVLmyg41GCPmeSnnYOWrJXhhnvXla2dVsB++9sPXfvjaMV+DwYjIJYPYbSVMaNPBcgmtVuZOjV11vWXqi5YqNPI3uEDpy3TKQTbWxnjOFgx+swQ+284mgVvttvWm1JLXbrQW1bDxsNxyQgaZztKsXtWgGlAXufxkB+X13yCZWuG1ueZldeiC9af2p3b9FRFIj3BUBXtzQmN/JUzI2SrnrmVriC9hvFVXbUEAwahcT9Q0Ix4XhEy4nSol7OwiW09z1zcfTQQ95uMht5Z//j7VCld4Ni5eAfrvWOWm+2XXXTlV8pQUBVTTKpVMTUdRJDXtUlk069gVQk17r/RpuvZT6MLYyzXOord0xbXu2nf3jdt2o303vbvrtG87d7fNn+5//Y9VutaeIjq4wBeLHC8MtPdLjqaUWEzMK4izvKu+3lda6WiZr12+g5Zru9qaZ7tnkYJX9hpinjzmxcOFeZBo754b2gePCbONMbryM4Hq22o0Cpi2uAwrqrarTp1Lx2o3b6u4BPat4BVsA+bqGAvYtKJyiXDJF7InNAW8EIiJysELAedkj2YEZfpAt03lxwZs8tC6AM6p24Tl8pez3V83ZG4rwjRuZUuIVtd+eh707Maj0+0PJv0GcGzKd1MSU9AX4bi0D5PeV18YP+iXwo+HZ98UGcaPF8rzL5QZrEnyLlsQMqmu4WjlbrL4M7Mq8cfKTVc96JkoMrM2GyXRZx5ut6pbbwH652XvnSnfXBLsGx8wNUiraxTWmKq9ZA6tfOqw6Ly9yWfYnkcSeZJ2Xoqno+FE1RPc7Bk2guwDejleqSda+L9jvcI/5c7Jrnyk+zcWZBGL1KCk4at+/guPmbOl +api: eJztWW1z4jgS/isq3ZeZOt6SndmZ9TcGyI5vEuCAZGuXUClht0G7suSV5BCK4r9fSbKxAZPA1dx9mlQlsaRWq9UvT0utDdZkobA3xUMpAlAKUa404QHgWQ2HoAJJE00Fxx4eA5HBEkVCouSAWKE5URAiwdGCPgNHgaQaJCWNR/7IPc/jQsMjnyypQsDDRFCuEVWIcDQlLFkSFAHRqYTZu2Yg4kRw4Fo1gUi2rpPArNW0dO5vPaNWjTh8jwgPERcaASdz5oTokDjlIUEBS5UGqZBINRIR0ktAc/HSeORjANua5qSf0ag3nqD20EfiGeQzhdXsXZMkVNW1EEw1A0dYJwmtS1D6qKOez2vE4T/+TkGuzdD7R240FqVSL0GiEDShTDWsVh45rmEJf6eg9BcRrrG3sU0qIcReRJiCGg4E18C1GSNJwmhAjD2afypjlA1WwRJiYkcZG0TYm26wXieAPSzmf0KgcQ0nUiQgNQVlZwhpuWVUREqyxjVMNcTqEj4RBRaWGCktKV/gbQ0LGYI8HjEOFZGUabOqCvB2Wyttd5oxnNWwpprBzuP+bVQ5FlKPnKbwdmZmJmQBF4krRVySiXINC5C4hiMhY6Jd10/XRn5GY6rPpFVWxnak93Z8pNR92ba7iV8gEhIumbmt1M+QLKDQT61ivYpJpycc25plGzxX3TLl3Bi92MFcCAaEG6WRQNNnqB6jPKChCf/q4YhyqpYQVo8a8GCgTw4bsGKnRiVoSUHdQqSrCUBKIe9Aqcz1jhzf7ovqtV8dF0oTqbtEV0wuuVZINNQ1jcEuycPLJsyTmGdYXiXFIahPDCImMd9But9tGDZZswtG34b2AaSiDnLOiIpnIqlB40s8hpO4WqvPhKWgzoiRfErZ3XNdZJnqIRPsxjp0CVFqeE50sBwkIC3AnjBhQiRwfcD0G6zf1MvPH8x0DZxwXcn7tMxHsp4mrQrurcNZlQiunBqvWy3z79gT8kNAzg5lOV+lNgdHKUM5o4ZNXt89OV2K6lpowvwDP3jNAhGVSpts8nCuV5UwlJH/du5rqO0Ueglsn5xxqJ5Ded6Q83D6X2c79hFe9CujuQp+cuQx8f89sOcNBNwF8flR6+hvmFj1RQiXR/3/A/eVPkEOPI3N6ardmfgPPVzDfr/jd3v9Ca7hzuBueNub9Lrmu93v9G7t533/W3/wW99+jYe9jn/j97p4VkrO1flxSVTbZvYdilbTHRn4uwBoDUshdG6dEyQil+zVqNh3UlRs5814q171rNTiOk4bcNQbD24fek9l+1mbPQ1Hg05vPH7y++OJ6cE13O0Zu1aNtLvdp4f2yG9/uTXN+2G3PemVe+4GXf/m91eYdnsdf+wP+k/d3o3f9yf+oH+84t7Ynf/rqF0lzuwczx13vva69841bwedb/Zj7DRw0/bdQOHKs3NOaruD4iVRVoLjwpgaYjsSEMa+UpAGptfnO9fhvRtJiECC+SoTvul4r7v9UcSdS1cN46+cQEa5+JliTlO+SVCZ8uyED5ceYCwTFBHKIGygOyEhv4kjIm0KeqYhhIhyWxXIDzloLsL1qyedRIo5g/ifxyeefeHaRjRDma2LnB0RUZmZ52716eimg3758PHT7N1S60R5zeZqtWrIKKhDSLWQDSEXTRkF5tfQvW+gyRIkoJis0RwQCUNrOMJQ4SFIJRDQiAZIC7vBTGxkzOr298Yx6wQ27aIklfQoubfR/chHNl/QaE354njp/ZrAXKTamzPC/8KFV7x1hGgjlcYxkeu8wLO/QAYw6dvnw5+uK48nXyeTIXIsUCBCsAUwbSpZ2UJmEzHlNDZo9aHVquGYvLjWz63W1vA0Fj9jJxzBS8IIt651uB3KUVz4bcNdlbNa3fexjJB0QQ/XbRwGu+nsuh25YPxYFYxtjoyWpfFDC8ZIBEEqJYRotaRsd+rL186qYD9i7Ues/Yi1U7G2reEY9FKE2MOJUNZ1iF5iDzezcKrvKvJNV1/EptAon0Eqe5lOJcMe3rjI2XrN5mYplN56m0RIvW0+G7PktRtrRTPsIiz3HCYCwpZu9WMLmgFzkct3dlBe/5VoWJG1u+ZldeiC9efW51b1FVFIfYKjKdi7HTr/K2FCztYEdyVbR3wO4625aisIUkn1emymOfXMgUiQ7dQYYecX2XqWu735WCJcyz5ucm/5128Ta3CDZ6PiFaD3QszZdL/suiunaplCUUB1rVLJ1HUURVLXLpVFs45dIdS190qfrmv/CF04e7nGWfSWrrj4unX9od76VL/+ZXL10ft45V1/brQ+Xf2BS9fa14gOLvDFIqcLA639kqMrJRYT8wriNO+qrveVVjpZ5muV76Dl2q715unuWaTglb2GuCePWfFw4R4kWrvnhtbBY8J045yu/Exg+rYWjSJhPS7DimPfNbvOtYNbjatjXBr6Fl4DEccptzmWL9CK6iUipVjIntAM8DIagDmDFwrOyW7dCMrsga4aJo4d2OSpdUH1Mp03AhHnL2e7/3Mm5s2YUN7MllDNTvvuvt9t12/9Tq8/7tWvGq2GfnElMQN9MeElOdzx/vhV8p19Lnx/uPdNccL48ar5v3nVzKBQw4tuJoxQW/exDrHJctYUH+UsnLu7eQR0mWeKNxtjhXvJtlvTbUXA3nRWjvipieclkNDFjatb4o4zcn1iZMlAwMThYaF6W8tntIMAEv0q7ayUg4eDsalBzLOn21iEZo4kK/OsS1bYwyb8k125yfZtMCN8kTpUdTzNz38AfejZjw== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query process instances (alpha)

+ Search for process instances based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

    sort object[]
  • Array [
  • ]
    • page object
    filter object
    variable object
+ -The Process Instance Search successful response. + -
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. - -
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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx index 67590b5a46e..f88215d54e7 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx @@ -5,54 +5,314 @@ description: "Search for user tasks based on given criteria." sidebar_label: "Query user tasks (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWUtz2zYQ/isY9JJM9WBSO011U/xI3Obh2nJ6kHWASFBCQgIsAErWaPTfuwuQIiXRstTJTC52xg4J7C6wr2+x4JJaNjG0N6R3hmtimflORy0acRNqkVmhJO3RW850OCWx0iQvqQwZM8MjoiSZiBmXBOgt14J17uW97PV6Ull+LwdTYQiXUaaEtASemSQsyaaMxJzZXHMYiAjQAhEbJ17gGUtzGTESJrkBmYao3BIVEzvlZKweYIVbzt3bsCR9S24ubgekf31F1IzrmeDz0Ysuy4RpW6US0w09YRuG2pobuzPQLvk6afTLvznXC5x6eS9R7TjXsJwmEbdMJKbjNLyXtEU1B1pj36loQXtL9yo0j2gvZonhLRoqabm0OMeyLBEhQ6N2vxm07JKacMpT5maT5EsMjlhSu8g4WF2Nv/HQwhKZVhnXVnDjOJR20goqpjVbABEYPzXHyIkFT6KaIGO1kBO6alGlI653ZzAqYpYnFlc1IV2tWjV1h4VACB4rbMLXYfM3mvIWNn3jLUVXI+TM2IQftV2t0tqeIJr4BHbZouCelFk/9Ntr3H8iUmEPpDVuj/3Ybmi8Y9TNva3WjO84iOTHcK4a7XMN1qjs02pYr4GpzrCZsOtcJn6bxMUzKWK1Q7cX2I2NpDDIY3I9xeESv/PFkx55c+I8YpnljXHJjBETyZsnecJTyLOr5pAOAWVEBILfa5Vn+0lQyUYK0CjkxpzzWEiBFvnrYKUK1isJ2smQH84I2MFQK3PYjh5Rf8YAmAFdzeGRuu1AydJmw89YkjfN1GIWLTqAqPlabOPSBc86fJtIt0l2KZoSYeUxyWRKGr/t10GwG8YDqBz5doqYPERbxnlCSgkdh/A/HMGPhT6rLEuutty0L2hioY1FyP2KvjnC6Wi+hP1f3n3Q5g16DLbVOA4Et8JpT2LRtgJHZsJPhrJy9mgoeRQDH9O/lsmPgeMBrIdi1M9AVxw5woCau9Q/b/RqjQMN1bYCABO5VJol/Hi+WCWJmt9lx3FFOT+OYX+B4Q+AwpIll8B7w2OuOdj3MPd9hYO78BB5wDkshJO+Sj9wBkfPxhxkUeTEsuR6ExwbAk4o6EWavbpbCEpybDBYVRY6BCenYoLHfmw1XJ1zT7XBkhlBJwXF0xwOqQE8swf//CoIaufm06CpkiG0N1fBRkB0lCcH1zWPjjG0LTzqkE9wXC27GMI0aqBmIoK+S0inUQmj0GhFi70FEDihlqe/7hbCzV31ybWnLNYl3qeEGeIJx3714c3lGfnj5PT30YuptZnpdbvz+byj47DNwfdKd5SedOEVf5HupfMR6JCyBRlDJ7kOEVIhNjEZD0UsQmJV4TK/GQwNr98T1dfN7kmnXIudwOqTu5srAnaVVsQLYNhderOfGkOL2xsnTH6nVRw0dWCbq5g8TZlelM3x5gJFBcqfPjZADjalxofB4Jp4ESRUEXc3ABY7+mKhjbA/CeqB/yYIEI6cxw/QRBL+kIH6LrS21YHgSKu4dYqJAut/kGcgiSdie93OxuGkCOJzr5HPwtOmLARd0MoIm4RrDSZTYZhr6JLJfApZSAqoLNcue6jnXHvOtedceyTXYDLldqrg7EgzZVzoMDuFty5WvLa7kuz6kkfxdkbP3EECmqtcg1Ho0qfMCiJ9OQUBq94ygy5n1Z2hPzYaZJz2qVWGTKJClkz9sruuwwlsj0uVtu4k38Nxa84WzpRZcXlXiX4bvA2azyVA+ohEvOX0GvrAq4FBKRazulGsJz5E8ApbL8MBuuCAc4ts3jxjMDLX/Rytvw6IYj0nHd89EYz4h8syTP78Z+A8jUB2U12dXjwwPCVv3j25RitYt1FV0FXdUzVWa5qqwe2Wp2HGNzTVRHMbEjQ3GcHG+XmPkM1t1aJtWN6s1Gfdhcr6SDtCF7u4Ga5vbSvq4rLW38iOqntVf18arG9Dg627zuHSu7d+i4ljK5fwsXK+LdJxN0pwm+X5ngadV7upD5GECAbdD/C6MgbpPxd2CofsSl5xw4/YBrWO4/l2fde0XvajnyFFR0FedTBjfFqX1WsCkvNxB5YrL/bX/48TNe6mTMhusYTpnvU/3X0+77c/Xp1dfL69aIPEjn3wlxGILimTtX2483f9y8cL9wXj5bbSy6p6P38y2fPJpIAMC81lF+qQkAhizp3LAtSHtAJ1WkYpflrw0DykyyWa8k4nqxUOu7VhfFTlFr6B2KnrKF3qODihZ95F7QFuokq2nZu9Vavk6Ichz+xe2lGtOl1/uR0g7hUfhFKo5TCq2Rw/FsHfHr2Hf5i5LmwcpLrxJYWaPMld/lIvF3/+A/q1lAY= +api: eJztWUtz2zYQ/isY9BJPJZJJkzblTXUeddukri2nB1kHiFyKSECABUDLGg3/e2cBUqQk2pE6menFnrEtEbt47H77LXa5oZYtDY1n9MaAJpaZL3Q+oimYRPPSciVpTK+B6SQnmdKkaqUMWTADKVGSLPkdSJJobkFzFtzKWxnHsVQWbuU054aATEvFpSXcECbJjIkyZyQDZisN82dhoopSSZDWhMC0WI9ZkoAxoZPzf8eNtAmK9IwwmRKpLAHJFsJv4pwVlUwZSURlLGhDVGWJyojNgSzUfXArrwHct1kr+ppcvb2eksnlBVF3oO84rObPQlZyM7ZKCRMmXnDMSj7WYOzBg3GrFxTpd/9UoNc4dHYr0VRZpW0OmqRgGRcmcFa5lXRENfxTgbG/qHRN4437yjWkNM6YMDCiiZIWpMUxVpaCJwwdEX426I0NNUkOBXOjQvyZ0Xi2oXZdAo2pWnyGxNIRLbUqQVsOxmko7WZrpJjWbE1HlFsozCnzZBxE2pvIWM3lktYjqnQK+nAEkZSxSlhc1SS0rke9486aCecjarkVsIXaX2jKa6XtlbcUreeoWbIlnLRdrYrenri0sARNRzRTumDWP/rhBe5f8ILbI2WN2+MkszsnPjDq7t7qreIvkCkNp2jWg/a5ZEvo7DMaWG9Aqa+wG+Tb+Cd+m8ThmTRYDej+AofYEI1BHprXSxw/4xdYf9UjP750HrHMwiAumTF8KWF4EAQUIO3FMKQTJlOeMgvvtarKx0XwkIMSpVZIZW8g45KjRX4/+lCN6oU0lskEjle0IBmeyhy3oweOf8c0R3Y1xyN134GSFcOGv2OiGhrpYRYtOmXmy6dmG+8ceLbwHRLdFzmUGAqE2nOSKZU0ftsvougQxtMcuuTXhoipXKLKKkHaGQLH8N+cwU+lPqssExd7bnoMNBnXxiLlfkLfnOB0NJ9g/1X3MWrzBj2F23oaR5Jb47SvctH+AU6MhP+ZytrRk6nkQQ586Py9SH6IHI9QPZaj/g92xScnGFCDC/03g17taaChxpYX4LRUUQo4XS9TQqjVTXmaVlrBaQqPJxi4t6AlE++ULq4gAw0yGQbtgfs+gTbcU+QR97CkMlYVvwJLQQ/GIEtTNy0Tl7vkOAA4rjS3w149TAStOBYYrEsLAcHBnC/x2o+lhstz7lPvYauMpFNwyYuqoHE0ogW795+fR1Hv3vwqGspkSO3DWXCQEJ3ky6PzmmfHjHEBaUA+KA1tFUOYxhOoO55CSrh0J2pplCxUun40AZZaLQQU3x8mwt1dTcill2zWJd6nhBniBRd+9dnVu3Py88tXP82f5daWJg7D1WoV6CwZQ8qt0oHSy1BnCf6i3JnzkQZSsDVZAOkgQjrGJqaEhGc8IVY1LvObQWj4830l+7rRR8Kp0vwAWBNyc3VBeArS8mzN5fJw6d16aqEqGy8Ek19oh4OhCmx3FVMVBdPrtjjeXaDJQNXXrw0/vBgMjV+n00vipyCJSsF1DSx2AZqFdmD/MuoD/8coQjpyHj/iJJLAfSmYdNDaPw6XpOhw6w7GG67/Rp5Rmi/5/rrBzuWkAfEbfyIfha+GonAiCVoZaZOA1koTlSSV1pCSVc6Fmx6psl27raGeYu0p1p5i7YFYq0e0AJurlMa0VMZBh9mcxjTEjDd2bczQpzyK3Rl95y4Ssw2ttKAx3fiQqeMw3OTK2DrelErbOrxDf+wUyDjsQ6uFjFAJE7lf9tB1OIDlcXukvZ7ke2ZhxdbOlGXTvOumfh29jobvJUrbB2bELqc/oQdejwzaaTGqB6f1wsdMXGPpZSCp8IJzjWrePAtgGvSkQutvAdGs52bH716IjpoP71qY/Pb31Hkaieyqa52+vWd4S97tPblCK9qWUR3ouuqpe9YrmrqH+yXPwIgvaLqB4TIkGi4yop378yOT7G6rh7ZZ21npj7qGyvZKO0cXO9zMtl3bTrpp1vqO7Lzrq/p+abTthkZ7vc7Zxru338XEZ7UL+Ew53zbheIgS3GZ7v6dR8Pww9C8vHIMlqigq6dKYXJIVtzlhPdQ1HX7kNsETwPvttte0XfYPP0KaioI8DzBifFi32WvJbV4tgkQVbWN/+38h1CIsGJdhs4QJzycfbj6+mYz/uDh/+/H67fh5EAX23jcjkF0KJnv7cPfv/tuSZ+41xtn+oTdd9n56zfKNX7M0NGPh3oalYFwi8TkIbJpEMKNdIqAtsvF1hKfzGd1s0Pw3WtQ1PnZr03g27+IRv9Ujmrsq1IWboyB67t06nuImugA96AbWo1ZjkiRQ2kdl572Mdvnn9RS5snmJVKgUdTRb4QsmtqIxxUh3MHMU7J5tqGByWbl4p35O/PkX+6C5xg== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query user tasks (alpha)

+ - + Search for user tasks based on given criteria. :::note -This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) 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 + -

Body

    sort object[]
  • Array [
  • ]
    • page object
    filter object
    + -User task filter request. + -
    variables object[]
  • Array [
  • ]
- -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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx index 861fdb17257..17393bd40b3 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx @@ -5,56 +5,259 @@ description: "Reports a business error (i.e. non-technical) that occurs while pr sidebar_label: "Report error for job" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SsYnOypLCqpkzq6qYrT2o0djyy3B8cHkIRE2CTBAqBlDYf/vbtYUqI+nPrQ3uSMHRIf+7C77wHgVtyJueXDe36pQ/7Q47G0kVGFUzrnQz6RhTbOMsHC0qpcWsukMdqwI9WXfZbr/MTJKMlVJNJj5hLhmI6i0li2SFQqWWF0BJNUPgcTjzrsf895jxfCiEw6aRC44jm8ABZ0/yGX0K0QuRAugWcj/y6VkTEfOlPK7eVNE8me5JLpGWBLDwBzbJTITPBhxd2yQMsqd3IuDXTNtMmEo6aPp7yuHwhCWverjpc4Zxsx0jA7d9gliiIFTxE8eLS4gmoXTIePMnLopdGFNE5Ji70+bGMdS3zZ9YKiGkE/RXGh0pSFksFqASCGd5cwkbfjsJXJZ1gXRbTBts5AqHndI7grCL2Y70EctYYyGkGYsOBnBQOZiGOFI0XKvPcve1F6PC/TVISppFAB6rMwChu8x2srN51I7Evj5e23a0Zx63ivcutE7pRw0md3ZZwJ5xtSDaxjNgLjLQN2wkP2fANMxCEuMXrR+L/h1ipxW27VXRbedxIJ3HHK4TgUzzm2T4hLQCyaZgudWwrH+8HpDxKhbLswoOiazGDkdDDYT5kmXTGLhRNoINcOgpSqmNx6hbgwDXzLftol8NbS2A2NZLF0QqVtgoRlNDAEaJWz+8mXMft0+uGXh6PEucIOg2CxWPTNLDqRQAAIsjbzAF7xF8cd9xks3yC3l0jxDtvWkmG2kJGaqYg57cPRLJthsvanbVNv1FvtcHa1A5RG8W0ijtjd5IJBUIF2syXuWjvQfs5MlCnaEKEu3TBMRf6EqWrYsAu6jWLLLBNmtW9tAoAhIL4r7b/uYD+/37GNxPh9Or1hZIJ2FKIUMKQBQicylauszPgQ+AVv4oXePg4GNdrEjL/BE6DvSwHue2ptuwPkyDTkmax5x0jT0X+VGW3UXG3jAtA6F7wh8WfyiHR5uk+KU9Ic7bRobq5gA2F0KrXymukyP8jrIK+DvH4or09vltcTaQtQsG1hNEBjbCWDW6SB5aTLPrtauwmHv+kcfc289qBlIVziDvI8yPMgz9fl+WHfhRJ8wSgb5CHdSP13nMFPj+0vOVKcv+getHbQ2kFrr2kNOjPpEh1jPUNbTx0sawx5AEehDSq6XNaBVxxWLqR5bqsipYGw8IpEUwPXqwRM1MMKKzJ18IwZ2fjexm4SV0sa/4GcEPBu8rADSy+tU2ORweVWsDM2Ob+dst/gEF6IpQ8mQm6aPhucDfZaxaGvWBzdXDDykKjX2Q5as6jrvWZp8FsM+5qOlbB5Kbe8xWkUnlDCzcGMSoz/ihINnreO7zQIWujhS0uUy7+mPte4lU3W9aLzF5EVJMROfWdNtM0qzLq9m7fak3Wm/aoaKu36h5OAGRSQQf/dLm0hBjNfQspgrt+CgbpUNurEK0pL6zBOPQ77tIQ7E+I2Fbh22FfqYX8SInvXx1wTIduddw6Wy7APcEFE01b/h6kOg0yoPGggbDAeXd1dfx6dfL0Yn1/fnp+Axb57cT6mqIxM5J11UNWxOYfQKdDJtsPV+tT5n6qUDUWw/BXAzqNyJK0PQtXI+B5rlhaGDle1S1IyMJDUeM+rKhRW3pm0rrEZqGOW0P6wJoFXe6wsPsNOMROp3a6QdZ09mjTFqGO2v/y5d91No8iXnn5piW/wCNPXpdf6AUYmUsQgAVwUdY4J+mSKJtaTd4qhda+dMYoiWbhXxm7cClCrqy3y5tvtFKXXFGIzEpMRC6wDw98h/w7/4EX7sHhV+/aKw8EwL0lkZBd//gEAD+RO +api: eJztWE1z2zYQ/SsYnJIpLSqpkya8qY7TOs2HR5bbg6sDCK5E2CTAAKBkDYf/vbNYUt9OfWhv0oxGIrDYxe6+B5Kv4V7MHU/u+CeT8mnEM3DSqsoro3nCx1AZ6x0TLK2d0uAcA2uNZS/UAAZMG33mQeZaSVG8ZD4Xnhkpa+vYMlcFsMoaCc4pPWeC3Zt08LfmEa+EFSV4sBi44VqUwBN+b9I/YMUjrjByJXzOI27he60sZDzxtob97U1yYA+wYmbGfA4hAI+4kzmUgicN96sKPSvtYQ6WR3xmbCk8Db095207pRDg/K8mW+Ga/YjSaA/a45SoqkJJgcHje4c7aA6DmfQepMcsranAegUOZ0PZLkwGeHGYBVVVmgyoiktVFCwFVgovc8jYUvmcCd3b4SiDBWhPFe1iO2+VnvM2onBfwDkxPxJx1DsqyYJiVtYsVAaOiSxTaCkKFrJ/PBol4rouCpEWQKVqI74QVuFAyHjj5XqrEsfa+Onm21dGddvKXmnnhfZKeAjdXTtnwoeBwkhRMCdNBT0CDspD/sIAuGDic2uWXf47aa0bt5dWu43Cu61GTiPulUc7JM8ljo8JS7xtaZmrjHZUjtfD8x80Qrl+YzNjN2BuI34+HB6HTNeujGXCC3SgjWcLUaiM0noCuJU1aQHlT4cA3tsauyZLloEXqugbJBwjwxQypjS7G3+8YO/P3/wyfZF7X7kkjpfL5cDO5Blkyhs7MHYe25nEL9q9HLBJDhaxvUKIb6FtQxnmKpBqpiTzJpSj2zbDZh1v2y7faLY5wOz6BKit4vtAHLHb8RVTGWivZis8tQ5ChzUzURfoQ6Sm9klaCP2ArerQcBh0P4qry1LY9bm1G6CNuPPC1+5fT7CfXx/4RmD8PplcM3JBJwpBSrk+ECZRKq3KuuTJ+XAY8VI80tXb4bBFn9jxZ2SiGTxWhdABWvvpKM1KY6HDT0iMOC3/q84Yq+ZqP+6At5te8A7EHygj4uX5MSpOiHN00qK7uVqAZnRX6uk1M7U+0etErxO9fkiv98+m1wNxS+kwtrRGz0NtgcnaWtC+WA3Yl02ajgm7devr1vU3WpaabHWi54meJ3o+Tc83xx4oR5phlS3ikJ5Iw3ucxVeP/Tc5Ylx40D1x7cS1E9ee4lob8RJ8bjLUM4wL0EFZI+HxvUld3NDDZRsHxqFyAXbRqyK1LXjCGyJNm8Rxkxvn26RBRaaNF9iRnfdtnCZy9aAJL8g5BT5sHk6g9NIndSHKWmeCvWPjy5sJ+014WIpVKCaG3HX9bvhueNQrmj7hcXR9xShDgt7WcdC7RV4fdUvGz3EcNB0HsrbKr25wGZUnBWHBjmqs/xoSXbzgHa/JiEfdn489UD79NQm9xqNsvNGLLh9FWRERt/SdDdB2VZjN+Hbf2gDWmQm76qB0mB8uAuuoIMPBq0PYXl8F9klTlrUOR7Ced7LRVr1kUTuPdYp4oSRoFzbfKXC92WeaYX9SRPZqgL0mQPYn71z5vE4H0pSxpGXr37QwaVwKpeMuhIsvRl9uv34YnX2+urj8enN59mowHPhHH2qKzCiF3toHqY7dfQiTujfpfsLN5q7zP6mUHURQ/oqrQiiNoA1FaDoa36Fm6XjEk7V2SUyeRh0b73jTpMLBrS3aFoe/12BXPLmbbkAQ2J4ph/8znsxE4fYVsu1kX4w7MeolOy5/Ht13Nyj0KsCvqPGKR/wBVhvptZ22Ec9BZGDDpmjygkKfTdDFZvGBGNpG/YqRlFD5J2x3ngqQq+sj8vrbzQSp1wmxJZHJiiXqwGJJGzahJIHRYazhhdDzmghGPvHzD4Gf41I= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha.api.mdx index 57756c511a2..46a49e88c9d 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha.api.mdx @@ -5,29 +5,32 @@ description: "Resets the Zeebe engine’s internal clock to the current system t sidebar_label: "Reset internal clock (alpha)" hide_title: true hide_table_of_contents: true -api: eJztVt1OIzcUfhXLV4sKmeyWbWnuIpZtqba7CEIrFbjwzJzJeJmxp7aHEEWR+hp9vT5Jv2NPIARW2ov2rkhoYvuc7zv/9koGNfdyciWPG1vcypt9WZIvnO6CtkZO5Dl5Cl6EmsTvRDkJMnNt6O8///JCm0DOqEYUrCuCjWJF7xyZIPzSB2pF0C3tQ0vljTZzoUOU05DXRjhSzQFLjK7NrNZe2I6cYmqBRe+p6htRWQfB0DvDAJFi4Ls2xroWBuRUqzsNOVXBJCaplccuGdFpY6hkUiV8R4WudCEGymszmUyMDTSwkyk7C6+YXBlxpZquVqIiBXK6eZU5qgi+FZTFk4PhxI/acg8KpWjVEqzC9/lnKqKnRa3MHPhwtupZGK40pDyUro3cl9DurMFSTlbyzfiQP08zMHtweAGffF8U5D3i0iwBheRs4r4V75Fc78u34/FzsKl5zBo5h4jZIiasFItaNyQ6Zxl/E2lHf/TkwwiWFhaKJjCm6rpGFzFPGRTyhtpvPnsmWElf1NSqF5jFWZIUJQWlG2FTjOBTEsxhA6J0df7+WPxw+Pb7m1d1CJ2fZNlisRi5qjigUgfrRtbNMyz5n+X2RgIhQmCH4KsSYuCEh7AN9RQ0+a3Up2gNZouw7Chlgn/BzmQW1o/K7Ew63XylDw4hglTFBYigyN5puds8U3F5fip0ibDparmJ6RPqqFOpvmEMlds+TPJGmVvOYNCheZF0l8X3bavcUtjqBQIA+YA63XJDcg3MyW3bj61v3zzD5uL7aTY7EwlCFLak2JCB+2UgYidabXTbt3JyOB5jpe7T6rvxeM2YnPGv8MQIuu/gfhoBO+6gOFqLPCe06Jg2sAv9+C9lxjqN4bbDC6LHXMihiN8lj9b8B3cp1LbEaWd9LB0Vaqyy2LZZ7FLsenJ35HjYrmATwiFXqVnWqPFVDdX1ZNVZF9bZHWfiTjmNqZnqj49TU22KBdiqqRPh86TxgVEtbZw5Vm1vSiWOxPnJxUz8qAIt1DIGkSmfQh+Nj8YvorLoFxCnZ6cieZhKbmsMbGC5n1+ETcJfA7xe33AgMbJ0WF6wWgpPTsqRm/Yc94dSGPgiOq+TEHbSj/ebAvn5t1nMsTaVjepDrp8bwllBCpPl49Hr53UFY7k9CttCN85I1NZChxrXzyNe0fQY1o4bB4OUMP+Zl/O1RfshnYhfE6N4PeKkpMrZjMY5kPt8BLqsSGoP37yxedYqbbKBwmfH018uP76bHnw4PT75eHFyAMRRuA/ReS7dVpktO+LVv3vJv4o3396u46vH6+H/J8N//GQYqjvQfcgwLLXhfotlsRomz5WM7qbnBWYPeibNjyu5WuVAunTNes3buN3dEvs3j+OGVwCsSZVoFh5Wt7Tk0sbDowtxLjU9G/DFVwD36MNIPPt0wd31DyERoUY= +api: eJztVttu3DYQ/ZUBnxJUljZp0qZ6M5ykdZGmhr1pgdp+oKjRijE1VHjxerEQ0N/o7/VLiiG19sZ2gDy0b11godVyOIdnzpmRtiLIlRf1uTgyVl2Jy0K06JXTY9CWRC1O0WPwEHqEPxAbBKSVJvz7z788aAroSBpQvBeCTWEqOocUwG98wAGCHrAAJNkYTSvQIcVpdQWawKE0BxxRXtCy1x7siE4yNGgP0WMXDXTWgcMQHXGCBDHjXRBZN0gDDfbyWlsHsgvoGKSXHhpEglETYcugEvyISndawQx5QXVdkw04oyO1o9UUGFwSnEsz9hI6lCE6vHxSOezQISms0srBvOLLoX0KkloY5AYaBB+bj6gSU9VLWuEFaYIucjA4NCg9+vKCRCEc+tGSRy/qrXi+eMGXzxVY3hJeSw8+KoXed9GYDTgWZ1f3vXqXYirEy8XiYbJDulMNnbMOrEqCtbDutUEYneX8u0o7/BTRh1IUQlkKSIFzynE0WiWdqtHZxuDwzUfPAFvhVY+DfAQZTnIktBikNmBzjaSHHNhgy5Y4P317BD+8ePn95ZM+hNHXVbVer0vXqQNsdbCutG5VuU7xl+OelrDs0eGu+LJtNWNKw2RGdEGj35M+V2s+NoTNiFkJ/iVqkY8lCnG3mcnk1d1V+OA0rUQhOjZgELWITov7zXMIH06PQbdIQXebXU0/g057OhkN55CNjaFujKQrVjDoYB4FvY/i4zBItwHbPQIwFcIHGeIeDcEeWKHbP7+m8O3zB7nZfD8tlyeQU4CyLaaGDNwvMxCTGDTpIQ6ifrFYFGKQN/nuu8Vi4pys+FcwIcCb0UjKI+AeHU0wWIezfxIxTT5IUv+WMtbplb6PW4rpTgsxm/h1ZjTxpxADht62ohaj9ck6MvSiFlVq2yp1qSiER3eNjoftVkRnRC22uVmmuqq2vfVhqrejdWGqrlmJa+m0bEz2Hy/nptqZxVglTZ8BH4rGCyQH3JE5kkOkVsIrOH1ztoQfZcC13KQiMuTnqV8tXi0ezcqhX8h4eHIMmWG23N4Y2KXlfn40bQ7+msTTdMmFVNHpsDnjbbk8DUqH7jBy3W+tMOOl7Hyfg0Qx/3i7M8jPvy+Txpo6m7bPWj88CKuCzueTL8pnD311cpzaQ9lhiJRmJK1grUMPco+YMtEHJlQIoxWSTw5mvfZg3+UV+C0jwrOSRcnO2Y3GlQ59bEplh0rlbbfXxtimGqSmaobw1dHhLx/evz48eHd89Ob92ZuDZ+WiDDchkWfrDpL2zpEe/fcf8k/Sk+/pfeLbu8fD/68M//Erw+zugDehGo3UxP2WbLGdJ8+5SHTz6wUGfqvL8+NcbLeN9PjBmWnivz9FdBtRn1/ejRu+mwrRo2zRpWF1hRu2tlI4hjSXTOQDfPEtgHv0diSe/HrG3fUPIRGhRg== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Reset internal clock (alpha)

+ - + 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 @@ -37,14 +40,57 @@ normal behavior after it has been pinned to a specific time. This endpoint is an [alpha feature](/reference/alpha-features.md) and may be subject to change 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx index f8caf5b59dc..11905fefd10 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx @@ -5,51 +5,183 @@ description: "Marks the incident as resolved; most likely a call to Update job w sidebar_label: "Resolve incident" hide_title: true hide_table_of_contents: true -api: eJztV81y2zYQfhUMTsnUFpXUSV31pHGc1m2SemS5Pbg6gORKhA0SLABK1nA409fo6/VJuguQMvXjcQ499KCDRgSwv/i+BRY1d2Jh+eiOXxWJTKFwfHbCU7CJkaWTuuAj/lmYB8tcBky2MkxYZsBqtYT0B5Zr65iSD6DWTLBEKMWcZrdlKhywex2zlcSpGFgBCVgrzJrWUR+ct4oi//z1N1l0RoI9YXOtlF5BymKUzKT1Ngd/FPyEl8KIHBwYirnmBQ4wwi6uX2CNMpKCLoXL8NvAn5U0kPKRMxXsZobyTM+3UwuhUWoD1LdJBrngo5q7dRlcOViAwaW5NrlwYer9GW+aGbmzpS4sWNJ4Ozyjv22X074vTC3HzcVMexs64M0JPxsOD+uWRi9ROWW4u4IMFNqxpVAypXATjeEhhqgqylLJRJBqhEqxgvybe0t26l5W2w7G7DpIshSckIrp+B4SD3cQjNGxLNjd5OMF+/7s3XezV5lzpR1F0Wq1Gph5cgqpdNoMtFlEOKQfyb0eMAzeAKa7JiaIFMXQp1CUUAnGIfDMlpDIuUwIAxdy9cHQ1gf4WxBCWESHjfITRBuoLNKpWPSRqozkuxwYs9vJFfN4yPkaFfZde525qBTZELGu3ChWonggoJx06qDTXS+2ynOifsu3bQdoyDrhKvsi0759u2ebaPHTdHrNggmW6BSwhkyondYRJZHLQuZVzkfILhyJxzB6Pxw2ZJMQ/4pMCgaPJabvqbWbDpIj14hzsOYTkwXGVST/FTLayIXc9YuOnrDgLYk/hIyapvEF9VIxrqTLto4COh3aApvrqjgW2LHAjgX2bIG9O3RjYS60y4Z4CMbglukkqQxeyGyVSeXNU0/Q+abrGqw7Vtqx0o6VdrjScBEb4Eyn1ORi5+2bYux1RzzqLi4b1b07rIl8Z1n5UBAcMMuufa4M7hKvQw01SP06Q4vNqC61cU20JICWwkiBMXg8aTnUWschpbE5z0Ic+1jSAvXoXY4XIseLVLBzNrm8mbIf8YWwEmu/t+Ry2/T58Hx40CqJPmNxfH3FQoaBib3ToTNLZX7QbBD+GsO+17eAJ5l06xtSC9sTgzBgxhXBsWFI689bp3EQwpnw8bHjzc+/Tz30sphrr95SYD8QQgUhDJEPB2/26YbBUtUkOkddf3Qi5XyDI3qJJaqyjhI64Xi+Ar5byG/7purEPoUV9lvwyN4MCJTAnO7EXKDlKh6guygJapv/WOk4yoUsotaFjS7Gn2+/fBiffrq6uPxyc3mKFgfu0fnkidG5KHpxTMKzaNOV7SZbP90U/6uXaou+g0cX4RmDj9Km3ba6Ldi7zbvVovxo+xHbq1nkWqi7O17XsbBwa1TT0DRelmaN87OnMvV1nUpL33hEzIWyu8/e/o69mrQP5Nfs5cfwwZTaSVGs/WGhKhrh5wOmsf0yb2YonoFIkf0UZZAYJwmUrqf77G1PRbc5+q5/vaFy+RfLSsf3 +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 +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Resolve incident

+ 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

+ -The incident is marked as resolved. + -
- -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 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}}>
- -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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/sidebar.js b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/sidebar.js deleted file mode 100644 index 5aae0ea5757..00000000000 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/sidebar.js +++ /dev/null @@ -1,342 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/camunda-8-rest-api", - }, - { - type: "category", - label: "Cluster", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-cluster-topology", - label: "Get cluster topology", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "License", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license", - label: "Get status of Camunda license", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Job", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/activate-jobs", - 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: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-a-job", - label: "Update a job", - className: "api-method patch", - }, - ], - }, - { - type: "category", - label: "Incident", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/resolve-incident", - label: "Resolve incident", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-incidents-alpha", - label: "Query incidents (alpha)", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha", - label: "Get incident by key (alpha)", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "User task", - items: [ - { - type: "doc", - 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-user-task", - label: "Assign user task", - className: "api-method post", - }, - { - type: "doc", - 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-user-task", - label: "Unassign user task", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha", - label: "Query user tasks (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Clock", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha", - label: "Pin internal clock (alpha)", - className: "api-method put", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha", - label: "Reset internal clock (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Process instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-process-instance", - label: "Create process instance", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-process-instances-alpha", - label: "Query process instances (alpha)", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/cancel-process-instance", - label: "Cancel process instance", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/migrate-process-instance", - label: "Migrate process instance", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/modify-process-instance", - label: "Modify process instance", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Flow node Instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha", - label: "Query flow node instances (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Decision definition", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha", - label: "Query decision definitions (alpha)", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha", - label: "Get decision definition XML (alpha)", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/evaluate-decision", - label: "Evaluate decision", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Decision requirements", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha", - label: "Query decision requirements (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Decision instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha", - label: "Query decision instances (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Message", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/publish-a-message", - label: "Publish a message", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/correlate-a-message", - label: "Correlate a message", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Documents", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/upload-document-alpha", - label: "Upload document (alpha)", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/download-document-alpha", - label: "Download document (alpha)", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-document-alpha", - label: "Delete document (alpha)", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-document-link-alpha", - label: "Create document link (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "User", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-all-users", - label: "Query users (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Resource", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/deploy-resources", - label: "Deploy resources", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-resource", - label: "Delete resource", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Element instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-element-instance-variables", - label: "Update element instance variables", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Signal", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/broadcast-signal", - label: "Broadcast signal", - className: "api-method post", - }, - ], - }, -]; diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/sidebar.ts b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/sidebar.ts new file mode 100644 index 00000000000..d4c13bf216e --- /dev/null +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/sidebar.ts @@ -0,0 +1,348 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api", + }, + { + type: "category", + label: "Cluster", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/get-cluster-topology", + label: "Get cluster topology", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "License", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license", + label: "Get status of Camunda license", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Job", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/activate-jobs", + label: "Activate jobs", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/fail-job", + label: "Fail job", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/report-error-for-job", + label: "Report error for job", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/complete-job", + label: "Complete job", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/update-a-job", + label: "Update a job", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Incident", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/resolve-incident", + label: "Resolve incident", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha", + label: "Query incidents (alpha)", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha", + label: "Get incident by key (alpha)", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "User task", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/complete-user-task", + label: "Complete user task", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/assign-user-task", + label: "Assign user task", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/update-user-task", + label: "Update user task", + className: "api-method patch", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/unassign-user-task", + label: "Unassign user task", + className: "api-method delete", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha", + label: "Query user tasks (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Clock", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha", + label: "Pin internal clock (alpha)", + className: "api-method put", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha", + label: "Reset internal clock (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Process instance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/create-process-instance", + label: "Create process instance", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha", + label: "Query process instances (alpha)", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/cancel-process-instance", + label: "Cancel process instance", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/migrate-process-instance", + label: "Migrate process instance", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/modify-process-instance", + label: "Modify process instance", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Flow node Instance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha", + label: "Query flow node instances (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Decision definition", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha", + label: "Query decision definitions (alpha)", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha", + label: "Get decision definition XML (alpha)", + className: "api-method get", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/evaluate-decision", + label: "Evaluate decision", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Decision requirements", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha", + label: "Query decision requirements (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Decision instance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha", + label: "Query decision instances (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Message", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/publish-a-message", + label: "Publish a message", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/correlate-a-message", + label: "Correlate a message", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Documents", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha", + label: "Upload document (alpha)", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha", + label: "Download document (alpha)", + className: "api-method get", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha", + label: "Delete document (alpha)", + className: "api-method delete", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha", + label: "Create document link (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "User", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users", + label: "Query users (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Resource", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/deploy-resources", + label: "Deploy resources", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/delete-resource", + label: "Delete resource", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Element instance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/update-element-instance-variables", + label: "Update element instance variables", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Signal", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/camunda-api-rest/specifications/broadcast-signal", + label: "Broadcast signal", + className: "api-method post", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx index 2152d9921c2..9912dcb27e8 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx @@ -5,55 +5,226 @@ 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/SsYnJKpTSqpkzq8aWyldetkPLLUHBwfQBCUEJMAC4CSNRz+9+wCpCRLcp3J5KiDRgSJ3beLfQ9fDXVsZmlyR6dWGOKYfaD3JzQTlhtZOakVTehYlHohLHFzQZi1cqaEIDonzPcnS+nm/ttMLoQiD2IV0RNaMcNK4YRB7w1V0ABXNaBMwOgfsYI+Er1XzM3h2Yj/amlERhNnarEbwgTcg2NERaS6DxaRLJ+LktGkoW5VIYhUTsyEgU+5NiVz4dX7M9q29whkK62ssGjxdnCGf/tgawSyZJbUqss7I7bmXFib10UBebYn9GwweNHF3ggRzpTSjqRiy3dEPmkjSCYck4UlDJ4roxcyA1ipvIM+eJLqbBV9VZAj15CuchgDq6pCcoYxxGCZFqL87ZvFgJqtUXoa6ZDchJ4dLtHpN8EdFJqEjmlAvxt/vCAfzt79cf9q7lxlkzheLpeRyfmpyKTTJtJmFkMTf9jvdURgFCCHkq0wT5ZBN8BkBWZVCeMkcMpWgstccuK0T7ALm2ApQ35dUUNYSKy18abk69JbZ6SabVe+NpLusmlIpuMrAuOqnMxXYLAP7W1yVhfog6W6dklaMPWAFXfSFQdBd1FsXZbMrFn7FAAcWcdcbV9k7u9v93wjv/6aTG5IcEG4zgQBG8CRtgfCJEqpZFmXNAGaQos9htb7waBFn1jxH8hEEfFYQfqeWrvpADnKDW99YlJBXIr/qspoI2dyFxeANrWgHYkvQ0Zt23plvizufWWi3lGaua5VFh0FdhTYUWDPCuzDTwgMxq9bzZZGQwA4woLw2hgIChbV4yp4FOlRpL9MpO8O7U8hFxxlgzwUxsCQae4VmJHlXBbePW5ze2zcnQvrjlo7au2otee0Bh/hxDvXcIYFkAIOv/4cDMfbhMa4JJ7ikmjjZusU3Mb9iRpPssIs+gNzbWCYaBNE1AL3m7m2rk2aShvXxgus0IIZySAIX1D8HMTWk6jQnBX+9aFi4gc8lfdJXrASNryMnJPx6HZC/oRFecnCERchn7o+H5wPDnrFrs94HN5ckZBhoOLW9NC7RZ0fdBs6/4hjf8a3AiYz6Va3aBaGJxWwkzDDGquxpkiH571jO3SCN+HhY0+cv79MfO2lyrU37ziwHwhWBUoYIh9Eb/b5BsGibLguwdbPncA5v01iW4nxorYOEzqhMMEK2OwgbneL0ne7Dl/IvwGRvImwKIE5/ZQ5A891GgFczIPZ+j8tdBqXTKq4g7DxxfDT9PPl8PT66mL0+XZ0Ch4j9+h88hUQpmRqK45pd3Wx2e/tpttsFoufu0bqCuXEo4thPpAKqeMzbDpp3dGNtMAgeXrFtFYXsCIo5I42TcqsmJqibfE1rGxmBe/vN4LyCsykxWdQc84Ku3sltZ3Zq3F3efWa/N9F1cFcupdMrbygixpb8AhOdu7L2nvoPhcsA4ZifKHHkHNRuS3bZ5dkFMZ6frocXY8mI6jrd/wi5PA= +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 +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx index b728aca1d9d..95732b30400 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx @@ -5,66 +5,263 @@ description: "Update a job with the given key." sidebar_label: "Update a job" hide_title: true hide_table_of_contents: true -api: eJztWN1u2zYUfhVCV+2W2G6Xdq135bnp2q7tgsTZLpIApSTaZiqRGknZMQwDe4293p5k3yEp/8R2G2y9dIo0ksjz/32H0pknjo9s0r1K3uk0uTlKcmEzIysntUq6yWWVcycYZ7c6ZVPpxsyNBRvJiVDss5i1kqOk4oaXwglDWuaJwg0Esf9XMcOyJDUVd2NcG/FnLY3Ik64ztbhvawDN0Mn00Bshi06z2ntAhmw2FiVPuvPEzSqyIZUTI2GwNNSm5C48en6SLBY3wZiw7medz0jmvu1MQ1o5WuJVVciMkxvtW0u+zLeN6fRWZI7iNboSxklhaTUbczUSVnhFm/G8u/jtIwtiIXVhb+4j484ZmdbI7YQX8LN1ra4VZWCoi0JPpRqttliWccVSlCG/ra2DhlgJaZlQeaUR9REWc0mWebEmea2msihIVo6URvhdsvMd+2QEtgj7iR0zsqrElPFS18pR+uMifDFNKX5iJUx7J1ilLSxNIFWXqTAtr9DJUujaNQrz2viENtUkA3ELk4qV9ohZx5FGBDo0uvSbstoY1ISVusQfn5Izoycy9+lQERraivXc+Fxw+II4fS4ZvNaldF63dKwyqI+ZYCvZQO2s9Elc6vjnr79tEF1WgUqEpCvtQ850WRWCZKB6yGWxpwQ1PPNxxP1eTRTx181WixzAB57DICD1ZYjFanwV+D88TXZR6n+VFhopsTwtRCDOAt6GMj6EiLv8+RbI2HbL++XolhpZf8lKWlhR/2qNrzcbEqHRnYeeAakgZyutbEj9087JNsUbqEy5jY0qZ7bOMmHtEP6hP0LNSaezW7Ly2IYIBDkDkghuwKGMsNjToiCGuMvvt1vVpokeOws7WS4cITD2IvgaNqYwjYxfnb/us5cnz368eTR2rrLddns6nbbMMDsWaCnatLQZtXFLv7TvcYsobgQr+Sy0pWXnWSGX2UpkcigzauIuROudIcw8BPZhdYkxC9yq0TrEaiO3ANZjl+dvGZKqnBzOCEJbpr3MkNcF6eApYNdNC64+JysIbRu9b8XWZcnN8qzaNABFQLCr/zNl3wwGZyyoQC/JRWQrEBINURClVLKsy6QLfOGO34W7553OgnRSxR8QiWLirkL4G5RswiE64tCI+PGBUd/iKvtWldFGjuR9u61knc4RxK9CRIGZJ18kY/OaEt5BGmIN0QLz1oFWB1odaLWXVi8fQKvl2z8xC1bo2dRomKbcLs9qnH7swypMy7hZO/KiXHPEshSv6YdT70DPAz330/PZrhdJxEJZNoRDYQx9+2SegfhEGeNLhdTT+2hjO34WH7h24NqBa/u4hsVSuLHOw+wqG/s5lxvjto2z0Lbn4d1yQWMpmi3E4VdtkJFkHviyAMznY23dojuvtHGL9oSKMeFG0oerrx0tB141eCl0xgv/eFfdaIEmbE08fV7irZazF+z89GLAfsH5O+Xhs5NMbqp+0XnR2amVtu7R2Dt7y0KEAXVrnaBRS5TeqTZsfohiP7CzAn1LutkFiYX0pAIvDaZXU+aXaIj2vHa6D5vwJFy8bjDy7o+BLzN1sfPVMPD0jtN0Zmt4txyzdNZGHJ2FR+RQe/sRL9uRUFlpruRD77SebGMT0RLFMl1C1vdZ4DOOrlb6soLme37sgmYs8GJEduNItdn2Pqyw34NF9qRFVQ3Qa9rrCJrrtAVz7SyILf+mhU7bJZeqHU3Ydr/34fLjq97x+7f9048Xp8fQ2HJ3YXhSAXElV2t+rM+E7wc6Xx0pD5kdx4o6cefa6BFSEcZ8JPPItyuaJFts7caJMoASSHOVzOcpt+LSFIsFPUaFzQzPb1Yc86TMpaVrcHnIC3t/7Lzu8aPzOCl6zL42jN7peXzI1czzvKjpDpdQtBqJL26wcyx4DsySe2GxH5w4HpCKlfDWaHpx1Ej0skxUbs/ejROcyLVsZ2e9Qf8NkSXOxUt0fzw2fEoDevzfTa7xDzfaZyiMIOn5PEEXH9V85Of7XjH9/Atn9mWy +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+Adk7zzBEVzLdXYyOj94h2DpeHFlOCpbNkOCns1SxCZWJ9GPeG9BJdPjwMaR249G8d8/5BRktg== sidebar_class_name: "patch api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update a job

+ - + Update a job with the given key. -## Request + -

Path Parameters

Body

required
    changeset objectrequired
    + -JSON object with changed job attribute values. + -The following attributes can be adjusted with this endpoint, additional attributes -will be ignored: - -- `retries` - The new amount of retries for the job; must be a positive number. -- `timeout` - The duration of the new timeout in ms, starting from the current moment. - -Providing any of those attributes with a null value or omitting it preserves the persisted attribute’s value. - -The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead. - -
- -The job was updated successfully. - -
- -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 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-element-instance-variables.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-element-instance-variables.api.mdx index 990dcf390b8..f75526da29b 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-element-instance-variables.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-element-instance-variables.api.mdx @@ -5,52 +5,179 @@ description: "Updates all the variables of a particular scope (for example, proc sidebar_label: "Update element instance variables" hide_title: true hide_table_of_contents: true -api: eJztWN1u2zYUfhVCN0kwx3aytOsMrICbplu6/gSJ013EAUpJlM1UEjWSimMYBvYae709yb5DSvKPbKwXu9qaIo1EHp7f73wktQgsn5hgcBdcpCITuWUyN5bnkQjuO0EsTKRlYaXKg0FwW8TcCsN4mjI7FeyRa8nDFCMqYZwVXFsZlSnXzESqEOwwUZqJJ54VqeiwQqtIGNPo77AkVTMmtswesZm0U6d/Ih9F3lhhMM674/ymEJFM5k5iezEe3PjnauKyGv9VzD+TfzwTVmgoCTpB80rRL4IcL4ixvRCikqIvuJ3iWYvfS6lFHAysLsV2ikYw/kXMKSE7/bOKlS6LWwlEpuDVaCoNi3jOQj+/nTKn+pAj36HlMhcxi0st88lKINKCkytHHYbcc5/CcV750WGmjKYMCjgzQj9K8oibL+zQCLE/ccon9UGFLIM7fCKOfApNNBUZDwaLwM4Lyp7MrZgIjSkElHHrh56fBcvlvU+dMPaViue0ZjuTkcLq3NIUL4pURi6S3oOhzC7axlT4ICJLldRAG7AnDM02SaWXzeq8vfn4gfllTItCCwN7lL/NYqBIRtgaS1VG/vrjT+Nx3YVJHseSlPL0as24j2PTvWUnSFXE07Y3l4kzA2tu3ZYTXAtkW09QZGO1jGw6h0ckDDGnse4ylNO4npCQDed760hF+4hJPZNmpznKI58AnLHHKeLyNjCdx85Zbt06VaJvMmUssCGgdpy/Ez5DKKKRMRaSWKJStDgluGKBAYmiR2CMDNqZqg0cnBw4IwenB9TjLjIaQ0O4ToA4+shHjOYiMUbNJpIEWQbKN9mI1tSuazJ7wn56yRZsDGCqccAG7JQtx/lpPRpy7UZPaHScD/O6TSvMelJqJ5V6Cb501qyvG3nGlh0XVlUwYcd5VW+WCv4oKki5UMs8mvKcCk4rePxQGtvMnx5QTTZc7TSGYMYV4dWcxSLhZYpOdw43ZmlxwlOq+8rgTILIQTWNx87hce6K3Zhdl1pLk2eACuuhUgiHBir7wcBZA/ipO1wjX4sEdaeNpdUJQ6S5mnQUF00VOrPGcmkcnLhtXKGdxu05eNUiUjo2+Gtgl7CWaJVBHshpbHfZeySTlr5kfSYTgvojYBpvRLGXvTpBJnOZlVkwOFku1/eAuzW6AcNZaVPSdCPsp2r82gMIDOhXmgId4snptH/WzsVooy1n1CoeinGXuOSs39+9po7IbZPUNrmyUJTKmPhqD7diEcxk37U5drtAV14S+MLOk9YkCvR7wRCGwZd312/O2Y9nz364P5xaW5hBrzebzbo6iY4FCBObnNKTHl7pl+SOXBcT1fE5lWfFq2zF6jW9Rayiv8ptRnXbqOCeLcHPNhsH8Wk+WS8zdtFgeysfstvrS4aUYotI5vUusWF6He8BD8GKgzDl+RcqVAWFttFtK6bMMq6bI8OmASgC19jS/OMm+/1pSzfB4pfR6Ip5FeDmmDhZ++aoDHXX0Q104Y0/+bfn/f6SdFLFvyKSHCxfIHwHre1wAI5Moc5emwusOWj+O5VRWk7ktl0YWtUiqED82kfkO/LZroZCLJRlTTgUWiNlKopKjZZns6lMm5NZbbvaJb512rdO+9ZpuzsNk7htTVVMVymcHN0NDDeqQdCrjlXHtZumt2iftJa91U6LUuH2Ut/cSo2cBQvfUUs0wgLHB7scLAqlLZZRuTYuBTTtO69GlDsnTb1X7crSBF0P64jPeVbmMWcv2PXFzYj9jM15xucu02RyU/WL/ov+Tq0kukfj8OqS+Qg9Lte4olZLTb9TrRf+GsXuTmYEeE3a+Q0t8+kJBY7MelhScRq8VPacdnfic0IY8Q9vahS9/W3kgEA8d72671348//2/Wx1OfKH052nxb5DcKKcNxW+2nFRkYEIn4h+96SNZcROLRmpDGsdLwPP7pjM1/IUpTgpUn7gGu7HOKuR3errQC32zs+wT94iO+lSjT0QazqeQHMZdmGuF/llzd8wVWEvww2+V5kwvfPh+9sPr4fH7y7PLz7cXBxDY9c+WZdLapeM52t++C8x7c8L6y2yEf1itS/9xz7jVPi04sn2wIkyp45xlVhUBHMXtAgG6wY7v/RsnOY9T9wFi0XIjbjV6XJJwwC1nmP8fiXueCiWhp7jBsx7K3B4XV0gjtj/64PRzmJVgzz3BUhLesMjfN/9QW55j1VTwWMQECXeC5779B6PSN1KUetT0rJTrxhGkSjsHtmNAxsxZbN7XX28GRHxVZ+xMuz1GNV8Rl8H8f8gGONfQGRGmhynuvFFgD17UiIdkPF66edvCmd7LA== +api: eJztWN1u4zYWfpUD3iTBKraTzbSzBraAm6a7aaczQeLpXsQBeiwdWZyhSJWk4hiGgL7Gvt4+yeKQkvwbtBe92p0AQSLy/P98h+RaeFw4MX4UN4pK0h6kdh51SuIpERm51MrKS6PFWHysMvTkAJUCXxA8o5U4V+TA5IBQofUyrRVacKmpCE5zY4FesKwUJVBZk5JzvfwEcmWWQHtqz2ApfRHkL+Qz6V4LZOhxMNMPFaUyXwWKfWaQOqz/0m7ctus/0uoXtg9L8mQHMy0S0X+y92uhsSQxFoeMIhGSva/QFyIRln6tpaVMjL2taT9E04LgM604IEft8wbqEMW9AOaGrZoW0kGKGuZxfz9kQfQpOjBzj1JTBlltpV5sCFJLyKacJWAsYAzhTLd2JODqtAB0gODIPku2CN1nOHVErwfOxKB+MnMoyTlc0FkMoUsLKlGM18KvKo6e1J4WZEUicmNL9HHpqyvRNE8xdOT8tyZbMc9+JFOjPWnPW1hVSqbBk+Enx5FdHyoz80+Ues6kNRVZL8nxbh9U/tjNzg8PH95DZANLlSVH2nP8dpPhDTjyXS21EfnPb/92sa4HIhGYZZKForrbUh792DWvSYQyKapDa27zoMYbCHx7RqAlKMkuKAPnrUy9WoHUTFwQBIldl6EDF3pCUgbz1at55KR98AXZpXRH1XEccYGeslinFbWd7AB1FoxFH/hM7cmWxnkwmgYzPdPvKEYoNdrJjGwgy41SZskBblFgzKTTgiwFhX5pOgUnFydBycnlCfd48IzXpIudgJb7KHps8kAG3GyU55R6+byHRszTmW5Z7QX8/RtYw0zkxswEjOESmpm+7FbnaMPqBa/O9ER3bdrWbASlw6ByL51cniRb2reVvIEmCW61CSM/022+QRE+U1tSwdVapwVqTjhzYPapdr7fvzzhnOyYmvSK3kATkvDtCjLKsVY+iQb3apk5R8V53yhcSqUYanqLg8EzHZLdq92m2gpTRIC21ufGKEJeaPWLcdDWJIK7IzTyPeVkiQfLQSdMwHabAeLSwjjSXS3XLpQT+t4UnjRh5igFllJjMweWXK1CM+fWlOAZSnvdA/ipdp5Zv4ERyJxL/VlmlO148Sp6JaKUWpZ1KcYXTbM9Ax634OYpEV56xZIeyP/crt/HAhJNEzldZbSL4HQ5ujqMxXSnLZfcKrEUswFjydVodJyn8yiMSW4bbTw8o5IZ49Ur2FpZM1dU/uUQY/cTdBcpISOPUnUgig4i4ZwyxsvH+++v4W9Xb75+Oi28r9x4OFwulwObp+eUSW/swNjF0OYp/zLdWehihjpccXo2uAobVO/gLYUW/lqzgfO2k8FXRkLc7QcH46lebKe5tlLsj/IJfLy/BZnxiMhX3ZTYUb1d7wLnpvbjuUL9mRPVlsKh0n0tri5LtP2RYVdBkwjn0dfud4fsXy8PZHNZ/HM6vYMoAlKTMSbb2BytosF2dV+NRoko8SV+fTUaNSyTM/4HPNFAL5VCHUpr3x2poTSW2voJjvUHzT8nM8bKhdzXOxDNJheiLeLvokexI98ca6iJ5llLluuQrDUWTJrW1lIGy0Kq/mTW6W6nxJdO+9JpXzrteKc1iSjJFybjq5RxoXT4RjUWw/ZYdd6Z6Ybrw5NWM9xM2kTw7aW7udVWibFYx45qxsPhujDON+N1Zaxvhs+crp1LAW/HzusqKpyTimjVYWZ5g6+HncfXWNY6Q3gL9zcPU/gHelriKkSaVe6Kfjt6OzoqlUlfkTi5u4XoYazLLazoxHLTHxUbif+I4HAnc5TWVvrVA7PF8MwJLdlJzcnp66XVF6SHE18gEkn7z/ddFf3wr2koBMa5+8197yae//fvZ5vLUTycHj0tjkIF5yZY09bXoV+cZLIuBmI0uDis5bvb0JKpKctaB1zWi3hMxq04pap2/EYgEqFkStoFo9vXgY7sXdyBn6NGuBhwjmMhdnC8kL6o54PUlMM0svV/58rMhyVKPWxVuOH15KeP77+bnL+7vb55/3BzfjEYDfyLD7HkdilRb9kRX2IOnxe2W2TH+/VmLv2PPeO09enpxQ8rhVJzx4RMrFuAeRQHACMSMT760rNzmo848SjW6zk6+mhV0/DyrzXZlRg/Pm3IAw5l0vH/WV/Mr2bg9L69QJzB/9eD0dFktYuoYwJUzV8iEZ9pdfxBrnlqElEQZmRD4CPhdQzv+ZTFbQQdPCU1SccxSVOq/Cu0Owc2Rsp+et19eJgy8LXPWKXJmNfikl8HcRmNNyHtAU/D2loo1IsaF0wbZfLPfwEwnXow sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update element instance variables

+ Updates all the variables of a particular scope (for example, process instance, flow element instance) with the given variable data. Specify the element instance in the `elementInstanceKey` parameter. -## Request + -

Path Parameters

Body

required
    variables objectrequired
    + -JSON object representing the variables to set in the element’s scope. + { \"foo\" : 2 }\n2 => { \"bar\" : 1 }\n\nAn update request with elementInstanceKey as '2', variables { \"foo\" : 5 }, and local set\nto true leaves scope '1' unchanged and adjusts scope '2' to { \"bar\" : 1, \"foo\" 5 }.\n\nBy default, with local set to false, scope '1' will be { \"foo\": 5 }\nand scope '2' will be { \"bar\" : 1 }.\n", + type: "boolean", + default: false, + }, + operationReference: { + description: + "A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + required: ["variables"], + title: "SetVariableRequest", + }, + }, + }, + }} +> -
     { \"foo\" : 2 }\n2 => { \"bar\" : 1 }\n\nAn update request with elementInstanceKey as '2', variables { \"foo\" : 5 }, and local set\nto true leaves scope '1' unchanged and adjusts scope '2' to { \"bar\" : 1, \"foo\" 5 }.\n\nBy default, with local set to false, scope '1' will be { \"foo\": 5 }\nand scope '2' will be { \"bar\" : 1 }.\n","type":"boolean","default":false}}>= 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
- -The variables were updated. - -
- -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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx index bf926037c75..faedffd420a 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx @@ -5,74 +5,294 @@ description: "Update a user task with the given key." sidebar_label: "Update user task" hide_title: true hide_table_of_contents: true -api: eJztWV9v2zYQ/yoEX9Zusax4TtfqzUvTNl3bBYmzAUsChJZom61EaiRlxzD83XdHSpZkO43XdW9OkVQSef/vd0edltSyiaHRDb02XBPLzBd6d0QTbmItciuUpBG9zhNmOWGkqPaQubBTYqecTMSMS/KFLwJ6RHOmWcYt18hxSSXcADlSDYHoN76APQI55sxO4VrzvwuheUIjqwu+KXYI7IExUWMnqRZuFSmcSijTxFOeMRotqV3kKE5Iyydcw9JY6YxZ/+hFn65Wd14kN/ZXlSyQptZgzFIDKsQKyKXFNZbnqYgZatP9bFCl5bY0NfrMY4u2a5VzbQU3uBpPmZxwwx2jtlnvr37/RDyZd6Pfm3jbmLVajApw94yloGlwK28lemKs0lTNhZzUWwyJmSQjiEzyuTAWWJRhEYZwmeQK7D6CxUSgaJY2KG/lXKQp0oqJVOCACOX8SO6BYyLQt2+1KnJzTzpEox1ktCBg4kwkTgVJeJbbBUmFsW06zKP9yZKCvwaip/Zfgd5y4ii8H67zf0mWa6G0sAskyYQUWZGR8Ihk7MFdHodwk/AxK1JLTkJ0xkWDX5mEyvCm9523GbmXRZre+3gRpYnKhLVIJywoBerpGToccxgyxAgXqTWbH4ynXAeaGQMx4RyDK5V9Mr6AC4ePgaPzWVStBsjS7TaFxnxRWmPecQAt/M0E0CgJuaUbYn3qAilk9WaWo6lslPIKsXVyXTTy36+1EVFGugEd46LTxCnmT8cKqBq7agFwIK4QlQUBLQ3I5ZPxD7b0XqHMOo3+g06eTafIv59mbSQ1dGNas8VOLRBOKHtN6oql2V8dZIDKCMszs+2O1dfU9IXiG/WcOOL/VdEK+U+2iJ97O5Wu6FtKws6yitAoRCpXOWh0AjdlTaERFpVNfUAhKyze0tN1j4CHLPYiN7vFgMQAfZURv6GsMnbKsHn4Cs7imAN4QQYZa9hZN0oHc4MlEpRDP7r1Vv0gQs6Ub3IBOR8TrDje7zw5wgrmpFSVETrvLfW995a2KsQaOI/be12eA/xx4tI3YujKuAdUzJU0vlT0wv62I4atI8CcmfIMkBBTOAeMQTCcQoBZPwyfpN86vzTKbck4IB+hM4LtlonUEKb52jPgNUddqU1GcJ7w/njkAAGU4JTsp+2DxGa8L/zOUm51UgB7/caRl35z+eaUvOqf/HL3bGptbqJudz6fB3ocdziUZKUDpSdduMVf3Pc8IOACsCFjC99T1seCulATk/NYjEWMkXYNq1QGo7y7I7SrvF/9SjkttNhC2YBcX54T8Ku0YrzAPN0STRsYo2ykChuNUia/0Dq/toVuSjFFljG9BnJbADAyltnCfGudeDccXhDPAvpswl1XdVgrBbWKRj9sVooXYbhCnhjxPSyBaviQg/kutTbNgeTI6rx1hgkJesn4e0UGyuFEbMoFQQ2sl0n82lvkMd7fA9bbsESkIy7HqpBJcADYAWAHgD0KsFffADDwX9nN5lqBAuhheAso4E1BWuiohy54AOkBpN8NpCe7DqdgC3pZYx5yrXGIEDsEwiv/VKSOvTvkl7LLKdYBawesHbD2GNZgMeN2qhI/cI6nbkJtp3DbxY7YwY5ousvGfHqFA2Wc15UT7EKDc+jSQ2cFGb+cKmNX0TJX2q66M4zLjGmBL7wujLjsIValTgpv16l7vCuEuIBj8sq0U5bBMZeRl+Ty7GpI3kIrnjP/Vosi26xfhi/D3SML2PoIx8HFOfEW+gRsFIWKLaJ7J1u/eR/GbtRuOJQwYRdXSObdM+JwftCDAoOwToxSnuOO934TPPEXb6p0ef/n0EUcC9plPcY/e2BZ7uHYnrpXA0faC3v9znHYCXvDXi8Kj6PecfBzv/cX3RwDfm3n5ljupkroux2zsOZiPX86CRuDnsbISsixcv6oBkNbnsU0w9GxIwyD423YgPcR/bHKgNa1AIBOOaCu+cUpzpE11gXoExzObCi3/E5TbfvgV8gfXiI5DjDLPBSqyj8BzsUoAHHd2JOt/x+latTNmJDdUoTpng4+Xn96Peh8OD89+3R11gGOgX2wLpo5ICBjsqFH+blpfWjdNHZZd7z9P02VuWb5g+1CIRMSHe9sWpZF4YbWRQEIouZnKwijR/YNXS5HzPBrna5W+BjSUENob+7qQuAqRyIMXtcflh414dll+Q3qOdnvi9dOU6rZq1y4kpQWeAeXwG7jE9zqDrZPOUsAY6ip33Hq9ekMkU/NYesb2OqoohjEMc/tI3tbhw8sButKfDEYnr5DcJdf4DJoXPBYszl+EIS/Eb2Ff3CjnLNc3XDPlxQa0KRgE9zvGePPPx1v+dY= +api: eJztWW1v2zYQ/isHflm3ybKSJX3RNy/t2nRbFyTOBiwJUFo622wkUuVLHMPQfx+OlGz5JU3Wdd9cIKhj8l54d89zzHHBLJ8Yll6xS4MaLDe37CZiOZpMi8oKJVnKLqucWwQOrt0DM2GnYKcIE3GHEm5xHrOIVVzzEi1q0rhgkpfIUkZSQ25uf8U5i5ggjRW3UxYxjZ+d0Jiz1GqHm2aHUyTFoMbe0sq4VeC8S2TTZFMsOUsXzM4rMiekxQlqFrGx0iW34avnR6yub4JJNPZnlc9JZuXBmBcGI5YpaVFaWuNVVYiMkzf9T4ZcWmxbU6NPmFk6u1YVaivQ0Go25XKCBr2i9WO9v/jjAwSxEMawNw9n49ZqMXIW4Y4XDk18La8lRWKsikLNhJysthjIuIQRAs8/OWMxb9MiDKDMKyWkjYDnuSDTvOhIXsuZKAqSFROpNOYp2fkBPmZc5oJi+1YrV5mP0ANN54DRHCqt7kTuXZCAZWXnUAhj1+Wojp4uljt8zS0+tv/CaiEnXiLE4bL6l2KVFkoLOyeRUkhRuhKSCEp+7z8eJEkEOY65KywcJxSMs46+pgiVwW70fbQ5fJSuKD6GfIHSoEphLckJCxW5p+8o4FTDFWojfKaWar4zQXKZaG6MmEhESq5U9tH8OoMeHwMvF6qoXY1Jpd9tnKZ6UVpT3eEdSgtYCmOEkjBWumM2lG58LVm0VeV0VD4qsEXsqrjOOvUf1tYR0WS6Ax3js9PFKdVPz4oS2S4uyB2CJ6KGEOikMZw/mv94y++abK7K6D/4FNT0XPXtPFtHUsc3rjWf7/SC4ES2l6KeLM3T3SEF5IywWJrtcNRfcjMQxVf6OfHC/6ujLfIfbRE/He50upVfc5JFrGERliYk5ZmDpcdJxBpOYSmRyqY/dcSssPQrO1n2iDpiPAsmN7vFADJnrCohbGhYxk45NY/A4DzL0BgxKhDGWpWdRulhbogiXeEZya+v8QcIeadCk4vhdAzEOCHumEfEYN5Ky4xWwTULvfearTHEEjgPn/eyuQeE68R5aMSsrmmPRlMpaQJVHCZH24EYrl0BZtw0d4AcjPMBGLuimMcUy6MkeVR+6/7SodtGcQy/K42Qo+WiMMA1LiMDQnrp1m0YqXwe4vHABaLSalRg+eP2RWIz32dhZ2O3vSlwA2HjKFi/Ov/lBF4dHb+4eTa1tjJpvz+bzWI9znqYC6t0rPSkr8cZ/dC+72MYTlEjlHweesryWrAiajAVZmIsMsq0b1iNM5Tl3R1hneXD6hfo1GmxhbIBXJ6fgshRWjGeU51umWYdjDE+Us6mo4LLW7aqr22jm1aMK0uul0BeN1BHzFhunflanng3HJ5BUAGZytF3VY+1xtAaaRwlXaZ4niQ16aSMP+EkEvC+Krj0pbV5HCGhXNWtP5iQxnKZfavMKC0mYtNuzLpYb4r4dThRwPjRE2C9DUtCOuFyrJzM4z3A9gDbA+xBgL36CoAJ03azmVZy4iOMkDmtUdpivu+Ce5DuQfrtQHq863I6kEBR1lSHqDUNETKPwBxmU1F49f6S39huplh7rO2xtsfaQ1irI1ainao8DJyzqZ9Q2ylLWZ86Yo86oukvOvPpmgbKNK9rJthOFyxliwCdOu33F1NlbJ0uKqVt3b+jvNxxLegPXp9GWg4Qa0unUBkv/Ne7UkgLNCZvj3bCSydzDi/h/M3FEN5yizMe/qolk+uqXyYvk90jC6XtAxoHZ6cQThgKsEMKrVpC9061YfNTFPtRu8HM0eDkgsRCeEbINeqBoyQsC6Ox57XT72ETi5oPv7Tl8v6voc84Edr5aoz/5p6XVYDj+tS9HTiyw+TwqJe86B2+Gh4cp8cH6eHLOHlx8DfbHAN+aefmWO6qLeibHbOw7uJq/nScdAY9nZGVkGPl49EOhrYiS2VGo2MvmMQH27A5O/Xoz1RZOulbgJy0A+qVvqygObImXihEhtL4sDXvNO2238IK/BkswkFMVRag0DL/RNipG8WZKvtZEFv+PyrUqF9yIfuNCdM/Gfx++eH1oPfb6cmbDxdvegdxEtt767NZKWNLLjt+NM9Ny0vr5mEXq4739KepptYs3tt+VXAhKfD+TIuGFK7YihRYxNLus9VN1CD7ii0WI27wUhd1TV9/dqjnLL26WRGBZ45cGPq8elh68AjPzps3qO/haS9eO4/Szl7l3FNS4eg3FrFbnG88wdU3dcSmyHPU3tOw4yT40xuSnpWGrTewOmolBlmGlX1g79rlg8hgycRng+HJOwJ38wJXqpyENZ/RgyCfBbeVD5TnDP/dghVcThyf0N6glP79AxmK+RI= sidebar_class_name: "patch api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update user task

+ Update a user task with the given key. -## Request + -

Path Parameters

Body

    changeset objectnullable
    + -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 -- `priority` - minimum 0, maximum 100, default 50 - -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. - -
- -The user task was updated successfully. - -
- -The user task with the given key cannot be updated. 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/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx index d4dd5a82250..ad902036bc8 100644 --- a/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx @@ -5,45 +5,207 @@ description: "Upload a document to the Camunda 8 cluster." sidebar_label: "Upload document (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SsYnJKpRClpmqa6qXbSuhOnHltuD5YPILkUkZAAA4CWVY3+e3cBUqJEOXHTHDqZZsYxSWC/3z5gveZOLCyf3PBTndQlKGf57YCnYBMjKye14hN+XRVapEywtNnDnGYuB3Yiylqlgr1iSVFbByaaq7maTCZKO5irWS4tA5VWWqIMPgvFRFHlgmUgXG0gYmeOJbUxqLNYMa3wP1tXlTbOb5ZqWEKpzWpn2TptYDBXy1wmOelEU6wEgUuZNqwyOq0T8pvVFiLvzFzxAa+EESWgixTsmit8wci8trMU1yUF+rEGs8IXAx9raSDlk0wUFg7zMcPQz06ZznwS9l2j1NQhX3uLTkeo2CY5lIJP1tytquCAkWrBN5vB1qdW5Gu5tXUIs535dGGS7mQK6QBLqmBJQktZFCwGtgAFRjjAzVcVJDJboXtUCriX1tFzu9mArQusqvKrxmDy5YFlURgQ6SrI2sjX4eEM3IYAwbqfdbqiHbt4nakx3EQrh3ppqUTbEmvqRlj1cpgK53X2tOv4PSSO6m90BcZJsLSayQL6Pgw4KRNogMdSCcz5ZsARNKJVf6hUpKmk5IvioqM+OLtvsHF95hX07fYL2Qgw2nlY0oj8ohDeecQ8Rh1hq1VDkl4F3FeYXjt1n0wFBg9DJ9HSMcW0ighAtOMOtsxB7WOgseHtWflX110kBViA6drCTy9fHLVDsj1oI/jilfPaUb2Tjqq6ZbLztnK0uMPSTaj+LSVAJTqlcAlRnTrvVYuLqipkIsiZ0XuLHm3oH6m0lVY2FPj5+Bn9OpKg1tmlsE0jQooslyRgbVYXxYqIoQPtnrl/gOvW2ONw1iaKpZI+l4h5pLCITYulWFlmwZPHnCeB5uecPAVVl5TE5qPPY0ujj4LiQ8zpIdIhvy9UFv3ftN9M0x4uXkIGeFdIgIcOfDEef6bpmqM4E5g+PNPO6YRO0YQs8IKBz+1RSF6Rl21PsxjPoHBiPdCaKBkXUH7Xb9F9d6bsIuxs7LIARIZsEDbGwfrN5ZsT9tOLH368fZI7V9nJaLRcLiOTJUNAwGJfarMY4Sv90L6nEcNQMYZSrOjo3uGa7WDMrD/FZdJe2Rq3PURDfJ9mFPcA+LfVr43s1X7Kri/PGOZVueYG0TPtZTKBxzgxbKxrN4kLoT7wXdk/1yJTZNGyxGO6hdi+Ac9LeM20n0Xv98+PovfX2eyCBRXY2Sn4C6ajO21jiIJA0pQlMSJiEd/EfXh7OR4Tm/mKPyISul9VGL6H1mE4CI5yh1sfmFToF/XB16mMNnIhD+3u92cD4tMQUXMCIs3mGpmaV9p66AiX49so3c4SWAMwd+2tuzaYDL4OrbJBhK9zFNxM1nTj34zuqA53wkiBpnzZaDm0VAuVQieiyIO5fsloocuauwHl8vXVjP2CvIdHm08hmdxX/Wr8anxUK219QOP04oyFCAPgOiTQqqVuPs6OfvNjFPvLsQWclKRbXZFYSE8MyGFmWlPWt0Bo7Hnt9B424Zfw8KaFx29/znyFpcq0F28q3XeEqoIlDJ6Po2d9VKGz1ByJLlHWMyQiayldjhNGf0hEeaRRQJolu83Y0257G1bYH8EiexZRUQJyWmJcoOY6jtDcqLmGbH/HhY5HpZBq1Jiwo5Pp+fW70+nw7dnJ63dXr4eoMXL3zgdPwC2F6vjRDLvbE+SJn1ifHsa83p0L38R83IDHwb0bIRPh3Llpsr5u2vqGp90/EYTWvOHrdSwsXJtis6HPYValZsdLJfXxA9NqN39fPk8f9foDrPZG+ztR1LSL05D9r736b43Tn0jA3t8Rdjm43VEslolu7zlqRYKgmgXJk5CDob/47mSPzdyU0iA0xYGmcp3t/bHptnNiXPx+NSNOakb9Es9X/EqKvd7B7pGc3Gz+BhUIecs= +api: eJztWEtz2zYQ/is7OCVTipTTNE15U+2kVSdJPbbcHmwfIGIlIgEBBgAtsxr9984CpN5O3DSHTlvPyHpg3/vtLpZL5vncsfyanZmiqVB7x24TJtAVVtZeGs1ydlUrwwVwEB0NeAO+RDjlVaMFh5dQqMZ5tOmNvtF5nmvj8UZPSukAtaiN1B6kA67hmqu65DBD7huLt0+ywlS10aQ4Q25VO+BFgc5lgS7+H3TULq3E0xTGHorGWtRetWC0asE1dW2sDwqkHlRYGdturHXeWExu9KKURUl2aOOhQq49zIyF2hrRFOQrNA7T4MCNZgmrueUVerQUoCXTvEKWsyBtLFjCJAXnY4O2ZQmz+LGRFgXLZ1w53I/hpEQYn4GZhcDtmkbhbGKMdw69SVnCXFFixVm+ZL6towFW6jlbrZK1TT3L1zJrbVAK41kIV23NnRQoEuCgcUFMC6kUTBHmqNFyjyKFyxoLOWulnlMq8F46T597YouuUR6kDqfWGgtyTzNXFrloI69LQx4ejsBtdBCd/9GIlig2/nrbYMIKoz1qT0dVo7ysufXZzNhqILgPMg+km+l7LDzl35oarZfo6HQmFR7akDASxj3L2VRqblu2SliFnvfi94VyISQFn6vzLfHR2F2FnemTIOBQ72EiOwYgyv2UpmQXufAuIOYx4ghbvRjiDCLwvpYW3ch/MhSCexx4WeFRwXQKXAsgCliUqHcx0OkI+pz8Y9tcqT3O0W7rktq/eH5UD/EeQFtqmLY+SF8lzEtPWV13v7d95uhwg6XrmP1bCoAujCB3CVFbed7JFuN1rWTByZjsvTOareiPRLraaBcT/Gx4Qm9HAtQbu+CuK0QU4JrQGWeNUi01hi1oH6j7C7julT0OZ32gQEj6uZKae2NTGKkFbx04DM3jhhVxNNwwshR1U1EQux9DHPs2+igoPtQ5A0S2mt8XCkv/L9p/TdHuH17gDC3qAlmswOfD4WeKrhvFMy4VzbS3NKEFei6VA25xPQrJKrKyr2mYGtHGifVAadbWTBVW3xyW6K45IziPlJ1eiEAE7iASTqP264vXp/DD8+++v31Sel+7PMsWi0VqZ8UAhaS6NHae2VlBL6J7msKkRItQ8ZZG9wbXsIExuDDFZdFf8zqzA0Sjf5/uKP4B8K+z31h5kPsRXF2MQQrUvrtBHKgOPDPeKJLBp6bx+VRx/YFt0v65EhmBa6qK27aH2K6C0Je4b9xn0fvts6Po/XkyOYcoAgojMFwwPd2DO0XkRCW1rKgjPh8OE1bx+/jtxXBI3Sxk/BGe0P2qVlwHaO27IzVUG9wGx6R2nlMdfJ3MGCvncl/vbn12ID6LHnUTsEJfGsFyVhsXoMN9yXKWifX+kTCH9q6/dTdWsZwtY6ms8ixblsb5Vb6kG/8qu6M83HEr+VRF9NFxLKkeKsoUXJVR3WHK6GC7a26WmotXlxP4iXtc8DaEkFTuin45fDk8KpVIH5A4Oh9D9DACbqsJ9GKpmo93x0D8GMHhcuywaKz07SWxxfBMkVu0o4aivgZCpy9Ip++RiCXdh9c9PH75fRIyLPXMBPYu04eGUFbQumj5MD05RNX5OBRHYaqq0aFD6jkspC+BH1ksWcKULFC7gN9u7enJ3sQT+C1qhJOUkhKR0zfGufRlM00LU2XdNWT9PlVmmlVc6qxT4bLT0durd2ejwZvx6at3l68GJ+kw9fc+OE/ArbjesqNbkNcT5ElYW5/u+7zczIX/7E7dAc7jvc9qxaWmEgiZWnat4JqJ7UcRsZyv2XI55Q6vrFqt6Oe431KDENJR7T+w4W7H/Mt38KNWf8B253HAHVcNUTFazP+2Vf+sFfwTAdh59rCJwe2mLbP8mm78JXKBNuQscp7GGAzCZXnDe2xPp5BGplFRYO23yA9XrdutKXP+6+WE+lj3eKAygnhIcJCbbD6SkavVn+/poIc= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +info_path: versioned_docs/version-8.6/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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Upload document (alpha)

+ - + Upload a document to the Camunda 8 cluster. :::note -This endpoint is an alpha feature. It currently only supports an in-memory document store, +This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md). It currently only supports an in-memory document store, which is not meant for production use. ::: -## Request + -

Query Parameters

Body

required
    metadata object
+ -The document was uploaded successfully. + -
Schema
    metadata 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/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-id.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-id.api.mdx index e1e428e5b1e..b40f567d7d6 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-id.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-id.api.mdx @@ -5,55 +5,191 @@ description: "Get decision instance by id" sidebar_label: "Get decision instance by id" hide_title: true hide_table_of_contents: true -api: eJzlV21v2zYQ/ivCfVo7JXLadCiEYoBbK4VWwwlipx0QBAVNnWM2EqmSlFND0H8fjnqxY8tetk8b+skS74V3z734UQmW3RsIb2GEXBihZCyNZZIj3PmgctTM0mECIczXcQI+5EyzDC1qMitBsgwhBEEiISGEnNkl+JCg4VrkZA0hxImnFl7S3OGJ9hIfNH4vhMYEQqsL9MHwJWYMwhLsOifPxmoh76Gq7kjZ5EoaNCR/NRjQz9OLpgXnaAz4wJW0KC2psDxPBXeZBN8M6ZX796j5N+SWEtSUtxX1LSLpicWHB1xvnQtp8R41+LBQOmO2PvrtnDSNZRb3ffiAssgI+YthPI5G4EP0eTi+Gc7c883k0+Tyy8Q9Ta+iD/FFHI3grvIBVywtXC6jXsdPVC6YSAvdr5VrRVCNcCGkIOVPz86pMW175fmGbQfE/ai24k1Mf6M4cd13ROEzaiPqih8N7/WrbauZUz1cslH0IZ7Gl5Ovs+H7cQQ+jONZdD0cf43+vLqOpiTaqdymolRDjaZI7bHaYRLLvLBmS4dpzdY0ZRYz868bVx5CjO7tk1Q+WGFTOtrdES5Ep9FFfVnY/0bYPugixQPt40QywR/P6osjCNTp1ioombS9Fx5xAFVF4vO+XRbLFUtF4tGKRGMP77Rcq3mK2a//dLfRairMM2cjQ2PYfT/U3T7vE9reYdoGJdJa6Q6J1/tIXCg9F0mC8ikGL4OX//90z/fTva4LjlR6owrN0ZPKegtVyOTn6II3ffMwvIq9rYQ9dAY/AR7EIpAXWti141xzZBr1ieMgt3eVXwJX6kGge7vb5V4f0e4zL2++9hxny9AuFdG7e3RQEHsLIVidBa3NSWtjglIkFVAwetXyv0KnEEJZg1uFQVAulbFVWOZKW1JeMS3YPK2xJVld2AVz/4CQKs5Sd7wb92yJHglo9RN7tEv0qAXq208dD1F6x93bwdtBrydSPeBl0xgbP0tr814/tXKvJ0dR20JNSa9Oui3O5i8xF0SZ2n81uLyKroez6GTaUQfHpBu7yn9S8M5LE6ILiN5rJWi1L9pe/ePLzPWVkAvlzJv+unTsHr2rYp4KTqnsJ6w85vi0x7gVK/SYTDyusjxF2k4NDeyaip681u1CaS9TUlhFne0srVYFdcJSKVsTKhpdxl0N60aipEwYBI+Pj6ecZYVM2ClXGYGQCo7SOBwb3MbNib9jnChuOmuh3HugcYEaJcegcWQCxx9agghnp4PTQd1VxmZMbl10fISeYNaVx+IPG+QpE5J8ugDLZrxuYXUGG7a5GTDwIRQJfXrVg3ILZTlnBm90WlV0/L1A7YZ+M1duChNh6DmBcMFSg3sxdSsSfrluPrheeIc/ynpTaJtXrqGjXQDNpxDxtoqo7RJZgtoFVQuGnGNut0z2vsZobLo19DGagQ+sIJw6LHda23nvDefde6fgzdQDyt+74Cy9UnxV9RfHqxkU +api: eJzlV9tu20YQ/RVintqUNuXELQK+qREdsBFsw5KTAIYQrJYja2Nyl9ldyhEI/nsxy4tulOL2qUWeRO5cdubMRYclWPZoIHyAEXJhhJKxNJZJjjDzQeWomaXDBEKYr+MEfMiZZhla1GRWgmQZQgiCREJCCDmzS/AhQcO1yMkaQogTTy28pLnDE+0lPmj8VgiNCYRWF+iD4UvMGIQl2HVOno3VQj5CVc1I2eRKGjQkfz0Y0M/uRZOCczQGfOBKWpSWVFiep4K7TIKvhvTKw3vU/CtySwlqytuK+haR9MTiwxOut86FtPiIGnxYKJ0xWx/9cUmaxjKLhz58QFlkhPzVMB5HI/Ah+jgc3w+n7vn++sP1zadr9zS5jd7FV3E0glnlA65YWrhcRr2Od1SumEgL3a+Va0VQjXAhpCDlDy/OqTFte+Xlhm0HxP2otuJNTD9QvHbdd0LhI2oj6oqfDO/N622rqVM9XrJR9C6exDfXX6bDP8cR+DCOp9HdcPwl+nx7F01ItFe5TUWphhpNkdpTtcMklnlhzZYO05qtacosZuZfN648hhjd2yepfLDCpnS0vyNciE6ji/qmsP+NsH3QRYpH2seJZILfX9QXJxCo061VUDJpey884QCqisSXfbssliuWisSjFYnGHt9puVbzFLPf/uluo9VUmBfORobGsMd+qLt93ie0vcO0DUqktdIdEm8OkbhSei6SBOUuBq+CV///dC8P072rC45UeqMKzdGTynoLVcjk5+iC3/vmYXgbe1sJe+gMfgI8iEUgL7Swa8e55sg06jPHQR5mlV8CV+pJoHub7XOv92gPmZc3X3uOs2Vol4ro3SM6KIi9hRCsLoLW5qy1MUEpkgooGL1q+V+hUwihrMGtwiAol8rYKixzpS0pr5gWbJ7W2JKsLuyCuX9ASBVnqTvej3u6RI8EtPqJPdoletQC9e3njocovefu7eDtoNcTqR7xsmmMjZ+ltXmvn1q515OjqG2hJqRXJ90WZ/OXmAuiTO2/GtzcRnfDaXQ26aiDY9KNXeXvFLzz0oToAqL3Wgla7au2V//6NHV9JeRCOfOmv24cu0fvtpinglMqhwkrjzk+7TFuxQo9JhOPqyxPkbZTQwO7pqInr3W7UNrLlBRWUWc7S6tVQZ2wVMrWhIpGl3FXw7qRKCkTBsHz8/M5Z1khE3bOVUYgpIKjNA7HBrdxc+LvGSeKm85aKPceaFygRskxaByZwPGHliDCxfngfFB3lbEZk1sXnR6hHcy68lj8boM8ZUKSTxdg2YzXA6wuYMM2NwMGPoQioU+velAeoCznzOC9TquKjr8VqN3Qb+bKTWEiDD0nEC5YavAgpm5Fwi93zQfXr97xj7LeFNrmlWvoaBdA8ylEvK0iartElqB2QdWCIeeY2y2Tg68xGptuDb2PpuADKwinDsu91nbee8Mpy1pjqp5QVlUXnaV3CrCq/gYA8BqK sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision instance by id

+ Get decision instance by id -## Request - -

Path Parameters

- -Success - -
Schema
    evaluatedInputs object[]
  • Array [
  • ]
    • evaluatedOutputs object[]
  • Array [
  • ]
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-1.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-1.api.mdx index f36cdf8c8a6..8be57fd78bc 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-1.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-1.api.mdx @@ -5,55 +5,156 @@ description: "Get process instance by key" sidebar_label: "Get process instance by key" hide_title: true hide_table_of_contents: true -api: eJzlVt9v2zYQ/leIe2o7JXLabiiEYUCWOIWXNAkSr3sIjIGizjYbiVTJkzND0P8+HCU5jq0E2ePQF1sS77uf3/GuBpILD8kdXDur0PuJ8SSNQphFYEt0krQ1kwwSSNfnuP77CCIopZMFEjoG1mBkgZDAPa4hAm0ggVLSEiLI0CunS9YACZzjWti5KFs7QveGInD4vdIOM0jIVRiBV0ssJCQ10Lpk1doQLtBBBHPrCkntp18+QtPMGO5Lazx6RrwfjfjvqenbSrFNiEBZQ2iIRWRZ5lqF+OJvnuXqfcs2/YaKOGbH2SDdWuFYX+NewLHpr+i8bm28CPrwfh80lYstnCenzYKl0rIwfdWyQYlSOjR0/npng/xZbh8ubYY9FV6P9yQdnUrCQW/QZM+eeRo8YVBVMD2PT6aTr2OI4OTqy/XFeDo+5efjy5PxxfgUZg0zT+msq22nJbU2R2m2UnqKc2001/z1UREaaejFFO80T9ANSjtV5dK92Tl9G5RqylnTbts1TdNE8HGIxROzkrnOBLcLenqezaWzaY7FT/+V1VyEyr+SowV6LxfD1dz09tBh+2HvYCsnY+es22Tiw34mzqxLdZaheZqDd/G7/3+4H/fDvWkLjlx6byunUBhLYm4rk/0YLPh5qB+OrydiK2CBAfAD5IPvS1SV07QOAzhF6dAdhKF0N2uiGpS19xrD22x3Dn9G2hvCIl2Ldn4XSEvL436BIRU8yROIV0dxhznoMT6u73HdADvjVv0yULkcEqjb5DZJHNdL66lJ6tI6YuGVdFqmeZtbPmsLO5dVzpnMrZJ5+Lzr93SJgg943eBFgpYomAKt9cNwGVu3o+7T6NNoUBOLPqPlkRiPepZE5aCeVnhQU1hO+kLdslwbdF+cTbFlqc9D8rtN6up6fHM8HR/cjm9vJ1eX/VbV4XjybxV8o6VzMTgUhl8Qgl76rOfqH39NA6+0mdsA7/h1FbY9FNdVmmvFoewHbIUMm5SQivQKhTSZULYoc+TbaZdV/CR6tXPrRGGNJsvMDkhytmImLK2ldtpz60oVatgSiYPySRw/PDwcKllUJpOHyhachFwrND7kscvbRfcl2gFnVvkNWtvwHjuco0OjMO4U+Zi1rvpFDY4OR4ejllWeCmm2DL3cQk9ytikP4T8Ul7nUYR0JDtZde93B6gg2K8pjg0EECaucRV2j3EFdp9Ljny5vGv78vUIXmv6xr0IXZtrzcwbJXOYe93zaXJHw5qZbvt+K5xf0wRB68pp16Oq84jeI2t04/Da8li1RZuiCV+3JsVJY0hZmbxHnvtncQ5/HU4hAVpyox8XuKbeD9kF/fv09CIipvUfz28Y74lf2r2n+BXkpdA4= +api: eJzlVt9P20gQ/leseWp7BoeWO1V+Q2CqHBxEkLYPKDqt15Nki73r7o7DRZb/99Os7RASg3KPp74ktne++fnNztRAYuEgfoCJNRKdG2tHQkuEWQimRCtIGT3OIIZ0fYXrv08ghFJYUSChZWANWhQIMTziGkJQGmIoBS0hhAydtKpkDRDDFa4DMw/K1k6gekMhWPxZKYsZxGQrDMHJJRYC4hpoXbJqpQkXaCGEubGFoPbTH6fQNDOGu9Joh44RH0cj/ntp+r6SbBNCkEYTamIRUZa5kj6+6IdjuXrfskl/oCSO2XI2SLVWONZD3PM4Nv0NrVOtjTdBnz7ug6ZisYVzZJVesFRaFrqvWjYoUQqLmq4Od9bLX+bm6cZk2FPhcLwjYelCEA56gzp79czR4AmDqoLpeXY+HX9LIITz278m18k0ueDns5vz5Dq5gFnDzJMq62rbaUmNyVHorZRe4FxpxTU/PCpCLTS9meKd5vG6QSorq1zYdzun771SRTlr2m27pmmaEE6HWDzWK5GrLOB2QUevs7m0Js2x+O2/spqLULkDOVqgc2IxXM1Nbw8dth/2DrZyklhr7CYTn/YzcWlsqrIM9cscfIg+/P/DPd0P964tOHLpnamsxEAbCuam0tmvwYLfh/rhbDIOtgIO0AN+gXzwfYmysorWfgCnKCzaIz+UHmZNWIM05lGhf5vtzuEvSHtDOEjXQTu/C6Sl4XG/QJ8KnuQxRKuTqMMc9RgX1Y+4boCdsat+GahsDjHUbXKbOIrqpXHUxHVpLLHwSlgl0rzNLZ+1hZ2LKudM5kaK3H/e9Xu6xIAPeN3gRYKWGDAFWuvH/jI2dkfd59Hn0aAmFn1FyzMxnvUsicpBPa3woCa/nPSFume5Nui+OJtii1Jd+eR3m9TtJLk7myZH98n9/fj2pt+qOhxP/q2Cb7R0LnqH/PDzQtBLX/Zc/fP71PNK6bnx8I5ft37bw2BSpbmSHMp+wCYQfpMKhCS1wkDoLJCmKHPk22mXVfwU9GrnxgaF0YoMM9sjyZqKmbA0htppz60rpK9hSyQOysVR9PT0dCxFUelMHEtTcBJyJVE7n8cub9fdl3AHnBnpNmhl/HtkcY4WtcSoU+Qi1rrqFzU4OR4dj1pWOSqE3jL0dgu9yNmmPIT/UFTmQvl1xDtYd+31AKsT2Kwozw0GIcSschZ2jfIAdZ0Kh19t3jT8+WeF1jf9c1/5LsyU4+cM4rnIHe75tLki4d1dt3y/D15f0AdD6Mmr176r84rfIGx3Y//b8Fq2RJGh9V61J2dSYklbmL1FnPtmcw99SaYQgqg4Uc+L3Utue+2D/tR1KzE1j6ibZuMe8Ts72DT/Ag1odYQ= sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process instance by key

+ Get process instance by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-2.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-2.api.mdx index 85681d95add..c5d1725af06 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-2.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-2.api.mdx @@ -5,55 +5,146 @@ description: "Get process definition by key" sidebar_label: "Get process definition by key" hide_title: true hide_table_of_contents: true -api: eJzlVt9v4zYM/lcEPm03N0573XAwhgEdljt0HdaiybCHIhhkmY51tSWfJKcLDP/vAyXb+eXrbo/DvSSWRH4kP5KiWnB8YyF5ggejBVr7C+ZSSSe1gnUEukbDaXGbQQLp7g53f11BBDU3vEKHhlRbULxCSOAZdxCBVJBAzV0BEWRohZG1h0vgDndM56wOlli2NxWBwU+NNJhB4kyDEVhRYMUhacHtagKXyuEGDUSQa1NxF7Z+uIauW5O6rbWyaEnjaj6nv2Pjy0aQVYhAaOVQORLhdV1K4SOMP1qSa88t6/QjCkdRG+LDyWCFov0S96KenlHUOiPVhg62aKwMVl+FeXt1IL3im0mwtK5Un0TK1oSEQ8WVmzykU+lK2jovhK6j8+spVm/VlpcyY5Q+tO7z7NZGpyVW3/1Xlq3jrrFfyFCF1vLNNNdSWceVmD4MG6+xsjBGm5GJt+dMvNcmlVmG6piDN/Gb/3+41+fhPoaEI6Xe6sYIZEo7lutGZV9HFXw/1Q83D7fsIGCGXuEr4KOLwKJojHQ7PxJS5AbNhb8kn9Zd1ILQ+lmiX61PJ8MHdBNjgaU7FmZKha7QNII26Mmg6ZJAvL2Me62LvZaN22fcdUAOme0wohpTQgJtILhL4rgttHVd0tbaOBLeciN5WgZ+6SwkN+dNSWyWWvDSb5/6viqQ0QHd8jTeXIGMyiBYnxGRZOMY7t383XwSiUQ/g7Ivjj1O4Vw9iROEJ5H8wByStSS5EPSQoDHhvJZ3nv5+vt8/LB5vVouL5WK5vL3/fZj1vR6NoIOkjyi9i94hWgchGKTfD/X6658rX1tS5dqr9zV2798gyB6atJSCQjkPWDPupzvjwsktMq4yJnRVl0g31FBZQ7HTFxtgc21YpZV0mqrbazqjG6qEQmtHFR/alwufw1BIFJRN4vjl5WUmeNWojM+EroiEUgpU1vPY8/ZbvxOdKGda2FFbar+ODeZoUAmMeyAbHz0V4HI2n81DVVlXcXVg6N/a6Ii1MUEO/3ZxXXKpCNW72PYt9gTby3D5nDYZRJAQ6Drqm+UJ2jblFv8wZdfR9qcGjW/+fW/5Tsykpe8MkpyXFs+8Gq9K+OaxfxR+y157Ok6GMZSw2vneLhtaQRRebf63W3cRFMgzNN6vcHIjBNbuQOfsiUjdM95HHxYriIA3RNZI6EmFe/RJf3782QuwlX5G9dPonaMl+dd1/wB6G/xX +api: eJzlVt9v3DYM/lcEPq2dc76k2VD4LcCuRZZhCXI37CE4FLJM36mxJVeSLzMM/+8FJdv3y826x6Evd5ZEfiQ/kqJacHxjIXmCB6MFWvsb5lJJJ7WCdQS6QsNpcZtBAmlzh82nK4ig4oaX6NCQaguKlwgJPGMDEUgFCVTcbSGCDK0wsvJwCdxhw3TOqmCJZXtTERj8UkuDGSTO1BiBFVssOSQtuKYicKkcbtBABLk2JXdh69dr6Lo1qdtKK4uWNK7mc/o7Nr6sBVmFCIRWDpUjEV5VhRQ+wvizJbn23LJOP6NwFLUhPpwMVija73Ev6ukZRa0zUm3oYIfGymD1VZh3VwfSK76ZBEurUvVJpGxNSDhUXLnJQzqVrqCt80LoOjq/nmL1Vu14ITNG6UPrvs1uZXRaYPnzf2XZOu5q+50MlWgt30xzLZV1XInpw7DxGisLY7QZmXh3zsQHbVKZZaiOOXgbv/3/h3t9Hu5jSDhS6q2ujUCmtGO5rlX2Y1TBL1P9cPNwyw4CZugVfgA+uggsitpI1/iRkCI3aC78Jfm07qIWhNbPEv1qfToZPqKbGAssbViYKSW6raYRtEFPBk2XBOLdZdxrXey1bNw+Y9MBOWR2w4iqTQEJtIHgLonjdqut65K20saR8I4bydMi8EtnIbk5rwtis9CCF3771PfVFhkd0C1P481tkVEZBOszIpJsHMO9n7+fTyKR6DdQ9sWxx9k6V03iBOFJJD8wh2QtSS4EPSRoTDiv5J2nv5/v9w+Lx5vV4mK5WC5v7/8cZn2vRyPoIOkjSu+id4jWQQgG6Q9Dvf7+98rXllS59up9jd37NwiyhzotpKBQzgPWjPvpzrhwcoeMq4wJXVYF0g01VNZQ7PTFBthcG1ZqJZ2m6vaazuiaKmGrtaOKD+3Lhc9hKCQKyiZx/PLyMhO8rFXGZ0KXREIhBSrreex5+6PfiU6UMy3sqC21X8cGczSoBMY9kI2PngpwOZvP5qGqrCu5OjD0b210xNqYIIf/uLgquFSE6l1s+xZ7gt1luHxOmwwiSAh0HfXN8gRtm3KLf5mi62j7S43GN/++t3wnZtLSdwZJzguLZ16NVyX89Ng/Ct+w156Ok2EMJawa39tFTSuIwqvN/3brLoIt8gyN9yuc3AiBlTvQOXsiUveM99HHxQoi4DWRNRJ6UuEefdKftg0SK/2MqutG9xytycGu+wqWo/3N sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process definition by key

+ Get process definition by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-3.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-3.api.mdx index 16b32c5492b..ff33da69e90 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-3.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-3.api.mdx @@ -5,52 +5,169 @@ description: "Get incident by key" sidebar_label: "Get incident by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivCfdo6NUr6MhTCMMC1mUyNIxu2nAYLAoGWzjEbiVRJKp1h6L8PR8nKi921/Tj0iy0d7/W5O/HZguW3BsJriGQmcpQWbnxQFWpuhZJRDiEsN+e4SV+DDxXXvESLmiy2IHmJEMIdbsAHISGEits1+JCjybSoyAOEcI4bT608sQvgg8bPtdCYQ2h1jT6YbI0lh3ALdlORSyEt3qIGH1ZKl9y2ot/fQNPckLmplDRoyOLV8TH9PQ05r7MMjQEfMiUtBQ23wKuqEJmrK/hkSG+7H1ktP2FGOVaaULCijUI1fk96zo5Cj3AlpKBY5z9qGkljuczw+w1blV7VWC3kLfiAsi6pt4t4PmXD6DRiI/BhEZ/Hk48x+BBN0ovBdBrFZymbzSYz8OHD5H0aT9IZS2YRm4MP7IoNF0k0idNxNE9YzGZPz4eTeBS5850LdpXMBsMkvRyMF6yXDgfjMRulbMwuWJz04kX81yAeuROSpOySxQn4cMHm88EZS+fR3yxlV0PGRi75zs2IDaP546APAgo7eJLQ6WR2kcaTJD2dLOIR3DQ+lGgMvz0AWuNDptENSSLKwwrGcvufeA+GSXTJqIrobDZIXOIzNp+ML93jlMWjKD5ziXxSyx/oM0ouLS3lXlZ0KmxBon6Tm4bEbw4tSCTveSFyjzYRjf36olRaLQssf/vRhSGMavPNul6/gm90Q3TbcPDw8OA/BoNprXSPxOt9JE6VXoo8R/kUgxfBi/9/uW/2y521DUdqvVG1ztCTynorVcv855iCt4f2YTCNvEcFe+gMfgI86HOGWa2F3bg7fYlco37p7rvrm8bfQqbUnUD3dvP8aj9D29/r3nLjtVSgRLtWxBxu0UFApCCE4P4k2OmaYHuHmwYouL7f8YlaFxDCtgWzCYNgu1bGNuG2UtqS8j3Xgi+LFks6axu54nVByBUq44UTP88zWaNHB8RYiIvYNXrU8jb6kbt8lX7m7t3xu+ODnkj1K14eBuHBz9ra6qCfVvmgJ8dzdo2Zk15b9K4ZfXN5Jc4d6B0Zm0wZ3Tgv52xO1+GOmHV2jf+kwb2XLkWXEL23SrDTPt3N5oePiZsjIVfKmXfzNHGEEb1pvSxERqXsF6w87kiZxzMr7tHjMvcyVVYF0teo4z7ebrDpydu5XSntlUoKq2iSnaXVqqZJWCtl28uXVpVnroftIFFRJgyCL1++HGW8rGXOjzJVEgiFyFAah2OH27iT+M+Mc5WZ3loo9x5oXKFGmWHQOTIBeaVBbos9OTo+Om6nytiSy0eBDq/ME6z6tlj8xwZVwYUkXy6xbbdO13B/4prbLRT4EJKrG79bjGvYbpfc4EIXTUPizzVqt9QPe+S2LheGnnMIV7wwuJdL/wmEX2Ydb//V2+f0B1PeDancuO0tanoDv6XT7rchErRGnqN22bQngyzDyj6y2ePutB/9d+aMEWXkNQHTg/dshp33g/n88d4peIm6Q/lnn52lV8qvaf4FfTtoRQ== +api: eJzlVttu20YQ/RVintqUsZxLi4BvqrR2GcukIFFOUMMgVuTI2pjcZXaXTgWC/17MkqIvUprksciLRM7O9cwM9zRg+a2B4BpCmYkcpYUbH1SFmluhZJhDAOvdBe7SN+BDxTUv0aImiwYkLxECuMMd+CAkBFBxuwUfcjSZFhV5gAAucOepjSf2AXzQ+LkWGnMIrK7RB5NtseQQNGB3FbkU0uItavBho3TJbSf64y207Q2Zm0pJg4YsXp+e0t/TkMs6y9AY8CFT0lLQoAFeVYXIXF2jT4b0msPIav0JM8qx0oSCFV0UqvF70nN2FHqKGyEFxbr4UdNQGstlht9v2KkMqsZqIW/BB5R1Sb1dRcs5m4RnIZuCD6voIoo/ROBDGKeX4/k8jM5TtljEC/DhffxnGsXpgiWLkC3BB/aRTVZJGEfpLFwmLGKLp+eTOJqG7nzvgn1MFuNJkl6NZys2SCfj2YxNUzZjlyxKBvEq+mscTd0JSVJ2xaIEfLhky+X4nKXL8G+Wso8TxqYu+d7NlE3C5eOgDwIKO36S0Fm8uEyjOEnP4lU0hZvWhxKN4bdHQGt9yDS6IUlEeVzBWG7/E+/xJAmvGFURni/GiUt8wZbx7Mo9zlk0DaNzl8gntf6BPqPk0tJSHmRFp8IWJBo2uW1J/PbYgoTynhci92gT0divL0ql1brA8rcfXRjCqDbfrOvNa/hGN0S/DUcPjw/+YzCY1koPSLw5ROJM6bXIc5RPMXgxevH/L/ftYbmLruFIrTeq1hl6Ullvo2qZ/xxT8PuxfRjPQ+9RwR46g58AD/qcYVZrYXfuTl8j16hfuvvu+qb1G8iUuhPo3m6eX+3naId73VvvvI4KlGi3ipjDLToIiBQEMLp/NdrrmlFzh7sWKLi+3/OJWhcQQNOB2QajUbNVxrZBUyltSfmea8HXRYclnXWN3PC6IOQKlfHCiZ/nmWzRowNiLMRF7BY9ankX/cRdvko/c/fu9N3pUU+k+hUvD4Pw4GdrbXXUT6d81JPjOfvGLEmvK3rfjKG5vBIXDvSejMVzRjfOyyVb0nW4J2a9Xes/afDgpU/RJUTvnRLstc/2s/n+Q+LmSMiNcub9PMWOMKI3r9eFyKiUw4KVxx0p83hmxT16XOZepsqqQPoa9dzH2w82PXl7txulvVJJYRVNsrO0WtU0CVulbHf50qryzPWwGyQqygSj0ZcvX04yXtYy5yeZKgmEQmQojcOxx23WS/xnxrnKzGAtlHsfadygRpnhqHdkRuSVBrkr9tXJ6clpN1XGllw+CnR8ZZ5gNbTF4j92VBVcSPLlEmv6dbqG+1euuf1CgQ8Bubrx+8W4hqZZc4MrXbQtiT/XqN1SP+yR27pcGHrOIdjwwuBBLsMnEH5Z9Lz9V++Q0x9NeT+kcue2t6jpDfyOTrvflkjQFnmO2mXTnYyzDCv7yOaAu9N+DN+Zc0aUkdcEzADesxl23o/m0zSdRqLuULbtkJ6ld0qwbf8FBbFpuw== sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get incident by key

+ - + Get incident by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-4.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-4.api.mdx index 6563ac201ed..d6ff71053c9 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-4.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-4.api.mdx @@ -5,55 +5,184 @@ description: "Get flow node instance by key" sidebar_label: "Get flow node instance by key" hide_title: true hide_table_of_contents: true -api: eJzlV1tv2zYU/isCn7ZOjdI2HQphGKDYTKvFlT1JTlYEhkFLxzEbmVRJKplh6L8Ph7rEjp1eHoe+2CLPhefyHerTlhh2q4l/Qy4K+SBkDqHQhokMyMwlsgTFDJcizIlPFptL2MzPiEtKptgaDCi03BLB1kB8cgcb4hIuiE9KZlbEJTnoTPESPRCfXMLGkUtn2R7k8O4klyj4UnEFOfGNqsAlOlvBmhF/S8ymRN9cGLgFRVyylGrNTLP1+xmp6xma61IKDRotXp+e4t/+2UmVZaA1cUkmhQFhUIWVZcEzm6D3WaPe9vBkufgMmcGkFZbD8OYUTPZ7wrN2eHRX18sfNRzCkguOQX6/qTZMmSEzsKOvjeLiFqUg8mdl2J0IYZB/VRzZlh9R4CLjOQjz/bE2Kk9dYZTVGoE5jZIJHYQXIR0Sl0zi8YAmCXFJMj2fP67oFY3S+f5ekgZxOrcS4pIwSmn8kQ7DIKXzQZAOPhwXpR/i8XUvOh9Po2EQf+o3aDTsnxMaX4UDOk+D5JK4JKYDGl71y2lC4+75YxBNg1G3av/oP4PRNEGL90FKr4NPNpTDvUkQB6MRHe1sNemeBwkd7uwm9O8pjQZ0fjEaX+Op01EazsMoSQPcPR8PUWsQjEbzYJCGV2GK6/NpEkY0SebxdNQHnwzicJL2K8y6Syu6jMbXEZk1ODuGo8fm2WMoHjr+OBnR1PYQix1GAS5mO5DZ8bOQsgAmLDxAMGGOwhGl3BS4ddHBtrtT6hrFZ8fuglDcs4LnDl46oM3zd0Kp5KKA9W8/ejdgVSr9Tfi/eY35rUFrdvvcMLXZHBMen5vdolClpOor8eawEhdSLXieg9ivwQvvxf8/3bPDdOOm4YCt17JSGThCGmcpK5H/HCh4e2wegkno7CTsgDX4CeqBFxhkleJmY3nMApgC9dK+2m9mtbslmZR3HOxq9pTOvAdjuYyzR2acxcZpiNAazEoib7oFWwykRD7x7l95HQN62Rlpb3sHm5pgPOq+o1WVKohPtk19a9/ztiupTe1vS6kMKt8zxdmiaMqLsqa3S1YVWMxCZqyw209DT1fgoACJG1IyswIHUdCcfmLJh1RP3L07fXd61BOqPuPlERuPflbGlEf9NMpHPVmW1/UqQb0m6a4/fb9ZyS9t9VtOOp7QOEjpy4QmSTiOOn7a2tXuXs97L22INiD7OrJKpNO+6OD613VqocXFUlrzFmJjy5vBmVSLgmeYymHC0mGWkjosM/weHCZyJ5PrsgC8oFru18MKn5zO7VIqZy0FNxLBbS2NkhUiYSWlad7AOL0ssz1sgIRJad/zHh4eTjK2rkTOTjK5xiIUPAOhbR3buo3aHfeJcS4z3VtzadeegiUoEBl4rSPtoVcEcpPsq5PTk9MGVdqsmdg56FtTtFe1vkEG/jVeWTBuKYINcdtO2A25f0Uaoro/Y8QlPvqcue2s3JDtdsE0TFVR17j9pQJlR/9xtOwg5lzjc078JSs0HATVX5Tkl7j9kPnV+crXztEkOgCLjZ3sosIVcZsPDftbI1laActB2bAaSZBlUJodm4OvGpyd/jJ6T5G4sgpL9Ui39vFtvR+N549zq+Ck8g7En310BpcYX13/B+pfx+g= +api: eJzlV1tv2zYU/isCn7ZOjdM2HQq9KTbTanFkT5KTFYFh0NJxzEYmVZJKZgj678OhLrFjp5fHoS+2yHPhuXyH+lQRw+408W7JRS4fhcwgENowkQKZu0QWoJjhUgQZ8chyewnbxRlxScEU24ABhZYVEWwDxCP3sCUu4YJ4pGBmTVySgU4VL9AD8cglbB25clbtQQ7vTnKJgq8lV5ARz6gSXKLTNWwY8SpitgX65sLAHSjikpVUG2aarT/PSF3P0VwXUmjQaPH29BT/9s+OyzQFrYlLUikMCIMqrChyntoEB1806lWHJ8vlF0gNJq2wHIY3p2CyPxKetcOju7pe/qzhCFZccAzyx021YcqMmIEdfW0UF3coBZG9KMPuhAiD7Jvi0Lb8iAIXKc9AmB+PtVF57gqjLDcIzFkYT+kwuAjoiLhkGk2GNI6JS+LZ+eJpRa9pmCz29+LEj5KFlRCXBGFCoys6CvyELoZ+Mvx0XJR8iiY3veh8MgtHfvS536DhqH+OaXQdDOki8eNL4pKIDmlw3S9nMY265ys/nPnjbtX+0X+G41mMFh/9hN74n20oh3tTP/LHYzre2WrSPfdjOtrZjenfMxoO6eJiPLnBU2fjJFgEYZz4uHs+GaHW0B+PF/4wCa6DBNfnszgIaRwvotm4Dz4eRsE06VeYdZdWeBlObkIyb3B2DEdPzbPHUDx0cjUd08T2EIsdhD4u5juQ2fGzlDIHJiw8QDBhjsIRpdzkuHXRwba7U+oaxWfH7oJAPLCcZw5eOqDNy3dCoeQyh80fP3s3YFVK/V34v3uL+W1Aa3b30jC12RwTHp+b3aJQpaTqK/HusBIXUi15loHYr8Grwav/f7pnh+lGTcMBW69lqVJwhDTOSpYi+zVQ8P7YPPjTwNlJ2AFr8AvUAy8wSEvFzdbymCUwBeq1fbXfzmu3IqmU9xzsav6cznwEY7mMs0dmnOXWaYjQBsxaIm+6A1sMpEQeGTy8GXQM6HVnpAfVPWxrgvGoh45WlSonHqma+tbeYFCtpTa1VxVSGVR+YIqzZd6UF2VNb1eszLGYuUxZbrefh56swUEBEjekZGYNDqKgOf3Ekg+pnrn7cPrh9KgnVH3ByxM2nvysjSmO+mmUj3qyLK/rVYx6TdJdf/p+s4Jf2uq3nHQypZGf0NcxjeNgEnb8tLWr3b2e917aEG1A9nVklUinfdHB9a+bxEKLi5W05i3EJpY3gzMtlzlPMZXDhKXDLCV1WGr4AzhMZE4qN0UOeEG13K+HFT45nduVVM5GCm4kgttaGiVLRMJaStO8gXF6WWp72AAJk9LeYPD4+HiSsk0pMnaSyg0WIecpCG3r2NZt3O64z4wzmeremku7HihYgQKRwqB1pAfoFYHcJPvm5PTktEGVNhsmdg763hTtVa1vkIF/zaDIGbcUwYZYtRN2Sx7ekIao7s8YcYmHPuduOyu3pKqWTMNM5XWN219LUHb0n0bLDmLGNT5nxFuxXMNBUP1FSX6L2g+Z351vfO0cTaIDsNjayc5LXBG3+dCwvzWSpTWwDJQNq5H4aQqF2bE5+KrB2ekvo48UiSsrsVRPdGsf39b70XiqqtFI5D2Iuu7DM7jGAOv6P9J4yV4= sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get flow node instance by key

+ Get flow node instance by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-5.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-5.api.mdx index c269bbffaeb..88dffa13855 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-5.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-5.api.mdx @@ -5,52 +5,147 @@ description: "Get decision requirements by key" sidebar_label: "Get decision requirements by key" hide_title: true hide_table_of_contents: true -api: eJzlVt9v2zYQ/leIe9o61XLadCiEYUCKuoWXoQliD3sIjIKmzjYbiVTJkzNB0P8+HPUjdqx06ePQF1sk7767++6OxxpIbj0kt/Aelfbamhv8WmqHORrysIrAFugkaWvmKSSwri6x+vwGIiikkzkSOtauwcgcIYE7rCACbSCBQtIOIkjRK6cLRoAELrESdiPSzphwh9Yi6JYpJORKjMCrHeYSkhqoKhhfG8ItOohgY10uqd369RyaZsXqvrDGo2eNV9Mp/x3bX5RKoWdTyhpCQywiiyLTKgQZf/EsV59atusvqIgDd0wJ6daKTg9kPDltttBEgYfneM38nPI+HwdtOR452KPzuvX7mxZfv2Jph96WTuGnp+AIjTQ06gSfasp4a7RgmoZFzseon5u9zHQaUo6enk5B4ew6w/yX702FJ0mlfyYJOXovt+Pxa+NJGvUEOWHjW8TMnLNuYOL1KRMfrFvrNEVzzMGL+MX/P9zz03Bv2oQjp76tPGEsiY0tTfpjVMGbsX64uJ6Lg4AFBoUfgI8mAo+qdJqqMDrWKB26l+HKvF01UQ3K2juNYbV6PEE+Io2PD7GuRDt+cqSd5Wm1xcAHD6IE4v1ZnLo0ru+waoB9cPt+epUugwTqltMmieN6Zz01SV1YRyy8l07LddZSymdtPjeyzJjAzCqZhe3H7i53KPiA726efLRDwZlvrU+YO7ZxDPd2+nY6isSiT6A81MMDzo6oGMVphUeRwiDt87NguTboPidDjmWhLwPd3ei/up7dXCxnLxezxWJ+9al/BnR6TXSU5wGlczE4xOtWCHrpD32J/vH3MpSTNhsb1LuyugrPExTX5TrTikM5DdgKGaa+kIr0HoU0qVA2LzLkS6lwNhz29c1foofdWCdyazRZLuigSc6WXAk7a4mLvO1YqUIO20LioHwSx/f39xMl89KkcqJsziRkWqHxgceOtz+7neiRcmqVH7S1DevY4QYdGoVxB+TjowcAnE2mk2lbVZ5yaQ4MPaNzjogbckT4D8VFJrVh4OBl3XXVLezPWM/xTZ4wyCrq+uMW6notPf7lsqbh7a8lutDiD+0Umi/Vnr9TSDYy83jixXAhwk/dWyP9WfzHQ3LU875wTRU6Oit5Bd1jLfw2qyaCHcoUXXCtPblQCgs60Dl5MHLPDLfOx9kSIpAl8zNw+KiuA/qoP7+9CwJiae/Q/D54R7xk/5rmX5p7AyA= +api: eJzlVlFvGzcM/isCn9bu6nPadCjuLcDcIsvQBLGHPQTGIOtoW82ddJV4zoyD/ntB6ezY8aXNHoe+2CeJ/Eh+JEV1QHLlobiD31Fpr625xa+tdlijIQ/zDGyDTpK25rKEAhbbK9z+8x4yaKSTNRI61u7AyBqhgHvcQgbaQAGNpDVkUKJXTjeMAAVc4VbYpSh7Y8IdWsugX5ZQkGsxA6/WWEsoOqBtw/jaEK7QQQZL62pJaeu3cwhhzuq+scajZ4234zH/HduftkqhZ1PKGkJDLCKbptIqBpl/8SzXnVq2iy+oiAN3TAnpZEWXBzKenDYrCFnk4SVeMz+nvF8OgyaOBw426LxOfn/X4ru3LO3Q29Yp/PwcHKGRhgad4FNNFW8NFkwILHI+RP2l2chKlzHl6On5FDTOLiqsf/2vqfAkqfUvJKFG7+VqOH5tPEmjniEnbnyPmIlz1u2ZeHfKxEfrFros0Rxz8Dp//f8P9/w03NuUcOTUp8oTxpJY2taUP0cVvB/qh4ubS3EQsMCo8BPwETLwqFqnaRtHxwKlQ/cmXpl385B1oKy91xhX86cT5BPS8PgQi61I46dGWlueViuMfPAgKiDfnOWlK/PuHrcB2Ae32U2v1lVQQJc4DUWed2vrKRRdYx2x8EY6LRdVopTPUj6Xsq2YwMoqWcXtp+7O1ij4gO9unny0RsGZT9ZHzB3bOIb7MP4wHkRi0WdQHuvhEWdN1AziJOFBpDhId/mZslwKepeTfY5lo68i3f3ov76Z3F7MJm+mk+n08vrz7hnQ64XsKM97lN7F6BCvkxDspD/uSvSPv2exnLRZ2qjel9V1fJ6guGkXlVYcymnAVsg49YVUpDcopCmFsnVTIV9KjbPxcFff/CV2sEvrRG2NJssFHTXJ2ZYrYW0tcZGnjpUq5jAVEgflizx/eHgYKVm3ppQjZWsmodIKjY889rz92e9kT5RLq/xeW9u4zh0u0aFRmPdAPj96AMDZaDwap6ryVEtzYOgFnXNE3D5HhP9S3lRSGwaOXnZ9V93B5oz1HN/kBYPMs74/7qDrFtLjX64Kgbe/tuhiiz+2U2y+Unv+LqFYysrjiRf7CxF+6d8a5Svxg4fkoOe7wjXb2NFVyyvoH2vxN8xDBmuUJbroWjq5UAobOtA5eTByz+xvnU+TGWQgW+Znz+GTuo7og/50XZKY2Xs0IezdI16zgyF8A729BJY= sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision requirements by key

+ - + Get decision requirements by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-6.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-6.api.mdx index 2af5df108f0..6dfe598cd29 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-6.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key-6.api.mdx @@ -5,55 +5,150 @@ description: "Get decision definition by key" sidebar_label: "Get decision definition by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivEfdo6xXLarCiEYUCGuoWXoQlib/sQGANNnW02EqmSJ6eGoP8+HCm/xUrWfBz6xRbJe334HO8aILn0kN3Be1Taa2ve40IbTdoamCVgK3SSF+McMphvrnDzz1tIoJJOlkjoWLcBI0uEDO5xAwloAxlUklaQQI5eOV0Fcxlc4UbYhcg7VyLf+0rA4ZdaO8whI1djAl6tsJSQNUCbiq1rQ7hEBwksrCslxa23F9C2M1b3lTUePWu8Hg7579j7pFYKvYcElDWEhlhEVlWhVUgx/exZrjn1bOefURGn7RgQ0tGLzg9kPDltltAmAYVviZrRiUCM+w1FVHsO1ui8jrE+6+XN60MvtxHgEg35Jzz2iV69OJ1D7U9P5dAn/NeL8iI00lBvJnyqqeCtHl63LQtc9HFkbNay0LlgMqKnp7lSOTsvsPzppZzxJKn235hhid7LZT9+2niSRvUfxo3nYBk5Z90OiTenSHywbq7zHM0xBq/SV///dC9O072NF4589d7WTqEwlsTC1ib/Pljwc189XN6MxUHCAoPCd4BHm4BHVTtNm9Dh5igdurPwtt/N2qQBZe29xrCaPW50H5H6upyYb0TskSXSynJLXWJAg7tlBun6PN2qne3VfNrc46YFDsmttz23dgVk0ESI2yxNm5X11GZNZR2x8Fo6LedFRJjP4vUuZF0wnoVVsgjbj6OfrlDwAfcf7te0QsFEiN4HDCX7ODb3bvhu2GuJRZ+wsqfH3s6KqOq1E4V7LYUBYHtdE5aLSW+vaHflstJXAf9uYLm+Gd1eTkdnk9FkMr7+tB1eOr02Obr2nZUuxBAQr6MQbKU/bBn7+9/TwC5tFjaodyy7DkMVipt6XmjFqZwmbIUM04qQivQahTS5ULasCuQ3qnI2HG7pzl9ia3ZhnSit0WSZ30GTnK2ZCStriTkfC1iqcIeRSJyUz9L04eFhoGRZm1wOlC0ZhEIrND7g2OH2R7eTPFLOrfI7bW3DOnW4QIdGYdoZ8unREAPng+FgGFnlqZTmwNF/FtIRbLsbIvxKaVVIbdhsiLHpiuwO1uewHz8OywwSyNjqLOnK5Q6aZi49/umKtuXtLzW68ADsqyvUYq49f+eQLWTh8SSs3XMJP3TzTv6jeHYa7k1ky2KzCeVd1LyCbuIMv+2sTWCFMkcXAosnl0phRQc6J1MvF9DuTfo4mkICsma4dpA+Inmw3hvPL78FATG192h+3UVHvOT42vZf5I9HyQ== +api: eJzlVt1v2zYQ/1eIe9o6xXLarCj0FqBukWVogtjbHgJjoKmzzUYiVfLkzBD0vw9HSv6Ilax5HPpii+R9/vg73jVAcuUhu4ePqLTX1nzEpTaatDUwT8BW6CQvrnLIYLG9xu3f7yGBSjpZIqFj3QaMLBEyeMAtJKANZFBJWkMCOXrldBXMZXCNW2GXIu9ciXzvKwGH32rtMIeMXI0JeLXGUkLWAG0rtq4N4QodJLC0rpQUt95fQNvOWd1X1nj0rPF2POa/Y+/TWin0HhJQ1hAaYhFZVYVWIcX0q2e55tSzXXxFRZy2Y0BIRy86P5Dx5LRZQZsEFL4nakYnAnE1bCiiOnCwQed1jPVFL+/eHnq5iwCXaMg/43FI9PrV6Rxqf3kuhyHhP1+VF6GRhgYz4VNNBW8N8LptWeBiiCNXZiMLnQsmI3p6niuVs4sCy19eyxlPkmr/nRmW6L1cDeOnjSdp1PBh3HgJlolz1u2QeHeKxCfrFjrP0Rxj8CZ98/9P9+I03bt44chX723tFApjSSxtbfIfgwW/DtXD5e2VOEhYYFD4AfBoE/CoaqdpGzrcAqVDdxbe9vt5mzSgrH3QGFbzp43uM9JQlxOLrYg9skRaW26pKwxocLfMIN2cp73a2V7Np80DblvgkNym77m1KyCDJkLcZmnarK2nNmsq64iFN9JpuSgiwnwWr3cp64LxLKySRdh+Gv1sjYIPuP9wv6Y1CiZC9D5iKNnHsbkP4w/jQUss+oyVPT32dtZE1aCdKDxoKQwA/XVNWS4m3V/R7splpa8D/t3AcnM7ubucTc6mk+n06uZLP7x0em1ydO07K12IISBeRyHopT/1jP3tr1lglzZLG9Q7lt2EoQrFbb0otOJUThO2QoZpRUhFeoNCmlwoW1YF8htVORsOe7rzl+jNLq0TpTWaLPM7aJKzNTNhbS0x52MBSxXuMBKJk/JZmj4+Po6ULGuTy5GyJYNQaIXGBxw73H7vdpInyrlVfqetbVinDpfo0ChMO0M+PRpi4Hw0Ho0jqzyV0hw4+s9COoJtd0OE/1BaFVIbNhtibLoiu4fNOezHj8MygwQytjpPunK5h6ZZSI9/uKJteftbjS48APvqCrWYa8/fOWRLWXg8CWv3XMJP3byT/yxenIYHE+lZbLahvIuaV9BNnOG3nbcJrFHm6EJg8eRSKazoQOdk6uUC2r1JnyczSEDWDNcO0ickD9YH42maKDGzD2jadhce8ZoDbNt/AUyJST8= sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision definition by key

+ Get decision definition by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key.api.mdx index 11ffbbedf5d..fbfe1a9ecc1 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/by-key.api.mdx @@ -5,52 +5,147 @@ description: "Get variable by key" sidebar_label: "Get variable by key" hide_title: true hide_table_of_contents: true -api: eJzlVt1v2zYQ/1eIe9pa1XLabCiEYkAKuIWXYQlir30I/EBRZ4uNRKrkyakh6H8fjvpIHKtr+zj0xRZ5H7z73R1/bIDkzkNyCx+k0zItEDYR2AqdJG3NMoME0sMlHiCCSjpZIqFj/QaMLBESuAsybSCBSlIOEWToldMV20MCl3gQdiv2g/sIHH6utcMMEnI1RuBVjqWEpAE6VOxSG8IdOohga10pqdv6/RzadsPmvrLGo2eLl/M5/x0fuaqVQu8hAmUNoSFWkVVVaBWyij951mtOT7bpJ1TEuTrGgHR3Cuf4PeEFOz56aTxJo/Dyuw29stUPqHfgj6qenDY7FuxlUU9LyNVGSWLcR2lqbYHSBDEaaWiZTdiyVFPBW2OXtC1vn0/BvzR7WehMcJ3R09fLUDmbFlg+/9FyeJJU+28i9eol51Wi93I3DYnuyzSNV9j4LzAWzlk3IvHqFIl31qU6y9AcY/Asfvb/T/f8NN2bruDIpfe2dgqFsSS2tjbZz9EFv03Nw8X1UjxKWGAw+Anw4GsNVe00HQJjpCgduhfhNr3dtFEDyto7jWG1eUoc75FG1hDpQXREUyLllllphwECppwE4v1ZPOj6uLnDQwt8uNsPbFW7AhJoOjDbJI6b3Hpqk6ayjlh5NOfsWNYVcivrgpErrJJF2H4a5zpHwQK+kpnpKEfBJe9OnwVWsO6Ju9fz1/NJT6z6FS8PjfDgJyeqJv10ypOeAosOhVmxXpf0UIyxuLLSHfP3VH91vbi5WC9erBar1fLq74H2e7s2Oirw6KUPMQQUOCcowaD9bujNPz+uQx9ps7XBvO+nq/AYQXFdp4VWnMppwlbIQPlCKtJ7FNJkQtmyKpBvo56UxdDY/CUGt1vrRGmNJsudHCzJ2Zo7IbeWuLu7UZUq1LBrJE7KJ3F8f38/U7KsTSZnypYMQqEVGh9w7HH7q9+JnhhnVvnRWtuwjh1u0aFRGPeOfBx4HZ3vkj2bzWfzrqs8ldI8Omh6ZI6wGstC+IXiqpA6sH8IrOnH6Rb2Z0cTEUHCrjZRPxi30DSp9PiPK9qWtz/X6MJQP1iFqcu05+8Mkq0sPJ7EMl6B8MtN/yr8VZy+GCdDHprUHGB89gBE3WMt/LabNoIcZYYuRNNJLpTCih7ZnLwMeT7Ge+b9Yg0RyJqBeXg3Hfdw8D4Zz5u3QUGs7R2aP8boiJccX9v+C4wh7NA= +api: eJzlVk1z2zYQ/SuYPbUpI8qJm8nw5oOSUd2pPZbaHDw6gOBKQkwCDLCUq+Hwv3cWIGnLYtrk2MlFIrAf2H27i4cWSO48ZPfwl3Ra5iXCJgFbo5OkrVkWkEF+vMYjJFBLJyskdKzfgpEVQgYPQaYNZFBL2kMCBXrldM32kME1HoXdisPgPgGHXxrtsICMXIMJeLXHSkLWAh1rdqkN4Q4dJLC1rpIUt95dQtdt2NzX1nj0bPFmPue/0yNXjVLoPSSgrCE0xCqyrkutQlbpZ8967fnJNv+MijhXxxiQjqdwjt8SXrDjo5fGkzQKr7/Z0Ctbf4d6BH9U9eS02bHgIMtmWkKuMUoS4z5Kc2tLlCaI0UhDy2LClqWaSt4au6TrePtyCv6lOchSF4LrjJ6+Xoba2bzE6pfvLYcnSY3/T6TevuG8KvRe7qYh0X2ZpvEKG/8GxsI560Yk3p4j8cG6XBcFmlMMXqWv/v/pXp6nexcLjlx6bxunUBhLYmsbU/wYXfDr1Dxc3S7Fs4QFBoMfAA++1lA1TtMxMEaO0qF7HW7T+02XtKCsfdAYVpuXxPERaWQNkR9FJJoKaW+ZlXYYIGDKySA9XKSDrk/bBzx2wIe7w8BWjSshgzaC2WVp2u6tpy5ra+uIlUdzzo5lsZBb2ZSMXGmVLMP2yzjXexQs4CuZmY72KLjk8fRZYAXrXrh7P38/n/TEql/x8tQIT372RPWkn6g86Smw6FCYFevFpIdijMWVtY7M31P9ze3i7mq9eL1arFbLmz8G2u/tuuSkwKOXPsQQUOCcoASD9oehN3/7tA59pM3WBvO+n27CYwTFbZOXWnEq5wlbIQPlC6lIH1BIUwhlq7pEvo16UhZDY/OXGNxurROVNZosd3KwJGcb7oS9tcTdHUdVqlDD2EiclM/S9PHxcaZk1ZhCzpStGIRSKzQ+4Njj9nu/k7wwLqzyo7W2YZ063KJDozDtHfk08Do6H5O9mM1n89hVnippnh00PTInWI1lIfyb0rqUOrB/CKztx+keDhcnE5FAxq42ST8Y99C2ufT4pyu7jre/NOjCUD9ZhakrtOfvArKtLD2exTJegfDTXf8q/FmcvxgnQx6a1BxhfPYAJPGxFn67TZfAHmWBLkQTJVdKYU3PbM5ehjwf4z3zcbGGBGTDwDy9m057OHifjKdto8baPqDpujE84jUH2HX/AJki7kY= sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get variable by key

+ - + Get variable by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/delete.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/delete.api.mdx index eb7cc632ca5..b756e60d7bd 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/delete.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/delete.api.mdx @@ -5,57 +5,142 @@ description: "Delete process instance and all dependant data by key" sidebar_label: "Delete process instance and all dependant data by key" hide_title: true hide_table_of_contents: true -api: eJzlVktv3DYQ/ivEnNpUXq0TtwiEooDbbAA3QW14t+jB2AOXml0xlkiFHK2zEPTfiyEleV/u61bkJJGc58dvZtgCyY2H7AHunFXo/Y3xJI1CWCZga3SStDU3OWSQY4mEkEAtnayQ0LFeC0ZWCBk84g4S0AYyqCUVkECOXjldswHI4APuhF2LOroRevCTgMPPjXaYQ0auwQS8KrCSkLVAu5pNa0O4QQcJrK2rJMWtH66g65as7mtrPHrWeD2d8ufQ9bxR7BMSUNYQGmIRWdelViG99JNnufbUs119QkWcs2MwSEcvFXovN7gn6Mlps4Eu6WHK/1n4CZCmkoV+KaTZ4JwkNR66jo+uzuVyY7ay1Llg0NDTyznVzq5KrL77t7n5GMLfhf/mNSf7V0CMN3zuMG6cHOwBMnPOuhGJN6dIvLdupfMczSEGr9JX//90r07TvY8Xjnz13jZOoTCWxNo2Jv86WPD9uXq4vrsRewkLDApfAR5dAh5V4zTtQhteoXToLrgNZw/LLmlBWfuoMayWx934XehSJ91YSJMLWZYixxpNLg2JXJIUq52I/b1CKuzRNKACMki3l2lv7WKw5tP2EXcdcKRuO8yLxpWQQRuR77I0bQvrqcva2jpi4a10Wq7KCDyfxVtfy6ZkmEurZBm2j5NaFCj4gCcSzxoqUDA/ovcJI8w+Ds29nb6dnrXEoi9YeWbNs52CqD5rJwqftRTm13CLc5aLSQ83NzJB1vpDwL8ftrd3s/vrxexiPpvPb25/GwZvr9clB2wYrfQhhoB4HYVgkH4/EPnXPxaBdNqsbVDvyXcb3gMo7ppVqRWncpqwFTIMWyEV6W0klLJVHYbiCd/4Twxm19aJyhpNlmkfNMnZhplQWEtcCrGupQp3GInESfksTZ+eniZKVo3J5UTZikEotULjA449bh/7neRIObfKj9rahnXqcI0OjcK0N+RTtspEjsleTqaTaWSVp0qaPUf/tb4O0BwvjvALpXUptWFvIfS2L7wH2F7GbnVYepBAxiaXSV9CD9C2K+nxd1d2HW9/btCFXvFccaE+c+35P4dsLUuPJzGNnRW+ue9fbt+Kl193Z1MYaG12od7LhleQhEdkfEp2yy6BAmWOLkQVT66Vwpr2dE5ecVxRY5N6N/s4W8wgAdkwViOeR8QPDs6G9OPPQUAs7COan8YAiZccYtf9CSey2/E= +api: eJzlVktv4zYQ/ivEnNqtYjm7abHQLeh6AXcXTRC76CHwgabGFjcSqSVHTg1B/70YUlL8Sl+3Yk8SyXl+/GaGLZDcesge4d5Zhd7PjSdpFMIqAVujk6StmeeQQY4lEkICtXSyQkLHei0YWSFk8IR7SEAbyKCWVEACOXrldM0GIINPuBd2I+roRujBTwIOvzbaYQ4ZuQYT8KrASkLWAu1rNq0N4RYdJLCxrpIUt366ga5bsbqvrfHoWePtdMqfY9eLRrFPSEBZQ2iIRWRdl1qF9NIvnuXac892/QUVcc6OwSAdvVTovdzigaAnp80WuqSHKf9n4SdAmkoW+rmQZosLktR46Do+urmUy9zsZKlzwaChp9dzqp1dl1j98G9z8zGEvwv/3VtO9q+AGG/40mHcODs4AGTmnHUjEu/Okfho3VrnOZpjDN6kb/7/6d6cp/sQLxz56r1tnEJhLImNbUz+bbDgx0v1cHs/FwcJCwwK3wAeXQIeVeM07UMbXqN06K64DWePqy5pQVn7pDGsVqfd+EPoUmfdWEiTC1mWIscaTS4NiVySFOu9iP29QirsyTSgAjJId9dpb+1qsObT9gn3HXCkbjfMi8aVkEEbke+yNG0L66nL2to6YuGddFquywg8n8Vb38imZJhLq2QZtk+TWhYo+IAnEs8aKlAwP6L3CSPMPo7NvZ++n160xKKvWHlhzYudgqi+aCcKX7QU5tdwiwuWi0kPNzcyQdb6U8C/H7Z397OH2+XsajFbLOZ3vw6Dt9frkiM2jFb6EENAvI5CMEh/HIj8y+/LQDptNjao9+S7C+8BFPfNutSKUzlP2AoZhq2QivQuEkrZqg5D8Yxv/CcGsxvrRGWNJsu0D5rkbMNMKKwlLoVY11KFO4xE4qR8lqbPz88TJavG5HKibMUglFqh8QHHHrfP/U5yopxb5UdtbcM6dbhBh0Zh2hvyKVtlIsdkryfTyTSyylMlzYGj/1pfR2iOF0f4B6V1KbVhbyH0ti+8R9hdx251XHqQQMYmV0lfQo/Qtmvp8TdXdh1vf23QhV7xUnGhPnPt+T+HbCNLj2cxjZ0VvnvoX27fi9dfdxdTGGht9qHey4ZXkIRHZHxKdqsugQJlji5EFU9ulcKaDnTOXnFcUWOT+jD7PFvOIAHZMFYjnifEDw4uhtS2UWJpn9B03Rgh8Zpj7Lo/ASPU3Wc= sidebar_class_name: "delete api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

- Delete process instance and all dependant data by key -

+ Delete process instance and all dependant data by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/get-statistics.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/get-statistics.api.mdx index 9b0793cadfe..da460cb759c 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/get-statistics.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/get-statistics.api.mdx @@ -5,57 +5,173 @@ description: "Get flow node statistic by process instance id" sidebar_label: "Get flow node statistic by process instance id" hide_title: true hide_table_of_contents: true -api: eJzlV0tv4zYQ/ivEnNqtYjm7abEQigIpkCzSLTZB7KKHwAeaGlvcSKSWHNk1BP33YqhH7EhBkdyKzSXmY17ffDMc1UBy6yF5gDtnFXp/YzxJoxBWEdgSnSRtzU0KCWyRFiRJe9LKQwSldLJAQsfiNRhZICTwiAeIQBtIoJSUQQQpeuV0yXoggc94EHYjytaa0L25CBx+q7TDFBJyFUbgVYaFhKQGOpSsWhvCLTqIYGNdIand+uUCmmbF4r60xqNniffzOf87Nb2oFNuciXukyhkv/BCO2FgnKEOx1Ts0I+8isXW2KjEV64PY5HYvjE2RQVDWEBpiY7Isc60CXvFXzxbrcQzSORkAIiz80b5df0VFjKpj1Em3cUhFeqfpwAkY7npy2mxHyC4zFDplcDmQwcsQ2j7TKgv7Dn2VkxfSoZDbrcOtJEyhiVpbOIn32BBZkrkwVbFGxyZb4QEwP3JjImsRKL6bY/pGo734a81qo3SKhvwb7Q7yA23+I0xblDnS2+Ps5V8XaBMBacrZ2nVu919sikcF3PBfBBdTlXJjdjLXqeCSRE8v87x0dp1j8dOLfH+B11x51TT8x1F8eM/wFei93OK4AkIqu/4xddhujA6OcLlyzjrokfgwRuLaurVOUzSnGLyL3/3/w70Yh3vfJhw59d5WTqEwlsTGVib9Pljw81Q9XN7diKOABQaB7wCPJgKPqnKaDuGRX6N06M74kU8eVk1Ug7L2UWNYrZ73sk9IR+/Q8NryI/r8hRWa+VUgZbabNcKEQRkkEO/O4+7+2dAA4/oRD03sjycSj27XjyOVyyGBuoW+SeK4zqynJqlL66iBCHbSabnOW+T5rE37RlY545xbJfOwPdWh+YAHnr4NM0Fa6zOGmG2cqvs4/zif1MRXX9DyRJsnPRlROamnvTypKYxHfRoXfK8Nuk/d03BS6s9hfOtmudu7q/vL5dXZ4mqxuLn90s91nVwTndBh0NK5GBzidXsJ+tvXPZP/+HsZWKfNxgbxjn23YepEcVetc604lHHAVsgwy/VzhzTp0Sv5nFz8S/Rq+ckurNFkmfdBkpytmAmZtdROVlzYUoUctkTioHwSx/v9fqZkUZlUzpQtGIRcKzQ+4Njh9me3Ez0TTq3yg7S2YR073KBDozDuFPmYtTKR22DPZ/PZvGWVp0KaI0OvLrATGIeMEf5DcZlLbdhM8Lnuiu8BdudtnzotP4ggaUf9owpcRV0hPUBdr6XHv1zeNLz9rUIXWsZT3YUqTbXn3ykkG5l7HDk4NFj44b77PPhRvPwJMRlPT25zCFWfV7yCKHyptN8rzaqJIEOZogtetSeXSmFJRzKjAZ/ramhZn66WEIGsGLUB2WfcD9on/fn193BBLO0jmt8G74iX7F/T/Au9Rrd6 +api: eJzlV0tv20YQ/iuLObUpLcpJWgS8+WAHborYsFz0YOiwWo7EjcldZncoVSD434NZPkyZNAr7VsQXax/z+uab2WENJHcekge4dVah99fGkzQKYR2BLdFJ0tZcp5DADmlFkrQnrTxEUEonCyR0LF6DkQVCAo94hAi0gQRKSRlEkKJXTpesBxL4gkdht6JsrQndm4vA4fdKO0whIVdhBF5lWEhIaqBjyaq1Idyhgwi21hWS2q0/PkLTrFncl9Z49Czxfrnkf6emV5Vimwtxh1Q544UfwhFb6wRlKHZ6j2biXSR2zlYlpmJzFNvcHoSxKTIIyhpCQ2xMlmWuVcAr/ubZYj2NQTonA0CEhR/t2803VMSoOkaddBuHVKT3mo6cgOGuJ6fNboLsfYZCpwwuBzJ4GUI7ZFplYd+hr3LyQjoUcrdzuJOEKTRRawtn8Z4aIksyF6YqNujYZCs8AOYnbsxkLQLFd3NM32i0F3+tWW2UTtGQf6PdQX6gzX+EaYsyR3p7nL386wJtIiBNOVu7yu3hq01xVMAN/0Xwca5Srs1e5joVXJLo6WWel85ucix+e5HvL/CaK6+ah38cxYf3DF+B3ssdTisgpLLrH3OH7cbkYITLpXPWQY/EhykSV9ZtdJqiOcXgXfzu/x/ux2m4d23CkVPvbeUUCmNJbG1l0p+DBb/P1cPF7bUYBSwwCPwEeDQReFSV03QMj/wGpUN3xo988rBuohqUtY8aw2r9vJd9Rhq9Q8Nry4/o8xdWaOZXgZTZbtYIEwZlkEC8P4+7+2dDA4zrRzw2sR9PJB7dvh9HKpdDAnULfZPEcZ1ZT01Sl9ZRAxHspdNyk7fI81mb9q2scsY5t0rmYXuuQ/MBDzx9G2aCtNYXDDHbOFX3aflpOauJr76g5Yk2T3oyonJWT3t5VlMYj/o0rvheG3SfuqfhpNRfwvjWzXI3t5d3F/eXZ6vL1er65ms/13VyTXRCh0FL52JwiNftJehvX/VM/vOf+8A6bbY2iHfsuwlTJ4rbapNrxaFMA7ZChlmunzukSUev5HNy8S/Rq+Unu7BGk2XeB0lytmImZNZSO1lxYUsVctgSiYPySRwfDoeFkkVlUrlQtmAQcq3Q+IBjh9tf3U70TDi1yg/S2oZ17HCLDo3CuFPkY9bKRG6DPV8sF8uWVZ4KaUaGXl1gJzAOGSP8l+Iyl9qwmeBz3RXfA+zP2z51Wn4QQdKO+qMKXEddIT1AXW+kx79d3jS8/b1CF1rGU92FKk21598pJFuZe5w4ODRY+OWu+zz4Vbz8CTEbT09ucwxVn1e8gih8qbTfK826iSBDmaILXrUnF0phSSOZyYDPdTW0rM+X9xCBrBi1Adln3A/aZ/2p6/bGvX1E0zSDe8RrdrBpfgCU8bjw sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

- Get flow node statistic by process instance id -

+ Get flow node statistic by process instance id -## Request - -

Path Parameters

- -Success. Returns statistics for the given process instance, grouped by flow nodes - -
Schema
  • Array [
  • ]
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-api.info.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-api.info.mdx index 9ea6e3d454d..cabe55b339c 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-api.info.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-api.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Operate Public API

+ To access active and completed process instances in Operate for monitoring and troubleshooting
-

- Authentication -

+
@@ -69,9 +77,7 @@ To access active and completed process instances in Operate for monitoring and t >

Contact

- - URL: https://www.camunda.com - + URL: [https://www.camunda.com](https://www.camunda.com)

License

diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-1.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-1.api.mdx index 5cba3950265..a8ab51ec272 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-1.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-1.api.mdx @@ -5,59 +5,240 @@ description: "Search process instances" sidebar_label: "Search process instances" hide_title: true hide_table_of_contents: true -api: eJztWG1PIzcQ/ivWfOHuupDl7V6iqhIHQeJ6BUpS+gGiyvFOEh+79p7tBdIo/70ae5NssgsXpPZD2+MTsWfG42eeefFOwfGRhfYNXBot0NozZR1XAqEfgc7RcCe1OkugDRa5EeM/diECg18LtO6jTibQnkKCVhiZkyS0oevlWB7sMVkatBCB0MqhcqTD8zyVwltvfbGkOAUrxphx+s9NcoQ26MEXFA4iyA354iRa2h3K1KH5ttwdTipCUjkcoYEIhtpk3IWltwcw83rk7DUaK4Mvzyrt79WVenxU0bPOSDUiqUGeqTm2SaNEzg0q9/Pmznr501Q/nOsE5wHbXN86btwJd9joDarkyT3rGndIqciIREfHvbPrDkRwfPHL5edOr3NC/x+dH3c+d06gP4tAKiGTkgOllYHWKXJVgfQEh1JJ4sbmt3KouHLPQrxGcW8bhDSiSLl5tbb72huVLiVL68lBWMg/cUOihMw5Gq6SlhvDJxCBdJjZOplnpKiN21yjniaYNsOhTbLiSj2O3WOI4KTTPYb+rIJDlxyaVVd+LdBMGuDBR57laXDkKE3rZeIKXWGUZTxN67WCvUpwyIvUMePFWCqtYwQ5k5btxq8hgnueFhQB8ob8woQNJmxx6ebT6ifZoMqtQJVINSIjqzm7PKoMyM0CW1iXLJH1AM76Fde4SljOR5iwB+nGbM6eZi8z/sj2G3zlRCG2NZCja27KY7e86TucsLfvDg/3P3w4ONiNDw/fv4u/fTV2q3qajdAxN0am8NF5H5nQ+cQv+YszPWRbZOuaftktJpXTbKvC6q0guHOr6LbM5ijksKzuzI51kSYs406MvdGK4qroCtIeoP3opZCvZdsNrIAF0TpIPkanvqGUUQqoPR+cw7genYgN52YGE7baHAjCvZdRbdnk1pvT3qL6HMYvxmfm/6iF21wrGxJ0L44b+nghAmR/V9teL1svLGffu/n3bv4PdfOy1Yb69rIW7bTj6UaXqjhwhbZIna37QUIHTcl4wh1nUt3zVCZPZ2Ru9CDF7IeXZiYxobAbJkqG1vJRM6XmxbBxMyzUNiq4dIzRZgHDfh2GU20GMklQrWLwpvXm33/dg/p1z7Vjp7pQyX/uuodNJD+6PGMVOjP0Cv8Dtvs3giiMdBPfygfIDZpt3/Fu+rNoCkLrO4n+Vz/a/MGdoRtrGgpybT0Q3I2hDa373VYpvr0Qb4XBCcgXc4/GelcKk0IbpgHbWbvVmo61dbP2NNfGzfzAYiQflJM+7YW4+ukd2pBqwdNxOH3V7d4YGW0onvkRk0ZDYkA4fccX+vL9szT3Pn4fN1oi0SesLHmxtDN2Lm+0E4QbLc3CdBni1CW5cOl5bJZtI5fUjSKgq0EbLi47V0e9zna30+2eXZxTQ6HjSj2aKirxXlgpXfQO+cbqhWAufTqn6qffe55WlAZXyw8znfAAWx0l/QlxfUKqLfn5ZzkRrI09y43KtBM/O8vEK5NKddZI1pfKuWQ5fiynDGcKfGquiKtTQ3XM8aNyvP4wmPporg/PCyfWpmZyYqh9dMrsvfAfx5BdFoNUCmJKnU+acT9DMy6cvEf/vBCawkLvgPr7Tio2NzvUhmVaSafJIa/pjC4o0cZau+AkFUYufIqEPCXO2Har9fDwsCN4VqiE7widEQypFKis50NJy8/lSrSmnGhhF9pS+98tg0M0qAS2SkO2RVbv5wyC3Z14Jw5Ja13GVeWgZwrUCmAL6jt8dK085dKPkd67aVm7buB+FxYU2K7aKutXPyrL0A1MpwNu8TeTzma0/JW+VVANXVatUF9hjDwJrAgpAseh5Wz3yKHFq6z+/KHaHDSOhMDcPSvbrxTky4tujxKr/ISa6YR0DH+gz6v8AdpwC7dARPTg+ELj16eQcjUqfE+CYJeynxeEznIKXy0W/mbz6qQmFS9//OgFWE/fofoJovI2jn6G5+Jf7YeYrw== +api: eJztWEtz2zYQ/iuYvThJaYt+5aGba8szblPbtVT34Gg6ELiSkJAAA4C2VQ3/e2cBSqJE2pFn2kPb+GQBu4vFt98+wDk4PrHQvYNrowVae6Gs40ogDCPQORrupFYXCXTBIjdi+sc+RGDwa4HW/aiTGXTnkKAVRuYkCV3oezmWB3tMVgYtRCC0cqgc6fA8T6Xw1jufLSnOwYopZpz+c7McoQt69BmFgwhyQ744iZZ2xzJ1aL4t9wVnNSGpHE7QQARjbTLuwtLbIyi9Hjl7i8bK4MuzSocHTaUBn9T0rDNSTUhqlGdqgW3SKpFzg8r9vL2zXv481Q+XOsFFwLbXt44bd8YdtnqDKnlyz7rWHVIqMiLRyeng4rYHEZxe/XL9sTfondH/J5envY+9MxiWEUglZFJxoLIy0jpFrmqQnuFYKknc2P5WDhVX7lmINyjubYOQRhQpN682dl97o9KlZGkzOQgL+SduSZSQOSfjddJyY/gMIpAOM9skc0mK2rjtNZppgmk7HNoka64049g/hQjOev1TGJY1HPrkUFlf+bVAM2uBBx95lqfBkZM0bZaJG3SFUZbxNG3WCvYqwTEvUseMF2OptI4R5Exath+/hgjueVpQBMgb8gsTNpqx5aXbT2ueZIMqtwJVItWEjKzn7OqoKiB3S2xhU7JC1gNYDmuucZWwnE8wYQ/STdmCPe1eZvyRHbb4yolCbGckJ7fcVMfueNNfcMbevjs+Pvzw4ehoPz4+fv8u/vbV2Cc10GyCjrkpMoWPzvvIhM5nfslfnOkx2yFbt/TL7jCpnGY7NVbvBMG9T4puy2yOQo6r6s7sVBdpwjLuxNQbrSmui64h7QE6jF4K+Ua23cEaWBBtguRjdO4bShWlgNrzwTmOm9GJ2HhhZjRj682BIDx4GdVWTW6zOR0sq89x/GJ8Sv9HLdzmWtmQoAdx3NLHCxEg+7va9mbZemE5+97Nv3fzf6ibV6021LeXtWinHU+3ulTNgRu0Reps0w8SOmpLxjPuOJPqnqcyeTojc6NHKWY/vDQziQmF3TJRMrSWT9optSiGrZthobFRw6VnjDZLGA6bMJxrM5JJgmodgzedN//+6x41r3upHTvXhUr+c9c9biP5yfUFq9GZoVf4H7DdvxFEYaSb+VY+Qm7Q7PqOdzcsozkIrb9I9L+G0fYP7gzdVNNQkGvrgeBuCl3o3O93KvHdpXgnDE5Avph7NNa7UpgUujAP2JbdTmc+1daV3XmujSv9wGIkH1WTPu2FuPrpHbqQasHTaTh93e3BFBltKJ75EZNGQ2JAOH3PF/rq/bMy9z5+H7daItEnrKx4sbIzdS5vtROEWy2VYboMceqTXLj0IjartpFL6kYR0NWgC1fXvZuTQW+33+v3L64uqaHQcZUeTRW1eC+tVC56h3xj9UKwkD5fUPWn3weeVpQGN6sPM73wAFsfJf0JcXNCaiz5+Wc1EWyMPauN2rQTPzvLxGuTSn3WSDaXqrlkNX6spgxnCnxqrojrU0N9zPGjcrz5MJj7aG4Oz0snNqZmcmKsfXSq7L3yH8eQXRejVApiSpNPmnE/QzMunLxH/7wQmsJC74Dm+04qtjA71oZlWkmnySGv6YwuKNGmWrvgJBVGLnyKhDwlzthup/Pw8LAneFaohO8JnREMqRSorOdDRcuP1Uq0oZxoYZfaUvvfHYNjNKgEdipDtkNW7xcMgv29eC8OSWtdxlXtoGcK1BpgS+o7fHSdPOXSj5Heu3lVu+7gfh+WFNit26rq1zCqytAdzOcjbvE3k5YlLX+lbxVUQ1dVK9RXmCJPAitCisBpaDm7A3Jo+SprPn+oNgeNEyEwd8/KDmsF+fqqP6DEqj6hZjohHcMf6PMqf4AuEAk9ML7I+LU5pFxNCt+PINikzOcFIbOawNcLhb/VojKpWc3D+TxIDPQXVCUV83AVR7/DW/EvcbmZKQ== sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search process instances

+ Search process instances -## Request - -

Body

- -Search process instances - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-2.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-2.api.mdx index d59e2ac1312..9b6fb57462b 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-2.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-2.api.mdx @@ -5,59 +5,223 @@ description: "Search process definitions" sidebar_label: "Search process definitions" hide_title: true hide_table_of_contents: true -api: eJzlWN9v2zYQ/leIe8nWKf6RJm0qDAPcNAXaDU1We9tDEgy0dLbZUqRKUkk9wf/7cCQty7aaJsNetr5Z5N3x+N3dd0fX4PjcQnoFl0ZnaO0rnAklnNAKbhLQJRpOH29ySMEiN9nizyNIwOCnCq17qfMlpDXkaDMjSq+WwtjLMfzMi1KihQQyrRwqR6K8LKXIvNH+B0vyNdhsgQWnX25ZIqSgpx8wc5BAacgFJ9DS7kxIh+brch9x2RISyuEcDSQw06bgLiw9O4ZVAooX2BK1zgg1p41bNFYE7+418/SoJT3h805j07JQEV8CskPCoeLKdW7SrnCSlvZjtErAir/wgW6GAI5m2yByY/gSEhAOC7sPLjlgtXEP19gPG8rua2uTb7kSdxJAVRWUlaPxGSTw6nx8BjdtJMbk0Kq98muFZtkJUJOHaQ0jKffzdSQlK4MmE8o6rjK07LscZ7ySjhHATFg2HHwPCdxyWRHedPaYdvSMGXSVUZgzKaz7Yj3sH8FVHnW9Jpnyh520zonxPfHnxTA8wjxFjk2XzCd626o3ddUEB6JAjIgHfnWzPjSYion2sNOTcDQJo8qFmq+9CFe1EbquqyZf9c4nxI57JZ8/xr02MI0+M2gr6ewmEj12rdhEszk65hbIFH52QTTT5dIvefdJ44Bs/k5f9oAJ5TQ7aFXcQRDsXSvvsi0xE7PIhMwudCVzVnCXLbzRluK26D/CK0RzhwCu4IxLiTmLVQMJHB2dDJ+/eHE6fPrs9PnR6TAU3WtPu5t02kc5SkyXLDLhVu5t01/L/w2fN3Q7bBjtZNBxr11Tu+m68pxg0JZa2VDyR4NBR1pUWbzyv9SadqnwkRT5DXWs2E5CnTyuDTntuHwQTi0X3oeS7vKExI670uMVd5wJdculyL+cI6XRU4nFD4/NFeu4q+wDA1WgtZHZ9mKwZrPuAPmF+4Jzbow2DQxPO8pam6nIc1TbGDzpP/nvX/d4/7rvtGOvdaXy/911T7qSfHT5hrXSmaFX+Aay3U/CWWWEW/rmMkVu0Bx6Dr66WSU1ZFp/FOi/bpL7J4q8IRTqJgW6haZGVWrroeBuASn0b4f9qHDYUuiHfgzkjyFG9u5URkIKdcB3lfb79UJbt0rrUhu38v3TCD6NEy3thdj6aRVSkDrjchHO33Z9skBGG37m0TM/aFAWhNN7hGPZjJhrc6eD00GnJRL9gpVNbmzsLJwrO+0E4U5LqzC0hFiNSS5ceh2fTfMoxc9I3SO0R7i4PH8/mpwfjs/H4zcX76it0HFRjxpcK+aNleiid4i+gxCspV+v0/XtHxOfWlQK7zcv4fPw0NiebPwJg8ax5oXTtOvBdjPeSOz04M3GpvW2CiAMTYPdGa/2CO6OUY2pnfmJYJppj0ismgv/DwCyy2oqRUbR2Y+hZtxPU4xnTtyGaTrTBIXDvONdIhRbm51pwwqthNPkkNd0RleU3AutXXCSCIlnPi1DbVCcbNrv393d9TJeVCrnvUwXBIMUGSrrYxAR/yWuJDvKuc5soy20/+4bnKFBlWE/GrL9rdkKhr1BbxAKxbqCq9ZB9xLDFmRNwjn87Pql5MI/VL1/deSMK7gdBi7dZQ1Yx5j+oQnlfwV1PeUWfzNytaLlT/QaJv7asEXgNlggz0NmhNSEs0D3hxNyqRnO94dh4sWgMcoyLN29sjctKry8GE8oneN/RYXOScfwO/ofid9BCtdwDZSMZbhfWof1GiRX88r3Awh2qep4Rfg0GO4Uqb/ZmhXUsuXljy+9AJvoj6h+giTextFneDz8DaxJhiw= +api: eJzlWFFz2zYM/is8vGTrFMtOmzbVm5emd912TVZ720Oa29ESbLGlSJWkkno6/fcdSFmWbTVNdnvZ+maRAAh+AD6ArsHxlYXkGq6MTtHaV7gUSjihFdxEoEs0nD7eZJCARW7S/M8TiMDgpwqt+1Fna0hqyNCmRpReLYGZl2P4mRelRAsRpFo5VI5EeVlKkXqj8QdL8jXYNMeC0y+3LhES0IsPmDqIoDTkghNoaXcppEPzdbmPuO4JCeVwhQYiWGpTcBeWnj+DJgLFC+yJWmeEWtHGLRorgnf3mnl60pOe89WgsUVZqBZfAnJAwqHiyg1u0q5wkpYOY9REYMVf+EA3QwCny10QuTF8DREIh4U9BJccsNq4h2schg3l8LW1yXZcaXciQFUVlJXT2TlE8Opidg43fSRm5FDTX/m1QrMeBKjLw6SGqZSH+TqVkpVBkwllHVcpWvZdhkteSccIYCYsm4y/hwhuuawIbzp7Rjt6yQy6yijMmBTWfbEeDo/gKmt1vSaZ8oed9s5p43vqz2vD8AjzFDm2WDOf6H2r3tR1FxxoBdqIeOCbm82hwVSbaA87PQpHkzCqTKjVxotwVdtCN3TV6Kve+YTYc6/kq8e41wem02cGbSWd3UZixN4rNtdshY65HJnCzy6Iprpc+yXvPmkckc3f6cseMaGcZke9ijsKgqP3yrtsS0zFsmVCZnNdyYwV3KW5N9pT3BX9R3iFaO4RwDWccykxY23VQAQnJ6eTFy9fnk2ePj97cXI2CUX32tPuNp0OUW4lFmvWMuFO7u3SX8//LZ93dDvpGO10PHCvfVP76dp4TjBoS61sKPmT8XggLaq0vfK/1Jr2qfCRFPkNday2nYQ6eVwbctpx+SCcei68CyU95AmJPRtKj1fccSbULZci+3KOlEYvJBY/PDZXrOOusg8MVIHWtsx2EIMNmw0HyC/cF5wLY7TpYHg6UNbaLESWodrF4En85L9/3WeH132rHXutK5X97657OpTk06s3rJfODL3CN5DtfhJOKyPc2jeXBXKD5thz8PVNE9WQav1RoP+6ie6fKLKOUKibFOhyTY2q1NZDwV0OCcS3k7hVOO4pxKEfA/ljiJG9O5WRkEAd8G2SOK5zbV2T1KU2rvH90wi+aCda2gux9dMqJCB1ymUezt91fZ4jow0/8+ilHzQoC8LpI8Kx7EbMjbmz8dl40BKJfsHKNje2dnLnykE7QXjQUhOGlhCrGcmFS2/is20epfgZqXuE9giXVxfvpvOL49nFbPbm8i21FTqu1aMG14t5Z6V10TtE30EINtKvN+n60x9zn1pUCu+2L+GL8NDYnWz8CePOse6F07Xr8W4z3krs9eDtxrb19gogDE3j/Rmv9gjuj1Gdqb35iWBaao9IWzWX/h8AZFfVQoqUonMYQ824n6YYT524DdN0qgkKh9nAu0QotjG71IYVWgmnySGv6YyuKLlzrV1wkgiJpz4tQ21QnGwSx3d3d6OUF5XK+CjVBcEgRYrK+hi0iP/SrkR7yplObacttP+ODS7RoEoxbg3ZeGe2gsloPBqHQrGu4Kp30L3EsANZl3AOP7u4lFz4h6r3r2454xpuJ4FL91kDNjGmf2hC+V9DXS+4xd+MbBpa/kSvYeKvLVsEboMceRYyI6QmnAe6P56TS91wfjgMEy8GjWmaYunulb3pUeHV5WxO6dz+V1TojHQMv6P/kfgdJECJWIa7JXVYq0Fytap8L4BgkyqOV4RNh99egfpbbRhBrXse1nWQmOuPqBoi0XAVR9/h5fA3aASGpg== sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search process definitions

+ Search process definitions -## Request - -

Body

- -Search examples - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-3.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-3.api.mdx index bf4ab7bd85d..8cc582c91a7 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-3.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-3.api.mdx @@ -5,56 +5,282 @@ description: "Search incidents" sidebar_label: "Search incidents" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/ivEfXG7qbGc9xjDANdWOrWp7NlOWiwNDFqiY7aSqJJU0szwfx+OlGU5VpoG24d1qz9Z5PHuufcjF6DptYL2JfhpyCOWarhyQGRMUs1F6kfQBsWoDOeTPXBAss85U/qliO6gvYCIqVDyDCmhDSNDR3jBSIEDoUg18mwvgGZZzEPDtflR4YEFqHDOEor/9F3GoA1i+pGFGhzIJGLQnCncnfFYM/k43Sd2VyHiqWbXTIIDMyETqu3S4T4szbmQKdVjM55yxPTmqUf9VGmahuzbD1qSklRpydNrcICleYIeOA9GA6/rn/peDxw4D94E/XcBOOD3J287g4EfvJp4w2F/CA687r+cBP3J0BsPfW8EDnjvve752O8HkzN/NPYCb7i53+0HPd/sr1h478fDTnc8ueicnXvlardzdub1Jt6Z99YLxuXyefBbJ+iZHVyZeBdeMAYH3nqjUeeVNxn5f3gT733X83oGfMGm53X9UVXoegHFdjYAnfaHbydBfzw57Z8HPbhaOpAwpeh1jdGWDoSSmWAa86SeQGmqv2rvTnfsX3iohf9q2Bkb4ENv1D+7MH8HXtDzg1cGyEcxfYKfWUpTjamzhQp3uY5xqcw3hMr/ZI8y39s1pCbJOrPNfKBS0jtwgGuWqO08QblKSP3tJ7YzkMV1CjkgZLQBZdvMo67x/KgLV1UDjBDQsrrye87kXdUu7AtNstgi6MTxdskZMp3LVBEax+u6Q55FbEbzWBNptknMlSZoY8IVabnPd8CBGxrnaHOUb7mQXZeU1qgXk9AvhmolqcqocOKuixxRNzK9I6XZ6vmtIaN3WESQjKURT6/xdKMa440NWcaZl6VfNrOhdIq1+tKY/dTU0CeBsmWXRQYLurexQ07xMGkUmdkgIU0bmkwZyRWLyEzI4hShaWS0qsLequP1dWVZwVuy2cK7VshiM6SNusLecL7FvjtfRfpAYazvI7C7e9A6Ojk5bu0dHh+2Do+gTMAn+WxArxkCLfpavb8yem1dlCvUK5PshotcFcHPItJAyReomWoQoyF5ZtL/+Wb8VivLZVWDo6Pjg0oMWWsac2dFdX56JP1db5XiIzKTIlmrva3tv8yx92r4Zetw//DE3XePD/ZPTpwT1z1qnZzsHuwf7e/tHh9fLc0PRy+ViVTZYrjrujXzVx4i5H9u7LrfG57YM35MYz+mse9vGisS2laQp41YWmgafxOsiuQhU3msVQUA7u7XJXiPakp4ekNjHj2c5ZkU05glPz8129FDuXoUvh1DvxYLvMjF2s36tKsaxJNSyNIMezWNX8gpjyKWbtrgp+ZP37+6+9vqBkKTU5Gn0X9O3YO6IO8MfFIJZ8LMgf9BtJvLXZhLru/MNDFlVDL5wnTRy6uls4BQiE+cma8r5/HHl4TpucB5JBPKGIDqObShedNqlmRNO4sAypY3TCojOpcxtGFhbblsN5uLuVB62V5kQuqlGackp9PiZoZ71o/m1gVtiEVI47mVuglzPGcEN1KaMCJmRM8ZQY9b6Tumo5fT/ordsXvs1nJC0ge4rONgzWeudVbLxxLXclragc36ZYR0VumVL9b9IePYlBxA1aAN/YGHbezFyBthj8XOgeKKc0tnw78llwKiAYTflghW1Ker0Hz9bmzCCMN+uH6U8+yFeXPQNRLch6Yst36GclfBe28QKlNh3cE3e/96vWj5686+6ttutStXZwRzg3bvD8gL44L7Q3YpZjVed+y1Ce08E8akRYr1zWsmI4N8GvMQ3bsdBIJQMzwTGmp+w8ztIhRoS7yIFAYiq1zHf2TFFu+8iUi5FgjInNRS5JgdcyF0YSORahqauLbJhY5W7Wbz9vZ2J6RJnkZ0JxQJmiHmIUuVcWIRS2fFinPvcCRCVZ7mwnw3JZsxydKQNQtGqolcMbmtsq0dd8e1maZ0QtOKoJoqsmGoMk41+6KbWUx5iowMqkVRYC7hpmWifc2jKDJXTlErLmGxmFLFzmW8XOLyZ3z5wcK2Li226MGc0chGgY1j6No+8GKMQMqL3fY9BwumPdEJQ5bpr9JeVarloD/CYXpavHEnIsIzkt7i+ze9hTZ8gA+AgWeMYqqBWV9ATNPr3GaH5YspSnO0Smm5exltNFuVkPSugvKXl4aAjMUnlv4KTqGNxk/zPrD8C/QS51o= +api: eJztWN1z2jgQ/1c0+0J75waT7/BGwem5TQ0HJO1cJsMIWwS1tuVKctIc4//9ZiVjTHA/MncP17vyhKXV7m+/V1qBprcKutfgpyGPWKrhxgGRMUk1F6kfQRcUozJczg7AAck+5UzplyJ6gO4KIqZCyTOkhC5MDB3hJSMFDoQi1cizuwKaZTEPDdf2B4UHVqDCJUso/tMPGYMuiPkHFmpwIJOIQXOmcHfBY83kt+k+socaEU81u2USHFgImVBtl44PoTDnQqbUgC14yhHTm6ce9VOlaRqy7z9oSSpSpSVPb8EBluYJeuAymIy8vn/uewNw4DJ4EwzfBeCAP5y97Y1GfvBq5o3HwzE48Hr4chYMZ2NvOva9CTjgvff6l1N/GMwu/MnUC7zx9n5/GAx8s79m4b2fjnv96eyqd3HpVav93sWFN5h5F95bL5hWy5fBb71gYHZwZeZdecEUHHjrTSa9V95s4v/hzbz3fc8bGPAlm4HX9yd1oZsFFNvbAnQ+HL+dBcPp7Hx4GQzgpnAgYUrR2wajFQ6EkplgmvKkmUBpqr9q715/6l95qIX/atybGuBjbzK8uDJ/R14w8INXBsgHMX+Cn1lKU42ps4MKd7mOcanKN4TK/2TfZH6wb0hNkvUW2/lApaQP4ADXLFG7eYJylZD6+0/sZiCLmxRyQMhoC8qumSd94/lJH27qBpggoKK+8nvO5EPdLuwzTbLYIujF8W7JGTOdy1QRGsebukOeRWxB81gTabZJzJUmaGPCFem4z/fAgTsa52hzlG+5kH2XVNZoFpPQz4ZqLanOqHTivoscUTcyfyCV2Zr5bSCjd1hEkIylEU9v8XSrHuOtLVnGmdeVX7azoXKKtXphzH5uauiTQNmyyyKDBd3b2iPneJi0ysxskZCmLU3mjOSKRWQhZHmK0DQyWtVh79Tx5rpS1PBWbHbwbhSy2Axpq6mwt5zvse/eV5F+oTA29xHY3z/qnJydnXYOjk+PO8cnUCXgk3w2orcMgZZ9rdlfGb21LsoV6pVJdsdFrsrgZxFpoeQr1Ey1iNGQPDPp/3w7fuuV5bquwcnJ6VEthqw1jbmzsjo/PZL+rrcq8RFZSJFs1N7V9l/m2Ec1/LpzfHh85h66p0eHZ2fOmeuedM7O9o8OTw4P9k9Pbwrzw9FLZSJVthjuu27D/JWHCPmfG7se94Yn9oyf09jPaezHm8bKhLYV5Gkjlhaaxt8FqyZ5zFQea1UDgLuHTQk+oJoSnt7RmEdfzvJMinnMkl+fmu3ooVx9E74dQ78WC7zMxcbN5rSrG8STUsjKDAcNjV/IOY8ilm7b4Jf2Lz++uoe76gZCk3ORp9F/Tt2jpiDvjXxSC2fCzIH/QbSby12YS64fzDQxZ1Qy+cJ00eubwllBKMRHzszXjfPtx5eE6aXAeSQTyhiA6iV0oX3XaVdkbTuLAMqWd0wqIzqXMXRhZW1ZdNvt1VIoXXRXmZC6MOOU5HRe3sxwz/rR3LqgC7EIaby0UrdhTpeM4EZKE0bEguglI+hxK33PdPRq2l+zO3VP3UZOSPoFLps42PBZap018rHEjZwKO7BZv0yQziq99sWmP2Qcm5IDqBp0YTjysI29mHgT7LHYOVBcea5wtvxbcSkhGkD4bYlgTX2+Ds3X76YmjDDsx5tHOc9emLcHXSPB/dKU5TbPUO46eB8NQlUqbDr4du/frJctf9PZ133brXfl+oxgbtDu4wF5ZVzweMiuxKzH6569NqGdF8KYtEyxoXnNZGSUz2Meont3g0AQaoZnQkPN75i5XYQCbYkXkdJAZJ3r+I+s2eKdNxEp1wIBmZNaihyzYymELm0kUk1DE9c2udDRqttu39/f74U0ydOI7oUiQTPEPGSpMk4sY+miXHEeHY5EqKrTXJjvtmQLJlkasnbJSLWRKya3Vbaz5+65NtOUTmhaE9RQRbYMVcWpZp91O4spT5GRQbUqC8w13HVMtG94lEXmxilrxTWsVnOq2KWMiwKXP+HLDxa2TWmxRQ+WjEY2CmwcQ9/2gRdTBFJd7HbvOVgw7YleGLJMf5X2plYtR8MJDtPz8o07ERGekfQe37/pPXQBg84YxFQCs7aCmKa3uc0MyxPTk+Zokcpqj7LZaLUuH+lDDeFqZSmm4iNLC6y4VhWN3+ZxoPgLjDTn1A== sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search incidents

+ - + Search incidents -## Request + -

Body

+ -Search incidents - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error + -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-4.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-4.api.mdx index 1ecf3581674..224417e3c2e 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-4.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-4.api.mdx @@ -5,59 +5,305 @@ description: "Search flownode-instances" sidebar_label: "Search flownode-instances" hide_title: true hide_table_of_contents: true -api: eJztWVtz4jYU/isavaQXb3CyZJMwnc444LR0WUOxSdpJGUbYIqhrJCrJyVKG/945krENOLtJZx962X1ZJB2d+/l0jrPGmtwr3LrD16l45CKhXa404THFYweLJZVEM8G7CW5hRYmM55MmdrCkf2RU6SuRrHBrjROqYsmWQIlbODR0aJYzfMVyjgo7OBZcU67hElkuUxYb9o3fFdxcYxXP6YLAL71aUtzCYvo7jTV28FKCMppRBaczlmoqP033nq4qRIxrek8ldvBMyAXRdutNE2/MvZgqtbX+7UsvduiMcQbGPP+q0kTqDtG0Qq+0ZPweTilPnjwD3wYQrOSjxwFZ1N9nPGYJ5fr5ulqSfVagZbaA9BkF4cBvd6+7fgc7eDDst/0wxA4OR1eTcuXf+EE02d0LI28YTcwJdnA3iPzhO7/T9SJ/0vai9o/1R9GPw/5tcXTVHwUdb/hrseEHneJ36A9vum1/EnnhW+zgod/2uzfFchT6w+3vd14w8nrbVf6f/0u7Nwrhxg9e5N96vxpVDvcG3tDr9fxeZcuae+WFfqeyG/o/j/yg7U+ue/1bkDrqRd1JNwgjD3av+h2ganu93sRrR92bbgTrq1HYDfwwnAxHvUL5sD3sDqJiBVZvzQreBv3bAI9tntXlURk8I8YHof13g54fmRiCs7uBB4txJWUqfKZCpJRwkx6UE65r0xFOmU5h63qbtluMAeXYn/STOfj61JAaYPFmu6VPpCQr7GCm6UIdQgLIV0Lq5984BBua1teZkMmOKoeODdvYwR0/bONx1REhKLSp7vycUbmq8w/9QBbL1Gripekh3A6pziRXiKRpgbmowFz0VUJnJEs1koYOpUxpBE5HTKET9+tj7OAHkmYQBFDIskOnLircUy9vQT4YqjwvVJVRHtVTFziCsWi6QoUf6/nV6A5xowkCesoTxu+BzVEOjEc78kyE74pgFehZBMlGYWPCcG2ej7+nk316aGJU2Rp/tGN8+TqVRaNlRjcV2YQnaJuWu7JL5Ur2yHnCF8UT8kwNnENPla9Qra8G5J6CqPwprffTktxbj2QKNFtK+sBEpvKcowk6ArE3oJ46QkZN9JUpw6+PUXsuhKKIcEQ/MKWBwXu6QjMpFiUnW/tUIS2Qliuk52wv46rgcHd6enZyfnl5cfL6zcX5+cVZJezWlSYAoPZnCH4ZHfJEcAppyZ5Zh375rHH0TBj3kPPu5E3zzaXbdC/OmpeXzqXrnp9cXp6eNc+br08vLsYb8w+aPLUUXFnoOXXdmk4vi6H3+Xx93T4ivxCpv7R7X9q9L+3eP7jdy3HLAt7LejgtNEmflb0VDYZUZalWNYoAVbMO0zpEE8T4A0lZ8jSwLaWYpnTx7UsBDmKTqU+aYfvdBVUqf6FqSjo3pe6wvnqrjvGlFLJww+uaLkTIKUsSynd98E3jm3+/uc1DcwOh0bXIePKfM/esLsm9QRdV0hlRc+F/kO1miowzyfTKNE9TSiSVr0zjcDfeOGscC/GeUbMaOy/4srWgei6gD1sKZTxB9By3cOPhpHFI37ANGQZt5AOVyiiTyRS38Np6d9NqNNZzofSmtV4KqTemL5SMTPNhEM5sZM18h1s4FTFJ51b8ruLRnCI44GRBkZghPacIcsBKPzaNTTGMbNlduBduLScgfYJLmRkln7nWy1o+lriW08Z2rTZSIdBZo7fRKV+OJYOuxsHcND+4P/CHXuS/Cv0w7PYDeFNAXH5v4+xEvOCSq2gUMk+dIcJb6uttsv50G5nEgkIYlt9AfTuj73bsRoJb32q6TzWS7k6bWH26k/2talN4uGt7wXJ/pwV0t0Wz18flnUPZIOxOHdV3v1J/dtZ396eMtQnh4ZSSK7Q7opganwkTkrxo++bjM0WDbJqyGNLjMIkEImYCQSTW7IGaMSsWEAuYxnIXV+Y3xtGW7UxItBCcaQEKmZtaigyqay6EtkoCHpLY1IUtTkgU1Wo0Hh8fj2OyyHhCjmOxADekLKZcmSTIc7GX7zh7lxMRq+I2E2bdkHRGJeUxbeSMVAO4AjhYY0+O3WPXVqrSC8Irgj6GSzseKxJe0w+6sUwJM+2cUW+dQ9YdfjjJE+mAWQ5bYydHnzu8Xk+JoiOZbjaw/Qd8xgLwLMHKAiueU5LYvLCVgdv2rXkVgUbFzHs4PgIo2xteHNOl/ijtuALEg34I88A0/yPFQiRwR5JH+AMGecQt/Bv+DUMqGu8YfDH7a5wSfp+ZxwhbvlD0JAP3lO3wLkYYy7agxFcVLb+7MgQoEu8p/x47uTUaluYjy+YvhYB+Tg== +api: eJztWd1z4jgS/1dUesnunic4GTJJeHPAuWWHMSw2yW2lKErYImjHllhJToaj+N+vWjK2AWcmuZqH+5h5GSS1+rt/6nY2WJNHhTsP+DYVz1wktM+VJjymeOpgsaKSaCZ4P8EdrCiR8XLWxg6W9K+cKn0jkjXubHBCVSzZCihxB4eGDi0Khu9YwVFhB8eCa8o1XCKrVcpiw771p4KbG6ziJc0I/NLrFcUdLOZ/0lhjB68kKKMZVXC6YKmm8tt0n+m6RsS4po9UYgcvhMyItlsf2nhr7sVUqZ31H996sUcXjDMw5vVXlSZS94imNXqlJeOPcEp58uIZ+DaAYCVfPQ5I1nyf8ZgllOvX62pJDlmBlnkG6TMJwpHf7d/2/R528Gg87PphiB0cTm5m1cq/84Notr8XRt44mpkT7OB+EPnjT36v70X+rOtF3V+bj6Jfx8P78uhmOAl63viPcsMPeuXv0B/f9bv+LPLCj9jBY7/r9+/K5ST0x7vfn7xg4g12q+I//x/dwSSEG3/3Iv/e+8Oocrw38sbeYOAPalvW3Bsv9Hu13dD/feIHXX92Oxjeg9TJIOrP+kEYebB7M+wBVdcbDGZeN+rf9SNY30zCfuCH4Ww8GZTKh91xfxSVK7B6Z1bwMRjeB3hq86wpj6rgGTE+CB1+Gg38yMQQnN0PPFhMaylT4zMXIqWEm/SgnHDdmI5wynQKW7e7tN1hDCjH/km/mYPvzw2pARZvsV/6REqyxg5mmmbqGBJAvhJSv/7GMdjQtLnOhEz2VDl2bNjFDu75YRdP644IQaFtfef3nMp1k3/oF5KtUquJl6bHcDumOpdcIZKmJeaiEnPRTwldkDzVSBo6lDKlETgdMYXO3J9PsYOfSJpDEEAhyw6du6h0T7O8jHwxVEVeqDqjIqrnLnAEY9F8jUo/NvNr0B3iRhME9JQnjD8Cm5MCGE/25JkIP5TBKtGzDJKNwtaE4dY8H/+eTvbpoYlRZWf8yZ7x1etUFY2WOd3WZBOeoF1a7suulKvYI+cFX5RPyCs1cI49Vb1Cjb4akUcKooqntNlPK/JoPZIr0Gwl6RMTuSpyjiboBMTegXrqBBk10U+mDH8+Rd2lEIoiwhH9wpQGBp/pGi2kyCpOtvapQlogLddIL9lBxtXB4eH8/OLs8vr66uz9h6vLy6uLWtitK00AQO3vEPwqOuSF4JTSkgOzjv3yXePomTAeIOfD2Yf2h2u37V5dtK+vnWvXvTy7vj6/aF+2359fXU235h80eWoluLLQc+66DZ1eHkPv8/36ukNEfiNS/2j3frR7P9q9/+B2r8AtC3hv6+G00CR9VfbWNBhTladaNSgCVO0mTOsRTRDjTyRlycvAtpJintLsb28FOIhNrr5phu13M6pU8UI1lHRhStNhc/XWHeNLKWTphvcNXYiQc5YklO/74JfWL//95raPzQ2ERrci58n/nLkXTUnujfqols6Imgv/B9lupsg4l0yvTfM0p0RS+c40Dg/TrbPBsRCfGTWrqfOGL1sZ1UsBfdhKKOMJope4g1tPZ61j+pZtyDBoI5+oVEaZXKa4gzfWu9tOq7VZCqW3nc1KSL01faFkZF4Mg3BmI2vmO9zBqYhJurTi9xWPlhTBAScZRWKB9JIiyAEr/dQ0NuUwsmN35V65jZyA9AUuVWZUfJZarxr5WOJGTlvbtdpIhUBnjd5Fp3o5Vgy6Ggdz0/zg4cgfe5H/LvTDsD8M4E0BccW9rbMX8ZJLoaJRyDx1hgjvqG93yfrbfWQSCwphXH0D9e2Mvt+xGwluc6vpvtRIunttYv3pTg636k3h8a7tBav9vRbQ3RXNQR9XdA5Vg7A/ddTf/Vr92VnfPZwyNiaEx1NKodD+iGJqfCFMSIqiHZqPzxSN8nnKYkiP4yQSiJgJBJFYsydqxqxYQCxgGitcXJvfGEc7tgshUSY40wIUMje1FDlU11IIbZUEPCSxqQtbnJAoqtNqPT8/n8Yky3lCTmORgRtSFlOuTBIUuTgodpyDy4mIVXmbCbNuSbqgkvKYtgpGqgVcARyssWen7qlrK1XpjPCaoK/h0p7HyoTX9IturVLCTDtn1NsUkPWAn86KRDpiVsDW1CnQ5wFvNnOi6ESm2y1s/wWfsQA8K7CywIqXlCQ2L2xl4K59a95FoFE58x6PjwDK9oYXx3Slv0o7rQHxaBjCPDAv/kiRiQTuSPIMf8Agz7iDIQ2NZwy2mL0NTgl/zM1DhC1PKHiSg2uqVngfH4xVO0Di65qGm42liMRnyreA4dYUDWvzhWX7L1jVfsg= sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search flownode-instances

+ Search flownode-instances -## Request + -

Body

+ -Search flownode-instances - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error + -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-5.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-5.api.mdx index 56935b6c5ee..e95140e43d5 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-5.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-5.api.mdx @@ -5,56 +5,227 @@ description: "Search decision requirements" sidebar_label: "Search decision requirements" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/ivEfcnWqZad1l0qDAPcNgWyDU0We9uHJBho6mxzlUiVpJx6hv77cKQsy7bcJsW+7OWbRN4dH97LcyetwfG5heQG3qCQVmp1jR9KaTBH5SzcRaALNNxJrS5SSMAiN2Lx+xAiMPihROte6XQFyRpStMLIgiQhgbGXY/iR50WGFiIQWjlUjkR5UWRSeKPxH5bk12DFAnNOT25VICSgp3+gcBBBYQiCk2hpdyYzh+bzcjJtyVhnpJpDFcF7XLXWpXI4RwMRzLTJuQtLL56TZNrhj4tuo4rn2LmxRGNluN8nT3x2StIGrS6NwHfHzDlUXLlOELQrXUZLnYGsIrDyT3wgkhDl0WzX09wYvoIIpMPcHkaAMFht3MM1DmOLWbeHtUl3oNQ7EaAqc8re0fg1RPDmfPwa7trOGBOgqr3yc4lmdcxHTb4maxhl2WFej7KMbTKDmZY2+yrFGS8zx8jPTFo26H8NESx5VpLbCcKYdvSMGXSlUZiyTFp3tHa6j+EqrfW9NpnzBw5bZ9WhHvoz64g88ggKJONWoEqlmrPpivkkb5/hDd80UYNaoA6Vj0h1t4EQjNYZ+HAsUQBCCrtIokc5IvosWp85e3ALPv8yuAd+20FLZrdoe7dqotkcHXMLZAo/Oi8QMaGLlV/zlyGFEzL+K73ZEyaV0+ykVagnQbB3q/wFbIFCzmqWZXahyyxlOXdi4Y22FHdFe1/kvhDsPeK4gQu11FIge1VaqdBatqk7aginp8PBty9fng2evTh7MRz2Q+G+9fy+zcHDANQS0xWr6XUrPF2xI7TdutS2gzT0PGjocdjvuOxRm/u5XnmmMWgLrWxgkdN+vyOHSiHQ/o1dcZ9gH0m8/zfL3UZQd7JQa4/rgE47nj3Iay0U12jLzNkjYEjyeVcaveGOM6mWPJPp8VwqjJ5mmH/z2JyyjrvSPjAcOVpb0+VBJKSyjitxJEx+4VMhOjdGm8YNzzoIQZupTFNUuz54Ej/551/3+eF132nH3upSpf+66w67knx0dcFa6czQK/wHst3P4aI00q18N5oiN2ieelK+uauiNQit30v0b3fRI8YUoBu4habeVmjrncHdAhKIl4M4NWkc+jgQAkO87AGUJoME1sGjVRLH64W2rkrWhTau8i3WSD6tx2faC9H0YzEkkGnBs0U4bxfsZIGMNqg30KRDEwrFPZzeI88VzRy7MXfWP+t3WiLRI1a22bC1s3Cu6LQThDstVWHYCdEZk1y49CYi245RyB+RWkZoe3B5dX49mpw/HZ+PxxeX76iX0HG1XhXtRLmxUkP0gOg9CMFG+u0mQX/4beKTiZL/evt5fh6+anaHH5m2v6P8ef3jjXwrWV+keW/adn+/KW9ltr24VQth4OrvD41r79r9EawxtTdykf9m2ruqLqBL/78C2VU5zaSgsB0GVzPuBzDGhZNL9AOk0OQjhykrjPabm0qmJ7YxO9OG5VpJpwmQ13RGl5T1C61dAEncxIXP11A0FECbxPH9/X1P8LxUKe8JnZMbMilQWR+c2rU/1SvRnnKqhW20pfbvscEZGlQC49qQjXeGKRj0+r1+qCDrcq5aB32GI3ac1uSiw48uLjIuFRn1CNc1fdzAckB6JoVNVOkPUmCCG1ivp9ziLyarKlr+QB/iRF5b4gjEBgvkaciFkJfwOnD90wlBaEb5w4mZSDFojITAwn1S9q7FgleX4wmVU/0vK9cp6Rh+T/+5+D0kcAu3QOnn3eFr3a+vIeNqXvpmAMEuFSAvyR+Nz/bq1d9sQxBq1UL53SsvwCb6ParvN3UJjl7DF8ZfAH7Cog== +api: eJztWEtz2zYQ/iuYvbhNGT0cK3V4UxJnxm0mdi21PTieDgSuJCQkwACgHJXD/95ZgKIoiUrsTC993Ehgd/FhH98uWYLjCwvxLbxGIa3U6gY/FdJghspZuItA52i4k1pdJhCDRW7E8o8RRGDwU4HWvdTJGuISErTCyJwkIYaJl2P4mWd5ihYiEFo5VI5EeZ6nUnij/Q+W5EuwYokZpye3zhFi0LMPKBxEkBuC4CRa2p3L1KH5upxMWjLWGakWUEXwEdetdakcLtBABHNtMu7C0vMzkkw6/HHZbVTxDDs3VmisDPf74onPTknaoNWFEfjumDmHiivXCYJ2pUtpqTOQVQRW/okPRBKiPJ7vepobw9cQgXSY2cMIEAarjXu4xmFsMe32sDbJDpR6JwJURUbZO568ggheX0xewV3bGRMCVLVXfinQrI/5qMnXuIRxmh7m9ThN2SYzmGlps+8SnPMidYz8zKRlw8H3EMGKpwW5nSBMaEfPmUFXGIUJS6V1R2un+xiuklrfa5M5f+CodVYd6pE/s47II4+gQDJuBapEqgWbrZlP8vYZ3vBtEzWoBepQ+YhUdxsIwWidgQ/HEgUgpLCLJHqUI6KvovWZswc354tvg3vgtx20ZHaLtvdeTTVboGNuiUzhZ+cFIiZ0vvZr/jKkcELGf6M3e8KkcpqdtAr1JAj23it/AZujkPOaZZld6iJNWMadWHqjLcVd0d43uS8Ee484buFSrbQUyF4WViq0lm3qjhrC6elo+OOLF+fDZ8/Pn49Gg1C4bzy/b3PwMAC1xGzNanrdCs/W7Ahtty617SANPQ8behwNOi571OZ+rleeaQzaXCsbWOR0MOjIoUIItH9jV9wn2EcS7//NcrcR1J0s1NrjOqDTjqcP8loLxQ3aInX2CBiSPOtKo9fccSbViqcyOZ5LudGzFLMfHptT1nFX2AeGI0Nra7o8iIRU1nEljoTJL3wpRBfGaNO44VkHIWgzk0mCatcHT/pP/vnXPTu87jvt2BtdqORfd91RV5KPry9ZK50ZeoX/QLb7OVwURrq170Yz5AbNU0/Kt3dVVILQ+qNE/3YXPWJMAbqBW2rqbbm23hncLSGG/mrYT0zSD30cCIEhXvYACpNCDGXwaBX3++VSW1fFZa6Nq3yLNZLP6vGZ9kI0/VgMMaRa8HQZztsFO10iow3qDTTp0IRCcQ+n98hzeTPHbsydD84HnZZI9IiVbTZs7SydyzvtBOFOS1UYdkJ0JiQXLr2JyLZj5PJnpJYR2h5cXV/cjKcXTycXk8nl1TvqJXRcrVdFO1FurNQQPSB6D0KwkX6zSdCffp/6ZKLkv9l+nl+Er5rd4Ucm7e8of97geCPfStYXad6btj3Yb8pbmW0vbtVCGLgG+0Nj6V27P4I1pvZGLvLfXHtX1QV05f9XILsuZqkUFLbD4GrG/QDGuHByhX6AFJp85DBhudF+c1PJ9MQ2ZufasEwr6TQB8prO6IKyfqm1CyCJm7jw+RqKhgJo437//v6+J3hWqIT3hM7IDakUqKwPTu3at/VKtKecaGEbban9e9/gHA0qgf3akO3vDFMw7A16g1BB1mVctQ76CkfsOK3JRYefXT9PuVRk1CMsa/q4hdWQ9EwCm6jSH6TABLdQljNu8VeTVhUtf6IPcSKvLXEEYoMl8iTkQshLeBW4/umUIDSj/OHETKQYNMZCYO6+KHvXYsHrq8mUyqn+l5XphHQMv6f/XPweYqDU867wde7XSki5WhS+EUCwScXHC/JF46+9WvW32pCDWrcQlmWQmOqPqKpqU5Tg6D18XvwFBsjDHA== sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search decision requirements

+ - + Search decision requirements -## Request - -

Body

- -Search examples - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-6.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-6.api.mdx index 9635ddbad3d..a4cff06d67a 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-6.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-6.api.mdx @@ -5,59 +5,317 @@ description: "Search decision instances" sidebar_label: "Search decision instances" hide_title: true hide_table_of_contents: true -api: eJztWW1PGzkQ/ivWfOGutySBFo5Gp5NSCFKuCDiStidBVJndCfF1Y29tL5CL8t9PY+9bNgsNbT/cC98Se94883jmcbIAy28MdC/hCENhhJIDaSyXIcI4AJWg5pYWI+iCQa7D6cd9CEDj5xSNfaOiOXQXEKEJtUhIErowdHIM7/ksidFAAKGSFqUlUZ4ksQid0fafhuQXYMIpzjh9svMEoQvq+k8MLQSQaArBCjS0OxGxRf1lORFVZIzVQt7AMoBPOK+sC2nxBjUEMFF6xq1f2n9FksZyi+s2AkCZzihZx73BSf8IAui/7528643c53enb0/PPpy6T8Pz/uHgeNA/gvEyALzlcerOfNRoeEXkmIs41c1SiVYhGnOEEyEFCb/d+EyZal7ezRWjHBjNWc23y5i+IHjKZ82HywXeozbCI+PR8F7uVrVGTvThkh31DwfDwdnpx1HvzUkfAjgZjPoXvZOP/T/OL/pD2qpVrqwo1VCjSWP7WO0wGsgktaYiw7XmcwhAWJyZrwaufChj5LdpZxmAFTampfq1diE6iSLqs9T+M8IOQKcxPgAftyUjvN8IF49kwB/Xi6Dk0jY6fMSA6xDiL9wQoL5t9iarresLKSb/Rmn79UWZCIybM6l0tBLK2lXpDQ8hgKP+8BDG1UQMKaBldeX3FPW8KT9F8+8uoBfH60OiF8csv7pMZJqG/RDhhKexZZRgJgzb6fwIJWLI95B21IRptKmWGLFYGPvgFGrwwWWUKTtVsuW87VUcZQXecw6zOjzFPtWOcROijIS8YddzttL+qo6c9cuiYFATzKrlirIc5/F4JxkINwws8FGRdHNYwZNSE2wcukNSLfaE33xF7A9mdCV0sl2G3rqSI8Vu0DI7RSbx3jqBgIUqmbs1dzJS2CIn7+mb2WJCWsW2Krd3ywu2rqQ7hUkwFJOMyzAzVWkcsRm34dQZrSiuira+KZceBrWucgkDeatEiOww5sYUriCA3d29nZ9fvz7Yebl/sL+31/E3+tgxqRKp65XIJCppzsZyqVTZG0TVQ5U8bW2k7xS9c6/zyKGdvTryl671aDSJksa3lt1OpwFEaUhM5/vxznrH/T7j8ZmOPtPRZzr6TEe/nY5mXNEPrqdxTKssjze6eZUILhz2TEMgJPWqqScfccuZkLc8FtHDjTnR6jrG2U9PbdDUIFOz4Q2doTEZ+Viras43Gjdt45WuJqavtdJFGl42TFWlr0UUoVzNwYv2i3//cV+tH/dUWXasUhn954671wTy3vmAVeDM0Cn8D9DuXrlhqoWdOzp3jVyj3nYM53K8DBYQKvVJoPs2DjYl/UDh26kiZpgo4zLB7RS60L7daefy24V825NioGj0LWrjgkl1DF1Y+Owuu+32YqqMXXYXidJ26XirFvw6e6zSnq+se4dCF2IV8njq3a8GPpoiow2aLPR8INpPGPDeW47mFG/H3NxB56DTaIlEH7BSIqO0M7U2abTjhRstLf3LwVdqSHL+0Hl1ysmRCGJk+dCEs/P+RW/U3x4WzESQu0xvGaxUvLCShegCou9eCHLp4xysv30YOWDRRbgof1nu+98QVl8UIqqyKeevUzDkkgjXKW6FgK0z23KzmdB2mulqZ5WMllaaOej6vqee6+sF4+zU+eQ6bcx54NoBS/p3Wc+arPnNCFBxx8dNbOypVkr2VFvxpKlDXkrCU2k8/nnYqT9xFw679QdjYbr2WCSATpTDYtatztx/GcjO0+tYhHQv1m+PYtw9HRkPrbhF99QNFYHQYsQyDFR+6RGS5WYnSrOZksIqCshpWq1SaitTpawPkgYBD11D8F2Jbojpttt3d3etkM9SGfFWqGaUhliEKI1Df5bpk2wlqClHKjSFtlDue1vjBDXKENuZIdN2XDeHFuy0Oq2Ob1HGzrisOHqsIa9krLjpFu9tO4m5kGTRhbfIevUl3O5UsL1dNZb163GQtd1LWCyuucF3Ol4uafkz/b5IU6Ps0n6iwBR55HHhmwAc+iG77S5Kica1dz9NI6/RC0NM7KOy48oEOj8bjqh3Zf95zVREOprfEbD5HXThCq6AoOiy4xqrW19AzOVN6qYweLvU7XhK6SlSWGuO7mR5N5bzSpS/vHECbKQ+ofw1b4Jg6av/neRvuEiA2w== +api: eJztWdtSGzkQ/RVVv7CbHWxDAkv85mBT5V0KWOwkW0VcKTHTxkrG0kTSAF6X/32rpbl5PBCT5GEvvNlS39R91H1kL8HyGwPdK+hjKIxQciiN5TJEmASgEtTc0mIEXTDIdTj7eAgBaPySorFvVLSA7hIiNKEWCUlCF0ZOjuE9nycxGgggVNKitCTKkyQWoTPa/mRIfgkmnOGc0ye7SBC6oK4/YWghgERTCFagod2piC3qr8uJqCJjrBbyBlYBfMZFZV1IizeoIYCp0nNu/dLhK5I0llvctBEAynROyTrpDU8HfQhg8K53+rY3dp/fnv1+dv7+zH0aXQyOhyfDQR8mqwDwlsepO3O/0fCayAkXcaqbpRKtQjSmj1MhBQn/vvWZMtW8vNsrRjkwmrOab5cxfUXwjM+bD5cLvENthEfGo+G93K9qjZ3owyXrD46Ho+H52cdx783pAAI4HY4Hl73Tj4M/Ly4HI9qqVa6sKNVQo0lj+1jtMBrKJLWmIsO15gsIQFicm28GrnwoY+S3aWcVgBU2pqX6tXYhOoki6vPU/jPCDkCnMT4AH7clI7zfChePZMAf14ug5NI2OnzEgOsQ4i/cEqC+bfam663rKykm/0Zp++1FmQqMmzOpdLQWysZV6Y2OIYD+YHQMk2oiRhTQqrryR4p60ZSfovl3l9CL480h0Ytjll9dJjJNw36KcMrT2DJKMBOG7XV+hhIx5HtEO2rKNNpUS4xYLIx9cAo1+OAyypSdKtly3g4qjrICHziHWR2eYp9qx7gJUUZC3rDrBVtrf1VHzvpVUTCoCWbVckVZTfJ4vJMMhFsGFvioSLo5rOBJqQm2Dt0hqRZ7wm++IfYHM7oWOtkuQ299kGPFbtAyO0Mm8d46gYCFKlm4NXcyUtghJ+/om9lhQlrFdiq3d8cLtj5IdwqTYCimGZdhZqbSOGJzbsOZM1pRXBdtfVcuPQxqXeUKhvJWiRDZccyNKVxBAPv7B3u/vn59tPfy8Ojw4KDjb/SJY1IlUjcrkUlU0pyN5VKpsjeMqocqedrGSN8reudB55FDO3t15K9c69FoEiWNby37nU4DiNKQmM6P4531jvtjxuMzHX2mo8909JmOfj8dzbiiH1xP45hWWR5vdfMqEVw67JmGQEjqVVNP7nPLmZC3PBbRw4050eo6xvkvT23Q1CBTs+UNnaMxGfnYqGrONxo3beOVriZmoLXSRRpeNkxVpa9FFKFcz8GL9ot//3FfbR73TFl2olIZ/eeOe9AE8t7FkFXgzNAp/A/Q7l65YaqFXTg6d41co951DOdqsgqWECr1WaD7Ngm2Jf1A4duZImaYKOMywe0MutC+3Wvn8ruFfNuTYqBo9C1q44JJdQxdWPrsrrrt9nKmjF11l4nSduV4qxb8Onus0p6vrHuHQhdiFfJ45t2vBz6eIaMNmiz0fCDaTxjw3luO5hRvx9zcUeeo02iJRB+wUiKjtDOzNmm044UbLa38y8FXakRy/tB5dcrJkQhiZPnQhPOLwWVvPNgdFcxEkLtMbxWsVbywkoXoAqLvXghy6ZMcrL+9Hztg0UW4LH9ZHvjfENZfFCKqsinnr1Mw5JII1yluhYBtMttys5nQdprpamedjJZWmjno5r6nnpvrBePs1PnkJm3MeeDGAUv6d1XPmqz5zQhQcccnTWzsqVZK9lRb8aSpQ15KwlNpPP552Kk/cZcOu/UHY2G69lgkgE6Vw2LWrc7dfxnILtLrWIR0LzZvj2LcPR0ZD624RffUDRWB0GLEMgxUfukRkuVmp0qzuZLCKgrIaVqtUmorM6WsD5IGAQ9dQ/BdiW6I6bbbd3d3rZDPUxnxVqjmlIZYhCiNQ3+W6dNsJagpRyo0hbZQ7ntb4xQ1yhDbmSHTdlw3hxbstTqtjm9Rxs65rDh6rCGvZay46RbvbTuJuZBk0YW3zHr1FdzuVbC9WzWW9etJkLXdK1gur7nBtzperWj5C/2+SFOj7NJ+osAMeeRx4ZsAHPshu+suSonGjXc/TSOv0QtDTOyjspPKBLo4H42pd2X/ec1VRDqa3xGw+R10gWDoMuOaqltbQszlTeomMHib1Ol4Sqkp0ldrjO5UeSeWi0qEy6WXGKvPKFervAOCpe/+R5K/AYP2gVU= sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search decision instances

+ Search decision instances -## Request + -

Body

+ -Search examples + -
    filter object
    evaluatedInputs object[]
  • Array [
  • ]
    • evaluatedOutputs object[]
  • Array [
  • ]
    • sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
    • evaluatedInputs object[]
  • Array [
  • ]
    • evaluatedOutputs object[]
  • Array [
  • ]
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-7.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-7.api.mdx index 53311a23861..7b5d4a83384 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-7.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search-7.api.mdx @@ -5,59 +5,242 @@ description: "Search decision definitions" sidebar_label: "Search decision definitions" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/ivEecnWKb6kdZsKwwC3SYFsQ5LFXveQGAMtHVtsJVIlqaSe4P8+HFKWZVtO42Iv3fYmkefynfuRSrB8biC8hTOMhBFKnuFMSGGFkjAJQOWoOb1cxBCCQa6j5M9XEIDGTwUa+0bFCwhLiNFEWuSOLYSRo2P4mWd5igYCiJS0KC2R8jxPReSEdj8Yoi/BRAlmnJ7sIkcIQU0/YGQhgFwTBCvQ0O1MpBb1l+lE3KAxVgs5h2UAH3HROBfS4hw1BDBTOuPWH718QZRx5Y2LdkGSZ9h6cY/aCG/To1qenzS13OCnQmjMUFqzR2Mb6S8Hm9PkvtxnQxvx+4Pssii5tK2W0K2wKR21ZNwyACP+wieq8ek4nG2mBNeaLyAAYTEzu6lCCIzS9ukcu0mIaXuQlI43oFQ3AaAsMiqy4egtBHB2PnoLk6YrRgRo2Tz5rUC9aPdQXVZhCcM03S2/YZqyVRBZXPMa9l2MM16klpGTmTCs3/seArjnaUE+J/0julEzptEWWmLMUmHs3gpv1cJlXLE7ZpLm9A0aqqowD5zKKhqHaaAYMm4ilLGQczZdMFeUTRVO7m0dMKgIqii5YCwnKwReaJV8T4YSeBxEvwkkOMgNwRfBupzZQpvz+Veh3fHaBliSugbbuZNjxeZomU2QSfxsHUHAIpUv3JmzhRiOSPh7ejNHTEir2FGjQo88YedOOvwmx0jMqjnATKKKNGYZt1HihDYYN0k7X+U9H+qtjuFnXoxO4ZkwCQRwcjLov3r9+rT//OXpy8Gg58v0nRs767TbdXpFMV2wagKsiacL1pgmDfTrYVZPjX7dAAe9Fqs25Gyn8dL1D40mV9L47nDS67XkRxFFaP7BobzdNg9sp//P6m90VleD1Ff8YQPYKsvTJ/mjgeEGTZFa0wqF6F60ZfsZt5wJec9TEe9P+VyraYrZD4emvrHcFuaJns7QmKpj78RRSGO5jNov/cFj4TnXWunaDc9b+pPSUxHHKDd98Kz77Ns398WuuZfKsneqkPG/ztxBW5IPry9YI50ZOob/QLa7j4Co0MIu3KCcIteoj93suJ0sgxIipT4KdG+T4OmbEpABNlE0dXNlnC+4TSCE7n2/u+I4bnB0/W4BhEjTaHGACp1CCKX38DLsdstEGbsMy1xpu3TbgBZ8Wm3zdOej69Z0CCFVEU8TD2AT/DhBRhc03mj7oiWG8sBr75An83qxXok77Z32WiUR6R4p6+xYy0mszVvleOJWSUu/gPlojYjOG72K0Hp+5IKm5Wpyw9X1+c1wfH48Oh+NLq4uabKQuopvGWxEvZZSQXSA6N0TwYr63Sphf/5j7JKLiuFm/VPj3H9kbe5pIm5+1Dl9vc39Y31bga/f622jt3+XWFPvXSH2cF9uaXt0L+g1p36j8vzm2dtek0sXuO1dtFa1tYdSdGbKBaIq1yv3DwnZdTFNRURJsZs6inG3lTIeWXGPbnuOFEXAYsxyrdzlqm/QE1uJnSnNMiWFVQTIcVqtCqqpRCnrQVIn5JGrBl+SlB4m7HYfHh46Ec8KGfNOpDJyQyoilMaFvgrir9VJsMUcq8jU3EK5967GGWqUEXYrQaa7sW1Cv9Pr9Hx9Gptx2VD0eEfa8Fmd6BY/226ecuF+DjiAZdWsbuG+30iG401xVcOaBFXfuYWynHKDv+t0uaTjT/QPglrnuk35tgoJ8tjnhq8CeOsnzfGYMNXfOLufFdSSPccwijC3j9JOGk34+mo0puKt/jdmKiYezR/oXyR/gBDu4A4oHXNvX1j68xJSLueFG0Xg5VK584IcVDtxqzs4y1btSC4aKH984wjYWH1E+dOqC4ClV/8Z9jeJZlWE +api: eJztWEtz2zYQ/iuYvbhNaUl2osThTY2dGbcZ27XU9OBoOhC5kpCQAAOAdlQO/3tnAYoiJcqxMr2k7Y0E9vHte8kCLF8YCO/gHCNhhJLnOBdSWKEkTANQGWpOL5cxhGCQ62j55ysIQOPnHI39WcUrCAuI0URaZI4thLGjY/iFp1mCBgKIlLQoLZHyLEtE5IT2PxqiL8BES0w5PdlVhhCCmn3EyEIAmSYIVqCh27lILOqv04m4QWOsFnIBZQCfcNU4F9LiAjUEMFc65dYfvXxBlHHljctuQZKn2Hlxj9oIb9OjWp6fNrXc4udcaExRWrNHYxfprweb0+S+2mdDF/H7g+yyKLm0nZbQrbAJHXVkXBmAEX/hE9X4dBzN2ynBteYrCEBYTM1uqhACo7R9OsduEmLSHSSl4xaU6iYAlHlKRTYav4EAzi/Gb2DadMWYAJXNk99y1KtuD9VlFRYwSpLd8hslCVsHkcU1r2E/xDjneWIZOZkJw04GP0IA9zzJyeekf0w3as402lxLjFkijN1b4Z1auIwrdsdM0py+YUNVFeahU1lF4zANFEPGTYQyFnLBZivmirKpwsm9qwMGFUEVJReMcrpG4IVWyfdkKIHHQfRtIMFBbgi+CtblzBbajC++Ce2O11pgSeoGbO+DnCi2QMvsEpnEL9YRBCxS2cqdOVuI4YiEv6c3c8SEtIodNSr0yBP2PkiH32QYiXk1B5hZqjyJWcpttHRCG4xt0t43ec+Heqtj+JkXo1N4LswSAjg9HZ68ev367OT5y7OXw+HAl+lbN3Y2abfr9IpitmLVBNgQz1asMU0a6DfDrJ4aJ3UDHA46rGrJ2U7j0vUPjSZT0vjucDoYdORHHkVo/sGhvN02D2yn/8/q73RWV4PUV/xhA9gqy5Mn+aOB4RZNnljTCYXoXnRl+zm3nAl5zxMR70/5TKtZgulPh6a+sdzm5omeTtGYqmPvxFFIY7mMui/9wWPhudBa6doNzzv6k9IzEcco2z541n/2/Zv7YtfcK2XZW5XL+F9n7rAryUc3l6yRzgwdw38g291HQJRrYVduUM6Qa9THbnbcTcuggEipTwLd2zR4+qYEZIBdKpq6mTLOF9wuIYT+/Ul/zXHc4Oj73QIIkabR4gDlOoEQCu/hMuz3i6UytgyLTGlbum1ACz6rtnm689F1azqEkKiIJ0sPoA1+skRGFzTeaPuiJYbywGvvkSezerFeizsbnA06JRHpHimb7NjIWVqbdcrxxJ2SSr+A+WiNic4bvY7QZn5kgqblenLD9c3F7WhycTy+GI8vr69ospC6iq8MWlGvpVQQHSB690Swpn67Tthf/pi45KJiuN381LjwH1ntPU3EzY86p2/Q3j82txX4+r3eNgb7d4kN9d4VYg/31Za2R/eCQXPqNyrPb56D7TW5cIHb3kVrVVt7KEVnrlwgqnK9dv+QkN3ks0RElBS7qaMYd1sp45EV9+i250hRBCzGLNPKXa77Bj2xtdi50ixVUlhFgByn1SqnmloqZT1I6oQ8ctXgS5LSw4T9/sPDQy/iaS5j3otUSm5IRITSuNBXQXxXnQRbzLGKTM0tlHvva5yjRhlhvxJk+q1tE056g97A16exKZcNRY93pJbP6kS3+MX2s4QL93PAASyqZnUH9yeNZDhui6sa1jSo+s4dFMWMG/xdJ2VJx5/pHwS1zk2b8m0Vlshjnxu+CuCNnzTHE8JUf+PsflZQS/YcoyjCzD5KO2004Zvr8YSKt/rfmKqYeDR/oH+R/AFCoFTMvG1h4c8KSLhc5G4MgZdJpc5zck7twK3O4KxatyK5aiAsCk8xUZ9QluW6BYCld/8N9jfXGVX+ sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search decision definitions

+ Search decision definitions -## Request - -

Body

- -Search examples - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search.api.mdx index 0bb5e4e40e3..567cbe91ad1 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/search.api.mdx @@ -5,56 +5,214 @@ description: "Search variables for process instances" sidebar_label: "Search variables for process instances" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/ivEeXHbqZGcppcYw4A0TYB0Q5PFWfeQ5oGWjm22FKmSlBNP0H8fDinLsq02CTAM2CVPEc+F5/KdC12B4zMLo2v4yI3gE4lwE4Eu0HAntDrLYAQWuUnnEIHBryVa91ZnSxhVkKFNjSiID0Yw9lxs0aixEEGqlUPliJcXhRSp1xl/tiRQgU3nmHP6zy0LhBHoyWdMHURQGLLACbREnQrp0NzP9wWXHSahHM7QQARTbXLuwtGrA6i9XIrWninruErx5wcL2lQXj2BXPMcOq3VGqBkRFlyW/RRnSpVyh1mHOtFaIleejIord5b1yBJVOElHbS7JZPEH3mvui33P6lN4NN2MNjeGLyEC4TC3u1mge6027uESu/lF2edQBNpkG6Y0lAhQlTmB9mh8DBG8Oxkfw003AGMyqO6e/FqiWXbjgnc8L2Sw4EjKXUBfoiuNsoxLuUY1e5LhlJfSMePJTArrGMWYCcuGyVNYJ5euHzfR71e9n3Q0dySbpO0npOLUw59xlbFVnB9i6K1wczbYRfqADQ6T5PXw8HD/5cHrg+Hw8NXAK8aMcZuiyoSascmSefB2bFqXYV/5wLZSaHFx3aYYGp1NXn36ap+4Cz6jzH7TN4V3ruPcVJt+3zY8GNB1gz325FgXS+YdYXrKBmTWR/qyA+Yto9PC4ELo0jKDtpTOPmV/i/NbVXcNNudSQrShcT9Jbmr/R03YFlrZANz9JOnpxGVKFv51DXi7jh9Z3//35d2+3OAjoPBxzdZpx+WDHO3cfBlA3TGAqAd98HnHHWdCLbgU2bcxVBg9kZj/8FgsWcddae81PwykHK3ls/6EiAYk/dnyB99LxYkx2rRheLEbhlNtJiLLUG3G4Fn87J/v7sGuux+0Y6e6VNm/zt2XfSA/ujhjHTgz9AL/AbT7NS8tjXBLP5wmyA2a575HX9/UUQWp1l8E+q+b6J4l3w/ipmuzlY00eXJ0c01Dr9DWh4W7OYwgXgzjVjhuHxYWzQKN9QaVRsIIqhDhehTH1VxbV4+qQhtX+5m8emGMKiBayK7fymAEUqdczsOtm8ZfzZERgbo/TXw3R0Y4CLfv+QHULlgrdW+SN0mvJmL9hpY1OtZ65s4VvXoCc6+mOqwHIVtj4gtOrzK0nhqFoOG3GmxwfnFyeXR18nx8Mh6fnX+geULXNXJ1tJH1VktjojfIjzfPBCvu0xVg3/9+5cFFxXC5fhKehIV6c1vyNyT9kz3pzu2kNb5d8pthvD7ozGBnSuxO3U41hN052V6sKh/M7Z2s1b21klLEptoHpymhc/8mRnZRTqRIKVG76dSM+9WL8dSJBfqdPdUUFdqud+qECcVWaqmQcq2E02SQl3RGl4TzudYuGEndiaceoaFMKGV2FMe3t7d7Kc9LlfG9VOcUBilSVNanownsL81JtCWc6dS20kL779jgFA2qFONGkY39goTGBmeHe8leEmrGupyrzkUP7hIb4Wtx6PDOxYXkwm9W3taqaSDXsBhutIBVlulXi9ALrqGqJtzib0bWNR1/pZcftbO1XGh1MEeeBWwEnMJx6P7Pr8iQNQB3dmdqk0HiKE2xcN/lvel0w4vz8RUVVPMLSq4zkjH8ln5d4bcwgk/wCQiOPii+2v15BZKrWenHAwS9VIK8pKisF9LNivWerVqEWnas/PGtZ2BX+guqnyBqvHH06V9k9Z/w5iYI +api: eJztWFtv2zYU/ivEeXHbqZGcppfoLUsTINvQZHHWPQR5oKVjmy1FqiTl1BP034dDyrJsq00CDAN2yVPEc+G5fOdC1+D43EJ6Cx+5EXwqEe4i0CUa7oRWFzmkYJGbbAERGPxSoXU/6nwFaQ052syIkvgghYnnYstWjYUIMq0cKke8vCylyLzO+JMlgRpstsCC039uVSKkoKefMHMQQWnIAifQEnUmpEPzMN9nXPWYhHI4RwMRzLQpuAtHb46g8XIZWnuhrOMqw58fLWgzXT6BXfECe6zWGaHmRFhyWQ1TnKlUxh3mPepUa4lceTIqrtxFPiBLVOEkHXW5JJPFH/igua8OPatP4clsO9rcGL6CCITDwu5nge612rjHS+znF+WQQxFok2+Z0lIiQFUVBNqTySlE8P5scgp3/QBMyKCmf/JrhWbVjwt+5UUpgwUnUu4D+hpdZZRlXMoNqtmzHGe8ko4ZT2ZSWMcoxkxYNk6ewya5dP2kjf6w6sOkp7kn2SbtMCEV5x7+jKucreP8GEPvhVuw0T7SR2x0nCRvx8fHh6+P3h6Nx8dvRl4x5ozbDFUu1JxNV8yDt2fTpgyHygd2lUKHi9suxdDqbPPq09f4xF3xOWX2m74p/Op6zs20GfZty4MRXTc6YM9Odbli3hGmZ2xEZn2kLzti3jI6LQ0uha4sM2gr6exz9rc4v1N1t2ALLiVEWxoPk+Su8X/UhG2plQ3APUySgU5cZWThX9eAd+v4ifX9f1/e78stPgIKn9ZsnXZcPsrR3s3XAdQ9A4h6NASf99xxJtSSS5F/G0Ol0VOJxQ9PxZJ13FX2QfPDQCrQWj4fTohoQTKcLX/wvVScGaNNF4ZX+2E412Yq8hzVdgxexC/++e4e7bv7QTt2riuV/+vcfT0E8pOrC9aDM0Mv8B9Au1/zssoIt/LDaYrcoHnpe/TtXRPVkGn9WaD/uoseWPL9IG67NlvbSJOnQLfQNPRKbX1YuFtACvFyHHfCcfewsGiWaKw3qDISUqhDhJs0juuFtq5J61Ib1/iZvH5hpDUQLWTXb2WQgtQZl4tw67bxNwtkRKDuTxPfLZARDsLtB34AdQvWWt275F0yqIlYv6Flg46NnoVz5aCewDyoqQnrQcjWhPiC0+sMbaZGKWj4rQcbXF6dXZ/cnL2cnE0mF5cfaJ7Qda1cE21lvdPSmugN8uPNM8Ga+3wN2J9+v/HgomK43jwJz8JCvb0t+RuS4cme9Od20hnfLfntMN4c9GawMxX2p26vGsLunOwuVrUP5u5O1uneWUkpYjPtg9OW0KV/EyO7qqZSZJSo/XRqxv3qxXjmxBL9zp5pigpt13t1woRia7VUSIVWwmkyyEs6oyvC+UJrF4yk7sQzj9BQJpQym8bx/f39QcaLSuX8INMFhUGKDJX16WgD+0t7Eu0I5zqznbTQ/js2OEODKsO4VWRjvyChscHZ8UFykISasa7gqnfRo7vEVvg6HDr86uJScuE3K29r3TaQW1iOt1rAOsv0q0XoBbdQ11Nu8Tcjm4aOv9DLj9rZRi60OlggzwM2Ak7hNHT/lzdkyAaAe7sztckgcZJlWLrv8t71uuHV5eSGCqr9BaXQOckYfk+/rvB7SIGg6APiK92f1SC5mld+NEDQSeXHK4rIZhndrlbv1bo9qFXPwroOHDf6M6qGOmpwxdG3f441fwLNHCaC sidebar_class_name: "post api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search variables for process instances

+ - + Search variables for process instances -## Request - -

Body

- -Search variables - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx index b378b45273b..d3ae80344bb 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx @@ -5,61 +5,133 @@ description: "Get sequence flows of process instance by key" sidebar_label: "Get sequence flows of process instance by key" hide_title: true hide_table_of_contents: true -api: eJzlVt1v2zYQ/1eIe9o6xnLabCiEYUAKOIXXYQmSFH0I/EBTZ5uNRCrkyZkh6H8fjpSc2Fax7XGoX2R+3O/ufvfFFkitA+QPcOOdxhDmNpCyGmEhwdXoFRln5wXkEPCpQavxqnTP4cPuE+5AQq28qpDQM0YLVlUIOTzGM2Mhh1rRBiQUGLQ3NYNBDp9wJ9xK1EmlMINOCR6fGuOxgJx8gxKC3mClIG+BdjVDG0u4Rg8SVs5XitLWLxfQdQsWD7WzAQNLvJ1O+XOo+q7RrBMkaGcJLfGVN9kb/pwoU96r6AlhFV7tB/LGrqHjn4SLMT1zu1WlKQQ7hIEO9am6Lo2O1Ga1d8sSq5++BpYbMcItv6JmgNpzQMgk7wIpasI/MvPuLXQSKgxBrXHEBQ5Tz/7YYdo4dVwCGSp5a+a98zAw8e6UiSvnl6Yo0P47zv9X7l6cunubAo4c+uAar1FYR2LlGlt8H1nw81g9XN7MxSuHBUaB74CPTkJA3XhDu9gil6g8+jNukfnDopMtaOceDcbV4rhTfkQSQ+MVK+68Y41TLHci9dwKaeO4W68xksPdN4dse571MmeDTMjaR9x12YB+FtGBrfXboZ83voQc2sR+l2dZu3GBurytnacOJGyVN2pZJvL5LEV+pZqSqS6dVmXcPnbsfoOCD3hisEu0QcE5krRPmGXWcQj3fvp+OorEV7+B8pI5LzgbonoUJ10eRYrzZYjkHd9LTg/RexkatUmzsR+G1zez28v72dnd7O5ufv3nMBh7uU4eZMQepTcxGsTrdAmG21dDMv/+5T4mnrErF8X7BLyOsxvFTbMsjWZXTh12QsVhKJQms0WhbCG0q+oSuX0dJxn/EwPsynlROWvIcepHSfKu4UzYOEdcDqm2lY4xTInEToU8y56fnydaVY0t1ES7ikkojUYbIo89b3/0O/JIuHA67KWNi+vM4wo9p3HWA4WMUTmRk7Pnk+lkmrIqUKXsK0X/tcYOWNwHjPAvyupSGctaosltX38PsD1PneqwAkFCniCPinAh+1p6gLZdqoCffdl1vP3UoI+N46X0YqEWJvD/AvKVKgOeGLlvs/DDbf/E+lF8+xk26tOQ33YXC79seAUyvvbSm69bdBI2qAr00ap0cqk11vRKhkc/V9O+WX2c3YME1TBZe0KPMj4Cjprw64d4Qdy7R7S/7Q0iXrJJXfc3GfC7mA== +api: eJzlVktv2zgQ/ivEnHa7jOW06aLQLQWcwtvFJohd7CHwgaZGNhuJVEjKWUPgfy+GlJzYVrG7x6K+yHzMNzPfvNiBFxsH+QPcWSPRubl2XmiJsOJgGrTCK6PnBeTg8KlFLfGmMs/u4/4z7oFDI6yo0aMljA60qBFyeIxnSkMOjfBb4FCgk1Y1BAY5fMY9MyVrkkqmBp0cLD61ymIBubctcnByi7WAvAO/bwhaaY8btMChNLYWPm39fgUhrEjcNUY7dCTxdjqlz7HqRStJJ3CQRnvUnq68yd7Q50yZsFZETzzW7tW+81bpDQT6cbga0zPXO1GpgpFD6PyxPtE0lZKR2qyxZl1h/dtXR3IjRpj1V5QE0FgKiFfJO+eFb92/MvPuLQQONTonNjjiAoWpZ3/sMG2cO87BK1/R1sxaY2Fg4t05EzfGrlVRoP5vnP9Q7l6du3ufAo4UemdaK5Fp41lpWl38HFnwfqweru/m7JXDDKPAT8BH4OBQtlb5fWyRaxQW7QW1yPxhFXgH0phHhXG1Ou2Un9CzofGykjrvWONk6z1LPbdGvzXUrTcYyaHum0O2u8x6mYtBxmXdI+5DNqBfRHQga+1u6OetrSCHLrEf8izrtsb5kHeNsT4Ah52wSqyrRD6dpciXoq2I6spIUcXtU8eWW2R0QBODXPJbZJQjSfuEWCYdx3Afph+mo0h09TsoL5nzgrP1vhnFSZdHkeJ8GSK5oHvJ6SF6L0OjUWk29sPw9m52f72cXSxmi8X89q9hMPZygR9lxAGlNzEaROt0CYbbN0My//H3Miae0qWJ4n0C3sbZjeyuXVdKkivnDhsm4jBkQnq1QyZ0waSpmwqpfZ0mGf1jA2xpLKuNVt5Q6kdJb01LmbA1xlM5pNoWMsYwJRI55fIse35+nkhRt7oQE2lqIqFSErWLPPa8/dnv8BPhwkh3kFYmrjOLJVpK46wHchmhUiInZy8n08k0ZZXztdCvFP3fGjti8RAwj//4rKmE0qQlmtz19fcAu8vUqY4rEDjkCfKkCFe8r6UH6Lq1cPjFViHQ9lOLNjaOl9KLhVooR/8LyEtROTwz8tBm4Zf7/on1K/v+M2zUpyG/9T4WftXSCnh87aU3X1gFDlsUBdpoVTq5lhIb/0qGRj9V06FZfZotgYNoiawDoScZHwFHTei6dGNpHlGHcLDI05psCuEb9aq9Dg== sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

- Get sequence flows of process instance by key -

+ Get sequence flows of process instance by key -## Request - -

Path Parameters

- -Success - -
Schema
  • Array [
    • - -string - -
  • ]
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sidebar.js b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sidebar.js deleted file mode 100644 index 8c5076925df..00000000000 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sidebar.js +++ /dev/null @@ -1,180 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/operate-public-api", - }, - { - type: "category", - label: "ProcessDefinition", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-2", - label: "Search process definitions", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-2", - label: "Get process definition by key", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/xml-by-key", - label: "Get process definition as XML by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "DecisionDefinition", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-7", - label: "Search decision definitions", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-6", - label: "Get decision definition by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "DecisionInstance", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-6", - label: "Search decision instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-id", - label: "Get decision instance by id", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "FlownodeInstance", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-4", - label: "Search flownode-instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-4", - label: "Get flow node instance by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Variable", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search", - label: "Search variables for process instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key", - label: "Get variable by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "ProcessInstance", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-1", - label: "Search process instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-1", - label: "Get process instance by key", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/delete", - label: "Delete process instance and all dependant data by key", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/get-statistics", - label: "Get flow node statistic by process instance id", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/sequence-flows-by-key", - label: "Get sequence flows of process instance by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "DecisionRequirements", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-5", - label: "Search decision requirements", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-5", - label: "Get decision requirements by key", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/xml-by-key-1", - label: "Get decision requirements as XML by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Incident", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-3", - label: "Search incidents", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-3", - label: "Get incident by key", - className: "api-method get", - }, - ], - }, -]; diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sidebar.ts b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sidebar.ts new file mode 100644 index 00000000000..c08ec748689 --- /dev/null +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/sidebar.ts @@ -0,0 +1,186 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/operate-public-api", + }, + { + type: "category", + label: "ProcessDefinition", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-2", + label: "Search process definitions", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key-2", + label: "Get process definition by key", + className: "api-method get", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/xml-by-key", + label: "Get process definition as XML by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "DecisionDefinition", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-7", + label: "Search decision definitions", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key-6", + label: "Get decision definition by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "DecisionInstance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-6", + label: "Search decision instances", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-id", + label: "Get decision instance by id", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "FlownodeInstance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-4", + label: "Search flownode-instances", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key-4", + label: "Get flow node instance by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Variable", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search", + label: "Search variables for process instances", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key", + label: "Get variable by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "ProcessInstance", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-1", + label: "Search process instances", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key-1", + label: "Get process instance by key", + className: "api-method get", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/delete", + label: "Delete process instance and all dependant data by key", + className: "api-method delete", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/get-statistics", + label: "Get flow node statistic by process instance id", + className: "api-method get", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/sequence-flows-by-key", + label: "Get sequence flows of process instance by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "DecisionRequirements", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-5", + label: "Search decision requirements", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key-5", + label: "Get decision requirements by key", + className: "api-method get", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/xml-by-key-1", + label: "Get decision requirements as XML by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Incident", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/search-3", + label: "Search incidents", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/operate-api/specifications/by-key-3", + label: "Get incident by key", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx index 434048b7599..403b919a73a 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx @@ -5,56 +5,131 @@ description: "Get decision requirements as XML by key" sidebar_label: "Get decision requirements as XML by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivEfVo71nLarCiEYUCKuUWWdgliFy0QGANNnW02EqmSlBND4H8vjpSUONbQfR36SeLLPXf33AuvBS82DvIb+BOlcsroa/zWKIsVau9gycHUaIVXRp8XkMN9Vb7dX+D+nxPgUAsrKvRoCaAFLSqEHG5xDxyUhhxq4bfAoUAnraoJBHK4wD0za1Z0+ph9rJBDtywg97ZBDk5usRKQt+D3NeEr7XGDFjisja2ET1uvTyGEJYm72miHjiReTqf0OdQ/b6RER6qk0R61j9h477P7qqT/I43OW6U3EEIIHE7HMM/1TpSqiL6g84fYoq5LJSOHWW3NqsTq16+O5EZ0mdVXlARQW2Leq+SJ88I37ocsvHoJgUOFzokNjnhAcXFeaDl+mDaO/ebglS9pa2atsQMTr46ZeGfsShUF6kMOnmfP///unh67e50CjhR6ZxorkWnj2do0uvg5suC3sXo4uzpnjxxmGAV+Aj4CB4eyscrvY09cobBoX1BPzG+WgbcgjblVGFfLp63xPfrxvsiEY18+fmCrPUvttUK/NdSQNxhpoUabQ7Y7yQpbZO0t7kNsZ2SO3fUdurEl5NAmekOeZe3WOB/ytjbWB+CwE1aJVZnYpbMU2rVoSuKyNFKUcfup5YstMjqgN4C6u98ioyRI2idEI+k4hHszfTMdRaKr/4LykBoPOFvv61GcdHkUKT4WfajmdC853YdnCLeo1UWkvHveLq9m12eL2Yv5bD4/v/y7f+o6ucAPQj6gdCZGg2idLkF/+12frX99XsTMUnptoniXYZfxFUZ21axKJcmVY4cNE/FlY0J6tUMmdMGkqeoSqT/V1sTDPtXpj/Wwa2NZZbTyhnI7SnprGsqErTGe8j0Vr5AxhimRyCmXZ9nd3d1EiqrRhZhIUxEJpZKoXeSx4+1Dt8OfCBdGukFambjOLK7RopaYdUAuI1RK5OTsyWQ6maascr4S+pGi/15EB/wNoYqjQF0KpQk/Gtt2BXYDO5p7Cku9PU8gVGVL3hXLDbTtSjj8ZMsQaPtbgzaW/kNtxUoslKP/AvK1KB0e2TI0SvilG8iKZ+wHk9Oo/X0W630s77KhFfA4paVZLSwDhy2KAm00LZ2cSYm1fyQzTEhUOEP7eT9bAAfREDsDg0+SO6KO2vH723iBLcwt6j8Gqzwtya4QvgP4oaIs +api: eJzlVm1v2zYQ/ivEfdo61nLabCj0LcPcIku3BLGHFgiMgabOFhuJVEnKiSHwvw9HSkoca+i+Dv0k8eWeu3vuhdeBFzsH+R38hlI5ZfQtfm2VxRq1d7DmYBq0wiujLwvI4bGufj1c4eHvM+DQCCtq9GgJoAMtaoQc7vEAHJSGHBrhS+BQoJNWNQQCOVzhgZktK3p9zD5XyKFfFpB72yIHJ0usBeQd+END+Ep73KEFDltja+HT1i/nEMKaxF1jtENHEm/mc/oc61+2UqIjVdJoj9pHbHz02WNd0f+JRuet0jsIIQQO51OYl3ovKlVEX9D5Y2zRNJWSkcOssWZTYf3TF0dyE7rM5gtKAmgsMe9V8sR54Vv3TRbevoHAoUbnxA4nPKC4OC+0nD5MG6d+c/DKV7S1sNbYkYm3p0y8N3ajigL1MQevslf/f3fPT929TQFHCr0zrZXItPFsa1pdfB9Z8PNUPVzcXLJnDjOMAt8BH4GDQ9la5Q+xJ25QWLSvqSfmd+vAO5DG3CuMq/XL1vgB/XRfZMKxz398ZJsDS+21Rl8aasg7jLRQo80h259lhS2y7h4PIbYzMsfuhw7d2gpy6BK9Ic+yrjTOh7xrjPUBOOyFVWJTJXbpLIV2K9qKuKyMFFXcfmn5qkRGB/QGUHf3JTJKgqR9RjSSjmO4d/N380kkuvovKE+p8YRTet9M4qTLk0jxsRhCtaR7yekhPGO4RaOuIuX983Z9s7i9WC1eLxfL5eX1n8NT18sFfhTyEaU3MRpE63QJhtvvh2z9/dMqZpbSWxPF+wy7jq8wspt2UylJrpw6bJiILxsT0qs9MqELJk3dVEj9qbEmHg6pTn9sgN0ay2qjlTeU21HSW9NSJpTGeMr3VLxCxhimRCKnXJ5lDw8PMynqVhdiJk1NJFRKonaRx563j/0OfyFcGOlGaWXiOrO4RYtaYtYDuYxQKZGTs2ez+Wyessr5Wuhniv57ER3xN4YqjgJNJZQm/Ghs1xfYHexp7iks9fY8gVCVrXlfLHfQdRvh8C9bhUDbX1u0sfSfaitWYqEc/ReQb0Xl8MSWsVHCD/1AVvzIvjE5Tdo/ZLE+xPKuWloBj1NamtXCOnAoURRoo2np5EJKbPwzmXFCosIZ28+HxQo4iJbYGRl8kdwRddKOrks3VuYedQijWZ7WZFgI/wC6/qOi sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision requirements as XML by key

+ - + Get decision requirements as XML by key -## Request - -

Path Parameters

- -Success - -
Schema
    - -string - -
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key.api.mdx b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key.api.mdx index a00d32b6d33..97eec2e6283 100644 --- a/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/operate-api/specifications/xml-by-key.api.mdx @@ -5,59 +5,131 @@ description: "Get process definition as XML by key" sidebar_label: "Get process definition as XML by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivEfdo6xnLabCiEYUCKuUXWbgliDxsQ+ANNnW02EqmSlBND4H8fjpTk2NZevg79JPHlnrt77o0teLFxkD/AnTUSnfsZ10orr4yGJQdToxW0uCkgh+eqfLf/iHvgUAsrKvRoSbYFLSqEHB7jmdKQQy38FjgU6KRVdcTL4SPumVmzOqlixUEXB4tfGmWxgNzbBjk4ucVKQN6C39cErrTHDVrgsDa2Ej5t/XAFISxJ3NVGO3Qk8Xo6pc+x8nkjSStwkEZ71D5i47PPnquS/s80Om+V3kAIIXC4GsO80TtRqoKR8ej8Mbao61LJSF9WW7MqsfrusyO5EV1m9RklAdSWSPcqeeK88I37VxbevIbAoULnxAZHPKCgOC+0HD9MG+d+c/DKl7Q1s9bYgYk350y8N3aligL1MQevslf/f3evzt29TwFHCr0zjZXItPFsbRpdfB1Z8P1YPVzf3bAXDjOMAl8BH4GDQ9lY5fexIa5QWLQX1BDzh2XgLUhjHhXG1fK0L35AP9IUmXDsz18/sdWepcZaod8aasQbjJxQi80h211mnfDFQdhl7SPuQ+xtZJvd9b26sSXk0CauQ55l7dY4H/K2NtYH4LATVolVmaimsxTntWhKIrY0UpRx+9SNxRYZHdA0oD7vt8goI5L2CXFKOo7h3k7fTkeR6OrfoBzy5ICz9b4exUmXR5Hi5OjjNqd7yek+VkPsRa3S3OsG3e3d7P56MbuYz+bzm9vf+qHXyQV+FP8BpTMxGkTrdAn62+/71P3lj0VMM6XXJop36XYbpzGyu2ZVKkmunDtsmIhjjgnp1Q6Z0AWTpqpLpGbVJ1mf9/THeti1sawyWnlDiR4lvTUNZcLWGE/JnypZyBjDlEjklMuz7OnpaSJF1ehCTKSpiIRSSdQu8tjx9qnb4SfChZFukFYmrjOLa7SoJWYdkMsIlRI5OXs5mU6mKaucr4R+oeg/VtQReUOc4qOgLoXSBB4tbbtqe4DdZWpHp/UGHPIESiW35F3lPEDbroTD320ZAm1/adDGpnAotFiWhXL0X0C+FqXDM9uGFgrf3HdPpW/ZPz2oRp3p81nvY6GXDa2Ax5dber+FZeCwRVGgjXalk2spsfYvZIaHE5XQ0Jg+zBbAQTRE1UDnSZpH1FE7fnwXL7CFeUT902CVpyXZFcJfhPioRg== +api: eJzlVt1v2zYQ/1eIe1o7xnLadCj0lmFukbVbgtjDCgR+oKmzzUYiVZJyYgj834cjJTm2tY/XoU8SP+53d7/7YgtebBzkD3BnjUTnfsG10soro2HJwdRoBS1uCsjhuSp/3n/CPXCohRUVerQk24IWFUIOj/FMacihFn4LHAp00qo64uXwCffMrFmdVLHioIuDxW+NslhA7m2DHJzcYiUgb8HvawJX2uMGLXBYG1sJn7Z+uoIQliTuaqMdOpJ4M53S51j5vJGkFThIoz1qH7Hx2WfPVUn/Zxqdt0pvIIQQOFyNYd7onShVwch4dP4YW9R1qWSkL6utWZVY/fjVkdyILrP6ipIAakuke5U8cV74xv0rC2/fQOBQoXNigyMeUFCcF1qOH6aNc785eOVL2ppZa+zAxNtzJj4Yu1JFgfqYg9fZ6/+/u1fn7t6ngCOF3pnGSmTaeLY2jS6+jyx4N1YP13c37IXDDKPAd8BH4OBQNlb5fWyIKxQW7QU1xPxhGXgL0phHhXG1PO2LH9GPNEUmHPvy22e22rPUWCv0W0ONeIORE2qxOWS7y6wTvjgIu6x9xH2IvY1ss7u+Vze2hBzaxHXIs6zdGudD3tbG+gAcdsIqsSoT1XSW4rwWTUnElkaKMm6furHYIqMDmgbU5/0WGWVE0j4hTknHMdz76fvpKBJd/RuUQ54ccLbe16M46fIoUpwcfdzmdC853cdqiL2oVZp73aC7vZvdXy9mF/PZfH5z+3s/9Dq5wI/iP6B0JkaDaJ0uQX/7Q5+6v/65iGmm9NpE8S7dbuM0RnbXrEolyZVzhw0TccwxIb3aIRO6YNJUdYnUrPok6/Oe/lgPuzaWVUYrbyjRo6S3pqFM2BrjKflTJQsZY5gSiZxyeZY9PT1NpKgaXYiJNBWRUCqJ2kUeO94+dzv8RLgw0g3SysR1ZnGNFrXErANyGaFSIidnLyfTyTRllfOV0C8U/ceKOiJviFN8FNSlUJrAo6VtV20PsLtM7ei03oBDnkCp5Ja8q5wHaNuVcPiHLUOg7W8N2tgUDoUWy7JQjv4LyNeidHhm29BC4Yf77qn0iv3Tg2rUmT6f9T4WetnQCnh8uaX3W1gGDlsUBdpoVzq5lhJr/0JmeDhRCQ2N6eNsARxEQ1QNdJ6keUQdtaNt042FeUQdwmCWpzUZFsJfTW+pvA== sidebar_class_name: "get api-method" info_path: versioned_docs/version-8.6/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process definition as XML by key

+ Get process definition as XML by key -## Request - -

Path Parameters

- -Success - -
Schema
    - -string - -
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx index 14546a99a99..1c871d48400 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx @@ -5,55 +5,290 @@ description: "Assign a task with `taskId` to `assignee` or the active user. Retu sidebar_label: "Assign a task" hide_title: true hide_table_of_contents: true -api: eJztWVlvGzkS/isFvkyCbUvOTHYxEPaA4ig7ymEbsrwBxjFiqlmSOGaTHZItRRD03xdFsltnbDk7+xY/tcW6u46P1Uvm+cSxzg0bcnfPbjMm0OVWll4azTqs65ycaODgubuHufRTuKPHvrgDb+COh3PEOzAW/BSB517OECqHtgUD9JXVLhwQV4tlzJRoOUnvC9ZhkT/ozljJLS/QoyWDlkzzAlmHRXUsY5IMKrmfsl0rh1OE/msw4y1NFr9U0qJgHW8rzJjLp1hw1lkyvyhJsvNW6glbrW4jMTr/yogFUWzL/zhFDZWTegKD3tUQupf9GIu3H4fAKz9F7WUevAJv7lHD2Chl5sSQBMPIiAWsPYSCL2AUAiXI2Nxoj9qTbl6WKklr/+HIgOW+7Wb0B+aegmYpol6iC7zpfex7uRuzDZ948CMYnsWXmKSs7QXp4PxiCCawcwVzYs+5UihASIu5VwsYW1MEAd3LfuuTptfiFs5jAXOpFGjjyWU+UkjJI9Bj7rcVNhK2LbI4Nha/ZZtGFI4kjvCTxq8UPUnmlNw5FCA1+Kl0ILXzXOfYYquMcXo/FzO0VgqMWV6k+Ke4jYxRyPXhwN1RSt016QZ+yj3FiCuLXCxqK0X9mpv/+YRL3YILcmouHTYiPumiciE+Y2mdh0qvebQAo9WCaPWuqGDfmFfKxzxfrXYNHqQMDAFzIeMoWFHOhgtmHVtjIa+sRe1jJbOMeekVhYVqNcYryWWrFem06EqjXUzDn09P96voQoOr8hydAxsaw5+a+VI8nvOUkJWWXyoEKahmxxLtdttYZanvHCOLKPfY6eE1jqWWdZd7TNS1QwsUV2piTQW8uvxwDqIRFGSX1lD8zr/LwsQcBOUWQ5hfc39sr5jzdSOHwI8CnlkkFQKo1864oowxY7gjb1q1kqEs8A7GEpV4HrWbolT4P+mPEh61oFG0Z8PxnTJkjUNLatpSkPT51IRqr0vRm/0cuPJH+RaaJJHujy8uLrRa1OMLdVXQoD4b9LrD3muWsbOLD5fve+m5e37Wex8e33T79HC7ytjY2OIdLh63YoBjtKhz3HQFiD34Qw/HZPKemDiVOQgslVmgiCKhH12lfyiONBhqiiw261Tci3BcKdWY8R+0TsbWkGyR2uME7ePGzCLrn2ZRNIj7aMPfXpKJ0r0xtugVIxQCxRHjpO/WijGx0X9RKb2GfyXjLEbLAu1DYUqFvm5CT0+BJGKj/zxcaHsqCSBuVFs676cR/P0G1UMc5COlv6Nxxx6Pmmt/TEpTfUZqSmbunMllaH0BAG5VvajwuH5GMkWFIKjsxwk513Xf5BSdnnhZYEx9AizX5fEKIsdJVT5FTc61kPTLv62pSrehiVvLFwcVNTwwCUx7qqTHwh3C3Rv6aAY+VR015SdpkzQNCOZxv91CmjDWTfbtxavPHy8G73oDlrHfe71Xvc/XV73B52H36l3orKWVxkp/4LIwDKM2nsZW08z3FtDhVE6mGG2ecVVFCLjxY83cgm7EQ4SXA/4jV39HHOFapAvYbLcRFlLLgjw5zVjBv8bnF6enG1jxr6cUkU1UN0gILgG6l4cwXFcDWmvCfaAGcfEu0AyN1D3TRfAZPct4nCZXHHfPW38f2fY/HxAYbpx8H1NngF9zLOPNIecOI/0372IB8BKGvvsG6Id/QIDzD6DR0pqRwuIvT0Wl5GrljhhWXQ3pKN4lLJYWHWofx8Nvw+ElRGGQG9GAhRi7Gnu34I2xgF855XkGL09PQWpBPqADDj+94gISav8pshLRy22ic+Phjam0aEgods6A0bsj75efqWcU6ByfHNGVuhAPooelNTMpgs6RlTiGDeJt9wK5ycONRIROW0+Bx3X2YnLVU+P6miC2saCMua9KeIatSSujBFVmAskTRzNioziCjKYqfnlKVVCLAmHQ6Z88TPksFnuJtpDOxRStL2JcGxrykSUgljT/f6Tlj7R8PC1fflezbkBMs9VL7XtMof6ReT8y7+HMC976qRFxNZtPwxrXT1mHtWcv2pRUrr2MubVqx07HMubQzuo1b2UV67BlTKBVp91eTo3zq86yNNavWMZm3ErCQCFr6CxmesIxTJmcq/DzIbRIB5tLEFrdRu3xXmLsjrhfT389PSiJSL8hZZ38azlT78vDl/1AfFBS2EQ7zKuILG+WLDfmXiLr3NxmbITcoj25p7vTze0m6RWJjPGpGdZAupR029q15CzQnYx4AEfbsEm6CDf5jEuV0CdcoRqffOCaT1BAripHW2zK/7SmJ2T8vn81PLnqXV31L87rhX0yaLVtf2NeClMISrgmByJWU7+pi+vtx2FIQeo3g/WuvhdLe3v1vU79b255w6aULBybYMwGDFbS+WbNv/8Gawpa/0AApifenFQuvsqNFkkz3PJSCrWA5uIBI1q500U23U+p3JXREycFptFPNUMFGJB+3YJ5HvI0FgsFzXXa7fl83sp5UWnBadVFQVYyR8Lwneb7yfv0S7bDLEzuGm5pwv9tW9+520mQa5PUWb10YbMXsWycL7je0LL1oWg3asv1FPk/fFFKmeTxq2+XiktNFgZfl6kX3ZDZcSvnWMY6zSel1JBus9RXbthySSVxbdVqRT9/qdAuYvnVbSjUpZCOngXrjLly+IC/zwbpM9RzOPyZ6qD5dfHqRWiAqqL/WMZC8dSfxFZ0EZ0iF2iDUfHwLKo+GZKINfPebn2V1RzdnK5TD9LebvT5y+7w7Deq0PStrDCCmCyf09aSz6Ol8UtR6EnhtyVTXE+qMBdZFEp//wXXQund +api: eJztWVlvGzkS/isFvkyCbUvOTHYxEPaA4ig7ymEbsrwBxjFiqlmSOGaTHZItRRD03xdFsltnbDk7+xY/tUXW2XV8Vb1knk8c69ywIXf37DZjAl1uZeml0azDus7JiQYOnrt7mEs/hTt67Is78AbueDhHvANjwU8ReO7lDKFyaFswQF9Z7cIBUbVYxkyJlhP3vmAdFumD7IyV3PICPVpSaMk0L5B1WBTHMiZJoZL7KdvVcjhF6L8GM96SZPFLJS0K1vG2woy5fIoFZ50l84uSODtvpZ6w1eo2XkbnXxmxoBvb/D9OUUPlpJ7AoHc1hO5lP/ri7cch8MpPUXuZB6vAm3vUMDZKmTkRJMYwMmIBawuh4AsYBUcJUjY32qP2JJuXpUrc2n84UmC5r7sZ/YG5J6dZ8qiX6AJteh/7Vu76bMMmHuwIimfxJSYua31BOji/GIIJ5FzBnMhzrhQKENJi7tUCxtYUgUH3st/6pOm1uIXzWMBcKgXaeDKZjxRS8Aj0mPttgQ2HbY0sjo3Fb+mmEYUjjiP8pPEreU+SOiV3DgVIDX4qHUjtPNc5ttgqY5zez8UMrZUCY5QXyf/JbyNjFHJ92HF3FFJ3TbiBn3JPPuLKIheLWktRv+bmfz7hUrfggoyaS4cNi0+6qFzwz1ha56HSaxotwGi1oLt6l1XQb8wr5WOcr1a7Cg9SBAaHuRBx5KzIZ8MEs/atsZBX1qL2MZNZxrz0itxCuRr9lfiy1YpkWnSl0S6G4c+np/tZdKHBVXmOzoENheFPjXwpHo95CshKyy8VghSUs2OJdrtsrLJUd47hRTf3yOnhNY6llnWVe4zVtUMb30H/9ToDXl1+OAfRMAq8S2vIf+ffpWEiDoxyi8HNr7k/tlbM+bqQQ6BHAc8skggBVGtnXFHEmDHcUZS0aiFDWeAdjCUq8TxKN0Wp8H+SHzk8qkEjaE+H4ytliBqHlsS0pSDu86kJ2V6nojf7MXDlj7ItFEm6ut++uLjQalG3L9RVQY36bNDrDnuvWcbOLj5cvu+l5+75We99eHzT7dPD7SpjY2OLd7h4XIsBjtGiznHTFCDyYA89HBPJe2xiV+YgsFRmgSKyhH40lf4hP1JjqG9ksVin5F6E40qpRo3/oHUyloaki9QeJ2gfV2YWSf80jaJC3Ecd/vaSVJTujbFFrxihECiOaCd9txaMiYz+i0LpNfwrKWcxahbuPuSmlOjrIvT0EEgsNurPw4m2J5IA4ka2pfN+asHfr1DdxEE+kvo7Enf08ai59seENOVnvE3BzJ0zuQylLwDArawXFR5Xz4inqBAEpf04Iec675uYotMTLwuMoU+A5bo8XkCkOKnKp4jJuRaSfvm3NVXpNiRxa/nioKCGBiaBaE+U9Fi4Q7h7Qx71wKeKo6L8JGmSugHBPO63S0jjxrrIvr149fnjxeBdb8Ay9nuv96r3+fqqN/g87F69C5W1tNJY6Q8MC8PQauNpLDVV3d9bQIdTOZli1HnGVRUh4MaPNXELuhEPEV4O+I9M/R0xjg2RpQvYbLcQFlLLgiw5zVjBv8bnF6enG1jxr6fkkU1UN0gILgG6l4cwXFcDWmvCPFCDuDgLNE0jVc80CD6jZxmPU+eK7e556+8j2/7nAwzDxMn3MXUG+DXHMk4OOXcY739zFguAlzD03TdAP/wDApx/AI2W1owUFn95KiolUyt3RLPqakhHcZawWFp0qH1sD78Nh5cQmUFuRAMWou9q7N2CN8YCfuUU5xm8PD0FqQXZgA44/PSKC0io/adISpdebl86Nx7emEqL5gr5zhkwerfl/fIz1YwCneOTI6pSF+JBtLC0ZiZFkDmyEsewcXnbvHDd5GEiEaHS1l3gcZm9GFx117i+JohtLChj7qsSnmFr0sooQJWZQLLEUY/YSI7Ao8mKX56SFSFPhUGnf/Iw5bOY7CXaQjoXQ7QexLg21ORTapt1//8Rlj/C8vGwfPldxboBMc1WL5XvMbn6R+T9iLyHIy9Y66dGxNVsPg1rXD9lHdaevWgHhNJexthatWOlYxlzaGf1mreyinXYMgbQqtNuL6fG+VVnWRrrVyxjM24lYaAQNXQWIz3hGKZMzlX4+RBapIPNJQitbqP0OJcYu8Pu19NfTw9yoqvf4LIO/jWfqffl4WE/XD7IKWyiHeZVRJY3S5Ybcy+RdW5uMzZCbtGe3NPsdHO7efWKWEb/1ARrIF1KmrZ2NTkL905GPICjbdgkXYSbfMalSugTrlCNTz5wzScoIFeVoy02xX9a0xMyft+/Gp5c9a6u+hfn9cI+KbTa1r9RL7kpOCWMyeESq2+/qZPr7cdhCEGqN4P1rr4XU3t79b0O/W9uecOmlDQcm6DMBgxW0vlmzb//BusbtP6BAExPvDmpXHyVGyWSerjlpRRqAc3gASNaudMgm+ZTSndl9MRJsYnqKQED0q9LMM9DnMZkIae5Trs9n89bOS8qLTitusjJSuZIGL7TfD95n37JdoiFyV1DLU34v23rmbudGLk2cZ3VSxc2exHTxvmC6w0pWx+Kdr22XHeR/8MXpRRJHr/6dqm41KRhsHWZatENqR23co5lrNN8UkoF6TZLdeWGLZeUEtdWrVb085cK7SKmX12GQl4K6ehZsM6YK4cP2PtskD5DPYfDn6kOql8nr16EAqgq+o9lLCRP/UlsRYPoFLlAG5SKh2dR9MmQWKyJ93brq6ym6OY0Tj1493ajzl92h2e/UYamb2WFEURk+Zy2lnweNY1fikJNCr8tmeJ6UoW+yCJT+vsvLsfqfQ== sidebar_class_name: "patch api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a task

+ Assign a task with `taskId` to `assignee` or the active user. Returns the task. -## Request + -

Path Parameters

Body

+ -When using REST API with JWT authentication token following request body parameters may be used. + -
- -On success returned. - -
Schema
- -An error is returned when the task is not active (not in the CREATED state).
An error is returned when task was already assigned, except the case when JWT authentication token used and `allowOverrideAssignment = true`. - -
Schema
- -An error is returned when user doesn't have the permission to assign another user to this task. - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+An error is returned when task was already assigned, except the case when JWT authentication token used and `allowOverrideAssignment = true`.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "403": { + description: + "An error is returned when user doesn't have the permission to assign another user to this task.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +> diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx index 1f4e3b31ea8..cd8e577c555 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx @@ -5,55 +5,297 @@ description: "Complete a task with `taskId` and optional `variables`. Returns th sidebar_label: "Complete a task" hide_title: true hide_table_of_contents: true -api: eJztWetPIzkS/1dK/jKga5LM7uxpFa3uFCDcZh6AkrAjLUKD064kXrrtHtudTC7K/74q2915cRC4+Th8odMu18u/erh6yRyfWNa+ZUNuH9hdwgTa1MjCSa1Ym53pvMjQIXBw3D7AXLop3NNjT9wDVwK0J+UZ3M+4kXyUob1vQB9daZQFN0W/scESpgs0nIh7grVZGjl7uQkruOE5OjSkzJIpniNrsyCIJUySMgV3U7ar4XCK0DsHPd6SZfBrKQ0K1namxITZdIo5Z+0lc4uCOFtnpJqw1eouEKN1p1osiCLVyqFy9MiLIpOpV7r5lyV5y31WevQXpo5sMGSik2hptXbHBik3hi/2TPijogSnoSwEdwjaABeCXni/i5LUrU2E6D3anzDpMLfPKxR8uuuBx/xJlJVHKzMabJWwGc/KA3l40j0m8HmKCmyBqRwvKouq1bAnAeneWEhNmUqekQdyLpXjUkGqlZXWoUoXAYnvB1eXYZeFI4tG8kz+1x8XjLXxzIOnvkFwigVbplPgFjJp3bFHMCpbGgQ35Q6CQRYMklDgBbnQSO4wWxDLnDuHosFWq4Q56TLcOL6eKkp3PrxiK1rd9kg/QCxqEZSf/T/HTiCvFKAQqgI1CiIdVoRsW2hlw/n/1GrRv23FrhR5JEVLNlPMknXJ94oBKQ4DS6nk1xJBClROjiWa7XheJa8Eb72dHs5xLJWsEtBzrG4sGiDPUnYZG517hqfXny5B1Iw878Jo8t/lqzSMmz2j1KB38zl3B3DykTTndgMdtB8FHBkkEQIoCc54hsqRuHuyplEJGcoc72EsMRPHQXqNrVfLjxh8ToNa0J4O3Fo5UXigH0uLhsQ0pSDu86kGaSHyCEG0i4GBO8g24m6dD8jdusLFlcoWVV1BVeZUPc/63c6we84Sdnb16fpjNz53Ls+6H/3jRadHD3erhFEa+YCL57Xo4xgNqhQ3TfFZyNtDD4cgeY9NKJccBBaZXqAILKEXTKUf5EelXU2RgJtKCzG4F365zLJajT/QWBlSQ9RFKocTNM8rMwtbv5tGQSHugg7/fEcqSnuhTd7NRygEbnpspHWGXO1p2bNrwRi3xYoirT+Gf0flDAbNPO1TboqBvk5CL4dAZLGRf54OtD2R1LNtRFtc7ynruErx9QrJyAHkM6G/I3FHH4eKK3cIpCk+AzWBmVurU+lTny+sW1EvSjwsnxFPUSL4Olx1D1Xc15ii1RMncwzQzzI9vykOFxB2nJTFS8SkXAlJb/5jdFk830+SoHoPTPymPVG7TWPdEG/Ioxr4UnGUlF8kTVI1yFE57rZTSO3GKsm+vzr98vmq/6HbZwn7s9s97X65GXT7X4adwQefWQsjtZFusd/mDH2pDash1dT1vQG0OJWTKZrYjlLn6rZfVpsb0An9EPWrWoWuEP5EHOGapfXd2W4izKWSOVnSSljOv4Xnt60W+XPMy8yx9i+tzcaSWPVjBxcbuneP9XAdBWiMNpRvqiYO5lSe66IRsydPnZwhHNGzDMuxcoVyd9z4bWSa/3qUoVxXQl/2iUeacUmxflQV3WMY4VgbPJBPpdZOyU5LYyhvEJae6EYLo0cZ5v94aVdKppb2gGLVURCXwu3AYGHQonKhPPw+HF5DYAapFnWzEGyueu8GXGgD+I0TzhN412qBVIJsQAsc3pxyAbFrfxO2EtG7baJL7eBCl0rUJHRzsRrCTWCz5P38E+WMHK3lkwOyUifeeYKFhdEzKbzMkZE4hg3ibfM8uU79UQmfaasq8LzMbgBFVTVubqjF1gYyrR/KAo6wMWkkBNBMTyBaYo+3b12eRx0VP+9HhY/GqQcqFGhyaX2f4TTwcN+pUXg0wGx8knPFJyh8UB//QN0P1D2PunevysV1j1LP0WIaHJOrfyDvB/KeRp631k21CCPRdOrHp27K2qw5e9skUNnmMmBr1awu5SxhFs2sGrCWJmNttgwQWrWbzeVUW7dqLwtt3Iol2+NLWgtYj40Ky3TKM//6sXaQFjanHJ3rHgTp4eKhzQ67X1u/th7lRKT/g8sa/ms+U+eKx2/znvhRTn4GbDEtQ+t4SxNg/SCRtW/vEjZCbtCcPNDl6PZuk3RALIN/qg3rTrmQdJ3aH6cT3cmIWxTASzeleVeIbkoCvp/kMy6z2F6Cr0yfYmVKs9LShJwiIA7IqfX92BsMTwbdwaB3dVmNyqNCq239a/Wim7xT/D3YE7GK+qIKr/efhx6ElHH66yl5NwT3zpR7PbavwyDOi+t2/86HzVh7VTa6XBrGQr87GNLJ7J9fRUHTHaARzOLE6ZPShoPcSJFU3Q0vpMgWUN8rYFRaqajix+snhXum1cRKEe4rPi/TNTY08lUK5qlHaQgVcpltN5vz+byR8rxUgtMki1ycyRSpRa9n7OxjfJPsbBY6tfVuqf3vpqmu1M3IyDb9rL2aqbDZ2xA01uVcbUjZ+Tiz67eNLxnf9TtOxJDDb65ZZFwq0s7buYx56JZUDgM3yxLWrj/j1MnoLok55ZYtlxQONyZbrej11xLNIoRepYiHlpCWngVrj3lm8Qlbj/rx488xPP5x6FEDqsBViw3csoT5wKk+RHkAT5ELNF6psHgWRJ8MicV6897gfJVUOzppioV7kvZuI8tfd4Znv1N0xi9UuRa0yfA5jST5PGgaTtDnI/9uyTKuJqWviiwwpb+/AePCssI= +api: eJztWetPIzkS/1dK/jKga5LM7uxpFa3uFCDcZh6AkrAjLUKD064kXrrtHtudTC7K/74q2915cRC4+Th8odMu18v1+Ll6yRyfWNa+ZUNuH9hdwgTa1MjCSa1Ym53pvMjQIXBw3D7AXLop3NNjT9wDVwK0J+UZ3M+4kXyUob1vQB9daZQFN0W/scESpgs0nIh7grVZGjl7uQkruOE5OjSkzJIpniNrsyCIJUySMgV3U7ar4XCK0DsHPd6SZfBrKQ0K1namxITZdIo5Z+0lc4uCOFtnpJqw1eouEKN1p1osiCLVyqFy9MiLIpOpV7r5lyV5y31WevQXpo5sMGSik2hptXbHBik3hi/2TPijogSnoSwEdwjaABeCXni/i5LUrU2E6D3anzDpMLfPKxR8uuuBx/xJlJVHKzMabJWwGc/KA3l40j0m8HmKCmyBqRwvKouq1bAnAeneWEhNmUqekQdyLpXjUkGqlZXWoUoXIRLfD64uwy4LRxaN5Jn8rz8uGGvjmQdPfYPgFAu2TKfALWTSumMfwahsaRDclDsIBlkwSEKBF+RCI7nDbEEsc+4cigZbrRLmpMtw4/h6qijd+fCKrWh12yP9EGJRi6D87P85dgrySgFKoSpRoyDSYUWRbQutbDj/n1ot+ret2JUij6RoyWbKWbIu+V45IMVhwVIq+bVEkAKVk2OJZjufV8krg7feTg/nOJZKVgXoOVY3Fk1weu8cxkbnnuHp9adLEDUjz7swmvx3+SoN42bPKDXo3XzO3QGcfCbNud2IDtqPAo4MkggBVARnPEPlSNw9xUmjEjKUOd7DWGImjoP0OrZeLT/G4HMa1IL2dODWyonCA/1YWjQkpikFcZ9PNUgLkUdIot0YGLiDbCPu1vmE3O0rXFypbFH1FVRlTt3zrN/tDLvnLGFnV5+uP3bjc+fyrPvRP150evRwt0oYlZEPuHheiz6O0aBKcdMUX4W8PfRwSCTvsQntkoPAItMLFIEl9IKp9IP8qLSrKRJwU2khJvfCL5dZVqvxBxorQ2mIukjlcILmeWVmYet30ygoxF3Q4Z/vSEVpL7TJu/kIhcBNj420zpCrPS17di0Y47bYUaT1x/DvqJzBoJmnfcpNMdHXRejlIRBZbNSfpxNtTyRhto1si+s9ZR1XKb5eIRk5gHwm9Xck7ujjUHHlDglpys9ATcHMrdWp9KXPN9atrBclHlbPiKcoEXwfrtBDlfd1TNHqiZM5htDPMj2/KQ4XEHaclMVLxKRcCUlv/mN0WTyPJ0lQvQcmftOeqF3QWAPiDXnUA18qjoryi6RJ6gY5Ksfddgmp3VgV2fdXp18+X/U/dPssYX92u6fdLzeDbv/LsDP44CtrYaQ20i32Yc7Qt9qwGkpNWfX3BtDiVE6maCIcJeTqtl9WmxvQCXiI8KpWARXCn4gjXLO0Hp3tFsJcKpmTJa2E5fxbeH7bapE/x7zMHGv/0toElpQy/YjgIqB79xiG6yhAY7ShelOBOJhTe66bRqyePHVyhnBEzzIsx84V2t1x47eRaf7rUYZy3Ql92yceacYl5fpR1XSPYYRjbfBAPpVaOy07LY2hukEOfQKNFkaPMsz/8VJUSqaW9oBm1VEQl8LtwGBh0KJyoT38PhxeQ2AGqRY1WAg2V9i7ARfaAH7jFOcJvGu1QCpBNqAFDm9OuYCI2t+ErUT0bpvoUju40KUSNQndXKyGcBPYbHk//0Q1I0dr+eSAqtSJd55gYWH0TAovc2QkjmGDeNs8T65Tf1TCV9qqCzwvsxuCouoaNzcEsbWBTOuHsoAjbEwaCQVopicQLbHH27cuz6POip/3s8ID+KkPVCjQ5NJ6nOE08HDfqaPwaIDZ+CTnik9Q+KQ+/hF1P6Lu+ah796paXGOUeo4Wy+CYXP0j8n5E3tOR5611Uy3CSDSd+vGpm7I2a87eNj0AaS5DbK2a1aWcJcyimVUD1tJkrM2WIYRW7WZzOdXWrdrLQhu3Ysn2+JLWQqxHoMIynfLMv34MDtLC5pSjc92DID1cPLTZYfdr69fWo5yI9H9wWYf/ms/UueLx27wnfpSTnwFbTMsAHW9pAqwfJLL27V3CRsgNmpMHuhzd3m2SDohl8E+1YY2UC0nXqf1xOtGdjLhFAbx0U5p3heymIuDxJJ9xmUV4Cb4zfYqdKc1KSxNyyoA4ICfo+7E3GJ4MuoNB7+qyGpVHhVbb+tfqRTd5p/h7sCdiFfVFlV7vPw99EFLF6a+n5N2Q3DtT7vXYvk6DOC+u4f6dT5ux9qpsoFwaxkK/OxjSyeyfX0VB0x2gEczixOmT0oaD3CiR1N0NL6TIFlDfK2BUWqmo48frJ6V7ptXESrEJ2ikBPZCvSjBPfZSGVCGX2XazOZ/PGynPSyU4TbLIxZlMkSB6PWNnH+ObZGez0Kmtd0vtfzdNdaVuRka26Wft1UyFzd6GpLEu52pDys7HmV2/bXzJ+K7fcWIMOfzmmkXGpSLtvJ3LWIduSeUwcLMsYe36M05djO6SWFNu2XJJ6XBjstWKXn8t0SxC6lWK+NAS0tKzYO0xzyw+YetRP378OYbHPw49akCVuGqxEbcsYT5xqg9RPoCnyAUar1RYPAuiT4bEYr15b3C+SqodnTTFwj1Je7dR5a87w7PfKTvjF6pcC9pk+JxGknweNA0n6OuRf7dkGVeT0ndFFpjS398lZ7Ni sidebar_class_name: "patch api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Complete a task

+ Complete a task with `taskId` and optional `variables`. Returns the task. -## Request + -

Path Parameters

Body

    variables object[]
    + -Variables to update or add to task during the task completion + -
  • Array [
  • ]
- -On success returned. - -
Schema
- -An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before.
An error is returned if the task is not assigned to the current user. - -
Schema
- -User has no permission to access the task (Self-managed only). - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+An error is returned if the task was not claimed (assigned) before.
An error is returned if the task is not assigned to the current user.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "403": { + description: + "User has no permission to access the task (Self-managed only).", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +> diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx index 53e956d2823..3a76e41c125 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx @@ -7,38 +7,141 @@ hide_title: true hide_table_of_contents: true api: eJzdV1FvGzcM/iuEXppgFzvtgqHwW7YkndeuLWJnAxYEiHyifWpk6SLxnBrG/feB0p3ti53W6+OeDJ8okvr08SO1EiRnQQxuxZXzc3GXCYUh97ok7awYiHdIQAXC1Pk5KCSpTYDJEu75w1Ddg7QK7kvvcgzhAqfaat75Hpf34PGx0h4VPFbol1BKL+c9GBcI9wv0QTt7v70EOoCLcaWJbnWAKqACZ82SEwCFpXFLVDGbAEd6CjgvaZmBJvBIXuMCQ8y30LMCA0ET6LgnMuFK9JL9D5UYiBlSPHImYnQk9IzDSlg5RzEQ6YAiE5pxKCUV4jk4fJThBbjpGiIO0x5bDMhXmImQFziXYrAStCzZcyCv7UzUdbYOtg/ANnSEaCf2NU7Ro80RyMXwjQtQax8/mkyD2bfj89kbww4A8Jc0+sU766Y0lSbsy0lbwhl6kcVLkJQ+/XIm6vqO94fS2YCBd7w5PeWfbm6fLIQqj2h4pMpbVBw4d5bQEtvLsjQ6j2Tofwm8abWbhpt8wZyYIJ6pQzqF1GoXvn3oVFY/VghaoSU91ehbnHA+QaUaSOBJU6EtOLu+wp6os/2M+G7cDit2GQFHHvmSFfAdLKRBS5zVPVdCbyck1/dUo1HHMSXSZPCws0fTbmHUL5Nvn4eITXNjcXPLyn00eZmaMX1WElsZA9rGhHIZYnLSdu8ig6dCG0xqUnoMaCnJSYfFr8LaPV8cFegh5Gil1y4y/DlrM0FopaXhgcxJ1iwtMgSXa0moIk+6cOpwgQYJt71OnDMo7Y7boVXMdwzwVGDMeOdYjJJKDsF5sI7AWfgHcYKs2jpswIyFy21A4VRWhrLvIdtjgWkJFFvNdVPFoq556ez0bLeOzy2g985zyLaQOX+7aUlrVA5pSEwDRzB1lf2WIJTeTQzOf/qvwhBIUhUOIOg5EycuARVyh2y/j8efITmD3Kl1HSUsWvnrwZXzgF/lvDSYwdnpKej1JUt49atUcI2PFQZ6lbay0VnX6KMjuGI41iYMX3CQusc2kX9+w5ybYwhydoAKnENaSCcsvVtoFWNOvMYpbBl3jxfNXZ5X3rNqM81tIGnzA2JeJrI09nBzM7yIPcg491CVcIS9WS9S1bgZNCcJx11uRh+RlPG0VLhmWIiDAhViIPqL1/3YzfqrRLpaZCKgX7QTROWNGIhV4k096PdXhQtUD1al88TGC+m1nJhEG15L3I+1JAbCuFya+HmfOvACi3iL2/nnIaToqXE4/8zd29O3p3s9sekLXjac3/gpiMq9fpLxXk+xYwfMK69pGcHJnXvQKAa3d5mYoPToTx64td3ebZuO2GXCp92wvn1Z6jQedTP5LdqdTCTPjLKigvtuKuk4WvJEIhdSG0aepW2EZnryp7RyhgpyUwUeAZn2zRw0Ph+9/zAcjU9Gl6PR8NPHdiBqEqq7+a/Ta2CKoERJjkaitb5qa+qPv8eRedpOXdzeMHAsw4PRgeD6cjRmNHcxby00F5RHqZYn5E6qkMDf0jIeA7wstTJL0CwUc+74kypoy5NBI5Ncl8bZWdAKeeT2QDI8BK6UJP+NVso8MivRm48ZBv3+09NTL5fzyirZy92cYTE6R5b2wXqk/NB8yZ5tVi4P693axf993w4x/cZR6HcGALF4nYgeaC7tVhR+rMjYF55Dttpo/f/qSdNQjvAr9UsjtWVgIsSrRq1uGa2k5EFkYtA8a+6yRnduxWrFJXPjTV3z5zTuc6UqHbhUNoP6i5AeXTe4HMOB75K9icc6eukttJCm4i2CXyqHp/bj75RvpLh5IW2yutvI+o+jt/9FuTeTVgxtB5w2w+aa67s6EwVKhT4mlRbP8xxL2tq28xzi06yb37tLFqp/Ab96n4Y= sidebar_class_name: "get api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get a form

+ - + Get the form details by `formId` and `processDefinitionKey` required query param. The `version` query param is optional and is used only for deployed forms (if empty, it retrieves the highest version). -## Request + -

Path Parameters

Query Parameters

+ -On success returned. + -
Schema
- -An error is returned when the form with the `formId` and `processDefinitionKey` is not found. - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx index c9ba57ae4b2..93426becf84 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx @@ -5,44 +5,231 @@ description: "Get one task by id. Returns task or error when task does not exist sidebar_label: "Get a task" hide_title: true hide_table_of_contents: true -api: eJztWN1vGjkQ/1csv1yq2wBtc6eKlxNJSY82TSIgV6lR1Jj1wLrx2hvbC0GI//00tneBwCWk18c+Yez5+M3sfNkL6tjE0vY1HTJ7R28SysGmRhROaEXb9AM4ohUQx+wdGc2J4A3SB1caZcOeNgSM0YbMMlBhi2uwRGlH4EFY16AJ1QUYhhJ7nLbpBBwqO573OE1owQzLwYFBFAuqWA60TVGQPxaIomAuo4+hDTMgvfdEj4nLAkBUZeC+FAY4bTtTQkJtmkHOaHtB3bxAydYZoSZ0ubxBYltoZcHi+ZtWC382lVwoYss0BWuJ8WYDRy2pVg6UQ3pWFFKk3rrmd4tMi22levQdUofWGvSFE0Gl4NvAdplZKnFfAhEclBNjAWbT6mUS3baPLKTcYsfFexgLJaqv9JyoKwuG4GfEbzA2OvcCjy8/nxNeC/KyC6PRf+c/hDAye0GpAe/m98ztIekLxuOM2dpQ4vmBkwMDqIITDJUpk6AcqrtFaxqVkqHI4ZaMBUj+KmjXeSHhf+kPEp5FUCvawsCsFRMFe/qxtGBQTVNwlD7LNBGWRBmcOL0dAwO3l20o3SLpdvYxfqHkvMo+UGWOxeWk3+0Mu+9pQk8uPl+edeO6c37SPfPL004PFzfLhI61yT/B/HkUfRiDAZXCuikE2b09uNgnkrfEhKLCCIdC6jnwIJL0gqn4B/2IBa6iSIjLhCUxuef+uJSyhvEPGCtCaYhYhHIwAfM8mGlg/WmIAiDmAoY/jxCisKfa5N18BJzDusdGWktgagtlz64UQ2TDf0Epfoa/IjgDAZmnfcpNMdFXRejlIRBFrNWfpxNtS2WPb2RbPO8p65hK4ccBiSiBiGdS/5HGR3gcKKbcPiGN+RmoMZiZtToVvvTNhMs2s56XsF89Q5m8BMIx7cO3XuV9HVN4euhEDiH0pdSzq2J/BYHjsCxeoiZligvc+WB0Wdg1TcwYNt+pqOYhE8+0pUo4yO2usWFNH/bAl6rDovwibQK7QQ7KMbdZQmo3VkX248Xxty8X/U/dPk3o1273uPvtatDtfxt2Bp98ZS2M0Ea4+faYM/StNpyGUlP39wbBw0xMMgiYp0yW4FdrmxVzg3TCPDSSQLSSc2/qV4ARrERaNHmrEOZCiRwtaSU0Zw9h/brVQn+OWSkdbf/RQo844SSyoqh+nODocolHR62328Z5vRnzZagAkwvrK6rThIXJru4dBwOQ48OcKTYB7uG/emLaK4weSch/f+nUh52ztHs0g44i8Yi4jDlioDBgQbkA+e/h8JIEYSTVvG7GYR6vZtsGOcUZ/YFhHCXkqNUiQnG0ASxh5Ldjxkkf7kuw7rfAikRHm0Tn2pFTXSpekzDFidUEZ7zNlvL2DeZkDtayyR5Z3yHhIFhYGD0V3OscGQFjska8aZ4n12laGoMjOSZKrJrP6+x6CXVVvrrCEVYbIrW+KwtyAI1JIyFCEaknJFpisQavBZ+XUUfd0XbUdVREKlZXh3hJqsKtrsa34bpzW3XxMbr6V+T9irynI89b6zIdL9X+Mu0y2qbN6esmhpRtLkJkLWlCLZhpdcsujaRtughxs2w3m4tMW7dsLwptHBJPmRFYw32w4FkI8FiHqdQpk357V7fDg/VLXOeyR4L2MFdp80jcu9a71k5JSPofUlYxv5KTOVfsvqx44p2S/EOAhbQMnfF6QVOt7wTQ9vVNQkfADJjDO5z9rm/WSQcoMvinYlgNAoXAafExkhNPdzhiFjhhpcvwOh9SGjPft0s2ZULG7kl8O/oc21EqS4vPJBj28ZUEO/tZbzA8HHQHg97FefVeEgEtN/HX8KKbvFP8mO+JaEV9WuXUxy/DMIKosfbsa41XCutIvzsYoje3fV5R4IWT4K1wfuj0YWmD89dqGbZhwwrB5ZzUow4ZlVYobM1xIsa8lFpNrOBhhPIFFCfrMFtUtZKlPrJCeKOZtt1szmazRsryUnGGl2t0ixQp4NTQrh+czuJO8oiZ69TW3EL7/01TTfnNKMg2Ueq0uubR6esQ6NblTK1pwec05rE/dtliVet/0qNb/NgOHlyzkEwohOSNW8Q6cY04w8Xf0oS246PbTRIz/pouFhisV0Yul7h9X4KZh8SoCoTPGC4srjltj5m08IRpB/34PveK7H6/24m6Sis196VJlviPJtSHdfVWuMQRNwPGwXhQ4bCTplC4Nbat9zpM6rqMfuhiyP8LSZdGzQ== +api: eJztWN1vGjkQ/1csv1yq2wBtc6eKlxNpSI82TSIgV6lR1Jj1wLrx2hvbC0GI//00tneBwCWk18c+Yez5+M3sfNkL6tjE0vY1HTJ7R28SysGmRhROaEXb9AM4ohUQx+wdGc2J4A3SB1caZcOeNgSM0YbMMlBhi2uwRGlH4EFY16AJ1QUYhhJ7nLbpBBwqO573OE1owQzLwYFBFAuqWA60TVGQPxaIomAuo4+hDTMgvROix8RlASCqMnBfCgOctp0pIaE2zSBntL2gbl6gZOuMUBO6XN4gsS20smDx/E2rhT+bSi4UsWWagrXEeLOBo5ZUKwfKIT0rCilSb13zu0WmxbZSPfoOqUNrDfrCiaBS8G1gu8wslbgvgQgOyomxALNp9TKJbttHFlJusePiBMZCieorPSfqyoIJn7t3QsZG517g8eXnc8JrQV52YTT67/yHEEZmLyg14N18wtwekr5gPM6YrQ0lnh84OTCAKjjBUJkyCcqhulsMykalZChyuCVjAZK/Ctp1Xkj4X/qDhGcR1Iq2MDBrxUTBnn4sLRhU0xQcpc8yTYQlUQYnTm/HwMDtZRtKt0i6nX2MXyg5r7IPVJljcXnf73aG3ROa0PcXny/PunHdOX/fPfPL004PFzfLhI61yT/B/HkUfRiDAZXCuikE2b09uNgnkrfEhKLCCIdC6jnwIJL0gqn4B/2IBa6iSIjLhCUxuef+uJSyhvEPGCtCaYhYhHIwAfM8mGlg/WmIAiDmAoY/jxCisKfa5N18BJzDusdGWktgagtlz64UQ2TDf0Epfoa/IjgDAZmnfcpNMdFXRejlIRBFrNWfpxNtS2WPb2RbPO8p65hK4ccBiSiBiGdS/5HGR3gcKKbcPiGN+RmoMZiZtToVvvTNhMs2s56XsF89Q5m8BMIx7cO3XuV9HVN4euhEDiH0pdSzq2J/BYHjsCxeoiZligvc+WB0Wdg1TcwYNt+pqOYhE8+0pUo4yO2usWFNH/bAl6rDovwibQK7QQ7KMbdZQmo3VkX248Xxty8X/U/dPk3o1273uPvtatDtfxt2Bp98ZS2M0Ea4+faYM/StNpyGUlNW/b1B8DATkwwC5imTJfjV2mbF3CCdMA+NJBCt5Nyb+hVgBCuRFk3eKoS5UCJHS1oJzdlDWL9utdCfY1ZKR9t/tNAjTjiJrJgy/TjB0eUSj45ab7eN86NKxnwZKsDkwvqK6jRhYbKre8fBAOT4MGeKTYB7+K+emPYKo0cS8t9fOvVh5yztHs2go0g8Ii5jjhgoDFhQLkD+ezi8JEEYSTWvm3GYx6vZtkFOcUZ/YBhHCTlqtYhQHG0ASxj57Zhx0of7Eqz7LbAi0dEm0bl25FSXitckTHFiNcEZb7OlvH2DOZmDtWyyR9Z3SDgIFhZGTwX3OkdGwJisEW+a58l1mpbG4EiOiRKr5vM6u15CXZWvrnCE1YZIre/KghxAY9JIiFBE6gmJlliswWvB52XUUXe0HXUdFZGK1dUhXpKqcKur8W247txWXXyMrv4Veb8i7+nI89a6TMdLtb9Mu4y2aXP6uukLbXMRImtJE2rBTKtbdmkkbdNFiJtlu9lcZNq6ZXtRaOOQeMqMwBrugwXPQoDHOkylTpn027u6HR6sX+I6lz0StIe5SptH4t613rV2SkLS/5CyivmVnMy5YvdlxRPvlOQfAiykZeiM1wuaan0ngLavbxI6AmbAHN7h7Hd9s046QJHBPxXDahAoBE6Lj5G893SHI2aBE1a6DK/zIaUx8327ZFMmZOyexLejz7EdpbK0+EyCYR9fSbCzn/UGw8NBdzDoXZxX7yUR0HITfw0vusk7xY/5nohW1KdVTn38MgwjiBprz77WeKWwjvS7gyF6c9vnFQVeOAneCueHTh+WNjh/rZZhGzasEFzOST3qkFFphcLWHCdizEup1cQKvj5HYKb42aKqlSz1kRXCG8207WZzNps1UpaXijO8XKNbpEgBp4Z2/eB0FneSR8xcp7bmFtr/b5pqym9GQbaJUqfVNY9OX4dAty5nak0LPqcxj/2xyxarWv+THt3ix3bw4JqFZEIhJG/cItaJa8QZLv6WJrQdH91ukpjx13SxwGC9MnK5xO37Esw8JEZVIHzGcGFxzWl7zKSFJ0w76Mf3uVdk9/vdTtRVWqm5L02yxH80oT6sq7fCJY64GTAOxoMKh500hcKtsW2912FS12X0QxdD/l8Nj0dt sidebar_class_name: "get api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get a task

+ - + Get one task by id. Returns task or error when task does not exist. -## Request + -

Path Parameters

+ -On success returned. + -
Schema
- -User has no permission to access the task (Self-managed only). - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx index 72f7da281e4..85327be002a 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx @@ -7,45 +7,116 @@ hide_title: true hide_table_of_contents: true api: eJyVVttu2zgQ/ZUBX9piZcvt5qHQm7tJut522yJ2usAGBkpLI4sNTSrkyKkh6N8XQ0m+xE7XfbIlnjlz0Znh1ILk0ovkTnyVTsmFRi/mkcjQp06VpKwRiXiPBFQgrDsIZEhSaQ+Lze6dyoYiErZEJ9lskolELJF62nebSSYiUUonV0jo2GctjFyhSERPEiCKXZaSCvE0jlmBMLkEmx9Ew24dPlTKYSYSchVGwqcFrqRIakGbkj14csosRdPMGexLazx6Pn8zGvHPoaPPBnyVpug9OKTKGQzJpdYQGmK8LEut0pBp/N2zUX3s1C6+Y0qcteO6kGpdquw4sPNSFU3Ulewce0aeYlhLXZ1JkVdaQ8CfIsqczOn/833GX9Oc8hg4n3EZCVKkmeKSUb20vgb+JhKERhqanFneFs1Vlt7bVEnCDB4VFU/ybHZue483nYJE0/DxxejiWENjA+icdaB2IoLHAs1hK20dfts1wTe2MZYgt5X5mfJKZxcaV7/9qgI9Sar8Hk4ZwiW6ozqNDXRHQIUkcFg69GjIh5j/nM2+QEsGqc22X6xNvO+zIVxbB/hDrkqNEVyMRqBMxjmgBwkv3skMbvChQk8vWlMGXRyCPlmCay7HFiJNBt6CNVyg3LqVpDaT39+wGFbovVyeofMxtAdthqWza5UFnwunMIc98GF6AW7TtHKOx0PDk8uTNOkZPq9aZXR4uL2dXEJuHWhr76sSXuJwOYxAGdB2CV0m/tXwQIyBIygwZEuF7UZuGLNUiETE69dxLysf1zuFNSISHt26n8OV0yIRdaufJonjurCemqQurSMGb1k4Nz5rBZ/LSnPVtU2lDq9PdRof7A+j8ZcJtN5D2djHId3b0dvRSSaGPsOy0/6OpyAqT/K04JNM4YrwmFZO0SYUJ7X2XqFI7uaRWKB06Ab3yEfzfeiUKdv69AZbFchSfcDNUSR/BNxgIT1mICsq0FDX2jwBrNEbkGupdJgU1sAUdT74Wxq5xAxSXXm+SFn+3T06G08/fJxMZ4Pp1XQ6+fypv027gJrD+LfhdWUKReHnFiR69HXfW3/9MwsKVCa3wbxT4kz6e608wc3VdMbVPK55j1DcWA5lthmQHVS+Lf7eTAOy4GSpMr0BxQNjhYZgUXll+DouneVrmftTW7P0KkOoPI8n6e89d8y/iAvsZ6ZMg7JaeXOaPonjx8fHYSpXlcnkMLUrLotWKfI8T7YrycfuTfTEOLOp31orG55jhzk6NCnGHZGPw0WLzrf5r1+3Qve0kmbPC29Wcv+COyhbvZv7v7KDdV+V8AfFpZbKsO+QRd0NhjsOaL+pI5Hs7WDzqGvxO1HXrM5bp5uGXz9U6DZtJ2yD5hbJlOf/mUhyqT3+JI+XN92q9gqeX+dOZtD3ktmI7Q4jRCSClvdXyGbeRKJAmaELwbWAcZpiSXumRyscd/N2jr6/Yq3/B/Aq1EE= sidebar_class_name: "get api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get a variable

+ Get the variable details by variable id. -## Request + -

Path Parameters

+ -On success returned. + -
Schema
    draft object
    - -The draft value of the variable - -
- -An error is returned when the variable with the `variableId` is not found. - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx index 27e5668f33d..c13b8795bc9 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx @@ -7,53 +7,182 @@ hide_title: true hide_table_of_contents: true api: eJztWG1vIzcO/iuEvmzSm9hpbw8ojCBAusnivO1tFrF3F+giQGiJ9qjRSFNJY8dn+L8fKM34NW3T+xx/sS1RpEjxeURqJSLOghh8E2MMj+K+EIqC9LqO2lkxEONSB3A1eeQBqMlPna8CBJqTRwMoeTwM4GLi+5cXzlxeGH35BY1WGClALAkihkdAq0B5nEaYo9c4MRR6F32jk/w1GWJpetIhajs7lISp8xtV22XvSpKPedLS4kg9DKeAaaYbexPgwWJFD1BhlCUFQLs16izBpInJ0MMcTUMPoPR0Sj4UoCPoAAHnpHowtCAxELgpqKY2WmKkA/PAdkKRlBkMcXcPSTere6Q6tu70OXSTy4+345vBRX9yedHkUA7t3D3y7iKfREWxdApCIyWFoOdklrDQxoCbk194HQnQmD+MYw9urVkeRTc0k0rHSAq0TRuuXIjgSZLlr98bChEmTrW2JsR5EHSIHItxSZ6mzlMBZEPjCZauAW2laVTejSXeLPrljkltgVCWG+3RQYXaRmx3oG0kq0ht4xkobk9+XBJ8HoJyFMC6CLLxnmxk33SoDS6TkhTnnB+HLscSI6AnkJ6QPZ9rzCEmq2qn7eZcGnMpCrGBwFCJgeA0uGaNDJovnVJRiBo9VhTJM6RWgnNADARn7VCJQmiGVI2xFMc4Ixhec0Jt0lwUgqOjPSkxiL6hQgRZUoVisBJxWbPmEL22M7Fe32dhCvEnp5YsIR2HMPJPrHOOamf7vwW2tzpW5Sa/kYzsg2dno6bAs5uQ7Yii97g8cuHLNrgOmprxD84DKsUDu27pSFX4a9M5eoe+Phc5luxi1224J9aFSBnwMh0ZlIdK4GtJFkJNUk+XGYbb2byGueFNAOkbqdHsZbJ0NsHESoZOLOHD6PZjl5YngbxGo/+bqbWjOOmq2tAT5KAwOGUJGMDoEE8TjbYwSymcHQrgiY0C1hxCrzEyMzBVI+O6J9brQkQdDe0c1NDWTbwe34r17uwI57Q5yrucU1liPxvTQKidDfm0fjh/y1/7gb21HVeBp9h4y3spdnPzu/53YrBK+t+enx9ruLJA3jvPdNmpgAUfyuZq0ZkD+CqaE5zw75ZFHt7d3VyNb64fIESMdNpLt9SzKvUWebDAllUM6ooUnGAIemZJncKko7onSXW+KtJNkHb04esYsIkl2djCDaJ7JAtNIPVC250zrcUOOi3BsSb/f1nfj/ouI9TeTQxV//i7zMAhbXZhzJw9I3+ErisL7VTOWU+1p0A25vLg3+PxJ8jKQDq1wWCOU5djPXjvPNATMjoKeHt+DtqqdPMGQHjzEypos/VNXspCb/eFProI711j1UaE8RQcOMsBynjJnvzzB+aPii+u2QsY5KpFYvaw9m6uVbI58ZqmsCO8714SdzIdr0qUpW2IaOULbN7kRGrl4fPn4XViEePcY1PDCfVmvYKhYNwMWk/C6T4XJB0M74S/ZxD8AvwlZktwyxfdQ5fEUw71a+a9Zt5fZd6/Xsz8esole2PpqSbJdVsWSX4EWJTabIrTbf2bsnRbBL8m5GtC/mlCJm+50eJq3YV03ly0D0R//n2fsyn0V5nr1v35TvkfyM+72r/xRgzEKqfQetDvr0oX4nqwqp2Pa1HsV9Y8lyEwxcZw4I2TaMps/bha5Yndqvfq0xCy9RQ5trGv7sfzH8+f1cSif6Blm/5bPWWM9bN6svCzmlJ7Ekg2XsdlCo507lGTGHy7L8SE0JM/eySeut8VHbHKHJ9uwbYHqfXPdNyEvEtyZxMMpA6rIX7J4PYX56hNqt+dhRGZ6dl/0OKMFEjTBG7eGAFt7za+Gv38y3A0PhvdjEbD249dF9duaL2//8322jCloPD/LCQ66fcdvD58HackZMa52zZwNxncBw3YtqPcwKBtcDaN4H2CzdSlrbSJzU0qdw9wdzMa88kcn18noRmnnlAtz6I7a0I+yB2K5HrUY62VWYLmLVZclU6aoC0X+bV3XOwz3I2zs6AVpZI1UXDq+n8lmlBHwShTlmaocMjCoN9fLBY9iVVjFfakqzjERkuygbZNofilHSkOFisnw2a1dul/39OUPFlJ/VZR6KfmkO+J5P/8+wyaECu0O1a4Fzp8OjgM3k6n/fpa9vpa9vpaJoqOBCM9xX5tUFuGVwLqqr1JvzHmivQyxogabJ7Itji7L9pb8ZtYrZjQP3uzXvPw7w35Zb48OvFEjkoH/q3EYIom0J8A9eSufcs4hedf3p71oLt67HKHeUUhEvV3r3yJgktCRT5tKk++y6bPxqxiu/joZW5ddCuuJPf4O7L8UsK346Y0+XQ7GvON0j74VU6xmMcFvxziIu/NJe/THZrGVsKgnTWpkhPZJH/+B8suaiA= sidebar_class_name: "post api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Save draft variables

+ This operation performs several actions:
  1. Validates the task and draft variables.
  2. Deletes existing draft variables for the task.
  3. Checks for new draft variables. If a new variable's `name` matches an existing one but the `value` differs, it is saved. In case of duplicate draft variable names, the last variable's value is kept.
NOTE:
  • Invoking this method successively will overwrite all existing draft variables. Only draft variables submitted in the most recent request body will be persisted. Therefore, ensure you include all necessary variables in each request to maintain the intended variable set.
  • The UI does not currently display the values for draft variables that are created via this endpoint.
-## Request - -

Path Parameters

Body

required
    variables object[]
    - -Variables to update or add to the task. - -
  • Array [
  • ]
- -On success returned. - -
Schema
    any
- -An error is returned when the task is not active (not in the `CREATED` state).
An error is returned if the task was not claimed (assigned) before, except the case when JWT authentication token used.
An error is returned if the task is not assigned to the current user, except the case when JWT authentication token used. - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
- -An error is returned if an unexpected error occurs while persisting draft task variables. - -
Schema
+ + + + + + +An error is returned if the task was not claimed (assigned) before, except the case when JWT authentication token used.
An error is returned if the task is not assigned to the current user, except the case when JWT authentication token used.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "500": { + description: + "An error is returned if an unexpected error occurs while persisting draft task variables.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +> diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx index 2192123cf65..4d33714bd3f 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx @@ -7,49 +7,188 @@ hide_title: true hide_table_of_contents: true api: eJztWFtv2zYU/isHfGmLyZbb5aEwhhVpk2Beu7aI3Q5YYMC0eGSxoUiVpOx6hv/7cEjJlmMnTYG9bXlJYh6ey3duH71hni8cG96wCXe3bJowgS6zsvLSaDZkk0I6KNEXRoBFX1vtgIOSzoPJwXN3C0tuJZ8rdJAbC75AcBVmMpcoYEYSIzEDrgXMWsn3vMRZ/5e5TX8d5eGGxa81Og9zI9YgHWjjobJmKQUKMBZkFDvQ4GZQcctL9GhB6gM90gGWlV8nwJXqeMidM5nkHgWspC/CnRDESioFc2xiRNFnCTMVWk44jAQbMofcZgWh9LlVxxK284Aw3DDNS2RDFqNmCZOEYcV9wY6BRRhdBBAbH8gk+S8tCjb0tsaEuazAkrPhhvl1RZqdt1Iv2HY7jcLo/Gsj1iSRGe1Re/qTV5WSWfA9/eLI3uZYlZl/wcxTDJYi9RIdnR5A3BHn1vL1URhBiqLYY+wN5FIHBKXH0p3ynpDJVC1wj+X3LJ1rCAddY6CDeV9wD64wtRKUw0a12BeFq4x2eMqje0CIebzr96kckmSbxdatPtsmjKsVX7vrUE9XtVKfuaq7OufGKOT6OM5wrynEoDavQw2r+sjQq3A757XybJhz5ZCg9dIrsjA6hJht6fDQ2HXTLxEGSl0s81CQrpPU+Xrfj4foE6qtxV02x0FLo50Mb6lcYxoCwC8GA/p16M0HDa7OMnTuoA9/tLDb+nlkrqV4XKZrLb/WCFKg9jTd7Mm0/wuVs7xTKQ/oOFkVQYl0oeAmttYZzbtHVN6FCb2EMKssLiWugoYZEP686SXf6mtN2055viLD3bvfD+IcGvm7QTxxUWcf3slS+tjNTv4doxOW5/4xs+x/JB9E8mggEBQB3PsA2Tf7BYnFRm/7PrranUHtSTsQ4ggIE2GbsLPB2fEUONeA1tLS348BWBWou9u62d07ftFwhtzU+qGZUVkzV1j+9KNL0Xnu6+4skdrjAu2pLdUcxa1ksbLoUPtYD79NJh8hKoPMiB2+MeDdooIrYwG/8bJSmMDZYABSC4qBKAw8ec0FNLP1SbxKQmeHQu+NhyuCYydCHMwZMJoAyo0tuY+R/PyCyq1E5/jiUZUWD2KEzVogm3MrMYeO8GF4QdxkWW0tDfZAApznOnuEzctYEY08fPo0ugh0UxlzW1fwFPuLfkKFrcwCmkjcs/5BLQYdbelFTkvszLiQbyJpQ5Yun6dh96WbWFrbdLcE07gbWcIc2mVL+Wqr2JBtYiVth2m6KYzz2+GmMtZvWbIjVKF86CyWfLO1mTIZV0V04rgX6aC7KM4/jiBaDwCSjUN1LwcvByc1keg9WvZdsNdTeF+d1BOFT2oKrNRhVlvp1wGczJhbiWx4M03YHLlF27tFOpp2RcekMuLTXtgv80q+xWM2+CbI9ebcoQBe+4KWcmxymgVGqzXwJZcqEBWjYYwq7/3BNV+ggEzVjjg7NUJD2Sfn47fvRuNJb3w5Ho8+vG/Je+PQ9tD/nXsNTAGUsBGCEGulr9ou+/3PSahFGjzXe95+GXv8BO++aTtheoor758au365h29GVjgNzZab4HnTDvSUCQ+568vxhBJ5nO5WQlJ3W+Ri3fOmV7uY985gJeZoeSWFWoOkiErUHua1k5rYXGUNsToaEsrohZMCoXY0IwPNlBr+QpxjO7h5Foo6dhYh7IZpulqt+hkvay14PzMlZUTJDGmb7Ag7e9d8kty5LEzmdrelCf+nFnO0qDNMG0UuDfQLrYvxL5/HHnO+5LpjZbznyHuKfBe9zoPsP/2KbhrF4zefVopLTZiG7GyaoXtDQCfh0UwoDnev5y62zeydJs0IvWGbDXX/J6u2W/r4a412HSdNey/0iZCO/hZNKzyQpafXzev7GZx+nZ8MpZ1Tes121J2xhIU50X4TEBqwQC7QBqfi4ZtoujchFfvLR4+cbdLeOM8yrPyDstPObvv4YTyhWdR8Q1AaQXcsX9FXDXwVHTUBijB9w2cbprhe1IEKsKiTfv4BygJY4w== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search task variables

+ This method returns a list of task variables for the specified `taskId` and `variableName`.
If the request body is not provided or if the `variableNames` parameter in the request is empty, all variables associated with the task will be returned. -## Request + -

Path Parameters

Body

    includeVariables object[]
    + -An array of variable names that should be included in the response. + -
  • Array [
  • ]
- -On success returned. - -
Schema
  • Array [
    • draft object
    - -The draft value of the variable. - -
  • ]
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx index b4d862e180d..29cd08fb76e 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx @@ -5,72 +5,500 @@ description: "Returns the list of tasks that satisfy search request params.
sidebar_label: "Search tasks" hide_title: true hide_table_of_contents: true -api: eJztW21zGzcO/iuc/ZLkTpaU18vpcsnIsdyqTeOcpSQz9XhqaheS2HDJNcm1onr0328Acl/0ZslOLr2ZVJ+kXRIAQQB8AFDXkeMTG3XOoiG3n6LzRpSAjY3InNAq6kSn4HKjLHNTYFJYx/SYOW4/4RPumOVO2PGcWeAmnjIDlzlYxzJueGqbL0am9fJFLl++kOJlf8y4YpBmbs5GOpkzYVlm9JVIIGkwLmWgyw0wQ1whab5oSUGzT5ScM60A+V+ceXbdsQPTYLUfJ6Z3mXNZPDuEsTaw/CsMOb8oZNa0VMvS3Do2ApYZsKAcE6pYTpCilcuXUSPSGRiOU/pJ1Ik8EdSdjRpRmHCok3nUuY5irRwoh195lkkR07zW7xZVex3ZeAopx29unkHUifTod4hd1Igyg1ycAEvjHHdQG2adEWoSrW7VcAqMhtIeTcHrsxk1IlB5ilv8+rTXHfaOokb0+uSXd2964Xv37eveG/p63O3jl/NFI+LWiomCpMZ3pLUErtYYdw1U/Fgx8VVUUdlD+o9TjRZRzGZOVzSXSNkaLW4Mn29URDEaaQazQXITcQWqfEnKEQ5Su5929yW6WDQiFPwIxkKJwlZ2a4C7e97TDt/98paNpZ4xpROg5cdcJSLhDn4wOs92U/uBhJrgYBRXKFZS8E8t+XNznfZuBXcdk8AxGKwqIVC+keHeKv8yNov6wt5bMPvqLLdg1kjTw3WFId0v0ReSXV9HjdlXUNZOHqipzOgYrK0s9meY72Z6CmMwoGJAdw0kWFLSYPcNKJ5CwuAyF1dcYlzVY4bh8j85mHlzjW0/YWMBMnlAeg6v+8o6rmK4u0wiUNhbooJlKQ+JwycwEH/Uo5lQDiZg1qTAYdVZiRPZ/QTGPJeO/Zs9bT/ArR1rk3LnqTx+hBzGWko9e58dLUf8LQfD2Oh0t0IGjhvHaNMNVxPSSzj7kACaBb48cCIF5kViOndSYBgWilmIaTOfNp8VhnV6/Jo9fvz4n6jfsZClwfUHJ+z5s/ZDPIdUwk2ytMqSC67U6d2S91SyWW6n/xSpF2tOFyTTY5bkQAJZFKZ2HNaUrQ0SdsJJXDNu8bGQDgyqI8nhrz3/zvYcB3/gRvCR3APVdBWjF8h4TDRYLHluwTKbQSzGc6EmJMRVQRMFCUNREILj/bEP0Ai6cfAlRr0AuBHVyHm1iNlUxFOC5gUnhLFzT+hHPYMrxN8CUYtIM20cVw7nKe3A5wduKmwQAaVLIZ5yJWzKhCUiCVRwb6bNJwafY5lbcQVyzmbCTZkzuYq5g6RaVpMNkWwKXHkq1YL1mHEmuZmAYRZDMGYTSjsW6zTjTowkBLKVYA3GVUJ0uHOYn9Dac0ugNmUpR/VYDNxCMaF4HOeGULZhQiFdCa7SIw7ciCu3+DOeRvuhTxxZmG+xYjolr7jM96RBQ9eIsI9TUNusyM8J2xybPBZcooJSLpTjiCm0ssI6UHHYsp8GJ2/9LMvuWzCCS/EHpT6ln3i1fWZeKZbZHA3NQ7cHuB8MlM1NsCK/IMsMIFM0QqMzI7hDK/FO6yAhXfjsTO8B9oZBDG6E1YoVE4u9LyQtlUQW8jd2AZcXHUY5pK2lVnAZnRPsD56OgOJwXnk3vQPFlesnt/P1Ic1i/aO6O/vUzu9bmksnDoh4PC8cCxTyRR8vkjIdC3KjYP4Q9lug81Us6tn3v4iSGLNE2IIaug1l9+ACSp4obSC5Aani0q027larLg1j2SgJi/kAq42jR8Hl2Gh+C68jOptspNjP4NdCqyEeA40oNsBrP5eAWnV8Ix+hjXBzSqK1SfbJO/7GLrqD1xcd1rUxqESoSWFsRz16fgTFi5qI3cHrqBHhCG96KwgA9VPphvFiv2OvxPqxhMZ6gqIezv1uVRWVnZv23vro7Y2GccS6QpGlee5N1i02NcQE79NTncsECy6xztAICZfgrn7wo9AI1HItw4+h+JEbg9C9rDv5dSLODsecY94FfELdfddfFRJWSlmJMBA7Cii4tSVXJhJQzjvKaE6Pi7JVWFDD+5QB1LArKhe4FDRbsoFd7rFWwvp+9a4NBSFALdSrQN9uH3yh8DvcgcxADAn8aSr/fm2/0PyfafxCxTJP4A4ZSR72IxzWCMFDq6AEkQhe13YhcKTcLRzlmVYW2AxxDSFqOvgJ7JCKhx62g0wwLdEzG6pblHFJTP8oczDgjIArqM68KkXYBIX8lhS4pxBneaO/Labncsbn1ndfjnMpP6xg/K21eJpXGB1BplzKzbj/Fc2mmlTUGXNpoY5g+8vm4E0EQVEKynHPbjt++unk8LePJ6c/906jRvRrr3fY++39oHf627A7+JmgUYmTOterBbx8OXXVuaP6nA2WLwwrJjdZ1/dV0MQod0XY/ivACBiWZv08gjo3bhhcbizppUKJFNfTbkQp/+y/P2y3F41o4jZXAW+cctsZ8g4zbinWYh05noYmntdVvQJTbEIZekKfbwVKDmh4IBN5FoVrk7oftdvr236iMAukam3Z/kPcfcseWhGq9nRVsUdjBh01V+IyhyoMm/ohQR57N6cvp9++X1QaOOsfVacUtY6qEny9jP72ThKGyb7vEZKgo70akpSdzritTjGaD8m2KvwFrqZZz7Qu6t2AKie7M/9QrdklwVLytyTD/g1NshoLBtm0RILUZ9t7nKUNDL6g2XvXXm+FgHaf+au4StfglFBOexUuhYALD4N8VMEAreCzQ6iTGbgSOrfL0GgXTLHHwli3z1nIxpJPKIBNKaHjrgaoEEcY64rDvkB3/tBp+maMSW/fcio54PSSzj4OvUamf+QLmglkUs8RryJJ1vc7jj9wGVjeLEYUFRof4+iOhcqlLMX4AMYun9zbGlhrwlz5qV9NouX217Mnkd9bbdJeOoIk2evqQd9WjCFMC6U7YWkbXgXhDHjJaOxNavqmnVAfbzZ0QS/+t21QsSMCrnVBl+QpCpn7hamyurgVejc3d8BuoFl0XpYaL9sbT1vaqjcw8DMO8uw2bG57j4JK0Ku3F1ZZ3RAKb3kNYZmdT5xuwe3qTq2qgvg9W2/g0HWuKierStFCbThAmqup6cXyLTH2tmw48ZLqPcsSw8cu5D4hLNVzvCVGHp5e3CLL+2LouJTw/T/0gXwIJiQwLNpuewThIx0qHhd0oMOMKFxgY4gaRGQCtTYesTa1xPSVD3LV3D2uu7AwfnURZGcyhyZ7I1LhQmNY/OFXRxaxe2v/0uQOTa4ljRSUa+62ppBaExyHebcrHNqLWq8+FG+W3fPbFSGGlPn4tx7ylOkWtp+BTcVkCkWLEFfslh/euUSxO2mvVW2etlebjmsKo/T7yaaMu6sYGKOpjVfGRSq9pdq3XhWVQ0P6X7b9LOOpVpOvdQ8XQ/n6pdvtqX9m9EhC+ve7XKPN7R7Qt4ttfnrlzxQDQTzvmz8Oh++YJ8ZinZS27nVZFDqa7FgbBp85WmuDPWm3mVAJrgFrkOzeIU9YON7u+ak46MnyoLfasWOdq6Qcgq1xqxkm9pvuj6VgLZ/s5fX+hV9hKOggz5ERgFdEysHLy6PhOqZsyXfcC0y5x9Ueb2wFBn3/HusW2jCp9ac8Y/ehOWk20ASkxqsitBL7oLkUF4hGYdUpuKnGW9iZJoPJuJtGnah19bBFmWTLG1yEXQZzRRDp7DrKjYw60bU3m0Wn1bqeausWnWu8wbKIVoAOvvOuE1wukjrmcuo5rgcNfFE/obEL4Ll7KB8a4RW55+3n7Y2UcOgWKpXJV3SmzmWbywQ0eCOlxeIcdRPnPgie4ZV1/UlA1Dk7b0Qj4AbMwSdMN87O60MHSNLrp5hQQcJMYIKyKslrGncw4tgr4LmbIhryHu2vU8s541dcyBAo2QDk+OAXrvgEEoaXgjDyoNV7pBRhEH/THwwPBr3BoH/yFoEbMgoCLZblL8ULaiKl0FFMg6Ji9HHhUj99HJLhYZQ5ra7197xD167l1yot1Z15Z3KoF4sql6hdYz8rnp5vKv9VU1avfm97s0Jy5fLzhlkhbahP2pz9VnM3paK1t+UF2fZ60uVvLkaP2o+eHLSfHzx8Nnz4uPP0Saf9sPn4H09/jfz9wO3vl3PEr0Bt5f7dWdG4qdYTcGD1oLpehD0DdInapZ66Hv2Fl7Pypsn6hZJwN4SucXjfql26WCK14XLA+vuiab3tzcap6y2/DUrY0oryDaPzdTy2DLvqEAvbLO3QO2n7hkjbdznaoXXR9o3Isb8oWoM11FA87Q2GGMDWw1wxAqurzABP5gdOH+A9Lox3NfRApUieiUTOWSk4G+VWKCyQBPPGk1BqNbEiCTflfe9DKI/cisYEjymY+xMFI4vttFqz2awZ8zRXCcdKMlqaFDEgGit7g9Gb8KSxMjnRsS1nC02/W6ao5bQCIduifK8o5kVXD/3ZYl3KVY3LoNa4WVVa7e9Jf/3La+1fXuG0cPDZtTLJhUIF01ZdB5hxhlr3QcRGha+hU3nEcBZdX+Nh997IxQIfUzvbH6wFwKBjtRFNgVMoOLuO6KyKXvuNORiiEFUUWut/LRrFjG4cQ+ZuHHtew0vvTgZDPPLC/9RSneAcw2f4HzY+izoRxTpSGQ6gZ9eR5GqSE7yMPE38/BdLt5sy +api: eJztW21zGzcO/iscfklyJ0vKW5vqcsnIttyqTeOcJScz9XhqeheS2HDJNcm1onr032/Al93VmyU7ufRmUn2SdkkABAHwAUDdUMvGhnbO6JCZj/S8QVMwiea55UrSDj0BW2hpiJ0AEdxYokbEMvMRnzBLDLPcjGbEANPJhGi4KsBYkjPNMtN8ealbr14W4tVLwV/1R4RJAlluZ+RSpTPCDcm1uuYppA3ChAh0mQaiHVdImy9bgrvZx1LMiJKA/C/OPLvuyIJukNqPY927KpiIz/ZhpDQs/gpDzi+izMot1ZCsMJZcAsk1GJCWcBmXE6RoFeIVbVCVg2Y4pZ/SDvVEUHeGNmiYsK/SGe3c0ERJC9LiV5bngiduXusPg6q9oSaZQMbwm53lQDtUXf4BiaUNmmvkYjkYN84yC7Vhxmoux3R5q4YTIG6o26MJeH02aYOCLDLc4oOTXnfYO6QNenD867s3vfC9+/ag98Z9Per28cv5vEGZMXwsIa3xvVRKAJMrjLsaKn4kTnxNKyo7SP9hotAi4mxiVUVzgZSp0WJas9laRcTRSDOYDZIb82uQ5UunHG4hM7tpd1ei83mDouCHMOKSR1vZrgFmH3hP23/361syEmpKpErBLT9hMuUps/CjVkW+ndqPTqgxDkZxuSQlBf/UOH9urtLeruCuJQIYBoNlJQTKtzLcWeWfx2ZeX9ipAb2rzgoDeoW0e7iqMKT7OfpCsqvrqDH7AsraygM1lWuVgDGVxf4Cs+1MT2AEGmQC6K6BBElLGuShBskySAlcFfyaCYyrakQwXP6nAD1rrrDtp2TEQaSPnJ7D6740lskE7i8TDxR2liiyLOVx4rAxDPif9WjGpYUx6BUpcFh1VuJE8jCFESuEJf8mz9uPcGtHSmfMeipPnyCHkRJCTU/zw8WIv+FgGGmVbVfIwDJtidt0zeTY6SWcfUgAzQJf7lmeAfEiEVVYwTEMc0kMJG4znze/i4Z1cnRAnj59+gPqd8RFaXD9wTF58V37MZ5DMmU6XVhlyQVXatV2yXsyXS+3VX+J1PMVpwuSqRFJC3ACGRSmdhzWlK00ErbcClwzbvERFxY0qiMt4O89/8b2HAe/Z5qzS7EDqulK4l4g45GjQRLBCgOGmBwSPppxOXZCXEeaKEgYioI4ON4f+QCNoBsHX2HUC4AbUY2YVYuYTngycdA8ckIYO/OEflJTuEb8zRG18CxX2jJpcZ5UFnx+YCfcBBFQugySCZPcZIQbRySFCu5Nlf5I4FMiCsOvQczIlNsJsbqQCbOQVstqkiGSzYBJT6VasBoRRgTTY9DEYAjGbEIqSxKV5czySwGBbCVYgzCZOjrMWsxP3NoL40BtRjKG6jEYuLkkXLIkKbRD2ZpwiXQF2EqPOHAtrtzgz3ga7YY+cWQ037hid0peM1HsSMMNXSFCPkxAbrIiPydsc6KLhDOBCsoYl5YhplDScGNBJmHLfh4cv/WzDHloQHMm+J8u9Sn9xKvtE/FKMcQUaGgeuj3C/SAgTaGDFfkFGaIBmaIRapVrzixaiXdaC6nThc/O1A5gbxjEYJobJUmcGPc+SloqyVnIP8gFXF10iMshTS21git67mB/8HQEFPuzyrvdO5BM2n56N18fulmkf1h3Z5/a+X3LCmH5niOezKJjgUS+6OMxKVMJd24UzB/CfnN0vopFPfv+l6PERyTlJlJDt3HZPdiAksdSaUhvQaq4dKO0vdOqS8NYNEqHxXyAVdq6R8HlyOXsDl7n6Kyzkbifwa+5kkM8Bho00cBqPxeAWnV8Ix+uNLczl0Qrne6Sd/yDXHQHBxcd0jUJyJTLcTS2w557fgjxRU3E7uCANiiO8Ka3hABQP5VuCIv7nXgl1o8lNNZjFHV/5nerqqhs3bRT46O3NxrCEOty6SzNc2+SbtzUEBO8T09UIVIsuCQqRyN0uAR39b0fhUYgF2sZfoyLH4XWCN3LupNfJ+LscMxZ4l3AJ9Tdd/1lIWGplJVyDYl1AQW3tuRKeArSeke5nLnHsWwVFtTwPqUBNWxj5QKXgmbrbGCbe6yUsL5dvSvtghCgFupVoK+3D75Q+A3uQK4hgRT+MpV/u7YfNf9XGj+XiShSuEdGUoT9CIc1QvDQKihBJILXlV0IHF3uFo7yXEkDZIq4xiFqd/A7sONUPPSwHUSKaYmamlDdchmXwPTPZQ4arOZwDdWZV6UI66CQ35KIe6I4ixv9dTE9E1M2M777clQI8X4J42+sxbt50egcZCqEWI/7X7vZriZFOyMmDNQRbH/RHLyJICjKQFrm2W3GTz8f7//+4fjkl94JbdDfer393u+ng97J78Pu4BcHjUqc1LlZLuAVi6mrKmzYIG/5XJM4uUm6vq+CJuZyV4TtvwFchgJn2QK5fcPgam1JL+OSZ7iedoNm7JP//rjdnjfo2K6vAt465a4zxD1m3FGs+SpyPAlNPK+regUmbkIZekKfbwlKDtzwQIZ6FtG1nbqftNur234sMQt01dqy/Ye4+449tBiqdnRVvkNjBh21kPyqgCoM6/oh4Tz2fk5fTr97v+g0GjjpH1anlGsdVSX4ehn97b0kDJN93yMkQYc7NSRddjplpjrF3HxIN1XhL9B6mvVM66LeDahysnvzD9WabRIsJH8LMuze0HRWY0AjmxZPkfp0c4+ztIHBZzR779vrrRDQ9jN/GVepGpzi0iqvwoUQcOFhkI8qGKAlfLIIdXIN11wVZhEabYMp5ohrY3c5C8lIsLELYBOX0DFbA1SII7Sx8bCP6M4fOk3fjNHZ3VtOJQecXtLZxaFXyPQPfUEzhVyoGeJVJEn6fsfxBy4Dy5txRKzQ+Bjn7ljIQohSjPegzeLJvamBtSLMtZ/6xSRabH9994z6vVU662WXkKY7XT3om4oxhGmhdMeN24bXQTgNXjI39jY1fdVOqI83a7qgF//bNijfEgFXuqAL8sRC5m5hqqwuboTezfUdsFtoxs7LQuNlc+NpQ1v1FgZ+xl6R34XNXe9RuBL08u2FZVa3hMI7XkNYZOcTpztwu75XqyoSf2DqDRx3navKyapSNJdrDpDmcmp6sXhLjLwtG06spPrAkFSzkQ25TwhL9RxvgZGHpxd3yPI+GzouJHz/D30gH4IdEhjGttsOQfhQhYrHhTvQYeooXGBjyDWInAnU2niOta4lpq99kKvm7nDdhYTxy4twdiYKaJI3POM2NIb5n351ziK2b+3fmtyiyZWk0QXlmrutKKTWBMdh3u2iQ3tR69WH+GbRPb9eEWLoMh//1kOesp6A7WcgEz6eQGwR4ort4sN7lyi2J+21qs3z9nLTcUVhLv1+ti7j7koCWivXxivjoiu9Zcq3XqUrh4b0v2z7GcIyJcdf6h4uhvLVS7ebU/9cq0sB2T/vc422MDtA3y62+d0rf6ZoCOJ53/xpOHxHPDGSqLS0da/LWOhokiOlCXxiaK0N8qzdJlymuAasQZIH+ywl4Xh74KfioGeLg94qS45UIdNyCLbGjSKY2K+7P5aBMWy8k9f7F36FoaCDPC81B7wiUg5eXJ4brhKXLfmOe8SUO1zt8cYWMejpKdYtlCZCqY9FTh5Cc9xsoAkIhVdF3ErMo+ZCXHA0olVnYCcKb2HnyhlMzuyEdmjr+nHLeVXLGxzFLoO+dhDp7IYWWtAOvfFmM++0WjcTZey8c4M3WOZ0CejgO+86weWoUAkTE89xNWjgi/oJjV0Az91D+dAIr8i9aL9or6WEQzdQqUy+ojOxNl9fJnCD11Kaz89RN0nhg+AZXllXHznQztl5g14C06D3PmK6cXZeHzpAkl4/cUIFCXOOCcqyJAdu3N4lw14BK+wE0ZD3aH+dWswIu2ZchEBJBiBGe78yycaQErwUhJEHrd4jJYpB/E1/MNwb9AaD/vFbBG7IKAg0X5S/FC+oySnFHcVuEI2jj6JL/fxh6AwPo8xJda2/5x26di2/Vmmp7sxbXUC9WFS5RO0a+1l8er6u/FdNWb76venNEsmly89rZoW0oT5pffZbzV2Xitbelhdk26tJl7+5SJ+0nzzba3+/9+SH4ePnneePO09eNNvfP/6N+vuBm98v5ohfgNrS/buz2Lip1hNwYPWgul6EPQN0idqlnroe/YWXs/KmyeqFknA3xF3j8L5Vu3SxQGrN5YDV97FpvenN2qmrLb81StjQivINo/NVPLYIu+oQC9ss7dA7afuGSNt3OdqhddH2jciRvyhagzWuoXjSGwwxgK2GuTgCq6tEA0tne1bt4T0ujHc19OBKkSznqZiRUnByWRgusUASzBtPQqHk2PC0jtLwbHLILTYmWOKCuT9RMLKYTqs1nU6bCcsKmTKsJKOlCZ4AorGyN0jfhCeNpcmpSkw5myv3u6VjLacVCJmWy/diMY9eP/Zni7EZkzUug1rjZllptb8n/f0vr5V/eYXTwsIn28oF4xIV7LbqJsCMM9S6DyKGRl9Dp/KI4Yze3OBhd6rFfI6PXTvbH6wRYLhjtUEnwFwoOLuh7qyiB35j9oYoRBWFVvpf80ac0U0SyO2tY89reOnd8WCIR174n1qmUpyj2RT/w8amtENdrHMqwwHu2Q0VTI4LBy+pp4mf/wJ5MpxC sidebar_class_name: "post api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search tasks

+ - + Returns the list of tasks that satisfy search request params.
  • If an empty body is provided, all tasks are returned.
  • Only one of `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` search options must be present in request.
-## Request + -

Body

    followUpDate object
    + -A range of due dates for the tasks to search for. +If defined, the query returns only tasks to which all clauses apply.
    However, it's important to note that this filtering mechanism is
    designed to work exclusively with truncated variables. This means
    variables of a larger size are not compatible with this filter, and
    attempts to use them may result in inaccurate or incomplete query results.", + items: { + type: "object", + properties: { + name: { + type: "string", + description: "The name of the variable.", + }, + value: { + type: "string", + description: + "The value of the variable. When specifying the variable value, it's crucial to maintain consistency with JSON values (serialization for the complex objects such as list) and ensure that strings remain appropriately formatted.", + }, + operator: { + type: "string", + description: + "The comparison operator to use for the variable.
    * `eq`: Equals", + enum: ["eq"], + }, + }, + title: "TaskByVariables", + }, + }, + tenantIds: { + type: "array", + description: + "An array of Tenant IDs to filter tasks. When multi-tenancy is
    enabled, tasks associated with the specified tenant IDs are returned;
    if disabled, this parameter is ignored.", + items: { type: "string" }, + }, + sort: { + type: "array", + description: + "An array of objects specifying the fields to sort the results by.", + items: { + type: "object", + properties: { + field: { + type: "string", + enum: [ + "completionTime", + "creationTime", + "followUpDate", + "dueDate", + "priority", + ], + }, + order: { + type: "string", + description: "* `ASC`: Ascending
    * `DESC`: Descending", + enum: ["ASC", "DESC"], + }, + }, + description: "Sort results by a specific field.", + title: "TaskOrderBy", + }, + }, + searchAfter: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + searchAfterOrEqual: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + searchBefore: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + searchBeforeOrEqual: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + includeVariables: { + type: "array", + description: + "An array used to specify a list of variable names that should be included in the response when querying tasks.
    This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.", + items: { + type: "object", + properties: { + name: { + type: "string", + description: "The name of the variable.", + }, + alwaysReturnFullValue: { + type: "boolean", + description: + "Always return the full value of the variable?", + default: false, + }, + }, + title: "IncludeVariable", + }, + }, + implementation: { + type: "string", + enum: ["JOB_WORKER", "ZEEBE_USER_TASK"], + }, + priority: { + description: + "Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks.", + type: "object", + properties: { + eq: { type: "integer", minimum: 0, maximum: 100 }, + gte: { type: "integer", minimum: 0, maximum: 100 }, + gt: { type: "integer", minimum: 0, maximum: 100 }, + lt: { type: "integer", minimum: 0, maximum: 100 }, + lte: { type: "integer", minimum: 0, maximum: 100 }, + }, + }, + }, + description: "Request object to search tasks by provided params.", + title: "TaskSearchRequest", + }, + }, + }, + }} +>     -
    dueDate object
    - -A range of due dates for the tasks to search for. - -
    taskVariables object[]
    - -An array of filter clauses specifying the variables to filter for.
    If defined, the query returns only tasks to which all clauses apply.
    However, it's important to note that this filtering mechanism is
    designed to work exclusively with truncated variables. This means
    variables of a larger size are not compatible with this filter, and
    attempts to use them may result in inaccurate or incomplete query results. - -
  • Array [
    • * `eq`: Equals","enum":["eq"]}}>
  • ]
    • enabled, tasks associated with the specified tenant IDs are returned;
    if disabled, this parameter is ignored.","items":{"type":"string"}}}>
    sort object[]
    - -An array of objects specifying the fields to sort the results by. - -
  • Array [
    • * `DESC`: Descending","enum":["ASC","DESC"]}}>
  • ]
    • It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>
    includeVariables object[]
    - -An array used to specify a list of variable names that should be included in the response when querying tasks.
    This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results. - -
  • Array [
  • ]
    • priority object
    - -Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks. - -
- -On success returned. - -
Schema
  • Array [
    • variables object[]
    - -An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`. - -
  • Array [
    • draft object
    - -The draft value of the variable. - -
  • ]
  • ]
- -An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request - -
Schema
+ diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/sidebar.js b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/sidebar.js deleted file mode 100644 index 8c3ec36257d..00000000000 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/sidebar.js +++ /dev/null @@ -1,78 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/tasklist-rest-api", - }, - { - type: "category", - label: "Form", - items: [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/get-form", - label: "Get a form", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Task", - items: [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/save-draft-task-variables", - label: "Save draft variables", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/search-task-variables", - label: "Search task variables", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/search-tasks", - label: "Search tasks", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/unassign-task", - label: "Unassign a task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/complete-task", - label: "Complete a task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/assign-task", - label: "Assign a task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/get-task-by-id", - label: "Get a task", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Variables", - items: [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/get-variable-by-id", - label: "Get a variable", - className: "api-method get", - }, - ], - }, -]; diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/sidebar.ts b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/sidebar.ts new file mode 100644 index 00000000000..8f467da6aae --- /dev/null +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/sidebar.ts @@ -0,0 +1,84 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api", + }, + { + type: "category", + label: "Form", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/get-form", + label: "Get a form", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Task", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables", + label: "Save draft variables", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/search-task-variables", + label: "Search task variables", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/search-tasks", + label: "Search tasks", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/unassign-task", + label: "Unassign a task", + className: "api-method patch", + }, + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/complete-task", + label: "Complete a task", + className: "api-method patch", + }, + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/assign-task", + label: "Assign a task", + className: "api-method patch", + }, + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/get-task-by-id", + label: "Get a task", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Variables", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/tasklist-api-rest/specifications/get-variable-by-id", + label: "Get a variable", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx index a8d732b0d7d..50bd714d180 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx @@ -9,16 +9,78 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Tasklist REST API

+ Tasklist is a ready-to-use API application to rapidly implement business processes alongside user tasks in Zeebe. -

Authentication

- -Cookie-based authentication is only available on Self-Managed clusters. - -
Security Scheme Type:apiKey
Header parameter name:TASKLIST-SESSION
Security Scheme Type:http
HTTP Authorization Scheme:bearer
Bearer format:JWT

License

License
+
+ + + + Cookie-based authentication is only available on Self-Managed clusters. +
+ + + + + + + + + + + +
Security Scheme Type:apiKey
Header parameter name:TASKLIST-SESSION
+
+ + +
+ + + + + + + + + + + + + + + +
Security Scheme Type:http
HTTP Authorization Scheme:bearer
Bearer format:JWT
+
+ + +
+
+

Contact

+ + URL: [https://www.camunda.com](https://www.camunda.com) +
+
+

License

+ License +
diff --git a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx index 2ecc8512e03..02874cb164f 100644 --- a/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx @@ -5,47 +5,231 @@ description: "Unassign a task with `taskId`. Returns the task." sidebar_label: "Unassign a task" hide_title: true hide_table_of_contents: true -api: eJztWG1vIjcQ/isjf7mcugGuTasKVa24HGm5lyQC0pMaRXdmPbC+eO2N7SWHEP+9Gnt3gUATcu3HfsKsZ5558bzZS+b5zLHuNRtzd8tuEibQpVYWXhrNuuxKc+fkTAMHz90t3EufwWdaDsTnFgzRl1Y78BmG/RZLmCnQcmIfCNZlZQUQ4BNWcMtz9GhJ5pJpniPrsojHEiZJZsF9xh4qMs4QBm/ATLdkWbwrpUXBut6WmDCXZphz1l0yvygI2Xkr9YytVjdE7AqjHTra/77ToZ9tIRcaXJmm6BzYYBkKkpIa7VF7oudFoWQazGt/ccS03BVqJl8w9WStJWd4GUVKsavYPjNLLe9KBClQezmVaLetXiWV2w7BIsoddlq8wanUsj6mp6CuHFqgI6QzmFqTB8DXlx/OQTRAAbuwhvx3/k0aVswBKLUY3PyG+wOQPmao4Z6vIxECPwo4skgiBFCozLlC7UncZ7KmVQsZyxw/w1SiEi+jdJMXCv+V/IjwpAaNoB0dYuLggX4sHVoS05aC0O8zA9JBhSHAm90YGPmDbCN0R6S72cfFhVaLOvtQlzmVktNhvzfuv2EJO734cPm+X61756f992F51hvQ4maVsKmx+TtcPK3FEKdoUae4aQoQe7CHFodE8g5MLCocBBbKLFBESBhEU+kP+VEb31Ak4DPpoEruRdgulWrU+BOtk7E0VLpI7XGG9mll5pH1P9MoKsR91OGnE1JRujNj834+QSFw02MTYxRyvaPlwK0FY8VG/6JQOobfKuUsRs0C7WNuqhJ9XYSeHwIVxEb9eTzRdkQOxFa2VfsD7TzXKX67QrJCAPlE6j+Q+EAfj5prf0hIU35Gagpm7pxJZSh9oVlvZb0o8bB6RpiiRBCU9vGs13nfxBTtHnuZYwx9pcz9VXG4gMhxXBbPEZNyLSR9+d2asnAbkri1fLFXUMMDs8C0I0p6zN2+sWFDHvXA54qjovwsaZK6QY7ac79dQho31kX27cXrTx8vhu/6Q5awv/r91/1PV6P+8NO4N3oXKmthpbHSL3bHnHFotXE3lpqmv7eANjM5yzDqPOeqxLDa+Fgzt6AX56GJQjBaLYKpfyFOcA3pyOSdQphLLXOypJOwnH+N61edDvlzykvlWffHDnnES6+IlaCG1QTHVivaOtk3w/U0oLXGUr2phzi4p/bcNI2qevLUyznCEa1l3K46V2x3L1u/TGz7172Act0JQ9snjFRxSbl+VDfdlzDBqbH4yAxZWDNRmH/33FmSFCzdAS2mp6HaAp9xDxYLiw61j0X9j/H4EiIYpEY0LT5aXE/MLTgzFvArp+hM4KTTAakF2YAOOLx4zQUM8a5E519EViI62SY6Nx7OTKlFQ8K1AGeAJsftRvXD95TpOTrHZwfUkh7EjWhhYc1ciiBzYiVOYYN427xAbtK0tJYGfUq/qhY/LbMfQ6Ku9VdXNBgbC8qY27KAI2zNWgmFlTIzqCxxVNk3QjpgNLF88k2x3NT4+lJWR/eUXP1/5P0feY9HXrDWZ0bEi3eahUu6z1iXteev2hRUrr2MsbVq17d5ljCHdl5f40urWJctYwituu32MjPOr7rLwli/YgmbcyupSYS4ob0Y61WhZ8qkXIXP+9opbWzeEnuXA4jS4+Bm7AO4nzs/d/YiEek/oKzDf42TeV/svw0F4r1I4aXBYVrG1nu9ZKkxtxJZ9/omYRPkFu3xLQ2X1zebpCOCjP6pGdaTRiFpHH2oyWmgO55whwJ46TN6L4jZTUUg9GM+51JV7RlGqKbHH7jmMxSQqtLROwxlQPUMQ6PD+8FofDzqj0aDi/P6QaZSaLWtf6Ne5abglHCPCESspj6r0+vtx3GccfTUBPaNzq6k8zDsj8bkzV2f1xR0owW6di6OvTkuXXT+RlmjQdzyQgq1gGaWgknppKbZvBq5KUWV0TMnRZzRQi2l0T0OL3XZ5GmIrBjeZKbrttv39/etlOelFpxu7+QWJVOksaTbvGi9r74kD5iFSV3DLU3437b1NaJdAbk2oc7reySbv4qB7nzO9YaUB69zD/22XNf+b3nIq47X41ffLhSXmpQI5iyrEnFNmsW3BMcS1m3e8Zo6cZNU6X7NlkuK1CurViv6fFeiXcSsqKtDSBchHa0F6065cviISUfD6vXvJex/HdxrQJ1TehHqkirpH0tYiOn6JXJFA3SGXKANSsXNXppi4TfYdl4DKaObcnrZG5/+wVarvwHbGGKv +api: eJztWG1v2zYQ/isHflmKKbbbZcNgDBvcxNnclySwnRVYELS0eLa4UKRKUk4Nw/99OFKS7dhLnG4f+0mUePfci+6NXDLPZ451b9iYuzt2mzCBLrWy8NJo1mXXmjsnZxo4eO7u4F76DD7RciA+tWCIvrTagc8w7LdYwkyBlhP7QLAuKyuAAJ+wglueo0dLMpdM8xxZl0U8ljBJMgvuM/ZQkXGGMDgDM92SZfFzKS0K1vW2xIS5NMOcs+6S+UVByM5bqWdstbolYlcY7dDR/qtOhx7bQi41uDJN0TmwwTIUJCU12qP2RM+LQsk0mNf+2xHTcleomfyNqSdrLTnDyyhSil3F9plZavm5RJACtZdTiXbb6lVSue0QLKLcYafFGU6llvVvegrq2qGNATA4g6k1eQB8ffX+AkQDFLALa8h/F1+lYcUcgFKLwc1n3B+A9CFDDfd8HYkQ+FHAkUUSIYBCZc4Vak/iPlFAtmohY5njJ5hKVOJFlG7yQuF/kh8RntSgEbSjQ0wcPNCPpUNLYtpSEPp9ZkA6qDAEeLMbAyN/kG2E7oh0N/u4uNRqUWcf6jKnUnI67PfG/TOWsNPL91fv+tW6d3HafxeW570BLW5XCZsam7/FxdNaDHGKFnWKm6YAsQd7aHFIJO/AxKLCQWChzAJFhIRBNJVeyI/a+IYiAZ9JB1VyL8J2qVSjxp9onYylodJFao8ztE8rM4+s/5tGUSHuow4/nZCK0p0bm/fzCQqBmx6bGKOQ6x0tB24tGCs2eotC6Tf8VilnMWoWaB9zU5Xo6yL0/BCoIDbqz+OJtiNyILayrdofaOe5TvHrFZIVAsgnUv+BxAf6eNRc+0NCmvIzUlMwc+dMKkPpC816K+tFiYfVM8IUJYKgtI//ep33TUzR7rGXOcbQV8rcXxeHC4gcx2XxHDEp10LSl9+tKQu3IYlbyxd7BTU8MAtMO6Kkx9ztGxs25FEPfK44KsrPkiapG+SoPffbJaRxY11k31y+/vjhcvi2P2QJ+6vff93/eD3qDz+Oe6O3obIWVhor/WJ3zBmHVht3Y6kp6/7eAtrM5CzDqPOcqxLDauNjzdyCXpyHJgrBaLUIpv6FOME1pCOTdwphLrXMyZJOwnL+Ja5fdjrkzykvlWfdHzvkES+9IlZKmWE1wbHVirZO9s1wPQ1orbFUb+ohDu6pPTdNo6qePPVyjnBEaxm3q84V292L1i8T2/51L6Bcd8LQ9gkjVVxSrh/VTfcFTHBqLD4yQxbWTBTm3z93liQFS3dAi+lpqLbAZ9yDxcKiQ+1jUf9jPL6CCAapEU2LjxbXE3MLzo0F/MIpOhM46XRAakE2oAMO373mAob4uUTnv4usRHSyTXRhPJybUouGhGsBzgBNjtuN6odXlOk5OsdnB9SSHsSNaGFhzVyKIHNiJU5hg3jbvEBu0rS0lgZ9Sr+qFj8tsx9Doq7119c0GBsLypi7soAjbM1aCYWVMjOoLHFU2TdCOmA0sXzyVbHc1Pj6UFZH95Rc/S3yvkXe45EXrPWZEfHgnWbhkO4z1mXt+ct2KODtZYytVbs+zbOEObTz+hhfWsW6bBlDaNVtt5eZcX7VXRbG+hVL2JxbSU0ixA3txVivCj1TJuUqfN7XTmlj85TYuxpAlB4HN2MfwP3c+bmzF4lI/wVlHf5rnMz7Yv9pKBDvRQo3DQ7TMrbemyVLjbmTyLo3twmbILdoj+9ouLy53SQdEWT0T82wnjQKSePoQ01OA93xhDsUwEuf0X1BzG4qAqEf8zmXqmrPMEI1PX7PNZ+hgFSVju5hKAOqaxgaHd4NRuPjUX80Glxe1BcylUKrbf0b9So3BaeEc0QgYjX1eZ1ebz6M44yjpyawb3R2JZ2HYX80Jm/u+rymoBMt0LFzcezNcemi8zfKGg3ilhdSqAU0sxRMSic1zebVyE0pqoyeOSk2BxVKmjC81GWTpyGyYniTma7bbt/f37dSnpdacDq9k1uUTJHGkm5zo/Wu+pI8YBYmdQ23NOG9betjRLsCcm1CndfnSDZ/GQPd+ZzrDSkPbuce+m25rv1fc5FX/V6PX3y7UFxqUiKYs6xKxA1pFu8SHEtYt7nHa+rEbVKl+w1bLilSr61arejz5xLtImZFXR1CugjpaC1Yd8qVw0dMOhpWt38vYP/t4F4D6pzSi1CXVElvLGEhpuubyBUN0BlygTYoFTd7aYqF32DbuQ2kjG7K6VVvfPoHW63+AdsQY08= sidebar_class_name: "patch api-method" -info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api +info_path: versioned_docs/version-8.6/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Unassign a task

+ Unassign a task with `taskId`. Returns the task. -## Request + -

Path Parameters

+ -On success returned. + -
Schema
- -An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before. - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+An error is returned if the task was not claimed (assigned) before.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +> diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/assign-a-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/assign-a-user-task.api.mdx index 3dd58a62c99..03e51ed86ec 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/assign-a-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/assign-a-user-task.api.mdx @@ -5,51 +5,178 @@ description: "Assigns a user task with the given key to the given assignee." sidebar_label: "Assign a user task" hide_title: true hide_table_of_contents: true -api: eJztWNty2zYQ/RUMXppMbVFJ3TTRm+M6rdtcPLbcTmN7xiAJSYhJgAVAySpH/96zAKl7LtPmMckkw8tiz+7inCVWDfdi7Pjgml85aZkX7p7fHvBcusyqyiuj+YAfO6fG2jHB6s6IzZSfMD+RbKymUrN7OWferD0QYY2UPX7AK2FFKb20BNRwjRt4JV9DuPpdzmGjCKgSfoJrK/+ulZU5H3hby+1ohsAgODMKcKuQgB9RCdNlE1kKPmi4n1cEp7SXY2nxamRsKXx89OyILxa3EVI6/9Lkc1qzHUFmsFp7eiWqqlCZoGCSD44ianbBTPpBZp5St6aS1ivpwtq2KHS9m1T3liHAzdR6bON9WTvPtPEslUyWlUctLLvTdVHcUeptDM5bpce4pxciLfBsJAonFwdcFIWZvZtKa1W+J5iXc5bLkagLfxDiCNVVjlnZhpAzNWLKs5kAKQo8zudddHmPXUqPZbDHhtwFyDu6tNLXFsTQDLgIWGnm6mzCMuGkixkGoJAdYDUbKetCkrVeAsNRuixFzsRYKN1jIG+EnNG6uanZRExjAR2rVHaPSrCRNSUbW1NXEQg7jj0nj5WV4KxnVmSSYa9zRZVwvRu9KmdqTCGF3qgnkYPKmcXCbdfxmGXIBaDRgE1FUVOcApVTRRESyTKJXOAthrdic4iIau6wD8vwQ5JS55UBeVHCqYlU7LGzUaAECDfFpuYHYX8Ipd1KyvOmZeAN30htD1NCZkjNK0+3oTuQWGMrKBHaRVQM5EN2CLNCxSLNn/aP9jN8md13rt1C8hRplH9ArUAfDm9H/f6nJBIW7ch/T0fKhG5lkpmyKiT5Z2+MlSiKF6oALK67khEjaX2XC0vRDWKhPqJ/rES1yu93+8A2Ec6jZYvLYn9AOiwaphH9+uLVCXtx9ONPt48m3ldukCSz2axnR9mhBCeN7Rk7TnBL/8jucdANcijFPNApj9QVBVt1HuYqmamRyroO3YbNaPs3iPCRthXfNjt0WTbS2iq+89FgVxdnDHXVXo3mROAd6LAmkBP2IjW1H6SF0Pd8Rbxd0G0UV5elsMvPwSYAHDkvfO0++yH44emObyLcr8PhOYsuwKG8680QYQtESZRKq7Iu+QC8xZ14iHfP+v0F+aQd/4JM0BcfKqQfqLWdDshRrngbElMacensa+2MsWqstnEBtNYEWhL/HDOKwj/6rNb3CZMUT8ocmVp3kn/xH/xgH1rRzqxBIrRTEHttLZIr5t/E/k3s38T+tcSOlzjFT0xOJ3XjAnXowD7gCYn0kETqkmbtXL9IVh9sOpNLO+2GgNqiTLyJIlqA+80ELheDpjLWL5LpE9hPhVV0HAkbSq+j2DoSFTj7FJMYyO5m0guaNChJwd5LCcX8gu4wE/NQUcLZ9Pe8/7y/1xWZdrWKji5OL4fs+PyMxZQi99b6QeeShL3XZTT+nNMwmjiJfqb8/JKWxFqkEq3MHtdU/CUfWqzgORxYgxGexItXHUt++3MYNpr62MVq7Dl9EHRE2hxTViTbGhniWNQdfDuzQNSRCUG1NNpMjTYVDIiL+r0nu3RF+qQ6nNfKWofWC8ouO3/0lhV0VLSkRnRnie5NiO1YGU1O4nqMRq+jBfsj4rInATXSr+u7Y/iv0x5Ak0xgXS6Sf8hNkhYmTUqMGEkL5JL3p6cvTw9P3r15c/X2bPjX4euzk9O3l6eH8NvzDz6UltRRCr0WVTw3r0/Q26k3q+/O/x64W0Z4+eATdBnM1os25aaV7DVfSRYLBpvD+JpqQcCovGveNClGtStbLBb0GMyxGJavb1dCDcrOlaPrvB03P5Hmo4t2zH7Mvmyo35tX+1DoeWgZGLFwh0u42/qVYXEL8wmmVciCIo0WJzGewyH5WXnYmfMXB92KYwxtlf+I7cYxgfS77Jnn7y6HJMf2N4bSkJC4FTP6yQP/D/gN/uLGhFoFpYfnDceXYlyLMdlHv/TnX93IKMU= +api: eJztWNtuGzcQ/ZUBX5qga0lO3TTZN8d1Wre5GLbconEMmMsdSYy55IYXyQth/70YcleyLrmgzWMCGNnLcM7M8JxZjpbM86lj+TW7cmjBc3fHbjJWohNW1l4azXJ27JycagccQm8EC+ln4GcIUzlHDXfYgDcPHvC4BnHAMlZzyyv0aAloyTSvkOWMfI25u/sTG5YxSUA19zOWMYsfg7RYstzbgNvRjGcY4cwkwq1D8qZDJUwnZlhxli+Zb2qCk9rjFC3L2MTYivv06OkRa9ubBInOvzBlQ2u2IxBGe9SeXvG6VlJwCmb4wVFEy10wU3xA4Sl1a2q0XqKLa7ui0PVuUv1bmBi7mdoANt5XwXnQxkOBgFXtGzAWbnVQ6pZS72Jw3ko9ZRmjF7xQyPIJVw7bjHGlzOLtHK2V5Z5gXjRQ4oQH5bMYR6yudGCxC6EEOQHpYcEdcGWRl00fXTmAS/TgZ9LRhtxGyFu6tOiD1cA1oLXGgtTggpiB4A5dyjACxez8DDVMpHUxyaBXwN7Qg9Utn3KpB3DlMEEuaF1jAsz4PBXQQS3FndRTmFhTwdSaUCegjwEDxihri3PUHiwXCMLoUlIl3OC9XpezMEYh1xv1JHJQOUUq3HYdj0EE500FyQDmXAWKk3tYSKViIkKgc7JQmMJbszlGRDV3QflV+DFJ1GVtpPYg9dwkKg7gbBIpUVszlyWWWdwfQum2kvJ83zHwPdtIbQ9TYmZtxrz0dBu7A4k1tYIKtb9IimFtS3YWXW20SzR/Mjraz/BVdj+4bgvJU6JR+SE4j+WAtRk7Go0+J5G4aEf+ezqS4LqTiTBVrZD8w2tjEUr0XCoH3OKqZMRIWt/nAoUpm1SoT+i/tqZQWP242we2iXCeLDtcSP0BuINkWCT064uXJ/D86Odfbh7NvK9dPhwuFouBnYgDLKU3dmDsdGgngv7I7nHUjUWoeBPpVCbqcgXrzgOuRiEnUvQdugsbaPs3iPCJtpXeLnfosmqkwUq289GAq4szkCVqLycNEXgHOq6J5GQ544UJPi8U13dsTbxd0G0UF6qK29XnYBOgzZjz3Af3xQ/BT092fBPhfh+PzyG5AGHKvjdL1wNREpXUsgoVy49Go4xV/D7dPR2NWvJJO/4VmWjA+1pxHam1nY7UUK15GxOT2nmuxbfaGWPlVG7jDtjDJtCR+NeUURL+0Re1vk+YpHhS5sQE3Uv++X/wI10v2oU1ehp3CkEEa1F71XwX+3exfxf7txJ7m7EK/cyUdFI3LlKHDuw5G5JID0ikbrh8cK5vh+sPNp3J0c77ISBYxXK2TCJq8+FwOTPOt/myNta3w/khy9icW0nHkbih9DqJrSeRMoKrWQpkdzPpBU0alCSHd4gFwm/c44I3saKEs+nv2ejZaK8rMu1rlRxdnF6O4fj8DFJKiXsP+kHvkoS912Uy/pLTOJo4FMFK31zSklSLArlFexyo+Cs+dFjRczywRiOWdRcve5b88fc4bjT1sYv12HN6z+mItDmmrEm2NTKksag/+PZmkagTE4PqaLSZGm0qWpcWjQaHu3Q9P4uqE6aqgo6tV0/XnT95E4qOipbUqKRA7WLU3ViZTE7Set/Aq2QBfyVcOIyoiX59351KPwvFQJhqKHgVdMlX/xfKFMOKSz3soNzw3enpi9ODk7evX1+9ORv/c/Dq7OT0zeXpweHgcODvfSwu6aPi+kFc6eT8cIbeTn65/vL875G744THez+sFZea9iYmvexEe83WomUZyzfH8Qe6vck67V2z5bLgDq+salt6/DGgbVh+fbOWatR2KR1dl93A+Zk0H110g/Zj+Lqxfm9e3UOum9g0VKA7lrE7bLZ+Z2hv2ozNkJdoY6TJ4iTFczAmP2sPO5N+m/UrjoXA2n/CduOgQApedc3zt5djEmT3K0NlSErM8gX96MEXKWoT6xR1Hp8tmeJ6GviUbJNP+vcv8esolw== sidebar_class_name: "post api-method" -info_path: docs/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api +info_path: versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a user task

+ Assigns a user task with the given key to the given assignee. -## Request + -

Path Parameters

Body

required
+ -The user task's assignment was adjusted. + -
- -The assignment of the user task 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 user task with the given key was not found. - -
- -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}}>
+ diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/complete-a-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/complete-a-user-task.api.mdx index 76903ffe6b9..d50f3c05387 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/complete-a-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/complete-a-user-task.api.mdx @@ -5,55 +5,172 @@ description: "Completes a user task with the given key." sidebar_label: "Complete a user task" hide_title: true hide_table_of_contents: true -api: eJztV8Fy2zYQ/RUMTslUFuXUTRPdHFVp3caJR5bbaWwfIBKSkJAEA4CSVQ7/vW8JUpREe+x2crQ99hDE4i12970lUHAnFpYPr/mVlYY5Yb/y2x6PpA2NypzSKR/ykU6yWDppmWB5Y8bWyi2ZW0q2UCuZsq9y0+c9ngkjEtgaAi14igEQaNUUi/6QG9goAs2EW+LZyG+5MjLiQ2dyeeh5CngAMz2vPLXOnWZhvSvyasOlTAQfFtxtMnKoUicX0mBqrk0inH/1+oSX5a13Kq17p6MNrWn3MBexxSZCjeWpozmRZbEKBe0n+GJpU0XXm559kaGj6I3OpHFKWppdCaPELPYDEUWKUER8sWP0UNDbpbuRHuSACkDBH24izeOY1nr0ssdF6JGLA0enLMyt0wnzBnAa5+REOGDHMZtJzITSWgU0NjewbL1LFN1ZZqTNY6fShZ93S2WZTKNMI91MpSvtc9dnZ3OWaseQoZWKZNRjqvYSybkABAV6w5tQb3j/Jm1js87ARTc2BOeUo2HFX6JYTVb4nPgqo+Rkh41mOrW+GK8GJ910TPezK+w28RGzeZWIOdyD5oA7GQweRegIhIUipSQgsVvoPjvXRiILTqgYCsNzkyPkr1rfbJ3NQFiflwcYipVITvJDl6mHlb/wlrVf5snDELM3nHnv15P3I/b25Kefb18sncvsMAjW63XfzMMjCTpr09dmEWBIf2T3ss+QBMSQiE3Fny3rWasNZjMZqrkKqeYUYL1tRtXeq/sDwvKzRYcdW63nRvFDWZ2yq8kZQ15Tp+YbYmzHdbWmYiPsxUznbjiLRfqVtzzrOj30YvMkEWbbs/YdAMg64XL7aK/68VUHm+j123R6wTwEOBRBltp41dWOKIhEpSrJEz4ESzESd370ejAoCZMq/oRIUibvMoRfUeswHJAjaXlbBaZS7CsNv1dltFELdegXjnY0X5P4Fx+R1/nJE6TdFSapnZQ513ka1QJ/+z9wUIdatGujEQhVCmLPjUFwaB3PYn8W+7PYv5PYMYmj5lJHdJzUtqIOnSqHPCCRHpFIbVDsHD7LINweD+jYKM2qOanmBmnihRdRCe4XS0CWwyLTxpXB6hj2ewc6mvZia0gU47ATL/1GusWkCToOU5CCfZYSivkV3WEt/ImC/OzjvRm8GdwLRaZNrjzQZHw5ZacXZ8yH5Lm30w8aSBL2vZDe+DHQ6vRsJfqZcptLWuJzMZNoZeY0p+Rv+VD7qpBp7I3wxj+8b1jy+1/TqtDUxybtyXx8J6hUhwfpnfNsw7iKjnNdua7Jsh8AlQ519osG/eMuKREkaQvsSPK0arAg5ra/e7QwxmmZ0tDj6MESPZo81jccbzLy692GffAW7E/vlx1XXj3Jmu66AH4+68NpEAqsi0TwD8EEs1jPgkSoNKgd2eDzePxufDT6dH5+9fFs+vfRh7PR+OPl+Ai4fXfnqgSSBhKR7uyqubntXtwOgy/a78t/uunVVXbyzgXoHLjUlXWARS3Da97KEAuG+7fAHSWCVF5N17woZsLKKxOXJb0GGwzuaNe3rfgqtUbK0nN7ZXswpBeT+nb3kj31NnlvZPVLkW6qRoCbEkZ4BODBBbe8hflSighkp716i5Hf0dGUcFqEzv2y7DUrTnHlyNwDtnsff1LlthNefLqcksjqy22C7wbeGrGm2zb+D/kNfjHQVbYq/VbvC47+v8jFguw9Lv38C0iulxI= +api: eJztV9ty2zYQ/ZUdPDVTWpRTN0345rhO6zYXjy230zh+AMGlhBgEGACUzOHw3zsLUKIu8STt5DGe0VgkFnv2cg606Jjnc8eyW3bj0ILn7p7dJaxAJ6ysvTSaZezMVLVCjw44NGszWEm/AL9AmMslarjHdsISVnPLK/RoyWnHNK+QZYx2zbi7/xNbljBJTmvuFyxhFj810mLBMm8b3EeeLZAcgykD0gjuDYghKkJ1YoEVZ1nHfFsToNQe52hZwkpjK+7jq2cnrO/vIig6/9IULe0ZYyi5cpgwYbRH7WmN17WSglM86UdHQXWHaCb/iMJT9tbUaL1ER6tLbiXPVXzgRSHJC1eXW0aPJb3Zup3pXg2oAZT8fhC6UYr2Ru99wriInrs9oFMQjfOmgmgAS64aAuEeVlIpyBG4EOiczBVCaU21hY5L1N6BRdcoL/U8rvuFdIC6qI3UHqRemli7CVyUoI2H2pqlLLBIQA4oBZa8UZ4S/cDWqX5gkw96zM15K/X8MLc+YV56egz8JYoNZJVGX8Uus74nO4uuNtrFZjydnhyWY7ZbXe42hS/ANaEQZaNUO2F9wk6m0y96OBAICK6pCDmOrifwxliEAj2XygG3uKkRSB32r0OH3BRtrMsjDK2tyRVWPx4ydb/zl9FywIVIHuAOomEe0W+vXp3Bi5Off7n7YeF97bI0Xa1WE1uKIyykN3Zi7Dy1paAP2T2ZwGyBFqHibeDPhvUwagNcjUKWUlDPKcEhbKBu7/T9EWHF1e6AHRutN1ayfVmdws3VBcgCtZdlS4w9gA57AhtZxnhuGp/liut7NvLsEHQfxTVVxe3mzNoF6BPmPPeN++JZ9dPTA99Er99ns0uILkCYAqE0NqpuAKIkKqll1VQsO5lOE1bxh/j0bDrtySd1/Csy0YAPteI6UGs/HamhGnkbEpPaea7Ft+qMsXIu93EnbFvzA4l/jRlFnZ98hbQPhUlqJ2WWptHFIPAX/8OPdGvRrqzR89ApBNFYi9qr9rvYv4v9u9i/ldj7hFXoF6agcdK4QB2aKjOWkkiPSKQu7baGzz4Vm/GAxka0y/Wk2ljFMtZFEfVZmnYL43yfdbWxvk+XxyzZHehoOYptTSJlBFeLGMhhM2mBxmFKksN7xBzhN+5xxeNEQTi7/p5Pn08/64pM17WKjq7Or2dwenkBMaXIva3zYO2ShP1Zl9H4S07D9OxQNFb69pq2xFrkyC3a04aKv+HDgBU803M0Ysnw5dWaJX/8PQuNpnPsapzMzx84tWp/kN6aZ9eMC3QsTYAeyLKbALUOrYubppPjQ1JeXgRtCVNVjQ4HrJ6P53v0JlTjPJUhYUoK1C7ENtxwoslZ3O9beB0t4K+IC8cBNZJsfbrOpV80+USYKhW8anTBN/9zZfK04lKnA5RL35+fvzw/Onv35s3N24vZP0evL87O316fHx1Pjif+wYcSkgoqrrfiWt/dtq9u++l34y/Mf7rrDX32+ODTWnGpqRMhxW4Q4i0bhcgSlu3eA7e0eJcMerplXZdzhzdW9T29/tSgbVl2ezfKL+i1kI6+j5e2R1P64Wq43z2Br71Pfjaz4SXXbTgKVENPLGH32O5dcfu7PmEL5AXaEGu0OIsRHc3Iz+jh4IbZJ+sdp0Jg7R+x3fn5J11uzsLLd9czktlwva1MQXstX9F9m69i1CZUKqg3vOuY4nre8DnZRp/09y9+Zpbk sidebar_class_name: "post api-method" -info_path: docs/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api +info_path: versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Complete a user task

+ Completes a user task with the given key. -## Request - -

Path Parameters

Body

    variables objectnullable
    - -The variables to complete the user task with. - -
- -The user task was completed successfully. - -
- -The user task 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 user task with the given key was not found. - -
- -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}}>
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx index c07bf7f8421..07546761dbf 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx @@ -5,44 +5,143 @@ 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: eJy1Vttu2zgQ/RWCT7uAEzndlyJvqesGXvQSJO4utoEfKHkss6VELUk5dQX/+86QlCXbai5AFzBgiRqeM8M5M8OGO5FbfnnPJ6q2DgxfjPgSbGZk5aQu+SX/lDohS8vcGlhWGwOlY05XWul8y/QqrIfN/jkXDh7ElknLKmEcmpzzETdgK11aQK6GvxqP6e//4Ml06XAnwYuqUjITBJ98tcTRcJutoRCn5HMEbF0kMtFRG/i3BusI3G0rQGOdfoXM4XtldAXGyRBVavQ3MPYU/IopaclBFk3Qf+GYMNB6jgsYRoyuxySMEVt8LWulRKpwyZkaRlw6KAaIbozeSFxislxpU/jQGf5EJGalXsLTgZDVbDl8SHUp8TjYbw8SXSbk6PTvHpvN3jJk9vkJlD02iZnJUWEjHpwLS3+84rsRX2vrhgnpSykK8LgGRIa0+TCBdQa/EVylzU/g6MszoB7zlXImCfLRVHdWrBClyGHJPGvQJL2VIesn3G3SX5zkPSXbZ+dFed/vfyL5mORWsvstzzw7o0nEx9hv/VsKofhvxcoxMmyrPgZBWRMslxsoB3lj+kccyrqglqZALKMfSukH/yhLkTmE4AtSHQjl1k/50zajYN069SwPwhZKZl12z0v0C/nRAUSg8+A3LRin1Q22CBn61WkO4mFEmwH192DfeNsZ6sQvx1K9kz8GckDY6HWK2L1GJct+331Oko+b1UHBTHRd/qQwO+5e5VCLtBWW6pKJzGhrf4E3bQkiwTvUgjbD/uAgWcm8NlipvR1s5bfEJjfYs1/iS5xhfz2W8JjpVndfAFJg12HjkPaOSHpymMeRdhsHHYpiR98LcGuNJc9z8E1BUE3wpJ2AuGTBbPxou294bRR+bcIk3V0mSUMtenfZUGvdJZsLtN8II8kH31a63r4StaLzUDoTyi8fXzYOOr6fw0fxHjT3Fu/1+PV4EMp3+4ODu53ezdnVzYyFkDxg/1LQQq6dqwYhg/FToLvdgk4NW4d02zvaEu8IgJI2V3XoOjF1kcsj03swwpXw8K6V0Z9/z30dU+P322NeD53gvQbCx+cXJ1GQo6TfTBcFdnQSNo5BGhm9kHq6Ru0DqYVuBqLoCCdhv9uy98GCRR2zC88ahELBWVRJjvh1eo6kSSZw31IkPwgmSZVOkwKvfkkkssmX6fTN9Gzy6cOHzx9n83/O3s8m04930zPEPXffnT+EClWCg7Xn1TW47oLYafcg+Ka7IP6iC2fMoYPvLqkUApKifOhNrKR7vvdm0d507nnTpMLCZ6N2O1rGuWq2uL7oiofewpCiKUal9w22lL8sg8r5KlO1vzAcX3RJfPuivp6Sav4D0YQjZg== +api: eJy1Vttu2zgQ/RVinnYBJUq6L4Xe0sQNvOglSNxdbAM/UNJYYiuRCkk59Qr698WQlC3bai5A1y+S6OE5MzxzYQeWFwaSe7isWmNRwzKCHE2mRWOFkpDA59RyIQ2zJbKs1RqlZVY1qlLFhqmVX/eb3XvBLT7yDROGNVxbplanEIFG0yhp0EDSwZuzM3r8HzyZkhalJXjeNJXIOMHH3wxxdGCyEmt+TL4okQ0uEhnfUWt8aNFYArebBiEBlX7DzEIEjVYNait8VKlW31GbY/ALVglDDrJgwmzJLeMaB8+ZLYUZohsxca35BiKQbVXxtEJIrG4xAmGxniC60WotcjRMyJXStQudKcl4IGZS5fh8IGQ1z6cPqZXioUX226OwpSDk4PTvDpvNr9hKeX085YhNSIsFaojAO+eX/ngDfQSlMnaakP6RvEaHq5FnpZDFNIGxWsiC4BqlfwJH/7wA6ilfSTNBkE9KvbNiNZe8wJw5Vp+T9CW96kfcg+ivFnlLybbqvEr37f5nxJ9fbVN2u+WFZ6cVJfEh9pX7StEX/y1fWUaGQ9WHIEg1zgqxRjnJG+SPAGVbU0urkOfBj6pSj+5VSJ5ZsUZYUtYhr2z5nD9DM/LWg1Mv8sBvITFbuXvPkeew7PsIrLB0HnAzgAGtrlEb4fvVsQbhMILNRPaPYN8527lcKbccSvVO/DuhAWHLtk5RjxuVkOO++xKRD5vVXsFcqlb+pDB33KPKoRZpGo08ZzzTyphf4M1QgkLJ9zyzSk/7kym5EkWrMWejHWzltoQmN9mzX+NLmGF/PSV4UHrIu6+IKbJrv3Eq9w5IRumwCCPtNgw66OkXQY22VDkkUKBrCpxqAuJhAkIEBvXajbb7DlpdQQKdn6R9Escdteg+6ai19vH6HCJYcy3IB9dWdr19xduKzqNSGa/c8uFlY6/juzl8EO9ecx/w3p69PZuEct1+7+BuZ3cLdnEzZz4kBzi+FAyQpbXNJKQ3fg6075d0almrhd3c0ZZwR0CuUV+0vusE6QKXQ6ZvbwRReHk/pNGffy9cHVPjd9uDrvtOwKiBwNnp+VEU5Cjlb6bqupUusWXhRsYopFFeVyJDyha6GfB6R3jp99sN++AtWMhjdu5YfaJQcCaJ40LYsk1PM1XHGa9bmfPtM61UGtdcyDhQmfjrbPZudnL5+ePHL5/mi39OPswvZ5/uZifnp+en9od1x9AoY2suR35do91dEXfZuxd+t7si/qIrZ1DR4g8bNxUXknLKBd+FWrqHrTfL4a5zD12XcoNfdNX3tPzQot5Acr/clQ99+TFFc4yK7ztuSMEsw8a6Oqtad2U4vOpS+m3L+npGefMfQ+wkNA== sidebar_class_name: "get api-method" -info_path: docs/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api +info_path: versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get cluster topology

+ - + Obtains the current topology of the cluster the gateway is part of. -## Request + -
+ -Obtains the current topology of the cluster the gateway is part of. - -
Schema
    brokers object[]nullable
    - -A list of brokers that are part of this cluster. - -
  • Array [
    • partitions object[]
    - -A list of partitions managed or replicated on this broker. - -
  • Array [
  • ]
  • ]
+ diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.js b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.js deleted file mode 100644 index 25b13ac45ac..00000000000 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.js +++ /dev/null @@ -1,48 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/zeebe-api-rest/specifications/zeebe-rest-api", - }, - { - type: "category", - label: "Cluster", - items: [ - { - type: "doc", - id: "apis-tools/zeebe-api-rest/specifications/get-cluster-topology", - label: "Get cluster topology", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "User task", - items: [ - { - type: "doc", - id: "apis-tools/zeebe-api-rest/specifications/complete-a-user-task", - label: "Complete a user task", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/zeebe-api-rest/specifications/assign-a-user-task", - label: "Assign a user task", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/zeebe-api-rest/specifications/update-a-user-task", - label: "Update a user task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/zeebe-api-rest/specifications/unassign-a-user-task", - label: "Unassign a user task", - className: "api-method delete", - }, - ], - }, -]; diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.ts b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.ts new file mode 100644 index 00000000000..909b802299c --- /dev/null +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.ts @@ -0,0 +1,54 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api", + }, + { + type: "category", + label: "Cluster", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/zeebe-api-rest/specifications/get-cluster-topology", + label: "Get cluster topology", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "User task", + items: [ + { + type: "doc", + id: "version-8.6/apis-tools/zeebe-api-rest/specifications/complete-a-user-task", + label: "Complete a user task", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/zeebe-api-rest/specifications/assign-a-user-task", + label: "Assign a user task", + className: "api-method post", + }, + { + type: "doc", + id: "version-8.6/apis-tools/zeebe-api-rest/specifications/update-a-user-task", + label: "Update a user task", + className: "api-method patch", + }, + { + type: "doc", + id: "version-8.6/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task", + label: "Unassign a user task", + className: "api-method delete", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task.api.mdx index b9b6246ae24..0f94a3833e8 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task.api.mdx @@ -5,51 +5,145 @@ description: "Removes the assignee of a task with the given key." sidebar_label: "Unassign a user task" hide_title: true hide_table_of_contents: true -api: eJztV01z2zYQ/SsYnJKpJcqpmya6qY7SurUTjyy107g6gORKQkwCDD4kqxz+9+4SpL5bdzI5+uAxAe6+t4vdBy1L7sTc8v49n1gwzAn7wKdnPAWbGFk4qRXv8xHkegmWuQUwYa2cKwCmZ0zU9mwl3aJ+N5dLUOwB1l1+xgthRA4ODKGXXOECoTyyjNHpN1ijjST0QrgFPhv44qWBlPed8XAYwhjhEZhYicm3wRKTTRaQC94vuVsXRCKVgzkYfDXTJhcubL2+4FU1JSJbaGXBkser3gX9OybbMLCVsMyrJu+UWZ8kYO3MZxnmWZ3xi17vSYijE2KJUEo7FsMOdpfdaAMsBSdkZpnA58LopUyRVqoaoA2exTpdd/9SmGOiMV3lKAZRFJlMBMUQoWecQf7dZ0sBlTuntB/pgN0Gy4aX6fgzJA4LzYJhHNjvR+8v2duLH36cvlg4V9h+FK1Wq66ZJR1IpdOmq808wiX9kd3LLsNTwBxysaY8RYpmyCkyyqoA4yT2lC0gkTOZMKfrBJuwGZUy5NcUNYRFjbVx3pZ8U3rrjFTz3cp7I/lhNw3YZHTF8FyVk7M1OhxT1z4z4TPCELH2rh9nQj1QxZ102UnSQxbr81yYTdfuEyCQdcJ5+2Tnfv/qCJv665fx+JYFCJboFBj6II+0LRElkUslc5/zPrYprsRjWL3u9SrCpIr/j0wUg8cC069b6zAdbI5827d1YlJhXCr5VpXRRs7lIS8SbWvBmyZ+FzKqqqpW5tPiPlYm6Z2kOdNepY3C334FDtahEe3KaEyEKgUs8cZgcnh3PIv9WezPYv9GYseXOGwsNI4PSJLh3FGPIDhZ9HlEMu2QTG1U7gwgVdQOMzREgFm2s4o3eEy8DCKqsPfLhbau6peFNq6KludovxRGCgyiLii9DmJrmyjTicjq7VPFpBc0EIUh6hMAKuZnvB1WIowUxLOP96b3pncSikzbswpAo+HdmA1ur1hIKfTezn3QQpKwT0IG46dA61nKAt5n0q3vyCWcRQx4lZmBp6Pf9EPDVSPTOhjhTnh433bJr3+M60JLNdO1e1Pw/SDo+LFWIeJe9/y4sTBQ0kei89yr+pLE5trc0QEtybx1lMoZx3sU8J4lxmZODSaXwd+t2XWwYL8HXnZes4ZGaW/IOeL7uIukUSLQLxXR3wQTxZmOo1xIFTVENvo0HP407Fx+vLmZfLga/9m5vrocfrgbdhC36x5dfQgFdkku1E5Uk2ZUxKbZ/PQcJl9ufyO+bnBvSubg0UV4DeCMXjWZlo2i7vlWUejQ3x/qN6LC/gjCuOdlGQsLE5NVFW1/8WDWuD/d6qgWXiotPaOIZyKzhx8Bu5m9GDWfCy/Zf30anMyl2RRqXes487TCRwQ5+EKppmi+AJFir1J8wWKAHwCF2/H9119iksjmWno3vB6Oh1jZfwDR0aEr +api: eJztV01z2zYQ/SuYPSVTmpRTN014cx2ldWunHltup3F1AMGliBgEGHxI5nD43zsAqA9Lbt3J5JiDhiK5eG8X+x657MHShYH8Dm4NamKpuYd5AiUapnlruZKQwzU2aomG2BoJNYYvJCJRFaEhnqy4rcO9BV+iJPfYpZBASzVt0KL26D1I2iDk4AzqGTX3v2EHCXCP3lJbQwIaPzuusYTcaof7Kcxq9MCe1TO5dbKeybAaGwp5D7ZrPQmXFheoIYFK6YbaeOn1CQzD3BOZVkmDxq94NTnxh0OyDQNZUUOcHOsuiXGMoTGVE6JLYUjgZDJ5FuJghwijUipLCtzBTsml0khKtJQLQ6hG0mq15CWWhMsAsE6eFKrs0r8lJMCUtCitz4G2reCM+hyyVqtCYPPdJ+MT6nd26XGmp+QqRo68RBWfkFlCDYmBRWS/u35/Rt6e/PDj/EVtbWvyLFutVqmu2BGW3CqdKr3IdMX8z8e9TMmsRo2koZ2vk5Yl95xU+Kpa1JajIaZFxivOiFWhwDFt4lsZ6xubGtPywtos3rZ803pjNZeL3c47zWFfTafk9vqc8BKl5VXH5eKQOqypqBMegxbK2bwQVN77jltuxZOk+yzGNQ3VG9U+JhgSMJZaZ55V7vevDrC9vn6Zza5IhCBMlUgqpYmtuVkT+SIaLnnjGshPJpMEGvoQz15PJoPH9B3/H5VIgg+toDJIa78cLkmz1W0ojEtjqWRfqzNK8wXf501h2PYCRhG/ixUNwxCc+by5D53p/e6tWSkny9Hhb78Ah5u1aVdayUXoFBLmtEZpRffN7N/M/s3sX8vsQwIN2lqVkEOJAi2GEcTWkEPmbXrkbWqyfmcAGbL1MOOHCNTL9azitIAc+miiIc+yvlbGDnnfKm2HbHkMCSyp5rQQUZf+djTbWkRCMSrC5aea6W/4gSgOUR8RCyQ/U4srGkcKz/MY783kzeRJKB+63qsIdD29mZHTq3MSS4ra23kerCG9sZ+EjMHPgYZZyiBzmtvuxi+Je1Eg1ahPnd/6jR5GroDsz2MQJOOf92uV/PrnLDSay0qF5WPDHyfhtx+1iRlP0uNDYV2dB38w1TROhoekXGyf0RGNCWesLyUBwRlKEwQ8zqkx5Cyutx25iBHkj8hLjgNrFMr6CbngtnZFylSTMdo4WdLNsRCqyBrKZTZSmezjdPrT9Ojs98vL2w/ns7+OLs7Pph9upkfH6XFqH2zYhlYZ21C5k9ftOCwSun357Jffb98SXza6j02z+GCzVlAuvYRCrf3oqTvYegoSyB+P9RtbzZPRGnfQ9wU1eKvFMPjLnx3qDvK7+dZJwXolN/5/CXlFhdn/DNit7MX1+MHwkvzXx8GTtYwXqeyCk4XzZ5DAPXZ73yjDfEigRlqiDvnFiFPGsLU7a//1XexNsnkwvZteTGdTGIZ/AFgoofk= sidebar_class_name: "delete api-method" -info_path: docs/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api +info_path: versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Unassign a 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. - -
- -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}}>
+ diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/update-a-user-task.api.mdx b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/update-a-user-task.api.mdx index 71af92194c3..3cbf8ae7b3d 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/update-a-user-task.api.mdx +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/update-a-user-task.api.mdx @@ -5,69 +5,211 @@ description: "Update a user task with the given key." sidebar_label: "Update a user task" hide_title: true hide_table_of_contents: true -api: eJztWFlz2zYQ/isYvjRprcOOkyZ6UxQldZrDI0vtNJZnDJKghIQEWACUrGr037uLpUTqcOym6Uwf7DgeksDe+y0Wuwwcn9igcxmMrDDMcfsluDoKYmEjI3MntQo6wSiPuROMs2K9h82lmzI3FWwiZ0KxL2LRDI6CnBueCScMclwGCl6AHKmGQPSrWMAeiRxz7qbwbMSfhTQiDjrOFGJX7BDYA2OmEy+pEu40K7xKKNNGU5HxoLMM3CJHcVI5MREGlhJtMu7o07PTYLW6IpHCupc6XiBNpUHCUwsqRBrIlcM1nuepjDhq0/psUaXlvjQdfhaRQ9uNzoVxUlhcjaZcTYQVxChNPybeI9sGvr34+IERA3IoUcVkJXfOyLAAx894Cjo3x2qs0CeJTlM9l2pSbbEs4oqFEKP4c2EdsCgDJC0TKs41eOAIFmOJonlaoxyruUxTpJUTpcEVHZTzI7sGjrFEL78xusjtNWswgxaxcMHA2JmMvQqKiSx3C5ZK67bpMKPuTxYX4hUQ3bX/AvRWE09Bfhjl/4RsrM5ri2VuaSvqrvSu4+xaFWl6Tc5n2jCdSeeQTjqQALLMDL2HqQmBt9K7fcPmB0uUm6hxa8HBQmCklHZ3BgvS3ad919NRSqxXm8jS77aFweBrYzCJBGAR/mYSaLSCRDE1sZSRQArJupu8VWac19KYQLmd2GWYagiw3rV1uGHwG04C+A9BGjgwX09KXKNlTTa4M3gIdgwJD1NBuq1QZpUD/0InYtMo8u+n2TYMarpxY/jioBaIBZS9IfU1z95fHWSAykgnMrvvjtXX1CSUf6OeE0/8HyoKX5x0+Br0NqV1tXdSPVTUh4r6/6ioe0DjEeXobhPQZRGorDNGG0rvuCnHDKY04lEkQChwY4mBnVUn5NWzGKci9Z7061t2M6lmmrqYJjtLGHqKwiniI/S8lxKLhAMLbK3GATVX42DLsk1JvR2Zo7LRo35xQJ0WtF24B1TMtbJ0iJy0T/cdMdzq8ebclk1ezGzhHZCAYGgzgdlpu30n/V6DWkuTknGTvQd4gu2Oy9QyDs9rz4DXPPVabRZCw0j+uKVDBEpwSvbTfqe4G+9z2lnKXZcrsJc2hiT9cvC6x16cPv356tHUudx2Wq35fN40SdQQUHS0aWozacEr/sd9j5sMXAA2ZHxBWNjUpuoIZzYXkUxkhJH2QCuVwSgfzuTt859Wv3LQFkbuHRpdNhqcMfCrcjJZYJ7uifY0Pgfx6Al14TphytWXoMqvfaG7UmyRZdxsbgzbAoCRddwV9s67wpOTg8feL8PhOSMWUB9i4auBx1opCI3IpJJZkQUdyFF44zf09qzdXiFPjPg9LIEie5OD+T61ds2B5MiqvPWGSQV6qeh7RUYbOZG7ckFQDetlEr8iiwjjp/eA9T4sEemIy0QXKi7h/eIb+EAcStDOjQZDMFJQpAso5MpB4XgA+wPYH8D+ncAOi5mAPi+mYU409dMfN4XXFqK0gSi1rWVt9rPCYQ22eOV0qDDgnGBJ0FlBxi+hbXSrzjLXxq1as2PYP+NGYq/hw4jLBLF16qTQ2KT+86EQ4gKOoNA0zj4JATh5AzVhzqmLQDnb/J63n7cPssKtaw8Ro0H/Ysi652eMTKKMq1WBNUuE80GWtPkupn5mZQVUMekWF0hCvggFFDDTLdDjmywoZXnO+E6b4As9vF7nxtvfhz68WL0G1Tysf8OznLC3Nb7aXPmhbzs5bbTh98nwpN05OekcP28+aT/9FOxexL+2c/difLnO3qsDt9FqsdZC166JUiXae6DM1G0/YgbhRcITtZvH+4gAXyOwI51lhfLVHVCxOVyIW5TincIg4OEAgBuCd1E53KQtPaKHa9E72sF+I7ns2EulXF+X9gnwL8ImCG1FHOhi3voL2bTCVIetjEvVKgXZ1qd+/2W/0fv4/v3ow9nwj8a7s17/w0W/AXyb7sb5OOaQ6BlXNa32J7a7pi+ro+3+890yz5y4cS2oWFJhCLxtyxL9l0GFfiDo1Ge/EF+C8GWwXIbcipFJVyv8DCloFvD9qkI8jUulxedqOnurCY8G5SD3Mbvf2PigKevJh1r42gMXMXiDR2C3M8deYT5OBY8BX6gp7eiRPo0h8qk47A2SV0drii7cbHJ3y96tLgMLwabknneHvV8Q2OUYO4MTCj4bPsepOvztBGP4By/aO8vXDP99GcBJMyn4BPcTY/z5G77OagE= +api: eJztWOtv2zYQ/1cIflm7ybKdpS99S9O0S9dHkDgb1iRAKelss6FIlQ87gqH/fThStuRHmqzrgH1IgCCxee+73/F4C2rZxNDkgp4b0MQyc02vIpqDyTQvLVeSJvS8zJkFwohb0pA5t1Nip0AmfAaSXEMV04iWTLMCLGiUuKCSFUATilwjZq5/h4pGlKPEktkpjaiGr45ryGlitYNNtaMpoGCixl5Tq9wq4rxJqNNkUygYTRbUViWq49LCBDSN6Fjpgtnw1dN9WtdXQSUY+1LlFfK0FoyZMBDRTEkL0uIZK0vBM4bW9L8YNGmxrU2lXyCz6LtWJWjLweBpNmVyAgaCICE+jn1E1h18e/bxAwkCQkADVx68ZNZqnjoLZMaEAxNfykuJMRkrIdScy0lLYkjGJEmBsPyLMxbyZYK4ISDzUnFpI8LynKNqJjqcl3LOhUBePpFKQ56gnp/J54zJnGOU32jlSvOZ9IhGj0hakVKrGc+9CZJAUdqKCG7sOh9W1P3ZcgevmIW76M+s5nLiOUIczst/wnYpTzqHTW0pA91Q+tAx8lk6IT6H4BOliSq4tcjHLSlRl55h9LA0S9CG+7CvxPxkAucqa8wYPpEAmCmp7J3JcgZ82R94vlASy9MYRXpq4zQmX2mNRQQzkJZAwY3hSpKx0h21oSLjS0mjreJtK+OkU8YBlOuF3aSpgwDjQ9uFGya/Z3kBdBekcwfE95MG1+hZTE7vTB6CHVPCUgHBthp1tjXwL2wKYnqu/HGWrcOgYxvTmlU7rUAsoO4Vq+955v7moAA0hlsozHY46m+ZGVD+nXZOPPN/aGgdUcstfqSHq9Zab91UDx31oaP+PzrqFtBYFmp0cwg4IJkzVhUkEDTRsVOGFRzKiGUZGMNTAWSsVdGZhLx5BvPkhI+kP1/zm3A5U2GKicnxmGCkQjohjzDyXksOY+aExdHqkobh6pKuebZqqbcj87wZ9MK8eBomLVrXSKPBlEqacInsDfa3AzFam/HmzDRDXk6M8wEYOyGqGJvD/mBwJ//WgNopk0ZwTN4rDSQHy7gwhGlYRYZw6bmXZpNU5VWIxy0TYqlVKqD4ZXtS3Mz3SaBs9C7bFTMkEKZB+8Xp60PyYv/Js6tHU2tLk/T78/k81uOsBzm3SsdKT/p6nOEv0j2OyWgKGkjBqoCFVW9qr3BiSsj4mGeYaQ+0xhjM8u5KXr//w+k3Llqn+dalcUDOT48Jz0FaPq6wTrdUex5fg3j1pMrZJBVMXtO2vraVbmoxriiYXr0Y1hXUETWWWWfufCv8urfz2vttNDohQQTJVA6+G3isNYrQiYJLXriCJvuDQUQLdhM+PR0MapSJGb+HJ5LATSmY9KW16Q6XpGjr1jvGpbFMZj8qM0rzCd/UG9Mu1psifhU8Chjfvwest2GJSEdcjpWTeQPvF98hh5slaOdayYnPFJDMaQ3SiuoB7A9gfwD7jwJ7HdEC7FTlYZmTTf32x05pQvuI0h6i1PQXnd1PjcsaHPGa7ZDTgiZ0EaBTJ/3+YqqMrZNFqbSt+7MhjeiMaY6zhk8jHgeILUtHqIwJ//WuFOIBrqDQNUY+AaRA3jALcxamCNSzLu/54PlgpygkXUYoCDo9OhuRg5NjElwKFdfpAkuRCOedIgPxXUL9zspA5jS31RmyhFikwDToA4cRX1VBo8tLxs+BiEbNP6+XtfH2z5FPL3av03YfdnTDijJgb219tXry073B3n5v8Ky392I0fJI8GSZ7z+PBs+EnuvkQ/xbl5sP4Ylm9Vzteo+1hZ4TuPBO5HCsfgaZS1+OIFYQPCc80iIfbiDg59sDOVFE46bu7nLSXS5CWCXxTaAS84BlI40PULDcDyWHgtxV5FyjIH0EvGXqtodaXrX3C7dSlcaaKfsYKJ3O2+psKlfYLxmW/UWX6n46OXh71Dj++f3/+4Xj0V+/d8eHRh7Oj3jAexvbG+kyWytiCyY5d2zvbTecX7eV2/w1vU2kWbmy/FIxLTIL3btHg/4K2+KcRTbrb36uoAfEFXSxSZuBci7rGr7860BVNLq5azIeFKTf4f7ufvdWFR6fNKvcxud/ieKcry92HrHz3EQ4/0YheQ7Wxya6xIqfActDe0kBxGOzpjVBOK2FrlVxHS46DLIPS3kK7NmdgK1g13ZOD0eFvCO1mkV2oHJk1m+Nenc2D2coHyncM/92CCiYnjk2QNgjFn78B1Ftp9w== sidebar_class_name: "patch api-method" -info_path: docs/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api +info_path: versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update a user task

+ Update a user task with the given key. -## Request - -

Path Parameters

Body

    changeset objectnullable
    - -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. - -
- -The user task was updated successfully. - -
- -The user task with the given key cannot be updated. 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. - -
- -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}}>
+ + + + + + + diff --git a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api.info.mdx b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api.info.mdx index 66890419109..171c1bc1269 100644 --- a/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api.info.mdx +++ b/versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Zeebe REST API

+ API for communicating with the Zeebe cluster.
-

- Authentication -

+