diff --git a/api/console-sm/console-sm-openapi.yaml b/api/administration-sm/administration-sm-openapi.yaml similarity index 98% rename from api/console-sm/console-sm-openapi.yaml rename to api/administration-sm/administration-sm-openapi.yaml index dd81c4cb7d1..4e5c73fef9f 100644 --- a/api/console-sm/console-sm-openapi.yaml +++ b/api/administration-sm/administration-sm-openapi.yaml @@ -155,8 +155,8 @@ components: scheme: bearer bearerFormat: JWT info: - title: Console SM Admin API - description: Access the administration API of Console SM. + title: Administration API (Self-Managed) + description: Access the administration API of Console Self-Managed. version: 1.0.0 contact: url: https://www.camunda.com diff --git a/api/console-sm/generation-strategy.js b/api/administration-sm/generation-strategy.js similarity index 56% rename from api/console-sm/generation-strategy.js rename to api/administration-sm/generation-strategy.js index 2ebe0da279d..3d0908043a2 100644 --- a/api/console-sm/generation-strategy.js +++ b/api/administration-sm/generation-strategy.js @@ -1,15 +1,17 @@ const { makeServerDynamic } = require("../make-server-dynamic"); const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); -const outputDir = "docs/apis-tools/console-sm-api/specifications"; -const specFile = "api/console-sm/console-sm-openapi.yaml"; +const outputDir = "docs/apis-tools/administration-sm-api/specifications"; +const specFile = "api/administration-sm/administration-sm-openapi.yaml"; function preGenerateDocs() { makeServerDynamic(specFile); } function postGenerateDocs() { - removeDuplicateVersionBadge(`${outputDir}/console-sm-admin-api.info.mdx`); + removeDuplicateVersionBadge( + `${outputDir}/administration-api-self-managed.info.mdx` + ); } module.exports = { diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml index 576639f483b..18390c8a3f3 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/api/camunda/camunda-openapi.yaml @@ -10,7 +10,7 @@ info: 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/ + url: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview/ servers: - url: "{schema}://{host}:{port}/v2" @@ -26,6 +26,7 @@ servers: description: The schema of the Camunda 8 REST API server. tags: + - name: Authentication - name: Authorization - name: Clock - name: Cluster @@ -35,9 +36,11 @@ tags: - name: Document - name: Element instance - name: Flow node instance + - name: Group - name: Incident - name: Job - name: License + - name: Mapping rule - name: Message - name: Process definition - name: Process instance @@ -46,6 +49,7 @@ tags: - name: Signal - name: Tenant - name: User + - name: Usage metrics - name: User task - name: Variable @@ -82,6 +86,32 @@ paths: $ref: "#/components/schemas/LicenseResponse" "500": $ref: "#/components/responses/InternalServerError" + + /authentication/me: + get: + tags: + - Authentication + operationId: getAuthentication + summary: Get current user + description: Retrieves the current authenticated user. + responses: + "200": + description: The current user is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/CamundaUser" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/CamundaUserNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/CamundaUser" + "401": + $ref: "#/components/responses/Unauthorized" + "500": + $ref: "#/components/responses/InternalServerError" + /jobs/activation: post: tags: @@ -103,6 +133,12 @@ paths: application/json: schema: $ref: "#/components/schemas/JobActivationResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/JobActivationResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/JobActivationResponse" "400": description: > The provided data is not valid. @@ -362,6 +398,12 @@ paths: application/json: schema: $ref: "#/components/schemas/TenantCreateResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/TenantCreateResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/TenantCreateResponse" "400": description: The provided data is not valid. content: @@ -369,11 +411,7 @@ paths: schema: $ref: "#/components/schemas/ProblemDetail" "403": - description: Forbidden. The request is not allowed. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" + $ref: "#/components/responses/Forbidden" "404": description: Not found. The resource was not found. content: @@ -411,6 +449,12 @@ paths: application/json: schema: $ref: "#/components/schemas/TenantUpdateResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/TenantUpdateResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/TenantUpdateResponse" "400": description: The provided data is not valid. content: @@ -418,11 +462,7 @@ paths: schema: $ref: "#/components/schemas/ProblemDetail" "403": - description: Forbidden. The request is not allowed. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" + $ref: "#/components/responses/Forbidden" "404": description: Not found. The tenant was not found. content: @@ -432,12 +472,12 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - delete: + get: tags: - Tenant - operationId: deleteTenant - summary: Delete tenant - description: Deletes an existing tenant. + operationId: getTenant + summary: Get tenant + description: Retrieves a single tenant by tenant Key. parameters: - name: tenantKey in: path @@ -447,22 +487,30 @@ paths: type: integer format: int64 responses: - "204": - description: The tenant was deleted successfully. + "200": + description: The tenant was retrieved successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/TenantItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/TenantItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/TenantItem" "400": description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" "403": - description: Forbidden. The request is not allowed. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" + $ref: "#/components/responses/Forbidden" "404": - description: Not found. The tenant was not found. + description: Tenant not found. content: application/problem+json: schema: @@ -470,49 +518,33 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}/completion: - post: + delete: tags: - - User task - operationId: completeUserTask - summary: Complete user task - description: Completes a user task with the given key. + - Tenant + operationId: deleteTenant + summary: Delete tenant + description: Deletes an existing tenant. parameters: - - name: userTaskKey + - name: tenantKey in: path required: true - description: The key of the user task to complete. + description: The unique identifier of the tenant. 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. + description: The tenant was deleted successfully. "400": - description: > - The user task with the given key cannot be completed. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "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. + description: Not found. The tenant was not found. content: application/problem+json: schema: @@ -520,48 +552,41 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}/assignment: - post: + /tenants/{tenantKey}/users/{userKey}: + put: tags: - - User task - operationId: assignUserTask - summary: Assign user task - description: Assigns a user task with the given key to the given assignee. + - Tenant + operationId: assignUserToTenant + summary: Assign a user to a tenant + description: Assign a single user to a specified tenant. parameters: - - name: userTaskKey + - name: tenantKey in: path required: true - description: The key of the user task to assign. + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The unique identifier of the user. 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. + "202": + description: The user was successfully assigned to the tenant. "400": - description: > - The assignment of the user task with the given key cannot be completed. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "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. + description: Not found. The tenant or user was not found. content: application/problem+json: schema: @@ -569,48 +594,40 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}: - get: + delete: tags: - - User task - operationId: getUserTask - summary: Get user task (alpha) - description: | - Get the user task by the user task key. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - Tenant + operationId: removeUserFromTenant + summary: Remove a user from a tenant + description: Removes a single user from a specified tenant without deleting the user. parameters: - - name: userTaskKey + - name: tenantKey in: path required: true - description: The user task key. + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The unique identifier of the user. schema: type: integer format: int64 responses: - "200": - description: > - The user task is successfully returned. - content: - application/json: - schema: - $ref: "#/components/schemas/UserTaskItem" + "202": + description: The user was successfully removed from the tenant. "400": - description: > - The provided data is not valid. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The user task with the given key was not found. + description: Not found. The tenant or user was not found. content: application/problem+json: schema: @@ -618,47 +635,41 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - patch: + /tenants/{tenantKey}/mapping-rules/{mappingKey}: + put: tags: - - User task - operationId: updateUserTask - summary: Update user task - description: Update a user task with the given key. + - Tenant + operationId: assignMappingRuleToTenant + summary: Assign a mapping rule to a tenant + description: Assign a single mapping rule to a specified tenant. parameters: - - name: userTaskKey + - name: tenantKey in: path required: true - description: The key of the user task to update. + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: mappingKey + in: path + required: true + description: The unique identifier of the mapping rule. 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. + "202": + description: The mapping rule was successfully assigned to the tenant. "400": - description: > - The user task with the given key cannot be updated. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "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. + description: Not found. The tenant or mapping rule was not found. content: application/problem+json: schema: @@ -666,52 +677,40 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}/form: - get: + delete: tags: - - User task - operationId: getUserTaskForm - summary: Get user task form (alpha) - description: | - Get the form of a user task. - - Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. - Furthermore, this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - Tenant + operationId: removeMappingRuleFromTenant + summary: Remove a mapping rule from a tenant + description: Removes a single mapping rule from a specified tenant without deleting the rule. parameters: - - name: userTaskKey + - name: tenantKey in: path required: true - description: The user task key. + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: mappingKey + in: path + required: true + description: The unique identifier of the mapping rule. schema: type: integer format: int64 responses: - "200": - description: > - The form is successfully returned. - content: - application/json: - schema: - $ref: "#/components/schemas/FormItem" - "204": - description: > - The user task was found, but no form is associated with it. + "202": + description: The mapping rule was successfully removed from the tenant. "400": - description: "Bad request" + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" - "401": - $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: "Not found" + description: Not found. The tenant or mapping rule was not found. content: application/problem+json: schema: @@ -719,82 +718,127 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}/assignee: - delete: + /tenants/{tenantKey}/groups/{groupKey}: + put: tags: - - User task - operationId: unassignUserTask - summary: Unassign user task - description: Removes the assignee of a task with the given key. + - Tenant + operationId: assignGroupToTenant + summary: Assign a group to a tenant + description: Assign a single group to a specified tenant. parameters: - - name: userTaskKey + - name: tenantKey in: path required: true - description: The key of the user task. + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: groupKey + in: path + required: true + description: The unique identifier of the group. schema: type: integer format: int64 responses: - "204": - description: The user task was unassigned successfully. + "202": + description: The group was successfully assigned to the tenant. "400": - description: > - The user task with the given key cannot be unassigned. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The user task with the given key was not found. + description: Not found. The tenant or group 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. + "500": + $ref: "#/components/responses/InternalServerError" + + delete: + tags: + - Tenant + operationId: removeGroupFromTenant + summary: Remove a group from a tenant + description: Removes a single group from a specified tenant without deleting the group. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: groupKey + in: path + required: true + description: The unique identifier of the group. + schema: + type: integer + format: int64 + responses: + "202": + description: The group was successfully removed from the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or group was not found. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/search: + + /tenants/search: post: tags: - - User task - operationId: findUserTasks - summary: Query user tasks (alpha) - description: | - Search for user tasks based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - Tenant + operationId: searchTenants + summary: Query tenants + description: Retrieves a filtered and sorted list of tenants. requestBody: required: false content: application/json: schema: - $ref: "#/components/schemas/UserTaskSearchQueryRequest" + $ref: "#/components/schemas/TenantSearchQueryRequest" responses: "200": - description: > - The user task search result. + description: The tenants search result content: application/json: schema: - $ref: "#/components/schemas/UserTaskSearchQueryResponse" + $ref: "#/components/schemas/TenantSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/TenantSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/TenantSearchQueryResponse" "400": - description: > - The user task search query failed. - More details are provided in the response body. + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found content: application/problem+json: schema: @@ -802,27 +846,18 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}/variables: + /user-tasks/{userTaskKey}/completion: post: tags: - User task - operationId: findUserTaskVariables - summary: Query user task variables (alpha) - description: | - Search for user task variables based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + operationId: completeUserTask + 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. + description: The key of the user task to complete. schema: type: integer format: int64 @@ -831,18 +866,28 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/UserTaskVariableSearchQueryRequest" + $ref: "#/components/schemas/UserTaskCompletionRequest" + responses: - "200": + "204": + description: The user task was completed successfully. + "400": description: > - The user task variables search response. + The user task with the given key cannot be completed. + More details are provided in the response body. content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/VariableSearchQueryResponse" - "400": + $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 variables search query failed. + 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: @@ -851,39 +896,47 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /variables/search: + /user-tasks/{userTaskKey}/assignment: post: tags: - - Variable - operationId: findVariables - summary: Query variables (alpha) - description: | - Search for process and local variables based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - User task + operationId: assignUserTask + 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: false + required: true content: application/json: schema: - $ref: "#/components/schemas/VariableSearchQueryRequest" + $ref: "#/components/schemas/UserTaskAssignmentRequest" responses: - "200": + "204": + description: The user task's assignment was adjusted. + "400": description: > - The variable search result. + The assignment of the user task with the given key cannot be completed. + More details are provided in the response body. content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/VariableSearchQueryResponse" - "400": + $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 search query failed. + 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: @@ -892,48 +945,50 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /variables/{variableKey}: + /user-tasks/{userTaskKey}: get: tags: - - Variable - operationId: getVariable - summary: Get variable (alpha) + - User task + operationId: getUserTask + summary: Get user task description: | - Get the variable by the variable key. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Get the user task by the user task key. parameters: - - name: variableKey + - name: userTaskKey in: path required: true - description: The variable key. + description: The user task key. schema: type: integer format: int64 responses: "200": description: > - The variable is successfully returned. + The user task is successfully returned. content: application/json: schema: - $ref: "#/components/schemas/VariableItem" + $ref: "#/components/schemas/UserTaskItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/UserTaskItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/UserTaskItem" "400": - description: "Bad request" + description: > + The provided data is not valid. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" "401": $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: "Not found" + description: The user task with the given key was not found. content: application/problem+json: schema: @@ -941,33 +996,47 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /clock: - put: + patch: tags: - - Clock - operationId: pinClock - 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](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - User task + operationId: updateUserTask + 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: true + required: false content: application/json: schema: - $ref: "#/components/schemas/ClockPinRequest" + $ref: "#/components/schemas/UserTaskUpdateRequest" responses: "204": - description: > - The clock was successfully pinned to the specified time in epoch milliseconds. + description: The user task was updated successfully. "400": - description: The required timestamp parameter is missing or it is negative. + 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: @@ -975,61 +1044,53 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /clock/reset: - post: - tags: - - Clock - operationId: resetClock - 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](/components/early-access/alpha/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": - $ref: "#/components/responses/InternalServerError" - - /process-definitions/search: - post: + /user-tasks/{userTaskKey}/form: + get: tags: - - Process definition - operationId: findProcessDefinitions - summary: Query process definitions (alpha) + - User task + operationId: getUserTaskForm + summary: Get user task form description: | - Search for process definitions based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. + Get the form of a user task. - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: - requestBody: - required: false - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessDefinitionSearchQueryRequest" + Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. + parameters: + - name: userTaskKey + in: path + required: true + description: The user task key. + schema: + type: integer + format: int64 responses: "200": description: > - The process definition search result. + The form is successfully returned. content: application/json: schema: - $ref: "#/components/schemas/ProcessDefinitionSearchQueryResponse" - "400": + $ref: "#/components/schemas/FormItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/FormItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/FormItem" + "204": description: > - The process definition search query failed. - More details are provided in the response body. + The user task was found, but no form is associated with it. + "400": + description: "Bad request" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: "Not found" content: application/problem+json: schema: @@ -1037,151 +1098,211 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /process-definitions/{processDefinitionKey}: - get: + /user-tasks/{userTaskKey}/assignee: + delete: tags: - - Process definition - operationId: getProcessDefinition - summary: Get process definition (alpha) - description: | - Returns process definition as JSON. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - User task + operationId: unassignUserTask + summary: Unassign user task + description: Removes the assignee of a task with the given key. parameters: - - name: processDefinitionKey + - name: userTaskKey in: path required: true - description: The assigned key of the process definition, which acts as a unique identifier for this process definition. + description: The key of the user task. schema: type: integer format: int64 responses: - "200": + "204": + description: The user task was unassigned successfully. + "400": description: > - The process definition is successfully returned. + The user task with the given key cannot be unassigned. + More details are provided in the response body. content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/ProcessDefinitionItem" - "400": + $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 process definition request failed. + 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" - "404": + "500": + $ref: "#/components/responses/InternalServerError" + /user-tasks/search: + post: + tags: + - User task + operationId: findUserTasks + summary: Query user tasks + description: | + Search for user tasks based on given criteria. + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskSearchQueryRequest" + responses: + "200": description: > - The process definition with the given key was not found. + The user task search result. + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/UserTaskSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+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" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /process-definitions/{processDefinitionKey}/xml: - get: + /user-tasks/{userTaskKey}/variables/search: + post: tags: - - Process definition - operationId: getProcessDefinitionXML - summary: Get process definition XML (alpha) + - User task + operationId: findUserTaskVariables + summary: Query user task variables description: | - Returns process definition as XML. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Search for user task variables based on given criteria. parameters: - - name: processDefinitionKey + - name: userTaskKey in: path required: true - description: The assigned key of the process definition, which acts as a unique identifier for this process. + description: The key of the user task. schema: type: integer format: int64 + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/UserTaskVariableSearchQueryRequest" responses: "200": description: > - The XML of the process definition is successfully returned. + The user task variables search response. content: - text/xml: + application/json: schema: - type: string - "204": - description: > - The process definition was found but does not have XML. - content: - text/plain: + $ref: "#/components/schemas/VariableSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: schema: - type: string + $ref: "#/components/schemas/VariableSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/VariableSearchQueryResponse" "400": description: > - The process definition request failed. + The user task variables search query failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" - "404": + "500": + $ref: "#/components/responses/InternalServerError" + + /variables/search: + post: + tags: + - Variable + operationId: findVariables + summary: Query variables + description: | + Search for process and local variables based on given criteria. + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/VariableSearchQueryRequest" + responses: + "200": description: > - The decision with the given key was not found. + The variable search result. + content: + application/json: + schema: + $ref: "#/components/schemas/VariableSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/VariableSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/VariableSearchQueryResponse" + "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" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /process-definitions/{processDefinitionsKey}/form: + /variables/{variableKey}: get: tags: - - Process definition - operationId: getStartProcessForm - summary: Get process start form (alpha) + - Variable + operationId: getVariable + summary: Get variable description: | - Get the start form of a process. - - Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. - Furthermore, this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Get the variable by the variable key. parameters: - - name: processDefinitionsKey + - name: variableKey in: path required: true - description: The process key. + description: The variable key. schema: type: integer format: int64 responses: "200": description: > - The form is successfully returned. + The variable is successfully returned. content: application/json: schema: - $ref: "#/components/schemas/FormItem" - "204": - description: > - The process was found, but no form is associated with it. + $ref: "#/components/schemas/VariableItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/VariableItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/VariableItem" "400": description: "Bad request" content: @@ -1190,6 +1311,8 @@ paths: $ref: "#/components/schemas/ProblemDetail" "401": $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": description: "Not found" content: @@ -1199,169 +1322,150 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /process-instances: - post: + /clock: + put: tags: - - Process instance - operationId: createProcessInstance - summary: Create process instance + - Clock + operationId: pinClock + summary: Pin internal clock (alpha) 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. + 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. - Waits for the completion of the process instance before returning a result - when awaitCompletion is enabled. + :::note + This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change + in future releases. + ::: 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: {} + $ref: "#/components/schemas/ClockPinRequest" responses: - "200": - description: The process instance was created. + "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/json: + application/problem+json: schema: - $ref: "#/components/schemas/CreateProcessInstanceResponse" - "400": - description: The provided data is not valid. + $ref: "#/components/schemas/ProblemDetail" "500": $ref: "#/components/responses/InternalServerError" - /process-instances/{processInstanceKey}: - get: + /clock/reset: + post: tags: - - Process instance - operationId: getProcessInstance - summary: Get process instance (alpha) + - Clock + operationId: resetClock + summary: Reset internal clock (alpha) description: | - Get the process instance by the process instance key. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. + 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](/components/early-access/alpha/alpha-features.md) and may be subject to change in future releases. ::: - parameters: - - name: processInstanceKey - in: path - required: true - description: The process instance key. - schema: - type: integer - format: int64 responses: - "200": - description: The process instance is successfully returned. - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessInstanceItem" - "400": - description: The provided data is not valid. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - description: The process instance with the given key was not found. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" + "204": + description: The clock was successfully reset to the system time. "500": $ref: "#/components/responses/InternalServerError" - /process-instances/search: + /process-definitions/search: post: tags: - - Process instance - operationId: findProcessInstances - summary: Query process instances (alpha) + - Process definition + operationId: findProcessDefinitions + summary: Query process definitions description: | - Search for process instances based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Search for process definitions based on given criteria. requestBody: required: false content: application/json: schema: - $ref: "#/components/schemas/ProcessInstanceSearchQueryRequest" + $ref: "#/components/schemas/ProcessDefinitionSearchQueryRequest" responses: "200": - description: The process instance search result. + description: > + The process definition search result. content: application/json: schema: - $ref: "#/components/schemas/ProcessInstanceSearchQueryResponse" + $ref: "#/components/schemas/ProcessDefinitionSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/ProcessDefinitionSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/ProcessDefinitionSearchQueryResponse" "400": description: > - The process instance search query failed. + The process definition search query failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /process-instances/{processInstanceKey}/cancellation: - post: + /process-definitions/{processDefinitionKey}: + get: tags: - - Process instance - operationId: cancelProcessInstance - summary: Cancel process instance - description: Cancels a running process instance. + - Process definition + operationId: getProcessDefinition + summary: Get process definition + description: | + Returns process definition as JSON. parameters: - - name: processInstanceKey + - name: processDefinitionKey in: path required: true - description: The key of the process instance to cancel. + description: The assigned key of the process definition, which acts as a unique identifier for this process definition. schema: type: integer format: int64 - requestBody: - required: false - content: - application/json: - schema: - $ref: "#/components/schemas/CancelProcessInstanceRequest" responses: - "204": - description: The process instance is canceled. + "200": + description: > + The process definition is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/ProcessDefinitionItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/ProcessDefinitionItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/ProcessDefinitionItem" "400": - description: The provided data is not valid. + description: > + The process definition request failed. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The process instance is not found. + description: > + The process definition with the given key was not found. + More details are provided in the response body. content: application/problem+json: schema: @@ -1369,45 +1473,53 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /process-instances/{processInstanceKey}/migration: - post: + /process-definitions/{processDefinitionKey}/xml: + get: tags: - - Process instance - operationId: migrateProcessInstance - summary: Migrate process instance + - Process definition + operationId: getProcessDefinitionXML + summary: Get process definition XML 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. + Returns process definition as XML. parameters: - - name: processInstanceKey + - name: processDefinitionKey in: path required: true - description: The key of the process instance that should be migrated. + description: The assigned key of the process definition, which acts as a unique identifier for this process. schema: type: integer format: int64 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/MigrateProcessInstanceRequest" responses: + "200": + description: > + The XML of the process definition is successfully returned. + content: + text/xml: + schema: + type: string "204": - description: The process instance is migrated. + description: > + The process definition was found but does not have XML. + content: + text/plain: + schema: + type: string "400": - description: The provided data is not valid. + description: > + The process definition request failed. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The process instance is not found. + description: > + The decision with the given key was not found. + More details are provided in the response body. content: application/problem+json: schema: @@ -1415,44 +1527,53 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /process-instances/{processInstanceKey}/modification: - post: + /process-definitions/{processDefinitionsKey}/form: + get: tags: - - Process instance - operationId: modifyProcessInstance - summary: Modify process instance + - Process definition + operationId: getStartProcessForm + summary: Get process start form 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. + Get the start form of a process. - 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. + Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. parameters: - - name: processInstanceKey + - name: processDefinitionsKey in: path required: true - description: The key of the process instance that should be modified. + description: The process key. 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. + "200": + description: > + The form is successfully returned. content: - application/problem+json: + application/json: schema: - $ref: "#/components/schemas/ProblemDetail" - "404": - description: The process instance is not found. + $ref: "#/components/schemas/FormItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/FormItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/FormItem" + "204": + description: > + The process was found, but no form is associated with it. + "400": + description: "Bad request" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: "Not found" content: application/problem+json: schema: @@ -1460,91 +1581,96 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /flownode-instances/search: + /process-instances: post: tags: - - Flow node instance - operationId: findFlowNodeInstances - summary: Query flow node instances (alpha) + - Process instance + operationId: createProcessInstance + summary: Create process instance description: | - Search for flow node instances based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. + 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. - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Waits for the completion of the process instance before returning a result + when awaitCompletion is enabled. requestBody: - required: false + required: true content: application/json: schema: - $ref: "#/components/schemas/FlowNodeInstanceSearchQueryRequest" + $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 flow node instance search result. + description: The process instance was created. 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: + $ref: "#/components/schemas/CreateProcessInstanceResponse" + application/vnd.camunda.api.keys.number+json: schema: - $ref: "#/components/schemas/ProblemDetail" + $ref: "#/components/schemas/CreateProcessInstanceResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/CreateProcessInstanceResponse" + "400": + description: The provided data is not valid. "500": $ref: "#/components/responses/InternalServerError" - /flownode-instances/{flownodeInstanceKey}: + /process-instances/{processInstanceKey}: get: tags: - - Flow node instance - operationId: getFlowNodeInstance - summary: Get flow node instance (alpha) + - Process instance + operationId: getProcessInstance + summary: Get process instance description: | - Returns flow node instance as JSON. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Get the process instance by the process instance key. parameters: - - name: flownodeInstanceKey + - name: processInstanceKey in: path required: true - description: The assigned key of the flow node instance, which acts as a unique identifier for this flow node instance. + description: The process instance key. schema: type: integer format: int64 responses: "200": - description: > - The flow node instance is successfully returned. + description: The process instance is successfully returned. content: application/json: schema: - $ref: "#/components/schemas/FlowNodeInstanceItem" + $ref: "#/components/schemas/ProcessInstanceItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/ProcessInstanceItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/ProcessInstanceItem" "400": - description: > - The flow node instance request failed. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: > - The flow node instance with the given key was not found. - More details are provided in the response body. + description: The process instance with the given key was not found. content: application/problem+json: schema: @@ -1552,91 +1678,80 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /decision-definitions/search: + /process-instances/search: post: tags: - - Decision definition - operationId: findDecisionDefinitions - summary: Query decision definitions (alpha) + - Process instance + operationId: findProcessInstances + summary: Query process instances description: | - Search for decision definitions based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Search for process instances based on given criteria. requestBody: required: false content: application/json: schema: - $ref: "#/components/schemas/DecisionDefinitionSearchQueryRequest" + $ref: "#/components/schemas/ProcessInstanceSearchQueryRequest" responses: "200": - description: > - The decision definition search result. + description: The process instance search result. content: application/json: schema: - $ref: "#/components/schemas/DecisionDefinitionSearchQueryResponse" + $ref: "#/components/schemas/ProcessInstanceSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/ProcessInstanceSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/ProcessInstanceSearchQueryResponse" "400": description: > - The decision definition search query failed. + The process instance search query failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /decision-definitions/{decisionDefinitionKey}: - get: + /process-instances/{processInstanceKey}/cancellation: + post: tags: - - Decision definition - operationId: getDecisionDefinition - summary: Get decision definition (alpha) - description: | - Returns a decision definition by key. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + - Process instance + operationId: cancelProcessInstance + summary: Cancel process instance + description: Cancels a running process instance. As a cancelation includes more than just the removal of the process instance resource, the cancelation resource must be posted. parameters: - - name: decisionDefinitionKey + - name: processInstanceKey in: path required: true - description: The assigned key of the decision definition, which acts as a unique identifier for this decision. + 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: - "200": - description: > - The decision definition is successfully returned. - content: - application/json: - schema: - $ref: "#/components/schemas/DecisionDefinitionItem" + "204": + description: The process instance is canceled. "400": - description: > - The decision definition request failed. - More details are provided in the response body. + description: The provided data is not valid. 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. + description: The process instance is not found. content: application/problem+json: schema: @@ -1644,50 +1759,45 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /decision-definitions/{decisionDefinitionKey}/xml: - get: + /process-instances/{processInstanceKey}/migration: + post: tags: - - Decision definition - operationId: getDecisionDefinitionXML - summary: Get decision definition XML (alpha) + - Process instance + operationId: migrateProcessInstance + summary: Migrate process instance description: | - Returns decision definition as XML. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. + 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. - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + 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: decisionDefinitionKey + - name: processInstanceKey in: path required: true - description: The assigned key of the decision definition, which acts as a unique identifier for this decision. + 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: - "200": - description: > - The XML of the decision definition is successfully returned. - content: - text/xml: - schema: - type: string + "204": + description: The process instance is migrated. "400": - description: > - The decision definition request failed. - More details are provided in the response body. + description: The provided data is not valid. 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. + description: The process instance is not found. content: application/problem+json: schema: @@ -1695,40 +1805,44 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /decision-requirements/search: + /process-instances/{processInstanceKey}/modification: post: tags: - - Decision requirements - operationId: findDecisionRequirements - summary: Query decision requirements (alpha) + - Process instance + operationId: modifyProcessInstance + summary: Modify process instance description: | - Search for decision requirements based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. + 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. - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + 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: false + required: true content: application/json: schema: - $ref: "#/components/schemas/DecisionRequirementsSearchQueryRequest" + $ref: "#/components/schemas/ModifyProcessInstanceRequest" responses: - "200": - description: > - The decision requirements search result. + "204": + description: The process instance is modified. + "400": + description: The provided data is not valid. content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponse" - "400": - description: > - The search query failed. - More details are provided in the response body. + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The process instance is not found. content: application/problem+json: schema: @@ -1736,100 +1850,94 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /decision-requirements/{decisionRequirementsKey}: - get: + /flownode-instances/search: + post: tags: - - Decision requirements - operationId: getDecisionRequirements - summary: Get decision requirements (alpha) + - Flow node instance + operationId: findFlowNodeInstances + summary: Query flow node instances description: | - Returns Decision Requirements as JSON. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: - parameters: - - name: decisionRequirementsKey - in: path - required: true - description: The assigned key of the decision requirements, which acts as a unique identifier for this decision requirements. - schema: - type: integer - format: int64 + Search for flow node instances based on given criteria. + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryRequest" responses: "200": description: > - The decision requirements is successfully returned. + The flow node instance search result. content: application/json: schema: - $ref: "#/components/schemas/DecisionRequirementsItem" - "400": - description: > - The decision requirements request failed. - More details are provided in the response body. - content: - application/problem+json: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: schema: - $ref: "#/components/schemas/ProblemDetail" - "404": + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponse" + "400": description: > - The decision requirements with the given key was not found. + The Flow node instance search query failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /decision-requirements/{decisionRequirementsKey}/xml: + /flownode-instances/{flownodeInstanceKey}: get: tags: - - Decision requirements - operationId: getDecisionRequirementsXML - summary: Get decision requirements XML (alpha) + - Flow node instance + operationId: getFlowNodeInstance + summary: Get flow node instance description: | - Returns decision requirements as XML. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Returns flow node instance as JSON. parameters: - - name: decisionRequirementsKey + - name: flownodeInstanceKey in: path required: true - description: The assigned key of the decision requirements, which acts as a unique identifier for this decision. + description: The assigned key of the flow node instance, which acts as a unique identifier for this flow node instance. schema: type: integer format: int64 responses: "200": description: > - The XML of the decision requirements is successfully returned. + The flow node instance is successfully returned. content: - text/xml: + application/json: schema: - type: string + $ref: "#/components/schemas/FlowNodeInstanceItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceItem" "400": description: > - The decision requirements request failed. + The flow node instance request failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": description: > - The decision requirements with the given key was not found. + The flow node instance with the given key was not found. More details are provided in the response body. content: application/problem+json: @@ -1838,89 +1946,94 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /decision-instances/search: + /decision-definitions/search: post: tags: - - Decision instance - operationId: findDecisionInstances - summary: Query decision instances (alpha) + - Decision definition + operationId: findDecisionDefinitions + summary: Query decision definitions description: | - Search for decision instances based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Search for decision definitions based on given criteria. requestBody: required: false content: application/json: schema: - $ref: "#/components/schemas/DecisionInstanceSearchQueryRequest" + $ref: "#/components/schemas/DecisionDefinitionSearchQueryRequest" responses: "200": description: > - The decision instance search result. + The decision definition search result. content: application/json: schema: - $ref: "#/components/schemas/DecisionInstanceSearchQueryResponse" + $ref: "#/components/schemas/DecisionDefinitionSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/DecisionDefinitionSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/DecisionDefinitionSearchQueryResponse" "400": description: > - The decision instance search query failed. + The decision definition search query failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /decision-instances/{decisionInstanceId}: + /decision-definitions/{decisionDefinitionKey}: get: tags: - - Decision instance - operationId: getDecisionInstance - summary: Get decision instance (alpha) + - Decision definition + operationId: getDecisionDefinition + summary: Get decision definition description: | - Returns a decision instance. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: + Returns a decision definition by key. parameters: - - name: decisionInstanceId + - name: decisionDefinitionKey in: path required: true - description: The assigned ID of the decision instance, which acts as a unique identifier for this decision instance. + description: The assigned key of the decision definition, which acts as a unique identifier for this decision. schema: - type: string + type: integer + format: int64 responses: "200": description: > - The decision instance is successfully returned. + The decision definition is successfully returned. content: application/json: schema: - $ref: "#/components/schemas/DecisionInstanceGetQueryResponse" + $ref: "#/components/schemas/DecisionDefinitionItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/DecisionDefinitionItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/DecisionDefinitionItem" "400": description: > - The decision instance request failed. + The decision definition request failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": description: > - The decision instance with the given ID was not found. + The decision with the given key was not found. More details are provided in the response body. content: application/problem+json: @@ -1929,49 +2042,46 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /decision-definitions/evaluation: - post: + /decision-definitions/{decisionDefinitionKey}/xml: + get: tags: - Decision definition - operationId: evaluateDecision - summary: Evaluate decision + operationId: getDecisionDefinitionXML + summary: Get decision definition XML 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: {} + Returns decision definition as XML. + 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 decision was evaluated. + description: > + The XML of the decision definition is successfully returned. content: - application/json: + text/xml: schema: - $ref: "#/components/schemas/EvaluateDecisionResponse" + type: string "400": - description: The provided data is not valid. + description: > + The decision definition request failed. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The decision is not found. + description: > + The decision with the given key was not found. + More details are provided in the response body. content: application/problem+json: schema: @@ -1979,127 +2089,82 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /authorizations/{ownerKey}: - patch: + /decision-requirements/search: + post: tags: - - Authorization - operationId: updateAuthorization - summary: Update authorization - description: Manage the permissions assigned to the authorization. - parameters: - - name: ownerKey - in: path - required: true - description: The key of the owner of the authorization. - schema: - type: integer - format: int64 + - Decision requirements + operationId: findDecisionRequirements + summary: Query decision requirements + description: | + Search for decision requirements based on given criteria. requestBody: + required: false content: application/json: schema: - $ref: "#/components/schemas/AuthorizationPatchRequest" - required: true + $ref: "#/components/schemas/DecisionRequirementsSearchQueryRequest" responses: - "202": - description: | - The authorization was patched successfully. - "400": - description: | - The authorization could not be patched. - More details are provided in the response body. + "200": + description: > + The decision requirements search result. content: - application/problem+json: + application/json: schema: - $ref: "#/components/schemas/ProblemDetail" - "401": - $ref: "#/components/responses/Unauthorized" - "403": - description: | - The request to patch an authorization was denied. - More details are provided in the response body. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" - "404": - description: | - The owner was not found. - content: - application/problem+json: + $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: schema: - $ref: "#/components/schemas/ProblemDetail" - "409": - description: | - The request to add or remove permissions to an authorization was in conflict. - More details are provided in the response body. - "500": - $ref: "#/components/responses/InternalServerError" - - /authorizations/search: - post: - tags: - - Authorization - summary: Query authorizations (alpha) - description: | - Search for authorizations based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: - operationId: findAuthorizations - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AuthorizationSearchQueryRequest" - required: true - responses: - "200": - description: The authorization search result. - content: - application/json: + $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: schema: - $ref: "#/components/schemas/AuthorizationSearchResponse" + $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponse" "400": description: > - The authorization search query failed. + The search query failed. More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - /roles: - post: + /decision-requirements/{decisionRequirementsKey}: + get: tags: - - Role - operationId: createRole - summary: Create role + - Decision requirements + operationId: getDecisionRequirements + summary: Get decision requirements description: | - Create a new role - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/RoleCreateRequest" + Returns Decision Requirements as JSON. + parameters: + - name: decisionRequirementsKey + in: path + required: true + description: The assigned key of the decision requirements, which acts as a unique identifier for this decision requirements. + schema: + type: integer + format: int64 responses: - "202": - description: | - The role was created successfully. + "200": + description: > + The decision requirements is successfully returned. content: application/json: schema: - $ref: "#/components/schemas/RoleCreateResponse" + $ref: "#/components/schemas/DecisionRequirementsItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/DecisionRequirementsItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/DecisionRequirementsItem" "400": - description: | - The role could not be created. + description: > + The decision requirements request failed. More details are provided in the response body. content: application/problem+json: @@ -2108,8 +2173,10 @@ paths: "401": $ref: "#/components/responses/Unauthorized" "403": - description: | - The request to create a role was denied. + $ref: "#/components/responses/Forbidden" + "404": + description: > + The decision requirements with the given key was not found. More details are provided in the response body. content: application/problem+json: @@ -2118,141 +2185,889 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /roles/{roleKey}: + /decision-requirements/{decisionRequirementsKey}/xml: get: tags: - - Role - operationId: getRole - summary: Get role + - Decision requirements + operationId: getDecisionRequirementsXML + summary: Get decision requirements XML description: | - Get a role by its key + Returns decision requirements as XML. parameters: - - name: roleKey + - name: decisionRequirementsKey in: path required: true - description: The role key. + description: The assigned key of the decision requirements, which acts as a unique identifier for this decision. schema: type: integer format: int64 responses: "200": - description: The role is successfully returned. + description: > + The XML of the decision requirements is successfully returned. content: - application/json: + text/xml: schema: - $ref: "#/components/schemas/RoleItem" + type: string + "400": + description: > + The decision requirements request failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" "401": $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The role with the given key was not found. + description: > + The decision requirements 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": $ref: "#/components/responses/InternalServerError" - patch: + + /decision-instances/search: + post: tags: - - Role - operationId: updateRole - summary: Update role - description: Update a role with the given key. - parameters: - - name: roleKey - in: path - required: true - description: The key of the role to update. - schema: - type: integer - format: int64 + - Decision instance + operationId: findDecisionInstances + summary: Query decision instances + description: | + Search for decision instances based on given criteria. requestBody: - required: true + required: false content: application/json: schema: - $ref: "#/components/schemas/RoleUpdateRequest" + $ref: "#/components/schemas/DecisionInstanceSearchQueryRequest" responses: - "204": - description: The role was updated successfully. + "200": + description: > + The decision instance search result. + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionInstanceSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/DecisionInstanceSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/DecisionInstanceSearchQueryResponse" "400": description: > - The provided data is not valid. + The decision instance search query failed. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" "401": $ref: "#/components/responses/Unauthorized" - "404": - description: The role with the roleKey is not found. - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" - delete: + + /decision-instances/{decisionInstanceId}: + get: tags: - - Role - operationId: deleteRole - summary: Delete role - description: Deletes the role with the given key. + - Decision instance + operationId: getDecisionInstance + summary: Get decision instance + description: | + Returns a decision instance. parameters: - - name: roleKey + - name: decisionInstanceId in: path required: true - description: The key of the role to delete. + description: The assigned ID of the decision instance, which acts as a unique identifier for this decision instance. schema: - type: integer - format: int64 + type: string responses: - "204": - description: The role was deleted successfully. + "200": + description: > + The decision instance is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/DecisionInstanceGetQueryResponse" + "400": + description: > + The decision instance request failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" "401": $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The role with the roleKey was not found. + description: > + The decision instance with the given ID was not found. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" "500": $ref: "#/components/responses/InternalServerError" - /roles/search: + + /decision-definitions/evaluation: post: tags: - - Role - operationId: searchRoles - summary: Query roles + - Decision definition + operationId: evaluateDecision + summary: Evaluate decision description: | - Search for roles based on given criteria. + 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: false + required: true content: application/json: schema: - $ref: "#/components/schemas/RoleSearchQueryRequest" + $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 roles search result. + description: The decision was evaluated. content: application/json: schema: - $ref: "#/components/schemas/RoleSearchQueryResponse" + $ref: "#/components/schemas/EvaluateDecisionResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/EvaluateDecisionResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/EvaluateDecisionResponse" "400": - description: > - The role search query failed. - More details are provided in the response body. + description: The provided data is not valid. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" - "500": + "404": + description: The decision is not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + /authorizations/{ownerKey}: + patch: + tags: + - Authorization + operationId: updateAuthorization + summary: Update authorization + description: Manage the permissions assigned to the authorization. + parameters: + - name: ownerKey + in: path + required: true + description: The key of the owner of the authorization. + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AuthorizationPatchRequest" + required: true + responses: + "202": + description: | + The authorization was patched successfully. + "400": + description: | + The authorization could not be patched. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: | + The owner was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "409": + description: | + The request to add or remove permissions to an authorization was in conflict. + More details are provided in the response body. + "500": + $ref: "#/components/responses/InternalServerError" + /authorizations/search: + post: + tags: + - Authorization + summary: Query authorizations + description: | + Search for authorizations based on given criteria. + operationId: findAuthorizations + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AuthorizationSearchQueryRequest" + required: true + responses: + "200": + description: The authorization search result. + content: + application/json: + schema: + $ref: "#/components/schemas/AuthorizationSearchResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/AuthorizationSearchResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/AuthorizationSearchResponse" + "400": + description: > + The authorization search query failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" + + /roles: + post: + tags: + - Role + operationId: createRole + summary: Create role + description: | + Create a new role. + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/RoleCreateRequest" + responses: + "201": + description: | + The role was created successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/RoleCreateResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/RoleCreateResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/RoleCreateResponse" + "400": + description: | + The role could not be created. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" + /roles/{roleKey}: + get: + tags: + - Role + operationId: getRole + summary: Get role + description: | + Get a role by its key. + parameters: + - name: roleKey + in: path + required: true + description: The role key. + schema: + type: integer + format: int64 + responses: + "200": + description: The role is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/RoleItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/RoleItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/RoleItem" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: The role with the given key was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + patch: + tags: + - Role + operationId: updateRole + summary: Update role + description: Update a role with the given key. + parameters: + - name: roleKey + in: path + required: true + description: The key of the role to update. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/RoleUpdateRequest" + responses: + "204": + description: The role was updated successfully. + "400": + description: > + The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The role with the roleKey is not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + delete: + tags: + - Role + operationId: deleteRole + summary: Delete role + description: Deletes the role with the given key. + parameters: + - name: roleKey + in: path + required: true + description: The key of the role to delete. + schema: + type: integer + format: int64 + responses: + "204": + description: The role was deleted successfully. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The role with the roleKey was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /roles/search: + post: + tags: + - Role + operationId: searchRoles + summary: Query roles + description: | + Search for roles based on given criteria. + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/RoleSearchQueryRequest" + responses: + "200": + description: The roles search result. + content: + application/json: + schema: + $ref: "#/components/schemas/RoleSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/RoleSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/RoleSearchQueryResponse" + "400": + description: > + The role search query failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + description: An internal error occurred while processing the request. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + /groups: + post: + tags: + - Group + operationId: createGroup + summary: Create group + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/GroupCreateRequest" + responses: + "201": + description: The group was created successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/GroupCreateResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/GroupCreateResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/GroupCreateResponse" + "400": + description: | + The group could not be created. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" + /groups/{groupKey}: + get: + tags: + - Group + operationId: getGroup + summary: Get group + description: | + Get a group by its key. + parameters: + - name: groupKey + in: path + required: true + description: The group key. + schema: + type: integer + format: int64 + responses: + "200": + description: The group is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/GroupItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/GroupItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/GroupItem" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: The group with the given key was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + patch: + tags: + - Group + operationId: updateGroup + summary: Update group + description: Update a group with the given key. + parameters: + - name: groupKey + in: path + required: true + description: The key of the group to update. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/GroupUpdateRequest" + responses: + "204": + description: The group was updated successfully. + "400": + description: > + The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The group with the groupKey is not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + delete: + tags: + - Group + operationId: deleteGroup + summary: Delete group + description: Deletes the group with the given key. + parameters: + - name: groupKey + in: path + required: true + description: The key of the group to delete. + schema: + type: integer + format: int64 + responses: + "204": + description: The group was deleted successfully. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The group with the groupKey was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /groups/{groupKey}/users/{userKey}: + post: + tags: + - Group + operationId: addUserToGroup + summary: Assign a user to a group + description: | + Assigns a user to a group. + parameters: + - name: groupKey + in: path + required: true + description: The group key. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The user key. + schema: + type: integer + format: int64 + responses: + "202": + description: The user was assigned successfully to the group. + "400": + description: | + The user could not be assigned. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: The group or user with the given key was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "409": + description: The user with the given key is already assigned to the group. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + delete: + tags: + - Group + operationId: unassignUserFromGroup + summary: Unassign a user from a group + description: | + Unassigns a user from a group. + parameters: + - name: groupKey + in: path + required: true + description: The group key. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The user key. + schema: + type: integer + format: int64 + responses: + "202": + description: The user was unassigned successfully from the group. + "400": + description: | + The user could not be unassigned. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: The group or user with the given key was not found, or the user is not assigned to this group. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /groups/search: + post: + tags: + - Group + operationId: searchGroups + summary: Query groups + description: | + Search for groups based on given criteria. + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/GroupSearchQueryRequest" + responses: + "200": + description: The groups search result. + content: + application/json: + schema: + $ref: "#/components/schemas/GroupSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/GroupSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/GroupSearchQueryResponse" + "400": + description: > + The group search query failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": description: An internal error occurred while processing the request. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + + /mapping-rules: + post: + tags: + - Mapping rule + operationId: createMappingRule + summary: Create mapping rule + description: | + Create a new mapping rule + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MappingRuleCreateRequest" + responses: + "201": + description: The mapping rule was created successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/MappingRuleCreateResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/MappingRuleCreateResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/MappingRuleCreateResponse" + "400": + description: The mapping rule could not be created. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + description: | + The request to create a mapping rule was denied. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "404": + description: The request to create a mapping rule was denied. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /mapping-rules/{mappingKey}: + delete: + tags: + - Mapping rule + operationId: deleteMappingRule + summary: Delete a mapping rule + description: Deletes the mapping rule with the given key. + parameters: + - name: mappingKey + in: path + required: true + description: The key of the mapping rule to delete. + schema: + type: integer + format: int64 + responses: + "204": + description: The mapping rule was deleted successfully. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The mapping rule with the mappingKey was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + /mapping-rules/search: + post: + tags: + - Mapping rule + operationId: findMappings + summary: Query mappings + description: | + Search for mapping rules based on given criteria. + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MappingSearchQueryRequest" + required: true + responses: + "200": + description: The mapping rule search result. + content: + application/json: + schema: + $ref: "#/components/schemas/MappingSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/MappingSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/MappingSearchQueryResponse" + "400": + description: > + The mapping rule search query failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" + /messages/publication: post: tags: @@ -2277,6 +3092,12 @@ paths: application/json: schema: $ref: "#/components/schemas/MessagePublicationResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/MessagePublicationResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/MessagePublicationResponse" "400": description: The provided data is not valid. content: @@ -2308,6 +3129,12 @@ paths: application/json: schema: $ref: "#/components/schemas/MessageCorrelationResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/MessageCorrelationResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/MessageCorrelationResponse" "400": description: The provided data is not valid content: @@ -2315,11 +3142,7 @@ paths: schema: $ref: "#/components/schemas/ProblemDetail" "403": - description: Unauthorized - content: - application/problem+json: - schema: - $ref: "#/components/schemas/ProblemDetail" + $ref: "#/components/responses/Forbidden" "404": description: Not found content: @@ -2476,7 +3299,7 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /document/{documentId}/links: + /documents/{documentId}/links: post: tags: - Document @@ -2531,6 +3354,7 @@ paths: - User operationId: createUser summary: Create user + description: Create a new user. requestBody: content: application/json: @@ -2538,13 +3362,19 @@ paths: $ref: "#/components/schemas/UserRequest" required: true responses: - "202": + "201": description: | The user was created successfully. content: application/json: schema: $ref: "#/components/schemas/UserCreateResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/UserCreateResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/UserCreateResponse" "400": description: | Unable to create the user. @@ -2556,9 +3386,10 @@ paths: "401": $ref: "#/components/responses/Unauthorized" "403": + $ref: "#/components/responses/Forbidden" + "409": description: | - The request to create a user was denied. - More details are provided in the response body. + A user with the given username already exists. content: application/problem+json: schema: @@ -2571,17 +3402,9 @@ paths: tags: - User operationId: findUsers - summary: Query users (alpha) + summary: Query users description: | Search for users based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: requestBody: content: application/json: @@ -2595,6 +3418,12 @@ paths: application/json: schema: $ref: "#/components/schemas/UserSearchResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/UserSearchResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/UserSearchResponse" "400": description: > The user search query failed. @@ -2603,6 +3432,10 @@ paths: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" @@ -2610,17 +3443,9 @@ paths: post: tags: - Authorization - summary: "Query user authorizations (alpha)" + summary: "Query user authorizations" description: | Search for user authorizations based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: operationId: "findUserAuthorizations" parameters: - name: userKey @@ -2643,6 +3468,12 @@ paths: application/json: schema: $ref: "#/components/schemas/AuthorizationSearchResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/AuthorizationSearchResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/AuthorizationSearchResponse" "400": description: > The user authorization search query failed. @@ -2651,6 +3482,10 @@ paths: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" @@ -2693,17 +3528,9 @@ paths: tags: - Incident operationId: findIncidents - summary: Query incidents (alpha) + summary: Query incidents description: | Search for incidents based on given criteria. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: requestBody: required: false content: @@ -2718,10 +3545,20 @@ paths: application/json: schema: $ref: "#/components/schemas/IncidentSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/IncidentSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/IncidentSearchQueryResponse" "400": description: > The incident search query failed. More details are provided in the response body. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "500": $ref: "#/components/responses/InternalServerError" @@ -2730,17 +3567,9 @@ paths: tags: - Incident operationId: getIncident - summary: Get incident (alpha) + summary: Get incident description: | Returns incident as JSON. - - Note that this endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and not enabled on Camunda clusters out of the box. - The [Camunda 8 API (REST) Overview page](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api) provides further details. - - :::note - This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change - in future releases. - ::: parameters: - name: incidentKey in: path @@ -2757,6 +3586,12 @@ paths: application/json: schema: $ref: "#/components/schemas/IncidentItem" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/IncidentItemNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/IncidentItem" "400": description: > The incident request failed. @@ -2765,6 +3600,10 @@ paths: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": description: > The incident with the given key was not found. @@ -2775,7 +3614,50 @@ paths: $ref: "#/components/schemas/ProblemDetail" "500": $ref: "#/components/responses/InternalServerError" - + /usage-metrics: + get: + tags: + - Usage metrics + operationId: getUsageMetrics + summary: Get usage metrics + description: Retrieve the usage metrics by given start and end date. + parameters: + - name: startTime + in: query + required: true + description: The start date for usage metrics, including this date. + schema: + type: string + format: date-time + - name: endTime + in: query + required: true + description: The end date for usage metrics, including this date. + schema: + type: string + format: date-time + responses: + "200": + description: > + The usage metrics search result. + content: + application/json: + schema: + $ref: "#/components/schemas/UsageMetricsResponse" + "400": + description: > + The usage metrics request failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" /deployments: post: tags: @@ -2811,6 +3693,12 @@ paths: application/json: schema: $ref: "#/components/schemas/DeploymentResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/DeploymentResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/DeploymentResponse" "400": description: > The document upload failed. More details are provided in the response body. @@ -2921,6 +3809,12 @@ paths: application/json: schema: $ref: "#/components/schemas/SignalBroadcastResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/SignalBroadcastResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/SignalBroadcastResponse" "400": description: The provided data is not valid. content: @@ -2950,13 +3844,20 @@ components: required: - tenantId + TenantCreateResponseNumberKeys: + deprecated: true + type: object + properties: + tenantKey: + description: The external key of the created tenant + type: integer + format: int64 TenantCreateResponse: - type: "object" + type: object properties: tenantKey: description: The external key of the created tenant - type: "integer" - format: "int64" + type: string TenantUpdateRequest: type: object @@ -2967,20 +3868,123 @@ components: required: - name + TenantUpdateResponseBase: + description: Base properties for TenantUpdateResponse. + type: object + properties: + tenantId: + type: string + description: The unique external tenant ID + name: + type: string + description: The name of the tenant. + TenantUpdateResponseNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/TenantUpdateResponseBase" + properties: + tenantKey: + type: integer + description: The unique system-generated internal tenant ID. + format: int64 TenantUpdateResponse: type: object + allOf: + - $ref: "#/components/schemas/TenantUpdateResponseBase" properties: - key: + tenantKey: + type: string + description: The unique system-generated internal tenant ID. + + TenantItemBase: + description: Base properties for TenantItem. + type: object + properties: + name: + type: string + description: The tenant name. + tenantId: + type: string + description: The unique external tenant ID. + TenantItemNumberKeys: + description: Tenant search response item. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/TenantItemBase" + properties: + tenantKey: type: integer - description: The unique system-generated internal tenant ID + description: The unique system-generated internal tenant ID. format: int64 + assignedMemberKeys: + type: array + description: The set of keys of members assigned to the tenant. + items: + type: integer + format: int64 + TenantItem: + description: Tenant search response item. + type: object + allOf: + - $ref: "#/components/schemas/TenantItemBase" + properties: + tenantKey: + type: string + description: The unique system-generated internal tenant ID. + assignedMemberKeys: + type: array + description: The set of keys of members assigned to the tenant. + items: + type: string + + TenantSearchQueryRequest: + description: Tenant search request + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + properties: + filter: + description: The tenant search filters. + allOf: + - $ref: "#/components/schemas/TenantFilterRequest" + + TenantFilterRequest: + description: Tenant filter request + type: object + properties: tenantId: type: string - description: The unique external tenant ID + description: The ID of the tenant. name: type: string description: The name of the tenant. + TenantSearchQueryResponseNumberKeys: + description: Tenant search response. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching tenants. + type: array + items: + $ref: "#/components/schemas/TenantItemNumberKeys" + TenantSearchQueryResponse: + description: Tenant search response. + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching tenants. + type: array + items: + $ref: "#/components/schemas/TenantItem" + UserTaskSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" @@ -2988,19 +3992,34 @@ components: type: object properties: filter: - $ref: "#/components/schemas/UserTaskFilterRequest" + description: The user task search filters. + allOf: + - $ref: "#/components/schemas/UserTaskFilterRequest" UserTaskVariableSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" description: User task search query request. type: object - UserTaskSearchQueryResponse: + UserTaskSearchQueryResponseNumberKeys: + description: User task search query response. Key attributes as numeric values. + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching user tasks. + type: array + items: + $ref: "#/components/schemas/UserTaskItemNumberKeys" + UserTaskSearchQueryResponse: description: User task search query response. type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching user tasks. type: array items: $ref: "#/components/schemas/UserTaskItem" @@ -3053,8 +4072,18 @@ components: processDefinitionId: type: string description: The ID of the process definition. - variables: + elementInstanceKey: + type: integer + description: The key of the element instance. + format: int64 + processInstanceVariables: + type: array + description: Process Instance variables associated with the user task. + items: + $ref: "#/components/schemas/UserTaskVariableFilterRequest" + localVariables: type: array + description: Local variables associated with the user task. items: $ref: "#/components/schemas/UserTaskVariableFilterRequest" UserTaskVariableFilterRequest: @@ -3066,13 +4095,13 @@ components: value: type: string description: The value of the variable. - UserTaskItem: + UserTaskItemBase: + description: Base properties for UserTaskItem. type: object properties: - userTaskKey: - type: integer - description: The key for this user task. - format: int64 + name: + type: string + description: The name for this user task. state: type: string description: The state of the user task. @@ -3082,15 +4111,11 @@ components: - CANCELED - FAILED assignee: - type: string description: The assignee of the user task. + type: string elementId: type: string description: The element ID of the user task. - elementInstanceKey: - type: integer - description: The key of the element instance. - format: int64 candidateGroups: type: array description: The candidate groups for this user task. @@ -3104,18 +4129,6 @@ components: processDefinitionId: type: string description: The ID of the process definition. - processDefinitionKey: - type: integer - description: The key of the process definition. - format: int64 - processInstanceKey: - type: integer - description: The key of the process instance. - format: int64 - formKey: - type: integer - description: The key of the form. - format: int64 creationDate: type: string description: The creation date of a user task. @@ -3153,6 +4166,52 @@ components: minimum: 0 maximum: 100 default: 50 + UserTaskItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/UserTaskItemBase" + properties: + userTaskKey: + description: The key of the user task. + type: integer + format: int64 + elementInstanceKey: + type: integer + description: The key of the element instance. + format: int64 + processDefinitionKey: + type: integer + description: The key of the process definition. + format: int64 + processInstanceKey: + type: integer + description: The key of the process instance. + format: int64 + formKey: + type: integer + description: The key of the form. + format: int64 + UserTaskItem: + type: object + allOf: + - $ref: "#/components/schemas/UserTaskItemBase" + properties: + userTaskKey: + description: The key of the user task. + type: string + elementInstanceKey: + type: string + description: The key of the element instance. + processDefinitionKey: + type: string + description: The key of the process definition. + processInstanceKey: + type: string + description: The key of the process instance. + formKey: + type: string + description: The key of the form. VariableSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" @@ -3160,7 +4219,9 @@ components: type: object properties: filter: - $ref: "#/components/schemas/VariableFilterRequest" + description: The variable search filters. + allOf: + - $ref: "#/components/schemas/VariableFilterRequest" VariableFilterRequest: description: Variable filter request. type: object @@ -3191,24 +4252,33 @@ components: isTruncated: description: Whether the value is truncated or not. type: boolean - VariableSearchQueryResponse: + VariableSearchQueryResponseNumberKeys: + description: Variable search query response. Key attributes as numeric values. + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching variables. + type: array + items: + $ref: "#/components/schemas/VariableItemNumberKeys" + VariableSearchQueryResponse: description: Variable search query response. type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching variables. type: array items: $ref: "#/components/schemas/VariableItem" - VariableItem: - description: Variable search response item. + VariableItemBase: + description: Base properties for VariableItem. type: object properties: - variableKey: - description: The key for this variable. - type: integer - format: int64 name: description: Name of this variable. type: string @@ -3218,6 +4288,23 @@ components: fullValue: description: Full value of this variable. type: string + tenantId: + description: Tenant ID of this variable. + type: string + isTruncated: + description: Whether the value is truncated or not. + type: boolean + VariableItemNumberKeys: + description: Variable search response item. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/VariableItemBase" + properties: + variableKey: + description: The key for this variable. + type: integer + format: int64 scopeKey: description: The key of the scope of this variable. type: integer @@ -3226,21 +4313,32 @@ components: description: The key of the process instance of this variable. type: integer format: int64 - tenantId: - description: Tenant ID of this variable. + VariableItem: + description: Variable search response item. + type: object + allOf: + - $ref: "#/components/schemas/VariableItemBase" + properties: + variableKey: + description: The key for this variable. + type: string + scopeKey: + description: The key of the scope of this variable. + type: string + processInstanceKey: + description: The key of the process instance of this variable. type: string - isTruncated: - description: Whether the value is truncated or not. - type: boolean ProcessDefinitionSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" type: object properties: filter: + description: The process definition search filters. allOf: - $ref: "#/components/schemas/ProcessDefinitionFilterRequest" ProcessDefinitionFilterRequest: + description: Process definition search filter. type: object properties: processDefinitionKey: @@ -3266,22 +4364,31 @@ components: tenantId: description: Tenant ID of this process definition. type: string - ProcessDefinitionSearchQueryResponse: + ProcessDefinitionSearchQueryResponseNumberKeys: + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching process definitions. + type: array + items: + $ref: "#/components/schemas/ProcessDefinitionItemNumberKeys" + ProcessDefinitionSearchQueryResponse: type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching process definitions. type: array items: $ref: "#/components/schemas/ProcessDefinitionItem" - ProcessDefinitionItem: + ProcessDefinitionItemBase: + description: Base properties for ProcessDefinitionItem. type: object properties: - processDefinitionKey: - description: The key for this process definition. - type: integer - format: int64 name: description: Name of this process definition. type: string @@ -3301,6 +4408,24 @@ components: tenantId: description: Tenant ID of this process definition. type: string + ProcessDefinitionItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/ProcessDefinitionItemBase" + properties: + processDefinitionKey: + description: The key for this process definition. + type: integer + format: int64 + ProcessDefinitionItem: + type: object + allOf: + - $ref: "#/components/schemas/ProcessDefinitionItemBase" + properties: + processDefinitionKey: + description: The key for this process definition. + type: string ProcessInstanceSearchQueryRequest: description: Process instance search request. allOf: @@ -3308,6 +4433,7 @@ components: type: object properties: filter: + description: The process instance search filters. allOf: - $ref: "#/components/schemas/ProcessInstanceFilterRequest" AdvancedIntegerFilter: @@ -3551,10 +4677,6 @@ components: description: The parent flow node instance key. allOf: - $ref: "#/components/schemas/LongFilterProperty" - treePath: - description: The path of keys to this process instance, separated by '/'. - allOf: - - $ref: "#/components/schemas/StringFilterProperty" startDate: description: The start date. allOf: @@ -3574,36 +4696,48 @@ components: description: The tenant ID. allOf: - $ref: "#/components/schemas/StringFilterProperty" + variables: + description: The process instance variables. + type: array + items: + $ref: "#/components/schemas/ProcessInstanceVariableFilterRequest" ProcessInstanceVariableFilterRequest: description: Process instance variable filter. type: object properties: - name: - type: string - description: The variable name. - values: + name: + description: Name of the variable. + type: string + value: + description: The value of the variable. + type: string + ProcessInstanceSearchQueryResponseNumberKeys: + description: Process instance search response. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching process instances. type: array - description: The variable values. items: - type: string + $ref: "#/components/schemas/ProcessInstanceItemNumberKeys" ProcessInstanceSearchQueryResponse: description: Process instance search response. + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" - type: object properties: items: + description: The matching process instances. type: array items: $ref: "#/components/schemas/ProcessInstanceItem" - ProcessInstanceItem: - description: Process instance search response item. + ProcessInstanceItemBase: + description: Base properties for ProcessInstanceItem. type: object properties: - processInstanceKey: - type: integer - description: The key of this process instance. - format: int64 processDefinitionId: type: string description: The process definition ID. @@ -3617,21 +4751,6 @@ components: processDefinitionVersionTag: type: string description: The process definition version tag. - processDefinitionKey: - type: integer - description: The process definition key. - format: int64 - parentProcessInstanceKey: - type: integer - description: The parent process instance key. - format: int64 - parentFlowNodeInstanceKey: - type: integer - description: The parent flow node instance key. - format: int64 - treePath: - type: string - description: The path of keys to this process instance, separated by '/'. startDate: type: string description: The start date. @@ -3648,6 +4767,47 @@ components: tenantId: type: string description: The tenant ID. + ProcessInstanceItemNumberKeys: + description: Process instance search response item. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/ProcessInstanceItemBase" + properties: + processInstanceKey: + type: integer + description: The key of this process instance. + format: int64 + processDefinitionKey: + type: integer + description: The process definition key. + format: int64 + parentProcessInstanceKey: + type: integer + description: The parent process instance key. + format: int64 + parentFlowNodeInstanceKey: + type: integer + description: The parent flow node instance key. + format: int64 + ProcessInstanceItem: + description: Process instance search response item. + type: object + allOf: + - $ref: "#/components/schemas/ProcessInstanceItemBase" + properties: + processInstanceKey: + type: string + description: The key of this process instance. + processDefinitionKey: + type: string + description: The process definition key. + parentProcessInstanceKey: + type: string + description: The parent process instance key. + parentFlowNodeInstanceKey: + type: string + description: The parent flow node instance key. ProcessInstanceStateEnum: description: The state, one of ACTIVE, COMPLETED, CANCELED. enum: @@ -3673,9 +4833,11 @@ components: type: object properties: filter: + description: The flow node instance search filters. allOf: - $ref: "#/components/schemas/FlowNodeInstanceFilterRequest" FlowNodeInstanceFilterRequest: + description: Flow node instance filter. type: object properties: flowNodeInstanceKey: @@ -3735,9 +4897,6 @@ components: 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 '/'. hasIncident: type: boolean description: Shows whether this flow node instance has an incident related to. @@ -3748,30 +4907,31 @@ components: tenantId: description: The tenant ID. type: string - FlowNodeInstanceSearchQueryResponse: + FlowNodeInstanceSearchQueryResponseNumberKeys: + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching flow node instances. + type: array + items: + $ref: "#/components/schemas/FlowNodeInstanceItemNumberKeys" + FlowNodeInstanceSearchQueryResponse: type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching flow node instances. type: array items: $ref: "#/components/schemas/FlowNodeInstanceItem" - FlowNodeInstanceItem: + FlowNodeInstanceItemBase: + description: Base properties for FlowNodeInstanceItem. type: object properties: - flowNodeInstanceKey: - type: integer - description: The assigned key, which acts as a unique identifier for this flow node instance. - format: int64 - processInstanceKey: - description: The process instance key associated to this flow node instance. - type: integer - format: int64 - processDefinitionKey: - description: The process definition key associated to this flow node instance. - type: integer - format: int64 processDefinitionId: description: The process definition ID associated to this flow node instance. type: string @@ -3786,8 +4946,8 @@ components: flowNodeId: description: The flow node ID for this flow node instance. type: string - treePath: - description: The path from process instance leading to this flow node instance. + flowNodeName: + description: The flow node name for this flow node instance. type: string type: description: Type of flow node as defined set of values. @@ -3828,12 +4988,47 @@ components: hasIncident: description: Shows whether this flow node instance has an incident. If true also an incidentKey is provided. type: boolean + tenantId: + description: The tenant ID of the incident. + type: string + FlowNodeInstanceItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/FlowNodeInstanceItemBase" + properties: + flowNodeInstanceKey: + type: integer + description: The assigned key, which acts as a unique identifier for this flow node instance. + format: int64 + processInstanceKey: + description: The process instance key associated to this flow node instance. + type: integer + format: int64 + processDefinitionKey: + description: The process definition key associated to this flow node instance. + type: integer + format: int64 incidentKey: description: Incident key associated with this flow node instance. type: integer format: int64 - tenantId: - description: The tenant ID of the incident. + FlowNodeInstanceItem: + type: object + allOf: + - $ref: "#/components/schemas/FlowNodeInstanceItemBase" + properties: + flowNodeInstanceKey: + type: string + description: The assigned key, which acts as a unique identifier for this flow node instance. + processInstanceKey: + description: The process instance key associated to this flow node instance. + type: string + processDefinitionKey: + description: The process definition key associated to this flow node instance. + type: string + incidentKey: + description: Incident key associated with this flow node instance. type: string DecisionDefinitionSearchQueryRequest: allOf: @@ -3841,9 +5036,11 @@ components: type: object properties: filter: + description: The decision definition search filters. allOf: - $ref: "#/components/schemas/DecisionDefinitionFilterRequest" DecisionDefinitionFilterRequest: + description: Decision definition search filter. type: object properties: decisionDefinitionKey: @@ -3876,9 +5073,11 @@ components: type: object properties: filter: + description: The incident search filters. allOf: - $ref: "#/components/schemas/IncidentFilterRequest" IncidentFilterRequest: + description: Incident search filter. type: object properties: incidentKey: @@ -3938,39 +5137,37 @@ components: 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: + IncidentSearchQueryResponseNumberKeys: + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching incidents. + type: array + items: + $ref: "#/components/schemas/IncidentItemNumberKeys" + IncidentSearchQueryResponse: type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching incidents. type: array items: $ref: "#/components/schemas/IncidentItem" - IncidentItem: + IncidentItemBase: + description: Base properties for IncidentItem. type: object properties: - incidentKey: - 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 process definition 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. @@ -3979,6 +5176,7 @@ components: - UNKNOWN - IO_MAPPING_ERROR - JOB_NO_RETRIES + - EXECUTION_LISTENER_NO_RETRIES - CONDITION_ERROR - EXTRACT_VALUE_ERROR - CALLED_ELEMENT_ERROR @@ -3993,10 +5191,6 @@ components: 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. @@ -4009,75 +5203,80 @@ components: - MIGRATED - RESOLVED - PENDING + tenantId: + description: The tenant ID of the incident. + type: string + IncidentItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/IncidentItemBase" + properties: + incidentKey: + 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. + processInstanceKey: + type: integer + format: int64 + description: The process instance key associated to this incident. + flowNodeInstanceKey: + type: integer + format: int64 + description: The flow node instance key associated to this incident. 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" + IncidentItem: type: object + allOf: + - $ref: "#/components/schemas/IncidentItemBase" properties: - id: - type: string - batchOperationId: + incidentKey: type: string - type: + description: The assigned key, which acts as a unique identifier for this incident. + processDefinitionKey: 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: + description: The process definition key associated to this incident. + processInstanceKey: type: string - enum: - - SCHEDULED - - LOCKED - - SENT - - FAILED - - COMPLETED - errorMessage: + description: The process instance key associated to this incident. + flowNodeInstanceKey: type: string - completedDate: + description: The flow node instance key associated to this incident. + jobKey: type: string - format: date-time - ProcessInstanceReferenceItem: - description: "Process instance reference description" + description: The job key, if exists, associated with this incident. + DecisionDefinitionSearchQueryResponseNumberKeys: + deprecated: true type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: - instanceId: - type: string - processDefinitionId: - type: string - processDefinitionName: - type: string + items: + description: The matching decision definitions. + type: array + items: + $ref: "#/components/schemas/DecisionDefinitionItemNumberKeys" DecisionDefinitionSearchQueryResponse: + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" - type: object properties: items: + description: The matching decision definitions. type: array items: $ref: "#/components/schemas/DecisionDefinitionItem" - DecisionDefinitionItem: + DecisionDefinitionItemBase: + description: Base properties for 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. @@ -4091,22 +5290,60 @@ components: decisionRequirementsId: type: string description: the DMN ID of the decision requirements graph that the decision definition is part of. + tenantId: + type: string + description: The tenant ID of the decision definition. + DecisionDefinitionItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/DecisionDefinitionItemBase" + properties: + decisionDefinitionKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this decision definition. decisionRequirementsKey: type: integer format: int64 description: The assigned key of the decision requirements graph that the decision definition is part of. - tenantId: + DecisionDefinitionItem: + type: object + allOf: + - $ref: "#/components/schemas/DecisionDefinitionItemBase" + properties: + decisionDefinitionKey: type: string - description: The tenant ID of the decision definition. + description: The assigned key, which acts as a unique identifier for this decision definition. + decisionRequirementsKey: + type: string + description: The assigned key of the decision requirements graph that the decision definition is part of. + UsageMetricsResponse: + type: object + properties: + assignees: + description: The amount of unique active users. + type: integer + format: int64 + processInstances: + description: The amount of created root process instances. + type: integer + format: int64 + decisionInstances: + description: The amount of executed decision instances. + type: integer + format: int64 PermissionTypeEnum: description: Specifies the type of permissions. enum: + - ACCESS - CREATE - CREATE_PROCESS_INSTANCE - CREATE_DECISION_INSTANCE - READ - READ_PROCESS_INSTANCE - READ_USER_TASK + - READ_DECISION_INSTANCE - UPDATE - UPDATE_PROCESS_INSTANCE - UPDATE_USER_TASK @@ -4114,6 +5351,7 @@ components: - DELETE_PROCESS - DELETE_DRD - DELETE_FORM + - DELETE_PROCESS_INSTANCE ResourceTypeEnum: description: The type of resource to add/remove permissions to/from. enum: @@ -4178,9 +5416,11 @@ components: type: object properties: filter: + description: The authorization search filters. allOf: - $ref: "#/components/schemas/AuthorizationFilterRequest" AuthorizationFilterRequest: + description: Authorization search filter. type: object properties: ownerType: @@ -4192,13 +5432,9 @@ components: description: The id of the owner of permissions. type: integer format: int64 - AuthorizationResponse: + AuthorizationResponseBase: type: "object" properties: - ownerKey: - description: The id of the owner of permissions. - type: integer - format: int64 ownerType: description: The type of the owner of permissions. type: object @@ -4211,15 +5447,44 @@ components: - $ref: "#/components/schemas/ResourceTypeEnum" permissions: type: array - description: The permissions. + description: The permissions. + items: + $ref: "#/components/schemas/PermissionDTO" + AuthorizationResponseNumberKeys: + type: "object" + allOf: + - $ref: "#/components/schemas/AuthorizationResponseBase" + properties: + ownerKey: + description: The id of the owner of permissions. + type: integer + format: int64 + AuthorizationResponse: + type: "object" + allOf: + - $ref: "#/components/schemas/AuthorizationResponseBase" + properties: + ownerKey: + description: The id of the owner of permissions. + type: string + AuthorizationSearchResponseNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching authorizations. + type: array items: - $ref: "#/components/schemas/PermissionDTO" + $ref: "#/components/schemas/AuthorizationResponseNumberKeys" AuthorizationSearchResponse: type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching authorizations. type: array items: $ref: "#/components/schemas/AuthorizationResponse" @@ -4227,119 +5492,538 @@ components: type: "object" properties: password: + description: The password of the user. type: "string" username: + description: The username of the user. type: "string" name: + description: The name of the user. type: "string" email: + description: The email of the user. type: "string" + UserCreateResponseNumberKeys: + deprecated: true + type: object + properties: + userKey: + description: The key of the created user + type: integer + format: int64 UserCreateResponse: - type: "object" + type: object properties: userKey: description: The key of the created user - type: "integer" - format: "int64" + type: string UserSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" type: object properties: filter: + description: The user search filters. allOf: - $ref: "#/components/schemas/UserFilterRequest" + MappingSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + description: The mapping search filters. + allOf: + - $ref: "#/components/schemas/MappingFilterRequest" UserFilterRequest: + description: User search filter. type: object properties: username: + description: The username of the user. type: "string" name: + description: The name of the user. type: "string" email: + description: The email of the user. type: "string" - UserResponse: + MappingFilterRequest: + description: Mapping search filter. + type: object + properties: + claimName: + type: string + description: The claim name to match against a token. + claimValue: + type: string + description: The value of the claim to match. + name: + type: string + description: The name of the mapping. + CamundaUserBase: + description: Base properties for CamundaUser. + type: object + properties: + userId: + description: The ID of the user. + type: string + displayName: + description: The display name of the user. + type: string + authorizedApplications: + description: The applications the user is authorized to use. + type: array + items: + type: string + tenants: + description: The tenants the user is a member of. + type: array + items: + type: object + properties: + tenantId: + type: string + description: The ID of the tenant. + name: + type: string + description: The name of the tenant. + groups: + description: The groups assigned to the user. + type: array + items: + type: string + roles: + description: The roles assigned to the user. + type: array + items: + type: string + salesPlanType: + description: The plan of the user. + type: string + c8Links: + description: The links to the components in the C8 stack. + type: array + items: + type: object + properties: + name: + type: string + description: The name of the component. + link: + type: string + description: A link to the component. + canLogout: + description: Flag for understanding if the user is able to perform logout. + type: boolean + apiUser: + description: Flag for understanding if the user is an API user. + type: boolean + CamundaUserNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/CamundaUserBase" + properties: + userKey: + description: The system generated key of the user. + type: integer + format: int64 + CamundaUser: + type: object + allOf: + - $ref: "#/components/schemas/CamundaUserBase" + properties: + userKey: + description: The system generated key of the user. + type: string + UserResponseBase: type: "object" properties: id: - type: "integer" - format: "int64" - key: + description: The ID of the user. type: "integer" format: "int64" username: + description: The username of the user. type: "string" name: + description: The name of the user. type: "string" email: + description: The email of the user. type: "string" + UserResponseNumberKeys: + type: "object" + allOf: + - $ref: "#/components/schemas/UserResponseBase" + properties: + key: + description: The key of the user. + type: "integer" + format: "int64" + UserResponse: + type: "object" + allOf: + - $ref: "#/components/schemas/UserResponseBase" + properties: + key: + description: The key of the user. + type: "string" + UserSearchResponseNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching users. + type: array + items: + $ref: "#/components/schemas/UserResponseNumberKeys" UserSearchResponse: type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching users. type: array items: $ref: "#/components/schemas/UserResponse" + UserUpdateRequest: + type: object + properties: + changeset: + $ref: "#/components/schemas/UserChangeset" + UserChangeset: + description: | + JSON object with changed user attribute values. + type: object + properties: + name: + type: string + description: The new name of the user. + email: + type: string + description: The new email of the user. + password: + type: string + description: The new password of the user. RoleCreateRequest: type: "object" properties: name: type: "string" - description: The display name of the new role + description: The display name of the new role. + RoleCreateResponseNumberKeys: + deprecated: true + type: object + properties: + roleKey: + description: The key of the created role. + type: integer + format: int64 RoleCreateResponse: - type: "object" + type: object properties: roleKey: - description: The key of the created role - type: "integer" - format: "int64" + description: The key of the created role. + type: string RoleUpdateRequest: type: object properties: changeset: - $ref: "#/components/schemas/RoleChangeset" + description: The set of changed role attributes. + allOf: + - $ref: "#/components/schemas/RoleChangeset" required: - changeset RoleChangeset: + description: A set of changed role attributes. type: object properties: name: type: string description: The updated display name of the role. + RoleItemBase: + description: Base properties for RoleItem. + type: object + properties: + name: + type: string + description: The role name. + RoleItemNumberKeys: + description: Role search response item. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/RoleItemBase" + properties: + key: + type: integer + description: The role key. + format: int64 + assignedMemberKeys: + type: array + description: The set of keys of members assigned to the role. + items: + type: integer + format: int64 RoleItem: description: Role search response item. type: object + allOf: + - $ref: "#/components/schemas/RoleItemBase" properties: key: - type: integer + type: string description: The role key. + assignedMemberKeys: + type: array + description: The set of keys of members assigned to the role. + items: + type: string + RoleSearchQueryRequest: + description: Role search request. + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + RoleSearchQueryResponseNumberKeys: + description: Role search response. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching roles. + type: array + items: + $ref: "#/components/schemas/RoleItemNumberKeys" + RoleSearchQueryResponse: + description: Role search response. + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching roles. + type: array + items: + $ref: "#/components/schemas/RoleItem" + + GroupCreateRequest: + type: "object" + properties: + name: + type: "string" + description: The display name of the new group. + GroupCreateResponseNumberKeys: + deprecated: true + type: object + properties: + groupKey: + description: The key of the created group. + type: integer + format: int64 + GroupCreateResponse: + type: object + properties: + groupKey: + description: The key of the created group. + type: string + GroupUpdateRequest: + type: object + properties: + changeset: + description: The set of changed group attributes. + allOf: + - $ref: "#/components/schemas/GroupChangeset" + required: + - changeset + GroupChangeset: + description: A set of changed group attributes. + type: object + properties: + name: + type: string + description: The updated display name of the group. + GroupItemBase: + description: Base properties for GroupItem. + type: object + properties: + name: + type: string + description: The group name. + GroupItemNumberKeys: + description: Group search response item. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/GroupItemBase" + properties: + groupKey: + type: integer + description: The group key. format: int64 + assignedMemberKeys: + type: array + description: The set of keys of members assigned to the group. + items: + type: integer + format: int64 + GroupItem: + description: Group search response item. + type: object + allOf: + - $ref: "#/components/schemas/GroupItemBase" + properties: + groupKey: + type: string + description: The group key. + assignedMemberKeys: + type: array + description: The set of keys of members assigned to the group. + items: + type: string + GroupSearchQueryRequest: + description: Group search request. + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + description: The group search filters. + allOf: + - $ref: "#/components/schemas/GroupFilterRequest" + GroupFilterRequest: + description: Group filter request + type: object + properties: + name: + type: string + description: The name of the group. + GroupSearchQueryResponseNumberKeys: + description: Group search response. Key attributes as numeric values. + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching groups. + type: array + items: + $ref: "#/components/schemas/GroupItemNumberKeys" + GroupSearchQueryResponse: + description: Group search response. + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching groups. + type: array + items: + $ref: "#/components/schemas/GroupItem" + + MappingRuleCreateRequest: + type: object + properties: + claimName: + type: string + description: The name of the claim to map. + claimValue: + type: string + description: The value of the claim to map. + name: + type: string + description: The name of the mapping. + required: + - claimName + - claimValue + - name + MappingRuleCreateResponseBase: + type: object + properties: + claimName: + type: string + description: The name of the claim to map. + claimValue: + type: string + description: The value of the claim to map. name: type: string - description: The role name. - assignedMemberKeys: + description: The name of the mapping. + MappingRuleCreateResponseNumberKeys: + type: object + allOf: + - $ref: "#/components/schemas/MappingRuleCreateResponseBase" + properties: + mappingKey: + description: The key of the created mapping rule. + type: integer + format: int64 + MappingRuleCreateResponse: + type: object + allOf: + - $ref: "#/components/schemas/MappingRuleCreateResponseBase" + properties: + mappingKey: + description: The key of the created mapping rule. + type: string + MappingSearchQueryResponseNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching mapping rules. type: array - description: The set of keys of members assigned to the role. items: - type: integer - format: int64 - RoleSearchQueryRequest: - description: Role search request. - allOf: - - $ref: "#/components/schemas/SearchQueryRequest" + $ref: "#/components/schemas/MappingItemNumberKeys" + MappingSearchQueryResponse: type: object - RoleSearchQueryResponse: - description: Role search response. allOf: - $ref: "#/components/schemas/SearchQueryResponse" - type: object properties: items: + description: The matching mapping rules. type: array items: - $ref: "#/components/schemas/RoleItem" + $ref: "#/components/schemas/MappingItem" + MappingItemBase: + type: "object" + properties: + claimName: + type: string + description: The name of the claim to map. + claimValue: + type: string + description: The value of the claim to map. + name: + type: string + description: The name of the mapping. + MappingItemNumberKeys: + type: "object" + allOf: + - $ref: "#/components/schemas/MappingItemBase" + properties: + mappingKey: + description: The key of the created mapping rule. + type: integer + format: int64 + MappingItem: + type: "object" + allOf: + - $ref: "#/components/schemas/MappingItemBase" + properties: + mappingKey: + description: The key of the created mapping rule. + type: string + TopologyResponse: description: The response of a topology request. type: object @@ -4590,28 +6274,30 @@ components: - type - timeout - maxJobsToActivate + JobActivationResponseNumberKeys: + description: The list of activated jobs + type: object + properties: + jobs: + description: The activated jobs. + type: array + items: + $ref: "#/components/schemas/ActivatedJobNumberKeys" JobActivationResponse: description: The list of activated jobs type: object properties: jobs: + description: The activated jobs. type: array items: $ref: "#/components/schemas/ActivatedJob" - ActivatedJob: + ActivatedJobBase: type: object properties: - jobKey: - 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 @@ -4619,19 +6305,9 @@ components: 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 @@ -4654,6 +6330,48 @@ components: tenantId: description: The ID of the tenant that owns the job type: string + ActivatedJobNumberKeys: + type: object + allOf: + - $ref: "#/components/schemas/ActivatedJobBase" + properties: + jobKey: + description: the key, a unique identifier for the job + type: integer + format: int64 + processInstanceKey: + description: the job's process instance key + type: integer + format: int64 + processDefinitionKey: + description: the key of the job's process definition + type: integer + format: int64 + elementInstanceKey: + description: > + the unique key identifying the associated task, unique within the scope of the + process instance + type: integer + format: int64 + ActivatedJob: + type: object + allOf: + - $ref: "#/components/schemas/ActivatedJobBase" + properties: + jobKey: + description: the key, a unique identifier for the job + type: string + processInstanceKey: + description: the job's process instance key + type: string + processDefinitionKey: + description: the key of the job's process definition + type: string + elementInstanceKey: + description: > + the unique key identifying the associated task, unique within the scope of the + process instance + type: string JobFailRequest: type: object properties: @@ -4727,6 +6445,59 @@ components: As a result, the completion request is rejected and the task remains active. Defaults to false. nullable: true + corrections: + $ref: "#/components/schemas/JobResultCorrections" + JobResultCorrections: + type: object + description: | + JSON object with attributes that were corrected by the worker. + + The following attributes can be corrected, additional attributes will be ignored: + + * `assignee` - reset by providing an empty String + * `dueDate` - reset by providing an empty String + * `followUpDate` - reset by providing an empty String + * `candidateGroups` - reset by providing an empty list + * `candidateUsers` - reset by providing an empty list + * `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. + nullable: true + properties: + assignee: + type: string + description: Assignee of the task. + nullable: true + dueDate: + type: string + format: date-time + description: The due date of the task. + nullable: true + followUpDate: + type: string + format: date-time + description: The follow-up date of the task. + nullable: true + candidateUsers: + type: array + description: The list of candidate users of the task. + items: + type: string + nullable: true + candidateGroups: + type: array + description: The list of candidate groups of the task. + items: + type: string + nullable: true + priority: + type: integer + format: int32 + description: The priority of the task. + minimum: 0 + maximum: 100 + nullable: true JobUpdateRequest: type: object properties: @@ -4791,11 +6562,13 @@ components: type: object properties: sort: + description: Sort field criteria. type: array items: allOf: - $ref: "#/components/schemas/SearchQuerySortRequest" page: + description: Pagination criteria. allOf: - $ref: "#/components/schemas/SearchQueryPageRequest" type: object @@ -4803,16 +6576,20 @@ components: type: object properties: from: + description: The index of items to start searching from. type: integer format: int32 limit: + description: The maximum number of items to return in one request. type: integer format: int32 searchAfter: + description: Items to search after. Correlates to the `lastSortValues` property of a previous search response. type: array items: type: object searchBefore: + description: Items to search before. Correlates to the `firstSortValues` property of a previous search response. type: array items: type: object @@ -4820,59 +6597,48 @@ components: type: object properties: field: + description: The field to sort by. type: string order: - type: string - default: asc + $ref: "#/components/schemas/SortOrderEnum" required: - field SearchQueryResponse: type: object properties: page: + description: Pagination information about the search results. allOf: - $ref: "#/components/schemas/SearchQueryPageResponse" - type: object SearchQueryPageResponse: + description: Pagination information about the search results. type: object properties: totalItems: + description: Total items matching the criteria. type: integer format: int64 firstSortValues: + description: The sort values of the first item in the result set. Use this in the `searchBefore` field of an ensuing request. type: array items: type: object lastSortValues: + description: The sort values of the last item in the result set. Use this in the `searchAfter` field of an ensuing request. 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: + description: The decision definition search filters. allOf: - $ref: "#/components/schemas/DecisionRequirementsFilterRequest" DecisionRequirementsFilterRequest: + description: Decision requirements search filter. type: object properties: decisionRequirementsKey: @@ -4892,22 +6658,31 @@ components: tenantId: type: string description: The tenant ID of the decision requirements. - DecisionRequirementsSearchQueryResponse: + DecisionRequirementsSearchQueryResponseNumberKeys: + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching decision requirements. + type: array + items: + $ref: "#/components/schemas/DecisionRequirementsItemNumberKeys" + DecisionRequirementsSearchQueryResponse: type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching decision requirements. type: array items: $ref: "#/components/schemas/DecisionRequirementsItem" - DecisionRequirementsItem: + DecisionRequirementsItemBase: + description: Base properties for DecisionRequirementsItem. type: object properties: - decisionRequirementsKey: - type: integer - format: int64 - description: The assigned key, which acts as a unique identifier for this decision requirements. name: type: string description: The DMN name of the decision requirements. @@ -4924,6 +6699,24 @@ components: tenantId: type: string description: The tenant ID of the decision requirements. + DecisionRequirementsItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/DecisionRequirementsItemBase" + properties: + decisionRequirementsKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this decision requirements. + DecisionRequirementsItem: + type: object + allOf: + - $ref: "#/components/schemas/DecisionRequirementsItemBase" + properties: + decisionRequirementsKey: + type: string + description: The assigned key, which acts as a unique identifier for this decision requirements. EvaluateDecisionRequest: type: object oneOf: @@ -4961,13 +6754,10 @@ components: tenantId: description: The tenant ID of the decision. type: string - EvaluateDecisionResponse: + EvaluateDecisionResponseBase: + description: Base properties for 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 @@ -4981,10 +6771,6 @@ components: 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. @@ -4998,17 +6784,46 @@ components: 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: + description: Decisions that were evaluated within the requested decision evaluation. type: array items: $ref: "#/components/schemas/EvaluatedDecisionItem" + EvaluateDecisionResponseNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/EvaluateDecisionResponseBase" + properties: + decisionDefinitionKey: + description: The unique key identifying the decision which was evaluated. + type: integer + format: int64 + decisionRequirementsKey: + description: The unique key identifying the decision requirements graph that the decision which was evaluated is part of. + type: integer + format: int64 + decisionInstanceKey: + description: The unique key identifying this decision evaluation. + type: integer + format: int64 + EvaluateDecisionResponse: + type: object + allOf: + - $ref: "#/components/schemas/EvaluateDecisionResponseBase" + properties: + decisionDefinitionKey: + description: The unique key identifying the decision which was evaluated. + type: string + decisionRequirementsKey: + description: The unique key identifying the decision requirements graph that the decision which was evaluated is part of. + type: string + decisionInstanceKey: + description: The unique key identifying this decision evaluation. + type: string EvaluatedDecisionItem: type: object - description: List of decisions that were evaluated within the requested decision evaluation. + description: A decision that was evaluated. properties: decisionDefinitionKey: description: The unique key identifying the decision which was evaluate. @@ -5035,16 +6850,18 @@ components: description: The tenant ID of the evaluated decision. type: string matchedRules: + description: The decision rules that matched within this decision evaluation. type: array items: $ref: "#/components/schemas/MatchedDecisionRuleItem" evaluatedInputs: + description: The decision inputs that were evaluated within this decision evaluation. type: array items: $ref: "#/components/schemas/EvaluatedDecisionInputItem" MatchedDecisionRuleItem: type: object - description: The decision rules that matched within this decision evaluation. + description: A decision rule that matched within this decision evaluation. properties: ruleId: description: The ID of the matched rule. @@ -5054,12 +6871,13 @@ components: type: integer format: int32 evaluatedOutputs: + description: The evaluated decision outputs. type: array items: $ref: "#/components/schemas/EvaluatedDecisionOutputItem" EvaluatedDecisionInputItem: type: object - description: The decision inputs that were evaluated within this decision evaluation. + description: A decision input that was evaluated within this decision evaluation. properties: inputId: description: The ID of the evaluated decision input. @@ -5089,9 +6907,11 @@ components: type: object properties: filter: + description: The decision instance search filters. allOf: - $ref: "#/components/schemas/DecisionInstanceFilterRequest" DecisionInstanceFilterRequest: + description: Decision instance search filter. type: object properties: decisionInstanceKey: @@ -5138,23 +6958,31 @@ components: tenantId: type: string description: The tenant ID of the decision instance. - DecisionInstanceSearchQueryResponse: + DecisionInstanceSearchQueryResponseNumberKeys: + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching decision instances. + type: array + items: + $ref: "#/components/schemas/DecisionInstanceItemNumberKeys" + DecisionInstanceSearchQueryResponse: type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" properties: items: + description: The matching decision instances. type: array items: $ref: "#/components/schemas/DecisionInstanceItem" - DecisionInstanceItem: + DecisionInstanceItemBase: type: object properties: - decisionInstanceKey: - type: integer - format: int64 - description: The key of the decision instance. Note that this is not the unique identifier of the entity itself; the `decisionInstanceId` serves as the primary identifier. decisionInstanceId: type: string description: The ID of the decision instance. @@ -5167,6 +6995,33 @@ components: evaluationFailure: type: string description: The evaluation failure of the decision instance. + 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/DecisionDefinitionTypeEnum" + result: + type: string + description: The result of the decision instance. + tenantId: + type: string + description: The tenant ID of the decision instance. + DecisionInstanceItemNumberKeys: + type: object + allOf: + - $ref: "#/components/schemas/DecisionInstanceItemBase" + properties: + decisionInstanceKey: + type: integer + format: int64 + description: The key of the decision instance. Note that this is not the unique identifier of the entity itself; the `decisionInstanceId` serves as the primary identifier. processDefinitionKey: type: integer format: int64 @@ -5179,24 +7034,23 @@ components: type: integer format: int64 description: The key of the decision. - decisionDefinitionId: + DecisionInstanceItem: + type: object + allOf: + - $ref: "#/components/schemas/DecisionInstanceItemBase" + properties: + decisionInstanceKey: type: string - description: The ID of the DMN decision. - decisionDefinitionName: + description: The key of the decision instance. Note that this is not the unique identifier of the entity itself; the `decisionInstanceId` serves as the primary identifier. + processDefinitionKey: type: string - description: The name of the DMN decision. - decisionDefinitionVersion: - type: integer - format: int32 - description: The version of the decision. - decisionDefinitionType: - $ref: "#/components/schemas/DecisionDefinitionTypeEnum" - result: + description: The key of the process definition. + processInstanceKey: type: string - description: The result of the decision instance. - tenantId: + description: The key of the process instance. + decisionDefinitionKey: type: string - description: The tenant ID of the decision instance. + description: The key of the decision. DecisionInstanceGetQueryResponse: allOf: @@ -5230,6 +7084,12 @@ components: - FAILED - UNSPECIFIED - UNKNOWN + SortOrderEnum: + description: The order in which to sort the related field. + enum: + - ASC + - DESC + default: ASC MessageCorrelationRequest: type: object @@ -5251,23 +7111,44 @@ components: description: the tenant for which the message is published type: string nullable: true - MessageCorrelationResponse: + MessageCorrelationResponseBase: + description: Base properties for MessageCorrelationResponse. + type: object + properties: + tenantId: + description: The tenant ID of the correlated message + type: string + MessageCorrelationResponseNumberKeys: description: | The message key of the correlated message, as well as the first process instance key it - correlated with. + correlated with. Key attributes as numeric values. + deprecated: true type: object + allOf: + - $ref: "#/components/schemas/MessageCorrelationResponseBase" 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 + MessageCorrelationResponse: + description: | + The message key of the correlated message, as well as the first process instance key it + correlated with. + type: object + allOf: + - $ref: "#/components/schemas/MessageCorrelationResponseBase" + properties: + messageKey: + description: The key of the correlated message + type: string + processInstanceKey: + description: The key of the first process instance the message correlated with + type: string MessagePublicationRequest: type: object properties: @@ -5301,16 +7182,32 @@ components: required: - name - correlationKey - MessagePublicationResponse: - description: The message key of the published message. + MessagePublicationResponseBase: + description: Base properties for MessagePublicationResponse. + type: object + properties: + tenantId: + description: The tenant ID of the message. + type: string + MessagePublicationResponseNumberKeys: + description: The message key of the published message. Key attributes as numeric values. + deprecated: true type: object + allOf: + - $ref: "#/components/schemas/MessagePublicationResponseBase" properties: messageKey: description: The key of the message type: integer format: int64 - tenantId: - description: The tenant ID of the message. + MessagePublicationResponse: + description: The message key of the published message. + type: object + allOf: + - $ref: "#/components/schemas/MessagePublicationResponseBase" + properties: + messageKey: + description: The key of the message type: string DocumentReference: @@ -5330,6 +7227,7 @@ components: metadata: $ref: "#/components/schemas/DocumentMetadata" DocumentMetadata: + description: Information about the document. type: object properties: contentType: @@ -5370,19 +7268,41 @@ components: format: date-time description: The date and time when the link expires. - DeploymentResponse: + DeploymentResponseBase: + description: Base properties for DeploymentResponse. + type: object + properties: + tenantId: + description: The tenant ID associated with the deployment. + type: string + DeploymentResponseNumberKeys: + deprecated: true type: object + allOf: + - $ref: "#/components/schemas/DeploymentResponseBase" properties: deploymentKey: type: integer format: int64 description: The unique key identifying the deployment. deployments: + description: Items deployed by the request. type: array items: - $ref: "#/components/schemas/DeploymentMetadata" - tenantId: + $ref: "#/components/schemas/DeploymentMetadataNumberKeys" + DeploymentResponse: + type: object + allOf: + - $ref: "#/components/schemas/DeploymentResponseBase" + properties: + deploymentKey: type: string + description: The unique key identifying the deployment. + deployments: + description: Items deployed by the request. + type: array + items: + $ref: "#/components/schemas/DeploymentMetadata" DeploymentMetadata: type: object properties: @@ -5394,7 +7314,19 @@ components: $ref: "#/components/schemas/DeploymentDecisionRequirements" form: $ref: "#/components/schemas/DeploymentForm" - DeploymentProcess: + DeploymentMetadataNumberKeys: + type: object + properties: + processDefinition: + $ref: "#/components/schemas/DeploymentProcessNumberKeys" + decisionDefinition: + $ref: "#/components/schemas/DeploymentDecisionNumberKeys" + decisionRequirements: + $ref: "#/components/schemas/DeploymentDecisionRequirementsNumberKeys" + form: + $ref: "#/components/schemas/DeploymentFormNumberKeys" + DeploymentProcessBase: + description: Base properties for DeploymentProcess. type: object properties: processDefinitionId: @@ -5406,17 +7338,33 @@ components: 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: + DeploymentProcessNumberKeys: + description: A deployed process. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentProcessBase" + properties: + processDefinitionKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this process. + DeploymentProcess: + description: A deployed process. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentProcessBase" + properties: + processDefinitionKey: + type: string + description: The assigned key, which acts as a unique identifier for this process. + DeploymentDecisionBase: + description: Base properties for DeploymentDecision. type: object properties: decisionDefinitionId: @@ -5428,11 +7376,6 @@ components: 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. @@ -5443,12 +7386,38 @@ components: type: string description: | The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment. + DeploymentDecisionNumberKeys: + description: A deployed decision. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentDecisionBase" + properties: + decisionDefinitionKey: + type: integer + format: int64 + description: | + The assigned decision key, which acts as a unique identifier for this decision. decisionRequirementsKey: type: integer format: int64 description: | The assigned key of the decision requirements graph that this decision is part of. - DeploymentDecisionRequirements: + DeploymentDecision: + description: A deployed decision. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentDecisionBase" + properties: + decisionDefinitionKey: + type: string + description: | + The assigned decision key, which acts as a unique identifier for this decision. + decisionRequirementsKey: + type: string + description: | + The assigned key of the decision requirements graph that this decision is part of. + DeploymentDecisionRequirementsBase: + description: Base properties for DeploymentDecisionRequirements. type: object properties: decisionRequirementsId: @@ -5465,15 +7434,32 @@ components: tenantId: type: string description: The tenant ID of the deployed decision requirements. + resourceName: + type: string + description: The resource name from which this decision requirements was parsed. + DeploymentDecisionRequirementsNumberKeys: + description: Deployed decision requirements. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentDecisionRequirementsBase" + properties: decisionRequirementsKey: type: integer format: int64 description: | The assigned decision requirements key, which acts as a unique identifier for this decision requirements. - resourceName: + DeploymentDecisionRequirements: + description: Deployed decision requirements. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentDecisionRequirementsBase" + properties: + decisionRequirementsKey: type: string - description: The resource name from which this decision requirements was parsed. - DeploymentForm: + description: | + The assigned decision requirements key, which acts as a unique identifier for this decision requirements. + DeploymentFormBase: + description: Base properties for DeploymentForm. type: object properties: formId: @@ -5485,16 +7471,31 @@ components: 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. + DeploymentFormNumberKeys: + description: A deployed form. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentFormBase" + properties: + formKey: + type: integer + format: int64 + description: The assigned key, which acts as a unique identifier for this form. + DeploymentForm: + description: A deployed form. + type: object + allOf: + - $ref: "#/components/schemas/DeploymentFormBase" + properties: + formKey: + type: string + description: The assigned key, which acts as a unique identifier for this form. CreateProcessInstanceRequest: type: object @@ -5586,14 +7587,10 @@ components: For now, however, the start instruction is implicitly a "startBeforeElement" instruction type: string - CreateProcessInstanceResponse: + CreateProcessInstanceResponseBase: + description: Base properties for 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. @@ -5604,12 +7601,6 @@ components: 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 @@ -5617,6 +7608,37 @@ components: additionalProperties: true description: All the variables visible in the root scope. type: object + CreateProcessInstanceResponseNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/CreateProcessInstanceResponseBase" + properties: + processDefinitionKey: + description: | + The key of the process definition which was used to create the process instance. + type: integer + format: int64 + 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 + CreateProcessInstanceResponse: + type: object + allOf: + - $ref: "#/components/schemas/CreateProcessInstanceResponseBase" + properties: + processDefinitionKey: + description: | + The key of the process definition which was used to create the process instance. + type: string + 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: string MigrateProcessInstanceRequest: type: object properties: @@ -5625,6 +7647,7 @@ components: type: integer format: int64 mappingInstructions: + description: Element mappings from the source process instance to the target process instance. type: array items: $ref: "#/components/schemas/MigrateProcessInstanceMappingInstruction" @@ -5656,10 +7679,12 @@ components: type: object properties: activateInstructions: + description: Instructions describing which elements should be activated in which scopes and which variables should be created. type: array items: $ref: "#/components/schemas/ModifyProcessInstanceActivateInstruction" terminateInstructions: + description: Instructions describing which elements should be terminated. type: array items: $ref: "#/components/schemas/ModifyProcessInstanceTerminateInstruction" @@ -5673,7 +7698,7 @@ components: ModifyProcessInstanceActivateInstruction: type: object description: | - Instructions describing which elements should be activated in which scopes and which variables should be created. + Instructions describing an element that should be activated. properties: elementId: description: The ID of the element that should be activated. @@ -5687,6 +7712,7 @@ components: format: int64 default: -1 variableInstructions: + description: Instructions describing which variables should be created. type: array items: $ref: "#/components/schemas/ModifyProcessInstanceVariableInstruction" @@ -5784,23 +7810,35 @@ components: type: string required: - signalName - SignalBroadcastResponse: + SignalBroadcastResponseBase: + description: Base properties for 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 - FormItem: + SignalBroadcastResponseNumberKeys: + deprecated: true type: object + allOf: + - $ref: "#/components/schemas/SignalBroadcastResponseBase" properties: - formKey: - description: The key of the form. + signalKey: + description: The unique ID of the signal that was broadcast. type: integer format: int64 + SignalBroadcastResponse: + type: object + allOf: + - $ref: "#/components/schemas/SignalBroadcastResponseBase" + properties: + signalKey: + description: The unique ID of the signal that was broadcast. + type: string + FormItemBase: + description: Base properties for FormItem. + type: object + properties: tenantId: description: The tenant ID of the form. type: string @@ -5814,6 +7852,24 @@ components: description: The version of the form. type: integer format: int64 + FormItemNumberKeys: + deprecated: true + type: object + allOf: + - $ref: "#/components/schemas/FormItemBase" + properties: + formKey: + description: The key of the form. + type: integer + format: int64 + FormItem: + type: object + allOf: + - $ref: "#/components/schemas/FormItemBase" + properties: + formKey: + description: The key of the form. + type: string responses: InternalServerError: description: > @@ -5828,6 +7884,12 @@ components: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" + Forbidden: + description: Forbidden. The request is not allowed. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" securitySchemes: bearerAuth: diff --git a/api/generate-api-docs.js b/api/generate-api-docs.js index 2a346ac99dd..e8dd7335ebd 100644 --- a/api/generate-api-docs.js +++ b/api/generate-api-docs.js @@ -2,15 +2,13 @@ const { execSync } = require("child_process"); // More strategies to come, for other APIs. const operate = require("./operate/generation-strategy"); -const zeebe = require("./zeebe/generation-strategy"); const tasklist = require("./tasklist/generation-strategy"); -const consolesm = require("./console-sm/generation-strategy"); +const adminsm = require("./administration-sm/generation-strategy"); const camunda = require("./camunda/generation-strategy"); const apiStrategies = { operate, - zeebe, tasklist, - consolesm, + adminsm, camunda, }; @@ -23,7 +21,7 @@ function runCommand(command) { // API name must be passed in as an arg. const api = process.argv[2]; if (api === undefined) { - const validAPIs = string.join(apiStrategies.join, ", "); + const validAPIs = Object.keys(apiStrategies).join(", "); console.log(`Please specify an API name. Valid names: ${validAPIs}`); process.exit(); } @@ -31,7 +29,7 @@ if (api === undefined) { // The API name must be recognized. const strategy = apiStrategies[api]; if (strategy === undefined) { - const validAPIs = string.join(apiStrategies.join, ", "); + const validAPIs = Object.keys(apiStrategies).join(", "); console.error(`Invalid API name ${api}. Valid names: ${validAPIs}`); process.exit(); } diff --git a/api/operate/operate-openapi.yaml b/api/operate/operate-openapi.yaml index 2ef6348a549..823e7248016 100644 --- a/api/operate/operate-openapi.yaml +++ b/api/operate/operate-openapi.yaml @@ -84,7 +84,6 @@ paths: searchAfter: - small - 9007199254741200 - required: true responses: "200": description: Success @@ -168,7 +167,6 @@ paths: sort: - field: bpmnProcessId order: ASC - required: true responses: "200": description: Success @@ -261,7 +259,6 @@ paths: sort: - field: bpmnProcessId order: ASC - required: true responses: "200": description: Success @@ -362,7 +359,6 @@ paths: searchAfter: - 1646904085499 - 9007199254743288 - required: true responses: "200": description: Success @@ -459,7 +455,6 @@ paths: searchAfter: - 1646904085499 - 9007199254743288 - required: true responses: "200": description: Success @@ -553,7 +548,6 @@ paths: sort: - field: decisionRequirementsId order: ASC - required: true responses: "200": description: Success @@ -645,7 +639,6 @@ paths: sort: - field: decisionId order: ASC - required: true responses: "200": description: Success @@ -737,7 +730,6 @@ paths: sort: - field: decisionId order: ASC - required: true responses: "200": description: Success @@ -1483,6 +1475,8 @@ components: processVersion: type: integer format: int32 + processVersionTag: + type: string bpmnProcessId: type: string parentKey: @@ -1501,6 +1495,8 @@ components: - ACTIVE - COMPLETED - CANCELED + incident: + type: boolean processDefinitionKey: type: integer format: int64 @@ -1549,6 +1545,8 @@ components: version: type: integer format: int32 + versionTag: + type: string bpmnProcessId: type: string tenantId: @@ -1602,6 +1600,7 @@ components: - UNKNOWN - IO_MAPPING_ERROR - JOB_NO_RETRIES + - EXECUTION_LISTENER_NO_RETRIES - CONDITION_ERROR - EXTRACT_VALUE_ERROR - CALLED_ELEMENT_ERROR diff --git a/api/zeebe/generation-strategy.js b/api/zeebe/generation-strategy.js deleted file mode 100644 index 06ebef03f02..00000000000 --- a/api/zeebe/generation-strategy.js +++ /dev/null @@ -1,49 +0,0 @@ -const replace = require("replace-in-file"); -const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); - -const outputDir = "docs/apis-tools/zeebe-api-rest/specifications"; -const specFile = "api/zeebe/zeebe-openapi.yaml"; - -function preGenerateDocs() { - hackChangesetDescription(); -} - -function postGenerateDocs() { - removeDuplicateVersionBadge(`${outputDir}/zeebe-rest-api.info.mdx`); -} - -module.exports = { - outputDir, - preGenerateDocs, - postGenerateDocs, -}; - -function hackChangesetDescription() { - // 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: `${specFile}`, - 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/zeebe-openapi.yaml b/api/zeebe/zeebe-openapi.yaml deleted file mode 100644 index 7bc6a5925e1..00000000000 --- a/api/zeebe/zeebe-openapi.yaml +++ /dev/null @@ -1,428 +0,0 @@ -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/administration-sm-api-overview.md b/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md index 932693c07f7..45bfb7b3056 100644 --- a/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md +++ b/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md @@ -15,4 +15,4 @@ See [the interactive Administration API Self-Managed Explorer][administration-ap An Open API UI is also available within a running instance of Console Self-Managed at `https://${base-url}/admin-api/openapi/docs`. -[administration-api-explorer]: ./specifications/sm-administration-api.info.mdx +[administration-api-explorer]: ./specifications/administration-api-self-managed.info.mdx diff --git a/docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx b/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx similarity index 97% rename from docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx rename to docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx index 5d84abb5475..357adbd146d 100644 --- a/docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx @@ -1,5 +1,5 @@ --- -id: sm-admin-api +id: administration-api-self-managed title: "Administration API (Self-Managed)" description: "Access the administration API of Console Self-Managed." sidebar_label: Introduction diff --git a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx index 43b170c8562..cca9bf58fdd 100644 --- a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx @@ -5,9 +5,9 @@ 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: eJzFV9uO2zYQ/RViXtoCXNu9AYFQFHAXSbBFtgmyXgSo4QeaGluMKVJLUus4hv69GFKW5cvuGujtyRI1PJw5M3M43oKt0ImgrLnJIYMlhmtd+4DOAweHvrLGo4dsCz+MRvSTo5dOVbQDMni/Ag7SmoAm0FdRVVrJiDf87MlkC14WWAp6UgHLiFU5OjaohFzXKqffsKkQMvDBKbMEfnTUvVEPNTKVowlqodAxu2ChQCaTw9BwMKLEl5H+ECU+sdlXQl6IEE37GEx55mpjlFkyZQYE6YMItT+l7cbkxBJ6phZM9AEKFDoUG2YdMzYAP3EETV1CNoXWEDjUpv+8MnZtYMYhqKBp57U13mq8ux3npTLjSg3uklcNhyWaNvsvxzwplCcPY8S1c2gCe0TnlTU7MnfR90hNmMfxf8JvHLJc+aDMsla+oF1zDGtEw0QdbBmdYsLkrBRGLLGk41pcP2C3p4tMGanrHFmvBslbEZiQgS21nQutN0wRLFPGB6E15ixW75fAmVYrZC1bxP+tzVGjG7Dx3qHuMOFS7v9EnOOxDxTNgRcR+n3sNORsIvxKKx9ieO+roEr1FQfP5HrPCHDY8/F8lts+nhBmw6kz/TM9+ESeInv7SA5LvF/8LX2RDn4aKmeDwXMRfqV9V3NnV+iAt69LEXAtqKyTSCEBtIBxMTFHnKRUJS0iHoBDEopwcVeMq2rH1d+Sox5dl0uAOWb5v9WB2ulLBABZVc+1kuz+47snwv2XFOXoFIciVwa9v8zrzvwZx0sMTskLAVvjJ+Giiw+1cphTjiJgLKuuHhLnB3zNuiTb+WeUlHSR54q+Cf2h160LoT2+UMp77QXhXGyi0zCiCNnFoVad7++TmOKl3d64/buzF2EvNr7jIMrQPxfp9fFN00bbNOTvT6MfTxvvjXVzlecYs/7zuaHmDt0juiuvcmTonE3BH9p8xFA745nYk6j1RVfXayGL7sZHE9wmXkFCGX9c8j6ihAKVY4nVqKFi6SkD3aA24+BR1o7ELptuYY7CoYNsOmtmHCrhRInRMJvOYqEXtp31gD6HAjIYCqL0SlRqKPcDoI9M+IgaNQK2aZprsuFwW1gfmmxbWRca4PAonBJzne4T+paYXYhaB8hAWyl0XD5XivTB9Oay8Ycblk6PgxSdcQj3avRqdF6irAtPoOwn0T1OEUJ1FicZn0Vqmh7ld2SXgt4R30lICx6h6L014O3DG+tKQU78/mkSa0yZhY3b24KPda58SF0Unfj2DvXiKs0/+Xcnno+lJJ2LinS62S66AacPQ1XVCi9k8P1gNBi1Y72QkfaUe4rGZ8Pher0eSFHWJhcDaUtiViuJxscJIs3g8K5d4Uebcyt9t1vZ+D50uECHRuKwBfLDyEdlfSiF6cG+xdDdFb1CPSBhu/9H8r/2aaoBGi6HlRbK9G7a1HVT6LqO+O71c2qfKWy3c+Hx3ummoeWHGt0mtfGu22KbcxoD8tjzW1jhpi2EKsS21HUUxuO/Zk1fDN6+npAK1+RWV75H5RrRdzJrNj3sX36LBmxiV2h+Bd76EOgVmlnTNH8B6kAKmA== sidebar_class_name: "get api-method" -info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api +info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed custom_edit_url: null hide_send_button: true --- diff --git a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx index 1de2f6077bd..6b108eaf1ed 100644 --- a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx @@ -5,9 +5,9 @@ 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: eJzlV99v2zYQ/leIe2oBxvZ+AYUwDMiKpciwbEWTYAMMP5zJs81GIhWSShsI+t+HoyRbsWWvGxLsoS+JJR8/fvzu7ju6BleSx2icvdSQwZribcA1XVH0RgWQ4CmUzgYKkNXw7WzG/zQF5U3JqyCDP+5AgnI2ko38LZZlblTCnH4MHFJDUBsqkD+VnneMpgU0mv/Gx5IggxC9sWuQe/g3GxJGk41mZcgLtxJxQ0LlVYjkJ9BIxlQUwqUNEa1qkQ8xKj6YKNqTiZXzIkT0kbTo1gvTA0xA7hGNLmI+4GqrYkkeJKycLzBCBtpVy5xG2bfBzPyQA4pQkjIrowRDT6BpWPT7ynjSkM27nRey39ktP5KKIAG1NrwJ5u8HVFeYB5IQTcw5+q2zweV0fXWuC2PPSzMZ5nenWMO8lQlcCP9WRvpMqmIde4SvXMiI4e42kP9iATEEs7akBa8UFS/9X4WT0DHqmjRSEQ77tNkqid7j4+i+6SwibjCmswWxwQcSSyI7OLQ7lqshj5fJ2802VfsMjIYRYxnrkmHCX4blhfNvW7uDpmGi38++O6ytC+eXRmuynJkfxpz6mvwD+bNgNAny3vl06qcxHyhW3obTddKZb/d6bR7IimgKEh7tmibisMzRk8D12tMa2SncA/lk47tVAq0Wxqq80sN6PerR8pTvyIR2pK8irgOnOEks+lG3kBBIVd7ER8jmNSwJPXnI5otmIaFEjwXF1NTz0a625r46MahAguHY+4o894rFghOfymxXd9FXJAfTcq/jGjm2dZIoKRkiFmW/8VDaIG5/v/xrEGOsKEyem0DKWR2OsEvIJwkems9TezpCmax+EcJkT+v5z3QXEgqKG9fdhtgEMG4ggylya55haaaptM+K7R0ppL5qK6PyOWRQt1s22XRab1yITVaXzscGJDygN7jMW2vl79o+XWGVM7HcKczT6zE/5S/4qL1k5+8vRbt7exFyfg/uzezNbBSJQ4+g7OTa4WxiLEdx2uBRpCRm31PXHNceuu+sbXl34AmKn7sA2X246JP26583ybGMXbm0vHPPZJomxPYim0i8uqZ8dXaFFtekXx8wP1fJTJgyHi52K9EZshjCsHdwnluIbyazyay7+aJKsre559OEbDr99OnTRGFRWY0T5QpWNjeKbCCO7Qr2t+6N3FusnQrb1cal56mnFXmyiqYdUJgmPUoXYoF2APuO4oiDd1YU9uWod9f3r8L/26qL9DlOyxxNGphJ/rpr9jlsm50z86TdF7Lr2jnU9RID3fq8afh160VpPJjALa63c/6o3K8+dF71WnzhFBllf0eP/TB5wLziAEjO+1+JPM9MOcG1Hy3PQ/c55skJsu1Y2VFd7Gw8XRAkbAh1ui3U3RJ2mHJ4wIOfxU9GzbtfbviuWHH1bX1xzwcTen/lto8D7B9/TgHixt2R/Ql62pEfoVk0TfM3+WOSPA== sidebar_class_name: "get api-method" -info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api +info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed custom_edit_url: null hide_send_button: true --- diff --git a/docs/apis-tools/administration-sm-api/specifications/sidebar.js b/docs/apis-tools/administration-sm-api/specifications/sidebar.js index 5c1953863bc..3d3722141b7 100644 --- a/docs/apis-tools/administration-sm-api/specifications/sidebar.js +++ b/docs/apis-tools/administration-sm-api/specifications/sidebar.js @@ -1,7 +1,7 @@ module.exports = [ { type: "doc", - id: "apis-tools/administration-sm-api/specifications/sm-admin-api", + id: "apis-tools/administration-sm-api/specifications/administration-api-self-managed", }, { type: "category", diff --git a/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md b/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md index a1274d69337..820ed96d30e 100644 --- a/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md +++ b/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md @@ -39,17 +39,4 @@ spring.servlet.multipart.max-request-size=4MB For example, if you increase the `maxMessageSize` to 10MB, increase these property values to 10MB as well. -### Query API - -:::warning -Query API endpoints do not currently support [resource authorizations][], and can be used to expand user access to restricted resources. If you use resource permissions, allowing public access to those endpoints is not recommended. -::: - -All Query API endpoints contain an `(alpha)` declaration. Those endpoints are not accessible by default in Camunda 8 clusters. - -You can enable the [alpha feature][] search endpoints by setting either the configuration property `camunda.rest.query.enabled` to `true`, -or the environment variable `CAMUNDA_REST_QUERY_ENABLED` to `true`. - [camunda-api-explorer]: ./specifications/camunda-8-rest-api.info.mdx -[resource authorizations]: /self-managed/concepts/access-control/resource-authorizations.md -[alpha feature]: /components/early-access/alpha/alpha-features.md diff --git a/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx index 85415e7aa9a..59492ca42e9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx @@ -5,7 +5,7 @@ description: "Iterate through all known partitions and activate jobs up to the r sidebar_label: "Activate jobs" hide_title: true hide_table_of_contents: true -api: eJztWVtv4zYW/isHfNkJVrE93Wl36rYLuMl069k2DRJPu0CSB0o6tphQpIak7LiG//vikLrZljMe7O7bBAgSiYfn+p0LqQ1zfGHZ+I691zF7iJgu0HAntJqmbMx44sSSO3yvY8silqJNjChomY3Z1BEpgsuMLhcZcCnhSemVgoIbJ4jKAlcp1FzgUccWygKcBpchGPxYonWYQs6fRV7mg3vFIla9/lGnazbe+EdhMGVjZ0qMWKKVQ+VoiReFFIlXd/hoSakNs0mGOaf/3LpANmY6fsTEsYgVhoxzAm27utmzidR61DHQagTcQopzoTAFobzKP17/egWF0QlaC69wsBjA938ixjh23D5dErE33DP44Z4VfJ2jcucWzVIkeM9g+I8zb2WlnXVGqAXbRmylzROafpUUzxH03KsQ6GqnCrWASmkbQa6tk2soLaYw1wakXiyIoihNoS3aA7kRU6WUPJYY3LuNmBM56tIdKsK9Zwy60pBH+NyhAZcJCwmFfiWkBKUdxNhEPIV4DVxpl6EJVKVyQnqNKznwSijI7Rlk3EKMqMAgTzJMu14SyuECDYvYXJucu/Dqmzfkt5w/EzxnelIJ7XdhBbGAQadbUMbrYEQFu08J/dtXJHSOLsl+50YE1x26SgrrKGLLisbL9LsIVTXMmtXvQMwB88KtI59HS2FFLLGznbvGa8S3Dr9WPtC0ZBNdNCgh7j4iMTYh63qUG8PXB+GPmHCYd/Kjwee2ycvZMXzM2pRuRCc6LyQSEFYZKjJCIifPqKCisB2saNOAquE020XJAKbzvuUfYBQBp2zlpXQNtoT1uXBs1/e0S2pKEC0lJYqwkApLDkl96epsorXWHJHnmAruUK4jwCWqYKDSB2YNTgIyFVevOxuP+pISFVdumtqXsDa9tD78ntZ6XKwykWQ7cH8MpXwPBsfCfqBKhYNQkO8CeVsz+rLxgZYdMaAeM2lwe1Pl23YbmNpCKxtq81ejUT+8aktbzJA5A/YZXeFUpq2PjjQQT9R67Jgnj+/+F677S9UTUhWAUomPJYJIUTkxF2iaTH/U8Wm18XiTo5VurXhlM11K6sRUolYZd7Ditm3RZ30tq2qEU2UdVwkeNehRx3+xTdsUFTnZeZoZ1c62vdJw0icoLnLVyJledgzsyE8bNi/Y1Mr6HY0VAUWHApdh8XRBLzWVA9EvIeS/FRk8ixJpPjnmT26tToTPCZpvoCKH6WWf62pmn4JDBWwyogL3uh5j9gRGNe1KuKwawXba3D6mTh0aktI6nf+MPEXTW1Mt+poQ6CALhM00mJZkM+Q6Rd83vuuMRRZotxFcij8xhfe3v11BqpOSXNNTVHia+nhxed0pEFXZ/8yZMFT7to75uWanWLTBMuhMVYt64p7rUnkHVGQgce7C3B5YNgWDyxVf0+QGhbbCiSWenYb2FHkqheqpT76T1oUp4Wp3ouQLLlQElnDonf3havpvwEJToxM5Wsfz4jQUNNPVoQ4TGsKa4asex6qDi88Fj8PIjwSl18t1hzLS5HOjXTf5/jbVlrNAB46KtF4pe9gTOlNb3XvrfpzSQW/bXdnryqEPV235zbFOXBi9FCmlAnec5h2a/JdcimreOdKPC6NjiflfP9WXJ3AdKCFFx4WE4MFwIiPCOJzJ7m5+uoBv33z994dXmXOFHQ+Hq9VqYObJOabCaTPQZjE084R+ie5sALMMDZ0H1h5XTUCgbdBgC0zEXCR1wCu1fdfcmec+cbjcP2w1ECyNODhPT+DDzfSgIu6I7o6JjMe6dONYcvXE2nAeCt2XYss852bdKaEdAduIWcdd2R1hjmbxPm8Cxs+z2TUEFpDoFKuhRdhaEBmRC0WHMTZ+Mxr5mTE8fTMa+cJAET/BEgX4XEiuQsbtmUPnBW2wwo83rG4S/6PIaCMWYl/uYCfpKhBfBotCSn3dl1ITBeRlQzhEY7QBnSSlMf7gJGTT6GrZ1Vz2Jde+5NqXXDuWa3Q5hC7TdJNZaH+1U3CXsTEb0uFt2LZrFjG6ofOz4N2GlUayMduEhNmOh8NNpq3bjjeFNm47XFI0dmYHWg6JVQNG6oTLLAg9DBwtdOe3C56XKuXwFm7e3c7gn9zhiq+9I0nkLuu3o7ejXq5EeoTj5HoKwcIAu04pqNlSTveyDcSnMN5uH8iRSWmEW9/StuCeGLlBMynJ9w0cKnmeOz0HIhZV//xUg+T9HzMfZypjN+3V8LtnTncxffiqp+b2TXOnOeq9LxwdXOjd1XsfDu+9RjvXMS2lR/1ce40qTB46i5BTHyjZaPD6EP/XU5/Gic7zUvlarhb+/AO84/xEltaR0yMmRYI0sY03jDDVEftLWIHqCAuvBwScgO66hC+Ey8p4kOh8mIRtzd9Y6niYc6GGlQg7vJj8+uHqcnL+y/Ti3dXtu/PXg9HAPTsfIEqxnKuOHpO9S6cdSzdt3/q/fUqokOHw2Q0LyYUi8Hv7N1UpuGOVbp1i8BBVCX3HNpuYW/xg5HZLrz+WaNZsfPfQ5j89bSMWToi+etC1xphdBOPOZ+GGbMll6a+J9i+ntlG9Y5IkWLgXaR86Fe36t9sZZUv1mYTOomzMDF/RJxS+YmN2z+4Zo0863n/+Wwq93zDJ1aLkC6IPfOnnP78PFGE= +api: eJztWm1vGzcS/isEv1yMW6+UXtrLbdsDFDtt5baOYSu9A2x/4O6OtLS55IbkSlYF/ffDkPsmaWUrRQ5oAQUIEomz8/rMPFyRK2rZzNDoll6omN4HVBWgmeVKjlMaUZZYPmcWLlRsaEBTMInmBS7TiI4tigKxmVblLCNMCPIo1UKSgmnLUcoQJlNSayEPKjakLIhVxGZANHwqwVhISc6eeF7m4Z2kAa2+fqfSJY1W7iPXkNLI6hICmihpQVpcYkUheOLcHTwYdGpFTZJBzvB/dlkAjaiKHyCxNKCFxuAsB9OurrZiQrceVExwNSDMkBSmXEJKuHQuv7v69ZIUWiVgDHkF4Swk3/0OEENkmXk8R2EXuFPw/R0t2DIHaU8N6DlP4I6Swb9PXJSVd8ZqLmd0HdCF0o+g+12SLAeips4FL1cnlcsZqZw2AcmVsWJJSgMpmSpNhJrNUKIodaEMmB27AZWlECwW4NO7DqjlOajS7jrCXGY02FJjRtjUgiY244YkWPoFF4JIZUkMTcVTEi8Jk8pmoL1UKS0XzuPKDnnFJcnNCcmYITGAJBpYkkHazRKXFmagaUCnSufM+q++eYN5y9kTwnOiRpXR/hRWEPMYtKoFZbz0QVSwe8noP75Co1OwSfYb09ynbjdVghuLFZtXMs6mewpRVcOsWf2W8CmBvLDLwPXRnBseC+g8zmyTNdRbl19JV2hcMokqGpSgdleRGJqSdTPKtGbLnfIHlFvIO/3R4HPd9OVkHz4mbUs3phOVFwIQCIsMJAYhgGFmpHeRmw5WlG5A1WiabKIkJONp3/L3ZBgQht3KSmEbbHHjemHfU9/hU0JhgyghsFG4ISk3mJDUja7OQ7jWhsPzHFLOLIhlQGAO0gco1U5Y4UFAxuHqfKfRsK8pQTJpx6l5Dmvjc+PK72SNw8Ui40m2AfcHP8q3YLCv7DuuVDjwA/nWi7czo68b73HZogLkmFGD2+uq39Zrr9QUSho/m78aDvvhVUfaYgbDCelnsMKhStsc7SEQJ9SrcNe7F7LdWGBCfJjS6PaPkxeudGfAK5OpUiDD4uhZZMySBTMt9Z70UVFFcC2d4Wagz1pc5LKhw/F5x/DfTPN92qg5yNZvoA33Vds1OPeLhxt6boiDACTnfcExY1TCXR2R3EklTsbnfXEkpbEq/wlYCrq3Sw04lHk5knnBZn+RlqiI5CoFN4m+7RCtIfi05kzw3yElFzcfLkmqkhK96YEpS1OXBCauOqCpBsln7jL8/GgB7ZjyQcV9GdBgdYXPnmTmqpQuAZUYETC1fifoVTZQZWLBlrgXIIUy3PI5nBxWzxRYKrjs6Qw3m+uWSJjc3KOwGeMyIAaL65L98XL8XwKFwtHJczCW5cVhm5GGr3d9GCGtN3ReE3y1FXYAcwQeOJIpnV+2S/PoyedWu6aN/jnVNqyXIxbHg1rIZoOyW+Z1O83rCZ9eqPgdM0DX9z0z8mdY9iPiEXCvQ0rJP5VAeArS8ikH3exn9sCs6vaxNJbJBPbq35wNvBJHsweNoef8/iNzrh42L7ld5QOtVDlZ1nv8rYEU1LILbrPq/WRjD7gde997x5560nV3ZYu3PVO7Z7tcO5dpmLC8lCkLWcHDR1iaUJZ5DPrvRx4+8vCRh488fOThvzgPP5f0L8nMB9j50lz9nMk/GXvvd3UPLi4dDf8MS3MAs28IH8DxHpNHjj9y/JHjjxx/5Pi/Oscf37X/hO/aKPNm3+/ihVZznuJoY5bh6QOew82Z4NXpw55fxwutYgH5i8w9IldekqRgGRfEd4Q/H0XB2J+Q3l7/cEb+9ebrf96/yqwtTDQYLBaLUE+TU0i5VTpUejbQ0wT/otxJSCYZaDydW7o50TQYacFNTAEJn/KkbuDKbce/G6crLzD49tFnM1JKzXdOt0fk4/V4BxYbpruHNpTFqrRRLJh8pG05d41uWzFlnjO97OCoY2AdUGOZLbsbmL1TeVs3AuOnyeSKeBUkUSlUDc9NbQiDyLnEo1EavRkO3QmO//TNcOgGPVb8gEgkgadCMOkn6FY4eHqnNFT4cYHVnfKFKqM0n/Ftu+FG01UgPvcR+Zb6uq+lRpJgljXiELRWmqgkKbV2x5hcNN1e2652eMdeO/basdf29Rpe1QCbKbxXVCh30aJgNqMRHeCr26DdftGA4n0Zt7e/XdFSCxrRlW+YdTQYrDJl7DpaFUrb9WCO1djYC+Kyb6waMEIlTGTe6G7hcKG7Hz/zL7jkLbl+fzMhPzILC7Z0iUSTm6rfDt8Oe7Wi6B6No6sx8RF62HVGQa0We7pXrRc+RPEa94gGklJzu7zBx3x6YmAa9KjE3DdwqOw57fjZC9Gg+s8PNUgu/jNxdcYxdt1e1Hr/xPBmRB++6reg9pvmhtGw9/bOcOd6zW397P3uLZThxuWIVtKhfqqcRxUmd5OFyKlfgekwfL2L/6uxa+NE5Xkp3SyXM7cJJKyT/ESUxmLSAyp4Arhji1YUMdUx+4tfIdVLN3kdInA8uusRPuM2K+MwUfmg+pml+TcWKh7kjMtBZcIMzka/frw8H53+Mj57f3nz/vR1OAztk3UFwhbLmez4Mdq6ArIR6arlrf/bxb4KGRae7KAQjEsEv4t/VY2CW1r51hkG90HV0Ld0tYqZgY9arNf49acS9JJGt/dt/+OndUD9G7+bHvgOEtEzH9zpxN9XmTNRuh+Jtq+KrIP6iVGSQGGflb3vTLSrDzcT7Jbq0iL+tkAjqtkCLzSyBY3oHb2jFC9Yuvy5m434/YoKJmclm6G814t//gffQZhf sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,15 +37,19 @@ Iterate through all known partitions and activate jobs up to the requested maxim The list of activated jobs. -