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 8c6e3c1dc14..18390c8a3f3 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/api/camunda/camunda-openapi.yaml @@ -49,6 +49,7 @@ tags: - name: Signal - name: Tenant - name: User + - name: Usage metrics - name: User task - name: Variable @@ -100,6 +101,12 @@ paths: 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": @@ -126,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. @@ -385,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: @@ -430,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: @@ -468,6 +493,12 @@ paths: 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: @@ -790,6 +821,12 @@ paths: application/json: schema: $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 provided data is not valid. content: @@ -932,6 +969,12 @@ paths: application/json: schema: $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: > The provided data is not valid. @@ -1027,6 +1070,12 @@ paths: application/json: schema: $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 user task was found, but no form is associated with it. @@ -1113,6 +1162,12 @@ paths: 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. @@ -1158,6 +1213,12 @@ paths: 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 variables search query failed. @@ -1191,6 +1252,12 @@ paths: 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. @@ -1230,6 +1297,12 @@ paths: application/json: schema: $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: @@ -1326,6 +1399,12 @@ paths: application/json: schema: $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 definition search query failed. @@ -1365,6 +1444,12 @@ paths: 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 process definition request failed. @@ -1468,6 +1553,12 @@ paths: application/json: schema: $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. @@ -1528,6 +1619,12 @@ paths: application/json: schema: $ref: "#/components/schemas/CreateProcessInstanceResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $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": @@ -1556,6 +1653,12 @@ paths: application/json: schema: $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 provided data is not valid. content: @@ -1596,6 +1699,12 @@ paths: application/json: schema: $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 process instance search query failed. @@ -1763,6 +1872,12 @@ paths: application/json: schema: $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponse" "400": description: > The Flow node instance search query failed. @@ -1802,6 +1917,12 @@ paths: application/json: schema: $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 flow node instance request failed. @@ -1847,6 +1968,12 @@ paths: application/json: schema: $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 definition search query failed. @@ -1886,6 +2013,12 @@ paths: application/json: schema: $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 definition request failed. @@ -1978,6 +2111,12 @@ paths: application/json: schema: $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponse" + application/vnd.camunda.api.keys.number+json: + schema: + $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponseNumberKeys" + application/vnd.camunda.api.keys.string+json: + schema: + $ref: "#/components/schemas/DecisionRequirementsSearchQueryResponse" "400": description: > The search query failed. @@ -2017,6 +2156,12 @@ paths: application/json: schema: $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 decision requirements request failed. @@ -2109,6 +2254,12 @@ paths: 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 decision instance search query failed. @@ -2205,6 +2356,12 @@ paths: application/json: schema: $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 provided data is not valid. content: @@ -2291,6 +2448,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 authorization search query failed. @@ -2327,6 +2490,12 @@ paths: 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. @@ -2364,6 +2533,12 @@ paths: 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": @@ -2464,6 +2639,12 @@ paths: 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. @@ -2501,6 +2682,12 @@ paths: 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. @@ -2538,6 +2725,12 @@ paths: 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": @@ -2731,6 +2924,12 @@ paths: 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. @@ -2770,6 +2969,12 @@ paths: 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: @@ -2841,7 +3046,13 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/MappingSearchResponse" + $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. @@ -2881,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: @@ -2912,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: @@ -3146,6 +3369,12 @@ paths: 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. @@ -3189,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. @@ -3233,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. @@ -3304,6 +3545,12 @@ 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. @@ -3339,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. @@ -3361,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: @@ -3397,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. @@ -3507,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: @@ -3536,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 @@ -3553,40 +3868,76 @@ components: required: - name - TenantUpdateResponse: + TenantUpdateResponseBase: + description: Base properties for TenantUpdateResponse. type: object properties: - tenantKey: - type: integer - description: The unique system-generated internal tenant ID - format: int64 tenantId: type: string description: The unique external tenant ID name: type: string description: The name of the tenant. - - TenantItem: - description: Tenant search response item. + 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: + 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. + 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 @@ -3610,44 +3961,29 @@ components: type: string description: The name of the tenant. - TenantSearchQueryResponse: - description: Tenant search response. + TenantSearchQueryResponseNumberKeys: + description: Tenant search response. Key attributes as numeric values. + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" - type: object properties: items: description: The matching tenants. type: array items: - $ref: "#/components/schemas/TenantItem" - - MappingItem: - description: Mapping rule search response item. + $ref: "#/components/schemas/TenantItemNumberKeys" + TenantSearchQueryResponse: + description: Tenant search response. type: object - properties: - mappingKey: - type: integer - description: The unique system-generated internal mapping ID. - format: int64 - claimName: - type: string - description: The claim name to match against a token. - claimValue: - type: string - description: The value of the claim to match. - - MappingSearchQueryResponse: - description: Mapping rule search response. allOf: - $ref: "#/components/schemas/SearchQueryResponse" - type: object properties: items: - description: The matching mapping rules. + description: The matching tenants. type: array items: - $ref: "#/components/schemas/MappingItem" + $ref: "#/components/schemas/TenantItem" UserTaskSearchQueryRequest: allOf: @@ -3664,11 +4000,23 @@ components: - $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. @@ -3747,13 +4095,10 @@ components: value: type: string description: The value of the variable. - UserTaskItem: + UserTaskItemBase: + description: Base properties for UserTaskItem. type: object properties: - userTaskKey: - description: The key of the user task. - type: integer - format: int64 name: type: string description: The name for this user task. @@ -3771,10 +4116,6 @@ components: 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. @@ -3788,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. @@ -3837,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" @@ -3877,25 +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 @@ -3905,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 @@ -3913,12 +4313,21 @@ 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" @@ -3955,23 +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 @@ -3991,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: @@ -4276,25 +4711,33 @@ components: 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 + items: + $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. @@ -4308,18 +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 startDate: type: string description: The start date. @@ -4336,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: @@ -4435,31 +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 @@ -4516,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: @@ -4633,34 +5140,34 @@ components: 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. @@ -4684,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. @@ -4700,30 +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 - tenantId: - description: The tenant ID of the incident. + IncidentItem: + type: object + allOf: + - $ref: "#/components/schemas/IncidentItemBase" + properties: + incidentKey: type: string - DecisionDefinitionSearchQueryResponse: + description: The assigned key, which acts as a unique identifier for this incident. + processDefinitionKey: + type: string + description: The process definition key associated to this incident. + processInstanceKey: + type: string + description: The process instance key associated to this incident. + flowNodeInstanceKey: + type: string + description: The flow node instance key associated to this incident. + jobKey: + type: string + description: The job key, if exists, associated with this incident. + DecisionDefinitionSearchQueryResponseNumberKeys: + deprecated: true + type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching decision definitions. + type: array + items: + $ref: "#/components/schemas/DecisionDefinitionItemNumberKeys" + DecisionDefinitionSearchQueryResponse: type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" 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. @@ -4737,13 +5290,49 @@ 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: @@ -4843,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 @@ -4865,6 +5450,34 @@ components: 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/AuthorizationResponseNumberKeys" AuthorizationSearchResponse: type: object allOf: @@ -4890,13 +5503,20 @@ components: 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" @@ -4938,60 +5558,60 @@ components: claimValue: type: string description: The value of the claim to match. - CamundaUser: - type: "object" + 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" - userKey: - description: The system generated key of the user. - type: "integer" - format: "int64" + type: string displayName: description: The display name of the user. - type: "string" + type: string authorizedApplications: description: The applications the user is authorized to use. type: array items: - type: "string" + type: string tenants: description: The tenants the user is a member of. type: array items: - type: "object" + type: object properties: tenantId: - type: "string" + type: string description: The ID of the tenant. name: - type: "string" + type: string description: The name of the tenant. groups: description: The groups assigned to the user. type: array items: - type: "string" + type: string roles: description: The roles assigned to the user. type: array items: - type: "string" + type: string salesPlanType: description: The plan of the user. - type: "string" + type: string c8Links: description: The links to the components in the C8 stack. type: array items: - type: "object" + type: object properties: name: - type: "string" + type: string description: The name of the component. link: - type: "string" + type: string description: A link to the component. canLogout: description: Flag for understanding if the user is able to perform logout. @@ -4999,17 +5619,31 @@ components: apiUser: description: Flag for understanding if the user is an API user. type: boolean - UserResponse: + 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: description: The ID of the user. type: "integer" format: "int64" - key: - description: The key of the user. - type: "integer" - format: "int64" username: description: The username of the user. type: "string" @@ -5019,6 +5653,34 @@ components: 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: @@ -5054,13 +5716,20 @@ components: name: type: "string" 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" + type: string RoleUpdateRequest: type: object properties: @@ -5077,33 +5746,66 @@ components: name: type: string description: The updated display name of the role. - RoleItem: - description: Role search response item. + 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 - name: - type: string - description: The role name. 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: 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" - type: object properties: items: description: The matching roles. @@ -5117,13 +5819,20 @@ components: 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" + type: object properties: groupKey: description: The key of the created group. - type: "integer" - format: "int64" + type: string GroupUpdateRequest: type: object properties: @@ -5140,23 +5849,44 @@ components: name: type: string description: The updated display name of the group. - GroupItem: - description: Group search response item. + 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 - name: - type: string - description: The group name. 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: @@ -5174,11 +5904,23 @@ components: 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" - type: object properties: items: description: The matching groups. @@ -5195,23 +5937,54 @@ components: claimValue: type: string description: The value of the claim to map. + name: + type: string + description: The name of the mapping. required: - claimName - claimValue - MappingRuleCreateResponse: + - name + MappingRuleCreateResponseBase: type: object properties: - mappingKey: - description: The key of the created mapping rule. - type: integer - format: int64 claimName: type: string description: The name of the claim to map. claimValue: type: string - description: The value of the claim to map. - MappingSearchResponse: + description: The value of the claim to map. + name: + type: string + 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 + items: + $ref: "#/components/schemas/MappingItemNumberKeys" + MappingSearchQueryResponse: type: object allOf: - $ref: "#/components/schemas/SearchQueryResponse" @@ -5220,20 +5993,36 @@ components: description: The matching mapping rules. type: array items: - $ref: "#/components/schemas/MappingResponse" - MappingResponse: + $ref: "#/components/schemas/MappingItem" + MappingItemBase: type: "object" properties: - mappingKey: - description: The key of the created mapping rule. - type: integer - format: int64 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. @@ -5485,6 +6274,15 @@ 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 @@ -5494,20 +6292,12 @@ components: 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 @@ -5515,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 @@ -5550,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: @@ -5623,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: @@ -5783,23 +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. @@ -5816,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: @@ -5853,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 @@ -5873,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. @@ -5890,15 +6784,43 @@ 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: A decision that was evaluated. @@ -6036,10 +6958,21 @@ 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. @@ -6047,13 +6980,9 @@ components: 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. @@ -6066,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 @@ -6078,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: @@ -6156,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: @@ -6206,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: @@ -6276,8 +7268,18 @@ 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 @@ -6287,10 +7289,20 @@ components: description: Items deployed by the request. type: array items: - $ref: "#/components/schemas/DeploymentMetadata" - tenantId: - description: The tenant ID associated with the deployment. + $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: @@ -6302,8 +7314,19 @@ components: $ref: "#/components/schemas/DeploymentDecisionRequirements" form: $ref: "#/components/schemas/DeploymentForm" - DeploymentProcess: - description: A deployed process. + 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: @@ -6315,18 +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: - description: A deployed decision. + 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: @@ -6338,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. @@ -6353,13 +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: - description: Deployed decision requirements. + 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: @@ -6376,16 +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: A deployed form. + 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: @@ -6397,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 @@ -6498,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. @@ -6516,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 @@ -6529,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: @@ -6700,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 @@ -6730,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: > diff --git a/api/generate-api-docs.js b/api/generate-api-docs.js index 6c6f2de56a4..e8dd7335ebd 100644 --- a/api/generate-api-docs.js +++ b/api/generate-api-docs.js @@ -3,12 +3,12 @@ const { execSync } = require("child_process"); // More strategies to come, for other APIs. const operate = require("./operate/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, tasklist, - consolesm, + adminsm, camunda, }; @@ -21,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(); } @@ -29,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/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/specifications/activate-jobs.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx index 888d6b44c49..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/isHfNkJVrE93Wl36rYLuMl069k2DRJPu0CSB0o6tpihSA1J2XEN//fFIXWzLSce7O7bBAgSiYfn+p0LqQ1zfGHZ+I691zF7iJgu0HAntJqmbMx44sSSO3yvY8silqJNjChomY3Z1BEpgsuMLhcZcCnho9IrBQU3ThCVBa5SqLnAo44tlAU4DS5DMPipROswhZw/ibzMB/eKRax6/aNO12y88Y/CYMrGzpQYsUQrh8rREi8KKRKv7vDRklIbZpMMc07/uXWBbMx0/IiJYxErDBnnBNp2dbNnE6n1qGOg1Qi4hRTnQmEKQnmVf7z+9QoKoxO0Fl7hYDGA7/9EjHHsuP14ScTecM/gh3tW8HWOyp1bNEuR4D2D4T/OvJWVdtYZoRZsG7GVNh/R9KukeI6g516FQFc7VagFVErbCHJtnVxDaTGFuTYg9WJBFEVpCm3RHsiNmCql5LHE4N5txJzIUZfuUBHuPWPQlYY8wucODbhMWEgo9CshJSjtIMYm4inEa+BKuwxNoCqVE9JrXMmBV0JBbs8g4xZiRAUGeZJh2vWSUA4XaFjE5trk3IVX37whv+X8ieA505NKaL8LK4gFDDrdgjJeByMq2L0k9G9fkdA5uiT7nRsRXHfoKimso4gtKxov0+8iVNUwa1a/AzEHzAu3jnweLYUVscTOdu4arxHfOvxa+UDTkk100aCEuPuIxNiErOtRbgxfH4Q/YsJh3smPBp/bJi9nx/Axa1O6EZ3ovJBIQFhlqMgIiZw8o4KKwnawok0DqobTbBclA5jO+5Z/gFEEnLKVl9I12BLW58KxXd/TLqkpQbSUlCjCQiosOST1pauzidZac0SeYyq4Q7mOAJeogoFKH5g1OAnIVFy97mw86ktKVFy5aWqfw9r00vrwe1rrcbHKRJLtwP0xlPI9GBwL+4EqFQ5CQb4L5G3N6MvGB1p2xIB6zKTB7U2Vb9ttYGoLrWyozV+NRv3wqi1tMUPmDNhndIVTmbY+OtJAPFEvw0PtXvD2cQn/wnV/OfuIVCmgVOJTiSBSVE7MBZqmGjzq+LT6ebwR0kq3nryymS4ldWsqY6uMO1hx27bxs762VjXLqbKOqwSPGvSo47/YprWKipzsPM2MamfbgmmA6RMUF7lq5EwvOwZ25KcNm2dsamX9jsaKgLRDgcuweLqg5xrPgejnEPLfigyeRYk0wxzzJ7dWJ8LDnWYgqMhhetnnuprZS3CogE1GVOBe16POnsCopl0Jl1Vj2k4r3MfUqYNFUlqn85+Rp2h6665FXzcCHWSBsJkY05Jshlyn6HvLd53RyQLtNoJL8Sem8P72tytIdVKSa3oKD09THy8urzsFomoNnzk3ho7Qlig/++wUizZYBp2palFP3HNdKu+Aigwkzl2Y7QPLpmBwueJrmu6g0FY4scSz09CeIk+lUD31yXfbujAlXO1OnXzBhYrAEg69sz9cTf8NWGhqhiJH63henIaCZgI71GFCg1ozoNUjW3W48bngcRj5saH0ernu4EaafG6060Ggv/O05SzQgaMirVfKHvaEzmRX9+e6Z6d0GNx2V/Y6d+jVVet+c6xbF0YvRUqpwB2nmYhOB0suRTUTHenZhdGxxPyvL/XuCVwHSkjRcSEheDCc2ogwDue2u5ufLuDbN1///eFV5lxhx8PharUamHlyjqlw2gy0WQzNPKFfojsbwCxDQ2eGtcdVExBoGzTYAhMxF0kd8Ept3zV3Zr4XDqD7B7IGgqURB2fuCXy4mR5UxB3R3VGS8ViXbhxLrj6yNpyHQvel2DLPuVl3SmhHwDZi1nFXdkeYo1m8z5uA8fNsdg2BBSQ6xWpoEbYWREbkQtGBjY3fjEZ+rgxP34xGvjBQxE+wRAE+FZKrkHF75tCZQhus8OMNq5vE/ygy2oiF2Jc72Em6CsSXwaKQUl/3pdREAXnZEA7RGG1AJ0lpjD9cCdk0ulp2NZd9ybUvufYl147lGl0gocs03XYW2l//FNxlbMyGdHgbtu2aRYxu8fwseLdhpZFszDYhYbbj4XCTaeu2402hjdsOlxSNndmBlkNi1YCROuEyC0IPA0cL3fntguelSjm8hZt3tzP4J3e44mvvSBK5y/rt6O2olyuRHuE4uZ5CsDDArlMKaraU071sA/EpjLfbB3JkUhrh1re0LbgnRm7QTEryfQOHSp7nTs+BiEXVPz/VIHn/x8zHmcrYTXt9/O6J031NH77qqbl909x7jnrvFEcHl3539d6Hw7ux0c6VTUvpUT/XXqMKk4fOIuTUB0o2Grw+xP/11KdxovO8VL6Wq4U//wDvOD+RpXXk9IhJkSBNbOMNI0x1xP4SVqA6wsLrAQEnoLsu4QvhsjIeJDofJmFb8zeWOh7mXKhhJcIOLya/fri6nJz/Mr14d3X77vz1YDRwT84HiFIs56qjx2TvYmrH0k3bt/5vnxsqZDh8csNCcqEI/N7+TVUK7lilW6cYPERVQt+xzSbmFj8Yud3S608lmjUb3z20+U9P24iFE6KvHnStMWYXwbjzWbhFW3JZ+mui/QusbVTvmCQJFu5Z2odORbv+7XZG2VJ9SqGzKBszw1f0mYWv2Jjds3vG6LOP95//3kLvN0xytSj5gugDX/r5Dxt+IOU= +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 @@ -41,15 +41,15 @@ The list of activated jobs. The activated jobs. -
  • Array [
    • customHeaders object
    +
  • Array [
  • ]
    • Schema
      jobs object[]
      -a set of custom headers defined during modelling; returned as a serialized JSON document +The activated jobs. -
      variables object
      +
    • Array [
    • ]
    Schema
      jobs object[]
      -All variables visible to the task scope, computed at activation time +The activated jobs. -
    • ]
    +
  • Array [
  • ]
    • The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx index 2ccbc676fe3..a328fa04332 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx @@ -5,7 +5,7 @@ description: "Broadcasts a signal." sidebar_label: "Broadcast signal" hide_title: true hide_table_of_contents: true -api: eJztWFFv2zYQ/ivEPW2YYrld2mV6c9N0S9emQeJsD4kfTtLZYiuRKknFMQT99+FEyZYjp+uAPiaAEcs83nf33X2UTjU4XFmIbuFarhTmsAhAl2TQSa3OU4ggNhrTBK3rDAJIySZGlmwBEbzp161AYVubCQRg6GtF1r3R6Qaiur2UhlKInKkogEQrR8rxEpZlLpMWMPxs2WcNNsmoQP7mNiVBBDr+TImDAErD4TlJtrVr8S6wIL7aD2yekVBYkNBL4TLqYhNOi21KHGgHYJ2RagVNAPdoJMa5B8A0lewP88sBsM9hDNdBbD0IZFLeX3+6ED6BAWCXUROAI4XKMdmHUjh/2yfg7YTL0Am9VnaQ1YFEmmBA+u2QqUUATrqcjX1NtyW88kWDpvHbbamV9US8nE4Px9flvEa7z+sPrfBftDmMXin5tRqS1FeZSRrF1EFJ5WhFBgJYalOg8z+9Pv7vYnQl+H9wg4o8ybtnuiP++CmuS6PvZUqpSNGhkFYo7cQ95jL9BuOl0XFOxS9j5vcBZuLSW4qUHMq8a1nuYW8YUyqkErdX707F78evflv8lDlX2igM1+v1xCyTI0ql02aizSo0y4Q/bPfzRMwzMiQK3IiYxE5TYldrYUtK5FImLFDnc22DYRInd2oknMeN4lfrR6QPSlwZOTq8ZuLm6lzIlJSTy41UqzF0u2eJVc4+MNaVi+Ic1RfYlXMM+hjFVkWBZtN3zT5AE4B16KpBGk+06K8vR765Lf6czy+FdyESnZJYaiNcJm0PxEkUUsmiKiA6nk4DKPDBX72eThv2yRX/jkyUoIcyR9W21uN0pBKFNtT1T5uYVNahSn5UZbSRK/kYd7Inra6J3/qMekEdf/Pw6pS01JV6VtKzkp6V9KSSXh26Nc2UYJYN9yEZo43QSVIZQ6lYZzJv3SdkbY/dPRv6XnzW2rPWnrU21loTQEEu0zyDldq2rYMugwhCf9ey4fZhEwKwZO7J8CRXQ2VyiKD2kmmiMKwzbV0T1aU2rgnvuR57Uw4ve2n1LZPrBPPMw45LxwvD0eoUi0qlKE7E1dn1XPyBjta4aalkyH3XJ9OT6UGvbPqEx9nlufAZ+sYbHAa9W1b1Qbfe+HscN82CiUwqI93mmrd5emJCQ2ZWMfvbhujwWu987Y0g6L6869vk/T/zttJ8kF3thuKzByxKL8PhELvrs2GB9uaSwagq1VK3IXVdNE6OHZGxno3p5MW4Yy/PW+Eluigq1Z6+aiXW0mUCB2QleWUdkxRALhPiWSWqQfmYe7MPfkX87RHFiwkX2ndjf+iupMuqeJLoIkz8tu3/ONdxWKBUYQdhw9PZx5uLt7OjD+enZxfXZ0cvJtOJe3AtoSyKAtUgju081T3XPU623t1snnpt0RXX0YMLyxylYprbDOpOfv0obbnUWwEugk5Et1DXMVq6MXnT8M9fKzIbiG4Xu5LyVRNARpiSaRX7hedbOPXRHc05CDbPKw5mND43Qb9jliRUum/aLgbnyOWn6zmH3b2UKXTKewyu+YUNriGCO7gD4FdA7KFt/vb3GnJUqwpXbO/98t+/TxlJew== +api: eJztWN9v2zYQ/lcIPm2YIrld2nV6c9N0S9ulQeJuD6kfTtLZYiuRKknFMQT978ORki1bThYMK7AHBzBiWaf78X33keI13MLS8PiW34ilhILPA64q1GCFkhcZj3miFWQpGNsZBDxDk2pRkQWP+ev+vmHAjLMJecA1fqvR2NcqW/O4cZdCY8Zjq2sMeKqkRWnpFlRVIVIXMPpiyGfDTZpjCfTNrivkMVfJF0wtD3ilKT0r0Dg7F+8SSqSr3cRmOTIJJTK1YDbHLjdmFduURIl2AYzVQi55G/A70AKSwgeALBPkD4qrQWBfwzhcF2LjgQGB8u7m4yXzBQwCdhW1AbcoQVoC+1AJF2/6ArwdszlYplbSDKo6UEgbDEC/HSI1D7gVtiBjz+mGwmtPGm9b/7iplDQeiOeTyeH8uppXYHZx/dcMQ1F8XPD4dj/YazDItvSzhdJslL/PeAzzfuM8jnmH9Bb6vncI+lGlY+AfhNenR5Xwdn64md/j+nBStRTfavxuSTmbIVN3MgtTKGuZQQiVCL/i2oSyLhPUP41ZzLDSmILdSvzI63fkVUiLS9Q84AulS7D+p5enT0nz0nH4HtfmaZx7AA5wfmT4/6Jcsjp9aIWutLoTGWYsAwtMGCaVZXdQiOyRdbrSKimwPKj0YYApu/KWLEMLoug2Otr5vGGCGROS3V6/PWO/nr74Zf5Dbm1l4iharVahXqQnmAmrdKj0MtKLlD5k92PIZjlqZCWsWYJsuxMPW8lUmIqFSGlbt75WlwyBGH6W/9xN7m6zB/pAVbUWo1eeKft0fcFEhtKKxVrI5Ti0e2YBdUE+IFG1jZMC5Fe+pXMcdD+KqcsS9Lrvmt0AbcCNBVsPynhgVfj5+cg3tcXvs9kV8y5YqjJ0srS5MH0gKqIUUpR1yePTySTgJdz7q5eTSUs+ifEnVCIZ3lcFSNda++UIyUqlsesfV5iQxoJM/ytmlBZLsR833JFW18RvfEW9oE4ffeXplLRQtTwq6aiko5IeVNKLQ1vTVDJCWVMfotZKM5WmtdaYsVUuCuc+RWP62N2J0vfiUWtHrR21NtZaG/ASba5oclMp41oHbM5jHvldy0Sbl00ecIP6DrVx7+y1LnjMGy+ZNo6iJlfGtnFTKW3b6I742JmN0G0vrb5lCpVCkfuwY+roxnAgc+YPGuwVuz6/mbHfwOIK1g5KCrnr+tXk1eSgVzJ9wOP06oL5Cn3jDRaD3i2p+qBbb/wUxy2dBwymtRZ2fUOPeXgSBI16WhP6m4bo4jnvdO2NeNB9edu3ybu/Zo5pWsiut6O083soKy/D4ehr22dDgnZGS4MBl5AL5VLqumhcHDlCbTwak/DZuGOvLpzwUlWWtXSrr1yylbA5gwFYaVEbSyAFvBAp0lklbrj0OfdmH/wd9qePyJ6FRLTvxn7RXQqb10mYqjLqjqeb/0mhkqgEIaMuhInOpn98unwzPflwcXZ+eXN+8iychPbeOkBJFCXIQR6b81T3XrdfbLPdbB4adnbkWry3UVWAkASzq6Dp5NcP4AxRvRHgPOhEdMubJgGDn3TRtvTztxr1mse38y2ldNUGPEfIUDvFfqUDJz/z2Z3MKAkyL2pKZjR0a4P+iWmaYmUftZ0P1pGrjzczSrsb5ZYqo2c0rGjMCyse88/8M+c0OCYPrvnd7w0vQC5rWJK990t/fwNDZMq8 sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -41,7 +41,7 @@ The signal variables as a JSON object. The signal was broadcast. -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx index aa348692e63..d6eb78f2f32 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx @@ -5,7 +5,7 @@ description: "Complete a job with the given payload, which allows completing the sidebar_label: "Complete job" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7uDSZ0pSSOmnCm+o4rdMk9dhKe3B8WJIrETYJMABomaPhf+8sQOrTTtKZ9CbPaCwSwH6+t6TeUjicW5FciXc6FdeR0DUZdFKrs1wkItNVXZIjXoxETjYzsuZVkYiTfg0QbnQKC+kKcAXBXN6RghrbUmMewaKQWQFYlnphobcn1dxvRWt1JtFRDpbMncwIHNrb+LMSkajRYEWODIe3FAorEom40emf1IpISI6hRleISBj60khDuUicaWg30GlBcEst6Jl3ysE6PYRCsYiEzQqqUCRL4dqavUjlaE5GRGKmTYUu3Hp5LLruOrgj637Tectn1t5nWFqKRKaVI+V4Deu6lJkv6OjGcjjLfW86vaHMccqGy+8kWV69QyMxLcMF5rlkK1ieb2x6LN3V0c1MV9lzqzjtXfeqKUs+Fex2nKhtSvdQpNtbHwohnB2KPsSQ+wDQQs6draSiHNLWb1loc0sm3itDTkpycVdBpFqXhGoPkGcq51KThUVBriCzYRa8Fbu6E4GMKQa65/ZIV7aQa7LqJwdY10bfEUgXw1ttgO6RQ48AYYr2Ft5L60iRgQwVW20385NaccboYcyJWXI92qWFWYlzbgiXLIYzFe6uHDxqR1owVBuypFyoV6CcK9Bt5sgRrZrta8yVi2FiAft+7HnpsRx8cHMpB1S53+adG6pQKguYOXlHMbyhGTal88jyeA9s3cFOFwknHV/yYLkIONq5e7KK4iIEIbquC6irtbKh+8/HxwEEu/jyQEa7gSzbZBlZO2vKso1FF4nj8fgrZ7fnFQ+IDJXSDtINuMbwQRtitKIsLaAhYHjInHKQyp8fwoVU520oxiMDoDY6Lan6eX8QbIc4gfOws/cLgXahpbwxDd6vLt6ewOvjF79ePymcq20yGi0Wi9jMsiPKpdMm1mY+MrOMP7zvaQzTggxBhS2nuR4qsOYc2JoyOZOZh2rhE/bBMP1Cfl+fW2F1RVfrjFTzzVHaGLlH3gl8ujgDmZNyctYOD4gt1/6MB59IBKa6cUlaoroVa1jtO931YpuqQrN6GGw76CJhHbrGfvNR8MvzPdsMrD+m03MIJiDTOcFMm8Dy3hEnUUklq6YSyfF4HIkK78PVy/G4Y5vc8e/IRPnhhQqHYbGZjlRQrXHrE5PKOlTZj+qMNnIud/3GWxTvQfwmZBS4ffxVOu9TkhnOnJzpRuXxgVoHah2o9Si1Xv8nakk7PMEWRqu5ry1B1hhDypXt4cl3oOeBnj+Oni8eehmdKOAqG8YhGaMN6MwzMOffzaU3z++0g+/+bf3AtQPXDlx7jGtdJCpyhWYBq9bWQ4d1okSMbnRqR8ugIXWj9c9g1oDI3A1aU2NKkYhlYE6XjEbLQlvXJctaG9eN7rgtW+oMLweGDcgpdYZlEbzvd5AXWNAaMjvBqlE5wiu4OL2cwu/oaIHhRyy73Db9avxq/KBV3vqIxcn5GYQMA/42ZsJglsn9oNmw+XsMe3XMUtYY6dpLPhbKkxIaMpOGm7DCRe/PW/eyjt8kov7L2wEt7/6Z+obzPLtYK2+nQTbZFcq2VKtBOhokCalm2kfQY2c/F24sGRuSH8fP9nF6fubplumqapSfuWoeXq9wozZZ2VgX1KxSZqSsD7TXMIdt78MK/B08wrOY+xrAN4zauXRFk8aZrkZZOLb6n5Y6HbE4M+pd2NHJ5MOnj28mR+/PTk4/Xp4ePYvHsbsPygtToUK1GcegFd3sy7vL9ePlf1d6e0A4unejukSpGKK+DMueuVes+1oRiWSl/26Q9zrqCXgllssULX0yZdfx7S8NmVYkV9drvnqC59Ly97Vk+2juTy56dfcpfFtHfjCR/iaq1k+NsuErEYlbatd6dnfdRaIgzMn4AMPiSQjjaMom1of3ROUuGk5Msoxq98jerTcDpupqTJ7/dTll5vWKdqVzPmtwweI6LkQiPovPHLT2JfKk9veXokQ1b3DutXlvl//+BdIObqg= +api: eJztWVtz27YS/is7eGl7SlGy66Qx33ycpHVOmnpsuZ2p7ZmA5EqCDQIsAFrmaPjfzyxAStTFdtLLmzLjiURir/i+BbS7YI5PLUuu2QedstuI6RINd0Krs5wlLNNFKdEhvYxYjjYzoqS3LGGn7TvgcKdTmAs3AzdDmIoHVFDyWmqeRzCfiWwGXEo9t9DqE2rql3JrdSa4wxwsmgeRIThu7+MbxSJWcsMLdGjIvQVTvECWsDud/g9rFjFBPpTczVjEDP5ZCYM5S5ypcNPR8QzhHmvQE2+UnHW6cwVjFjGbzbDgLFkwV5dkRSiHUzQsYhNtCu7Co9dHrGlugzm07r86r0lmZX3CpcWIZVo5VI7e8bKUIvMJHd5ZcmexbU2nd5g5CtlQ+p1AS28fuBE8leELz3NBWrg87y16KtylaD/SZfS0VRT2pnlVSUlSQW9DgdpKul2eri/d5UKQ7ZLe+ZB7B7iFnHa2EApzSGu/ZK7NPZp4Kw05KkHJXTqRai2Rqy1AnqmcUo0W5jN0MzQ9teC12OWTCESMMeAjbY9wsoZco1XfOOBlafQDgnAxvNcG8JGT6xFwGHN7Dx+FdajQQMYVaa378QmtKGLuYUyBWXQt2oWFieRT2hBKWQxnKjxdGnhSj7BgsDRoUbmQr0A5N+OuHyN5tNxsn2PKXAwnFni7H1tWWiwHG7S5mANXuV/mjRssuFAWeObEA8bwFie8ks4jy+M9sHULO5k2BjOyYXcBaH3rPlz++gnCu1BIuHNGpJXzW8YdzNGQ217lFmRu1I0iyE00VRlKd0+ckpL2ZCNYUam/bi6kpIViqrTBPCGl/4HP3FoxVYifYUApREe2CSEi94YUYFG6Gi6dEWrqRfIK33L3NRLB8avyK8UyrnKRc4c/GV2V9iVJKaxbl7uyaL5crDRCG+FqEiiEEkVVwCiCgj/6jwejUQR5QAe8GlH+znva2vqrLa5nnTYbPhN8PsMDlxWCNqALEXgjHHjgmwe0N4r2vERjiYL5Ss03NkjuQuJmNen2s4dJ6zO6hcmTdmVXwvzJtAvp7X7v0rg8PSjbAycK3DJDwM0rBFrxoqk+UP6GvaBmUJVfZnUdLz273Bhe77RAoCG9S1GoSHbTlHBY2O1AmuecCGD/i15MvfDfcKMjwYuXhR8Od7rUyW+60BKKJaOItYxiCVFq04UmYk44+kpXtgtf1U97tXbngs2np8sD4CLUf9Y0TTjwS61soMrh6Cicv5sx+DsEt71D3VZZhtZOKinrmPJ2NBo9I7t+VaS7WcaV0i4U6lZpDL9og3RR4EJa4Abb6oQ5COXlO3ch1Xkd2P/E3as0OpVYfL99B9sgPZyHla3d7lDypyktTIP164v3p3B89OrH229nzpU2GQ7n83lsJtkAc+G0ibWZDs0koz9a910M4xkdYgWvKczeIbQqUGBLzMREZP6W4NESnCGkhfievzKGt8/UhcqI7UIHVxdnIHJUTkzq7m6+ZtrL+MpOfEt15ZJUcnXPVrB6sZyCrYqCmyXy1w00EbOOu8r+VWL9PB6fQ1ABmc6pyJlwwWoNrbHsaNTn2evRiOq43/EviET5eyNXvLun9cMRCooVbn1gQlnHVfZP7Yw2Yio27cZrFG9B/DZEFLh99CydtylJDCdOTnSl8nhPrT219tR6klrHX0UtYbsTbG60mvrcImSVMaicrPcn356ee3r+c/R8tesyeqKAsmwIh2gM/ejMPANzallKr57utJ3ttlGy59qea3uuPcW1JmIFupmm2UGprYcOtegTNrzTqR0uQvu+Ga46kNR+p/ZO2+avjGQJWwTmNMlwuJhp65pkUWrjmuEDbctaY5xeB4Z1yJE643IWrG/vIL2gWUIX2SkvKpVzeAMX7y7H8BN3OOfhRyyZXFf9ZvRmtPtnvTbuCY0n52cQIgz469WETi2Re6fasPhLFPvBhMWsoubCJYmF9KTIDZqTijZhiYvWntfuO+p+EYvaD+87tHz4few3nOrZxWro8S50rDdnFGsDg65rH3pwG83gVROuh/6ui8YOR4dHg4PDwcHx+OBVMvox+eE4Pn59/Afb7H89t3KzZ3XdWbrd0Urqv1w1eEYez0JNtE9dC/rtTSBEUlPS79ooPtgm2PmZrxOZLopK+cNCTbvW50pfJivrwgREigyV9Rlu517dso/hDfwWLMJBTIAMrOnOiKlwsyqNM10MsyC2/D+VOh1SQ3/YmrDD05Nfrj69PRl8PDt99+ny3eAgHsXuMbSMiMMFV30/uvnC3fZIcLE6F//16WCLZIePblhKLhRxy6dh0Zaca5oVWhaxZDkz7FWd26itHNdssUi5xSsjm4Ye/1mhqVlyfbsqNL4y5cLS59WY78nYv71oJ4Lfwcuzx52BdJ1NVftyJyv6xiJ2j/VqBtrcNhGbIc/ReAfDy9PgxmBMKlbCW4PIJuokTrIMS/fE2rUrDdWYZX0///VyTCWjnYIWOidZw+c0kOVzlrAbdkNO63JJfP98wSRX04pP/TzX66V//wfyEJmO sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -44,7 +44,23 @@ The variables to complete the job with. The result of the completed job as determined by the worker. -
    +
    corrections objectnullable
    + +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. + +
    The job was completed successfully. diff --git a/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx index 7833cf500bc..ddd8bcb7d20 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx @@ -5,7 +5,7 @@ description: "Publishes a message and correlates it to a subscription." sidebar_label: "Correlate message" hide_title: true hide_table_of_contents: true -api: eJztWVFv2zYQ/ivEPW2YYrlt2nV6c9N0c9ekRuJuD0keKOlssaVIlaTiGIb++3CiZMlWnGbAXgY4QGDLPN7xvvu+k3zegONLC9ENXKC1fIlwF4Au0HAntJqmEEGijUHJHbYWAaRoEyMKMoEIZmUshc3QMs5yb8O4Stl2o2XCMacZZ7aMtztHt2q62BoJrZiwzJZJgtYuSkl7VkJKZtCVRjGXIVsIYx0rjCYbJpR1XCXIvuG6Xm6DbwOnbCVcNrpVEIDB7yVa906na4g29aUwmELkTIkBJFo5VI6WeFFIkdRHCr9aSnEDNskw5/TOrQuECHT8FRMHARSG4HICLa0qniO97iI07x2OLBi3LMWFUJgy4VN7N7u4bDOrz9vEsc4ItYQqgB5Sf+L68SB9NAkVvegDM/BKlVzwUjqIgELccyN4LH0qh1PYmlEeH68/X7JUJ2VO8AXA01TQHi5nPWQ8yPvYqVJKcuTXqwAcKq4c0W4/PqXhV9lCG7bKRJLtFF1YVjRETB9JdC8UxRKOLlvin3XQXXmqQFWRnUFbaGU9KC/H46exEbZPP6eZVsi0Ybk2OGCuhX9BvMMxe5XuxW5WAyrSCqWk1x+ISLhb9ah4niZ9E+kgK588X+ddKIdLNBDAQpucO//Rm1N4khjzjhjT988J0ymqwWDaQPCc8x8A74nu85z8fsBGz7+GjqeHGFgYfS9STFnKHSceKu3YPZciPcyywuhYYv7Lj9g2YTNvyVJ0XEjmmeD7GBnGvpPdXH04Y7+dvv717qfMucJGYbharUZmkZxgKpw2I22WoVkk9E92P4/YPEODLOdrFiPrugfrOMZsgYlYiIT05Hyq9WEI2OcQ1K9uBk1hW4fSiMFtbcK+XE2ZSFE5sVgLtRyG3mmgPNali2LJ1TfoCjoMuh/FlnnOzZZhuwGqAKzjruylcYBHr14OfBMr/pjPZ8y7YIlOse6eLqNu6QNRErlQIi9ziE7H4wBy/uCv3ozHFfmkij8jE8XwoZBc+dvPXjpC+RbovdWJter5jyqjjViK/bijHXE1JH7vM2r19GrI9w/axCJNUdX0ZM2zQysqLqVeYTo66uqoq6OuDurqdMj3S02Pb6U63pKO0jlK55B0Xj/2iDdRjFA2xEM0Rhumk6Q0hh4zMyG3Xy7a2M09y3PxqLWj1o5aG2qtCiBHl2macxXa1tThLoMIwubrnA17MxUIwKK5R0MTsw2URkIEG6+aKgrDTaatq6JNoY2rwnsqyc5IhZa9ulrWSJ1wmfnIw+rRQj0varI643mpUs7esqvz6zn7nTtc8XWNJoXcdf12/Hb8qFcyPeBxMpsyn6HnXq8ftG5J2I+69cbPcVxVdwRkUhrh1te0zcMTIzdoJiUVYMuJJl7tna69EQTNmw8tUz7+Pa+LTb3sqpv1nT/wvPBK9LO5jmT7A7VupV+0neFDb3gg1ELXx2zINUyYHKGxHqHx6MWQyLNprcdE53mp6qaslvXQgPEegIksrSPgApAiQRoFdNm0Zp/8CvvLR2QvRlR8z9C2Fy+Fy8p4lOg8TPy27WssdRzmXKiwCWHDs8nFl8v3k5NP07Pzy+vzkxej8cg9uBpk0krOVf8c7dSjN3DZyXbT3YT+JxPjhoAOH1xYSC4Ulb1GdNN0iZt29GV36URDdK/1G9hsYm7xi5FVRR9/L9GsIbq561hGV1UAGfIUTd1YvtV0PPN4nczpHGQuSzrPYEpYBe2OSZJg4Z60vet1vNnn6zkJqRmJ5zqlPYavaFzOVxDBLdwC0A8C5KHWaP35BiRXy5KqHIH3S3//ADwPcwc= +api: eJztWW1v2zYQ/isEP22YKrtt1nX65qbp5r6kRuJuH5J8oKizxYYiVb7EMQz99+FEyZYtO81egHWYAwS2zOMd7+55TkdyRR2bW5pc0Q9gLZsDvYmoLsEwJ7QaZzShXBsDkjloJSKageVGlChCEzrxqRQ2B0sYKYIMYSoj64mWCEecJoxYn65nxtdqPFsLCa2IsMR6zsHamZc4ZyGkJAacN4q4HMhMGOtIaTTKEKGsY4oDuYVlPdwaXxvOyEK4PL5WNKIGvniw7pXOljRZ1Y/CQEYTZzxElGvlQDkcYmUpBa+XNPhs0cUVtTyHguE3tyyBJlSnn4E7GtHSYLicAIujihWAn9sRmnYWhxKEWZLBTCjIiAiuvZp8OG89q9fb2LHOCDWnVUQ7kXoHy/1GutHEqOhZNzA9rZjJGfPS0YSiiTtmBEtlcOWwC2sx9OPt5cdzkmnuCwxfRFmWCZzD5KQTmRDk3dgpLyUqCuNVRB0ophzCbtc+uhFGyUwbssgFz7eSLiwpGyBmexzdMYW2hMPHFvinm9BdBKjQqkI5A7bUyoagPBsOH46NsF34OU20AqINKbSBHnIt/RPAO2yzk+mO7WY0wiQtQEr8/AqJhLtWe8mzmzgm5ccZTa52V/WK2drLJu91qvbFN0Q03qN5m06H8TDd4GH8+rD3fSJ9JfNhZegHrW52l9MoPUi/BxOxj9NNFsZNEh6j+ED6Hqh/fzEGtVgXkncqizkrvMpYzEoR38LSxsoXKZgfvhm4knewJMw5I1LvQoVSvgAjOLlj0oMNgM6gNMBx2qHadIT434G4UA7mYGhEZ9oUzIWfXpz8C6A/vJRHxem8Bvg7WNrHESIk4dshxLF+/3/rNwqeHOpYSqPvRAYZyZhj2Lco7bBGiuxwV1IanUoovoruEZkESZKBY0KSgI/Q96JgGjrfq4s3p+Tnkx9/uvkud660yWCwWCxiM+NPIBNOm1ib+cDMOP6j3PcxmeZggBRsSVIgm26zC1tbAhczwbH/csHVejEYxv2E2IFtPbrqNZHrAuKN6G2DRuTTxZiIDJQTs6VQ877prYabpdq7JJVM3dJNQvtGd61YXxTMrPG0baCKqHXM+Y4bBwrg82c93YiKX6fTCQkqCNcZ1CXA5dhdB0PoRCGUKHxBk5PhMKIFuw9PL4bDCnVixh/hiSJwX0qmwnZlxx2hQssctNWOtVz5hzKjjZiLXbvxFrkaEL8OHrV8et7H+xttUpFloGp4kmav2ZKKSakXkMVHXh15deTVQV6d9PF+rnG779XxlXSkzpE6h6jz474Wb6QIRtkgDsEYbYjm3BuDTWUu5PowqrXdvLMCFo9cO3LtyLU+16qIFuByjfcipbY1dJjLaUIHzebNDjpn8DSiFswdGFvvtb2RNKGrwJoqGQxWubauSlalNq4a3GFKto7gcTiwq0WN1JzJPFjuZw8H6vuFxqvTcDhBXpKLs8sp+YU5WLBlHU00ua365fDlcK9WFD2gcTQZk+BhwF6nHrRqkdh71QbhxyiucCdvgXsj3PISp4XwpMAMmJHHBKwx0dirteNzEKJR8+VNi5S3v0/rZGMtu9jcDZ3ds6IMTAx3ORuQ7V7AbEa6Sdu6xegcFQg10/UyG3D1HUZFYGyI0DB+2gfyZFzzkeui8KouympeHxEQ1gkgl946DFxEpeCARwEbb1qx92GE/BYskqcxJj8gtK3Fc+Fyn8ZcF4PmmGv9mUqdDgom1KAxYQenow+fzl+Pnrwfn56dX549eRoPY3fv6iAjVwqmuutozzg6xytb3q42L6H/yA1jA0AH925QSiYUpr2O6KqpElftCZTdhhNeugauX9HVKmUWPhlZVfjzFw9mSZOrmw3K8KmKaA4sA1MXltsajqchXk+muA4Ulx7X07tVqqJ2xohzKN2Dsjedijf5eDlFIjVXqIXOcI5hC7xeZQua0Gt6TSleIKOGmqP17ysqmZp7zHJCg178+wMGZ7As sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -42,7 +42,7 @@ The message variables as JSON document The message is correlated to one or more process instances -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx index 5b9de891e8d..5f7f999e043 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx @@ -5,7 +5,7 @@ description: "Deploys one or more resources (e.g. processes, decision models, or sidebar_label: "Deploy resources" hide_title: true hide_table_of_contents: true -api: eJzVWUtz2zYQ/is7ODVTmlJSN03Zk2olrdrY9dhKe3B8AMmViJgEGAC0rdHwv3cWoERKom3FcdzpQSNRWOzj228XDy6Z5XPDogt2hkZVOkF2GTBVouZWKDlJWcQSjdziGMtcLQqUlgUsRZNoUZIIi5gfMqAkgtJQKI2gG3UGvsNwHkKpVYLGoAkgxUQYoSQUKsXcBDRnpnRhXoQf5TQTBoQBLoFbVYgEEp7nAYgQQ0BhM9TA87yjn2uE1HmAKamSzo0Z2AwLGgw/ShYwjZ8rNPZXlS5YtHSPQmPKIqsrDFiipKXQoiUrqtyKkms7IKcOUm45/W2SDAv3yy5KZBFT8SdMCIxSE15WoPGaG8c6olxrvtiBbZohxEJyvQAyAlaBh5pcb0IivNtYQ5hYAqdUxog4R5qS8Wv0kNuMS5cD8hsoArgRNoNUzGaoSVE7IHmBhp6drX4veMcHD6KwWHTjMlYLOWcBI8Xcsoh5TayuA2ZRcmmJQbvyu0B4abLujTq/2iRbFTqlbd4uOkhf1rUfNKWSxkP/ajikr11L/cwJ2QYJeFnmInE1MPhkaO7+DGhR+xMXHXEhLc5Rd+ES0r4+7MWjkuJzhXCFCxApSitmCyHnW8wIWR10zJndgCeUsbY84hWurhgo5i2Gbmf4jhCbah7jTEjhTW1bHrVWG+mOuX3V7sueuCzkygxMxgFwQzw3mEJa0awOaAFYNUfXSFx5ECDXqF1Hcm0I+EfZwN9AL9B1KOBgSkzETCRrY+naVyqROtiN4W+v+0Ei/PCqNzRujJjLFsWVr2Gvsa9g3NrQFS4CuMlEkgFPrCEsOfQDYqlbr9PrS9AV1wkvcL/UrWa4lgQzrYrGdlc33KwT6sw8qrdMxs2y0MNM17CEzXG9nBFVTv2wrzK/aO1J+ZX4w5zfVbxvWGkh27X0WUi/jspT/fqJmL0OokvtXVyegttrU19K8q3Q5d78Hh+feGqvuecV3ZuuJyV5y8UOrGd+IXXLxpcQrqu/gVJ3VMFc85Loxe0mbm7bQjsPNbs/co9vn5tP1Nu+2n/nYm+/GDfCd0Ww2zLG20na8Gb/7vHYdPaD8EAz+eXuZmJW3eSOWnrGZrIRUbezfH3tbuh+/kLe4sg3LJd+MB/bOzf99ml/6g1Dv8cb24d7S3ejXGuP1r0rPQk8XKcktS8B3CntWdZz5/vTlp9zvltt9Md/sSv1efkGDHMRfqP9aON0L0PfERP7h47RcndPsX3uvs82N0YlgltMWwp1G1ewFUm/6bPmzM38EfzwrlN3qpLKXWZUZa54CjMuckxDOFbuEG65yP2BvNTqWqSYgpCrOwBnAGKVLvw1xB3n9FKrOMfi+93z+nbxnnrJxi74miVGecHYW784e3cEPx/++NPld5m1pYkGg5ubm1DPkgNMhVU6VHo+0LOEPiT3IoRphhqh4AuIEXiauo0rz6HtBm31WeUCbNwGQtvHd38r8aP33MFUWuzQbgQfziY7Nwkbpt2cGa9y0sFjVdkozrm8Ym3eHyL3CExVFHSV1BB700AdMGO5rcxju8zv0+kpeBWQqBQ3zqBkiIIohBRFVbDocDgMWMFv/dPr4dAtlJTxPSKRgLdlzqWj1nY4QvobN6/NBSaksVwmT5UZpcVcbNvd7AwNicc+otrXX4E2U3RpWyrjqMNtxiI26F4SBcygphbNooslq3TOIrb0xVJHg8EyU8bW0bJU2taDa8rENdeCx7nnHw37olqRJVcJzzNvcDdpNNDdRB3xopIphzdw9vZ8Cr9xizd84a8zlN5S/Wb4ZtirlUTv0Dg6nYCP0FOu0wZWaqmee9V64X0U1/UlAZlUWtjFOU3z8MTINepRRbivqdDYc9rp2QuxoPnxbkWQP/6ZuhwLOVNuepPrXUdYZ8lmw/DlLq9OJ648ElUUlXQ9Us59p+edwJK8MpYCClguEqROHi2bLfLa7Hs/As1VFrwMKSmeOavWOBc2q+IwUcUg8dPW33Gu4kHBhRw0JszgaHT84WQ8Ong/OXp7cv724GU4DO2tdcETdQsuO3745aa9ud0OdtkuCf+LlxENKyze2kGZc+F2YA7OZVOxFxvXupdBU3UXbLmMucEPOq9r+vtzhXrBoovLtkjpqQ5YhjxF7Ur8irZf7MhDdDAl4ySeV+RE3+uOOlhNGiUJlrYjvnMxTmWw7jqnf51PidXNWxbClEWu/zm9QfuTnKzrfwFFFVRu +api: eJztW8ty2zYU/RUMVumUppQ0bVN25VhJq6ZxPY7SLhwvQPJKREwCDADa0Wj4750LUCIpUY84tpNMuPBYMsH7POcSPkMsqGEzTYMLeg5aFioCeulRmYNihksxjmlAIwXMwAjyVM4zEIZ6NAYdKZ7jEhpQd0kTKYBIRTKpgKjKnCaPwJ/5JFcyAq1BeySGiGsuBclkDKn28J6pVJn+wX8nJgnXhGvCBGFGZjwiEUtTj3AffALcJKAIS9OGfaaAxDYCiNGUsGFMiUkgw4v+O0E9quBDAdo8l/GcBgv7lSuIaWBUAR6NpDCYWrCgWZEanjNlBhjUUcwMwz/rKIHMfjLzHGhAZfgeIixGrrBehoN2lqvAGkuZUmy+UbZJAiTkgqk5QSfESOJKjaFXKWG961x9MjZYnFxqzcMU8JaEXYMruUmYsD3AuAlmQG64SUjMp1NQaKi+IFgGGr9bX91RsEYMrojcQNbMSxvFxYx6FA0zQwPqLNGy9KgBwYRBBG2u3yyEW43enVMbV91kI31rtO7bRaPSl2XpLupcCu1K/2Q4xF+bnrqR49MWCFiepzyyHBi813jvLgSwNP1nSoOLdXfPmQZSw8PWu+bReRUuut6NqWYpt5ZuPCJMaxlxZiB2nW/jqOGnaoRtEzcprEjcjAujp+XlejC1wVcwP6y5heAfCiBXMCc8BmH4dM7FbCO80msY15vJjhF+NdfDJUgssxvZLem2Dtct1a1G0wimXHDnat3zce21Wt3VtNvB4Gy7wT1xHsqtMM/EMm4yHnmEaZwCGmISF3hXowseMXIGdsyuIHQNys5rO6QJeyeqfla95GDnN2FE5xDxKY9WzuJVrDhASm8zh3+d7UYiXBiYgWpOFS7MT086U2Na85mo27KM1YJpyfRTlsFhlVreYecjmSqZkZuER1gGHLuVj5tV/aybWw268ah6RnUgq5uWFU62sHKjsAeTc1XCK5h7VbosMhpRwkh3q5vl2BOvY7V74h9IseXyu+PYaIfF9em2HuqhjY0zUW9tHoRlqzo5bl3fEZVWSTS5JA7m0Oj1qaPPCt/O3M6C3CmRavw0sHfudg720fIpLW3ar+qiGqbITLEcG8iMY8VqFdduqyWnuzPH5nUSaAnarc/hdaR+OuVXwX4q99eg11XkWw2gz671/nJui3dzJI3WAdWK5u6n0/ke6939vy2wu0u8Z3D9vn1w6eXk2oKbBxxcrYzudoq1bD/8SFtD4D1scrqL2Nry7KRXE457JtfnTYvuQG87yNqF3TtEWoOjdDDduafBBXc3MV5usdauM/o8FHpWGniQXYutxN0S3wZ/nzt/6+Cetv0OGd1wwz5vIRHedv97/H3Bbbn0Ggyzwlm5W2Kwtze1lmsR+xHLChEzn+Xcv4K59kWRhaB+3NRhYsgVRKh3LHW8XpnpUGa6SfXL016r6bWaXqv56rSaT6LrPas3p3b0voJ5r+P0Ok6v43wJHed24+DhlJ1bj6sH0Hq6x1ev+vSqT6/6fH2qz2dOui+tA7WHTa8I9YrQl1aEHuY/iX3hNnmxUy1qLdwpgKyZ3KsguTZ0KEi9XtS/ydOrQ7069O2oQ/2bPL0C1CtA35UC1L/J07/J02s6vabzLWo6/Zs8vW7T6zbfxZs8uODptlNXsYwKXE+KPJUsJlPGU4h98lraQ1iG8dQdyMqVvOYxxISL5Rkw64CEMp67Y2hbzmnlSoYpZJ3vCbW5fOZWVn6JIx1W0C0MnfeL85cn5LenP/96+SgxJtfBYHBzc+OraXQEMTdS+VLNBmoa4Q+u+8EnkwQUkIzNSQiExbHdzbG0yf8VfYy0CVZhE+y9y2+PhGSv7jiDVyi+AZ1j8vZ8vCHZtFzbe6asSNEGC2VhgjBl4orWfd8H0GOiiyzDo4QVNdoOSo9qw0yhbzsm/pxMzogzQSIZQ+s/WHSESWRc8KzIaPB0OPRoxj66b78Mh3a7iB0/IBNB4GOeMmGhtZ4OF+7EpbNmE+NCGyaiu+qMVHzG1/226VuBeOQyKh3/MjCJxEO7udQWOswkNKCDphrnUQ0KZ6x9WBUqpQFdOLKUwWCwSKQ2ZbDIpTLl4Bo7cc0UZ2Hq8IeXHamWYEllxNLEOdxsGl5o7r9OnDhLnpHzF28m5A9m4IbNbRHRZdv0s+GzYadVXLrF4vHZmLgMHeQaY2BpFvncadYtPsRwiYNcQ1QobuZv8DZXnhCYAnVcYN1XUKj8Wev43S2iXvXh5RIgf/03sT3mYirt7VWvNwOhjWcuHfqPN3F1Nrb0iGSWFcLOSDFzT3vWSCxKC20wIY+mPAKc5MGi2l2v3P7trpBK4iOPfWyKQ85yNM64SYrQj2Q2qOT31e8wleEgY1wMKhd6cHL8+u3p6Pjo7/HJi9M3L44e+0PffDQ2eYRuxkQjDve4qU/urie7qB8J38Rh9AoVBj6aQZ4ybrdQtpyLirEXLf380qtYd0EXi5BpeKvSssQ/fyhAzWlwcVmTFL+VHk2AxaAsxa9wc0FPXImOJugcl6cFBtF13L30ljcdRxHkprF842A00mA1dc7+eTNBVFen7LGmNLDzz9r16o8YZFn+D6Ib+GY= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -38,27 +38,67 @@ This is an atomic call, i.e. either all resources are deployed or none of them a The resources are deployed. -
    Schema
      deployments object[]
      +
      Schema
        deployments object[]
        Items deployed by the request.
      • Array [
        • processDefinition object
        -A deployed process. +Base properties for DeploymentProcess. -
        decisionDefinition object
        +
        decisionDefinition object
        -A deployed decision. +Base properties for DeploymentDecision. -
        decisionRequirements object
        +
        decisionRequirements object
        -Deployed decision requirements. +Base properties for DeploymentDecisionRequirements. -
        form object
        +
        form object
        -A deployed form. +Base properties for DeploymentForm. -
      • ]
      +
    • ]
    Schema
      deployments object[]
      + +Items deployed by the request. + +
    • Array [
      • processDefinition object
      + +Base properties for DeploymentProcess. + +
      decisionDefinition object
      + +Base properties for DeploymentDecision. + +
      decisionRequirements object
      + +Base properties for DeploymentDecisionRequirements. + +
      form object
      + +Base properties for DeploymentForm. + +
    • ]
    Schema
      deployments object[]
      + +Items deployed by the request. + +
    • Array [
      • processDefinition object
      + +Base properties for DeploymentProcess. + +
      decisionDefinition object
      + +Base properties for DeploymentDecision. + +
      decisionRequirements object
      + +Base properties for DeploymentDecisionRequirements. + +
      form object
      + +Base properties for DeploymentForm. + +
    • ]
    The document upload failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx index 01738dfb698..b59905bb2f2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx @@ -47,7 +47,7 @@ in future releases. The document link was created successfully. -
    Schema
    +
    Schema
    The document link creation failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx index 6bfc6514516..ab0f217f4a2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx @@ -60,7 +60,7 @@ Information about the document. Custom properties of the document. -
    +
    The document upload failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx index 630ede47a51..8ba50e38e63 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx @@ -5,7 +5,7 @@ description: "Create group" sidebar_label: "Create group" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/is7OLVTWpQTJ3V5UxUndZuHx5bbg+0DCK5ExCDAAKBljYb/vbMAqYdluTnkVmlGI5JY7LeP74MILJnnM8eyG/bBmqZmdwkzNVrupdHnBcuYsMg9xsGEWfzWoPO/m2LBsiUTRnvUni55XSspwrz0qzOanjlRYsXpyi9qZBkz+VcUniWstoTiJToa1bzCDSvnrdQzlrACnbCyJp8sY5MSoZCuVnwBNAPMFHyJoHEOM4pvwNo2YV56RV5CyOMQ/WWMmrUtGVh0tdEuQr8aHtPPLlLwCHPuIFagANcIgc5NG6UWA5b8qOQD0F+4eD6Me1z0efZxdLkmvV+pPc7QsoRNja24j4/enuyvRsy/K8fJcPhSBYRpVAHaeMhXIQxu9SdjEQr0XCoH3CLU1jzIAguQOkTbVxlyUywGt3p/wWprcoXVL7uF245pBBfRssOFWFDgDqJhHtFvLt+P4beTN7/e/VR6X7ssTefz+cBOxREW0hs7MHaW2qmgL9n9PIBJiRah4gvKkheFJEyuYN0qcDUKOZUCvAkJdmEDdSHm93Kf4+guyVdNa6zc4fwIri/PQRaovZwupJ7tQoc5U94o8sFz0/gsV1zfs3X3/0tZI3BNVXG7oto2QJsw57lvNtLYQ7rXr55V7R+TyQVEFyBMgTA1FnwpXQ9ESVRSy6qpWHYyHCas4o/x7u1w2JJP6vh3ZKIBH2vFdaDW03SkhmrN25CY1M5zLX5UZ4yVM/kUd3td6kj8LmbUa3DPKtStt6C4uHfwwJUsgDe+JNQoH9JkCIIr98KqdBDZQWT/e5G93uX7e2NzWRSoAz1XepMu/OVxpcwci4OuDro66Gqfrt489wI50kBVtsRDtNZYMEI01mIB81Kq4J7epnvsTniHF8WD1g5a26e19qnvuKGLOzWqDPrS0Ka9Ni7wivuSZSwN444lzKF9QEvb/SVrrGIZW0YRtVmaLkvjfJsta2N9mz5Qhx64lTxXkZc0HMXWk0gZwVUZsXabSQOb+/QxrxpdcDiFy7OrCXzgHud8EYpLkNuuT4enw2e9kukej6OLc4gZRipuLA+9W9L5s26j8fc4bts7KqRorPSLK5oWy5Mjt2hHDZV8RZEOL3in+2jEku7ifU+cP/+ZhN7T0na5PmM5e+RVHYUZz0h6zgVCTk1A6uiyGzM1EK2LSQ4Hx7vUvDgPChOmqhodllk9g7n0JfCNGgjVOE+5J0xJgXR0sA6oN/sYR+DviAjHA+pfJFm/us6kL5t8IEyVijht9Zsrk6cVlzrtIFw6Hn26/vxudPTxfHz2+ers6HgwHPhHH+pEBK+43oxjWwpbia7a4fHRp7XiUlMFQ3DLTiU3rFPJXdIx/YYtlzl3eG1V29Ljbw3aBctu7tbCoLs2YSXyAm2Q1T2d5LBx/Ac7mhAumauG8HfOidqknzESAmv/ou3dhsIvvlxNiEbdQVxlCppj+ZwO6ficZeyW3TJGp3nkITA0PF8yxfWs4TOyj37p8y+f9OiH +api: eJztWN9v2zYQ/lcIPm2YIjlt2nV689K0y/orSNztIckDRZ4tNhSp8kccwdD/PhwpO05sp33ogAFzgMCyeLq77+77SOsW1LOZo+UlfWtNaOl1Rk0Llnlp9KmgJeUWmIe0mFELXwM4/7sRHS0XlBvtQXu8ZG2rJI/PFV+c0XjP8Roahle+a4GW1FRfgHua0dZiFC/B4apmDaxZOW+lntGMCnDcyhZ90pJOaiBCulaxjuATxEyJr4FomJMZ5pfTvs+ol16hl5jyccz+PGVN+x4NLLjWaJdCPxsd4sdmpOiRzJkjqQKCuMA5ODcNSnU5zX4U+BjoHXTb07iBbolzmceANXtUrp3YE9q4vp7nrRY5Z03QguWslfkNdC7XoanA/rKJQUBrgWN8WnobIPu3UUntYQaWZnRqbMN8uvXy6Fs4P0YE76Bz34c4VW8L4v9K19DiaDR6iqXcBCWINp5Uq4D5lf5gLBABnknlCLNAWmtupQBBpI65LZVAKiO6/ErvJnVrTaWg2UqM9ZzG5CxZDnFJKh9hjiTDKkW/PH9zTH47evHr9U+1960ri2I+n+d2yg9ASG9sbuyssFOO/2j3c04mNVggDesQJRNCYkymyH1jiGuBy6nkxJsIcEibYM0Tvqe7mlY3N6IVBYOVG/vSmHw+PyVSgPZy2kk92wwdn5myoNAHq0zwZaWYvqH33f/W7jcmLjQNsytiPQzQZ9R55sMajB0Sev5s6876x2RyRpILwo0AMjWW+Fq6ZSAE0Ugtm9DQ8mg0ymjD7tK3l6NRjz6x49+BRBO4axXTkVqP4UhNmnveRmBSO880/1GdMVbO5OO4D8+OgcSvE6KlBnecFMOZSBTjN47cMiUFYcHXGDXJBzUZk2DKPXFy7EW2F9n/XmTPN/n+xthKCgE60nOlN+nikceUMnMQe13tdbXX1S5dvdj2A3KsCVbZIg/BWmOJ4TxYC4LMa6mie3zjWcYehLf/objX2l5ru7TWP/adXujSmxpWBnxtcLDSGhd5xXxNS1rEdUcz6sDegsWRzIIGq2hJF0lEfVkUi9o435eL1ljfF7fYoVtmJatU4iUuJ7EtSaQMZ6pOsTabiQvrs5Tj9HpMXpHzk4sJecs8zFkXi4shH7p+NXo12uoVTXd4HJ+dkoQwUXFte1i6RZ1vdZuMv8dx319jIXmw0ncX+FgqTwXMgh0HLPmKIkO86B2/JyOaDRdvlsT58+9J7D1ubef3c7CTO9a0SZhpjrV6tUdCTk2MNNBlM2dsIFiXQI7yw01qnp1GhXHTNEHHbVbPyFz6mrC1GnAVnEfsGVWSA44O7hNamr1PK+SvFJEc5ti/RLLl7jqTvg5Vzk1TDLOS1WelTFU0TOpiCOGK4/GHzx9fjw/enx6ffLw4OTjMR7m/87FOSPCG6fU8HkrhAdBVOzzc+aJVTGqsYExuMajkkg4quc4Gpl/SxaJiDj5b1fd4+2sA29Hy8vpeGPitz2gNTICNsrrBuQ09TifYwQTjorkKGH9jltdnyyfGnEPrn7S9XlP42aeLCdJoGJY2RuAzls1xkMrmtKRX9IpSnLiih8jQeH9BFdOzwGZon/zi3z9Qwn8i sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Create group The group was created successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    The group could not be created. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx index f98a7f937e4..5428314b82a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx @@ -5,7 +5,7 @@ description: "Create a new mapping rule" sidebar_label: "Create mapping rule" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SuYPbVTWpQTJ3V5UxWndRs7HllOD7YOILgSEYMAA4CWNRr+984SlERZsuOZ5tCDNKMRPxb79d4DqV2C5zMHyS1c8LKUesZspRAmEZgSLffS6PMMEhAWucfWZkQmEWTohJUl2UACw8aCcaZxzoqOszsNEVj8VqHzv5tsAckShNEetadDXpZKiiZS/NWRqyU4kWPB6cgvSoQETPoVhYcISkt5eYmucaO4LC55gR1T563Us530xjkyzQtkZsp8jqxZyryhVHtQR8HXF66qVzp7INNnvNWhYGkxo9Zu0twKM4nAS68oTqexoY+j0C+o6+DMlUa7UPSb/jH97GbUbTqbc8cCaBlzlRDo3LRSatGjHH5M99t4f+Nifz73uFj3p82kmyJl0gaQ2uMMLUQwNbbgPlx6f7LG5f+J8QvoBbxa+E76/VcgJkylMqaNZ+m6YS+gVVqTKix+2UVtO86AXQVLlqHnUrGAJuOOBcMUMyY1ux19HLLfTt79Ovkp9750SRzP5/OenYojzKQ3tmfsLLZTQV+y+7nHxjlaqmJBKfMskxSTK7bhCXMlCjmVghpHXWzTZtT8XrM1vEyycHcXrDVRKit3sBuwm9E5kxlqL6cL6vBO6GbNlFeKfPDUVD5JFdf3sMH1ewwZMFcVBbdrlm8HqCNwnvuqU8YzRH/7Zi/7/hyPr1hwwYTJkE2NZT6XbhWIiiiklkVVQHLS70dQ8Mdw9r7fr8knIf6KSjTDx1Jx3VDraTlSs8JYbPnTFCa181yLH4WMsXImn8bd1lhL4g+hopWu3u7XVfu0Ic6J1WNpZ3fMUEvMenf6YlOcY9w2CTzILMjCN+6CnFlqskUg7UGUB1EeRLlflCf/XZQHhR0UdlDYMwp7t+91cqAZddkSD9FaY5kRorIWMzbPpWrc05+AVexWjYen2UFrB609p7U6ggJ9bmgCUhrXUIf7HBKI2yfXET25HETg0D6gpUnKEiqrIIFlkEudxPEyN87XybI01tfxA2HxwK3kqQoMpNtBViu6KCO4ykPIXdjoRveP7pAXlc44O2Wjs+sx+4N7nPNF00YKue36tH/a3+uVTJ/xOLg6Z6HCQLrORrByS4re6zYYv8ZxXU+okaKy0i+uaVloT4rcoh1U1Pk1Gdp4jXc6D0YQtQcfVxT5659xgzJtYqPNFOrskRdlkGBnwrChWHdUsLrasHJqmiRazuyWQ9iidaH+fu94l59X543MhCmKSjd7rZ6xufQ54532CFU5T22JQEmBNE1IlqBDmiuzT+EO+xIisuMeQRv4t9piZ9LnVdoTpohFWLb+TZVJ44JLHbchXDwcXNxcfhgcfTofnl1enx0d9/o9/+ibFpIECq67eYQXue5r3NN6O8O+78wIW2A9Pvq4VFxqanhTy7KV3S1sy24StdK5heUy5Q5vrKpruvytQruA5HayURqd1RHkyDO0jU7vaXIFw5De0ZjCk3nAfGcyVkerFQMhsPQv2k46O8fV5+sx8bKdfRYmozWWz2kuyueQwB3cAdDIlTw0lG+uL0FxPav4jOyDX/r8Cym2fIY= +api: eJztWV1v2zYU/SsEnzZMkZw27TK9uWm6ZW3SIHG7h8QPFHVtsaFIlaTsCIb++3BJOZZjJ/W6vRRzgMD6uLpf5xySohbUsaml6Q09Z1Ul1JSYWgIdR1RXYJgTWp3lNKXcAHPQ2VyhSURzsNyICm1oSk+8BWFEwZyUPWe3ikbUwNcarHuj84amC8q1cqAcHrKqkoL7SMkXi64W1PICSoZHrqmAplRnX4A7GtHKYF5OgPVuJBPlBSuhZ2qdEWq6kd6oAKJYCURPiCuA+EeJ05hqTNso+PrMZL2jsxmaPulNfVdSXdti2rahZcJAjuCsCl1LtIszjqgTTmKgHkIBkKvQeNq2waettLKhey8Gh/izmVIfPTJnlgT0c2JrzsHaSS1lE2Mq3wsjk/LjhKY3/2uAn8EsoPSGWaDt+HFTOifvodkO3x00D2l3wPURReDWs94pGW/VR3mm8pizslY5i1kl4jtobKzqMgPzy54BPwgDhHIwBUMjOtGmZC5cen20W3oXHu330Njd2BF6tGfHj8KOfzg+oN3RYLDDpMJ1LXOitCPZQxLPTCiV0ZmEcgtx1uMMyWWwJDk4JiQJtCHMkmCYQU6EIjdX707Ib0evfh3/VDhX2TRJ5vN5bCb8AHLhtIm1mSZmwvEf7X6OyagAg1U0mDLLc4ExmSSr3hNbARcTwZEH2N0ubYLdjP0y6Hk2h7ubnHmQZm3EBoWG5NPVGRE5KCcmDXZ4I7R/ZsJqiT5YpmuXZpKpO7rC9VtEHRJblyUzD8xZD9BG1Drm6l4ZTwwtL19sFcEfo9ElCS4I1zmQiTbEFcIuA2ERpVCirEuaHg0GES3ZfTh7PRi06BMR36ESReC+kkx5aj0uRyhSagMdf3xhQlnHFP+vkNFGTMXjuOuC70j8NlS01NXL7brqVtbIOb5cgm8s4HJQAvL4Vp2virOEGZ/ATORBFs67C3Immc6bQNq9KPei3ItyuyiP/r0o9wrbK2yvsCcU9mrbcnKoCHbZIA/BGG2I5rw2BnIyL4T07nGfYhm7U+N+Nttrba+1p7TWRrQEV2jc7a209dRhrqApTbqZ6wBnLksjasHMwFj/fl4bSVO6CHJp0yRZFNq6Nl1U2rg2mSEWM2YEy2RgIN4OslrSRWrOZBFCbsKGN/qvyCdhU4Eck6vT6xH5nTmYs8a3EUOuuz4eHA+2ekXTJzwOL89IqDCQrjcQLN2iore6Dca7OG7xvd0Cr41wzTU+FtqTATNghjV2/oEMXTzvHc+DEY26g3dLivz518ijjIPY1WrH/fSelVWQYG/DZEWx/s7H6qpas/IsnWifVMehzfIQazA29GMQH27y9fLMy47rsqyVH3vVlMyFKwjrtYvL2jpsU0Sl4IC7C+limdDS7EO4Qz6HiOQwRqgDH5dD7lS4os5irsuk24x6+M2kzpKSCZV0IWxyMjz/dPF2ePDh7OT04vr04DAexO7e+ZaiJEqm+nmEhV1/Wfe43t6Hjm98H+mAdnDvkkoyobDhvpZFJ8Mbui7DcdRJ6YYuFhmz8MnItsXLX2swDU1vxivl4Vkb0QJYDsbr9g53h+hJSO9ghOHRPHBgYzO/jZZPDDmHyj1rO+6NJJcfr0fI0+67T6lzfMawOX4TYnOa0lt6Syl+bkIPXgL++oJKpqY1m6J98It/fwPzizqS sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -33,11 +33,11 @@ Create a new mapping rule ## Request -

    Body

    +

    Body

    The mapping rule was created successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    The mapping rule could not be created. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx index b63d15221f2..dddb8e07e68 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx @@ -5,7 +5,7 @@ description: "Creates and starts an instance of the specified process." sidebar_label: "Create process instance" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isYnJIpTcmOnbjsSbGdVs3LYyvJwfIBBFciYhJgANCyRsP/3lmApGiKSj1J21M94xEpLHY/7H77gDbUsqWh0Q291IqDMURIY5nkQG8DqgrQzAolpwmNKNfALNRy00YsoAkYrkWBcjSiZ07KECYTYizTFh9brUQtiE2BmAK4WAhISOH1hXM5S6F5IwkshBSoklhFSgP44QG4/a0+ziSJu/pA2BQ0KY2QSyKsIaUU30ogd7Cey2fMEA221BISEq/JORSZWhMNRpWag3keENXsRTOvL99/aDFNz92hGLkHbYSS4VzO5ReGNhZKO3mu8iIDB7s+aNFzK4lhoTTUKNAOQ/NlZudylYIkbMWEPdvqEYaAZHEGSTiXNKAavpVg7GuVrGm0ca9CQ0Ijq0sIKFfSgrS4xIoiE9zFb/TVYHA21PAUcoZPdl0AjaiKvwK3NKBKwscFjW52V6ywGbSR7cX/qoazfgtrWgU/unua0Or2acK0Cig8MHSQwYO8Xg+x5g6ce0yZ50yvW5WEDUSkVXDe7n8L65AG9J5lJaCeIQEaHR69OD5BKS0wQginqqpgD6Tp+c8gmiaOfQ33vgvOpSuCOzh5+eoURf0uGh3uoK0cYg2mUNJ4jx6Nx/jxOK9nQ2ReMVNnZYKIfph8hcZSY4W3P+zsIUB3sO4nWsfhq1Tw1GEsDSS9CtI/i8+uGpiQFpagaUAXSufM+q9eHiP3Br09BK5fPH4OaDiXDdQuUmO1kMtBXJ+boA+BqxnxH3rvxVEHZZPTeyNbV22RgLRY2HWDtKbbDoLfEGEMHuwqBQ33oF1xdVVjLiVAYoayDUn0DMJlSM7wPRsuO8+fTBALkkm7jxV+tcOHfQcKh4LcTV7KksSFiiHkNn98H3hseJJlzla7ndwLI+IMG6lb0EpZYrgqumbr9MT68DeF2RcP6mvJ8XfKx71IICEJswwbm1SW3LNMJCGe7WRo3wRnBwtasoyA1koTxXmptQuyyFomNh27DrcP1p56VGgVZ5D/sluXerbJpZckCVgmMuIdQhjmCQrGkKADb67enJFfj09e3T5LrS1MNBqtVqtQL/gBJMIqHSq9HOkFx3+Uex6SGTKU5GyNnN0GkmwrYTPTcCR2nXMODEbnERn3lFG/uumRqMPYUoud8W1CPl1Nm7RbN159ZNrtWbAyQx0sVqWN4ozJO7rlya7RvpW6DXbqT8dAFVBjmS07x9hfVPq6kWl/zGaXxKsgXCVQD2jCNIbwELmQIi9zGh2PxwHN2YN/ezkeV6gTI/6Ek0gCD0XGJOtNfe44QpIcpz2vzR2sna//mcgoLZaibzd8lLM1ic/9ieqGn4NNFY4JhTKOOsymNKKjOp0OGpiGBtSAxnbhhsNSZzSiG58yVTQabVJlbBVtCqVtNbo/or0ihcs+tRrKZIqzLPVmd0OHC5Ll7U3hjOWlTBg5JVcX1zPyO7OwYmvnSjT5WPXp+HQ8qBVF92icXE6JP6EnXqcYNGoxqwfVeuGnKK5wvDXASy3s+hq3effEwDToSYnebwlR23Pa8d0L0aB+eNPQ5M8vMxdpLGRX23vBhZ+O949S494U2O1ZWza2t78rWIAGx9mxy0xtsfTrkuOq5wVkkMNjDXji3m2GRguWGQjoAixPP28x3DSbbtsbzkzkoEpLo7HLmoVyDmr60I6ru1MuHYeHu/lzOXVlgKs8L6XrBXJJVsKmhHVCx7PSWAxZQDPBAdtatKHIyI7Zd36F1CMWOQyRdj43mhawFDYt45CrfMT9tvYzzlQ8ypmQo9qEGZ1N3n/6cD45eDc9u/hwfXFwGI5D++CbL6ZozmQXh5/E+iND/8ybbQf8/17+L9/L69S18GBHRcaExGLiGLGpi+sN3S2ut0FdIG/oZhMzA590VlX49bcS8JZ4c7vNVXyrApoCS0C7rHO3XHrmg3wwQwjtvXD3CobXc79jwjkU9ruyt50ecfnxeobVp/7NIVcJ7tFshb9HsBWN6JzOqSsZdUXY+O83NGNyWbIlynu9+PcXAB+Akg== +api: eJztWUtv2zgQ/isETy1WkZ00abPaU17d9aZNg8RtD3EOlDS22FCkSlJ2BMP/fTGkJMuvNujjskiBwpY5nOc3H5nRnFo2MTS6o9daJWAM4dJYJhOg9wFVBWhmuZKDlEY00cAs1HKDRiygKZhE8wLlaETPnJQhTKbEWKYtfm21EjUmNgNiCkj4mENKCq8vHMlhBs0TSWHMJUeVxCpSGsAP74Db3+pLmCRxVx9wm4EmpeFyQrg1pJT8awnkAaqRfMEM0WBLLSElcUXOoRCqIhqMKnUC5mVAVLMXzZxev79qfRqcu6AYmYI2XMlwJEfyM0MbY6WdfKLyQoBzuw60WEsriWGsNNReoB2G5kthR3KWgSRsxrg9W+rhhoBksYA0HEkaUA1fSzD2VKUVjebukWtIaWR1CQFNlLQgLS6xohA8cfXrfTFYnDk1SQY5w2+2KoBGVMVfILE0oErChzGN7jZXLLcC2squ1f+mdqe6hIough/dPUjp4v5pwnQRUHhkmCCDgZxW21DzAC49psxzpqtWJWFbKtIqOG/3X0IV0oBOmSgB9WwToNH+wavDI5TSHCuE7iwWi2CHS4Pzn/FokDr0Ndj7pnOuXdG5vaPXb45R1O+i0f6GtwvnsQZTKGl8Rg/6ffxY7evhNjDPmKm7MkWPfhh8TIgafKtGT5lxVgvQloPvsx3Y8P6jF+vKl/t3JmtbsOu9v9bQncLOMp5kLhelgXSNqZb81mTNtXHtpLGaywlCesOvT03NtjlXF/QnnWoLGXZ94tLCBDQN6FjpnFn/06sD9NKCZNLuSplf7SSrxsamvW0Z6AKTsjR1cTBx3Smf57hVwydCOFvtdjLlhscCDwm3oJWyxCSq2IIOxP53SMcDC5HoKOo7aLr0vLOZmweofku1NhDUeL7Tk/pA5ClIi2em/l61/kJ/YvCuzTLQMAXtzi1HyCMpAVKzjcgw6BcQTkJyhs9iO6O/3BrQUyvjJLt0M5VpmLC8lCkLWcHDB6hMKMs8Bv3HJhWlUGhIMO4GXs/k9ExOz+T0G6v1+vB/RFe7Q3xq9a4cNV1CZZ5GZR6UW6jsmbieieuZuJ5vVb/oVoWyh9/4U3DKU0hJyizDIYVUlkyZ4GmIWTvatu8E50AWtGSCgNZKE5UkpdYufi7akjTTlzoTPo4df1sWWsUC8q0XuxXb5NpLkhQs44J4qBKGgEHBGFKE9t3N2zPy5+HRm/sXmbWFiXq92WwW6nGyBym3SodKT3p6nOB/lHsZkiEWj+SswnIuW6xLsfV8KsGa1+BzzmB1Vuq0g1/96nytmh0uKTXfGMWdkI83gwaRVZPVFdNuz5iVAnWwWJU2igWTD3SJk02j61bqkUanETsGFgE1ltmyE8ZuLlzXjUj7Zzi8Jl4FSVQK9bCNm8YQBpFzyfMyp9Fhvx/QnD36p9f9/gJ1YsWfEIkk8FgIJtnaBM+FwyXJcXLntbnA2lnpr6mM0nzC1+2GKz1bg/jcR1QPb3KwmcKRT6GMgw6zGY1or26nvcZNQwNqQOMp524FpRY0onPfMouo15tnythFNC+Utove9ICuHR+47FurgYxQCROZN7tZOlyQLG+nvmf+KkOOyc3F7ZD8zSzMWOVSiSZXVR/3j/tbtaLoDo0n1wPiI/TA65BBoxa7eqtaL/wUxQs8sQwkpea2usVtPj0xMA36pMTst4Co7Tnt+OyFaFB/edvA5N/PQ1dpJLKb5Yz3wk86d5+K/bWJXvc2sURjO8m/gTFocJjtu87UFqlflwmuelyAgBxWNWDEa5NpGo2ZMBDQMdgk+7T04a7ZdN9Oq4c8B1VaGvVd14yVS1BzDm2kujuxpP1wf7N/rgeOBhKV56V0Z4GckBm3GWGd0iWiNBZLFlDBE8BjLZpTRGTH7Du/QuqbIdkPEXa+N5ojYMJtVsZhovJefR1vP2Oh4l7OuOzVJkzv7OT9x6vzk713g7OLq9uLvf2wH9pHfy3CFs2Z7PrhryTrp/x6zPPlCfj8juU3v2OpW9fCo+0VgnGJZOIQMa/J9Y5ukut9UBPkHZ3PY2bgoxaLBf78tQSc+N/dL3sVnxYBzYCloF3XuTcW9MwXeW+ILrQz/s1xOr5q8TtOkgQK+03Z+84Zcf3hdojsU78/ylWKezSb4bslNqMRHdERdZRRM8Lc/z6ngslJySYo7/Xiv/8AHOQLng== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -64,11 +64,19 @@ after it has been created. The process instance was created. -
    Schema
      variables object
      +
      Schema
        variables object
        All the variables visible in the root scope. -
      +
    Schema
      variables object
      + +All the variables visible in the root scope. + +
    Schema
      variables object
      + +All the variables visible in the root scope. + +
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx index 62319b3c6e3..8a4c2acaf12 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx @@ -5,7 +5,7 @@ description: "Create a new role." sidebar_label: "Create role" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7OLVTWpQTJ3V5Ux2ndZsPjy23B9uHJbgSEYMAA4CWNRr+984SpCVHlptDjvKMR6Sw2Lcf70HkrkTAuRfZtbiwmsRtImxNDoOy5qwQmZCOMFC3loiCvHSq5kWRiZNuCRAMLcBZTaMbIxLh6GtDPvxui6XIVkJaE8gEvsS61kp2vtMvnn2shJclVchXYVmTyITNv5AMIhG140iCIs+rBivasPLBKTPfCmlaEhTK1xqXwDvAziCUtI5QtG0iggqanXBWMYmLGLNoW1535GtrfAR+NT7kj20c9gcL9BBLVIBvpCTvZ43Wy1iKH5Q7I/1Ny+fDuKPlkOUQSMw0GbwqE2hOTiRiZl2FIX719mhnLWL2fTGOxuMX8pe20QUYGyB/xB/dmI/WERQUUGkP6AhqZ+9VQQUo04U6lBhyW7xcrNrZXFP1y3bRnoY0gfNo2eNCLCagh2iYR/Tri/cn8NvRm19vfypDqH2WpovFYuRm8oAKFawbWTdP3UzyP9v9PIJpSY6gwiVniUWhGBM1rNsEviapZkpCsF2CfdjAPYj5vdzjuLrN78eWNU5t0X0CVxdnoAoyQc2Wysy3obs9M2w0+8DcNiHLNZo7se79/4lqAr6pKnSPPHsK0CbCBwzNRho7KPf61bOC/XM6PYfoAqQtCGbWQSiVH4A4iUoZVTWVyI7G40RU+BDv3o7HLfvkjn9HJgboodZoOmp9m44yUK152yWmjA9o5I/qjHVqrr7FfXom9SR+FzMaJLjrCIrHFmiUdx7uUasCsAklo0b5sCa7IFD70V5ke5HtRbZTZK+3+f7eulwVBZmOno96U777yUOt7YKKva72utrrapeu3jz3/DgxwFV2zENyzjqwUjbOUQGLUunOPT9LD9i98PYPinut7bW2S2ttIioKpeXX9tr6jjoYSpGJlN/VvEiEJ3dPjl/3V6JxWmRiFWXSZmm6Kq0PbbaqrQttes89uEenMNeRebwc5TTQRFuJuoxQ2+3ihc2X8BOsGlMgHMPF6eUU/sBAC1x25WPIp66Px8fjZ72y6Q6Pk/MziBlGsm0cAINbVvKzbqPx9zhu21supGycCstL3hbLkxM6cpOGK/5Igh6v88730Ugk/cX7gRp//TvtusuH18V6gHL6gFUdpRcHIAOrOsrNbIfUE2I7Zm4gOR+THI8Ot8l3ftZpSNqqakx3kJo5LFQoATdqIHXjA+eeCK0k8WxgHdBg9iGuwD8REQ5H3L9IsuH8nKtQNvlI2iqVcdvjZ65tnlaoTNpD+PRk8vHq07vJwYezk9NPl6cHh6PxKDyErk7M7wrNZhxxGuWemVRtDKF2Da36dgV6CGmtURmucBf8qhfRtYgiuk16IVyL1SpHT1dOty1//bUhtxTZ9e1aN3zXJqIkLMh1qrvjOY44ifEcTBmWzXXD8FtDojYZdkykpDq8aHu7of/zz5dTZlk/hKtswXscLnhAhwuRiRtxIwRP+9hDHDPx9yuh0cwbnLN99Mt//wEycfDn +api: eJztWE1z2zYQ/Ss7OLVTmpQTJ015Ux2ndZM4HltpD7YPILASEYMAA4CWORr+984S1EciyckhnelBmtGIJJa7+3bfA8VdsMBnnuU37MpqZHcJszU6HpQ155LlTDjkAfu1hEn0wqmaFlnOTvsl4GBwDs5qTG8NS5jDzw368LuVLcsXTFgT0AQ65HWtleh9Z588+VgwL0qsOB2FtkaWM1t8QhFYwmpHmQSFnlYNr3DDygenzGwrpUmJIJWvNW+B7gA7hVDiOkPWdQkLKmhyQqgiiKuYM+s6Wnfoa2t8DPxsdEw/23HIH8y5h1giCb4RAr2fNlq3sRQ/CDtFeovt7jTusV2iXCYSkSZf1Wof8oi1X95M8sHIVPCqMZKnvFbpPbY+NU1VoPtlG4DE2qGg6CwPrsHkv4WkTMAZOpawqXUVD/HSy5NvgLzo03+Lrf8+uLFyO+D+L/pFBiej0RPsFLbREowNUKyipbfmvXUIEgNX2gN3CLWzD0qiBGX6xJYCgMLKp6lcO1torHYyYjOlMVxGyyEuxNIB9xANixj95urNKfx28uLXu5/KEGqfZ9l8Pk/dVByhVMG61LpZ5qaCvmT3cwqTEh1CxVtCyaVUFJNrWDcFfI1CTZWAYHuAQ9pAFY/4nu5oXN3efVbsa5za2ozG8PHqHJREE9S0VWa2Hbq/Z8obTT54YZuQF5qbe7bu/be2vDH4pqq4W7HqywBdwnzgodmAsUc9z5/t3E7/nEwuIboAYSXC1DoIpfLLQASiUkZVTcXyk9EoYRV/jGcvR6OOfFLHvwOJAXysNTc9tb6GowxUa972wJTxgRvxozpjnZqpr+N++cQYSPw6IlpKcN8DIj5UQHNx7+GBayWBN6GkqFE+pMk+Ca59ehDZQWQHke0V2fNtvr+xrlBSounpudKb8v0jj2tt5ygPujro6qCrfbp6sev/49gAVdkRD9E568AK0TiHEual0r17etNZxh6Ed/ijeNDaQWv7tNYlrMJQWhqq1Nb31OGhZDnL6F3Ns4R5dA/oaBizYI3TLGeLKJMuz7JFaX3o8kVtXeiyB+rBA3eKFzoyj5ajnJY00VZwXcZQ2+2ihc0RyWl8+YVXcHV2PYE/eMA5b/vyUcgvXb8avRrt9EqmezyOL88hIoxk29gAlm5JyTvdRuPvcdx1d1RI0TgV2mu6LZanQO7QjRuq+IoEQ7zeO51HI5YMB2+W1Pjrn0nfXdq8rtbjrbNHXtVRenE8tXp1J8pNbR9pIMR2ztRAdD6CHKXH2+S7PO81JGxVNabfSM0M5iqUwDdqIHTjA2FPmFYCaTawTmhp9i6uwN8xIhyn1L9IsuX+OVOhbIpU2CobJiGr30LbIqu4MtkQwmen4/cfL16Pj96dn55dXJ8dHaejNDyGvk7E74qbzTzirNDtmCNujAj3jRSHdgV8DFmtuTJU4T75xSCiGxZFdJcMQrhhi0XBPX50uuvo8ucGXcvym7u1buisS1iJXKLrVXdPUxt2GvM5mlBYMtcNhd8a4XXJ8o6xEFiHJ23vNvR/+eF6QiwbRqSVlXSP43Man/I5y9ktu2WMZrHkIQ6V6PqCaW5mDZ+RffRLn38BHrSEoA== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Create a new role. The role was created successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    The role could not be created. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx index 20d3f77beb9..77b0e5d1a19 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx @@ -5,7 +5,7 @@ description: "Creates a new tenant." sidebar_label: "Create tenant" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7OLVTWpQTJ015Ux2ndZumHltpD44PILgSkYAAgw/LGg3/e2cBUpJDOc0hR3nGI5JY7Mfb9yBxN8zzpWPFLZuj5tqzu4yZFi330ujLihVMWOQe+9WMVeiElS0ts4Kdx0UHHDSuwEejCcuYxc8Bnf/VVGtWbJgw2qP2dMnbVkkR3ecfHTnZMCdqbDhd+XWLrGCm/IiCorWWkvESXVyN/imrraXzVurlKK95jRC0/BwQ8MGj1Vz12cHla9ZlTPMGv80NWYJZgK9xW2DXpRKlxYqw2yZ2lzEvvSKXCbEE0HWCg3WPN3obMD5wrdEu1fhsekof4zz69FfcQWpJBS4Igc4tglJrQv27wvwnrg8nsgX0E64HYIaM/ECTPoLUHpdoWcYWxjbcp0cvzyKCh5FKWBBUXcbOptPDSbTW3MsKK6i45yAdaOPhnitZfQWI1ppSYfPTGJDHAWZwlSyhQs+lggQUcAfJsMQKpIbb6zfn8MvZi5/vfqi9b12R56vVamIX4gQr6Y2dGLvM7ULQP9n9OIF5jRah4WsoEXhVSYrJFexaAK5FIRdSgDcR3D5tIEwnH/QO3af6F1fH3N62IFg5ovoM3l9fgqxQe7lYS70ch457Fjwo8sFLE3xRKq4/sV0v/09QM3ChabjdEudxgC5jznMf9sp4gkLPnx0U6+/z+RUkFyBMhbAwFnwt3RCIimiklk1oWHE2nWas4Q/p7uV02pFP6vg3VKIBH1rFdaTWl+VIDY2x2PMnFia181yL79UZY+VSfhl38khXPYlfp4oGQT0f8/2NsaWsKtSRntAf3oOquFJmhUddHXV11NVXdHU25vs742Fhgq4GXTkTrMD4Ha63a0ddHXV11NUTunpx6AfgTAOhHH+EorXGghEiWIsVrGqponv6YTzE7r/QEhePWjtq7ai1sda6jDXoa0Pv/K1xkTrc16xgeXqrcyxjDu09WpoXbFiwihVsk4TSFXm+qY3zXbFpjfVdfk9duOdW8lIl7tFyEtRAFGUEV3UKNm4YLey/fZ/zJuiKwyu4vriZw2/c44qvI4AU8rHrV9NX04NeyfQJj7OrS0gVJrrtHQGDW9LyQbfJ+Fscd90dASmClX59Q9sSPCVyi3YWCPMtDfp40TvdJyOW9RdvBnL88e889peOr+vd8OXigTdtL77t8GTHrTQFGe4jERcmGvc0GddBTUXrUuHTyemYkleXUVnCNE3Q8XjVS1hJXwPfw0Wo4DzhkTElBdIrf7EZEhrM3qYV+CdFhNMJ9TQRbzhVl9LXoZwI0+Qibdt+lsqUecOlzvsQLj+f/fX+3evZydvL84t3Nxcnp5PpxD/4iB2xvuF6P484k9hNNR5VujfWenIO1nfR44PPW8WlJpBj/pteXcPwyNHsKCnklm02JXf43qquo8efA9o1K27vdoKiuy5jNfIKbZTjJ5rXsPOU0smcApO5CpTAaBzUZcOOmRDY+q/a3u0dDVd/38yJfv1krzEV7bF8RVM/vmIF+8A+MEZTRPIQmR2fb5jiehn4kuyTX/r7D0boEAc= +api: eJztWE1z2zYQ/Ss7OLVTmpQTJ015Ux2ndZO6HltpD44PILgSEZMAgw/LGg3/e2cBUpZDOfYh0+lBmtGIJJb78fY9iNw1c3xhWX7FZqi4cuw6YbpFw53U6rRkORMGucN+NWElWmFkS8ssZ8dh0QIHhUtwwShlCTP4xaN1v+pyxfI1E1o5VI4OedvWUgT32WdLTtbMigobTkdu1SLLmS4+o6BoraFknEQbVoN/ympjaZ2RajHKa1YheCW/eAS8c2gUr/vs4PQt6xKmeIPPc0OWoOfgKtwU2HWxRGmwJOw2iV0nzElXk8uIWAToIsLBuoc3OuMxXLCtVjbW+GJySD/jPPr0l9xCbEkJ1guB1s59Xa8I9e8K83tc7U5kA+gNrgZghozcQJOHuFLZu3GJlQeD7ZRvVZkK3nhV8pS3Mr3BlU2Vbwo0P43LKbE1KCiBiGny3xUolcMFGpawuTYNd/HS66MnSz4LxbzHlX1e8RHJHcX/D3tJJkeTye6QrdG3ssQSSu44SAtKO7jltSy/QeHW6KLGZmfvtwNM4TxaQomOyxoiLMAtRMMCS5AKri7eHcMvR69+vv6hcq61eZYtl8vUzMUBltJpk2qzyMxc0JfsfkxhVqFBaPgKCgRelpJi8hruAQfbopBzKcDpAGWfNhCC6SfFniRmWB3vShtueSNHm9QUPl6cgixROTlfSbUYhw73zLmvyQcvtHd5UXN1w+57+dRWOAXrm4abDU0eBugSZh13fquMR7Tx8sXObfb32ewcogsQukSYawOuknYIREU0UsnGNyw/mkwS1vC7ePZ6MunIJ3X8GZUowLu25ipQ6+typIJGG+z5EwqTyjquxPfqjDZyIb+Omz7QVU/it7GiQVAvx3x/p00hyxJVoCf0f7uDqnhd6yXudbXX1V5X39DV0ZjvZ9rBXHtVDrqy2huB4elLbdb2utrraq+rR3T1atcD4FQBoRweOdEYbUAL4Y3BEpaVrIN7eqUZYvd/aJGLe63ttbbX2lhrXcIadJWmaU2rbaAOdxXLWRbf4SxLmEVzi4YmPWvmTc1yto5C6fIsW1faui5ft9q4LrulLtxyI3lRR+7RchTUQJRaC15XMdi4YbSwPTc5jm+z8AYuTi5n8Bt3uOSrACCFfOj6zeTNZKdXMn3E4/T8FGKFkW5bW8DglrS80200fo7jrrsmIIU30q0u6bYIT4HcoJl6wnxDgz5e8E7n0Ygl/cG7gRx//DML/aXt6+J+bHZyx5u2F99m7HXPrTi/2ryTExHnOhj3NBnXQU1FY2Phk/RwTMnz06AsoZvGq7C9qgUspauAb+Eiam8d4ZGwWgqkV/58PSQ0mH2IK/B3jAiHKfU0Em/YVRfSVb5IhW6yftyx+S1qXWQNlyrrQ9jsePrnx7O304MPp8cnZ5cnB4fpJHV3LmBHrG+42s4jzCTuZxgPKt0aSD46wey76PDOZW3NpSKQQ/7rXl3D2M/S1C8q5Iqt1wW3+NHUXUeXv3g0K5ZfXd8Lis66hFXISzRBjjc0nWHHMaWDGQUm89pTAqNBXpcMd0yFwNZ90/Z6a2s4/+tyRvTrZ7KNLukew5c0r+VLlrNP7BNjNP8lD4HZ4fqa1VwtPF+QffRLn38Bv8qvaw== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Creates a new tenant. The tenant was created successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx index c76c57f4bce..ea02fb106fd 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx @@ -5,7 +5,7 @@ description: "Create a new user." sidebar_label: "Create user" hide_title: true hide_table_of_contents: true -api: eJztWUtT4zgQ/isqnXZrTRxmmFnGtywDu+zOg4KwewAObbkTa5AljyQnpFL+71st2SSQBOYwx1CVwla3+vl9stNZcg9Tx7Mbfu3Q8ruEmxoteGn0ecEzLiyCxyBLeIFOWFmTkGf8JIgYMI1z1ji0A55wi98bdP4PUyx4tuTCaI/a0yXUtZIiWE6/ObKw5E6UWAFd+UWNPOMm/4bC84TXluLwEh1Ja3BubmxB10+DGJfIeikzE+ZLfIyls+m8lXrK24STQEOF28300lfN7DbxQ9uxAqm27w+iVwy0CffSK1qitlzGgvOWBFR9abHgmbcNhgVXG+1iFd8MD3dnzubgWOx2wVwjBDo3aZRaDG41T35WI8nTP7jYHsY9Lvrc+0CaCLzOqNQep2FhYmwFPi69P9ooSoTmZZc81aZN+NFwuOn3WkOukHnTuVxV/lZ/NhZZgR6kcgwsstqamSywYFIHvb66LDfFy3WqrckVVr9t1utpOCN2ETU7vyzWkYFjUTGP3m8uz07Yh6N3v9/9UnpfuyxN5/P5wE7EARbSGzswdpraiaAP6f06YOMSLbIKFixHBkUhyScotuoQczUKOZGC6kEJdmEzqn/M7+X2RunyGWTX2tVYuXGOjNj15TmTBWovJwupp5uuw54JNIpsQG4an+UK9D1f9X3T6XMvrqkqsI8Qe+qgTbjz4Ju1NHbA7e2bDdsE3r/G4wsWTTBhCmQTY5kvpesdURKV1LJqKp4dDYcJr+Ah3r0fDluy6buD4ZVMNMOHWoEO0HqejtSsWuE2JCa186DFz+qMsXIqn/sdPOFgB+KPMaOefjtOn+6RwRSIe8dmoGTBoPEleY30IW6GIEC5wZ5ke5LtSbaTZG838X5mbC6LAnWA5yPfpGPaeAZKmTkWe17tebXn1W5efdiG9/jiLH0ZrE3lDPXqawQoi1AsGD5I593+9XDPsD3DdjPs3bZvZyPNqMqWcIjWGsuMEI21WLB5KVUwT19Ue9/do23PtT3X9lzbxbU24RX60tB4rzYuQAd8yTOe0rPL8YQ7tDO6ym6WvLGKZ3wZadJmabosjfNttqyN9W06ox7MwEqao4SWkTjSqYeJMgJUGV1ttosE64OzE6gaXQA7ZpenV2P2J3icwyKUj1w+NX08PB5utUqqOyyOLs5ZzDCCbe0A6M0Sk7eajco/Yrht76iQorHSL65oWyxPjmDRjhqq+CMIOn/BOt1HJZ50F2c9NP7+bxy6S4fX5WrUevoAVR2ptxqVrpC1mnuu1p7fd1PJtTml1BMTQuyQtJksdR6ti9UZDg43UXtxHsgnTFU1OpzAehpfmGCteEI1zsdhp5ICaWSXLfsIe7VPUcL+jR7Z4YAaH9HZH7xT6csmHwhTpSJue/yfK5OnFUiddi5cejL6fP3l4+jg0/nJ6Zer04PDwXDgH3woMBGjAr0eR5wPNltG4Wtz7u1T8a7LHh98WiuQOkyjrYoNIyTc8Mi9u6Tjzw1fLnNweG1V29Ly9wbtgmc3dyu60V2b8BKhQBvIek+zVX4SozkYk1tSVw253xjctkm/YyQE1v5F3bu1Y+Pi69WYwNlN+StT0B4Lc/oFAOY847f8lnP6MYEsBNyH9SVXoKcNTEk/2qW//wHn3XQR +api: eJztWU1z2zYQ/SsYnNopTcmJkya8qY7Tuklcjy23B9uHJbgSEYMAA4CSNRr+984CpCVbkp1DOtODPKMxiV3u53ugtFhyD1PHs2t+5dDy24SbGi14afRpwTMuLILHIEt4gU5YWZOQZ/w4iBgwjXPWOLQpT7jFbw06/5spFjxbcmG0R+3pEupaSREsD746srDkTpRYAV35RY084yb/isLzhNeW4vASHUlrcG5ubEHXj4MYl8h6KTMT5kt8iKWz6byVesrbhJNAQ4XbzfTSF83sNvFdj2MFUm1/PoheMNAm3EuvaInachELzlsSUPWlxYJn3jYYFlxttItVfDU83J05m4NjsdsFc40Q6NykUWqR3mie/KhGkqdPuNgexh0u+tz7QJoIvOdLEIF40aUaxOsxznSRCqgaXUAKtUzvcOFS3VQ52l824y+wtijIeSxi8p9mJLXHaViYGFuBj0tvj17I8SxE/wkX7vuyjYXbku3/oVukcDQcbnq50pArZN50DlasuNFfjEVWoAepHAOLrLZmJgssmNRBr0c+y03xPIZra3KF1VYsrIczYudRs/PLYtUYOBYV8+j9+uLjMXt/9ObX259K72uXDQbz+Ty1E3GAhfTGpsZOB3Yi6EN6P6dsXKJFVsGC5cigKCT5BMVW/WCuRiEnUlA9KMEubEbVjvk938woXT7pzhrwGis39vgRu7o4ZbJA7eVkIfV003V4ZgKNIhuQm8ZnuQJ9x1d933T61ItrqgrsA6AeO2gT7jz4Zi2NHcR5/WrDNkH1j/H4nEUTTJgC2cRY5kvpekeURCW1rJqKZ0fDYcIruI93b4fDlmz6btN+IRPN8L5WoAO0nqYjNatWuA2JSe08aPGjOmOsnMqnftNHHOxA/CFm1NNvx5uhe50zBeLOsRkoWTBofEleI32ImyEIUC7dk2xPsj3JdpLs9SbePxqby6JAHeD5wDfpmDaegVJmjsWeV3te7Xm1m1fvt+E9/qiRvgzWpnKGevUTD5RFKBYM76Xzbv/1cM+wPcN2M+zNtl9nI82oypZwiNYay4wQjbVYsHkpVTBPQ4Ted/dq23Ntz7U913ZxrU14hb40NHqtjQvQAV/yjA/o3eV4wh3aGV1l10veWMUzvow0abPBYFka59tsWRvr28GMejADK2mOElpG4kinHibKCFBldLXZLhKsDzWP42SJvWMXJ5dj9jt4nMMilI9cPjb9bvhuuNUqqe6wODo/ZTHDCLa1DaA3S0zeajYqf4/htr2lQorGSr+4pMdieXIEi3bUUMUfQND5C9bpPirxpLv42EPjz3/Gobu0eV2sxuAn91DVkXqrMfYKWauZ9Grt6X03MV6bIUs9MSHEDkmbyVLn0bpYnWF6uIna89NAPmGqqtFhB9bT+IUJ1oonVON8HEQrKZBGdtmyj7BX+xwl7O/okR2m1PiIzn7jnUpfNnkqTDXo5pMP/3Nl8kEFUg86F25wPPpydfZhdPD59Pjk7PLk4DAdpv7ehwITMSrQ63HE+WCz5Zhi7Qxi+4lF12WP935QK5A6nBRYFRtGSLjmkXu3Scefa75c5uDwyqq2peVvDdoFz65vV3SjuzbhJUKBNpD1jiap/DhGczAmt6SuGnK/MVRvk/6JkRBY+2d1b9e2jfO/LscEzu4EpjIFPWNhTqczMOcZv+E3nNNBD1kIuA/rS65ATxuYkn60S3//AjDTB7w= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Create a new user. The user was created successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    Unable to create the user. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx index 4d4319dccbe..9848c410dfe 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx @@ -5,7 +5,7 @@ description: "Evaluates a decision." sidebar_label: "Evaluate decision" hide_title: true hide_table_of_contents: true -api: eJztWttu2zgQ/RWCTy1Wsd02vaze0jjdda9BkrZYJHmgpbHFViJVXuoIhv59MaRkyZFst267fdgECBKJw5nhzDnDm5bUsLmm4SUdQ8Q1l4LEMOOCGy4FvQ6ozEExfJjENKTwlaWWGaiFaUBj0JHiuZMP6UkloAkjcSU0uBL/SEt0DhGfFcQksGoiRpJaJwFuElBkWhCruZgTbjSxgn+xQD5DQe4xTRQYqwTEZFpciTHkqSzOQEurIrgfEKmqnmsmJuMB+ZiA6G8L3IsUXTYkdhohvhJfQTkBOVvvwDWxGuLBFQ5dwRcL2jyXcUHDpXvkCmIaGmUhoJEUBoTBJpbnKY9cHIefNEZqSXWUQMbwP1PkQEMqp58gMjSgUsC7GQ0vuy2GmxRaYa7zcFZ5UryCgpbBHh0nMS2vd8rRMqBww7I8BY2ePy+a0DS4wXS5EdosY6poqVsP5rTpPV51fgXFgAYUOwAq6ZWg4YOHjw4fo5jibOq9Kcsy2OTRZLy3Q5N4hz+OGejPweMnT5/RjlOlc0yBzqXQPm4PRyOvq82di7YrC6ZXzHAO7I2mXCGHDfeWN4Szz5cW93gMwvBZ0SHQIuFR0nW28oELA3NQNKAzqTJm/Ksnhwij/jj2+TEZd2i43aw2iot5v5G3LIN+M4Jl8BMNffAVpN/WpvKyTzgfPWw7cOaLUAbC6O8IqGp1I3PF8oSYhJmd3mFBzJkyRM62xqXt1g8B7uc6ug2g0prcmq6nL8/fvSWxjCz64I0veJoSLrRhwvC6qijQNjXflGI3m3RiN2M8hXj84zzxikhsUXNtFifmTVatgjegNZv3UKVqIP7tFDUukmJ3/L0TvSYNCCbMpmH51tboGp2rFcY26E1cXiL4fthx3QypN2rb4LPysk6g7lpfNVUwAtUe3YKbhIsKS276bQ253yGmFCtoQLmBTPdNBuv2j1oLMefA7cLzH88dd1PH75w6GgcuXKdeMhb5/iP97RX11xSajJkogfjMptDD8bVVnUIZP8KqV8PyndVmf3Kj2e+2us59VLGbZbV6lO6NlVMjYrjp18SxaYeybVBeZeydg9qGdHTzSjw09f7R3q13PZ6+YXdEN+rcwrBvK1T7aP7Q7II6dQmb9tFddnedqznTp3FiIKNlW/CNh8Zqd4qo8kItDEzEZgg0G3ontH3+/YXMdOZ7Jt/vJ6jTtBeeXM/epLuWvdG0Q+8PYGmT5m1QcmjoIqkrt1GkOQvxO3nqN/aHm/byuZJfeYx+M8Nw/yGkwaHxbfv5XMlpCtkf3X39bQydekkSg2E8JR5rhOl6ZY57HkEuz14ckz8PHz+9vpcYk+twOFwsFgM1iw4g5kaqgVTzoZpF+Ity9wfkIkEiZKwgUyAsjt2agKWkAVx1mMcjPMAzfqzOGUzI2uS74RjCVCuM9QS2SrpVvIc3788mnfXkmmnXZ8ZsijrYVFoTTlMmPtMmn12jt61Ux0Q1ANcNlAHVhhnb5vnGKalvlvj74uKUeBUkkjGQmVSe55UhHETGBc9sRsPD0QhXGDf+6clo5BZsmPFvGIkgcJOnTDho3R4OFySTCir8DDwv/VbpJ2VGKj7nt+0O1mhagXjsR1QT6nBX0fZcmkkr7rh0x6U7Lm3k0uO+yekIZ1ADCnEISklFZBRZpXDZkfDUqY9Ar65LqtMHj8U7rt1x7Y5rXa7hQQCYROJlUC61gw4zCQ3psJ63DpoLKT1s1vI0oBoUnuu4Oz+rUhrSpSdQGQ6Hy0RqU4bLXCpTDr8+vHXDRLHZE60GUCojlibeiW4isaG9dD9mmRUxI8/I2cn5BfmLGViwwgUWTa6rfjZ6NurViqIbNB6dTogfoYdhqzTUapHjvWq98LcoLvH+UkNkFTfFOXbz4ZkCU6COLOZiBY/KntOOz16IBtU/L2rQvPx44fKOZe2sue498XegWw5FR7euAduHT2s7oZl0blW46g4Qs12fB9LR4EEXw6cTR8VIZpkVrh7jmTw3CWGtgEWp1QYDFdCUR4D7l3BJhdvcrcy+9i2kOoEkDwaYbI/IugzPuUnsdBDJbBj5bqu/01ROhxnjYliZ0MPjozfv346PDl5Pjk/enp8cPBiMBubGuKAiTTImWn6srmXrqN4e7bKZf/5f3xpUuDVwY4Z5yrhA9LjELKs6c0n76gxdHYhUH3T4anFJl8sp0/BepWWJr79YwIvxy+sGt/hUBjQBFoNypcnd69Njn4EDd0q8uhnv3krjdwi+x1EUQW62yl63yufpu/MLpGL1XUUmY+yj2AK/uWALGtIrekXxQ4nc1Bcr7v2SpkzMrbu3ol4v/vwLl+ZD2w== +api: eJztXO1v2zYT/1cIftowR3a7tOv0LY2zzeuaBkm6YUjygZbOFleJVPkSRzD8vw9HSrZsyXbqNnuerQpgxBKPd8d7I/mTqTk1bKppeEOHEHHNpSAxTLjghktB73pU5qAYXoxiGlK4Z6llBipi2qMx6Ejx3NGH9Kwk0ISRuCQKbsWf0hKdQ8QnBTEJLJuIkaTiSYCbBBQZF8RqLqaEG02s4B8tkA9QkG+YJgqMVQJiMi5uxRDyVBaXoKVVEXzbI1KVPddEjIYB+SMB0d7WczdSVNmQ2HGE+Fbcg3IEcrLegWtiNcTBLQ5dwUcL2ryWcUHDubvkCmIaGmWhRyMpDAiDTSzPUx45O/b/0mipOdVRAhnDb6bIgYZUjv+CyNAelQLeTWh402wx3KRQM3Plh8tSk+INFHTRO6DjKKaLu710dNGj8MCyPAWNmr8uVqZZxQ26y43QZhlTRY3dujHHq97DZec3UAS0R7EDIJNWCho+e/798QskU5yNvTaLxaK3TaPR8GCFRvEefVxmoD5HL17+8Io2lFo4xRToXArt7fZ8MPC86rlzXVdlxvQyM5wCB0cTS9MymtbFvWYaSK4wwQ0HTSZSkabbvdKowCbfVdftZmkb4mjYyKpZwqOkOeRSojaKiymGXlPIOcugXYxgGXxBQb/7gtAua1u12C2OCwNTULRHJ1JlzPhb3z+vK3Dpa0oGwuhPMKiqdSNTxfKEmISZvdphfcuZMkROWu0ircmtaarx69W7cxLLyKJEL2rG05RwoQ0ThleZpkDb1DzKTq7CNhSYMJ5CPPz8YPOMSGyRcyUWJ6ttUq2Ct6A1m7bEW9lA/N0xcpwlxX5reyVaRRoQTJhtw/KttdGteC5n3TauS7LKgrrJf9lU+hFUnf2Mm4SL0pluTqjJbLcjU4oVtEe5gUy3Vah1+Se11YFTYDN99hWeN372aVqttpjgMQjDJ0VjRdB0096MfXncXjK6AvgFCuBKgWvXqTUbivzwkf7PS9rTZHrGTJRAfGlTaMnxtaWGQho/wrLXKsu5frLkRrGfLHU995HF/iyr2CN1q60cGxHDQzsnjk17mO0K5aXH3rlQ2+KOpl+JD019uLX38123p2/Yb9GtPHdk2OMK1SGcf18tzRt1CZsO4b1oboWWc6Z348hARhd1wrc+NJZrZ4wqT1SLgZHYHgKrXaYj2j3/PmFmOvEtk++nJ6jjdFA8uZ6tTnctB0fTHr6fEUvbOO8KJRcNzUhq0m0l2dyp4a7O7eT/4VXS7mVEfRvzWYKfamMTLx2Cs3sEn67k3nzcEQ+bTnRE9V3+vYiDiGVWxCxgOQ8+QKEDYbMxqO+aCEAMuYIIh11BUR0m8B9aEneYQIcJdJhAhwl8tQWwwwQ6TKDDBDpMoMMEOkygwwT+HZjAY5ZJ/6cowWNUf0LcYLv4R7j+3GEEb6DQj8MUfIC2YAodgvAfWkB3CEKHIHQIQocgfLUFsEMQOgShQxA6BKFDEDoEoUMQ/h0IQvergs//VQGSHW87e5Arec9jDD5mGA5NSIPxyXedP8iVHKeQtf4KYb0QXHhKEoNhPCW+YBCmq/0NmlOQm8ufTsmPxy9+uPsmMSbXYb8/m80CNYmOIOZGqkCqaV9NIvwg3bcBuU6wmmWsIGMgLI5dJLK0DkP4w0c8wgNHxo/VKYNWXFtBbQEiTLlMXLd6bV62ircUv/eXo0bUrYl2fSbMpsiDjaU14Thl4gNd+bMpdFNKeaylqiLrAhY9qg0ztl6st64r2qb6X66vL4hnQSIZg4N0XGSWgnAQGRc8sxkNjwcDXCY++KuXg4FLA/T4I0YiCDzkKRMutDaHwwXJpIIyfgJfXH1efSHPSMWnfFNusJZbZRAP/YiqhDreN/P6XJpIK7pc6nKpy6WtufSibXI6wWWQAYVxCEpJRWQUWaVw7Zjw1LGPQC+Pd5YQko/FLte6XOtyrZlriOaASSQeXs2ldqHDTEJD2q/mraPVAVrdX60+aY9qUAjOuec/VqU0pHOfQIuw358nUptFOM+lMov+/fONE7EUm32iVQGUyoiliVei6UhsqO+/Tv1DK/KKXJ5dXZOfmYEZK5xhUeQ661eDV4NWrki6hePJxYj4EfowrJWGii3meCtbT/wYxgvcT2mIrOKmuMJu3jxjYArUiUVfLMOjlOe447Unor3yy09V0Pz6x7XzO5a1y9Xx9DN/ZnvHnm2wcWy5jiCubWcn0qlVxlVzgOjtCtSlg+BZM4YvRi4VI5llVrh6jE82uEkIqxksSq02aKgeTXkEuH8J51S4HfpS7G++hZQwMnkWoLN9RFZleMpNYsdBJLN++bhz+X+cynE/Y1z0SxG6f3ry9v358OTot9Hp2fnV2dGzYBCYB+OMimmSMVHTY3mMvLLq5mjnq/nn63o3Qhm3Bh5MP08ZFxg9zjHzss7c0LY6Q5eoFvcvoPDV4obO52Om4b1KFwu8/dECHuS/uVvFLV4tejQBFoNypcm9h4Ceeg8cOah/eZK/eYoe35vge5xEEeRmJ+1drXxevLu6xlQs3wORyRj7KDbDd0SwGQ3pLb2l+GKH3FRPx9z9OU2ZmFr39I96vvj3N9eW9ug= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -51,7 +51,7 @@ The message variables as JSON document. The decision was evaluated. -
    Schema
      evaluatedDecisions object[]
      +
      Schema
        evaluatedDecisions object[]
        Decisions that were evaluated within the requested decision evaluation. @@ -67,7 +67,39 @@ The evaluated decision outputs. The decision inputs that were evaluated within this decision evaluation. -
      • Array [
      • ]
      • ]
    +
  • Array [
  • ]
  • ]
    • Schema
      evaluatedDecisions object[]
      + +Decisions that were evaluated within the requested decision evaluation. + +
    • Array [
      • matchedRules object[]
      + +The decision rules that matched within this decision evaluation. + +
    • Array [
      • evaluatedOutputs object[]
      + +The evaluated decision outputs. + +
    • Array [
    • ]
    • ]
      • evaluatedInputs object[]
      + +The decision inputs that were evaluated within this decision evaluation. + +
    • Array [
    • ]
    • ]
    Schema
      evaluatedDecisions object[]
      + +Decisions that were evaluated within the requested decision evaluation. + +
    • Array [
      • matchedRules object[]
      + +The decision rules that matched within this decision evaluation. + +
    • Array [
      • evaluatedOutputs object[]
      + +The evaluated decision outputs. + +
    • Array [
    • ]
    • ]
      • evaluatedInputs object[]
      + +The decision inputs that were evaluated within this decision evaluation. + +
    • Array [
    • ]
    • ]
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx index 26777316286..61350dad91c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx @@ -5,7 +5,7 @@ description: "Search for authorizations based on given criteria." sidebar_label: "Query authorizations" hide_title: true hide_table_of_contents: true -api: eJztWm2T2jgS/isqfbqrc4DsZvdyfCPgSXw7Aywve7U3mZoIuwFtbMmR5GE4iv9+1ZKNbTAzJJX9tJOq1Bip1S/qp1vtlnfUsJWm3Vvay8xaKv4/ZrgU9M6jEehQ8dT+7NIpMBWuyVIqwqqUmiyYhohIQVb8AQQJFTegOGt9FNSjMgVl6YKIdumSi6gmR1OPKviSgTbvZLSl3R0NpTAgDD6yNI15aAnbf2hUY0d1uIaE2dk4Hi1p93ZHzTYF2qVy8QeEhno0VSjWcNB2hVSW25E9Uhmy5BBHpcbUK1gxpdiWepQbSPTXCLMcT6XN1pALM5KgQmSxrYjTRnGxonuPShWBal5vpwgXZLPm4frAyKyBKIiZgciJQL4gssQ6ddqnHh34077z6JJlsaHdfNxwE0O+FyPk7uOy/d75hCuIkIcz6a5CbqHwawZqiysnzn90f4crU7aCU/3HbMWFdWRtty/eVSWT5k3hIoJHIpfEespuimHKEG115GJFcG1lq7kwsAJFPbqUKmHGDf34A25+zBPeABWUk7BHnmQJEVmyAFUTqMBkSqBjpEBX2N24UKJTs7c0TU4PDia52GNI1iJ9qZy/7Ry6/1PMtEFX/MbiDPQnku/eFvVkJFXwwGWmCz4KdCqFhqfwXvfH/qDqO1hK1eDgY10Xlq5R2SVXf7a2+0awjtkKSrB6DTY2LDq/4DT040Y3InxqKbOwzC3Q9UCor+2dX1fZjzMKyY0ANbMkTTrhYtxydIolxR8pqIRrjam5ScA5PS/lV+Sl+dSfUI9ORtc+9ej7yWg+ph696Y3HwfA99eh8OB37/eAq8AfVzDMqLHKJ6g4TJg79Atsz6SG60MLmIP35TQ0WNW9cWS/Uk18jYROY6jnWqAzsgEO6dd4Pnc5XQEmBzmKbdC4+Ps+79mlUPZvguXBbiM9sITN3RNUUfRLz38DqaY2NNCwOilxxtKM4l+fyhBl3ZKCQhqLgPEY8epTUml1nz+sHS1DA0q6z8vEAcWc5mkU0mBaZayBmzXUx96mahD/lFQVmTUFA6Ax1Pz1/Lsjt9fPjYuVx2dfqbs+676b6U4neBdNRZNaC8UBxjBh+Biy2EMhBUq+CL1e6MUv/mQnM+2scBAq0zFQIz9tZUBKzZibXcM0e4HvYXPKWhEVRW0Ei65yJke2iJj2U6fPZh9Ek+G9vFoyGpf33k7ndlht/Ou29x6d3vVn/A/Vobzy+DvoF+fT36cy/oR6d+cPecGYr/vH16Pcb3/4YT0Z9fzq9H/hXwTDI1wz8fjANRsP7if/rPJj4SHuOpDZa+KjquYpnJhU3lM6p2F+JiCJSTrfzyBMXhlK5qhkE0xRCvuRYi1Zc9o1ev4jZwcF99AD1aH/i92b+4eG+8E0wnM56w35l5rD7lamJ3xvkf5pW2nH0y/2sN/2lGGhiNB8PnBruoYlZPlNlN/CvfbvKPRSryoHBZFD+uBpNbk5oSwkVzIxrfjsN6SB6HjU9EnNtaiEYDJxvSp+Q8l0EvZMJ/iWDvDLAIuwUacWbefUMKdUdzEb1qVrhVx4wz9SGVcK9R998Ven3Bc8ysmQ8hqhFbqQCEoFhPNaEKcCXqwceQVQ5oq0sspDR1vVozpSMqZKLGJJ/nJaOxzs/dpS5XOJChzBNHOHCSb+dXPXJv9789M+7v62NSXW33d5sNi21DF9BxI1ULalWbbUM8T/S/b1FZmtQeOZuyQIwn3KUyWJSxj3RLg7D4v0yV9tGpLPvmeowTxV1h1eO0UzxBrTNJwHhEQjDl9uiZqyJptV+iy1eu4uYic+0xMKp0GMpOksSprbFaVoXgC/lhpmsitezzYamLPthNhsTx4KEMgLb3bM1Wy4IjUi4wM4H7b7pdDya90Fo9+dOZ4880eMXWCIIPKYxy+v6I3O4IEmJW2sYF9owEX4vz0jFV/xYbqv2cpeDeOAsKiLxdXMk5qUqiVn4WWNVzCMbnSg1LPpcYJVgsX7ivewlyF6C7C8fZD+e4v1KqgWPIhAWnod445oIaQiLY7mB6CWuXuLqJa7OxdVPTWVkD5tqBhTiEJSSisgwzJSCCK+VYss+BK0L2UVP5qVQfIm1l1g7E2t7jyZg1hKvuFOpLXSYWdMubde7hG33zkbxNk09gNK2r5CpmHbpzoXNvttu79ZSm313l0pl9u0H9MkDU5wtYodEnHbhVcAmliGL1070qftwQrDk0JTrsyQTESNvycSfzsh7ZmDDtnY708NlecH6bedtp7lHgw3hZo69cUCchQ58lYRQsMXIbmTriC9hvMfGrYYwU9xsp7jMbc8CmAKF79kVUOTyLHf87Yiolz9cFVD5939m1tuYzCbllwn+I0tSF4rlPV+1r1q7ikLEu88Obg+fBBxaCXflJbm71+4cbp47RzfCtztnYvXmFcf2FvhLae3LYXm6UwgbUNptbaf1+jQExoGN5FAmSSZsOhcrsuFmTVhl58M40/mFY8xDwEZFd0cRUBWx126G/OYkktctRI2DdpHFV9yss0UrlEk7dMsOfxexXLQTxkU7F6Hb/d7NfDjovboO+v5w6r963eq0zKO7sMAoS5io6GFb+kdN+WODKx+XfOv3LDmaDDyadhozLhDf1spdHvO39ESJPOrvvDxyb+luh1LmKt7vcdj2cGj39q4MdPy19+gaWOSQQD8jsmjfWfDKwg7J48w2xY7v+vZesaIXhpCaJ2nvKglsPJpi03iRf46TyAjXKLbBT3XYhnbpR/qR2k97TNHPteM7GjOxyiy0qeOL//4PH+mCiA== +api: eJztW22P27gR/isEP7WoYjt3ubvU3xxbm6jZtX1+ueK6WWxoaWzzIpEKSe2ua/i/F0NKtmTLGydICxSnAMHK5HBeOM8MRxS5pYatNO3e0l5m1lLxfzPDpaB3Ho1Ah4qn9meXToGpcE2WUhFWptRkwTRERAqy4g8gSKi4AcVZ64OgHpUpKEsXRLRLl1xEFTmaelTB5wy0eSOjDe1uaSiFAWHwkaVpzENL2P5DoxpbqsM1JMz2xvFoSbu3W2o2KdAulYs/IDTUo6lCsYaDtiOkstyO7JHKkCWHODpoTL2CFVOKbahHuYFEf40wy/FU2mwNuTAjCSpEFpuSOG0UFyu686hUEaj68baLcEEe1zxc7xmZNRAFMTMQORHIF0SWWKdO+9SjA3/adx5dsiw2tJu3G25iyOdihNx9HLbbOZ9wBRHycCbdlcgtFH7NQG1w5MT5j+7ucGTKVnCq/5ituLCOrMz2xbOqZFI/KVxE8ETkklhP2UkxTBmirY5crAiOLU01FwZWoKhHl1IlzLimH3/AyY95wmuggnIS9sSTLCEiSxagKgIVmEwJdIwU6Ao7GxdKdGr2lqbO6cHeJBd7DMlapC+V87ftQ/d/jJk26IrfWJyB/kjy2dugnoykCh64zHTBR4FOpdDwHN6r/tjtVX0DS6lqHHys68LS1Sq75Oq/re2uFqxjtoIDWL0aG2sGnR9wGvpxrRsRPpWUWVjmBuhqIFTH9s6PK83HGYXkowA1syR1OuFgnHJ0iiXFHymohGuNqblOwDk9L+VX5KX51J9Qj05G1z716NvJaD6mHr3pjcfB8C316Hw4Hfv94CrwB+XMMyosconqDhMmNr2HzZn0EF1oYX2Q/vyqAouKN66sF6rJr5awDkzVHGtUBrbBId0674dO5yugpEBnsU06Fy+f5137PKq+mOC5cFOIz2whM7dEVRR9FvPfwOp5jY00LA6KXHE0o9iX5/KEGbdkoJCaouA8Rjx6lNTqXWfX6wdLUMDSjrPycQFxazmaRTSYFplrIGbNddH3sZyEP+YVBWZNQUDoDHU/XX8uyO3V9eNi5XHY1+pu17rvpvpzid4F01FkVoJxT3GMGH4GLLYQyEFSrYIvV/rySPtT5G8FWmYqhC/bWVASs2Ym13DNHuB72HzgLQmLoraCRFY5EyPbRSm5r67ns3ejSfCv3iwYDQ/230/mdlpu/Om09xaf3vRm/XfUo73x+DroF+TT36cz/4Z6dOYPe8OZLdTH16Pfb3z7YzwZ9f3p9H7gXwXDIB8z8PvBNBgN7yf+r/Ng4iPtOZJKa+GjsudKnpmU3HBwTsn+EpALgJ9O55EnzkbA0YqyH1UPgmkKIV9yLCFLLvtGr1/EbO/gPnqAerQ/8Xszf/9wX/gmGE5nvWG/1LOf/VLXxO8N8j91I207+uV+1pu+LxrqGM3HA6eGe6hjlveU2Q38a9+Ocg/FqEPDYDI4/LgaTW5OaA8SSpgZV/x2GtJB9GXU9EjMtamEYDBwvjn4hBxeIdA7meCfM8gXdKydTpFWvFCXU/9B3cFsVO2q1GvFuvCG1a4N36ng3Gv4BS2eUdStZSVCr1LyPYioFbIkExFrsZS3PsFGt9z7699Oy8EIUgUh7iIUc9oUiE2B2BSITYHYFIhNgdgUiE2B2BSI/9MC8et3JAu9hrbGew8bfXHxWBlyQRnppq+mjGyKxqZobIrGpmhsisamaGyKxqZobIrG//tdRaR89VVfoz/jQkiWjMcQtciNVEAiMIzHmjAFeN7jgUcQldZ3K4ssZLRxx8bOfMVOlVzEkNRuX1b9P3aUuVziApgwTRzhwkm/nVz1yd9f/fTL3V/WxqS6224/Pj621DJ8ARE3UrWkWrXVMsT/SPfXFpmtQeGCvSELwKzOUSaLycGfRLtsEBZHXnK1bV5w9n2htMwTVtWppQIxU7wG8/NJQHgEwvDlpig4K6Jp+QiYrXy7i5iJT/SAhVOhx1J0liRMbQpAVgXgOSHDTFaOmrPnn+py/bvZbEwcCxLKCOyBQ1vw5YLQiIQLPIxFu686HY/mR7No9+dOZ4c80eMXWCIIPKUxy18KjszhgiQH3FrDuNCGifB7eUYqvuLHcluV0M1BPHAWFZH4sj4S8zqXxCz8pLGk5pGNTpQaFkfvwCrBYv3MUZEmyJog+9MH2Y+neL+SasGjCISF5z7euCZCGsLiWD5C1MRVE1dNXJ2Lq5/qysge7sgZUIhDUEoqIsMwUwoiPOkeW/YhaF3ILjZ0mkKxibUm1s7E2s6jCZi1xFs3qdQWOsysaZe2q1uMbffORvGAv3oApe3uRqZi2qVbFza7bru9XUttdt1tKpXZtR/QJw9McbaIHRKx24VXAZtYhixeO9Gn7sMOwZL91mDffWEgr8nEn87IW2bgkW3sdKb7+zsF69ed1536nSLcTa7n2BsHxFnowFdKCAVbjOxato74EsY7fLPXEGaKm80Uh7npWQBToPA9uwSKXJ7ljr8dEfXyh6sCKv/458x6G5PZ5HBZyn9iSepC8XD1oLy7Wzkdj4h3N6Fu97eU9tsFd4d7O+6qTWd/GaZzdEnldutMLF8GwbadBf5SWvtyWJ7OFMIGlHZT22m9PA2BcWAjOZRJkgmbzsWKPHKzJqw082Gc6fwORMxDwI2K7pYioEpir10P+c1JJC9biBoH7SKLr7hZZ4tWKJN2/pFr/3cRy0U7YVy0cxG63e/dzIeD3ovroO8Pp/6Ll61Oyzy5rx0YZQkTJT3s94CjHf1jg0v33b71il2OJgNPpp3GjAvEt7Vym8f8LT1RIo/6Oy+P3Fu63aKUuYp3O2y2ezi0e3t3CHT8tfPoGljkkEA/IbJo31nwwsIOyePMbs0dXz/YecWIXhhCap6lvSslsPFoilvXi/yGYCIjHKPYI94eZI+0Sz/QD9TeNjTFrrJt39KYiVVmoU0dX/z3H2CAej0= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -60,11 +60,23 @@ Pagination information about the search results. The matching authorizations. -
  • Array [
    • permissions object[]
    +
  • Array [
  • ]
    • Schema
      page object
      -The permissions. +Pagination information about the search results. + +
      items object[]
      + +The matching authorizations. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching authorizations. -
    • Array [
    • ]
    • ]
    +
  • Array [
  • ]
    • The authorization search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx index ee029efec67..f0dbba95912 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx @@ -5,7 +5,7 @@ description: "Search for decision definitions based on given criteria." sidebar_label: "Query decision definitions" hide_title: true hide_table_of_contents: true -api: eJztGttu2zb0Vwg+bZhiu1u3dXrzknTz1kuWpNuDG6CUeGRxpUiVpOIYhv59OKRky7Ycu12GvThAkEg89yt1yCV1bGZpPKUXkAortCIcMqGEE1rRu4jqEgzDhwmnMc2E4i3gxQrO0ohysKkRpUeL6Q0wk+Yk04bwXbqWJMwCJ1qRmbgHRVIjHBjBBu8VjaiBTxVY97PmCxov/aMwwGmcMWkhoqlWDpTDNVaWUqRevuHfFlkvqU1zKJhflfJtRuPpkrpFCTSmOvkbUkcjWhrUywmwHkMbT21LB20cyQRIvpaPRi0pZgxb0IgKB4X9HGae4i632xwaZk4TFIgkiw4764xQM1pHVBsOph/fLxGhyDwXab4i5HIgBiRzwAMLpAuqKtDt45tzGtGLy5tz9DaHjFXS0bh574ST0NjiLVK/RLS6jjpemTYq3XXAvfv/qMAsEPM6OJTWd4hZshnsyn/FZkJ5R25Y+2irGl30G0UoDg9EZ8R7yhvFMeOI9TIKNSOI2zG1UA5mYGhEM20K5sKr775F40tRiJ5QQT4FexBFVRBVFQmYDYYGXGUUOkYrdIW3xpEcg5jjzPU5fbJSKeQbQ7ABOdcm+Nuvofs/SGYduuJPJiuwH0hjvQXKyUhp4F7oyrZ0DNhSKwuPxfumP+qVqD9Dpk2Pg7dlTTxcr7CZMP+1tHVvsF6xGayDNerRsQdpP8Ju6steN2L49JTJVr+AZjfTYZNCT/HexO7YZo9wfKes/w6Ljun6g/SH5zu1H7Vh1oqZAk4+wiJqyhFLnSXMEkYqJT5VQAQH5UQmwPhG4XJh+8wwwDTYlW7CO8I15bFPlIvXb8jkAiPH9ZvZ01esgOPpIfQhivdgrAgd6VCaP2rBhs4hdu3761CXC1DOHmMit99EpkOKzAwrc+Jy5vaJQYQlJVZWne2V6IlC6qlFdaCYcsdGVIA+GFSdarG7ZXrps3KzMe6H7qs2dejCofT5DP52NPrs2mLAVtKFfdeT76sOdnqhguPxf5boKjhsQ7RHy94XkHpcYqcdk5O2aWxZEteapl4wF/YOyKRnd7g3suuIbnW3fpf5jdu9B2ijzON5/riTCJs6VItYcAPyzkKooM3ah243/tBsLbF9KgLKVij77kbkiCa/uZE4WnhE+1zZ/abnyUR/rOOHJNpKw42kW0EciiCxJ3j8DrEJmr5PouNVOTXuU+M+Ne7/q3Fjc9isJgfadVs5PM7zL2jRn5AOyZiQwAfktTYI7ZiQljAD+G10LzjwTmH1HEmi+eLRxl4anUgovtlt8JvyjclVgGz4klCIsCQEwCRwn16/PCc/Pf/+x7uvcudKGw+H8/l8YLL0DLhw2gy0mQ1NluIvwn09ILc5GKyMC5IAYZx7zZkk6xJHbAmpyETafh42YhP0d9DvQE/3q7vxsQrdyoidcBmTd9eTttAt2k6/wZp2xyV+yxEnkqmPdB0bh4JyTGxVFMys8mKTAX5TO+Yq+6W16Nfb2ysSSJBUc1iX64YRKlEIhYMLGj8fjSLajDFo/MNo5GsBevwITRSBh1KyZje2pY5QpFjHrVdMKOuYSp/KM9qImdjmu5nLTRBfBI3afHzWn4/NBoNIln60uJcRnLDK5cg1bcdU4IVg0jfvU5KdkuyUZP1J9t1uvL/UJhGcg/Lhuco3YYnSjjAp9Rz4Ka9OeXXKq3159X3fZnKMoxAHBuMQjNGG6DStjAGOX3PSk0/B2pZ3+yV92iiecu2Ua3tyrY5oAS7XeAReautDh7mcxnTYfriddWY5w/DlRvFIzOAYwI8uKyNpTJcheep4OFzm2ro6XpbauHp4j565Z0awRIZ4xOWQZG3wSJ0ymQcBdp2IC90BxzkrKsUZeUGuL29uyS/MwZwtvFHL1Yl3S/rF6MWolyqC7qE4vpqQoGEIwU5ZaMlifveSDcDHEK5x6GYhrYxwixtEC+ZJgBkw4wr9sAqNhp+njs8BiEbNPy/bgPntr1vvcyxp1+v7BpcPrChDQnYP63oHbKN9w611fIbh1Pp5NVrq4G7PfbqJs2cOM+oOPjpXA8I9hunqjsFq6W596h4Oykero+zR1hHzdBnM3T3KxXe1T8VMe1s3ibLrta6OdDR4tpuUVxNfW1JdFJXyDUbNyFy4nLBOFKSyss2ppRQp4AAlXrbmbMFehRXyZzNoezbACA5p1vaVmXB5lQxSXQzTgLb6m0idDAsm1LBhYYfn49fv3lyMz15Nzi/f3FyePRuMBu4hDL4x7wumOnL4AU/vMHdb7eW6s/67qzFNlDt4cMNSMqHQ7V7jZVORprSvItHWpXhLI9SVKV0ukdc7I+saX/s5E42nd+syhE91RHNgPMQG/YjxR8+DNme3KA6Cy8oPrrdPjeqoxRinKZTuUdi7TpG9entzi0nbXAEqNEccw+Z4PYjNaUzf0/eU4vWkoB/eE8L3SyqZmlU+2Gmgiz//AEMA4x4= +api: eJztW1tv2zYU/isEnzZMsd2t2zq9uUm6eVvbLEm3BzdAaenI4kKRKknFMQz99+GQki1bcuxm6dABKlC0Fslz/c7Fx9SKWjY3NJzSM4i44UqSGBIuueVK0puAqhw0ww+TmIY04TKuN56t9xka0BhMpHnujoX0CpiOUpIoTeI2XUNmzEBMlCRzfgeSRJpb0JwN3ksaUA0fCzD2pYqXNFy5j1xDTMOECQMBjZS0IC2usTwXPHLyDf82yHpFTZRCxtyqEG8TGk5X1C5zoCFVs78hsjSguUa9LAfjTijtqO3ooLQlCQcRb+SjQU2Kac2WNKDcQmY+hZmj2OZ2nULFzCqCApHZssHOWM3lnJYBVToG3X3eLREuySLlUbomZFMgGgSzEHsWSBdkkaHbx1enNKBn51en6O0YElYIS8PqueVWQGWLt0j9HI+VZdDwyrRS6aax3bn/jwL0Ek9eeofS8gZP5mwObfkv2JxL58gtax9tVa2ybqNwGcM9UQlxnnJGsUxbYpyMXM4Jnm2YmksLc9A0oInSGbP+0XffovEFz3gHVJBPxu55VmREFtkM9BZDDbbQEh2jJLrCWeNIjl7McWK7nD5Zq+TjjeG2ATlV2vvbraH7PwhmLLriTyYKMB9IZb0lyslIruGOq8LUdDSYXEkDD+F92x/lWtSXkCjd4eBdWWduX6ewCdefW9qyE6wXbA4bsAYdOnYc2n+gHfqi040In440Wevnj5ntcNim0JG8t083bLNHuLiV1n+DZcN03SD94Xkr96M2zBg+lxCTW1gGVTpikTWEGcJIIfnHAgiPQVqecNCuUNiUmy4zDDAM2tJN4oZwVXrsEuXs9RsyOUPk2G4zO/qSZXA8Pdx9iOIdaMN9RToU5g9asKJziF39/NLn5QykNceYyO43kW6QInPN8pTYlNl9YhBuSI6ZVSV7JXoiSD21qBYkk/ZYRPndB0HVyBbtlumVi8rtwrh/d1e2KX0V9qnPRfC3o9En5xYNphDW911H91W7ieTYIn2w8nPpgYD/ZzNVeAduifpgGnwEqYcltsoyMamLyI5lca0q8hmzvpdAJh3d4l6klwHdqXbdLnSN3J3bUKPOnXP8sbPwTR6qRQzYAXlnwGfUau1Dszp/qFpNLKeSgDQFyt5uTI4o+tuNxdHC47FPld01QU8m+kMdgA+qnbDcCsL1jl3E8D1gcR1iBZKur0THi74f/i+ZAbIRx1XVdjJBOD+mHegL7hdecP/7KoZQQtB1xMGhdvIByT5b87i/EzlSmqf12EHTbmepA21BnZHKYKt638l4ELGskDEbsJwPbmFpBv476jftyh5DriHCSQENrS6gnSX6Wt/X+r7Wf75a/ykR2Ff/vvr/P6v/lzFM+uInEwfN/8YV8t9gaR7RK2wdPqJr8HDq6Br6HqHvEfoeoZ8H9B1B3xH084AvbR6AZ54/4qeBj0iHJIwLiAfktdK42zIuDGHa5ZU7HkPcSNiOI5mpePngDwq5VjMBWef4oSnfmFz4nRVf4lMTut1vnHnu08tXp+Sn59//ePNVam1uwuFwsVgMdBKdQMyt0gOl50OdRPgX9309INcpaMzASzIDwuLYac5EM1uaHCKe8Kj+WboSmyBEvH4HegW32obUOvcUmrcQNibvLic1mJd1B7HFmjavabhWJpwJJm/pBhuHcDwmpsgyptcA3maAv+VbZgvz2Nz5y/X1BfEkSKRi2IRkxQiVyLjECxM0fD4aBbS6PkHDH0YjF6Lo8SM0kQTuc8GqLm9HHS5JtsGtU4xLY5mMnsozSvM53+W7HcsViM+8RnU8PuuOx6pxIYJFtwZ7JB4TVtgUuUb19RhwQjDhmoQ+yPog64OsO8i+a+P9ldIzHscgHTzX8cYNkcoSJoRaQNzHVR9XfVzti6vvu5rJMY5YLGjEIWitNFFRVGgNMXbswpGPwJiad/0NvW8U+1jrY21PrJUBzcCmCq/e58o46DCb0pAO6y9uJ42Z0dB/c6N4FVfj2MLNhAotaEhXPnjKcDhcpcrYMlzlSttyeIeeuWOas5nweMRlH2Q1eISKmEi9AG0n4kJzIHPqB8fkBbk8v7omPzMLC7Z0Rs3XN+1r0i9GL0adVHHrHorjiwnxGnoINtJCTRbju5Os33wM4RKHGAaiQnO7vMJj3jwzYBr0uEA/rKFR8XPU8bPfRIPqP69qwPz617XzOaa0y817Duf3LMt9QDYvCXeOTEb7bsNu8OmHaZvP61FY4+zunKoZOHvGI6PmTKnxSoJ/f2K6frdhvXSzue3vL+iP1lfoRztX26crb+7mFXJ8VrpQTJSzdRUoba81daSjwbN2UF5MXG6JVJYV0hUYOScLblPCGiiIRGGq29KCR4ADlHBVm7Pe9rtfIX9Wg8FnA0SwD7O6rsy5TYvZIFLZsPodZf3vTKjZMGNcDisWZng6fv3uzdn45PfJ6fmbq/OTZ4PRwN77gTrGfcZkQw434OkcGu+qvdpU1n/3Sk6Fcgv3dpgLxiW63Wm8qjLSlHZlJFq7FN8O8XllSlcr5PVOi7LEx27ORMPpzSYN4acyoCmw2GOD3iL+6KnX5uQaxcHtonAD8t3bqmVQnxhHEeT2wb03jSR78fbqGoO2evUoUzGe0WyBryWxBQ3pe/qeUnwtyuuH7yfh8xUVTM4LB3bq6eKffwD0Z8K2 sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -60,7 +60,23 @@ Pagination information about the search results. The matching decision definitions. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching decision definitions. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching decision definitions. + +
    • Array [
    • ]
    The decision definition search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx index dd40cd83d25..acb009840c4 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx @@ -5,7 +5,7 @@ description: "Search for decision instances based on given criteria." sidebar_label: "Query decision instances" hide_title: true hide_table_of_contents: true -api: eJztW21v2zgS/isE0Q+7OMV20myv6/vkOs6eb9MkFzvdw6XBhpbGNrcUqZBUEsPwfz8MKdmSJb/kNu3h0BQIaosczgznlY/oObVsYmj7hp5AyA1XknBpLJMh0NuAqgQ0s1zJfkTbdMxllE/rZ7MMDWgEJtQ8wXm0TQfAdDglY6VJtL6mISNmICJKkgl/AElCzS1ozhqfJQ2ohvsUjP2gohltz91XriGi7TETBgIaKmlBWhxjSSJ46GRr/mGQ8ZyacAoxc6NCXIxp+2ZO7SwB2qZq9AeElgY00aiT5WAchdJutTUNlLZkzEFEK/lokC/FtGYzGlBuITbPYeZWrHIbTiFjZhVBgchoVmBnrOZyQhcBVToCXU/vhgiX5HHKw+lyITsFokEwC5FngeuCTGM0eGfQpQE96Q26aOkIxiwVlraz55ZbAdleXODqPSRbLIKCVW4ylW4L053x/5mCniHllTcoXdwiZcImUJX/kk24dIYs7fbeu6pVXL8pXEbwRNSYOEu5TbFMW2KcjFxOCNIWtppLCxPQNKBjpWNm/aO3R7j5gse8xlWQT8yeeJzGRKbxCHSJoQabanR/oiSawu3Gnhy9mJ2xrTN6f6mSjzaG0xqkq7S3txtD898JZiya4hMTKZg7ku3eDOVkJNHwwFVq8nU0mERJA9v8vWyPxVLUDzBWusbA67KO3LxaYcdcf21pF7XOeskmsHLWoEbHGqLNBNXQF7VmRPepJMlcO09kysFQpq8k7TJtYV82CBatpfNfYVbYtHr3fHdcyfmoxxdwVrJ1KjXIubJA7JRhUuKGcEOk8gkqlfw+BcIjkJaPuY8gHMDvdka4NSDGf/MOsi5vP7ojBvQDGMKMm5JoHjM9K6yHtWURVFTtRwVNsyxbp1f/ZLNaLk4tszVej6RuaAv1Khn3PnXOrjvD3gkN6Gmnf+Y+XJ8PLnvd/mk/+/br+cVv58Vsu16MB8jPJ+qAwgMTqcurp4yL1EfmbnVXZGTs6barv5p/snEfCmtGu3Zko6szCweWx7DKCY/cTsk4FYKw6AHpo9z9Q5awERcc3bwuCJSEcnFZbsjS0aOcH10E67J0cnbLSXsH3Bu4r+5RdwrhF+NaJrhPmeC5ct6h1QOPICK4iVDtDDbITN/IHay4fEFm8MSNNRv5cW/xMNUapF2Z0JMV+IyUEsBcwL6Z1BTcXzQwCxpTiSShihOmuVHyBTSY1HlviV1unpflK2q0PFOPX0VHUadjgdnX0ZDLXX6x9IeY2XCKyVwui0mZrdmj1m+Vp1jL8zjG3DLkMZz6Mr0optjS0GUmJza0LrJDMOYExlxy1Otlqme2LImW67pEmz1+2Uqd8yql9DwvVxTbq+hvS+JnSk7W8veIGR7++QS+cQOq2ftDmaNAmX5wk3/8X6TxLZK/cA7fyulrJPBvHfibFSxGvbM/emJNuK+NleO9GhfP7yFPPp4XIqV20XMW79mrSRbDMxb+BNpwD5XsOn/WcXvw5NV4r2U2dBzqcgbyrksaeS980uv2B/2L89+HnQ9nPRrQs/6wd9U5+733r8ur3gCHntMcl0XKu2MLkkm7r/387B1HgcXmxtx7UxkN2djE1xwwFx548add5/FHrdYzj5MaTCqsB9peHEjbCe1w6T0MP7ORSv3ZryTa1pPuf7HUdomtskz08wSyto84lqE4LjEhWOTSXxUO3JZU1+CMDYdEROp8isu9y9E5/ggdeRQP1SIGbINcG8gO0X7srgi/3GVYIuIlkoA0KcpeRZ72QHXKyNHewiPZc2V3KNeLib4N4vEhtBaCpZBbztjlQXyD8zhIMHOaKgK+vyLfJVbzfSM1OYSyx0FmB3azA2f5dvjQd3dIeqF43MDkteP8f+04fRncb5uzkrk1sL5tB4udUrm0bu1b8yLqKI6f3ave4youv0DUIB+VxrmWcWEI04WT4arDcPzISEWzrR1uotVIQPyXaqe7hvCSSz8z40t8TcbC5SeOPPebq9Mu+fn4p7/e/jC1NjHtZvPx8bGhx+EBRNwq3VB60tTjEP9w3o8NMpyCxhZhRkZAWBQ5T2GCrKo9MQmEfMzD/MVYJrZzZK/fjuY2C4WNdSTVvOImHXJ91c9r8SxveUusafFFseu92yPB5Be68otdztghJo1d1V9l1wKDrEynu4/1G3LG34fDS+KXIKGKwMEkro/JGKESMZf4ypa2j1utgGYvcGn7XavlMgtafA9NJIGnRLDsWLKmDpckXvmtU2x5s+JlLKM0n/B1vuUozpz4xGuUR+NhfTRmnTYRDAGaByZ4RFhqp8g1zF/QgxOCCdfHvgbZa5C9Bll9kL2t+vup0iMeRSCdey7jLTtfMSHUI0SvcfUaV69xtSmufqprJTvYQFrQ6IegtdJEhe5FRYT34cTyAJfzziGl10bxNdZeY21DrC0CGoOdKrz4myjjXIfZKW3TZn5sO1iCmk1/bqN4FVDjqd0h+KkWtE3nPnQW7WZzPlXGLtrzRGm7aD6gXR6Y5mwkvDfisA+x3HWECpmYevZVE+JAEZHosjiVESPvyVVvMCS/MAuPbOaBoeVN33zp9633rdpVceqGFTuXfQ9heqCymBTyZTG6a5f1k/dZeIHYs4Ew1dzOBkjmt2cETIPupGiFpWNk/Nzq7v2rm0SD7MNp7i7/+G3oLI4J7Wp1z7r3xOLEh2PxkmIN0tyqB2ZXnlkDKNYNeoyTHrWOjg8Ojw4O3w4P37YPf24fHzWO3x39m26CDFv16F5BrCpBPX5WjNN6KGzbjCWm1SpiMIV72v5S+c3ywvdy6HZ1BdrfWm4t7xW31u773sy9DxTv1eKzhcsOY+UcIIvdqithXOVS0lbjsJonLvsu3YUqjlPpap6c+BsErOCaoUhNdh1C8BAQ0WnPqfRblE878yMk2xdy2MCw8rGfl7oJt9N01AhV3Aw92fL/kVCjZsy4bGYsTLPb+Xh9ftI5OOt3e+eD3sFho9WwT/6lFKaimMmCHA5xqnnRsq70fFXq/8xvFLKws/Bkm4lg3N10cNrOswR5Q6sJkubGRLzQp7kbOp8jp2stFgt87EAv2r65XWVF/LYI6BRY5L2CfkHPpl2vyYGDPHG6SN0LpfV3uXj5xVN0whASu3XubSHjX14MhphDsl9ixCpCGs0e8Vca7JG26Wf6meJFHLe7Lj2553MqmJykzs2pXxf//QeYuYZJ +api: eJztXG1v2zgS/isE0Q+7OMd2umm36/vkOs6et2maS5zu4dJgS0tjm1uKVEnKiWH4vx+GlGzJkl/STXuHngoEtU0OZ4bzwuEjkQtq2cTQzi09hYAbriTh0lgmA6B3Dapi0MxyJQch7dAxl2HWbZD2MrRBQzCB5jH2ox16DUwHUzJWmoSbYxoyYgZCoiSZ8BlIEmhuQXPW/CBpg2r4nICxr1U4p52F+8o1hLQzZsJAgwZKWpAW21gcCx442Vp/GmS8oCaYQsRcqxDvxrRzu6B2HgPtUDX6EwJLGzTWqJPlYByF0m60DQ2UtmTMQYRr+WgjG4ppzea0QbmFyDyGmRuxzG04hZSZVQQFIqN5jp2xmssJXTao0iHoanrXRLgk91MeTFcD2SkQDYJZCD0LHBdkEqHBu9c92qCn/eseWjqEMUuEpZ30d8utgHQu3uHofSRbLhs5q9ymKt3lujvj/zMBPUfKK29QurxDyphNoCz/JZtw6QxZmO2DZ1WrqHpSuAzhgagxcZZyk2KZtsQ4GbmcEKTNTTWXFiagaYOOlY6Y9T/99BwnX/CIV7gK8onYA4+SiMgkGoEuMNRgE43uT5REU7jZOJCjF7M7tlVGH6xU8tHGsFuT9JT29nZtaP6PghmLpnjPRALmI0lnb45yMhJrmHGVmGwcDSZW0sAufy/aY7kS9TWMla4w8KasI9evUtgx119b2mWls16yCaydtVGhYwXRdoJy6ItKM6L7lJJkpp0nMsVgKNKXknaRNjcvWwQLN9L5G5jnJq3aPV+elHI+6vEJnJVslUpNcqEsEDtlmJS4IdwQqXyCSiT/nADhIUjLx9xHEDbgdzsn3BoQ4797B9mUdxB+JAb0DAxhxnWJNY+YnufGw7Vl2SipOghzmqZZtkqvwel2tVycWmYrvB5JXdMO6nUy7r/vnt90h/1T2qBn3cG5+3BzcX3Z7w3OBum3Nxfvfr/IZ9vNxfga+flE3aAwYyJxefWMcZH4yNyv7pqMjD3dbvXX/U+3zkNuzHDfjGx1dWbhyPII1jnhntspGSdCEBbOkD7M3D9gMRtxwdHNq4JASSguLqsJWTl6mPGjy8amLN2M3arTwQH3DD6X56g3heCTcSUTfE6Y4Jly3qHVjIcQEpxEKFcGW2Smz+QeVlw+ITN44Maarfy4t3iQaA3Srk3oyXJ8RkoJYC5gn00qFtxfNTALGlOJJIGKYqa5UfIJNJhUeW+BXWaep+UrKrQ8V/dfRUdRpWOO2dfRkMt9frHyh4jZYIrJXK4WkyJbc8Bav1Oe/FqexTHmliGP4Mwv08t8ii00XaZyYkHrIjsAY05hzCVHvZ5m9UyHJeFqXJdo05+fdqXOeBVSepaXS4odtOjvSuLnSk428veIGR789QS+dQLK2ft1kaNAmX5wnX/8b6TxHZI/cQ7fyelrJPBvHfjbFcxHvbM/emJFuG+0FeO9HBePryFP317kIqVy0AsWHVirSRbBIwZ+D9pwD5Xs239WcZt58nK8VzIbOg5VOQN5VyWNrBY+7fcG14N3F38Mu6/P+7RBzwfD/lX3/I/+vy6v+tfY9JjiuChSVh1bkEzaQ+3ne+/ZCiy3F+bem4poyNYivmKDufTAi9/tOo9/3m4/cjupwSTCeqDtYCBtMwseisrshXq49B6Hn9lIJX4vWBB15873C4baLbFVlolBllA25hXbUlTHJSoEj1w6LMODu5LsBryxZdOIyJ1PeZm3OTrHH6Ekj+qhWsSAbZIbA+mm2rd9zMMxH1NsEfETSUCaBGUvI1EHoDxFJOlg4ZHssbI71OvJRN8F+fiQ2gjJQgiuemx6DN/iLA4STJ2kjIAfLvjh0fb/C21kmMMBlf8esGMPMPHtAJW6yvh+qgyf6g6b5jQt7vSNb1u14Gr4mlXmvt248Q6Z/ndRYrp/R3+YXl+yf3/cyIft1r/IGPs9orig7qxes6Vz2SiUmTMZNgMWJTJkTRbz5ieYm6Z/eva3cgkaQqwhwGeYtGN1AuVCri5K66K0LkrrorQuSuuitC5K66L0u36Z4YAy9ft78PREJtzvWReuCn0Dc/PoMrdAekDB62OkouCty9u6vK3L27q8rcvburyty9u6vK0x1xpz/QLMFSlOHv2WwGccxSVNCJvkrdLY1zIuDGE6907Ouq5w/MhIhfOd7xbEWo0ERJUAb+HdWnLpe6Z8iV9/0Yl8x5Hnfnt11iO/nLz4+e6HqbWx6bRa9/f3TT0OjiDkVumm0pOWHgf4h/1+bJLhFDQWCnMyAsLC0FmOCbKOM2JiCPiYB9mRhFRsl9q8fntK2jQ5bl0cE81LftElN1eDLC7mWaFbYE3zR3Rcxd0ZCSY/0bVf7PO+LjFJ5CJw7do5Bmntkex/oWrLKvKP4fCS+CFIoEJwL6i5nJIyQiUiLvGwDO2ctNsNmh6doZ2X7bYLK7T4AZpIAg+xYOlmZEMdLkm09lun2OpM29NYRmk+4Zt8i1GcOvGp1yiLxuPqaEzrayIYvho3Y4KHhCV2ilyD7GgUOCGYcNVsHWR1kNVBVh1kP5X9/UzpEQ9DkM49V/GW1jpMCHUPYR1XdVzVcbUtrl5UlZJdLCAtaPRD0FppogL3iniIJ5HFqnrOeGdAUl0o1rFWx9qWWFs2aAR2qvDKhVgZ5zrMTmmHtrJt29EK2mz5fRvFQ9gacRwHXSZa0A5d+NBZdlqtxVQZu+wsYqXtsjVDu8yY5mwkvDdisw+xzHWECpiYevZlE2JDHqPq+acb5BW56l8Pya/Mwj2b+z346o6FbOhX7VftylGx65YRu5cDDyd40CCfFLJhMborh/WdDxl4iaiLgSDR3M6vkcxPzwiYBt1N0Aorx0j5udHxu+9EG+mHs8xdfvt96CyOCe1qfcNF/4FFsQ/H/PHwCoynXX14ee2ZFShpVaMHbunz9vOTo+PnR8e/DI9fdNo/d07azXb75b/pNiymXQ2k5MQqE1Qjqvk4rQZHd/VYoZztPCqXuyHDX+dxu7pqY9V0t758wt8X0V7d6NDeuGnhduF9IH+jAf62dNlhrJwDpLFbdiWMq0xK2m4el/PE5cClu0BFUSLdmicn/uwWy7lmIBKTHkQTPABEdDoLKv0UZd3OfQtJ54UcNzGsfOxnS92E22kyagYqaqVPIFf/j4QatSLGZStlYVq97tubi9Pu0fmg17+47h8dN9tN++AfRWEqipjMyeEQp4rHLZtKL9ZL/V+5HSYNOwsPthULxt0ZM6ftIk2Qt7ScIGlmTESQfZq7pYsFcrrRYrnEnx3oRTu3d+usiN+WDToFFnqvoJ/Qs2nPa3LkQHDsLhL3WGnzFA0eO/QU3SCA2O7se5fL+JfvroeYQ9I7cCIVIo1m93g/DrunHfqBfqB4BNLNrktP7vcFFUxOEufm1I+L//4DkwAUzg== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -76,7 +76,23 @@ Pagination information about the search results. The matching decision instances. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching decision instances. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching decision instances. + +
    • Array [
    • ]
    The decision instance search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx index 5e7e149ef01..8f177b0102a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx @@ -5,7 +5,7 @@ description: "Search for decision requirements based on given criteria." sidebar_label: "Query decision requirements" hide_title: true hide_table_of_contents: true -api: eJztWm1v27YW/isEP91hiu1u3dbpm5ekd97tS5a42wc3QCnxyOJKkSpJxTEM/ffhkJIt23Lsbh2GC7hA0MQ87+c85/DFK+rY3NJ4Rq8gFVZoRQx8qoSBApSz9D6iugTDnNBqwmlMM6F4S3rbpYwoB5saUSIpjekdMJPmJNOG8D7RJGEWONGKzMUDKJIa4cAINnivaESREqz7SfMljVe0YeQ0zpi0ENFUKwfK4RorSylSb+HwD4u6V9SmORTMr0r5NqPxbEXdsgQaU538AamjES0NeuYEWM+hjZe244Q2jmQCJN/YR6NWFDOGLWlEhYPCfo4yL3Ff2zSHRpnTBA0iybKjzjoj1JzWEdWGg+nn90tEKLLIRZqvBbkciAHJHPCgAuWCqgpM/fjukkb06vruEvPNIWOVdDRuPnfCSWhi8RalXyNbXUedrMwal+475D7/v1Zglsh5GxJK63vkLNkc9u2/YXOhfCK3on1yVI0u+oMiFIdHojPiM+WD4phxxHobhZoT5O2EWigHczA0opk2BXPho2+/weBLUYieUkE9BXsURVUQVRUJmC2FBlxlFCZGKyBNeZ+oMZg5zlxf0idrlwLgGJINyKU2Id9+DdP/QTLrMBW/MVmB/UCa6C3RTkZKAw9CV7aVY8CWWll4qt6381GvTf0JMm16Erxra+Lpeo3NhPmnra17i/WGzWFTrFGPjz1Mhxn2oS9704jls+6THDKhhAdC419gs9tw2JbQ28C3+TvROWAe72nt/4NlJ3z9hfr9870BgB4xa8VcAScfYRk1LYmlzhJmCSOVEp8qIIKDciITYPy0cLmw/SNjgGBQrICOOU1T7FN+9foNQWqsGNcN757MBzBWhMlxDI5PetnIOa6wL8wTftwt17g1uTquw4Fiyp0iFX0I1CcI7gCgbx/w0hfadrd/ir4PRHUYLgHRviy/GY2OQKav6A3YSrqwofjiG4ajI0yoUDr4O0t0FYbwlmlP4vkviHraYqcdk5O2G+7EEteaaVUwF4YiKunZ9hzsAHVEd9p2f9L8juTBE7TV5vm8fhyRYbeCbhELbkDeWQhtoVn70B0zH5o9E84FRUDZCm3fn7AnTK/tCXmy8cj2ubb7af7FTH9qlAUY7UBxC3ZrimMVJA4Uj9/6NEVzoG+c6st5IP1fDaTpZwwkA1ZXJoU3JwesG6yW22/V29PNwcyQBbOkZMYC/xeHITbbbXQeHYEtFj3X80Njr2n9n5CHZExI4APyWhu01DEhLWEGcMv8IDjwTlvy0kmi+fLJsVganUgovt4fj9u2jMlNoGz0koBiRFMgTIL22e3LS/Lj8+9+uP9P7lxp4+FwsVgMTJZeABdOm4E286HJUvxBuq8GZJqDwb6yJAkQxrnfDzNJNv2B2BJSkYm0PTU0ZhPMcPDvyET0q/sVsYZYZcRegYzJu9tJ2yOW7ZzcUk27p2g/sONEMvWRbirhWBmOia2KgpllW4LbCvCo5Zir7F9tET9PpzckiCCp5rDpdI0idKIQCs+zNH4+GkW0Od3S+PvRyLcMzPgJnigCj6VkzV5mxx2hSLGpW++YUNYxlX6pzGgj5mJX7zZ2myK+Ch612HvWj71mPBPJ0o8WdwKCE1a5HLWm7e0FeCOY9JPvDLIzyM4g6wfZt/v1/lKbRHAOypfnGm/CEqUdYVLqBfAzrs64OuPqEK6+69s4jvEiwYHBOgRjtCE6TStjgON2WnrxKVjb6m7PoeeN4hlrZ6wdwFod0QJcrvFttNTWlw5zOY3psD00XnQPjcNwdKP4VGLweO5v/iojaUxXAT11PByucm1dHa9KbVw9fMDUPDAjWCJDQeJyQFlbPVKnTObBgv0s4kL3NH3JikpxRl6Q2+u7Kfkvc7BgSx/Vcv0S2op+MXox6pWKpAckjm8mJHgYarDTF1qxCPBesYH4FME13llZSCsj3PIO2UJ4EmAGzLjCRKxro9HnpePfgYhGzS8v24r55fepTzr2tNvNO/T1IyvKgMjuI86B66lRezG0Kcn1pc7o8H3LhnpzY9F5+A2v1LP1C/J66X7zphqeQUfrh8rRzgPibBWC1n2ow89qj6hM+4g19b4f+64fdDR4to+tm4lvEakuikr5OaHmZCFcTlgnl6msbPMiJUUKeOcRr9qQtWSvwgr5rbnGejbAOgxgacfDXLi8SgapLoZpYFv/n0idDAsm1LBRYYeX49fv3lyNL15NLq/f3F1fPBuMBu4x3P4ifAumOnb4O5n+y59dv1ebCfk3v/rQVKuDRzcsJRMKE+99XjWtZUZ7Wwtts4rP8KFBzOhqhcreGVnX+LG/MaLx7H7TT/CvOqI5MB7Kg37EAqaXwZ+LKdqD5LLy97e7ryd11HKM0xRK9yTtfadd3ry9myL6mu94FJojj2EL/P4HW9CYvqfvKcVvoKAED2z/+YpKpuaVr3ca5OK/PwFbwShQ +api: eJztW1tz2zYW/isYPO1OaUlp0zbLN8V2drVtHNdWug+KZwIRhxJqEGAA0LJGw//eOQApURJ1STadTqfMjCe2AJz7dz4QhFbUsZml8YReQSKs0IoY+FQIAxkoZ+lDRHUOhjmh1YjTmKZC8XrqXXNmRDnYxIgcp9KY3gMzyZyk2hDeJppMmQVOtCIz8QSKJEY4MIL1PigaUZwJ1r3WfEnjFa0WchqnTFqIaKKVA+VwjOW5FIm3sP+bRd0rapM5ZMyPSvkupfFkRd0yBxpTPf0NEkcjmhv0zAmwfoU2XtqOE9o4kgqQfGMfjWpRzBi2pBEVDjL7Ocq8xH1t4zlUypwmaBCZLhvqrDNCzWgZUW04mPb1fogIRRZzkczXgtwciAHJHPCgAuWCKjJM/fD+kkb06vr+EvPNIWWFdDSuPnfCSahi8Q6lX+OysowaWZlULj00pvv8/1KAWeLKu5BQWj7gypzNYN/+WzYTyidyK9pnR9XorD0oQnF4JjolPlM+KI4ZR6y3UagZwbWNUAvlYAaGRjTVJmMufPTdtxh8KTLRUiqoJ2PPIisyoopsCmZLoQFXGIWJ0QpIVd5nagxmDlPXlvTR2qUAOIbTeuRSm5BvP4bp/yiZdZiKX5kswH4kVfSWaCcjuYEnoQtbyzFgc60sHKv37XyUa1NfQ6pNS4J3bZ36ea3GpsL80daWrcV6y2awKdaoxceWRYcX7ENftqYRy2fdJzmkQgkPhMq/sMxuw2FbQmsD317fiM4B83hLa/8Jlo3wtRfqDy/3CAA9YtaKmQJOHmEZVS2JJc4SZgkjhRKfCiCCg3IiFWA8W7i5sO2U0UMwKJZBw5yqKbYpv3p7Q3A2VoxrhndP5hMYKwJznILjUS8rOacVtoV5xE+75Sq3RlendThQTLlzpKIPYfYZghsAaNsHvPGFtt3tj81vA1EZyCUg2pflt4PBCci0Fb0BW0gXNhRnbxh28XEu+5ykNKFCKeHvbKqLQMpbph7F9xeIOm6x047JUd0dd2KLYxV7ZcwFkkQlLduggx2hjOhOG29Pot+hPPkJdfX5dV4/UmbYvaBbxILrkfcWQpuoxj42aedjtYdCnlAElC3Q9n3GPYPNthnzbONx2efa7tn9q5l+jNoCrHaguQXD9YzdihEHisVvfaoiOdA3zrX9cP2/ZhbIxh7PFW0dBSv6dPH/rWlk/Bk0YsDqwiRwc3bAmsGqV/sNdv1McpDgyYJZkjNjgf+JFIYFhMXWAoDT26Mj9n31zdAZfmz3gpMEXCO/jLZY8knxXsKyQnHWY7noPcLS9sJDzjf7DMohN5DgoyaNnSlgH4odp3ac2nHqH8ipnwPBjmU7lv2rseyfewhxhmc3nhx/gqX9IgbeWn4GF4d8tXBxx7wd83bM2z3Ndjzb8ezf92kWV708dIRcEc0nXENSJiTwHnmrDUbcMSEtYcZD9Ulw4I0m6KWTqebLo0fMudFTCVnrg3LTliG5DTMrvSRgHeMZJk6D9sndm0vyr5ff//jwj7lzuY37/cVi0TNpcgFcOG162sz6Jk3wB+f9s0fGczDY1ZZkCoRx7t8tMdlsQDaHRKQiqd/AVWYTrITg3wn+9aP7lbNuFYURe4U0JO/vRnWVLGtW3lJNm2+k/fYgnkqmHummEk6V65DYIsuYWdZQ2laAry0dc4X90lb3n/H4lgQRJNEcNrVeKUInMqHw3TCNXw4GEa3eFNP4h8HAtz7M+BmeKALPuWTVzmnHHaFItqlb75hQ1jGVfK3MaCNmYlfvNnarIr4KHtXYe9GOvWozQCRLHi3uOwQnrHBz1JrUNwHAG8Gk590OZB3IOpC1g+y7/Xp/o81UcA7Kl+cab8ISpR1hUuoF8A5XHa46XB3C1fdtG8chHls4MFiHYIw2RCdJYQxw3ApLLz4Ba2vd9VNvt1HssNZh7QDWyohm4OYa7xnn2vrSYW5OY9qvHxovmg+N/fDoRvHaocFjBn/OUhhJY7oK6Cnjfn8119aV8SrXxpX9J0zNEzOCTWUoSBwOKKurR+qEyXmwYD+LONA8FbgMp7HkFbm7vh+TfzMHC7b0Uc3Xt4pr0a8GrwatUnHqAYnD2xEJHoYabPSFWiwCvFVsmHyO4BIPCCwkhRFueY/LQnimwAyYYYGJWNdGpc9Lx7/DJBpVv7ypK+a//xv7pGNPu9vc6b5+ZlkeENm8EHngOGJQ3/rblOT6cGpw+NxoM3tz8tK4RB1ufE/Wt7HXQw+b+8nhSvFgfel3sHMZd7IKQWteesXPSo+oVPuIVfW+H/umH3TQe7GPrduRbxGJzrJCeZ5QM7IQbk5YI5eJLGx1u1OKBPDMY30muFb7cxghv1bHcS96WIcBLDU9zISbF9NeorN+9Yph/f9U6mk/Y0L1KxW2fzl8+/7manjx8+jy+ub++uJFb9Bzz+GsGeGbMdWww5/JtB/+7Pq92jDk//k1gqpaHTy7fi6ZUJh47/Oqai0T2tpaaJ1VvNIeGsSErlao7L2RZYkf+xMjGk8eNv0E/yojOgfGQ3nQRyxgehn8uRijPThdFv70ePcmYhnVK4ZJArk7Oveh0S5v392PEX3V9yUyzXGNYQv8LgVb0Jh+oB8oxW9zoAQPbP/5ikqmZoWvdxrk4r/fAZofoZU= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -60,7 +60,23 @@ Pagination information about the search results. The matching decision requirements. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching decision requirements. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching decision requirements. + +
    • Array [
    • ]
    The search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx index b0b45006c16..4b02b0715cb 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx @@ -5,7 +5,7 @@ description: "Search for flow node instances based on given criteria." sidebar_label: "Query flow node instances" hide_title: true hide_table_of_contents: true -api: eJztWu1z2jga/1c0+nQ35wDd7e72+OaAs/WVEIohvZ00kwpbYG1tyZXkEIbhf795JNsYMAlpczd3c+lMJ1gvz4ueF/30SGusyULh7g2+SMQScRFRxLjShIcU3zpYZFQSzQT3I9zFc8YjGDcUEfWLUQo7OKIqlCyDcbiLA0pkGKO5kGh+QFShGVE0QoKjBbunHIWSaSoZaX3m2MGSfsup0uciWuHu2nwySSPcnZNEUQeHgmvKNfSRLEtYaIRr/6mA8xqrMKYpgV+7Ih0qh5SVsmCIHUyS5GqOuzdrrFcZxV0sZn/SEHoyCcugGVWGh5D6kEMgpEZzRpNoqxF2SlJESrLCDmaapobIqcwMxUNuk5gWzLRAIBCarWrslJaML/DGwUJGVDbPN12IcbSMWRhXhHRMkaQJ0TSyLIAu5XkKTuIGPezgvhf0wDkiOid5onG3aNdMJ7RYiyug7sG0zcap2fGmUOm2NtxY4mNO5QpmjguLbG5hZkYW9FD+EVkwbky/s9onr6oUafOiMB7RByTmyFjKLIomUhfewvgCwdzaUjOu6YJK7OC5kCnRtunnn2DxE5ayBlcBPil5YGmeIp6nMyp3GEqqc8nBMILT0j9P5GjFdOe6yeh+pZJ1fQLDWqgnpLW36QPzf0mI0mCKa5LkVH1BxeqtQE6CMknvmcjVNoRUJriij/n7rj02lajndC5kg4H3ZZ2ZcY3Czpn8d0u7aXTWEVnQrbM6DTo2TDo+4TD0k0Yzmtg/ms/sLLUbDU8mQzurtiTHZNpL/h/oqrZeW888lJgoxRacRugrXTlFyiGhVogoRFDO2becIhZRrtmcUWl2Dx0z1aBqa8/1f30Lrp9JEVKlni9ZMXG7GF/pCsQVITNJ0PjZ8wXp0znjDPg8X5SomvviwvhHdpMG1n7/dM4HG4/SRDfEdQDNEJgNHkwK7jRCimoYdG8i+pB+bUPqTfxrDzu4d3U5GngTr48dPPHGl/7QhY/bTTn3QOlVtifI9/CfDoOR1/MvfMN4NL7qeUGAHRxMz++2X961N5zc7bYFE3c8uTM92MH+EIT2+r478e567qT3vrlr8n589anqOr+aDvvu+I+qwRv2q9+BN772e97dxA0+YAePvZ7nX1ef08Abl78v3eHUHZRfxR/vn73BNIAZv7sT75P7hxHlsG3kjt3BwBvUmqy6527g9Wutgfdx6g173t3F4OoTcJ0OJv6dPwwmLrSeX/VhVM8dDO6MVf0JfJ9PA3/oBcHdeDqohA96Y380qb5A61Kt4Yfh1aehsXuVrKJa+FUWfCyp+v3H80+N+JCk9LnkOUktkZgon4cm69VozIRIKOGHuDoWS4WWMdUxPSociiGhAnywdCssp4VhWbafnpQgAwE+KQmyeQE9ty0KaZkfyUCacsL1sbRje5Hfb0gitQ10/9BxYfarXaR4bGzT5ruxoNQiAbOz/dTpPHerlVTlibbnlpPPJadC1CdxL+N2reE3mYncIvcd0R5FAd9B6nGJtdAk8UsItbeQ0FdA3JRoi6SBScNZqRnfWmfaw3rNFjPHGJu6wXG1OStJpQ1/wNX2iANqQaJvoamiNpyKvi91bPql8HYAkxxRrnKQ/RCWnwB5d2H1ycLDtOfKbo4ALyb6Y/jXxtBeDO7EXDXiKQ9iR5zHnJcKp2moKJyuyf88nH1p9HpCyB2Dsy+PXr9HmP8gnJW63whpoRV2Zd64VcA8GjVByEq7iGh6pllKgRHl0XewASVV/Bw+u+DoR8BQw2rtg6OnwNCzGbxC+v9PSP9fdKrcw+4vANVbyJ8bII1IokS95wNdAcjOpLhn0U6Ul2eFQ2S/V08rsfpeRl4yHf9gTj4R4JdoptL2WYAfcOUuEHkU5peQw8x4ewzaH78V+AZk0JywhEYtdCkkRRHVhCUKEUkrQ9QAmWGIZiJaPXogyKSYJTT921MXFi4a2ZEFX2QRjPVmGDiz3G/GFz3097e//Hb7l1jrTHXb7eVy2ZLz8IxGTAvZEnLRlvMQ/sO4v7bQJKYSENUKzSgiUWS2R5KgLTZCKqMhm7OwLLIWYiMwmNXvibNAkZ+P7kW5ZAe4ykXTsV+CplV5QthhjeuXDuao0p0lhH/FW8d46ijuIpWnKZGr0iF3GRRJJleNQHCv4t6EDN9PJiNkSaAQfKva2wpGoETKOJT/cfdtp+Pg4jIAd3/tdDZAEyx+giYc0YcsIcUpbk8dxlG69dvi7F9c7L2MZYRkC7bPt7UTxoUT961GZTi+aQ7H4mCCEhJ+VZClWYRIrmPgGpaXPdQIQRKTv1+D7DXIXoOsOch+brgFF3LGoohy455VvDGFuNCIJIlYWnDxGlevcfUaV01x9UsTlnQBqWsqwQ+plEIiEYa5lICvY5ZU1YiSd1mBewWKr7H2GmtHYm3j4JTqWMC7s0yYF1oZ0THu4jYcVeHYdlaVgNv23IbhWYm8p1KZC49cJriL1zZ0Nt12ex0LpTfddSak3rTvwS73RDIyS6w3QrcNsdJ1EhGSJLbsD00IHaZ+VajWI2nOI4LeobEXTNDvRNMlWZklzapXYyXpd513neZXAHAF0EzRHfnIamgdsJYUSrIQ3Y1k7eBTCG+gVK9omEumVwFMs8szo0RS6eZghcoxCn6GuqlImEHYKX5clO7yj08TY3FIaOPtKz/vgaSZDcftg5fGunynuSjeOVaibuowrxgrVy6qSdtyT6HSbgWwXimthcFOiXPbvlMWgmLOXmGmUy+Y1AvMxj9uqhd/Vdft9g2cfbbWqR6WdfYefN2sreHqD6ugbWNCei6M1YqAO7Q/BAOVyjpMp/XmMLhHvslRoUjTnJuNii9sBYnU/ClMclU8JkpYSKEO011jbtepHDawPejackRvWhALNmDL/WnBdJzPWqFI26GdVv2dJWLWTgnj7YKFavfcS6icng38njcMvLM3rU5LP9iLN8gfKeE1OT7aAs/hZdK+1uvtBv1DD1sL19L0QbezhDBTsjP6rou8doMP8xouzQnvJW12usHrNXCaymSzgWZTq8Ldm9ttMoMvKFFSElm/wF/B93DPqnIGhXKT+5Lc3Jrt31hvnHKGG4Y004+Ova0l6tFVAHXqWfF8NxURzJFkCU97yRJ38Wf8GWN4VwwUTFYx7WucEL7IjaNjSxf+/Qtj90nf +api: eJztXP9z2jgW/1c0+ulujgDd7e72+M0BZ+srJRRDejtpJhW2AG1tyZXkEIbhf795km0MGEK66V1nzp3pxNa396T3RZ/3hLzGmswV7tziq0gsERchRYwrTXhA8V0Di4RKopngXog7eMZ4CO0GIqRe1krhBg6pCiRLoB3uYJ8SGSzQTEg0OxhUoSlRNESCozl7oBwFkmkqGWl+4riBJf2aUqUvRbjCnbV5ZZKGuDMjkaINHAiuKddQR5IkYoFhrvWnAsprrIIFjQk87bJ0ODmkLJcZQdzAJIquZ7hzu8Z6lVDcwWL6Jw2gJpGwDJpRZWgIqQ8p+EJqNGM0Crczwo18KCIlWeEGZprGZpBziZkRD6mNFzQjpgUChtB0VSKntGR8jjcNLGRIZXV/U4UYR8sFCxbFQHpBkaQR0TS0JGBcytMYlMTxu7iBe67fBeUI6YykkcadrFwzHdFsLa5hdBe6bTaNkhxvsyndlZobSXxIqVxBz1Emkc0d9EzInB7yPyRzxo3od1b77FWVIq5eFMZD+ojEDBlJmUXRROpMWxifI+hbWmrGNZ1TiRt4JmRMtC36+SdY/IjFrEJVgE5MHlmcxoin8ZTKHYKS6lRyEIzgNNfPMylaNp2ZrhK6V0zJqj6BZk3UFdLK29SB+D9HRGkQxQ2JUqo+o2z1VsAnQYmkD0ykamtCKhFc0VP6viuPTcHqJZ0JWSHgfV6npl0lszMmvze3m0plHZI53Spro2KOFZ2Odzg0/ahSjMb2j/oz20vtWsOTztD2Ki3JMZ72nP87uiqt11YzDzkmSrE5pyH6QleNzOWQQCtEFCIo5exrShELKddsxqg0u4deMFUx1eae6v/6GlQ/kSKgSj2fs6zjdjG+0BWwKwJmnKDRs+cz0qMzxhnQeT4rYdH3xZnxjuwmFaS93vmUDzYepYmusGsfisEwKzSYZNRpiBTV0OjBWPTh+KUNqTv2blzcwN3r98O+O3Z7uIHH7ui9N3Dg5W6T9z2Y9CrZY+Rb6E8G/tDteleeITwcXXdd38cN7E8u77dv7o07GN/vlvljZzS+NzW4gb0BMO32PGfs3nedcfdtddX47ej6Y1F1eT0Z9JzRH0WBO+gVz747uvG67v3Y8d/hBh65Xde7KV4nvjvKn987g4nTz9+yP+6/u/2JDz1+d8buR+cPw8ph2dAZOf2+2y8V2eleOr7bK5X67oeJO+i691f9649AddIfe/fewB87UHp53YNWXaffvzdS9cbwfjnxvYHr+/ejSb9g3u+OvOG4eINZ59MavBtcfxwYuRfOKiyZXyHBU07V6532P6XBBySmzx2ek9gOsiDK44HxeqUxpkJElPBDXL0QS4WWC6oX9ChzaAEOFeCDHbfAcloYknn5+U4JPBDgk3xANsug57ZEIS3TIx5IU064PuZ2bC3yehVOpLSB7gcdV2a/2kWKx9pWbb4bC0otEjA720/t9nO3WklVGmkbt5wdl+zvr+dC1idxMON27eGZTEVqkfwOqydRwTcMdZpjLTSJvBxS7S0s1GWQNybaImsgUhE7VeNdq1x72K9agiassa4cFFmb2EkqbegDzrYhD0wLHH8TTRS15pXVfS5j1c+Z9gO45IhylQLvhzD9DAi8C7PPZh66PZd3ExK8GOun8LC1qT2b3LHBosW+xrAjymLipUxJKjIK53N+XPsviaJoy41x//uOBHT5abX/XyIuqXuVqAtKYePgld4M+tGwCuUUBhcSTS80iykQojz8BjIwSbV4Dp3d/fuv7NcVq7W/fz+1Xz+bQI06/z9R5w8U+OzByxdAk03kzQzWQyRSolzzjq4AByZSPLBwx8pzOHs+Fsw3uoLqs7AhuGlw5xUbzOn0xQns/qLZi6PJipfOTRz4pGOpiZfPRByQ3os79rJ9eSSxR2PJ9OIZVJ5Qil3gcjJMyCHKprED5x942AxInPKQNEnCml/oSjVtCvcfVUcQiaQBTAR3wGYOkUMN/mvwX4P/7wb+n2OAdThQhwN1OFCHA3U4UIcDP+xp5ncKEE6BrP96yHCKme8ZRByn+4RyDQz+f0dX6tkBxk7XM0INq+4VoUYdWNSBRR1Y1KcKdRhRhxF1GFGHEXUY8cOEEfWpQn2qsH+qAD1eH/vB0fG7Cl9hGDQjLKJhE70XkqKQasIihYikhZWUAJwhiKYiXJ38mVIixTSiceUZRpk9Bw1ty4wusmjFuhpoOLXUb0dXXfTP17/8dve3hdaJ6rRay+WyKWfBBQ2ZFrIp5LwlZwH8h3Z/b6LxgkpAZCs0pYiEoVEPEpXhk0powGYsyH/6nbGNQGB2fk/EDtnmeRQopJIdGKqDJiMvt8JVHlHskMblqxAmtOlMI8K/4K1iPOUOHKTSOCZylXupXQLZDpCW0efRewBVrubteDxEdggUgG4VviQjBJOIGYdLCbjzut1u4OyKAu782m5vYEyQ+Bkz4Yg+JhHJor696TCO4q3eZr9IzK4bvYxkhGRztk+3uWPGmRL37Ixyc3xVbY5ZIIMiEnxRsIWyEJFUL4BqkF9BoYYJEpnNtTay2shqI6s2sp8P9f1KyCkLQ8qNehb2xhTiQiMSRWJpkV9tV7Vd1XZVZVe/VGFJB8IoTSXoIZVSSCSCIJUSEPCCRQUaz2nnGbsaKNa2VtvaEVvbNHBM9ULAbfhEmHvjCdEL3MEtCCYhbLsoUsgtG7dhuOwqH6hUJkWcygh38NqazqbTaq0XQulNZ50IqTetB5DLA5GMTCOrjVBtTSxXnUgEJFpY8ocihAqTXMym1rXHSOgNGrn+GP1ONF2Slc0YFHfZ86HftN+0q+8mwpFB9YjO0EN2hlYBS04hHxasu3JY2/icgTeQeVE0SCXTKx+62eWZUiKpdFKQQqEYGT0zukkXmUa4kT1c5eryr49jI3FwaKPttwfcRxIn1hy313Ar8zzt6rRL+1hapKrCfFuhUOUs1bfNxWVT2k3PltPYJTPYyT9vy3dydvanUDupk3Y5i1bO/hv9uC2+Q1BU3W1v5tvL9O3iunt77xr67doKrnzdG8o2xqRnwkgtM7hD+YMxUKmswrSbrw6Ne+gZHxWIOE652aj43OZ4SEmfgihV2RXniAUU8jCdNeZ2nfJmfVuDbixF9KoJtmANNt+f5kwv0mkzEHErO58t/k4jMW3FhPFWRkK1us57SGtf9L2uO/Ddi1fNdlM/2oM68B8x4SU+PtgEz+Fh1P6s19sN+i99biNTLU0fdSuJCDP5VDPfdebXbvGhX8O5OOErDtY73eL1GihNZLTZQLHJVeHO7d3WmcEb5I8pCa1e4C+ge7hrp3IBpxjG90WpOXXbv0e3aeQ9nCCgiT7Z9q7kqIfXPhwiTLOPisQihD6SLOGDI2SJO/gT/oQxfO0ERjBexZSvcUT4PDWKju248O8/q8m8IQ== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -60,7 +60,23 @@ Pagination information about the search results. The matching flow node instances. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching flow node instances. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching flow node instances. + +
    • Array [
    • ]
    The Flow node instance search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx index b5bdd44a810..b257ec82095 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx @@ -5,7 +5,7 @@ description: "Search for incidents based on given criteria." sidebar_label: "Query incidents" hide_title: true hide_table_of_contents: true -api: eJztWm1z2rgW/isafbp3rgMkze52/Y2C0/VuAiyQbGfTDCvsA6i1JSrJSRiG/37nSLYx4CR02/1w56YzmYJezjk6r48OWlPD5pr6tzQUEY9BGHrnUbkExQyXIoypT2dcxMWsph6NQUeKL3Ge+nQETEULMpOK8GIRmTINMZGCzPk9CBIpbkBx1vgoqEcVfMlAm3cyXlF/bb9yBTH1ZyzR4NFICoOC+GvKlsuER1aU5ieN/NZURwtImZ1Nkv6M+rdralZLoD6V008QGerRpcIjGA7a7pDKUtsTXCpDZhySeCsf9QpSTCm2oh7lBlL9NcwsxUNu4wXkzIwkKBCZrirstFFczOnGo1LFoOr32ynCBXlY8GhREjILIAoSZiB2LJAuiCxFs7ZHHerRbjDqoGFjmLEsMdTPxw03CeS66CP1ALdtNl7FKrf5ke4qy63Nf89ArXDn0BmUbu5w55LN4VD+AZtzYQ25o+2jtapkWq8ULmJ4JHJGrKWsUgxThmgrIxdzgnsrqubCwBwU9ehMqpQZN/TmDJWf8JTXuArySdkjT7OUiCydgtphqMBkSqBhpEBTWG0cydGJ2Z6ZOqOH5ZFckDFc1iAdqZy97Rya/6+EaYOmuGFJBvovkmtvhXIyslRwz2WmCzoK9FIKDc/5+649NqWo72AmVY2B92Wd2nW1ws64+qel3dQ664DNYeusXs0ZazY9veEw9JNaMzo3dbmxOJRbq3djYE+jtVsqWnhCjILVb7CqqKbeCX88P0joKC3Tms8FxOQzrLw83bDIaMI0YSQT/EsGxDLhMw7KZn+z4Lo8ZgN9e6lkBFp3YcYFR+rfIFFOi8QlMZQNBZURt6nPeteLIoRxRYI86x7JL+weyy4U2jARwXc4L89JHXVaUEqqseX20hlL57J7CC4mD9wsCHNHhphoMBiQ9zZIqzXlujcaBJ3wIgy61KPXvd96/T961KNhf3LVHgzC3vtJMBz2h9Sjv/bfTXr9yTAYD8NgRD3a6fe64Tjs98olwYfxsN0ZT27al9dBOdppX14G3UlwGVwFvXE5fN37pd3r2hkcmQQ3QW9MPXoVjEbt98FkFP4ZTIIPnSDoWuFyMt2gE46qTLcDyLa9I9BFf3g16fXHk4v+da9L7wrFXoHWeW17XreBVWnqlufR41ZMMQsuIFc6FySVCkgMhvHEWnCWyIeejOFYN8X1RMgYjvHOkvi3u+eW71c5aKTAYoAxT4/QY5cZsIW28NVie6MqZMwMnBgkiDXKMHME5ZHJSe+IeHQAtDvj8CZAtwvfD9tj62nDYNS/vLEfB0GvG/beW8/5JKffoOZPcupSMJ8ReOTaaK+qYyvvoZYNCCZM+AQKdbPoL/b8UNl7AEcrFbFIGBe2Cu1Cvv01ddVz41ClK+W2Tp21WsfVSgU6S4y7PHz3y8GLcJULZyj8zKYyc4B7R7Rny/jfIPW8xEYaloQF8tlTH87lyDRlxgFgZFJzxXnSEzFV7EK0ejvZ24eLjsKX7D7LH7Obu5ngsTCWGuRaQ+GuDglWIeVf+f0IMaAgIHSGsh+i6SOQ6i4aPlp43Pa1slvk/t1Efw62usjZi7idSCtXvIgQn3Aee83Jnaa8zB8v/ysQfQWi/zNANPgQdK4t7rsMR+OgFwxfgeorUH0FqjVq/i64tA5l/KNAFRHSbkmthadF0bQrz4+FpF9wM5kxnkDcIFfb4NCEKZs073kMcQVIWDZkKuMVAlnL67SeV44bSMKizxqNymPCMrPAIhcVLVSwNY8l1txPgOKlktME0v8cguNdpm0ycCvzMxBXz7HGFtnAnuR2eNEhP5//8NPdvxbGLLXfbD48PDTULDqBmBupGlLNm2oW4R+u+3eDjBegEFWsyBQIi2NbwVhCtkiB6CVEfMajoj+Yi21LgQP9L+DhJ+pM6W+Z4gde3CbXw7BADqsCJe+wptV+uYXr/jRh4jPdutRL4dsmOktTplaFC+8yyPNApl/Mbm/OauPwl/F4QBwJEmGSK/FPzggPkXKBnWvqn7daHs372NT/sdXaIE20+BEnEQQelwnLbzJ7x6kpEEW6/U6WkYrP+T7fxk7g507cdScqAvrNob9fSDXlcQzCumcZb1wTIQ1hSSIfIH6Nq9e4eo2rp+Lqh7pC2cYOhwGFfuiAo4yiTClEBAuelHeJgndxQX6usfMaa6+x9n8daxuPpmAWEl9iLKW2rsPMgvq0WbZomg6VUvyNVt2D0rYNmamE+nTtImbjN5vrhdRm46+XUplN8x7Ncc8UZ9PEOSFOu8gqPCaREUsWjuuh5XBCsBSKE3VYmomYkbdkGIzG5D0z8MBWrh9RPsEoSL9tvW3VNxywMVdPsT0IiTuh87tKLijIYlDXknWLjyG8wQaahihT3KxGuM2pZwpMgWpnqPzSH3J+ljp+d4uol3+4KLzk1z/G1tCYx4bbBzDBI0uXLgq3vx7v9M1aT7Wv6ibse53SReuaQK2d5sxeB2W3e1Dx9cplv2Z0j/7u3Zmetc7OT07PTk7fjE/f+Kc/++dnjfOfzv6k5SV4e00tLqGt6t2w8jjGveS5LV/ZlFN323cn7qlIq3zM0dp7ZHG7dvatPmbAsY0N+Jm0xs3D8dBNMGZAaedXrcbpYegPQpvBIpmmmbBlTMyLC/uWXpRkOv81P+ER4BXUX1OMpgrbSzdDbhxHctrAkHFxXVSvOTeLbNqIZNqM3Lby/2kip82UcdHMWehmp3113eu2Ty7DTtAbBSenjVbDPLquOWaXlImKHPaKvO0E7591vS3af+MZWB5ABh5Nc5kwbi/F9mzrPMPd0irrPMfdeXmeuqXrNTK4Vslmg8P2Tk7927ttWsNvG48ugMXO9PQzuhftOLlPbBTg8iSz/e39X5Q2XrGjHUWwNM+uvatk6kF/hN2+af7GLZUx7lHsAd+/sQfq04/0I6X41A4p2Pxix9c0YWKeuQB0dPHffwGu8aAk +api: eJztW/9z2rgS/1c0+um9eQ6QXnvX828UnJ6vCeSA5DqXZlJhL6DWtqgkJ2EY/vc3K9nGgEmcNnd9b0pnMgVL2l1pv312sZZUs6mi7hX1k4CHkGh67VAxB8k0F4kfUpdOeBLmo4o6NAQVSD7HcerSITAZzMhESMLzSWTMFIREJGTKbyEhgeQaJGeNDwl1qIQvKSj9RoQL6i7NVy4hpO6ERQocGohEoyDukrL5POKBEaX5SSG/JVXBDGJmRqOoP6Hu1ZLqxRyoS8X4EwSaOnQucQuagzIrhDTUtgQXUpMJhyhcy0ednBSTki2oQ7mGWD2FmaG4y200g4yZFgQFIuNFiZ3SkidTunKokCHI6vVmiPCE3M14MCsI6RkQCRHTEFoWSBeSNEa1tocd6tCuN+ygYkOYsDTS1M2ea64jyM6ij9Q9XLZaOSWtXGVbui5NNzr/IwW5wJUDq1C6usaVczaFXfnP2ZQnRpEbp137VKWIqw+FJyHcEzEhRlPmUDSTmigjI0+mBNeWjponGqYgqUMnQsZM20c/vcDDj3jMK0wF+cTsnsdpTJI0HoPcYChBpzJBxYgEVWFOoyZHK2Z7oquU7hdbsk7GcFqDdIS0+jZjqP6PEVMaVXHJohTUR5Kd3gLlZGQu4ZaLVOV0JKi5SBQ8ZO+b+lgVor6BiZAVCt6WdWzmVQo74fLvlnZVaaznbAprY3Uq9lixaP+CXdePKtVozdTGxnxTdq7a9IGtE61cUjqFPWLkrN7BonQ01Ub488udgI7SMqX4NIGQfIaFk4UbFmhFmCKMpAn/kgIxTPiEgzTRX8+4KrbZQNueSxGAUl2Y8IQj9W+QKKNFwoIYyoaCioCb0Ges61ER/LAkQRZ1a/Lzu3XZ+YnSLAngGfbLM1K1dgtSCjky3B7bY2FcZg3ByeSO6xlhdssQEgUaHfLWOGk5p1z0hudexz/xvS516EXvXa//Z4861O/fnLXPz/3e2xtvMOgPqEN/77+56fVvBt5o4HtD6tBOv9f1R36/V0zx3o8G7c7o5rJ9euEVTzvt01Ove+Odemdeb1Q8vuj91u51zQg+ufEuvd6IOvTMGw7bb72bof+Xd+O973he1wiXkel6HX9YZrp+gGzbGwKd9AdnN73+6Oakf9Hr0uv8YM9AqSy3PXy2njnS2E7PvMfOGGMUnEF26DwhsZBAQtCMR0aDk0jc9UQIdc0U55NEhFDHOgvi326ea75PMtBAgsEAIx7XOMcu02ASbW6r+fJGWciQaTjSSBBzlGa6BuWhzkhviFjbAdqdkX/podn5bwftkbG0gTfsn16aj+der+v33hrL+STG33DMn8TYhmA+IXDPlVZO+YyNvLunrCFhifb3oFA7ivZi9g+ltTtwtJQR84BxYrLQJuTbnlOVPVcWVdpUbvLUi1arXq6UoNJI2+KhdnGwnSPrIs1H4StPrOLwMxuL1ALwDVEfTOtfQephibXQLPJzJLR1nDiWIdWYaQuIkUlFybPXMjF0bEK2ar2ZasR6S25bZp3hj9HOViq4LfStBrlQkJuvRYZliPkxq5cQEyYEEpWi7LvougZy3UTHtYXHZU+V3SD5ZxP9IRhrPWnLAzc8r5ixgxD3GIspczIjKYr5+vLut/k3TAFZy2DwYh4s0HIfN/J/GMj9HyAp773XuTDA5dQfjryeNzggrf8VpPXj4Zy/FXNgiMAQUhXKKovdB/T4j5S2T4tHTyhkq6F7DXZPgukPFwq1nORJ/HZA8gMsvgYS7zGpzQRbCV7zFLpyNuDmbRI2AhanScgabM4bn2GhGrYz+J9dKBrCXEKA4lFXyxR2c90BnB7A6QGcPjM4fYrbHeDqAa4e4OoBrn4fuPpD/zbzvX4s+f7d8Ad6w8+Ce3ex0h5j7Rnk+g4WqjYk3lhSAxxbd6kAxwcofIDCByh86NMegO8B+B6A7w8GfA992kOf9nn7tDjzZd0XC77gYjJhPIKwQc7WkUcRJo1ObnkIYQlWGDZkLMIFvo5geB1X88pQBIlY8Fmhz/KQsFTP0GCD/EVYMPbLIuPNe15tmEsxjiCu7CuXmbbJuZ2Z7YHYDI3+kodas5OrwUmH/Pry1S/X/5ppPVdus3l3d9eQk+AIQq6FbAg5bcpJgH84798NMpqBRMyxIGMgLAyNP7CoDBXUHAI+4UH+lmcmtsmz9tWNR9DxniRexNVU8h1Da5OLgZ9HgUWOmTdY0/Jbzwa8u+OIJZ/p2qQeM+c2UWkcM7nIo+ImgyzMp2WktfeV3ypX+W00OieWBAnQKYtYljHCTcQ8wfePqfuy1XJo9jYydX9utVZIEzVeYycJgft5xLK6Zms7Fdk3Dw/PpBkh+ZRv8910/MyIu3ZHuUP/tGvvJ0KOeRhCYsyz8DeuSCI0YVEk7iA8+NXBrw5+tc+vXlUlyjb2OzRItEOLykUQpFJi0p7xqIAqOe+8XH7o9byDrx187Yf2tZVDY9Azgffp5kIZ02F6Rl3aLBo4TYtKKd60kbcglWnQpDKiLl1aj1m5zeZyJpReucu5kHrVvEV13DLJ2TiyRojD1rNyi4lEwKKZ5bqrORxIWAz5jjq2dUtek4E3HJG3TMMdW9jiprhIl5N+3Xrdqq5nsE1XTbF97hO7Q2t3pViQk0WnriRrJ9chvMIaVEGQSq4XQ1xmj2cMTIJsp3j4hT1k/Ax1/G4nUSf7cJJbye9/joyiMY4N1tcYvXsWz60Xru8AbVS8rX2laNWAuXVZmGhVRdna6Hxttac2WzMlWy91UiqebtHfbI3QF60XL4+OXxwd/zo6fuW2fnFfthqt41d/0aLHse5C5GViq9xuKF1xtPcxr4q7ksXQ9fr2oL3w1yqu5LW2rspdLa1+y1fS8NnKOPxEGOVm7rhrJugzIJW1q1bjeNf1z30TwQIRx2li0lgyzfsxa3pBlKrsTlbEA8AS1F1S9KYS21M7Qi4tR3LcQJexfp1nrynXs3TcCETczH46Kf4fR2LcjBlPmhkL1ey0zy563fbRqd/xekPv6LjRauh720PH6BKzpCSHKZHXfeLtvS7XSfsrLvNmDqThXjfnEeOmKDZ7W2YR7oqWWWcx7trJ4tQVXS6RwYWMVit8bGpy6l5dr8Mafls5dAYstKqnn9G8aMfKfWS8AKdHqel+b98LWDn5inYQwFw/OPe6FKnP+0NspY6zm8qxCHGNZHd4i5ndUZd+oB8oxQvTSMHEF/N8SSOWTFPrgJYu/vsv00kpdA== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -57,7 +57,23 @@ Pagination information about the search results. The matching incidents. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching incidents. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching incidents. + +
    • Array [
    • ]
    The incident search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx index 20b97713c77..a9f16c87174 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx @@ -5,7 +5,7 @@ description: "Search for mapping rules based on given criteria." sidebar_label: "Query mappings" hide_title: true hide_table_of_contents: true -api: eJztWVFv2zYQ/isEnzbMsZ027Tq9uW6yZWvaLHG6BzdAKOlksaFIlaTiGIb++3CkZEu2nDpF9zQXCJqIx7vj3fd9osgltWxmaDClFyzPuZwRXQigtz2qctDMciXPYxrQhMu4sjC0R2MwkeY5DtOAXgPTUUoSpUnW8GJIyAzEREky4w8gSaS5Bc1Z/7OkParhawHGvlXxggZLGilpQVr8leW54JELPvhiMMSSmiiFjLlRIT4mNJguqV3kQAOqwi8QWdqjucakLQfjZijtvG3kqrQlCQcRr9OhvdoV05otaI9yC5l5TjDncTvaJIUqmFUEEyLhohHOWM3ljJY9qnQMunu+GyJcknnKo3TlyKZANAhmIfYh0C/IIsNmjq7HtEffnV6PsZUxJKwQlgbVc8utgKoWH9H7KU4rS98TriFGH35Jtw1z1+a/C9ALnHnl+0fLW5yZsxls53/JZly6RraqvXdVtcq6i8JlDI9EJcR1yhXFMm2JcTkiAnFuo9RcWpiBpj2aKJ0x6x+9fIHFFzzjHVDBOBl75FmREVlkIehWQA220BIboyS2wlVjz4g+zVFiu5p+vlqS5xVDsz4ZK+377caw/XeCGYut+MREAeaOVNVbYJ6M5BoeuCpM7UeDyZU08BTe2/0oV6m+hUTpjgZv5ho6u85kE67/62zLTrBeshmswdrrWGPHpN0TtqkvOtvo4ePlsFqTNzVtCrRnXXTNaNRgRxKRYDz7wDJolKVSl021xrycOZEsA2xPxizCbMa4NJYwYtU9yD7i1Nm5fu3n9wFNsZ92FaT2329VulrmmVteW0k2TLp60pYqqwtwDzxgXD1eDIdPdwRfUA2oFcJRd++X0GY39lW0b8okl14t8HcWqsILfSvRJ/HzHa6eztgqy8R5zbiNguJYpYiuyVhZ1/rtV2u3HL4+QZhtSEN359xbzwHM1Ahz81x8lGH/RsRlEQO2T24MEJtyU4/dNaXsrnovo/ZIAtIUDhVbKr6HQrZVeO/kcdpzc3dvjB+W+lNy6bm0QckWF1cWm4jhO8Di2FeBpLVP3D/nzVCVm79g0R3vHhYrNdLg9krNyHvC85ni6mR1WwPzH6qoeaeerruyU0mbJmWPnjxHKL9i50nCuIC4Ty6UBhKDZVwYwjTgC/2BxxA3AO1CkVDFC7/p3yGwuVahgOyXbaFtJzYil96yiks8LggzxBuGPvr06mxMfjt59evtT6m1uQkGg/l83tdJdAQxt0r3lZ4NdBLhD9r93CeTFDQue0FCICyOOcZkgqwRR0wOEU94VO9pqrQJttGv7xta6ka3276CXKH5FgpG5ObqnPAYpOXJolbYVmja3OM7qQ9CweQ9XYPgW1gbEVNkGdMrvrQD4EbQMls0Oblzg9uF4z8mk0viXZBIxeC+Fp3CVYFwERmXuNumwclw2KPV3psGr4fDEn1ix/dYiSTwmAtWvQU3lsMlyda4dQvDXQ+T0Y/qjNJ8xjfjttlagfidX1FNxONuIlbCTgSL7g3qAY8JK2yKUaP62wpcEkyYJ3YxB5IdSPa/J9nLbbyfKR3yOAbp4LniGzdEKkuYEGoO8YFXB14deLWLV6+6dpEj/AS1oBGHoLXSREVRoTXEeJQpnPsIjKlj118wh43igWsHru3gWtmjGdhU4aVMroyDDrMpDeig+mI7ct/UA//JRvEAVz+ANu6sqNCCBnTpWVMGg8EyVcaWwTJX2paDB2zJA9OchcIDEYc9u2rUCBUxkfrI293Dgeb375hlhYwZeUOuTq8n5HdmYc4Wrpr56n6mdv1m+GbY6RVNd3gcXZ4Tv0KPvYYe1G6R2J1uvfE+jks85TAQFZrbxTVO8+UJgWnQowIbsMJEFc95x7+9Ee1Vv5zVSPnzn4lrNmrZ1foy7PSRZbln4vpouXEEscZc8yyhcZfkL76mq0up1dDt+prG36wMV3cfw407ienSr7h59o/PSkeDRLnlViDdLhyiCLTxlR72j7cJcXnueB2pLCukE3c5I3NuU8IajYhEYarjb8EjwFOLYEmlL0Nt9t6PkE8+IjnuI4g80mtNn3GbFmE/Utkg8tNW/4dChYOMcTmoQpjBeHRx8+Hd6Oj9+fj0w/Xp0XF/2LeP/rAPOZcx2cjDHYfVxyVbl6ONi83vvCetUGXh0Q5ywbjEHrvlLSvqT2mL+rRuHF7eeQJP6XKJQW60KEt87E5yaDC9XfMd/yp7NAUWewTQezxWo2Of/9EE80Bzj7et8/GyV88YRRHk9knb24aMXX68niA7qovgTMU4R7M5XhKzOQ3oZ/qZUrySRg+OeO75kgomZ4WDNPV+8d+/CT6yoQ== +api: eJztWlFz2zYM/is8Pm03R3a3buv05qbplm1tsyTdHtLcFZJgiwtFaiQVx+fTf9+BlGzJllO3175s7l2vqQgCIPDho4RgxR3MLY9v+CsoS6HmzFQS+e2I6xINOKHVecZjPhMqayQsH/EMbWpEScs85lcIJs3ZTBtWdLRYloDFjGnF5uIeFUuNcGgERO8UH3GD/1Ro3XOdLXm84qlWDpWjH6EspUi98fHflkysuE1zLMCvSvlmxuObFXfLEnnMdfI3po6PeGnIaSfQ+h3aeG1bvmrj2EygzDbu8FGrCoyBJR9x4bCwH2PMa9y1dp1jY8xpRg6xZNkxZ50Ras7rEdcmQzO83y8xodgiF2m+VuRyZAYlOMyCCdKLqioomdOrUz7iL86uTimVGc6gko7HzXMnnMQmFm9I+xltq+uQE2EwIx3hSLcdcZ/mPyo0S9p5GfLH61vaWcIcd/2/gLlQPpG9aB8cVaOL4aAIleED0zPmM+WD4sA4Zr2PhEDa2wm1UA7naPiIz7QpwIVH331LwZeiEANQITsFPIiiKpiqigRNz6BBVxlFidGKUuGjcaDF4OZ05oaSfr4+UqgrILGInWoT8u3XKP3vJVhHqfgTZIX2PWuityQ/gZUG74WubKvHoC21svgY3vv5qNeuPseZNgMJ3vY18XKDzs6E+dLe1oNgvYA5bsA6GjjjwKb9G3ZLXw6mMcAn0GFzpiBq+yXQ3/VqaEcnBnucSCWI4jUU2AlLwy7bbE1+eXGmoEBKTwGOYDYHoaxjwJy+QxURTr2cz9dheu9JlPLp1kZa/V6fOthD71ujqIli1MtVE6iXPkB9LtoSGcpqn+ycqdA/CJDzEf12Mnk8p3TFdcBaSV/8B19j2/k8lBM/SLRCBb6hnyHRVbgqeo4+isBPUPW4x047kOdtzW4FlNYaTvUwoch68OxezsOE+sNTAtYWuQxnzt+bHqK2hZbf5+0TkYc7lY7FLLqIvbXIXC5su/a+S4bvm5ud2EsxVLbyqNi5Bw7g2D6PH+w8bftY3/2d89lcf4xwQy1tlWSvFtcS24gRe8Diq68BSe9N83CfDy+0j6TULmF1mK/8rDxafiEWpep8DoO5aLb9hsvhhNzhcu2oQf862k3NwNvusPk+moaou4VLPepR673KohSKSmUQQSmiO1zaKLyvfbNLuxmWBlNyM9D+LnkdifhIxEciPhLxf5eI99fvsEOvPZn+hkt7KEn3dhxA1yFyA3R9JOcjOR/J+UjO/x9y/mxvyST49GOaGP+QAjYDITGL2CttkGXoQEjLwCC16+5FhlmnjLwpluhsGVr6e5ofpdGJxGLwbbzr2JRdBMnGLguYY2BZEEyC9ZvLl6fsp6ff/3j7Ve5caePxeLFYRGaWnmAmnDaRNvOxmaX0l+S+jth1joaOvWQJMsgyQTZBsk0amS0xFTORth3Lxm1GiQnn+wCD+9VdwK15uDJiB39T9vbynIkMlROzZcvrPdO828H3F0ycSFB3fIOED6F8ymxVFGDWIOwboDavA1d1mWBv+3qogn65vr5gQQVLdYb+d0GeVxtDdIhCKOql8/jpZDLiTWedxz9MJjXppIwfcBLF8KGU0Ny9W8cRihUb3PqDUU8TVPq5MqONmIttu322aED8IpyoLcQnw4XYXCdMQnpnidFExqByOVlN29+coHcCpH2kw3gssmOR/e+L7LtdvL/UJhFZhsrDc11vwjKlHQMp9QKzY10d6+pYV/vq6vuht8gpffg6NIRDNEYbptO0MgYzGlSQXn2K1ra22++m44visdaOtban1uoRL9DlmkauSm09dMDlPObj5ovtxH/Jj8MnG6fxDHOPxvov9cpIHvNVqJo6Ho9XubaujlelNq4e31NK7sEISGQAIi2H6mpRI3UKMg+Wd7NHC92P5dPQx2PP2OXZ1TX7GRwuYOmjWa6nr1rVzybPJoNaSXSPxunFOQsnDNjr8EGrlgp7UG0QPkRxTd/zFtPKCLe8om0hPAmCQTOtKAFrTDT2vHb6fxDio+aHly1Sfv3r2iebuOxyM+p29gBFGSpxMzjSaaJsMNfthmyeqp4UxcQH+mY9grZeut0MZYU5qsl60mmyNYF0swoR6E760LPal8VM++M3oN0NJKEKjQ2Rn0RPdgvk4tzXeaqLolKe7NWcLYTLGXQSk8rKNsMuUqRIXYx41R64Ffs9rLA/g0X2JCJQBeS3HD8XLq+SKNXFuOk0r/9NpE7GBQg1bkzY8en01dvXL6Ynv5+fnr2+Ojt5Ek0i9xBajlSDBaiOH77L0rZPdkYhO2OMnzgV2aDM4YMblxKEohz7460aKrjhPSrgbeJoVC8U9A1frcjIWyPrmh77zg6Pb2439U//q0c8R8gCAvgd9a74afD/5Jr8IPGAv51ZlnrU7pimKZbuUdnbDq1dvLm6pmppxj4LndEeAwsaCYUFj/k7/o5zGkAlDb4Q/fMVl6DmlYc0D3rpz782b+We sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -45,7 +45,7 @@ Pagination criteria. Mapping search filter. -
    +
    The mapping rule search result. @@ -57,7 +57,23 @@ Pagination information about the search results. The matching mapping rules. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching mapping rules. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching mapping rules. + +
    • Array [
    • ]
    The mapping rule search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx index 579c38161f7..ab8bb55d51a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx @@ -5,7 +5,7 @@ description: "Search for process definitions based on given criteria." sidebar_label: "Query process definitions" hide_title: true hide_table_of_contents: true -api: eJztWm1v2zYQ/isEP22YYrsv2zp9c5N0817SLHG3D26AUtLJYkuRKknFMQz99+FIyZJt2XG2DhgwBwgSi/fKu+eOOnpFLZsbGs7otVYxGEMSSLnklitJ7wKqCtAMP0wSGtKUy6Smu1iTGRrQBEyseeG4QnoLTMcZSZUmxY5UQyJmICFKkjm/B0lizS1ozgbvJQ2ohs8lGPtaJUsartxHriGhYcqEgYDGSlqQFtdYUQgeO+uGHw1qXlETZ5AztyrE25SGsxW1ywJoSFX0EWJLA1po9MpyMI5DaSdtywWlLUk5iKS1jwaNKKY1W9KAcgu5eYoyJ3FX2zSDWplVBA0i0bKjzljN5ZxWAVU6Ad3P75YIl2SR8ThbC7IZEA2CWUi8CpQLsswx5uPbcxrQi8vbc4x1AikrhaVh/dxyK6Dei7co/RLZqiroRGVWu3TXIXfR/70EvUTOGx9QWt0hZ8HmsGv/NZtz6QK5sdtH76pWef+mcJnAA1EpcZFym2KZtsQ4G7mcE+TtbDWXFuagaUBTpXNm/aMXz3HzBc95T6qgnpw98LzMiSzzCPSGQg221BIDoySGwu3GkRq9mePU9gV9snbJw40h2YCcK+3j7dYw/B8EMxZD8QcTJZgPpN69JdrJSKHhnqvSNHI0mEJJA4fyfTMe1drU15Aq3RPgbVsjR9drbMr1v21t1Zus12wObbIGPT72MO1n2IW+6A0jps9ulWzc81xmEw1b4HmEubMze0wrtkv6L7DsN/QTLF1Ztxk3PVY/mtbfvcS0lizvyZErlgPG+HHZbT3UYFSpY7jqlXhTrxL5N0TfgzbcN5VNqX/4hePkHUJ3rWHK5vuVWDZ/quE70Zz0dJyepJlcPFWTBcmk7RM/dStPFtnB2M4x441L5s1uspe4D6GV71y+XLi8fz4aPRWPGkwprD+qfPGjyKPNkUufRfg/i1Tp2/uGaYdLxdNFHbbYKsvEpKmzWxuJa3UfzJn17RaV9ByoDlWLrYbQHzF31rl3BD7l8ECljXX6sfn6cxC6RQzYAXlnwCdmvfah28A+1Kcx7DiSgDQl2r7bu4/oi5u992jjke2ptrtzwhcz/VCT9BjaAuEG5tYUj2UQ35M87lBVJ03PS8Txnvw/m91xdp+63X+122FN3QTh4R7X4M2xvHx6X/uMYkjKuIBkQH5TGkgClnFhCNOO8Z4nkHSqkVNIIpUsD3bDQqtIQP7NblfcNG9Mrj1lrZd4+BKG1iJh5LXPbt6ckx9efvv93VeZtYUJh8PFYjHQaXwGCbdKD5SeD3Ua4y/SfT0g0ww0lpMliYCwJHGeM0HawkBMATFPedy8htRmEwyZ9++RRuhWV1sh7uCg1HxnTjIm724mhCcgLU+XTXvcUE27r+WuT4eRYPITbTNjV+m2FlPmOdPLprdsKsB3N8ts2S2de3G8LRuT6qfp9Jp4ESRWyWbtQUXoRM4lviDT8OVoFND6dZmG341GFcrEiB/hiSTwUAhWH2G23OGS5G3eOse4NJbJ+EtFRmk+59t6B9tAxocX3qMGjs/64Vh3ZSJY/MngAYAnhJU2Q61xMw4BZwQTruWdQHYC2Qlk/SB7sZvvb5SOeJKAdOm5xhs3RCpLmBBqAckJVydcnXC1D1ff9p0lxzg/sKAxD0FrpYmK41JrSPD2QawPmo3u5vXzdFA8Ye2EtT1YqwKag80UXrQWyrjUYTajIR3WcDrrDECG/sWN4s2LxndrN+4rtaAhXXnsVOFwuMqUsVW4KpS21fAeA3PPNGeR8OmIyx5jTe4IFTORef27McSFdpoO5JzlpUwYeUVuLm+n5EdmYcGWbk+L9cVqI/rV6NWoVyqS7pE4vp4Q76HPwE5VaMQivHvFeuJjBFc4qDIQl5rb5S2y+e2JgGnQ4xLDsM6MWp+Tjp89EQ3qf940+fLzn1MXcqxoN+219uUDywuPx/ZOqH8qNWrGR202bg6B2ufrAc5oc9TSUvROStrldrzRmXn4y/HZ+uJ6vXTXXuX629fR+n50tHVvOVv5ze3eD+KzyuEuVW5na1TsxqjrGh0Nnu0i8HriCkms8ryUrpvIOVlwmxHWiXksSlNfhgkeAw5LwlWzuw3Zr36FNPOoZwPMVw+qponMuc3KaBCrfBh7tvXfSKhomDMuh7UKMzwf//bu6mJ89uvk/PLq9vLs2WA0sA9+NIwgz5ns2OGGOX3jzm2vV20X/Ufftqgz2sKDHRaCcYlBd/6u6uIzoz3FhzbxxHt/X0JmdLVCVe+0qCp87CZKNJzdtRUHP1UBzYAlPjHoJ8xyeu59OZuiNUguSjfY3b5UqYKGYxzHUNiDtHedcnr99naK+Ky/VJKrBHk0WyCg2IKG9D19Tyl+3cX7h988wecrKpicly7TqZeLP38Bm1tLlg== +api: eJztW1Fv4zYS/isEn644Rfa223arN2+SbX1ts7nE2z54AywtjWw2FKmSVBzD0H8/DCnZsiw7dq+LO7QKECQWyZkhZ775yBG9ppbNDY2m9FarGIwhCaRccsuVpA8BVTlohh/GCY1oymVS9bvadDM0oAmYWPPcjYroPTAdL0iqNMn3pBoyYwYSoiSZ8yeQJNbcguYs/ChpQDX8XoCxb1WyotHafeQaEhqlTBgIaKykBWmxjeW54LGzbvCbQc1rauIFZMy1CvE+pdF0Te0qBxpRNfsNYksDmmucleVg3AilnbTWFJS2JOUgkq19NKhFMa3ZigaUW8jMOcqcxH1tkwVUyqwiaBCZrRrqjNVczmkZUKUT0N3jXRPhkiwXPF5sBNkFEA2CWUi8CpQLssjQ56P7SxrQq+v7S/R1AikrhKVR9dxyK6Bai/co/RqHlWXQ8Mq0mtJDo7vz/r8L0CsceecdSssHHJmzOezbf8vmXDpH7qz2yauqVda9KFwm8ExUSpyn3KJYpi0xzkYu5wTHNpaaSwtz0DSgqdIZs/7RV1/i4gue8Y5QQT0Ze+ZZkRFZZDPQOwo12EJLdIyS6Aq3Gidq9GaOUtvl9PFmSh5uDLuF5FJp72/Xhu7/JJix6IpfmCjAfCLV6q3QTkZyDU9cFaaWo8HkSho4Fu+7/ig3pr6FVOkOB7dtnbl+ncamXH9ua8vOYL1lc9gGa9Axx45BhwfsQ190uhHDZz9L1tPzo8wuGlrgeWFwY2UOmJa3U/qPsOo29BFWLq3bBTcdVr8Y1t+8xrCWLOuIkRuWAfr4ZdnbfKjBqELHcNMp8a5qJfIPiH4CbbgnlV2pv/iG0+QdQ3elYcLmh5VYNj/X8D1vjjsYpyNoxlfnarIgmbRd4ieu5WyRDYztbTPeuWDeZZODnbsQWnrm8unCxf2Xw+G5eNRgCmH9VuXkrUgbfafy2otkyaWPKvyfzVTh6X7H1OOp43xRxy22yjIxrvNua2GxreLFjFlPv6ikY4N1LHu0CKLbg27v8+Q6+BDEDZY21ulHMvb7IpwWMWBD8sGAD9Sq7VOT0D5VuzNkIElAmgJt3+fyE3hyl4tPNh6HnWu72zf8aaYfI02PqRYodzC46dGOGH4gWNymqgqSjkPE6ZYfjv63zADZWuOIbS+TYDC/HPf/G0Y7jYl7Svt/pTSMLQzCDlh8ji3ZqSbtgv04t9a4LoMdDnySSRizrJAJC1nOw0dYmdAfjv65z48J5BpiPKLSyOoC9tHWM2bPmD1jfjbGPAeAPYf2HPr35dDDafYlI28c+/0IK3M+v+6MPYFp/cJ1MG3Pqz2v9rzan0R7Fu1Z9K96EsUhr8+v7P6OYkjKuIAkJD8rDSQBy7gwhGk38IknkDSynlNIZipZHa0H51rNBGSd596meSOEPPas9BKPcMLQWuw489qnd+8uyXevv/724R8La3MTDQbL5TLUaXwBCbdKh0rPBzqN8Rf7fRGSyQI0prEVmQFhSeJmzkQz55gcYp7yuH4RV5lN0GV+fi8Qrmtdt1zcgGah+d5NgRH5cDcmPAFpebqqaXhHNW2+mHb7gWgmmHyk28jYV9rWYoosY3pVc9iuAnx7aZktmin7YGppy8ag+mEyuSVeBIlVspsOURFOIuMSXxHT6PVwGNDqhTGNvhkOS5SJHj9hJpLAcy5YtVVqTYdLkm3j1k2MS2OZjP8szyjN57ytN2wDGR9e+RnVcHzVDceK/Ylg8aPBjQZPCCvsArXG9YUAcEYw4ai2B1kPsh5k3SD7aj/e3yk940kC0oXnBm/cEKksYUKoJSQ9rnpc9bg6hKuvu/aSI6xTWNAYh6C10kTFcaE1JHj/Tmw2mrXu+pjbbxR7rPVYO4C1MqAZ2IXCq8a5Mi50mF3QiA4qOF00Ci8Df3CjePdQ43HfFVYKLWhE1x47ZTQYrBfK2DJa50rbcvCEjnlimrOZ8OGIzR5jdewIFTOx8Pr3fYgN2/tkQC598ZW8IXfX9xPyPbOwZCu3pvnmanEt+s3wzbBTKnY9IHF0OyZ+hj4CG1mhFovw7hTrO58iuMSTv4G40Nyu7nGYX54ZMA16VKAbNpFR6XPS8bPvRIPqn3d1vPzr14lzOWa0u+3F7utnluUej9tbkd11hmF9W3Abjbt1qe3zTU1puFv92fboLN5sm7cVl0YZxl8Pn26ubm+aHraXmf394+HmhvCwdXN3uvaL27whi89Kh7tUuZWtULHvo+bU6DB8tY/A27FLJLHKskI6NpFzsuR2QVjD57EoTHUdVPAYsFiyqRdu1P7kW0hdInsVYrx6UNUkMud2UczCWGWD6s3D5u9MqNkgY1wOKhVmcDn6+cPN1ejip/Hl9c399cWrcBjaZ1+CRpBnTDbscMWcrjJre9brLYv+V983qCLawrMd5IJxiU53811XyWdKO5IPrf2JN999CpnS9RpVfdCiLPGxqyjRaPqwzTj4qQzoAljiA4M+YpTTSz+Xiwlag91F4QrK7WuFZVCPGMUx5PZo34dGOr19fz9BfFZfq8hUgmM0WyKg2JJG9CP9SCl+4cPPD797gc/XVDA5L1ykUy8Xf/4D0AmnrQ== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -60,7 +60,23 @@ Pagination information about the search results. The matching process definitions. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching process definitions. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching process definitions. + +
    • Array [
    • ]
    The process definition search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx index 2f1f4e5114f..f2ccbc6d451 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx @@ -5,7 +5,7 @@ description: "Search for process instances based on given criteria." sidebar_label: "Query process instances" hide_title: true hide_table_of_contents: true -api: eJztXG1v2zgS/isEsR92cY7tpGmv62+uk+75Lm1zjdsFLg1QWqIsbilSpag4huH/fhhSkiWLkt02ado7FSjqii8zw5l5NBpyuMaaLBI8usaXSno0SRATiSbCo/imh2VMFdFMiqmPRzhgws96TbNOCe5hnyaeYjF0wyN8RYnyQhRIheKdGRM0Jwn1kRRowW6pQJ5imipG+h8E7mFFP6c00S+kv8KjtfkvU9THo4DwhPawJ4WmQkMbiWPOPMPZ4K8E6K5x4oU0IvCrytCuXCixHGbk+riHCedvAjy6XmO9iikeYTn/i3oa93CsYAk0o4khIZWuE7iSSqOAUe5vBcK9fCqiFFnhHmaaRmaSQ4mZGevUZiHNiGmJgCE0X5XIJVoxscCbHpbKp8o93jQhJtAyZF5YTKRDihTlRFPfkoB5qUgjMI/x1QT38Nn51QQMw6cBSbnGo+y5ZprTbC3ewOznMGyz6ZXUeJ2JdFPqblTx75SqFYx8a1WCNzcwMiYL6lAnWTBhNF9Z7YNXVcnIvShM+PQOyQAZTZlF0UTpzFyYWCAYW1pqJjRdUIV7OJAqIto+enICi89ZxBymAnQicseiNEIijeZUVQgqqlMlQDFS0LKBHkDRsjkOtEvp00Ika/sEuvXRRCqrb9MG6v/ISaJBFe8JT2nyEWWrtwI+CYoVvWUyTbY+lMRSJLTN3qv62BSsvqCBVA4F7/I6N/2czAZMPTS3G6exXpIF3RprzyGjY1DzgLrrc6cawXx2QTUXzo5Jqr5wGBLaoaVVaWArrmL/v+jKzeInahSgQ5bU2G3j70KKxVaFS6ZDFKScI+LfwlA/59cjMZkzzoAvF9dS0CoWuP3m2Sne9HZ5GOe0ODDzq+n2W2mFmnh/QRLmbTltGN2+vr/Qz/UFnYTU+5SY9yn9nBLO8qXR1hhumU99dAsOsBcpjMT4F7GHDhP3RYnesUQnjcRYYOb2UqWo0FvV22ElInMpOSXCzMnEvvmKeSKivZAmiIjMIHflSA6AgmYBy35u9A8G/NL6LljWHm0vHC+IPxQlmiqkQyKQJ6OYKJZI8a16WGgH0FZo5eZ1j0S5Q74Lubx/6bhLuhKl+5ZtsymFMDlglHVfat4+vsysEqKbXo6lZzRgguURdhve+0VPND1rQ6IrEwE+CI4WwWUjatoej4F428D3fvGtNO//Aprl4hi/YZ8cjrOHeoUszJCt2AdxlcaxVPDxsGTc94jykRcSRTyIS5BPYyrMt59ZJCkCtkhVyRg5o0LbL8E6r7veZo3c4W/lhj0e95pEDvEbfE6QqDV26byu87rO6w7wuvdUJUw61r/B8W5t/zbfm9o39Y7zPdBXg/nabvTEbIwJ/Z+c/EChv00SfI/QP6P0EG77PSLmjP3vGzFnRB8+Yi4Ifb+IOSP5Y3y2ATMuZMsgxAFtlZbDsG1GFl8Kb0iTRRdedOFFF158Y3jRmJR0+N4nuurSkV068ufy9S4d2aUjHyAdScDkLw/c4LG961tRHaB2gNoBageoHaBmgPqSy+Vr6dNDETXgcomE9GmHqR2mdpjaYWqHqSVMNefxzoiLc8BQe1zPJ7p1ow7GH2kW0QdBzSy7UZLfz+m1AWfR6RGTbA08P0zmrZHYj79tsE+Ch8KNfXTvEzr203oI9NhH9ZHSqm5+XAlMwJYZi6gD06pNVVyjwm9GNcivdpjWYVqHaR2m/USYluhGRKufYNd78G0nL3kF/aHA5H7hzhlRatozxRgyQOPJbPr+vIcmb15dXpzPzs96aDJ+PTm/OD+rFMqYbriHi37wO+tYLn5pkqoNVBtX4ntibJOaHnPJbu4P1X9Y8X7qzMCPs5Y/+S65SzAHODd3qwJ1SJKp8JifVVbumMhudeefIdWheSM6antQSBJEihJClk0Lb04hdR/sTVNBhG46625bu/Pt3VGY7ijMFx+FuSWKkTmnDWhbc9ai/+GoXSsgzOc42CGE88w9nMTPVZ5P6TRRowq3fKbpgEk2jRD5PhtkF7eo1mwZsdPzpqWrqw50Y+ujbVGqWZ6T4fDQmLkoaU25KRG+9+r4ba3sobXVewu2mbBfHfCbzGVqS84rorQXsH75VO0ca6kJnzaEKNCW1WYbcADgN75dL/JvS7XvFCk3xEJQf29BLrdhM87Qh4JwW5sPYqGE6j56l1D7Es7aPpaLqj9mNwRAFbRAVCQp8F6vJz+gVrtaD34w8zDsS3k3tev3xnpb4bY17R2HrXho0WOfBbXEt4XR1O7B+AbE3XFPs8b77dxduV0z3roM+0q56+beUNi4m344uNCxrXLrqya1lVx7SlMOWJr2WpX6Cfg9p8W/SpbK6fGW47BfJ0529MCh45bTYoeQaj8+1kSv4TDF4QSbT1fUSVb2Gvfrprr36M71ldL8+ycsp/3d07Vk2B4tb/WIX5P7l7T0ddkSqEE00Br0Od8TZsDpl0Zvn2ESFBDGqd9Hr6SiyKeaMJ4gokqfIdt3qAX9ufRX9kuiIeqLlZxzGv1tX/Q3hoQi9MzoIvv+QARwADrOLfXrty8n6PfTp3+/+TXUOk5Gg8FyueyrwDuiPtNS9aVaDFTgwV/o91sfzUKq4CW4QnOKiO8bTCEcbd9MKImpxwLm5Re6ZGwj0GXlS6kpfDOtLbntVLGaKYzRu7dTZGyJBas8qKuQxuULjkx0OZpzIj7hrVXsM7gxStIoIqr8KVsikPlvelDFksuY/zGbXSI7BfIA0uDDP/cjIARCREzAVUN4dDoc9nB28RAePRsONzAnaPwASQSidzEnWeC9Iw4TKNrarRGsuEDsfjQjFVuwXbo1F4aHZ1ai3BmP3c6YxZKIE0gD3BLOfERSHQJVL79YihomCE9aPq06J+uc7P/eyZ7U7f2lVHPm+1QY8yz8jSXw3kaEc7mkfudXnV91ftXkV09dkeRYmOsFFNghVUoqJD2TjPfhHkdehJk57Txp0gWKna91vtbga5sejqgOJdxvG8vEmA7RIR7hQeZOR0XabmA/2zDcYKkg9WJS1KnieITX1nM2o8FgHcpEb0Zr2CzaDG5BLZW9GWi2HpZbDpce4aGlXtcgNIjSDsmERKnwCXqO3p5fzdAfRNMlWdn8T3FBbT718+HzoTsnAklb94zjyymyElr7K2FCPi04tzsRYjofMrE5EZ5QL1VMr65gmF2eOSWKqnEKSijsIqNnZjcZBdMJ97IfL3Nr+eefM6NwwLO32/uEz+9IFFtv3N6t6UqKDhsSmFvDbEhGtnQo0oquyctJwJY5CuYaM2/D1jTZsJLRwifDk9Oj45Oj4yez4yej499Hpyf906fP/oNLWaq2TpU0j1YpLeditmKUzP463/srt5rNvGJnzhwbMwZ8Xdx+vG3c3gdsr/AdFpfsDncuv71eW8sqXzILzzYGcgJpzCoDhLqBAmO5wvCwf1wHn8upwVBPRlEqzItULLIrh0oG7/E0ybZEOfMoZImK/c+C7IVtQZkVoOM+OKtFlPz9uWA6TOd9T0YDzw4r/p1zOR9EhIlBRiIZTMav3r0+Gx9dTCfnr6/Oj477w76+s3s5gG8RESU+TBarvj+xK/N6Gz58w/3emStreqcHMSfMHBAwsq4zzL3GNczFuSYhA2mR8xqv10DoneKbDTw2aTQ8ur7ZWhz8D9KRlPjWJPAncAM8sXIczYCXrQnWdkzhCIgdMfY8GuvWvjeld8jlm6sZwFJ2iXkkfRijyBIuOCdLPMIf8AcMh0/M2hrEM8/XmBOxSI2NYzsv/PkvsYCdlw== +api: eJztXeFv27YS/1cIYh82PMd22m5r/c1z0r28dW1e43bASwOUls42F4lUKSqOYfh/H46UZMmiJGdN2vRNA4ZlFnl35N39eDrxyA3VbBHT0SU9V9KDOCZcxJoJD+hVj8oIFNNcijOfjuicCz9tdZY2immP+hB7ikfYjI7oBTDlLclcKhLtUYzJjMXgEynIgt+AIJ7iGhRn/Q+C9qiCTwnE+hfpr+loY/6XK/DpaM6CGHrUk0KD0PiMRVHAPSPZ4M8Y+W5o7C0hZPhXWaD9cZHYSpiy69MeZUHwZk5Hlxuq1xHQEZWzP8HTtEcjhVOgOcSGhVS6yuBCKk3mHAJ/NyDay0gxpdia9ijXEBoihzIzFKvcpktImWlJUCAyWxfYxVpxsaDbHpXKB+Xubx4RLshqyb1lTkgvgSgImAbfskC6IJIQzWN8MaE9enJ6MUHD8GHOkkDTUfq75jqAdC7eIPVT7Lbd9gpqvEyHdFVoblTx3wTUGnu+tSqh2yvsGbEFONTJFlwYzZdm++BZVTJ0TwoXPtwSOSdGU2ZSNFM6NRcuFgT7FqaaCw0LULRH51KFTNufnj7ByQ94yB2mgnxCdsvDJCQiCWegSgwV6EQJVIwUUDTQAzhaMcdz7VL6WT4ka/sMm/XJRCqrb/MM1f8xYLFGVbxnQQLxR5LO3hrlZCRScMNlEu98KI6kiKHJ3sv62Oai/gJzqRwK3pd1Zto5hZ1z9dDSbp3Ges4WsDPWnmOMjk71HaquHzjViOazD6rZ4GyfuOwLhyGh7VqYlRqxojL2/wZrt4jXYBSglzyuiNsk3yspFjsVrrheknkSBIT5N9jVz+T1WMRmPOAol0tqKaCMBW6/+ekZ3fb2ZRhnvAIU5nvT7IfCDNXJ/guLubeTtKZ38/x+B5+qEzpZgncdm/UUPiUs4NnUaGsMN9wHn9ygA7QihRkx/U608OHivjjBLY91XMuMzw1tL1EKhN6p3nYrMJlJGQAThiYXbfRyOiHT3hJiwkRqkPvjiA+AgvoBFv3c6B8N+KX1XbSsFm0vHAvErwqYBkX0kgniyTBiisdSfK4eFtoBtCVemXndI9PAMb5XcnX/owtcoytwuu+xbbeFECYDjKLuC493P5+nVonRTS/D0hOYc8GzCLsJ7/28JTk7aUKiCxMBPgiO5sFlLWraFl8D8XaB7/3iW4Hu/wOaZcMxfsOvHY7Twr3EFimkM/ZBXCRRJBW+PKx44HtM+cRbMsU8jEuIDxEI8+5nJkmKOV8kqmCMAQeh7ZtgVdZ9b7NG7vC34oMWj3vNQsfwa3xOsLAxdum8rvO6zusO8Lr3oGIuHfNf43g3tn2T753ZlXrP+R7orcG8bdd6YtrHhP5Pnzyi0N8mCb5E6J9yegi3/RIRcyr+l42YU6YPHzHnjL5cxJyyfByvbSiMC9lSCHFAW+nJYdg2ZYu7whvRbNGFF1140YUXnxle1CYlHb53DesuHdmlI78tX+/SkV068gHSkQxN/vzADzy2dfVTVAeoHaB2gNoBageoKaC+DOTqtfThUESdB3JFhPShw9QOUztM7TC1w9QCppr9eCfMJTliqN2u5zPd+KEO+x9pHsKDoGaa3SiM38/4NQFn3ugrJtlqZH6YzFsts8f/2aBtBA+FG2187xM62nk9BHq0cf1KaVW3PK4EJmLLlIfgwLTyozKugfDrUQ3zqx2mdZjWYVqHad8QpsW6FtGqO9h1C77t5SUvsD0WmNwv3DkjSg09U4wh52Q8mZ69P+2RyZvfz1+dTk9PemQyfj05fXV6UiqUMc1oj+bt8O+0YbH4pW5UTaBaOxNfEmPr1PQ1p+zq/lD90Q7vm84MPJ65/Ma/krsG5gDn+mZloF6y+Ex43E8rK/dMZL+6848l6KVZER21PWTJYsLyEkKeksWVU0jdR3vTIJjQdXvd7dNuf3u3FabbCnPnrTA3THE2C6AGbSvOmrc/HLUrBYQZjYMdQjj33ONO/EzlGUmniRpVuMdnHh1AZFsLke/TTnZy82rNhh57La8amrrqQLe2PtoWpZrpeTIcHhoz5yWtSWBKhO+9Or5SK5ur9NBa69YCbi7sWwj+zWYysSXopaE1F7TenVSzxFpqFpzVhCz4LK3VNmCBC4Hx9WrRf1Pqfa9ouSY2wnp8C3qZTZt+hj8WiNtafRwWiUH3ybsY7KKcPvtYLLL+mJ4YgFXRgoCIE5S9Wl9+QO12uT78YOGx211lN7Xs9yZ6UyG3NfU9By55bN5i32Ia4tvcSCrnYHwG4u65p5nTZh+tfHPNFz0ONl7Yg6qzGpLOYvD9Asb9NMPBBY1NFVp/i6it2GopQan4611rUqo73Vt2hf+tsZR2ie9/CWunWP4y5s5EFZLQ7QSLSWk3uYb8z1fLqnzFd532KS28+zSEEeib6MIOJHKfztDOuPm0hoY91n/Lks12lpYNhwcQbtqA2Lb75mDydbtxWvTTGDI6V5VtrxSz3Qi/77EwET7rs4j3r2Ed9+1xMf/67HiO/AZrwrRWfJbgWSosxpNoQHGv8JLlQ6TAQ8umI60S6GLALgbsYsBHHQPeu193cWMXN3Zx4z88bmwy8LZjvqrLXkskeUdvSndGO9i0x5aNrJqrW+r4NUebBzCs3/xd2UzZqOfXJlL8DdbxXSPRUs8DYlJrlp8fk3Y5xi6+7OLLxx1fdjnGLlbsYsUuVuxyjN9ojhE7PLvr9+VPSITMGQ/A75PfpQLig2Y8iAlThY0SuxXXLhkz6a/tXoea79KRkrMAwtbYcYwrB7ZM+RK7VGB6wzacWe6Xb19OyItnP/589f1S6ygeDQar1aqv5t4R+FxL1ZdqMVBzD//Fdj/0yXQJCpfQNZkBYb5vrIcFxaUrjsDjc+5lR06nYhPUb2kvR12wZ5427L5NFK+Yx5i8e3tGjK/z+ToLAUusafEIdhOLjmYBE9d0ZxVtRjgmcRKGTBU32xQYpPiaHHSmksvA/z2dnhNLgnho4BgGZAiAjHAQIRd4GDodPRsOezQ9Gp2OfhoOt0gTNX7ASASB2yhgaZi+NxwuSLizWzOw/IqD+9GMVHzB9/lWXBh/PLEjypzx2O2MaeRJAoYblW5YwH3CEr1Erl529D0YIVgQN2z+6Jysc7J/vJM9rdr7S6lm3PdBGPPM/Y3HGFcRFgRyBX7nV51fdX5V51c/uiLJsTAHoCq0Q1BKKiI9s13Yx5tmgjzMzHhnKZYuUOx8rfO1Gl/b9mgIeinxBq5IxsZ0mF7SER2k7nSUJ/0G9rWN4h07ChM6JjuXqICO6MZ6znY0GGyWMtbb0Qa3s28HN6iW0u5xfGw9LLOcQHosWFruVQ3iA1HYwz2xHwrIc/L29GJKfmUaVix9a86v0MpIPx8+H7rfkDHF66Y4Pj8jdoTW/gqYkJFF53YnqkzjQwibMyti8BLF9foCu9npmQFToMYJKiG3i5SfoW4yPqYR7aV/vMys5T9/TI3CEc/e7m48O71lYWS9cXf7jyvdMqy5O2JnmDUpzoYGebLSRbyYWmygkQtXm3QZNuZMhqWMI30yfPLs6PjJ0fGL6fGPo+HPo6cv+i9ePP8fLWQRmxqV0nDpVoc8V7YbRsHsL7PqhOJTU26Q1w6YwlZjwJf5/Wy7h7sby+wlY8P8GrDh3vVclxtrWcVrsPC3rYGcuTRmlQJC1UBRsExhdNg/roLP+ZnBUE+GYSLMQioW6aHoBYP3giROizYC7gFmifIKjZztK/uEpFZAjvvorBZRsvVzwfUymfU9GQ7ST4T5f2eBnA1CxsUgZREPJuPf370+GR+9Opucvr44PTruD/v61n75QXwLmSjIYbJY1a8b+2Pe7MKHz7iBMHVlDbd6EAWMmxImM9ZNirmXtIK5NNMkZogtcl7SzQYZvVPBdos/mzQaHV1e7SwO/w/TxcB8axL0Gt2ATuw4jqYoy84EKzUdWKRme4w9DyLd2PaqsIacv7mYIiyl1yyG0sc+iq3wCka2oiP6gX6gWB5n5tYgnvl9QwMmFomxcWrp4j9/AVua62w= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -156,7 +156,23 @@ Pagination information about the search results. The matching process instances. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching process instances. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching process instances. + +
    • Array [
    • ]
    The process instance search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx index f41e04c7e2f..0ef957f8d51 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx @@ -5,7 +5,7 @@ description: "Search for user authorizations based on given criteria." sidebar_label: "Query user authorizations" hide_title: true hide_table_of_contents: true -api: eJztGmuT2rb2r2j0qZ3rAGnTNuUbAW/i212gPNrp3ewkwj6AGltyJHlZLsN/v3MkG9tgdklv+qmbmcwa67xfOj7Sjhq20rR7S3uZWUvF/8sMl4LeeTQCHSqe2p9dOgWmwjVZSkUyDYqwKrgmC6YhIlKQFb8HQULFDSjOWu8F9ahMQVm4IKJduuQimmtQNYaaejRliiVgQKE8OypYArRLkdsvsKUe5ShHysyaelTB54wriGjXqAyOhZ2tgXyCLZFLYtZAchLFz5roLepRHa4hYbS7o2abIk8uDKxAUY8upUqYca9+fEX3+zvHG7R5I6Mt4oRSGBAGH1maxjy0dNt/ahRlVyHO4ni0tKrlbOTiTwgNaq7QRIaDthhSWWpHDpDKkCWHOCqtS72CFFOKWRsZSPSXMLMUT7mhBR0zIwkKRBbbCjttFBcruveoVBGoZny7RLggmzUP1wdC6AIFMTMQORZIF0SW2Cic9qlHB/6070JwybIYze/eG25iyG0xQuo+ou331Xi4zVW6q4Db2P01A7VFzInzH93fIWbKVnAq/5ituLCOrFn7YqsqmTQbhYsIHjASraesUQxThmgrIxcrgrgVUzfH4vffofFjnvCGUEE+CXvgSZYQkSULUDWGCkymBDpGCnSFtcaFHJ2YvaVpcnpwUMkVC4ZgLdKXyvnbrqH7P8ZMG3TFbyzOQH8kufVsijKSKrjnMtMFHQU6lULDY/Fe98f+IOobWErV4OBjWRcWrlHYJVd/t7T7xmAdsxWUweo16NiAdB7hNPXjRjfOjmtkoZlD0PVEqOP2zuNV7HFGILkRoGYWpEkmRC5quAXFHymohGuNW0gTg3NyXkqvqEvzqT+hHp2Mrn3q0beT0XxMPXrTG4+D4Vvq0flwOvb7wVXgD6qVZ1Ro5ArVHRZMfIUbWnN5iC7U8JEtqmRf88aV9UK9+DUCNgVTvcbinmtfuEi3zvuu02lW6bRdqGRKFtvKc/Eeet6/j4fWk1WeC2dHfGYLmbl9qiboo4H/F0g9LrGRhsVBUTCOzIpreUFPmHH7BjJp6AzOB4pHjypbs//spn1vAYrYtHiWP+4ibkNHtYgG0yJzDcSsuS7WPlYr8ce8rcDSKQgInaHsp5vQBQW+volcLDyifansdsP7aqI/Vu1dRh2lZy0jDxDHEcPPBIvtBvIgqbftlwvdWKr/zirm/TN2AwVaZiqEp/UsIIlZM5NLuGb38DV0LmlLwqKorSCRdcrEyHbRmB569fns3WgS/Kc3C0bDUv8Pk7k1y40/nfbe4tOb3qz/jnq0Nx5fB/0CfPrHdObfUI/O/GFvOLNt//h69MeNb3+MJ6O+P51+GPhXwTDIcQZ+P5gGo+GHif/rPJj4CHsOpPa28FHVcxXPTCpuKJ1T0b+SEUWmnJrzyBMXplKJ1RwE0xRCvuTYkFZc9he9fhGxg4P76AHq0f7E7838w8OHwjfBcDrrDfuVlYP1K0sTvzfI/zRh2vfolw+z3vSX4kUTofl44MRwD03E8pUquYF/7Vss91BglS8Gk0H542o0uTmBLTlUYmZc89tpSgfR01HTIzHXppaCwcD5pvQJKT9I0DuZ4J8zyDsDN/04jrTi87y6h5TiDmaj+lKt+ys3mCcaxCrg3qOvvrz/+4wbGlkyHkPUIjdSAYnAMB5rwhTgZ9Y9jyCq7NOWIVnIaOsmS2f6xlTJRQzJv077x2Pzjx1kzpe4/CFMEwe4cNxvJ1d98vOrH366+2ZtTKq77fZms2mpZfgCIm6kakm1aqtliP8R7tsWma1B4ca7JQvAosqRJ4tJmfxEu2QMiy/NXGyblk6/J1rEvF7UvV7ZSzPFG0JuPgkIj0AYvtwWjWONNa1OXmwH213ETHyiZUCcMj3morMkYeowdKszwM9zw0xWDdqzY4emUvtuNhsTR4KEMgI7mLSNW84IlUi4wBkI7b7qdDyaT0Ro98dOZ4800eMXaCIIPKQxy5v7I3W4IEkZt1YxLrRhIvxanpGKr/gx31btMy8P4oHTqEjHl83pmPerJGbhJ42tMY9sdiLXsJh4gRWCxfqRj7PnJHtOsn98kn1/Gu9XUi14FIGw4XnIN66JkIawOJYbiJ7z6jmvnvPqXF790NRL9nCyZkBhHIJSUhEZhplSEOEBU2zJh6B1wbsYzDw3is+59pxrZ3Jt79EEzFriwXwqtQ0dPGHv0jZ+t+n2Lj8837fro8O2+4bD03NQ98WZfaZi2qU7l0b7bru9W0tt9t1dKpXZt+/RR/dMcbaIXWTisku3IoxiGbJ47UQ5dScu4MWAQs0+SzIRMfKaTPzpjLxlBjZsa82bHo7RC9KvO687zYMbnBI3U+yNA+I0dMFYKRAFWcz0RrIO+BLC9l6BhjBT3GyniObMswCm3E2JSpDk/Cx1/O2AqJc/XBWh8+/fZ9b7WNwm5Z0F/4ElqUvN8gSwOmytHVJhBrgLCbeHywKH+cJdeXzuTrw7hzPpztFZ8e3OqVg9k8V3e5sIS2n1y8P01FIYNqC0M22n9fI0JcaBzexQJkkmbHkXK7LhZk1YxfJhnOn8KDLmIeD0onu4aVKAXbsV8pvjSF62MGpcaBdVfcXNOlu0Qpm0Q4d2+LuI5aKdMC7aOQvd7vdu5sNB78V10PeHU//Fy1anZR7cKQZmXcJERQ4752+6ZXOsdeXuyf91PyePKwMPpp3GjAuMdKvvLq8Gt/YaDgrQLe/jnAiXl4Q7L0/rW7rbIeO5ivd7fG0HPrR7e1dWATej5BqfI9pdslgfX+epqvnNJD+E/JZ84SWfRiWL4ZzY2sIUZ/iLevQThv7h6pEd662BRS6Q89W+E+qFzZoS++T8cu8VGL0whNQ8CntXqcfj0RQH4Yv8nlEiI8RRbIP3n9iGdul7+p7a+1WmmFHb9zsaM7HKbGZSRxf//Q+UIQsQ +api: eJztG2uT2jjyr6j0abfOAbKb3cvxjYAn4TIDLI+92ptMJcJuQBtbciR5ZjiK/37Vko1tMDNkL3dVV+tUpcaPfr/UFuodNWytafeW9lKzkYr/ixkuBb3zaAg6UDyxt106A6aCDVlJRVINirAyuCZLpiEkUpA1vwdBAsUNKM5aHwT1qExAWbhhSLt0xUW40KAqDDX1aMIUi8GAQnl2VLAYaJcit/ewpR7lKEfCzIZ6VMGXlCsIadeoFI6FnW+AfIYtkStiNkAyEvltRfQW9agONhAz2t1Rs02QJxcG1qCoR1dSxcy4Rz+/ovv9neMN2ryR4RZxAikMCIOXLEkiHli67d81irIrEWdRNF5Z1TI2cvk7BAY1V2giw0FbDKkstSMHSGXIikMUFtalXk6KKcWsjQzE+muYWYqn3NCCjpmRBAUiy22JnTaKizXde1SqEFQ9vn1FuCAPGx5sDoTQBQoiZiB0LJAuiDS2UTjrU48O/FnfheCKpRGa3z033ESQ2WKM1H1E2+/L8XCbqXRXArex+0sKaouYU+c/ur9DzISt4VT+CVtzYR1ZsfbFVlUyrjcKFyE8YiRaT1mjGKYM0VZGLtYEcUumro/FH39A40c85jWhgnxi9sjjNCYijZegKgwVmFQJdIwU6AprjQs5OjF7K1Pn9OFBJVcsGIK1SF8q52/7Dt3/KWLaoCt+ZVEK+hPJrGdTlJFEwT2Xqc7pKNCJFBqeiveqP/YHUd/ASqoaBx/LurRwtcKuuPpvS7uvDdYJW0MRrF6NjjVI5xFOUz+qdeP8uEbmmjkEXU2EKm7vPF7JHmcEkg8C1NyC1MmEyHkNt6B4k4CKuda4hNQxOCfnpfTyurSY+VPq0en42qcefTsdLybUoze9yWQ4eks9uhjNJn5/eDX0B+XKM841coXqDgsmPsIFrb48hBdq+MQSVbCveOPKeqFa/GoB64KpWmNxzbUPXKRb5/3Q6dSrdNoulDIljWzluXgNPe/fp0Pr2SrPhbMjXrOlTN06VRH0ycD/A6SelthIw6JhXjCOzIrvsoIeM+PWDWRS0xmcDxSPHlW2ev/ZRfveAuSxafEsf1xF3IKOahENpkUWGojZcJ2/+1SuxJ+ytgJLpyAgdIqyny5CFxT46iJysfCI9rWy2wXvm4n+VLV3GXWUnpWMPEAcRww/Eyy2G8iCpNq2Xy705Zn2pyjiCrRMVQDP65lDErNhJpNww+7hW+hc0JaEhWFbQSyrlImR7byfPLTYi/m78XT4z958OB4V+n+cLqxZbvzZrPcWr9705v131KO9yeR62M/BZ7/N5v4N9ejcH/VGc9utT67Hv9349mYyHff92ezjwL8ajoYZzsDvD2fD8ejj1P9lMZz6CHsOpPI091HZcyXPTEtuKJxT0r8UyHmAn5rzyBNnM+BoRTlg1QfBLIGArzj2kSWX/UGvX0Ts4OA+eoB6tD/1e3P/cPEx981wNJv3Rv3Sm4P1S6+mfm+Q/anDtM/RLx/nvdn7/EEdocVk4MRwF3XEsjdlcgP/2rdY7iLHKh4MpoPi5mo8vTmBLTiUYmZS8dtpSg/D56OmRyKuTSUFhwPnm8InpPiOQO+kgn9JIVvQ3abFcaTlX9Xl0l+IO5iPq68qTVu+LrxhtWvDN+o6DxI+I8UTgrq1rAToVVq+exG2AhanImQtlvDWZ9jqlvuI/ctpOxhCoiDArYTcpk2D2DSITYPYNIhNg9g0iE2D2DSITYP4P20Qv35bMpdrZHu897DVFzePFZQL2khnvpo2smkam6axaRqbprFpGpumsWkam6axaRr/73cVEfLV1/8k/QVXQ7JiPIKwRW6kAhKCYTzShCnAkx/3PISwtMhbhmQpw6077Hbmp+xEyWUEce0eZjUIJg4y40tcFhOmiQNcOu6306s++durn/56993GmER32+2Hh4eWWgUvIORGqpZU67ZaBfgf4b5vkfkGFK7aW7IELO0cebKIFE4l2pWEID/8kolti4PT75n+MqtaVc+WusRU8ZrAX0yHhIcgDF9t866zwpqWD4PZ9re7jJj4TIuAOGV6zEWncczU4RxglQGeGDLMpOXUOXsSqq7gv5vPJ8SRIIEMwZ6VtF1fxgiViLnAY1m0+6rT8Wh2SIt2f+509kgTPX6BJoLAYxKx7MvgSB0uSFzErVWMC22YCL6VZ6Tia37Mt1XJ3yyIB06jPB1f1qdj1uySiAWfNfbVPLTZiVyD/BAeWCFYpJ84L9IkWZNkf/ok+/E03q+kWvIwBGHD85BvXBMhDWFRJB8gbPKqyasmr87l1U91vWQPt+UMKIxDUEoqIoMgVQpCPPMeWfIBaJ3zznd1mkaxybUm187k2t6jMZiNxFmhRGobOjj006Vt/G7T7V02z7NvV/cd2+4bDgd6QN3nY0SpimiX7lwa7bvt9m4jtdl3d4lUZt++Rx/dM8XZMnKRia9duuVhFMmARRsnyqk78QXOKuVq9t3PDuQ1mfqzOXnLDDywrTVvcpjsyUm/7rzu1G8f4RZzPcXeZEichi4YSwUiJ4uZXkvWAV9C2I46aQhSxc12hmjOPEtgyg1vlYIk42ep470Dol52cZWHzt//Mbfex+I2Lcao/EcWJy41i6GE8pZv5dw8ZoCbkbo9zC8d9hDuiokeN4TTOYzJdI7GV253TsXymAg+29tEWEmrXxamp5bCsAGlnWk7rZenKTEZ2swOZBynwpZ3sSYP3GwIK1k+iFKdTUdEPADcvegeht9ysGv3hvzqOJKXLYwaF9p5VV9zs0mXrUDG7eyXr8PfZSSX7Zhx0c5Y6Ha/d7MYDXovrod9fzTzX7xsdVrm0f0EglkXM1GSw/5IUDf4d6x1aRzuPxoZzOLKwKNpJxHjAiPd6rvLqsGtnQxEAbrFiOCJcFlJuPOytL6lux0yXqhov8fHdsOHdm/viirgdkq5xuuQdlcs0scThmU1v5tmcxHfk6+cO6xVMt8iFFtbmKIU76hHP2PoH6Yh7ebiBljoAjl723dCvbBZU2CfjFTsvRyjFwSQmCdh70r1eDKe4Xb8Mht9jGWIOIo94Egme6Bd+oF+oHbk0+Q75fb5jkZMrFObmdTRxX//BtEfAsU= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -60,11 +60,23 @@ Pagination information about the search results. The matching authorizations. -
  • Array [
    • permissions object[]
    +
  • Array [
  • ]
    • Schema
      page object
      -The permissions. +Pagination information about the search results. + +
      items object[]
      + +The matching authorizations. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching authorizations. -
    • Array [
    • ]
    • ]
    +
  • Array [
  • ]
    • The user authorization search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx index d34fbf8cbee..07d9f7fae71 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx @@ -5,7 +5,7 @@ description: "Search for user task variables based on given criteria." sidebar_label: "Query user task variables" hide_title: true hide_table_of_contents: true -api: eJztWVtv2zYU/isEn1ZMsd0u7Tq9uUm6eeslS5z2ITVQSjqy2FCkSlJJDEP/fTikbrYV173srQWCGiJ5rt93DnW0ppYtDQ2v6ZUBTSwzN3QRUFWAZpYrOUtoSFMuE1yeM3PzjmnOIgGGBjQBE2te4D4a0ktgOs5IqjQpG1nkttlOImYgIUqSJb8FSWLNLWjORh8kDWjBNMvBgkZT1lSyHGhIy1rnP7CiAeWopGA2owHV8LnkGhIaWl3CtiXzDMgNrIhKic2gs2ZEA2riDHJGwzW1qwKVcGlhCZoGNFU6Z9Y/enZMq2rhFYGxL1SywjOd3pQJAwGNlbQgLa6xohA8dlEbfzJoyLqnjQnxNnXO1XpV9Alii75rjLblYNwJpZ20rdgqbUnKQSRd4GjQiGJaMxchC7n5GmVO4q42jJ9XZhVBg0i06qkzVnO5pFVAlU5AD593S4RLcpfxOGsFYT40CGYh8SpQLsgyRwhOL09oQE/PLk8QgwmkrBSYD//cciugjsVblH6Gx6qqj4br2qVFb7uD5b8l6BWevPAJpdUCTxZsCbv2n7Mlly6RG9E+OKpa5cNB4TKBe4Sly5QLimXaEuNs5HJJ8Gwv1MPg/O0JBl/wnA9ABfXk7J7nZU5kmUegNxRqsKWWmBglMRUuGgdq9GZOUzuU9Fnrkq8DDLeNyInSPt9uDdP/UTBjMRXvmCjBfCR19BxfGSk03HJVmkaOBlMoaWAf3jfzUbWmvoBU6YEEb9sauX2DxqZc/9/WVoNgPWdL6MAaDPg4cKh/YNPltrw3ln7G/QMAaEHdiN+u/EPqKk9D77tz8slkMozNod6wHTzXE354af0i2bn0mMffLFKlL1edcaWwZrMQfLeo/RZbZZmYNbjZiiWu1bzOmfXlA5UMNIiHe1xAtwA+nDRXu2/dhqarunNOPxYTX9fRLWLAjsiVAWIzbpq1j31Cfqy7CzJIEpCmRNt3oXgAzzdrycHG47Gvtd3VvR9m+j7SexbULWqQ5e2ObZo3JN1m+U5VegBx/AGwuaZSg6zl7T5/95vVGORy8GWrGo14ERy0DW97ePF0aWt2H0gAf9nclvqG5eDRMiyxuwQ5ZA25LMoDJaSlEO+GpbwshfDYPUyUiVWxP0w1A9zGfTL3hazQKgZjZtJYJuOD9NVHCK/PfKtqC5JJOxu6tboVMjs9LFLczHUpY7yJ7sp6n4HNsE9lUEefG2Kb/URpIlWf7pFSApjcaMsN5rF+bxJ+sJM2lHY7j7+he3qqp4wLSEbktdJAErCMC0OYdgm45QkkvYrnKRipZLW34xZaRQLyX3c776Z9U3Lud9Z6iWczYYb4jZHXfn3x8oT8cfz098UvmbWFCcfju7u7kU7jI0i4VXqk9HKs0xj/cN+jEZlnoLEErUgEhCUJR51MkK5OEFNAzFMeN1e32myCKfL+faHZutX1FlJ6GCw133npnZKrixnhCUjL01XTgjdU0/6rjLsLhJFg8oZ2iNhVuq3FlHnOdJ9NPQXIe8ts2W80D97jh16W/5rPz4kXQWKVQFdLa0XoRM4lvlTQ8HgyCWj9ikHDZ5NJhTIx4wd4IgncF4LV16Qtd7gkeYdb51hTL35QZpTmS76td7TB2xrEp94jz8enQ3yc4jXPgkYcgtZKExXHpdaQ4EuvaGteo7u5Jfzk2k+u/eTaA1yrApqDzRTOHQtlHHRw5hfSMfa+I+x9ZrzujQarcdsKx74V4pgP9G0zTSy1oCFdeypV4Xi8zpSxVbgulLbV+Bbz1IpA33HZU66BklAxE5k3ZzeluCDb+yKQE5aXMmHkObk4u5yTP5mFO7ZyIS7a8V4j+vnk+WRQKm59QOL0fEa8hx6QvSLRiEW2D4r1mw8R7AagBuJSc7u6xGM+PBEwDXpaYlZaoNT6nHR3I3KbaFD/eNnA5+/3c4cALHAX3XD17J7lhaenn4Bet9PJ9s626OZ1fsQ2aYdgk63h1PXa294fAuGzyqE8Vc7wGoO7IUA8gDY+ZpPR4128n88cbWOV56V0tVsuyR23GWG9kMaiNDgEo2hnDHi9C9vhdrPtlV8h77xG8niEcPCYbUr2ktusjEaxysexP9b+HwkVjXPG5bhWYcYn09dXb06nR69mJ2dvLs+OHo8mI3vv35eRUjmTPTvc9XPoXrnt9brrWd81668BY+HejgvBuEQIO3/XNdWvaUd1GtBw8ztA38Ca74ug5uw1Xa9R+ZUWVYWP3aWYhteL7pwf3HCDv7tB/oOu/nJRT5cfkX3fFQa9al6OpbfbveFRGtAbfGHa+LxRLaqAZsASj956x4m34miOcjoJO+OwKmhOTOMYCrt376JXYc/fXs6Ro/XnjVwleEazO/zGwu5oSD/QD2ixcpFx9HfP11QwuSwdHamXi//+AwJhI5s= +api: eJztWt1v27YW/1cIPm24iuxu3W6v3tw03bxubW7idA+pgVLSkcWFIjWSSmIY+t8vDinJkq243m0G7MEFghoieT5/54PS2VDLVoZGt/TGgCaWmTu6DKgqQTPLlZynNKIZlykuL5i5+8g0Z7EAQwOagkk0L3Efjeg1MJ3kJFOaVC0tct9uJzEzkBIlyYrfgySJ5hY0Z+EnSQNaMs0KsKBRlA2VrAAa0arh+Q7WNKAcmZTM5jSgGv6suIaURlZXsCvJIgdyB2uiMmJz2EoT0oCaJIeC0WhD7bpEJlxaWIGmAc2ULpj1j358Set66RmBsa9VusYzW74ZEwYCmihpQVpcY2UpeOKsNvnDoCCbHjcmxIfMKdfwVfEfkFjUXaO1LQfjTijtqO3YVmlLMg4i3RqOBi0ppjVzFrJQmL/CzFHc54b288ysIigQidc9dsZqLle0DqjSKejx826JcEkecp7kHSH0hwbBLKSeBdIFWRUIwdn1OQ3om4vrc8RgChmrBPrDP7fcCmhs8QGpX+Cxuu6j4bZRadnb7mD53wr0Gk9eeYfSeoknS7aCffkv2YpL58iBtY+2qlbFuFG4TOERYek85YximbbEOBm5XBE82zP1ODi//w6NL3jBR6CCfAr2yIuqILIqYtADhhpspSU6Rkl0hbPGkRy9mLPMjjl93qnk8wDDbSE5V9r7262h+z8LZiy64iMTFZjPpLGei1dGSg33XFWmpaPBlEoaOIT3oT/qTtTXkCk94uBdWWO3b1TYjOu/W9p6FKyXbAVbsAYjOo4c6h8Yqtyl91bSP3H/CAA6ULfkdzP/GLvah6HX3Sn53XQ6js2x2rBrPFcTjk6tQx6tmLt67vmlU/TYuP5isuDSxwz+ZrGqfLrbKlcJa4aJ5KtJHZbYKsvEvMXdji9wrckLBbM+/SCTkQLzdI0M6E6AjDvd5f57t6Gtyu6c44/JyNcFVIsYsCG5MUBszk279rkf0J+b6oQRKAlIU6Hs+1A+Ik8Mc9HRwuOxvyq7y5vPJvqhpOGh3pS40SzR7dhFDH8CLK6oNCDp4vaQvIeDsg1HZ8PDMTkk9JoZIFuRXbfZEp8/QWuooe8td+m+ZwV453LTKTja8zggjGkoqiMpZJUQH8epvK2E8FA7jpQFyaSdj/VwboXM3xxHiJuFrmSCfdk+rd9zsDlm7Rwa4bghtt1PlCZS9cEbKyWAyUGR6jsJnTiCvVZAbPdHEYg9PTr8y+qYRJWH6TSB7DYeZ6JSqwSMmUtjmUyOot4cIbw5cwyjJ2w2DPnRWtwGdR0MCua9TMOEFZVMWchKHt7B2oS+M/zXVxZT8g7WhFmreVxh08QMtpygedLky9DdEksNDbL8be1UgE8F+FSA/0EF+Nnj+FS0T0X7yKJ9KLU9Xxk/xOVvLuwHXjCOW/q9q83vYG2OLvqDI0eUf4+hry3/p7v0qZSfSvk/q5Sf7tKnsny6Sz/fXRp3vvw/3mX7UpkxLiANyW9KA0nBMi4MYdppc89TSHs5zwdxrNL1wfffpVaxgOKLtXtGLv3Ohi/xMYy9vd8Ye+63V2/PyX9e/vDv5Te5taWJJpOHh4dQZ8kZpNwqHSq9mugswT/c921IFjloTGJrEgNhacqRJxP9ZGJKSHjGk/ZDSiM2QQ95/b5Qbt3qZsejvaJZab73CXpGbq7mhKcgLc/WbREesKb9D4uuG4hiweQd3SJin+kuF1MVBdN9aPYYYMhYZqt+qXnyq9rYp+ufF4tL4kmQRKWwjdOGESpRcImf+Gj0cjoNaPPBj0Y/Tqc10kSPH6GJJPBYCtY0SjvqcEmKLW6dYm3wPZNnlOYrvss3HMRtA+I3XiMfjz+MxeMMGz0LGnEIWitNVJJUWkOKn6BFl0Ba3m2fcIq1U6ydYu2JWKsDWoDNFU4Blco46OAETkQnWPvOsPaZyaY3qFNPulI48aUQh25A37ezPZUWNKIbH0p1NJlscmVsHW1KpW09uUc/dSRQd1z2IddCSaiEidyLs+9SXJBdCwrk3F9+yStydXG9ID8xCw9s7UxcdsM2LelX01fTUaq49QmKs8s58Rp6QPaSREsWo32UrN98DGE3jmQgqTS362s85s0TA9OgZxV6pQNKw89Rd12k20SD5sfbFj6//L5wCMAEd7Uddbp4ZEXpw9PPI912s0Jdb7XcTs/4gZdpN5Iy3RkVud142fsjGfisdijPlBO8weC+CRAPoI232TR8sY/3y7kL20QVRSVd7pYr8sBtTljPpImoDI6kUJQzAWzvuitMx/ZXv0I+eo7kRYhw8JhtU/aK27yKw0QVk+bFSvd/LFQ8KRiXk4aFmZzPfrt5/2Z29uv8/OL99cXZi3Aa2kd/Y8aQKpjsyeHaz7G+clfrzbZmfdXkXQMYC492UgrGJULY6btpQv2WbkOdBjQaTuX1BWzifRk0MXtLNxtkfqNFXeNj1xTT6Ha5Pefvpdzg7+1Y3ZOqfnPVzHp9Sw5N+Y1q1V6vpZfbXRopDegd3j4Gw4b1sg5oDiz16G12nHspzhZIZ0thbzilDtoTsySB0h7cu+xl2MsP1wuM0WbYsFApntHsASce2QON6Cf6CSVWzjIu/N3zDRVMrioXjtTTxX//A6XMpGQ= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -56,7 +56,23 @@ Pagination information about the search results. The matching variables. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching variables. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching variables. + +
    • Array [
    • ]
    The user task variables search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx index e906343ea7d..15f345b3332 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx @@ -5,7 +5,7 @@ description: "Search for user tasks based on given criteria." sidebar_label: "Query user tasks" hide_title: true hide_table_of_contents: true -api: eJztG2tvG7nxrxDEfbhDZUm5S66pvulkO6fWSVw/0g+OgVC7I4lnLrkhubIFQf+9GHKfEiWvHeeKtgoQRFkOZ4bz4nCGXFHLZoYObui1AU0sM3f0tkNVCppZruQ4pgM65TLG4Stm7gzt0BhMpHmK43RAL4HpaE6mSpOswGHIhBmIiZJkxhcgSaS5Bc1Z97OkHarhawbG/qbiJR2s3H+5hpgOpkwY6NBISQvS4hhLU8Ejx0vvD4MEV9REc0iYGxXi45QOblbULlOgA6omf0BkaYemGtdgORg3Q2mHbYNzpS2ZchBxxR/tFKiY1mxJO5RbSMxTiDmM29Su5pATs4ogQ2SyrJEzVnM5o+sOVToGHZ7vhgiX5H7Oo3mJyM6BaBDMQuxJIF6QWYKKHV6OaIcen1yOULMxTFkmLB3k3y23AnJZfETsJzhtve7UtHKTL+m2Bu6U/s8M9BJnXniF0vUtzkzZDLb5P2czLp0iG9JuLVWtkrBQuIzhgagpcZpyQrFMW2Icj1zOCM6tiZpLCzPQtEOnSifM+k+//IzCFzzhAVNBOgl74EmWEJklE9ANghpspiUqRklUhZNGS4qezeHUhpQ+LpfkvYwhWJeMlPb6dmOo/i+CGYuq+MREBuYLyaW3RD4ZSTUsuMpMgUeDSZU0sM/em/pYl6z+BlOlAwre5HXi4ILMTrn+3tyug8Z6zmZQGWsnsMbApPqE5pLLoFlw+hXhAwawM1SIoNrR3LJN3B7YNJ1mFz8euD0nWR7f/wHLmjQru93m7w6WLujbOTcVs90NG//1tbNxyyzU8ObBLoTWgaIZ2LoM6gFtdHEyvDo5ph06+vj+/Owk/z38MDo5cz9Ph2P8cbvuUGYMn0kIWCvSKkaD5HbJ+NLxXlnsPbdzMs2EICxeMBlBXCgsYimbcMFRxiENKAnN0FfuAZs0hyVmT9xr93Gt/gBft1c+mkN0Z5zu4GvGBC8WgSJItVrwGGKyQM8M7k8/yEewcvk8vPDAjTU7UXOvpCjTGqStFOCn1VBOlBLApMPJ5WP4SjwJs9EcDGFyWRhEk2vTIv4Uy0Hagt8FDO8R6g2yiCGX2Gd5maWp0rjH33MRR0zHJJozzSKMCiSGFKTLuJyQlJzyWaZrxig4SOvzr21ei6hXGJo38lMfntb1jb82cJ7zjts+Wh5Xmttl2NWK0Se52tiHnw1f+2Y327Mb73S8fA750UH+9J/wwH1JxMv65F5K38NLZ4GU650GhluYnTNJIpWkTHOj5LeyP7MBn2zQKrTygkRFYH1n6v7lVydCq6tR+g5r+7Mj7G5mQoEsDyGBSNYYaYYyEJCAtOO4XcqSg5PxcSC6rTs0YjLmMbPwTqssDcfHEobMEGhHZnXISQ45ySEnaZ+TlF6FB6PHHM952sHvDn538LtvPwuoCIw5himXHNf6tLJCJXHEQuISTbi6kMONpbHI8DfR4jmSMCULkrXMCxxkmRI0A0pIQm2TjSrJCImnlrx8izSKjGa/NDbk/olpziYC6i5QuMZGKTjnvJhJFsVULMmoiDNv2Xm8aITiHQW/zWgnWdKi4PSBJWXxp+DBCdH5WTuFONAAkponFc2TQkLeZcqyIpadVcREewGeIfj/u9QCoBsgtyGYUGF37RsevsrsJPFzv9+yLKvBZCIPpi/euHq0lcKl90v8zSYq882gBmt7K8bPQLWfY6ssE+PC3Dbkh2N518TtcZi/uC1qu/0WPub5wLPRPggrynXG/F5d2Jmb5+hjq8Z3zXBZxIDtkmsDPlLnY1/q7Y4vee8O+xOSgDQZ8r5dXm/RRWl2alozj9OeyrvrKr0Y6/taKt51Nlyu4WolROsmylbTZ4fJ8R3W5np2uZVVren2K36kR7J3B21E3xYm3S7yIhGEDB5T/kv7LFu5/wtXX/68fKhZ53l8Fw/UfcyOA+ieo0XjjPtUokjkGTS/X/b6v3pywC/PQo8Td5gbFq25ksetfb6YQeLc99mOxi2OH1megKOjklTAEymVc55Ga6qEUPfXaXtKfsbTqMQZtCcQZ/A07C93SIQHC1oycap0cgFT0CCjllwXU539EF1MDvvYJ9CG+xS1hXEuPHR7X/ONgigzViW/A4ubYarcbDdKIw6czD18HqI2+4Zx7Agycd7MQQMBq2pOtlhivVtZ1znBwTmfzUHnBxc8xdjmx2IycphwiXeG6KDfofn9ITp41e/XLmK96YdOKZhBh884waTKQb5ufWbxGdaUcQFxl7xXGkgMlnFhCNO1mlOVaTo6ZKLi5d6TTqrVREDyl+0Tz0YRk5x7yJwu8VZAGNoRAk489ZuL0xH52+s3f739cW5taga93v39fVdPoyOIuVW6q/Ssp6cR/kW4n5yONGZ+SzIBUpkIqZI5YlKI+JRHxYWknG2CptEoi+065LjRbT8srT7TfMuwhuT6Ykx4DNLy6bI4+jRI0/oFPXcGG0wEk3e0soPHnH9ITJYkTNf3pxqBPEnMWnXUQq7x+9XVOfEoSKTiWiqaE2qY/et+3fB/7fcx+jqNt1iJJPCQCpYfTzeWwyVJKrt1Cyt24BfSjNJ8xjfpNksUuREf+xUVXvgq7IX5iYsIhjXfBRM8Jiyzc6QaFRcjwTHBhDumHJzs4GQHJws72S/b9n6q9ITHMUi/Txf+xg2RyhKGeSLEB786+NXBr3b51ZtQCjmU7vqbO06A1koTFbnOa4zvEER5BChoF6XFQ6J48LWDr+3wtXWHJmDnCh9Ypco402F2Tge0h8e1I1er7vnzGsWnF3rhzs03K5ppQQd05V1mPej1VnNl7HqwwisB694C9bGo9xJx2LtWYTKu3zj3ZLdVhwOy1uQbsSSTMSNvycXJ5RV5xyzcs6WvJZQvqwrUb/tv++FDNfY0whiH52PiV+gNrxYMCrTo1eFCtgNug3iNvQcDUYan80uc5sUzAaZBDzOUfmkQOT2H3V0kcUC0k/84Lczk7/+6cprGQHZRvWs7eWBYAaONRx6NBkK/LNfXKu1VHb2yyKp20W8UxyuIzQuGgRF/AaqONFRn7YdLov16UWsPjuZwqPC+TaDW9L4pGtAVjryjXJZybrdb5W1moU05Q70pn+fVURZdVv/GrF++AutvvM66WXkLqr+Cwm9rF1OmyplP7vHbhoiMFYU22u++2o4u52MXJCOVJJl0O6Wc5Xfea4YdiczkN74EjwDrP2XrviR75kdIXtojr7rolD5yFBvkjNt5NulGKulFflr570SoSS9hXPZyEqY3Gr6//nA8PDobj04+XJ4cver2u/bBtzQxgCVM1vhw9ala121zsasqMXjOC9LcSS082F4qGHcXvNzqVnkYvaFVGKWF0vAJow+GN3S1QgrXWqzX+NmVxOjg5raKnfi/dYf6EqSznTu0YTrynB9dIROVtW11/PHunp8xjCJI7V7Y29p+cP7x8gojTf4+NlExztHsHt/Osns6oJ/pZ4q3Bp00XRBz31dUMDnLnDlTjxf//BtMi9l5 +api: eJztHGtz2zbyr2Aw/dDOyZLSJm1O3xTZSX1xEp8fuQ+OZwKRKwk1CDAAKFuj0X+/WYCkSAmS6dju9e6YGU8kYbG7wD6wDxJLatnU0MEVvTSgiWXmhl53qEpBM8uVPI7pgE64jHH4gpkbQzs0BhNpnuI4HdBzYDqakYnSJCtwGDJmBmKiJJnyOUgSaW5Bc9b9ImmHaviWgbFvVLygg6X7yjXEdDBhwkCHRkpakBbHWJoKHjleen8YJLikJppBwtyoEJ8mdHC1pHaRAh1QNf4DIks7NNW4BsvBuBlKO2wbnCttyYSDiNf80U6BimnNFrRDuYXEPISYw7hN7WIGOTGrCDJExosKOWM1l1O66lClY9Dh+W6IcEluZzyalYjsDIgGwSzEngTiBZklKNjh+Yh26OHR+QglG8OEZcLSQf675VZAvhefEPsRTlutOhWpXOVLuq6AO6H/MwO9wJlnXqB0dY0zUzaFbf5P2ZRLJ8jabjfeVa2S8KZwGcMdURPiJOU2xTJtiXE8cjklOLey1VxamIKmHTpROmHW//TLz7j5gic8oCpIJ2F3PMkSIrNkDLpGUIPNtETBKImicLvRkKJnczixIaEfl0vyVsYQrEtGSnt5uzEU/1fBjEVRfGYiA/OV5Lu3QD4ZSTXMucpMgUeDSZU0sE/f6/JYlay+gYnSAQFv8jp2cEFmJ1w/N7eroLKesimslbUTWGNgUnVCfcml0yw4/YbwAQXY6SpEUOyobtkmbg9s6kazix8P3JyTLPfv72FR2c213m7zdwML5/TtjJs1s90NHf/1pdNxyyxU8ObOLoTWgaIa2OoeVB3a6OxoeHF0SDt09OnD6clR/nn4cXR04j6+HR7jh+tVhzJj+FRCQFuRVjEaJLdrj88d72uNveV2RiaZEITFcyYjiAuBRSxlYy447nFIAkpC3fWVZ8AmzWGJ2RP30r1fqj/At+2Vj2YQ3RgnO/iWMcGLReAWpFrNeQwxmaNlBs+nH+Q9WLn8Prxwx401O1FzL6Qo0xqkXQvAT6ugHCslgEmHk8v78JV4EmajGRjC5KJQiDrXpoH/KZaDtAW/CSjePdRrZBFDvmNf5HmWpkrjGX/LRRwxHZNoxjSL0CuQGFKQLuJym6TkhE8zXVFGwUFaH39t81p4vULRvJK/9e5pVT34KwOnOe947KPmcaW5XYRNrRh9kKkde/ezYWuPNrM9p/FOw8vnkB8d5E//CQvcF0Q8rU3upfQcVjoNhFzvNDA8wuyMSRKpJGWaGyUfy/7UBmyyRquQyhMSFYH1najbp1+dCK2uQukZ1vZne9jdzIQcWe5CAp6sNlJ3ZSAgAWmP42YhSw5Ojg8D3m3VoRGTMY+ZhXdaZWnYP5YwZIpAOyKrNiZpY5I2Jmkek5RWhYnRfYbnLK21u9buWrt7fC6gIjDmECZcclzrw8oK6x1HLCQu0YSrCzncsTQWGX4ULZ4jCVOyIFnDuMBBliFB3aGEdqhpsLEOMkLbUwleHrMbRUSzfzc29v0z05yNBVRNoDCNjVJwznkxk8yLqViSURFnXrNzf1FzxTsKfpveTrKkQcHpI0vK4k/Bg9tEZ2fNBOJAA0gqllQ0T4od8iZTlhWx7KwiJppv4AmC/7/vWgB0A+Q6BBMq7K58w8NXmd1O/NzvNyzLajCZyJ1p48ZVwzLyVtm7lFvTtsm9vRguvWHjZzZWme8m1da2t+T8Haj2c2yVZeK40NcNAeBY3nZxhyQGQO6M2+7fhfNE77k2+g9hSbvWmj/sC0V18xx97PX4thsuixiwXXJpwLv6fOxrtV/yNW/+YYNDEpAmQ9636/MN2jD1Vk9j5nHaQ3l3baknY31fT8ar+obN1my1hNjUGL5DWVzPLleSdWu6OcO7lf4NM2W4xsFHuoV/QdW9X8ubeVpcAkIG05L/0r7KVqz/rNWW+8/SQPXF7EgD9wT4tUzzoUSRyHfQfL4YMsJ6KFfysLF6FTNInKsZ29ETxPEDyxNwdFSSCnggpXLOw2hNlBDq9jJtTsnPeBiVOIPmBOIMHob96fIPuLOgJRNvlU7OYAIaZNSQ62IqKmxCdDE5nNZ8Bm24j34apCBzD908AfQ16CgzViW/A4vrtlf63o2s24GTmYfP7W6zJRXHjiATp/XoJGCF675XgyVWG2FVmRMcnPHpDHQeE2OAbOs/FpORw4RLfByFDvodmj+aQgcv+v3KMz6v+qEAGA8oPMACJ+nGUwB7c8RmTj2Yhe5Rrr1J6P2VhWaYd3i9vXWEh2Gu8YwK+z3IcF44JUIRhjOgYMSEB3YlHZnLuBuxJJMx67KUd29gYbr+qaa/PTZVIe9hQZi1mo8z6zJTfF4KNI8qdbMYUg0Rpqt0YHUGbXrTpjdtevP86c1D7K5NeNqEp0142oSnTXjahKdNeHY59X1R2J/eiPufa7duJ04N0fvMaRvlDuX46HKf97AwjZOq2pQG6ZW3n0enV20nqE2V2lSp7QS1iVGbGLWJUZsYtYlRmxj9JROjthP01+wEIeTLxs+2+exjwriAuEs+KA0kBsu4MITpyrPJ6zDS0SFjFS/2PhGXajUWkNybDw3JqYfM6RJvyNhW8oBjT/3q7O2I/P3lq9+uf5xZm5pBr3d7e9vVk+gAYm6V7io97elJhH8I95MzM41x4YKMgaytvBrNmRQiPuFR8eJ6zjZB4dUen96VwbjRbWGXjivTfEv2Q3J5dkx4DNLyyaLIa2qkafUiB5dgDcaCyRu61oP7NGxITJYkTFcVtkIgDymzRm9ehbT394uLU+JRkEjFlcA1J1TzXC/7Vd/1a7+PB6iTeIOVSAJ3qWB57rmxHC5JstZbt7DCJJ9IMkrzKd+kW7fWXIkP/YoKK3wRtsI8nSKC4bsBcyZ4TFhmZ0g1Ki7QAMcEEy6JaY2sNbLWyMJG9su2vr9VeszjGKQPtQp744ZIZQnDUB/i1q5au2rtapddvQqFkEPprklwGSForTRRkXtDL8b7qkQZExe0i7phGyi2ttba2g5bW3VoAnam8CK+VBmnOszO6ID2MF07cJXsns/XKF7Rpeeu9HG1pJkWdECX3mRWg15vOVPGrgZLfHV01ZujPObVd85w2JtWoTLuvbSZJ7stOhyQlZfBRr7rRV6Ts6PzC/KOWbhlC59RlzfwFahf91/3w3URbFiEMQ5Pj4lfoVe8ijMo0KJVh8veDrgJ4hWWQwxEGRZYznGa354xMA16mOHulwqR03PY8bsHop38w9tCTf7xrwsnaXRkZ+v7D4/uGBYxae0ysFrxpV8W9yt1+XXVfa2R6/JTv1ZKX0NsXkQRGPEvyleRhqos/XCJpF+tS+7BUR8OFYi2CVRejrwqmiZrHPmbh2XZ6Xr7lcoms1CnnKJeldc4VlEWLVR/F2G/vC2wv3GL39XSa1D1tjz8beV8ykQ59cktflsRkbGiVkr73Rfb3uX02DnJSCVJJt1JKaf53UgVxY5EZvKbAQSPAOs/ZbupJHviR0henSUvumiU3nMUB+SU21k27kYq6eV97fL/sVDjXsK47OUkTG80/HD58XB4cHI8Ovp4fnTwotvv2jvfr0QHljBZ4cPVpyo9uc3FLteBwffcNJobqYU720sF4+4iALe6Ze5Gr+jajdJCaHjVpXeGV3S5RAqXWqxW+LMridHB1fXad+K3VYf6KrLTnRvUYTrynB9cIBNrbdt6MxTvePAzhlEEqd0Le105D04/nV+gp8nvUU1UjHM0u8U7VtktHdAv9AvF2yXcbjon5n5fUsHkNHPqTD1e/PdvOyABXg== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -97,11 +97,23 @@ Pagination information about the search results. The matching user tasks. -
  • Array [
    • customHeaders object
    +
  • Array [
  • ]
    • Schema
      page object
      -Custom headers for the user task. +Pagination information about the search results. + +
      items object[]
      + +The matching user tasks. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching user tasks. -
    • ]
    +
  • Array [
  • ]
    • The user task search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx index 98c0340fb41..f3114e19fb9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx @@ -5,7 +5,7 @@ description: "Search for users based on given criteria." sidebar_label: "Query users" hide_title: true hide_table_of_contents: true -api: eJztWd9v2zYQ/lcIPm2YYjtt2nV6c51k89AfWeJ0D66BUNLZYkORKknFMQz978ORki3bcuIW3cvmAkEt8Xh3vPu+I3VcUstmhoZjemtA00lAVQ6aWa7kMKEhnXKZ4IihAU3AxJrnOEZDegNMxymZKk0KFCARM5AQJcmMP4AkseYWNGedz5IGVMPXAox9q5IFDZc0VtKCtPiT5bngsbPY/WJQ9ZKaOIWMuVEhPk5pOF5Su8iBhlRFXyC2NKC5Rk8tB+NmKO20bfmotCVTDiJZu0ODWhXTmi1oQLmFzHyLMadx19oohcqYVQQdItGiYc5YzeWMlgFVOgHdPt8NES7JPOVxulJkUyAaBLOQeBOoF2SRYeb6NwMa0POLmwHmL4EpK4SlYfXeciugisVH1H6B08rS54RrSFCHX9KkIe7S+1cBeoEzr33+aDnBmTmbwa7/V2zGpUvkRrQPjqpWWXtQuEzgkagpcZlyQbFMW2Kcj1zOCM5thJpLCzPQNKBTpTNm/auXLzD4gme8BSpoJ2OPPCsyIossAr1hUIMttMTEKImpcNE40KJ3sz+1bUkfrpbk+cRQrEMGSvt8uzFM/51gxmIqPjFRgLkjVfQW6CcjuYYHrgpT69FgciUNPIX3zXyUK1ffwlTplgRv+xo5uVZnp1z/296WrWC9YjNYgzVoWWPLpP0TdqkvWtOI8MEyWC/Iy5lN/G9Oud0Rb6x+j3k0IVnWkpvaARzFGNvqubUA7Vdx0HTIGBft893QMwoaOcAYXLq1bxaY5nhbnjbLl9UFuBceRC5SL3q957OkwRTC0fjgDWk7P4dWt2dLJpe+cuBvFqnCF/0NR5+E03eoetpjqywTw5p9W4HEsao6Zsz6IoxGWrbZ9tL4+gyRtFUm2jPmdsAHJ1Ajy81z9rEk+90Rl0UM2A65NUBsyk09dtcsa3fVHo11SBKQpkDfdyv6AdVysyIf7DxO+1bf3e7xw1x/qnR6Dm3xcIODK4ltxPA9YHFbawUSd1Y83NcdE3vOXcPzPUXnKfTdw6Jd2z0svkPdf7E4r7PdXpab42VAzw6pul8RRmTKuICkQ94rDSQBy7gwhGnAk8IDTyBpsMOZIJFKFv5rYk+1zrWKBGS/7FbtTYf65MpLVnaJBxthhnjByFsfX18OyG9nr36d/JRam5uw253P5x09jU8g4VbpjtKzrp7G+IdyP3fIKAWNcF+QCAhLEo42mSBrGBOTQ8ynPK4PS5XbBDPh1/dMYXajy63MNRBZaL7zudYnt9dDwhOQlk8XdbneME2bHw9u3wgjweQ9XWd+1+i2FVNkGdMr+mwawBOmZbZoEn3vyXlbN8Loj9HoingVJFYJuM9PVy4rQ7iIjEs8xtPwrNcLaHWop+HrXq9EnbbixzMrkQQec8GqLXVrOVySbI1btzAujWUy/lGZUZrP+LbdzgY/KxCf+xXVBDxtJ2C1SxDB4nuDGxJPCCtsilbj+qMNnBNMmCeOREeSHUn2vyfZy128Xyod8SQB6eC54hs3RCpLmBBqDsmRV0deHXm1j1ev2k6PffyetXh2FgS0VpqoOC60hgR7pMKpj8GY2nb9OXQ8KB65duTaHq6VAc3ApgqveHJlHHSYTWlIu+4Dves/1Sh2hPUDXv9gw6nQgoZ06dlSht3uMlXGluEyV9qW3QdMxQPTnEXCAxCHPatqtAgVM5F6i7tZw4HmR+6AZYVMGHlDri9uRuR3ZmHOFi6K+erCp1b9pvem16oVRfdo7F8NiV+hx1yjDtRqkdCtar3wIYpLbJUYiAvN7eIGp/nwRMA06H6BgV9hobLntOOzF6JB9eOyRsiff49ckrGGXa9v1y4eWZZ7Bq571evOxBpq289V36DRSfB3auPVfddqaLK+AfKXNr3VtUpv67pjvPRrb14r4LvSEWGq3MIrmO6GEPEE2viY9zqnu5S4GjpmxyrLCunKu5yRObcpYY2UxKIwVX9d8BiwXxEu6wjUYu/8CPnkLZLTDsLJY76u6jNu0yLqxCrrxn7a6v9IqKibMS67lQnTHfTf334475+8Gw4uPtxcnJx2eh376HuHyLqMyYYfrrvm+2Pb62xcmH7jvWsFKguPtpsLxqVrVGnhW9IIvDGtTVacnwQVb8d0uUTlt1qUJb52jRsajidrmuNTGdAUWOLT7ZtqdOD9PRmhfRQXhev2bffWy6Ce0Y9jyO2TspNG1br6eDNCUlQXyplKcI5mc7xsZnMa0s/0M6V4n40aHN/c+yUVTM4Kh1/q9eK/fwB+d73L +api: eJztWtty2zYQ/RUMntopQ8mJk6Z8U3xp3ebi+pI+OJoxSK5ExCDAAKBljYb/3lmAlCiJspVM+tIwM55IBLC72N1zAK52QS2bGhrd0GsDmo4DqgrQzHIlz1Ia0QmXKY4YGtAUTKJ5gWM0opfAdJKRidKkxAkkZgZSoiSZ8nuQJNHcguYs/CRpQDV8KcHYNyqd02hBEyUtSIsfWVEInjiNg88GRS+oSTLImRsV4sOERjcLaucF0Iiq+DMklga00Gip5WDcCqWdtA0blbZkwkGkK3No0IhiWrM5DSi3kJuvUeYkbmu7yqBWZhVBg0g8b6kzVnM5pVVAlU5Bd693Q4RLMst4ki0F2QyIBsEspF4FygVZ5hi50eURDejxyeURxi+FCSuFpVH93HIroPbFB5R+gsuqyseEa0hRht/SuDXdhffvEvQcV174+NFqjCsLNoVt+8/ZlEsXyDVv7+1VrfJup3CZwgNRE+Ii5ZximbbEOBu5nBJc23I1lxamoGlAJ0rnzPpHL56j8wXPeUeqoJ6cPfC8zIks8xj0mkINttQSA6MkhsJ5Y0+N3szRxHYF/Wy5JY8nhtNCcqS0j7cbw/DfCmYshuIjEyWYW1J7b452MlJouOeqNI0cDaZQ0sBj+b4ej2pp6huYKN0R4E1bYzev09gJ1/+1tVVnsp6zKaySNejYY8ei3Qu2oS86w4jpgzTYbMjPM+v5v77kemt6a/c71KMKyfKO2DQG4Cj62NbfOwlot4i9lkPOuOhe74aeENCKAfrg1O19nWDa411xWqcvq0twD3wSOU89Hw6fjpIGUwoH470PpM347MtuT1Iml5458DOLVelJf83QR9PpG0Q9brFVlomzBn0bjsSxmh1zZj0Jo5KOY7abGl8dYiZt0ER3xNwJeO8mNJnl1jn9SMn+dMRtEQM2JNcGiM24acZu27R2W5/RyEOSgDQl2r7N6Huw5Toj7208Lvta293p8d1Mf4w6PYY2cLiGweWMzYzhO5LFHa11kri74v627g8wvuNGdna8g44ey8v/I882gXvDOoN3B/NuVXcw/zZF64m2ovLWeLDGtvcyDROWlzJlISt4eAdzE/rL2C/bTJxCoSHBK7E/Abb5rOfmnpt7bu65+Ufk5t0e3KH6vePZv2BunuLttZl7MLjfcweD93zd83XP1z1f93z9Pe7SOOFwn6rHF0w9MmFcQBqSd0oDScEyLgxhGrBSd89TSFuIcipIrNK5r+bvqJYUWsUC8s67etugETn3M2u9xKchYYb4ibHXfnNxekR+O3z56/inzNrCRIPBbDYL9SR5Bim3SodKTwd6kuAfzvs5JFcZaITInMRAWJpy1MkEWQWImAISPuFJU6yszSYYCb+/J8jcjS42ItdK/VLzrZ9LRuT64ozwFKTlk3lD8Wuqabt4786aKBZM3tFV5LeVbmoxZZ4zvcyydQVY4bXMlm1y2Fm53pSNafTH1dU58SJIolJwP/84iq0V4SZyLrGMTqPD4TCgdVGdRq+Gwwpl2hqIT+xEEngoBKuP4Y3tcEnyVd66jXFpLJPJ94qM0nzKN/WGa/isk/jY76gB4EE3AOuThQiW3Bk8xHhKWGkz1Jo0P5qAM4IJ80hJsgdZD7IfHmQvtvP9VOmYpylIl55LvHFDpLKECaFmkPa46nHV42oXrl523R5H+A5s8ZIuCGitNFFJUmoNKfYoCCc+AWMa3c0rVH9R7LHWY20H1qqA5mAzhS1WhTIudZjNaEQH7qV+4F/VKHZk6Htsv8KX9lILGtGFR0sVDQaLTBlbRYtCaVsN7jEU90xzFgufgDjsUdVki1AJE5nXuB01HGi/TR/5Uh55TS5OLq/I78zCjM2dF4tlw1Uj+vXw9bBTKk7dIXF0fkb8Dn3OtXigEYuA7hTrJ+8juMI3dANJqbmdX+Iy754YmAY9KtHxy1yo9Tnp+N1PokH94bTJkD//uXJBRg67WHW3nTywvPAIXPWKrEogq1Tb/F4XKFolC9/TdrPsN1sOjVcdWL5parhsaxputBvdLPze2209+KxyQJgot/E6TbddiPkE2nifD8ODbUicnzlkJyrPS+noXU7JjNuMsFZIElGaur9F8ASwXhEtGg800976EfLRayQHIaaTz/mG1afcZmUcJiof1GXm5f+xUPEgZ1wOahVmcDR6d/3+ePTs7dnRyfvLk2cH4TC0D77eiKjLmWzZ4Spyvqa2uc9Ww+JX9j3WSWXhwQ4Kwbh0FTEtfBkbE++GNiprzI+DGrc3dLFA4ddaVBU+doUbGt2MVzDHb1VAM2CpD7evPdEjb++zK9SP00XpKoSbvS1V0KwYJQkU9tG54xZrnX+4vEJQ1A2duUpxjWYzbPZkMxrRT/QTpdhPihIc3tzzBRVMTkuXv9TLxX//AnBCxvs= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -57,7 +57,23 @@ Pagination information about the search results. The matching users. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching users. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching users. + +
    • Array [
    • ]
    The user search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx index e3f219e6eca..b979d5573b5 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx @@ -5,7 +5,7 @@ description: "Search for process and local variables based on given criteria." sidebar_label: "Query variables" hide_title: true hide_table_of_contents: true -api: eJztW1tv2zgW/isEMQ8zWNV2LzPb9ZubprPe6bTZJM08pAFKS0cWJxSpkpQdw9B/XxxSsiRbvsyOi8UsVCBoIpLn/h2S50hratnc0PE9vWOas5kA+hBQlYFmlis5jeiYxlxG1aihAY3AhJpnOE7H9AaYDhMSK00yrUIwhjAZEaFCJsiiWkZmzEBElCRzvgBJQs0taM4GnyUNqIavORj7RkUrOl67P7mGiI5jJgwENFTSgrQ4xrJM8NAJN/zdoARrasIEUuZGhfgY0/H9mtpVBnRM1ex3CC0NaKZRKcvBuBVKO2pbqihtScxBRLV8NKhIMa3ZigaUW0jNH2HmKO5yu02gZGYVQYHIbNVgZ6zmck6LgCodge5e74YIl2SZ8DDZELIJEA2CWYg8C6QLMk/R0ZObCxrQt5c3F+jqCGKWC0vH5XPLrYDSFh+R+iUuK4qg4ZX7UqWHxnQXBf/OQa9w5bV3KC0ecGXG5rAr/xWbc+kc2bL2yVbVKu02CpcRPBEVE+cpZxTLtCXGycjlnODahqm5tDAHTQMaK50y6x+9fIHGFzzlHaGCfFL2xNM8JTJPZ6BbDDXYXEt0jJLoCmeNEzl6MSex7XL6dKOShx3DaQNyobT3txtD938RzFh0xR0TOZgvpLTeCuVkJNOw4Co3FR0NJlPSwKF4b/uj2Ij6BmKlOxy8LevMzesUNub6W0tbdAbrFZtDHaxBh44di5oL2ipXabIS9CtO7/D/3kwhOr2O0bbYIu3nmjZk9kjj554uR8XrF1h1C/MIK5fxbcLNRrJDorxXcl47dcltQuJcCMKiBZMhRJVWIcvYjAuOknTJqSS0s0M3kn56RYtgW4ZJxUugMN+7aT+Utjkk+xtmeFhLumf1YYt+B193LXmRQPhonCHha84Er0yDmMi0WvAIIrJASBzNHU5j+p08wofLc3GCJ26s2cuMx452mGsN0tau98saTGZKCWDS0eTyGL0NnZTZMAE8a7gcsauHOSE57FewiXznfwzgdx6eGFlHvD3v2DJ+1sAQhTZhkoQqzZjmRsk/64e57Ui9LV5VeJ2RqejQ771anl870aVdg9O5dSuKxqGmShhN3zeG68dXZVTieSegkqUdQn9gKVSRekrGvHHnv2+SMzdHy70Z0s/4X2S3+th73lzWoPv/kLkqdRxG+GNHvB3h3mKLFEqLfZY3eZYpjVeHJRdRyHREwoRpFuJxg0SQgXQXOWckJWM+z3UjGAUHaf21blfWbWT5IO/AVnOgjS4n5r4jksh7jPUY6zH2JzFmQpUdPvyXRnUT/R/9RaC/CPxlod5fBPqLwPkvAmU9fCqNxeWnJNSqhM7LNX1u7XNrn1v73Nrn1q3cakEyaaddfTU3QqZvO3PnzlWFm1udyxB7Zbu0fkvAJs4M1e2SG2Kr+WgYqWwXzhqRXVXhvRbtztj2nK4mQ+Gbb77j4SL/xWh0Wo9Ag8lFeVE4ew/1aFePS+94/J3NVO77ki3RDrYv/gtShyW2yjIxrdLTlvlwrGzgubSHd3OXXHc7wYfAtNXJ6vaTa9L6BFrlVbfO8ceuoW/golrEgB2QTwZ8KJdjX5qdty9lGxlbZZKANDnKvtvsOaGh124aniw8LvujsrsG59lEP9Td88jZQlwLaZsZp/bzdtqPeyKO7wk21z0ug2zzjsQhfQ+LVQnkfPAt23snAOBY9ftYPt5T37ura3vHKOCZ966byjs8Di9OJ3WGQsgJJvtW94QTWP/1tlHM323Ad26eFaTdzFf7NszcoFTMPLYBHjMuIBqQX5UGEoFlXBjCdOOwU+c5D7yZilYH99lMq5mA9G+7++3W/Ylc+ZklX+IxTBiWBXHizHO/v353Qf7x6se/P3yfWJuZ8XC4XC4HOg6fQcSt0gOl50Mdh/iD834YkNsENCaeFZkBYVHEkScTpM4OxGQQ8piH1ZsZpdgEHdMqOO7bYt3odgm1EXm55juvkE3Ip+sp4RFIy+NVtfG2WNPmm0ruBDCeCSYfaR0Hu0y3uZg8TZluYqjBANFumc2PX11evtihjbH0z9vbK+JJkFBFUGfQkhEqkXKJ7wzR8avRKKDlG0R0/NNoVCBN9PgJmkgCT5lg5eFoSx0uSVrHrVOsyhJn8ozSfM63+Q5aaC2D+K3XqELh824Ulvs9EQwvoQsmeERYbhPkGlZviIETggm3TfYg60HWg6wbZC87jj1Kz3gUgXThucEbN7jvEiaEWkLU46rHVY+rfbj6sesIOcHKhAWNcQhaK01U6IqxEb6QLTbH9Ip3dbHtD4o91nqs7cFaEdAUbKLw05NMGRc6zCZ0TIebUsnQX9covoKuF6CNKx/mWtAxXXvEFOPhcJ0oY4vxGt+1KIYLdMeGBKqIwx5ZVcS4z1YSz3XXczggG+/xXbA0lxEjr8n15c0t+ZlZWLKVs2S2+cKkIv169HrUSRWn7qE4uZoSr6GPu0YuqMgiqDvJ+smnEHb1eANhrrld3eAyb54ZMA16kqPxN/FQ8nPU3V3dTaJB+cu7Kkr+9dutczTmsev6+57LJ5ZmHoX12+6tgtSoqiHVoVfWhOoHdV1m1F0+GTVLG/W6VpXC6hzQqM5T95vvdDZFjYf6yxX/sclo8znIaOszjfu1N2Hzcwh8VjhMxcrZr4z4XU+ghqCNd91o8HwXXVdTlyRClaa5dDuFnPsWDGt4NhS5KRulgoeA9Y/xujJmNe29HyF3niN5PsCo9NCpNog5t0k+G4QqHYZ+2eb/mVCzYcq4HJYszPBi8uunD28nz95PLy4/3Fw+ez4YDeyTLygjgFMmG3K4+kxd9NzWdV3vi2f5tKyMWgtPdpgJxl0P1Gm7LtPKPW0KUyaWh6BMDvd0vUYGn7QoCnzsKkR0fP9Q5xL8qwhoAizywUAfMQbphdfk2S3KUEfxTvsFe51+xSQMIbMH5z400uPVx5tbRF753VyqIlyj2RK/qWNLOqaf6WeKHX1nXQdq93xNBZPz3EU39XTx338AIIl/bw== +api: eJztXFuP2zYW/isE0YcW69jOpW3Wb85k0vUmTWYzk/RhMkAo6dhihyIVkrLHMPzfF4fU1ZIvbRxsu1CAQWYk8ty/c0geSRtq2cLQyS39yDRngQB6N6AqBc0sV3IW0QmdcxkVdw0d0AhMqHmK9+mEXgPTYUzmSpNUqxCMIUxGRKiQCbIsppGAGYiIkmTBlyBJqLkFzdnwk6QDquFLBsa+UNGaTjbuT64hopM5EwYGNFTSgrR4j6Wp4KETbvS7QQk21IQxJMzdFeLdnE5uN9SuU6ATqoLfIbR0QFONSlkOxs1Q2lHbUUVpS+YcRFTJRwcFKaY1W9MB5RYS80eYOYptbjcx5MysIigQCdY1dsZqLhd0O6BKR6C757tbhEuyinkYl4RsDESDYBYizwLpgswSdPT0+oIO6MvL6wt0dQRzlglLJ/l1y62A3BbvkPolTttuBzWv3OYq3dWGuyj4TwZ6jTPfe4fS7R3OTNkC2vJfsQWXzpENa59sVa2SbqNwGcEDUXPiPOWMYpm2xDgZuVwQnFszNZcWFqDpgM6VTpj1l54+QeMLnvCOUEE+CXvgSZYQmSUB6AZDDTbTEh2jJLrCWeNEjl7M6dx2OX1WquRhx3DYkFwo7f3t7qH7PwtmLLriIxMZmM8kt94a5WQk1bDkKjMFHQ0mVdLAoXhv+mNbivoC5kp3OHhX1sCN6xR2zvW3lnbbGaxXbAFVsA46dOyYVJ/QVLlIk4WgX3B4h//3ZgrR6XWMtuUOaT/WNCGzRxo/9nQ5Cl6vYd0tzD2sXca3MTelZIdEeaPkonLqituYzDMhCIuWTIYQFVqFLGUBFxwl6ZJTSWhmh24k/fSMbge7MkwLXgKF+d4N+yG3zSHZXzDDw0rSPbMPW/Q7+NK25EUM4b1xhoQvGRO8MA1iItVqySOIyBIhcTR3OI3pd/IIHy7PxQkeuLFmLzM+d7TDTGuQtnK9n1ZjEiglgElHk8tj9Eo6CbNhDLjWcDmirYc5ITnsV7COfOd/DOBXHp4YWUe8vegoGb9oYIhCGzNJQpWkTHOj5Nf6YWE7Um+DVxFeZ2QqOvR7o1bn1050aVfjdG7dttvaoqZIGHXf125Xl6/yqMT1zoBKlnQI/ZYlUETqKRnz2q3/vknOLJeWezOkH/G/yG7Vsve8uaxG9/8hcxXqOIzw+454O8K9wRYp5Bb7JK+zNFUatw4rLqKQ6YiEMdMsxOUGiSAF6TZyzkhKzvki07VgFByk9du6tqy7yPJB3oGt+o0mupyY+5ZIIusx1mOsx9hXYsyEKj28+M+N6gb6P/qNQL8R+NtCvd8I9BuB828E8vPwmTQWp5+SUIsjdJ7P6XNrn1v73Nrn1j637uRWC5JJO+vqq7k7ZPayM3e2tirc3OhMhtgra9P6LQYbOzMUu0tuiC3Go2Gksl04q0V2cQrvtWh2xnbHdDUZtr755jseLvKfjMen9Qg0mEzkG4WTe6indTRaDZgSpac28I52Bbn0gYO/s0Blvq/ZUO1g++NPkDossVWWiVmR3nbMj/fyBqBLm7i3d8m53Uk+BMadTli3n12T1yfgIi+7eY4/dh19AxjVIgbskHww4KGQ3/tc79x9ztvQ2GqTBKTJUPZ2s+iEhmCz6Xiy8Djtj8ruGqRnE/1Qd9CH+g5iG0gtR+xGDN8TLK57nAdJ+YzEIXkPg7KAo7PhYUy2Vl1luefgVy8F8dkeWk0Njx12H0u/e47zPlZHecco4BL3YzeVV7j6XZ5O6u9XVNBJ6MSO2PvzTdyWOmc4D2rR/Fabo/0HYnWbNSHfWX4LUG8HjYK5lNEwZEkmIzZkKR/ew9oM/SMg//jKYkpew5owazUPMnw6ghl8tgQ0D2ur7QhSDXlkWZ1BX4D7AtwX4L9UAT47jvui3RftE4v2odR2vjJ+iMs3LuwHjhW6Lf3W1ebXsDYnF/3GlBPKv4+hry3//V66L+V9Kf9rlfJ+L92X5X4vfb69NI58tu/4OjPoSWbumwVyzriAaEh+VRpIBJZxYQjTtdZDlek8dAMVrQ+eeqdaBQKSoxV7Sq78yJwv8cjFFb0fGHjut+9fXZB/Pvvx57vvY2tTMxmNVqvVUM/DRxBxq/RQ6cVIz0P8wXE/DMlNDBpT15oEQFgUceTJRD2FmBRCPudh8Z5ELjZBvzQe/9lXZN3d3QeaaqUy07z1QteUfHg/IzwCafl8XZTeBmtaf2/IrQEmgWDynlZx0Ga6y8VkScJ0PSBrDBAoltnseCPx6ZMWbYylf93cXBFPgoQqggqdOSNUIuES3+Chk2fj8YDm7/PQyU/j8RZposdP0EQSeEgFy5dHO+pwSZIqbp1iBeTO5Bml+YLv8h020JoH8UuvUYHCx90ozCs+EQxbwksmeERYZmPkGhbva4ETgglXaHuQ9SDrQdYNsqcdKymlAx5FIF14lnjjBtcqhAmhVhD1uOpx1eNqH65+7FpCTvFswoLGOAStlSYqdI9GRfh6tCjXvAXvYmvbLxR7rPVY24O17YAmYGOFH4JIlXGhw2xMJ3RUHraM/HaN4gvhegnauNORTAs6oRuPmO1kNNrEytjtZINvPmxHS3RHSQJVxNseWUXEuI9IxJ5r23N4Q9beqrvwx7LkOXl/eX1DfmEWVmztLJmW33soSD8fPx93UsWheyhOr2bEa+jjrpYLCrII6k6yfvAphN3TcQbCTHO7vsZp3jwBMA16mqHxy3jI+Tnq7nzDDaKD/JdXRZT8+7cb52jMY++rr21cPrAk9Sis3j1vHHaMi/cZq9DLj5mqC9WRxrj7LGJcPw6q5jVOdrAHhkZ1nrotv5pRHj7cVd+R8J9+GJcfZxjvfDThduNNWP84AV7bOkzNlbNfHvFtT6CGoI133Xj4uI2uq5lLEqFKkky6SiEX/oFIVvNsKDKTP7YseAh4/lGe8ZVs3/g75KPnSB4PMSo9dIoCseA2zoJhqJJR3nko/w+ECkYJ43KUszCji+mvH96+nD56M7u4fHt9+ejxcDy0D/5IGQGcMFmTw53PVMemu7puqrp4lg+95FFr4cGOUsG4eyLZabvJ08otrQuTJ5a7QZ4cbulmgww+aLHd4mV3QkQnt3dVLsG/tgMaA4t8MNB7jEF64TV5dIMyVFHcehgSnzz2M6ZhCKk9OPaulh6v3l3fIPLyr9gkKsI5mq3wCzdsRSf0E/1E8fl6Z10Hand9QwWTi8xFN/V08d9/AYJ9AEc= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -97,7 +97,23 @@ Pagination information about the search results. The matching variables. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching variables. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching variables. + +
    • Array [
    • ]
    The user task search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx index 1a376170168..bc9719028d9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx @@ -5,7 +5,7 @@ description: "Retrieves the current authenticated user." sidebar_label: "Get current user" hide_title: true hide_table_of_contents: true -api: eJztWMty2zYU/ZU7WLVTRpRTN3W50zhO6tbNeBy5XbhegOAViRgPBgBtqxr9e+cClETJUu1mssxCQxGPcx/nXDy4YIHXnhU3bNKFBk2QggdpDbvNmG3RxZfzihWsxrAzJGMVeuFkG98KdoXBSbxHD6FBEJ1zaALwzSSsoPPoRixjDn1rjUfPigV7PR7TYxttOsCgWSA9+E4I9H7WKTUHh6FzBiuCE9YENIFQeNuq3sP8kyeoBfOiQc3pX5i3yApmy08oAstY6yjKIJMjZIeC3efL+VuwsxjZKoYeywcnTc2WWZz+O873z/dzH1BDjYayihXc4fwAojQBa3QsYzPrNA+p6c0x2aikbxWff+Aa99vpB4DhGp/1mMixTv6D1WSTNr8feJBYv0YlVjYgECy1Dkxx5/icZUwG1H5AwMqFZcYCGm7CAaN957Y90KhLdGBnL7B0gOoEnMje9mlX1tvkp3kjSp7pOXh++pCLNcCSgq+d7doDsac+4N7L2qTk7iHzBRl2VuEBG7HrK5jwXKG/VNxMY9c+U63i5llBipMLae4OOKuoa+WjsLq1Bkkc0sSW0xPwgYu7LxfFlzG69iSqgpx8HmMSg3kSy0oWgpsLW9suPE3EO8VrmFkHnanQ+cBNJU0NcrZdI6VCQm/R0RoCKqINMlNaq5CbuAi08tqj+2JTBiaX57uUrvGpwmVQ1HbKdWcqHo2lOI/HRwd0iZ879AEUF3ce7rmS1XAnkdaAcFjRK1f+P7aA1tlSof7h6VawS8hlGgkVBi4VJIkA95AGlliR0G6u3p3CL8c//Xz7XRNC64s8f3h4GLmZeIWVDNaNrKtzNxP0o3Hfj2DaoEPQfA4lAq8qSTa5go34wLco5EyKlSJ6t4GyOfrbbPJ6aDnry25XdesNpHNyjwivr85BxizO5kTtE9Nxzox3ijB4abtQlIqbO7ah9Xmp+05r7ta73bYBWjwCD92wPPdvgD++3luKv06nl5AgQNgKo2JDI/3KEAWhpZG606w4Ho8zpvljenszHtOeGhl/QSQG8JGWsSTAnXCkAW0d9vqJgUlDRSO+FjPWyVru2h1tlVgv4rcpolRkP+07Xk0MUJYd6RCdsw6siMetCh4aqSI8nbVWtvuCTFr8Vmvfau1brT2ttWXGNIbG9vclUg4PDStYvr135RpZxjy6e3R0+VqwzilWsEWqmGWR54vG+rAsFq11YZnfEx333Ena1yN71J0qa6UYZQVXsXkfc9QxPLT0ezGcwNXZxym85wEf+DxmkkxuQ5+MT8Z7UWnoAUQ6E6QIk+4Ga8EKlop6L2wa/BLg5fKWEik6J8P8I01L6SmRO3R0YR3oobcX0eMZJQ5iWf/n3Uolv/01jURLM7Nx+vb5ZeAIsYLOJ8/Ho6On4ro8jzUirNadifSbGh5kaIAPAhOq8yGdn5QUaDxujqNrsxepB/5MFuFoRKQk5azWx1qGpitHwupcpGnrZ6lsmWsuTd6b8Pnp5I/rD28nry7OT88+fDx7dTQaj8JjiMG31gfNzcCP9xi2buS7wS42+8L/+hbQsxPwMeSt4jIeSmNYi75+bhjf/fSgkT5RpCq4YYtFyT1eO7VcUvPnDt2cFTe3m6Kht2XGGuQVHXVvFuyObupsIgS2IVaX6uKVYff7ASlsXdXvz0ga/wIiCPHv +api: eJztWUtz2zYQ/isYnNqpQsqpk7q8qY6TunFdjy23B9UHEFxRiECAAUDbrEb/vbMAJZESVbmZXNrRwSMTj29f3+6CxII6lluaTOiocjNQTnDmhFb0YUB1CcY/XGY0oTm4rSUDmoHlRpT+KaG34IyAR7DEzYDwyhhQjrDNJshIZcFEdEAN2FIrC5YmC/p6OMSfLtq4hYG7iLDEVpyDtdNKypoYcJVRkCEc18qBcojCylI2GsafLEItqOUzKBj+5+oSaEJ1+gm4owPKpPxtSpPJtvSfmAVSGnSBE2DJVBtyzopKZey+MWEbarMaBaHK6Lc+sy7fET31Tqq6WNYZoXK6HNBM2FKy+poV0I/RLCCKFXAQDWOgjfgLstHGO7YfuOU/u0ZF529AiNM42hLFjGE1HVDhoLAtP69UWA6oA8WU2yO0mezKIwUUKRiipy+QtCcMATgEoqvTNnu7gQn7InSeamJweHs7FmuAJRqfG12Ve2wPc4RZK3IVnNsTzBd42GgJe2T4qa8gwjIJ9kYyNfZTfaJKydRBQvKzK6Hme5SVOLXSkeui1AqQHEL5kfMzYh3j8y8nxZdFdK2JZwUqeRhj5I3ZsWVFC87Ulc515XYd8V6y3FedSmVgrGMqEyonYtrNkVQCopdgptoURHq0lmdSrSUw5YtAKbB0fbEoRUY3l9shXeNjhgsncaxVJ7GM0uVDX3H8CHV/+G1tHRQkB4XtBzIyh/oAofqF+/F2O3hUWcTDfMRKEc2htpGqsMh8t9sqMigN+K5FE2cq2K34x+ZxbB7H5nFsHsfm8V9sHkI5yMHQAUXrmQtDb0/3qXPtG8VHqO3LGkuIak9jObaRYxs5tpFjGzm2kf9DGzn4DoIzp8OTPUkBnyuwjkjG55Y8Mimy9hczoRXhBjJ8ZNL+w6eu0uhUQtH7HtNlw01YSTJwTEgS+EmYJWFhChmyfHL7/pz8ePrmh4dvZs6VNonjp6enyEz5K8iE0ybSJo/NlOMfrvs2IuMZGCAFq0kKhGWZQJlMtnuYLYGLqeArOjZqE3Rm9Kc62NJck/PblF+38MqIngy4v70kwntxWiOvdkT7PVNWScRgqa5ckkqm5nQT1sN5ZquiYGZNlK4ArFyOuapdG/qPIN+/7q0DP4/HNyRAEK4z8OniZsKuBKERhVCiqAqanA6HA1qw5/D0djjEhu4j/gJLFIFnrKGBgFvmCEUKbaDhjzdMKMxY/rUio43IxbbcqJNiDYnfBYtCkr3p+4w8UgS9bJCHYIw2RHP/WTkjTzMhPTx+U17JbhIycPGYa8dcO+babq4tB7QAN9PNvRAyh7kZTWjc7V1xAXRALZhHMNa/4VRG0oQuQsYskzhezLR1y2RRauOW8SOG45EZgYcKHz2cDpm1YozUnEk/3Bc5nGifmJpeTM7I7cXdmHxgDp5Y7T2JIrvQZ8OzYS8qLt2DiAeSYGHgXasWrGAxqXthw+KXAC/xAGOBV0a4+g63BfekwAwYvJhr8aGR59H9AckvooPmn/crlvzyx9gHWqip9tu755eWIhgVMDZoPoxOdsl1c+lzhOuiqJQPv8rJk3AzwlqGcVlZF45PUnBQFjZn4bXYqzBDfg8SyUmEQQnMWdXHXLhZlUZcF3Hz4r3+TaVO44IJFTcibHw++vX++t3o1dXl+cX13cWrk2gYuWfnjS+1dQVTLT0+gOvcPG4bu9j0hX9159lEx8Gzi0vJhD8Re7MWTf5MKNu+Yi0Ar2JDFkzoYpEyC/dGLpc4/LkCU9Nk8rBJGnxaDugMWIbn7MmCzvGQS0ecQ+l8dsnKv69s35Miw9ZZ/eECqfE3LgNv/g== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Retrieves the current authenticated user. The current user is successfully returned. -
    Schema
      tenants object[]
      +
      Schema
        tenants object[]
        The tenants the user is a member of. @@ -45,7 +45,23 @@ The tenants the user is a member of. The links to the components in the C8 stack. -
      • Array [
      • ]
      +
    • Array [
    • ]
    Schema
      tenants object[]
      + +The tenants the user is a member of. + +
    • Array [
    • ]
      • c8Links object[]
      + +The links to the components in the C8 stack. + +
    • Array [
    • ]
    Schema
      tenants object[]
      + +The tenants the user is a member of. + +
    • Array [
    • ]
      • c8Links object[]
      + +The links to the components in the C8 stack. + +
    • Array [
    • ]
    The request lacks valid authentication credentials. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx index 041e88e477c..3d368a39766 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx @@ -5,7 +5,7 @@ description: "Returns a decision definition by key." sidebar_label: "Get decision definition" hide_title: true hide_table_of_contents: true -api: eJztWU1v2zgQ/SsDnlqsYjlt2u3qZiRpN7ttEaTp7iGbA0WNLDYSqZIjO4ah/16QlGwnlpO0CPbkg2FTGs7neyN5uGTEp5YlV+wEhbRSK8gwl0qS1IpdR0zXaLhbnGUsYVOkXu5kLRaxDK0wsvarhF0gNUZZ4JBtK4V0ATe4GP3n9tXc8AoJjXNhyRSvkCUs2zLxNy5YxKRTXnMqWMQMfm+kwYwlZBq878FlgcCtlVOFmbMGOgcqcMifCOaFFAVwQRa4c7pR8nuDIDNUJHOJBnJtgAppV/tHLGJWFFhxliwZLWrntlSEUzQsYrk2Fadw6e0Ra9tr57CttbJo3Y5X47H72nZ6KGHSgm2EQGvzpiwXYHx6MQspFFoRKnLqeF2XUvhqxd+s07nc9lKn31CQy71xtSUZPBrO+ROCeyz1v5TfjfBHrI0GvHNwXDlnyUg1HXTl5NNnODt5oP5efwDeU/U56cc0ztBYGUrwYAZfv3o4g52ex8z11y8CLSpUZJ+SItqdIrOhCqaG1wVQwWmXGw6mNTcEOt/p0TNB6rldJVRc0VMRFaQfBZXTK6l0yrZb5hlhxdrWCR39TCtwgaIlyLksMRvBJ22cIHFZWuAGoTZ6JjPMQCrvW991INXZ4sGGURudllj9tt047ro2gfMg2dmF0FActYNgGqxfXbw/hj+O3vx+/aIgqm0Sx/P5fGRycYCZJG1G2kxjkwv3cXIvR3BZoEGo+AJSBJ5lPmhewrpVga1RyFwKIO0D7NwGV7cQ38N9LtzdrvMKgo2RW2WfwNeLs75hLaSabpv2e3LelE4HT3VDSVpydcPWOHgMXBOwTVVxs8L3XQNtxCxxauyv9pQ/Ly/PIagAoTNct93OkAuikkpWTcWSo/E4YhW/Dau347HntKv4EyJRgLd1yZWH1v1wpIJqjVsfmFSWuBLPVRlt5FTet3uXkx2IT0JEPRUPh6nY067k4sbCjJcyA95Q4awG+oAw6J3gpR3tSbYn2Z5kO0n2ehvv77VJZZah8vBc8U1aUJqAl6WeY7bn1Z5Xe17t5tXRI++Rc0mF1zmVM1T+RXrOA8Ny3aj96+SekXtGPiMj3wz9s5socFk2DodojDaghWiMwczNSUqv3o16etvdo3DPtT3X9lzbxbU2YhVSobsRtR8sU8ESFvcPv4P1EMXGy8FhZ+tmumhm/TC6MSVL2DKQqU3ieFloS22yrLWhNp65Ss24kTwtAz7d7UC6HkylFrz0l4eK6m5sjhKPedWojMM7uDj9cgkfOOGcL3ySncm7qt+N340HtTrRHRon52cQIgyQ3GgTvVrH90G1Qfgpiv2026JojKTFF7ctpCdFbtBMGleYFVQ6e167WwchFnU/3vcA+uvfS48BqXLtt3dY2HaEbcxe2Xh0uI278zNPH6GrqlG+h6ppeDniG4GJsrHkAopYKQUq6xHenVD0Yh/DHfinm9IejlxRAnL61jmVVDTpSOgqFmHb6jstdRpXXKq4M2Hj48mnr59PJgcfz45PP385PTgcjUd0Sz74WluquNrw4wPS0JzwfszL9ZPjJw5nuhIR3lJcl1wqBxof27Lj1xUb4heLWDJ8nHAddSS5Ystlyi1+NWXbusvfGzQLllxdrznlSZhJ635nLMl5ae+f82zG9aIbNGcv4f84/RlMTneRq4XvDWXjVixiN27uveOIpb1uI1Ygz9D4iIPsRAisaUPL1tmOY9mq6X04dfT4Abf9p6g= +api: eJztWltv2zYU/isEn1pMkZw27Tq9eUnaZW2zIE23hywPFHlksaFIlaTsCIb/+0BSviSSYzcoiqHQQ+BIOjzX7zuiSM6xJROD02t8ApQbriRikHPJLVcS30RYVaCJuzhjOMUTsEu5k7VYhBkYqnnlr1J8CbbW0iCCWFcpyhp0C038rxtXEU1KsKCdC3MsSQk4xaxj4j00OMLcKa+ILXCENXytuQaGU6treOjBVQGIGMMnEpizhlSObAF9/kRoVnBaIEKtQcQ5XUv+tQbEGUjLcw4a5UojW3CzGh/jCBtaQElwOse2qZzbXFqYgMYRzpUuiQ23Xh/hxeLGOWwqJQ0YN+LFaOR+uk73JYwbZGpKwZi8FqJB2qcXWEghVdKCtE4dqSrBqa9W8sU4nfOulyr7AtTiCBMh/sp92u+78TsxgCrtCm85GB98t+hnFkqXhYda1wNDgJ1xbMMXYzWXkw5+XCJOPp6js5NH6hbjRdQCZl99TnqXxilow0PqHi3ryxe9Zlaga/XsMre8fxngXIK0Zp8U2e0p0huq0ESTqkC2IHabGw5eFdEWqdx7ZEESafctU5DeWSmnl1vhlPVDyYEOO5rswo/rBHt5tkn/J3F8n1I9yZvvW7GdqfUim61hKllMSVlLRmJS8fgWGhPLusxA/9JtGwwqDZTYdasdGsnQSH62RrL13f0/aS1P9u8HN5tz30beQ2P2azsBET1tZ2gyQ5P52ZrMMFvZa7bihI6+5QPJeQTGopxwASxGH5V2gpZwYRDRvj9MOQOGuPRuLr/FUKZY8+hnVKVVJqDsnRdtujZGF0GytYtCi3HlC4JZsH59+fYY/Xb06tebZ4W1lUmTZDabxTqnB8C4VTpWepLonLo/J/c8RlcFaEAlaVAGiDDmgyZis+uZCijPOUVW+QBbt5ErdYjv8c4XnnahseohteYdpIzR58uzJSgbLidd035MTmrhdJBM1TbNBJG3eI2DXXgcI1OXJdErIN43sIiwscTW5qk98I+rqwsUVCCqGKyp1RpyQZRc8rIucXo0GkW4JHfh6vVo5KnmKr5HJBLBXSWI9NB6GA6XqFzj1gfGpbFE0u9VGaX5hD+0e5+TLYhPQkRLKh72U3FJO0HorUFTIjhDpLaFsxrog6gG7wQRJh5INpBsINlWkr3s4v2t0hlnDKSH54pv3CCpLCJCqBmwgVcDrwZebefV0Y555Izbwuuc8ClIP+OdkcCwXNVymE4OjBwY+R0Z+arvy24skcuydjgErZVGitJaa2DuW1h49W4DbGm7fRUOXBu4NnBtG9cWES7BFqrduPfb7bbAKU6WL7+D9SKKSea9y1cLt9MNerrcoq+1wCmeBzIt0iSZF8rYRTqvlLaLZOoqNSWak0wEfLrHgXRLMAlFifC3+4rqHmwufR6HJWP0Bl2efrpC74iFGWl8kp3J+6rfjN6MerU60S0axxdnKEQYILnRJpZqHd971QbhfRT7MwAGaK25bT65YSE9GRANely7wqyg0trz2t11EMJR+8/bJYD+/OfKY4DLXPnhLRa6juCNtWI8ig+7uLs48/Shqixr6XuonITJEdkIjIraWBdQhAWnII1HeHtuYyn2ITxBf7eryoexK0pAzrJ1Trgt6iymqkzaTYHVbyZUlpSEy6Q1YZLj8cfP5yfjgw9nx6fnn04PDuNRbO+sD75SxpZEbvjxDmzfOuHDmOfrN8c3HFlpS2ThziaVIFw60PjY5i2/rnEfv3CE0/4F4puoJck1ns8zYuCzFouFu/21Bt3g9PpmzamwBcKN+5/hNCfCPDz9shnXs3b9lz1HP+JMTG9y2ptENr43iNpd4QjfuuXoLYvmi5tFhAsgDLSPOMiOKYXKbmjpnHhxLFs1vXenjh7/AaXi5a0= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Returns a decision definition by key. The decision definition is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The decision definition request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx index 3cc41b3ca67..79b4c2e8fb2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx @@ -5,7 +5,7 @@ description: "Returns a decision instance." sidebar_label: "Get decision instance" hide_title: true hide_table_of_contents: true -api: eJztWltz4jYU/isaPbVTB9ht2m7pEw1kS5tlU0K2nclmWmEfsLq25JWOkzAM/71zJBscbCDZZvrEQyaAj75z/Y5uXnIUc8u7N7wPobRSKyaVRaFC4LcB1xkYgVKrYcS7fA5YSg1LoYBHYEMjM5LiXT4GzI2yTLBoG7D1UfGAZ8KIFBAMaV1yJVLgXR5t4Q4jHnBJgJnAmAfcwOdcGoh4F00O21onMTBhrZwriNiwz/SMYQx1EwJ2H8swZiJEywRZmSv5OQcmI1AoZxIMm2nDMJa2wQEecBvGkAreXXJcZGS5RSPVnK9Wt2SkzbSyYOn5606H/tUNreEyaZnNwxCsneVJsmDGBREiH7FQKwSFBCayLJGhy0j7H0uIy4pFIknez1xUC9v09B8IkYJuKJMovWXbwf4NFhWHpEKYg+EBn2mTCvQ/fX9aSzX58gkWO4PdYiONwDAW6AMqLVManXA97AUKfccFk2ghmf3kfvq7Xhx/MwvmDlwOSSQzMhVmUcFr8VXQVFW1xDV5taeCHK5FgdCcXPdoz+iAg8pTItzgQ+/iujcZ9HnAz3vDC/fhenR1OTgbng+Lb7+N3v8xIiaixISs3ibgFekbEOQq4HAnktxVR78wcNvXdUojgXCCMq0zmLzYALFovz+PtJ4LmeSmUfFeHTM/br+azGhiSB9mUkka9jJlW8CyaI1b1fayFCl1PfKr9PalHStxdyh5Phf670aHQEeumz8Flvr+M4A/gLHS97u9Yfn2daO2Oz/8iaGZOA1N7CbddZANp/uDs+HV8P3or0nv54sBD/jFcDIY9y7+Gvx5OR5c0aPnkPyxSSXLDdg8waeF2cvuJxaCEgqfWg9e+kCLXO1uWEME8uLQHFV0B4iGKsvRVmwTxogFrQ4Q0urva6DHNveqBmY5+vnoXli2VsHuJcZSbc36m/7UqlnnkHzE9jFmo+GxDQS4tXwIPGZJoP2EeT7uB5HkO4AJ60uQKzkelKM2yab4+Ezvbv0QeXC7u5Q+KkJIBYYxROM8gZepBJMnxcKkgH5+CRDE4Qoo4Um6MTsORkXw0Iwk6dEBsJ2dcDM3Q/Q+x5JH+/Kxdl17+YqaZ0b7MO7jePoHX8QpP7QxvP7RF7PqIPJ/4NVO7H3E8mn0zKoKvvOlUYoRU3bTr1pHB7jntjW7WvlbwN9zMItxse0h8VXAT5++8aFdHVh0C0CIWuydNiSGQiaWCeNWTHcyco3CWVnusNhUR4u926PM6GkC6Tf1bdJ2V7j0koVe5uuZdhZecOq134zPz9iPp9/9cPtVjJjZbrt9f3/fMrPwBCKJ2rS0mbfNLKQ/kvu6xSYxGAr3gk2BiShyU7lI2Kbymc0glDMZMtTlEtEZQzXh/ds/T2KxVtm50M+NbOiE1+NhuVlaSDWvq3ZjZsItNLiY6hy700SoT3xTdIdWCz1m89RtyzbL34qCYh+V2y9d1P0ymVwyD8FCHcFm514oIidSqWRKi7PTTocmkgf/7ftOx1GDMv4ETxSDhywRym9XttyRiqWbum35Obc4HnmZzGgj53Jb7+NlVlHEfe9RScRXzUQsaZeI8JOlRiUjJnKMSaunDwsNOCNE4nr1kWRHkh1J1kyyb+v1fq7NVEYRKFeea74VB2AiSfQ9REdeHXl15NVuXp0+dRVJezcHPpd3oGivQNt7YtpM5+q4rDwy88jMF2Tmd037ux7xEcFQHYIx2jAdhrkxdLQSy2R99l3qLqbEI9eOXDtybRfX6OgTMNbF5bu7PceYd3m7nARPSjNte1m/7VzRhTVdlBaX7blJeJcvPY9W3XZ7GWuLq+4y0wZX7TtK0p0wUkyLg1Z67PlW1lGiQ5G4n5vySQ+qR2pnIs1VJNgbNh5cTdhbgXAvFv6CTZst6DedN51GVBLdgdi7HPqrYH/hW+0QJSxRvRHWCz8F2J2CWQhzI3FxRcN8eKYgDJheTjlZV0mhz6HTdy/Eg+LDeVk7v/4xcemXaqbd8KIM6oZQVsr7L95pvaqX3OXQMSfUaZor1z7V3C+LRMWxMMktkkMBT2QIdGLXXb+BUYpd+CesuHFjr1qUFF85ZdecS4zzaSvUaTv0w9b/p4metlMhVbtQYdtnvXfXo37v5GJ4NhhdDU5etTotfEDnfKYtpkJV7HgLWF/ibXu83EwZh984KfKC8IDtLBHSXSk4h5YFn254nU884N2G9wdug4IUN3y5nAoL1yZZrejnz3QUyrs3txsOOdJF0tLniHdnIrHbr65UPflqXLzk8jX7/15oaYxOeeSvFq4juDNuzgP+iW6mm16rWN2uAh6DiMA4p71gLwwhwwpE7f0VIta6xb0dECP+Bad8t7U= +api: eJztWt9z2kYQ/ldu7imdykDStE3pEzU4pXGIi3HaGdeTHtKCLpHulLuVbYbhf+/snQQyEmAnmT7x4DHS7X27e7vf3i8tOYq55d1r3odQWqkVk8qiUCHwm4DrDIxAqdUw4l0+ByylhqVQwCOwoZEZSfEuHwPmRlkmWLQN2PpH8YBnwogUEAxpXXIlUuBdHm3hDiMecEmAmcCYB9zA51waiHgXTQ7bWicxMGGtnCuI2LDP9IxhDHUTAnYXyzBmIkTLBFmZK/k5ByYjUChnEgybacMwlrbBAR5wG8aQCt5dclxkZLlFI9Wcr1Y3ZKTNtLJgqf1Fp0P/6obWcJm0zOZhCNbO8iRZMOMGESI/YqFWCAoJTGRZIkMXkfZHS4jLikUiSd7N3KgWtunpRwiRB3taMkMxRultbghDzdOmsd8z5C2+CrhFgdA8Gq5pT++Ag8pTytDB+975VW8y6POAn/WG5+7H1ejyYnA6PBsWT29G7/4aUeqixISs3s7YS9I3IMhVwOFWJLkbzn5h4LavM21SgZShAuEEZVpPefJiA8Si/f480HomZJKbRsV7dcx8v/1qyrd9mEklSxY/LZz9t6M1+g7QkWPwY2CJ608Afg/GSp/jBbZUCHMw1bBIhT+8aNR267tvj9EOZROnoSlBSXcdZJOW/cHp8HL4bvRh0vvtfMADfj6cDMa98w+Dvy/Gg0tqekqePjSpTFQDNk/wccPsZffnBoISCh+bD176AMtXuzk3REh/ExY4Fcn9FecNLB5n0ydY7LaGjTQCw1igL+XSMqXRCdcLfoFCz7hgEi0ks1/dq3/r9fBfZsHcgps9SCQzMhVmUcFz45sZTeV8E8wv8asAYdEapYr9NSNWIh+oF18TjMMZwVfBofmoKHkQDVWWo60YI4wRC1ojIKTV92ugh0b2qkmS5ehz405YtlbB7iTGUm3N/Zui26pZ55A8h/bV0I2GhzYQ4NYiIvCYZUndX0KfjvteJPkOYML6EuRKjAdlr02waXx8pHfPZxB5cLubzv8oQkgFhjFE4zyBb5MJJk+KIlFAPz0FCOJwBpTwJN0YHQejIrhvRpLUdABs59y4WXBA9C7Hkkf74rF2XXv5iponjvZh3Ifj6Ru+iFO+a+Pw+qYvZtVB5K/g1U7sfcTyYfTMqgq+9alRihFTdtOvmkcHuOc2N7tK+WvAP3Mwi3Gx+SHxVcBfPn77Q3s7sOhWtRC12FttSAyFTCwTxk1XtzJyhcJZWe6z2FRHi72bpMzoaQLp9/XN0nZVuPCShV7m85lmeS849dqvx2en7JeXP/588yxGzGy33b67u2uZWXgCkURtWtrM22YW0h/JfddikxgMDfeCTYGJKHJTq0jYJvOZzSCUMxky1OX87IyhnPD+7Z8nsVi97ty95EY2VMKr8bBcuCykmtdVuz4z4ZaeXEx1jt1pItQnvkm6Q8uDHrN56pZIm7VHRUGxOcyrteRJy/zfJ5ML5iFYqCPY7N8LReREKpVMabn+stOhieTeP/3U6ThqUMQf4YlicJ8lQvk92JY7UrF0k7ctP+cWhyTfJjLayLnc1vtwmVUkcd97VBLxeTMRS9olIvxkqVDJiIkcY9Lq6cNCA84IkbhafSTZkWRHkjWT7Id6vp9pM5VRBMql55pvxWZUJIm+g+jIqyOvjrzazauXj11F0t7Ngc/lLSjaK9D2npg207k6LiuPzDwy8xsy88em/V2P+IhgKA/BGG2YDsPcGDpaiWWyPngsdRdT4pFrR64dubaLa3T0CRjr4gre3aFjzLu8XU6CJ6WZtr2sX1ms6NqaLi2KK/fcJLzLl55Hq267vYy1xVV3mWmDq/YtBelWGCmmxUErNXu+lXmU6FAk7nVTPKmheqR2KtJcRYK9YuPB5YS9Fgh3YuHvMrTZgn7VedVpRCXRHYi9i6G/lvGXL9UKUcIS1RthvfBjgN0pmIUwNxIXl9TND88UhAHTyykm6ywp9Dl0evZCPCh+nJW588dfExd+qWbadS/SoG4IRaW8EeWd1vN6yl0MHXNCnaa5cuVTzf2ySFQcC5PcIjkU8ESGQCd23fV3GKXYuW9hxR0se96ioPjMKavmXGKcT1uhTtuh77b+P030tJ0KqdqFCts+7b29GvV7J+fD08HocnDyvNVp4T065zNtMRWqYsdrwPoSb9vj5WbKOPzdSREXhHtsZ4mQ7krBObQs+HTN63ziAe82fBRxExSkuObL5VRYuDLJakWvP9NRKO9e32w45EgXSUu/I96dicRuf8BS9eTZuPjU5Tv2/33W0jg65ZG/WriK4M64OQ/4J7oWbPpWZHWzCngMIgLjnPaCvTCEDCsQta9YiFjrEvd6QIz4D0D+vSw= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Returns a decision instance. The decision instance is successfully returned. -
    Schema
      evaluatedInputs object[]
      +
      Schema
        evaluatedInputs object[]
        The evaluated inputs of the decision instance. @@ -52,7 +52,7 @@ The matched rules of the decision instance. The evaluated decision outputs. -
      • Array [
      • ]
      • ]
    +
  • Array [
  • ]
  • ]
    • The decision instance request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx index 34d380d6fbc..965704f18bd 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx @@ -5,7 +5,7 @@ description: "Returns Decision Requirements as JSON." sidebar_label: "Get decision requirements" hide_title: true hide_table_of_contents: true -api: eJztWU1z2zYQ/Ss7OCVTWpQTJ3V509hOqjR2Pf5oD64OILgUEYMAA4CSNRr+9w4AUpYtylY6melFBw1FcrG7b3cfAC6WxNKpIckdOUXGDVcSNH6vucYSpTVkEhFVoaaWKznOSEKmaDvJq3XBiGRomOaVkyQJuUJba2lgpXZdGqiBL9d/Xgz+kSQiFdW0RIva+bEkkpZIEpL1WPkDFyQi3OmvqC1IRFpnM5JYXeNzJ24KBGoMn0rM4B4XoHKwBULWhzWCecFZAZQFBynUkn+vEXiG0vKco4ZcabAFN/0aBiQihhVYUpIsiV1UDgeXFqeoSURypUtqw6OPR6RpJs5/Uylp0LgR74ZDd9nE0GsNuAFTM4bG5LUQC9A+5JiFqDIlLUrrFNKqEpz5HMbfjNO63PRTpd+QWZcO7TJuefBpWxp2APhaNn5GwJuorZeVO8ZqLqe9xk/PL8BJv1gGXucMteEhUC+ifP/uZZStntcN9oXZ8W1XWOPT121oNKrWDC92Dth6sLrRkGtVtpnbnhmYUwMV1QYzb9uipNLuiihI7wDKaeZWOHV9s9LYYkmaxokd/Ri33A0aCznlArMBnCvtRC3lwgDVCJVWM55hBlx24fFEhlRlixcZWGmVCix/2WTiU+dGcBkkW7sQGOqYEgTTYP3u6tMJ/Hb04dfJm8LayiRxPJ/PBzpnB5hxq/RA6Wmsc+Z+Tu7tAG4K1AglXUCKQLOMO5tUwCP3wVTIeM4ZWOUBtm6Dy17A9/LEEd5uZntFn1rzjeSP4PZq3PF/weV007Qfk9NaOB00VbVNUkHlPXmshddKbASmLkuqV+vBUwNNRIyltjb/lf6/39xcQlABTGX4OIu1hhyIkkte1iVJjobDiJT0Idx9HA79dOAyvgMSCfhQCSp9aT2HwyWUj3XrgXFpLJXsZ2VGaT7lz+0+5WVbxKcBUUfGw34ydrQTlN0bmFHBM6C1LZzVQB9gGr0TVPj1dk+yPcn2JOsn2fvNev+kdMqzDKUvzxXfuAGpLFAh1Nyt2Hte7Xm159U2Xh39yE5yzm3hDUz5DKX/CnV7Y0e3XNVyv7fc03NPz59Izw99H3ojCS7K2tUhaq00KMZqrTFzX7LCq3eNlM52uy7uubbn2p5r27jWRKREW6i2Lew7ubYgCYm7lfBgfSWMl1t6iY1rm6KedQ3gWguSkGXgU5PE8bJQxjbJslLaNvHMJWtGNaepCCXqXgfedfUkFKPCP+7Lq3ux3to6oWUtMwrHcHV2fQOfqcU5Xfg4O5NPVR8Pj4e9Wp3oFo2jyzEEhKEq12aKTq2jfK/aILyLYt9QNshqze3i2g0L4UmRatSj2uVmVS2tPa/d3QchErV/PnU19OXvG18GXObKD2/LYdMRstY2JcPB4WbpXY49g5gqy1r6aVROw/6IrgFjojbWAYqI4Ayl8UXengp0Yl/DG/irbbAeDlxSQuV0s+eU26JOB0yVMQvDVtdUqDQuKZdxa8LEJ6Pz24vT0cHX8cnZxfXZweFgOLAP1oOvlLEllWt+fEbbv997jnr5uHz8yJlImyWLDzauBOXS1Y2Ht2xZdkd6WUYikmzr2U+ilip3ZLlMqcFbLZrGPf5eo16Q5G7yyCxPxYwb9z8jSU6FeX6+so7tTWssewv/w6lLb7jah1Qu/IQhandHInLvji+2Hmw0kyYiBdIMtQ9BkB4xhpVd07NxpuLIt5oOP5851vwLGRKGfA== +api: eJztWktv2zgQ/isETy1WkZ02faxu3iTtuo80SNLdQzYHihpZbChSJSk7huH/vhhStpVYTt1FgS0KHQJH0nCe3zekSC2oYxNLk2t6AlxYoRUx8LUWBkpQztKbiOoKDHNCq3FGEzoBt5K8aAtGNAPLjahQkib0AlxtlCVrtW1pwix5d/npLP5H0YhWzLASHBj0Y0EVK4EmNOuw8h7mNKIC9VfMFTSijbMZTZyp4aETVwUQZq2YKMjILcyJzokrgGRdsUZkVgheEMaDg4zUSnytgYgMlBO5AENybYgrhO3WENOIWl5AyWiyoG5eYRxCOZiAoRHNtSmZC7deHtHl8gb9t5VWFiyOeDYc4s92DJ3WiLDE1pyDtXkt5ZwYn3LIQla5Vg6UQ4WsqqTgvoaDLxa1Lrb91OkX4I5GlEn5KfeVuO/IH8wCqQzCwQmwPhddUBg7KDETD/VuhqLVUOW1deuMUJMtFGHwJx/PCEo/WryYLiM6BWNFCO/R5D9/1mlojZRGz7cNdmEUWbJvWOOTb9swYHVtOJztnbB2slajSW502QB8N4DJjFlSMWMh87YdKKbcvhEF6T2CQs3CSVS3C0AINooEuY+aXU1hL//aneBHkH2fOLxQm39TlcWclbXKWMwqEd/C3MaqLlMwv21zM4PKAGdu0+B6tvZs/XXYunNy/Fn4e+aZ+R7mdj8mh4R3MLnnbc/bX4e3P98si2JH37d+xguwjuRMSMhi8lEbFHVMSEuY8TScigwyItSqzH6xTlKdzR9dZVdGpxLKzhm97dyInAfJxi4JPMZcBcE0WL++eHNMfj968ermSeFcZZPBYDabxSbnB5AJp02szWRgco5/KPc0JlcFGCAlm5MUCMsygTaZbDcXWwEXueDEaR9g4zbBKof4Hm8v4ek2KtZtoDZiCyQj8vlivELAXKjJtmk/Jme1RB0s1bVLUsnULd1g4VtQHBFblyUz63e++waWEbWOudr+1zb259XVOQkqCNcZbHDcGMIgSqFEWZc0ORoOI1qyu3D1cjj0bQ0rvkckisBdJZny0HoYjlCk3ODWByaUdUzxH1UZbcREPLR7n5cNiE9CRCsyHnaTcUU7yfitJVMmRUZY7Qq0GuhDuAHvBJP+nbonWU+ynmTdJHu+jfc32qQiy0B5eK75JixR2hEmpZ7hyqPnVc+rnle7eHX0PSvJmXCFNzARU1B+pxnX+Ei3XNeqX1v29Ozp+QPp+aLrRW+kCGbZIA7BGG2I5rw2BjJ8C5VePR6WrGw382LPtZ5rPdd2cW0Z0RJcoZujX39a6wqa0MFqJjxoz4SDxY69oyUejYKZrg55ayNpQheBT8tkMFgU2rplsqi0ccvBFIs1ZUawVAaI4uPAuxWepOZM+ttddcUH7S2647BTS16Ti9PLK/KWOZixuc8zmryv+vXw9bBTK4ru0Dg6H5MQYUBlq1Os1CLlO9UG4X0U+0NjC7w2ws0vcVhITwrMgBnVWJs1Whp7XjteByEaNf+8WWHo3d9XHgZC5doPb+Cw7Qhtbf/SYXy4Db3zsWcQ12VZK99G1SSsj1grMC5r6zCgiErBQVnY7FavzX4IT8hfzUbxYYxFCchZdc+JcEWdxlyXg2Yvfv2bSp0OSibUoDFhB8ejj5/PTkYHH8bHp2eXpweH8TB2d84HX2nrSqZafrwF173eexj1YjN9fM93D02VHNy5QSWZUIgbH96iYdk17WQZjWiya4/2Jmqock0Xi5RZ+Gzkcom3v9Zg5jS5vtkwK5w/CIv/ZzTJmbQPv6Fox/akMZY9Jf/DlxWd6WpuMjX3DUPWeEUjeovb1Ts3spc3y4gWwDIwPgVBesQ5VK6lZ+u7CSTfuh2+PUXW/AtKrls3 sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Returns Decision Requirements as JSON. The decision requirements is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The decision requirements request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx index 2a840442a7f..fea7a12d1c0 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx @@ -5,7 +5,7 @@ description: "Returns flow node instance as JSON." sidebar_label: "Get flow node instance" hide_title: true hide_table_of_contents: true -api: eJztWV9z4jgS/yoqPe3WOcDsZndneXPAmfEOIRw2yW7lUilhN1g7tuSR5DAUxXe/atkGgp1Mcjd3TzxQWFKr//9abWtDDVtq2r+jl6lcESFjIFxow0QE9N6hMgfFDJfCj2mfLsEg2VjG4NdEDo1BR4rnSEX7dAqmUEKTRYMfYZr8EVyPO/8S1KE5UywDAwqlb6hgGdA+xV3igP0nWFOHcmScM5NQhyr4UnAFMe0bVcCx9DBBMZovBcTkM6yJXBCTQIs2DlklPEoIi4xGzRgpBP9SAOExCMMXHBRZSEVMwtuM6VCH6iiBjNH+hpp1jtpzYWAJijp0IVXGTDn16zndbu9Rc51LoUHjjp96Pfxrat/iN66JLqIItF4UabomyroY4tKRkRQGhEFuLM9THtl4df/WyHLTVFLO/4bIYAQURtfwUqHFUWDR822Wvezv7+DVY9dZRdH4I82ailR0e8dhAjCtZcSZgZgY+ZLcb8Zwp8gQFlxwFPxNVeId6f9eGYToK3Xxh29WRRvFxRIFa8OUGTIDTXE4S1YJiLY0tvsgbvI8sC5mBs4MzwAFgYj/AzFopE7eImeX+s84cC/EH34rexveqpmPbYF7mT0WwTcLKCcajNc5YPHbM2FVBkBMNBhce2RpAbrNTyCKDA+F2TiYeAP/0veG1KGT6fXACwLq0GB28bAfeTfeOHx4OheE7jR8sCvUof449KZX3tB3Q+9h4IaDj+1L4cfp9e1u6eJ6Nh660792E954uHsOvOmNP/AeQjf4RB069Qaef7MbzgJvWj9fueOZO6pH1Z/352A0C3DHBzf0bt2/rCrNuYk7dUcjb3QwVZp74Qbe8GA28P4588YD7+FydH2LUmej0H/wx0Ho4uzF9RCpBu5o9OAOQv/GD3F8MQv8sRcED9PZaKd8MJj6k3A3Qqtrs8afxte3Y3pfwrANGwFOP4384QH85hSwynqo+vXVZOSFNhMwZP7YxQGqkjDti8iW+BaFErnSiFaTwLOZTRI8LAThFZsO8RcED3jCUi0PVz7BGg/EXMlHHj9B+VzKFJhATBwQNxWqVT2uyCtukv+yJhsQTJjn6ki5ikWk6kp21jZxjcy4SXHquOXyDWR0u0WS8zd0Edg4gTZkwXgKcYdcSQUkBsN4qglTsHMp4cJqV/crZC7j9Yu9Rq7kPIXsH82e46lmLpmUlJVcUvYiZV4i4byUfje9HJDfz3/57f6HxJhc97vd1WrVUYvoDGJupOpIteyqRYQ/pPuxQ8IEFJCMrckcCItje9CxlOy7HKJziPiCR+WBZw22yqDrS/tebpHqSvvsqVIo3uiQXDKb+nX7s+Zi2RRt9yxYkSIPNpeF6c9TJj7TfRI0hR5L0UWWMbVreJ8KqMpFob/ZrP78U2uP9zEMJ6RkQSJMq90pVQlCIzIueIZV47zXc2jGvpajX3u9LfLEiL/CEkHga54yYVPr2BwuSLbP206J9epN5PtERiq+5MdyO08AWSXxsLSoRuK7diTWsEtZ9FljveUxYYVJUGoJHxIpsEqw1FbiE8hOIDuBrB1kPzfz/VKqOY9jEDY9d3jjmghpCEtTuSrbhBOuTrg64aodV+evbiOrLhnIkj9C+VVjxUqsLWQhTo3lCZsnbH5HbP7S9orn4vuwAYV5CEpJRWQUFUrhW2zC0903v1p2dSiesHbC2glrz2Ft69AMTCKrmy57R2US2qfd+lbqrFZTdzctN1VbvBMC9VjfaRUqpX26KYG07Xe7m0Rqs+1vcqnMtvuIUXpkirN5WuYmLpeAqxMplRFL7XRbQHHBfjOuDB2wrBAxI+/J1AtC8oEZWLG1dTCKfMr6fe99r5Urkj7D0Z34pLSwTMeDElGzRay3si2JX8PY3pZpiArFzTrAbaV75sAUKLfAoOzSpJJnuduvgJaIOtXDZZ08f9yGNv5cLKTdXuVBUxGMCihdat7rvGvm3MS30IlklhXC1k+xLBsjdmBYlBbaoEEOTXkEQtvsri46a7JRuUJuSonkXQeDUmZOXTaX3CTFvBPJrBuV23b/81TOuxnjoluJ0N2Be4Wfzc9G/sAbB97Zu06vY74aa3wutcmYONDjA5iWLu/Y5M3+0Hj1BW8VHwNfTTdPGbcfZq1hmwpYd7QJLOrQftsl8L1ToeOObjZzpmGm0u0Wp78UoNa0f3e/B5NFX8w1Pse0v2CpPr4pPrToh2l1p/wj+b/eH7d6qJpkYm2rQ1rgiDr0M37Kbr0f39pP8MBiUNbwktKNIsjNAY/G5TCibFfwPngIj38D1yj/XA== +api: eJztW0tz4zYS/isonJJaWtIkTjLRjZboGcay7BUpOymvywWRLRExCXAA0BqVSv99q0FSliX6ldcelgeXSKDRD3R/6CYAr6lhC037N/Q0lUsiZAyEC22YiIDeOlTmoJjhUvgx7dMFGCQbyxj8msihMehI8RypaJ9OwBRKaDI/4EeYJr8EF+POfwR1aM4Uy8CAQulrKlgGtE9xlNhhfwYr6lCOjHNmEupQBV8KriCmfaMK2JceJihG84WAmNzDisg5MQk0aOOQZcKjhLDIaNSMkULwLwUQHoMwfM5BkblUxCS8yZgOdaiOEsgY7a+pWeWoPRcGFqCoQ+dSZcyUTT8e083mFjXXuRQaNI74rtfDn0PtG+aNa6KLKAKt50WaroiyUwxxOZGRFAaEQW4sz1MeWX91f9fIcn2opJz9DpGhDmVpejG3k/9UixOmgeQKXW84aDsL+273DWQ4Bfs8H4ehxFxJ1HoIcy54HUVNRleEJN5SEn+IjpQRZwZiYuRLjqi00EZxsaAbh2rDlBkyA4fisJUsExBNM23HQXzIc8ejMTNwZHgGKAhE/AfEoJE6eY+ceT3/z0zgoxB/+FrYHsxWzXxsMfgye8TpuwWUDQeMVzkgPh+ZsCoCICYaDPY9sLQA3TRPIIoM163pOLj0Bv6p7w2pQy8nFwMvCKhDg+nJ3eObd+WNw7unbUHoTsI720Md6o9Db3LuDX039O4Gbjj43NwVfp5cXG+7Ti6m46E7+W3b4I2H2+fAm1z5A+8udIMz6tCJN/D8q+3rNPAm9fO5O566o/qt+vF+HYymAY745IbetfubVeWw7dKduKORN9ppKs09cQNvuNMaeP+eeuOBd3c6urhGqdNR6N/54yB0sfXkYohUA3c0unMHoX/lh/h+Mg38sRcEd5PpaKt8MJj4l+H2Da2uzRqfjS+ux/S2hGETNgJsfur53Rzx7hCwynqo+sX55cgLbSSgy/yxiy+oSsK0LyK7tjcolMilRrSaBJ6NbJJglhCEV2w6xJ8TzEGEpVru9pzBCtfsXMkHHj9B+UzKFJiwmADBhHkOz2UvgrlKYFuph/hCZtyk2NS0TONyTjH/PF2b53ukmGkfk8R2jl9Or386iW6cOkns6fF8jtj6A9P7H08RB7npVcE7yenPid6Jk0OJdZTuy1hyk7xDyitBYQl2y4UHEXcilhUiZh2W8849rHRHFNkM1L8OS4kYcgUR6lWXYW1x0RYXbXHRFhdtcdEWF68VF4+fyX9zdXH4Hf4PlxvPbwj8DwqQl5T5O0uSF3ZFXg6usS0/zmCl31aulDHbUK60xUlbnLTFSVuctMVJW5y0Ox//9zsfSHL8jvMXPHICbcic8RTiDjmXCkgMhvFUE6ZgG++ECxuy9UkPmcl49eIpTa7kLIWscYtlVzOXXJaUlVxS1h3looGEs1L6zeR0QH4+/uGn228SY3Ld73aXy2VHzaMjiLmRqiPVoqvmEf4h3bcdEiaggGRsRWZAWBxbR7N0txDSOUR8zqPS39ZgqwxOfWnfy+VQnQafTfmF4geQc8l04td4WnGxOBRtx8xZkSIPNpOF6c9SJu7pYxC8BmyX6CLLmNoeFT4VUK3lhW78ftktaL//rnHR+ByGl6RkQSIMq+2qUAlCIzIueIZL+nGv59CMfS3ffuz1NsgTPf4GSwSBr3nKhA2tfXO4INlj3HZKNFZnuH+NZ6TiC74vt/MEkFUQD0uLaiR+aEZiDbuURfcakyGPCStMglJL+JBIgVWCpTZNtiBrQdaCrBlk3x/G+6lUMx7HIGx4bvHGNRHSEJamclnWcC2uWly1uGrG1fGby8iqjgWy4A9QVtJLVmJtLgvRFpYtNlts/oXY/KHpE8/FzQoDCuMQlJKKyCgqlMLvzISn22/eWnaVFFustVhrsfYc1jYOzcAksrojbG/3moT2abe+z3tUq6m764Y7vhu8TQvqob4NXKiU9um6BNKm3+2uE6nNpr/OpTKb7gN66YEpzmZpGZvYXQKuDqRURiy1zU0OxQ67oV8ZOijPkshHMvGCkHxiBpZsVe7SSbXH+mPvY6+RK5I+w9G99ElpYRmOO0tEzRax3si2JH4LY3vPWENUKG5WAQ4rp2cGTIFyC3TKNkwqeZa73aK1RNSpHk7r4PnlOrT+52Iu7fAqDg4VQa+A0qXmvc6Hw5i79C10IpllhbDrp1iUhRHbMSxKC23QIIemPAKhbXRXV8RrslHZQ65KieRDB51SRk69bC64SYpZJ5JZtzot3P7OUjnrZoyLbiVCdwfuOZ5pHI38gTcOvKMPnV7HfDXW+FxqkzGxo8cnMA1V3r7J68ek8ear8ZV/DHw13Txl3O6aW8PWFbBu6CGwqEP7Tdfnb50KHTd0vZ4xDVOVbjbY/KUAtaL9m9tHMJWHolzjc0z7c5bq/Tv2uxZ9M6lu439L/tGb940zVDUysbKrQ1rgG3XoPW42N/5nwcaejwCLQVnDS0o3iiA3OzwOrtUjyrYL3icP4fFffjTTKg== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Returns flow node instance as JSON. The flow node instance is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The flow node instance request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx index 0f2a5dd8cd5..81389ad4e8d 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx @@ -5,7 +5,7 @@ description: "Get a group by its key." sidebar_label: "Get group" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7OCVTRpQTJ0150ziO6+ZjPI7dHlwfQHAlIgYBBlha5mj43ztLkLJqyXYOvVUHDUUCePv1HkDuSpBcBJFdiRPvmlpcJ8LV6CVpZ08LkYkFUhxJRIFBeV3zkMjECRJIWPAY5C1oCnCD7eRvKxJRSy8rJPSMvBJWVshQPPcTtiIRmhFqSaVIhMcfjfZYiIx8gw/NXJQ4GGF0kYigSqykyFaC2pphtSVcoBeJmDtfSYqP3h2Krrtm9FA7GzDwitfTKV8es6ADhEYpDGHeGNOCR2q8xYLNKmcJLfFyWddGqz5F6ffAGKsNrx5kqQcOKL0qYfQFNGHFoEMELv+OijhvnpNPOnq7zteuWJ/J0sNUJEMR1kiBvLaLJ4B4/oQXyhD0wmLxBasc/SdswwaM9F62O1ECErg5+xP4WvWrA4xoQA5oNMYec07Cz5W1SwRpMjjm95Sw4sddIg6nB7srzCzDQGCkuglwK40uQDZUoqWhlqA8FnwrTXii4rV3ucHql+cqP4OzOBMKJKkNxCqDDBAn5liAtnB1/vEIfjt8++v1i5KoDlmaLpfLiZ+rV1hocn7i/CL1c8U/nvdyAhcleoRKtpAjyKLQbFMauOcPhBqVnms15nlwGzi7UaRPky+ObtNlXYzG6626z+Dy/BR0n8V5q+1i23S/Zi4bwxgydw1luZH2RtwX9TmOziA0VSV9y7zaNtAlIpCk5nkyvXm9k7m/X1ycQYQA5QqEufNApQ6jIQ6i0lZXTSWyw+k0EZW8i3fvptOOMbniPxGJBbyrjbSRgA/C0RYq53HgTx+YtoGkVf9VZZzXC/3Q7kRsCmwg8YcY0SiyN9t8/+h8rosCbU/Ptd50AOsIpDFu+eROutfVXlf/e10dPvV6stRUxjNT36LlkxWWMspr7hq7F9deXHtxPSqut7ve/WcWOMueeYjeOw9OqcZ7LGBZatPD8/fAaHs41SIX91rba22vtW2tdYmokEo3tA/6fgCVIhNpf46FdDV+2Xb8PY/+dmwUNN6ITKyiYrosTVelC9Rlq9p56tJbLset9FrmJpKQh6OyRsYYp6TpH++qHA/wh+0Y0ZGsGltIeA/nx98u4EQSLmXbZ5JN/hv6/fT9dCcqT30EcXZ2CjHCyLuNvWCEZVHv/oLuJ/8McN/pCKgar6n9xstienKUHv2s4eyv+TDY69H5Pk4SyfDn48iSP/666Aut7dz1y4eCbzvCVUEfoufTycE2uc5Oe40oV1WN7TdKu4jvM3IjMGWaQBxQIoxWaENP46F7NE77HEfgz2gRDiZclMiccX9caCqbfKJclaq4bH3NjcvTSmqbDiZCejT7cvn1w+zV59Oj46/fjl8dTKYTuqM++NoFqqTd8IP7XotdHbHV/YHwZHNsKAPhHaW1kdoyMXr/V4NQrmLrJ4hEZOsm0HUysP1KrFa5DHjpTdfx4x8N+lZkV9f34ujVVOjA/wuRzaUJDztrm+6+OB96cC9hq5O0092x+2PbXpGm4TuRiBvuVt03rrrrLhElygJ971EcnimFNW0s3GqoMZ3XW8jJMfPwH24DGmg= +api: eJztWV1v2zYU/SsEn1pMlZw27Tq9eWmaZW3TIE23hywPFHVlsaFIlR9xBEP/fbikZDuxk3TogA2bHwxbInnu1zmkdL2gjs0szS/okdG+pZcJ1S0Y5oRWxyXN6QxcHEloCZYb0eIQzekROMLIDMdI0RHhLLmCLv1D0YS2zLAGHBhEXlDFGkAonPsOOppQgQgtczVNqIGvXhgoae6Mh7tmzmsYjCA6TajlNTSM5gvquhZhhXIwA0MTWmnTMBdvvdqnfX+J6LbVyoLFFc8nE/y6z4KwxHrOwdrKS9kRA84bBSWa5Vo5UA6Xs7aVgocUZV8sYizWvLqTpQBsgRlek9EXIhw0CDpEoIsvwB1NKJPyYxVSdhvlZ2aBtAYr4wRYUmlDAvLxPUCruehSzP8yYdYZoWYbBV3lAeentO8T6oSTMIaBxtATinm9bWFZ2r9gJdSzTyizVswUlB+gKcC8g86uoTBjWLcVxIIjukIUi99NWG3JiEacJm60hSnCnNtN//qtYYbg1+t8rcqUs8arkqWsFSmaTZVHmz98BwfIO+gIc86IwjtA74nyDRjByTWTHmwaYm8NcOZWEvkv82Yl50c2grtq/8eY9MAGtC0VJ37p3TexLKb9e1i222n+1TsN3t+f7G0/mfB0BOuIZPzK4qYgSsK8q0G5gTWEGyjxkkn7wEnVGl1IaB7l0ZScxpmkBMeEJLHUuDXFiQWURChycfb2gPy0//LHyye1c63Ns2w+n6em4s+gFE6bVJtZZiqOH5z3NCXnNRggDetIAYSVpUCbTK4TzrbARSX4mNXBbYK5jA8XDzMwjm5yYylNb8RGlafk89kxESGLVSfUbNN0WFMxLxGDFdq7vJBMXdFVUR8j5JRY3zTMdMiiTQN9Qq1jzj++tbx4vpWnv5yfn5IIQbguIYjX1cKOhjCIRijR+Ibm+5NJQht2E69eTSY9YmLFvyESReCmlUxFAt4JRyjSaAMDf0JgQlnHFP+7KqONmIm7dm/vIwOJ38SIRpG92OT7W20KUZagAj2XehOWKO0Ik1LPH3wC3Olqp6v/va72H3qtmgtXxxNSXIPCc5TMWZRXpb3aiWsnrp247hXXy209i6kimGWDPARjtCGac28MlGReCxngsY8x2h5OtcjFndZ2WttpbVNrfUIbcLUe2p6hj+lqmtMsnGM2W4wvnz32IcFcjw1ObyTN6SIqps+zbFFr6/p80Wrj+uway3HNjGCFjCTE4aiskTFScybD7W2VwwF8Vx4jOohNAvKanB1+OidHzMGcxZdcNHkb+vXk9WQrKk69B3F6ekxihJF3a3vBCIui3v6+HCZ/C3Do0Frg3gjXfcJlMT0FMANm6jH7Sz4M9gI6XsdJNBl+vB1Z8uvv56HQQlU6LB8KvukIVgWMjZ5P0r1Ncp0eB41w3TRehY1SzeLzDFsLjEtvHQaUUCk4KAurXsjS7Ps4Qn6LFsleikWJzBn3x5lwtS9SrptsaAMtvwupi6xhQmWDCZsdTD98Pnkzffb++ODw5NPhs710krobF4JvtXUNU2t+YL9+tq2Tv1gdCA829YcyOLhxWSuZUEiM4P9iEMpF7M5YmtB82ae5TAa2X9DFomAWPhvZ93j7qwfT0fziciWO2JESFn+XNK+YtHf/EVh398nZ8N/BU7LRHtzq7tjrUV1QpPR4RRN6hQ2lVW+pv+wTWgMrwQSP4vCUc2jd2sKNPwKQzsst5OgQefgn6CvEHg== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Get a group by its key. The group is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The request lacks valid authentication credentials. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx index 2c867668475..2feb67dfb3c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx @@ -5,7 +5,7 @@ description: "Returns incident as JSON." sidebar_label: "Get incident" hide_title: true hide_table_of_contents: true -api: eJztWd9z4rYW/lc0emqnXmDbtHcvb77gpN4mJgMm3blphhH2AWvXlrySHMIw/O93jmQbEkjDbbdvPGQClnR+ft85RmdDDVtq2r+noUh4CsLQB4/KEhQzXIowpX26BNMuejQFnShe4irt0zGYSglNeL2BME0+TkZR5w9BPVoyxQowoFDDhgpWAO3TZu9vsKYe5SimZCajHlXwteIKUto3qoKXuuIMCNOaLwWk5AusiVwQk0Gr2yOrjCcZYYnRaAcjleBfKyB2lS84KLKQipiM7wzuUI/qJIOC0f6GmnXpLDSwBEU9upCqYMY9+uWCbrcPaKUupdCg8cSPvR7+O7S0jQjXRFdJAlovqjxfE2VDBqkLUSKFwcD2N5SVZc4TG/fuZ42CNoemyflnSDAPpcIsGe7M2I/pCX68Fdq/GMqtNQtdHcKCC47S/4ZFtSyStsJs2pnWMuHMQEqMPMUERHFrgTaKi+Wp+sLhqepCoQ0TCXwDf3kt6iRvQSmpYqvtLR8bFhN7huBmsuImI8y5DCnRYJBWjyyvQCM3QFQFlodpNLkNBuFlGAypR6fRb9Ho94h6NBzNbvzb2zC6mgXj8WhMPfpx9J9ZNJqNg3gcBhPq0eBTMJjG4SiaXYeTOIiC8fP1wSgahna9ERF8isf+IJ7d+dfToH068K+vg+EsuA5ugihuH0+jX/1oaFfwySy4C6KYevQmmEz8q2A2Cf8bzIJPgyAYWuNrMcNgEE72le4eoFr/mUGXo/HNLBrFs8vRNBrShybwN6A1W54Q+8CGvHDba3a5HXPQtoy5pHBBCqmApGAYz22GF7lcRTKFU2GM+4mQKZyC3lb434fvTu//BeBEga15MS9OiOOQGUCEtuW1Od7ZNzJlBt4ZFLj1qDbMnCB5YmrRz0w8mSD+IA7vAoRdeDX2Y4u0cTAZXd/Zj7dBNAyjK4ucz3L+WpgPo/pZzl1F5gsCT1wb7e2H1Jp30NFeti2PGhBMGAehQyVuFfHyoqeisOdh26IwbnLYKyihgYJut7h08WY/xCYP2pAF4zmkHXKzg7smTNky+MhTSJELaEvTb8lcpus/7ZqlkvMcih8Ou+dze3xy63bWeonrqtjpGk5a7ffjywH598XP/3r4LjOm1P1ud7VaddQieQcpN1J1pFp21SLBP9z3fYfEGSggBVuTORCWpraPsJzs+jXRJSR8wRPHB+uwNQYD7fz782ZvXqn2bdYrxQ+w5JPpOGz695qL5aFqe2bBqhxlsLmsTH+eM/GF7lL+Fol8oquiYKp9OXuuoGZjpd+sMT/9eJQNv8bxLXEiSIKlpn0LqRWhEwUXvEBWXvR6Hi3Yk/v2S6+3RZmY8RM8EQSeypwJC62X7hwp003R+0aZkYov+Uu9nWf0q0E8dB41/Ht/nH8N7XKWfNFYv3hKWGUy1Orog6XUGsFyW9nOJDuT7Eyy4yT76RDvl1LNeZqCsPBs+cY1EdIQludyBemZV2denXn1Oq8u3nh5rF93gSz5I7jrgBVzDFvISpxfJ8+MPDPyGzLy52M/53xBMMoKcehuLWSSVErhz9GM5+1FVqO7boVnrp25dubaa1zberQAk8l64mKnJyajfdptmp/ubvau+bc4uAD12AxXKpXTPt043mz73e4mk9ps+5tSKrPtPmJSHpnibJ47KOKy41eDm1wmLLePj+UPF3CC0/g1YEUlUkY+kHEwickVM7Bia3clLtUL0R96H3rH77ylMq9I9G9D4jx06NurCI1YpPZRsW7zKYLtSEdDUilu1hM85sIzB6ZA+RXmoEVFrc9Kx+9uE/XqD5cNVj7+Htt0c7GQ9nid9kNDMCugtLO813l/CLHb0DIlkUVRCVsuxbK5ldzJS/JKG3TIozlPQGgL5nri1my7divkzmkk7zuYFIecpkouucmqeSeRRTdxx9r/81zOuwXjolur0N2BfzONhv6763AQRJPg3ftOr2OejHW+lNoUTOzZcQWmfZV76ehm1xnemCrWuTDwZLplzrhAdFgnNjVn7tt5mKYe7e8Pxx68Gvj3dLOZMw1TlW+3+PhrBWpN+/cPO55YYqVc4+eU9hcs1y+nkvtmfzeu55ffk39sVnnU+fohE2tL8rzCb9SjX/CW+dlscIv3zxmwFJR1zu3wkwRKs3f2YBSJJGnL01WA6P4fvBNhLQ== +api: eJztWltz4jYU/isaPbVTL7Bt2m55o+Ck3k1Mhku60zTDCPsA2tiSV5JDGIb/3jmSbQiQhnTSaR/8wAC6nIvO951jyVpTw+aatm9pICIegzD0zqMyA8UMlyKIaZvOwVSdHo1BR4pn2EvbdAAmV0ITXgwgTJOPw37Y+FNQj2ZMsRQMKNSwpoKlQNu0HPsJVtSjHMVkzCyoRxV8zbmCmLaNymFf12gBhGnN5wJicg8rImfELKDS7ZHlgkcLwiKj0Q5GcsG/5kBsL59xUGQmFTELvjW4QT2qowWkjLbX1KwyZ6GBOSjq0ZlUKTOu6aczutncoZU6k0KDxhnft1r4dWhptSJcE51HEWg9y5NkRZRdMojdEkVSGFzY9pqyLEt4ZNe9+UWjoPWhaXL6BSKMA0uS/swu61PdvzINJFMYQsNBW4/L8AUGUnR4X9Z2OGrKlERrezDjgpcoqAzQRnExPwACulxMJHE1kwQ9DJmMODMQEyP3F3/jUVBKqpEV/pKS0g9i5xAcTJbcLAhzOiEmGgzi4oElOWj0FUSeIr7H4fDa7wbngd+jHh2Hn8L+7yH1aNCfXHWur4PwYuIPBv0B9ejH/q+TsD8Z+KNB4A+pR/3Pfnc8Cvrh5DIYjvzQHzzt7/bDXmD7SxH+59Gg0x1NbjqXY79q7XYuL/3exL/0r/xwVDWPw986Yc/2YMvEv/HDEfXolT8cdi78yTD4w5/4n7u+37PGF2J6fjcY7irdNqDazhODzvuDq0nYH03O++OwR+/Khb8Crdn8hLX37ZKnbnjBNDdiCtry0AWFC5JKBSQGw3hiIzxL5DKUMZyKIxxPhIzhFPhECixlRjw9wYseM4D4qNhZTm/skj1mBt4ZFLjxqDbMnCB5aArRT0w8GZ6d7ii48THowcWgM7JxHvjD/uWN/Xnth70gvLBxMyCYMG4xDxfP9eLK7aXHHeIXLmxQGDcJ7FALUwSmEIqZ7mle2M3bJ8VxN1n/w+S88Q7T0cn6j+QjLBsvIaqYFghtmIjg1ep4MfEkZRU3XqttS5JX6fsipyer+CKnLnR8RuCRa6O9XfkW2vsanoGU7dgtcA8ibkQszUXMGizjjXtY6YbI0ymo7w6LXwyZggi1lo8GdTmsy2FdDuty+H8rh89uHf6zAvkqi/6NkvmPDHjDIvoq/W9VVrdK36SuHtmJHgdraEvoJ1jp00quw/6RklsX2LrA1gW2LrD/twJb7zfr/eZJ+03sOnvxdBaPnEEbMmM8gbhBrra5RBOm7Co/8BhiTDQI7/L0l0xlvPrbM9xMyWkC6dHt7K49HXLtRhZ6iauTiNoy4Vntt4PzLvnl7Mef775ZGJPpdrO5XC4baha9g5gbqRpSzZtqFuEHx33bIKMFKCApW5EpEBbHFpUs2S3YOoOIz3jk4mcdtsZgvJx/f1++zTOltMpuueIH4e6Q8SAoubjiYn6o2s6ZsTxBGWwqc9OeJkzc023IXwJVh+g8TZmqXhU8VVAk21y/+LD4w/dHAfvbaHRNnAgSITWqjFIoQidSLniKSfes1fJoyh7dv59arQ3KxIif4Ikg8JglTFho7btzpAaWJH2jyEjF53xf71P6FSDuOY9K/r0/zr+SdgmL7jWWJx4TlpsFanX0wUppjWCJLVw1yWqS1SQ7TrIfDvF+LtWUxzEIC8+Kb1wTIQ1hSSKXENe8qnlV8+p5Xp298PBYPJECmfMHcA/7S+YYNpO5qB8na0bWjHxDRv54bDvXEQRXWSEO3ZGQjKJcKdwxLnhS7ZNL3UUprLlWc63m2nNc23g0BbOQxf0/e5fPLGibNsvip5vrnQO6DV6jA/VQXvXLVULbdO14s2k3m+uF1GbTXmdSmU3zAYPywBRn08RBEbsdv0rcJDJiiW0+Fj/swPuEpV9d92KDfCADfzgiF8zAkq3c+ZpUe6I/tD60jh+pSWWekdi5Dojz0KFvJyOUYpHaR8W6wacIthcMNUS54mY1xGlueabAFKhOjjGoUFHos9LxvxtEveLHeYmVj7+PbLi5mEk7vQj7oSEYFVDaWd5qvD+E2HVgmRLJNM2FTZdiXh46b+VFSa4NOuTRhEcgtAVzcf+zHHbpesiN00jeNzAoDjlllpxzs8injUimzeLVVfU9TeS0mTIumoUK3ex2rsZhr/PuMuj64dB/977RaphHY53PpDYpEzt2XICpHuX2HV1vK8MLd1yLWBh4NM0sYVwgOqwT64Izt9VJtqYebe8ea995BfBv6Xo9ZRrGKtlssPlrDmpF27d3W564l29c4++Ytmcs0ft3ZHfN/mZQ3Kb9lvxrN2ePOl80MrGyJE9y/Ec9eo/nwE9O9Tf4emEBLAZlnXMjOlEEmdmZe3AxFklSpacLH9H9F1WxWZI= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Returns incident as JSON. The incident is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The incident request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx index 202e1a3e160..0d51cae0eb2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx @@ -37,7 +37,7 @@ Obtains the status of the current Camunda license Obtains the current status of the Camunda license -
    Schema
    +
    Schema
    An internal error occurred while processing the request. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx index 62125e25c28..4bd233946ca 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx @@ -5,7 +5,7 @@ description: "Returns process definition as JSON." sidebar_label: "Get process definition" hide_title: true hide_table_of_contents: true -api: eJztWUtz2zYQ/isYnJopTcqJk6a8aWwndZq4HltpD64PILgkEYMAA4CSNRr+984ClCWLdGzPZHrSQSPh9e3zW1KLFXWstDS9phdGc7CW5FAIJZzQit5EVDdgGA7OcprSEly/7WSzK6I5WG5E40cpvQTXGmVJMwAkzJJPV3+dx//iqYYZVoMDg+JXVLEaaEqbXfw/YUkjKhC5Ya6iETXwvRUGcpo608Ku+FkFhFkrSgU5uYUl0QVxFYyoE5FFJXhFGHcWVWOkVeJ7C0TkoJwoBBhSaENcJcasiWlELa+gZjRdUbdsUH2hHJRgaEQLbWrmwtS7I9p1N6i5bbSyYPHE68kEv4bajzhOWGJbjrNFK+WSGO9jyIMnuVYOlEM01jRScB+x5JtFyNVQSZ19A+4wBAbj60RQaNT1oxqiW5/wzJP+iPqI7+KfsxpCzJ7Cts4IVSKSAatbw+F8FPGyXyUo8Jl6b7DnYKwIjnwI+3dYeJ6u435483pLwoyVjwtxrHypUwbhRArv4g9ZT85OXirJgWLKjcHP/MqLIRFTOAkbBbescFDTrsM9Ry9gEBYNsI4UTEjIY/JFGyA5OCakJcz4M3ORQ06E8vVizVWS6Xz5Q541RmcS6l+HfHuo2ZRchJ29XBJ4iKUnbMyC9OvLD8fk96O3v938UjnX2DRJFotFbAp+ALlw2sTalIkpOH5w36uYzCowQGq2JBkQlufeaCbJhuHENsBFIThxel0QvTLo+2Dfj8tDWF3txGoroVsjBg+DKfl6ebYuqEuhyqFof6ZgrUQMlunWpZlk6pZusmAodFeKbeuame1ivyWgi6h1zLX2yUL95vUAG/Ppj9nsggQIwnX+sIigIDSiFkrUbU3To8kkojW7C6N3k0mHmBjxZ1iiCNw1kimfWrvmCEXqTd56w4Syjin+syKjjSjFrtx4l5E4eRIsWjPxcJyJa9pJxm8tmTMpcsJaV6HUQB/CDXglmLTxnmR7ku1J9ijJ3gzz/YM2mchzUD497/kmLFHaESalXkC+59WeV3tePc6ro2e/Ri6Eqzx6Keag/B+hBQtcK3Sr9i+We27uufkTufl27C/eVBH0ssE8BGO0IZrz1hjIsaMj74m7lt0/FPdc23Ntz7XHuNZFtAZX6b7P6xu0rqIpTXo2HWwegzZZjTULO+yIgpmvW7qtkTSlq0ClLk2SVaWt69JVo43rkjnGac6MYJkM2YnLgXLrVJKaM+mnx0KKC+q+XwjkmNWtyhl5Ty5Pr2bkI3OwYEvvYhT5EPr95P1kFBW3PoI4vTgjwcKQkFtFYg2LbB+FDZufA+x7xRZ4a4RbXuGx4J4MmAEzbTEs94nSy/PoOA6baNT/+LBOn0//zHwGCFVof7zPhKEidKvpSSfx4TDrLs48ebiu61b5CqrK8GrEtgzjsrUODYqoFByU9fnd9/nX2z6HFbJudB7GGJSQOevCWQpXtVnMdZ3wcOz+O5M6S2omVNKLsMnx9MvX85Ppweez49Pzq9ODw3gSuzvnjW+0dTVTW3p8BDfynrdr8mrz2Hj2/UYfHwd3LmkkEwozxhu26ql1TUeoRSOajnbib6KeH9d0tcqYha9Gdh1Of2/BLGl6fbOhk+dfLiz+zmlaMGl3b0q2bfrlsr9TeUX+1/uTUR/1k0wtfX2QLY5oRG/xOmL8lqK76SJaAcvBeMvD1inn0LgtkMHtCBLtvup9PEWG/AddXGgW +api: eJztmklz2zYUgP8KBqdkSlNy4izlTbWdVFkcj620B9eHR/BRRAwCDABK1mj03zsAqMUildjTTE88eGSSwNs/EAuX1MLU0OSGXmrF0BiSYc4lt1xJehtRVaEGdzHOaEKnaJtmZ9tWEc3QMM0rf5XQK7S1loZULYEEDPlw/eUi/sf1qkBDiRa1U7+kEkqkCa325X/EBY0od5IrsAWNqMbvNdeY0cTqGvfVTwokYAyfSszIHS6IyoktsMOciMwLzgoCzBpnGpBa8u81Ep6htDznqEmuNLEF7/ImphE1rMASaLKkdlE587m0OEVNI5orXYINt16f0NXq1lluKiUNGtfjxXDoftrWdwSOG2Jq5u7mtRALon2MMQuRZEpalNZJg6oSnPmMDb4ZJ3LZNlKl35BZGlEQ4kvuo//Qij/AeDMq1Jaj8VFoJX5ssXQx2Be67edUhrTuK7iAEkNiDoa2EWus5nJKVz54qtYMLzolXjVPiVP4s7S1ZM9QGx6i9VDsX+HB42ztTv7LFzsaJjA9rMTC9KlBaeHiON2X30abjM+eqsmiBGm7xE/8kyeLdDK5Fbg18GFtuSKkjpqHBdU5QHRy5OB/WiH8zCTfYhexmcxiBmUtM4ih4vEdLkws6zJF/VsbvwwrjQzsdujqgeyB7IF8bOL8a/QnRl54+D7iwjwO1uB8B6w9mj2aPZr/6V3p2pw8YZbrJvZoLMmBC8xi8llpJBla4MIQ0L7PjGeYES79nH49nyapyhY/nAtXWqUCy86X8q5lI8eua9noJQFVtzwIDdOg/ebq3Sn5/eTVm9tnhbWVSQaD+Xwe65wdYcat0rHS04HOmftz7Z7HZFKgRlLCgqRIIMu80yB2Bw9TIeM5Z8Sq9aLFG+NiH/z78QgSni73crXDWK15a8E2Il+vxutFz4LLaVu175NDLZwMSFVtk1SAvKPbKmgr3ddi6rIEvbsg21GwiqixYOsdNw6PEV1rvj8nk0sSRBCmsofjmlPknCi55GVd0uRkOIxoCffh6vVwuHIyXcYf4YkkeF8JkL609t3hkpTbuvWOcWksSParMqM0n/J9vfE+ke7mWfBoTeJxN4lr7ASwO0NmIHhGoLaF0xrwIUyjNwKEiXvIesh6yA5C9rJd7++UTnmWofTlueGNGyKVJSCEmmPWc9Vz1XN1mKuTR08j59wWXvqUz1D6qe0cAmu5qmU/sezZ7Nn8hWy+6lrijSRxUdauDlFrpYlirNYaM3fqIjbgrnU3L8WetZ61nrVDrK0iWqItVHMW6w9RbUETOmhoOtq+Bs1g2bX9s3Knlqhn62PXWgua0GVAaZUMBstCGbtKlpXSdjWYuTzNQHNIRahO9zggty4loRgIf7srpe6B3GxhIjkNO7DkLbk6v56Q92BxDgsfYqfyoei3w7fDTqmu6QGJo8sxCR6GgtwZJNZiHe2dYkPjxwj257kGWa25XVy7biE8KYJGPapdWjaF0ujz0t11aESj5p936/L58PfEVwCXufLdm0poG0J39mHpMD5uV93l2MPDVFnW0o+gchqmRrDjGBO1sc6hiArOUBrcbkRv1H4KT8h67/U4dkkJlbMeOKfcFnUaM1UOmj32zW8qVDoogctBo8IMTkefv16cjY4+jU/PL67Pj47jYWzvrXe+UsaWIHfseI+2Y5637/Jy+9p49DcITX4s3ttBJYBLVzHesWWD1g3tQItGNOncW72NGj5u6HKZgsGvWqxW7vb3GvWCJje3W5zCYQI37v+MJjkIs/81w65Pz66a7x6ek//1G4fOGDU3QS78+CBqd0Ujeuc2mLv3nVe3q4gWCBlq73loOmIMK7sjpPUFgwNtM+q9P3eE/As0+iPl sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Returns process definition as JSON. The process definition is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The process definition request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx index 77f040db8d1..e81a393c5fa 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx @@ -5,7 +5,7 @@ description: "Get the process instance by the process instance key." sidebar_label: "Get process instance" hide_title: true hide_table_of_contents: true -api: eJztWcFy2zYQ/RUMTsmUluTETVPeNLKcqnVcj60kB9cHkFyJiEGAAZaWNRr+e2cBUnYkylbT3qqDxxK4eIvFvregFiuOYu54fMMvrUnBOSa1Q6FT4LcRNyVYgdLoScZjPgdsjCatTcQzcKmVJRnxmH8AZJgDKzfAWLLsHr+DZe8vzSNeCisKQLC0mBXXogAe8/J7f3/AkkdckqdSYM4jbuFbJS1kPEZbweZyprtc8oi7NIdC8HjFcVmSL6kR5mB5xGfGFgLD0LsTXte35MiVRjtwNOPNYED/9nAmHXNVSmOzSqkls4CV1ZDRClKjETQSkihLJVO/1f2vjuBWTxb4vZ/NRDEHwqY5a1fIJEJB+E1cJvkKKdIWW8onyhBDx9Z27cV2jHewZGbGMJduK95ex+5FratTmEktWzqtfTm0Us87XbXw2Xomm5z2OiEvPGF+EJTY1g37GayTIR97bE0H9H0A2NyYt2+eczcV8x+OpXHIUMy7Q9o/0x3ojXg6ciws6M368A9c+ek7xbrL35kyiwuTwQ87nCmzYNpksIdLh8LiqcA9eebNWSbwe1XQwBHKAggSdLY/IOjsBTiHDVjnahAiZjSQeIej6eTzOGKjPz9eno+n49OIjYYXo/H5+JTQQVcFnQnBjEd8bUefG0M6IFCigsea1KbhmpyNCaSOeC7cRKcya0pdE2dijAKhtwL9kgPmYLvLC8uFY4JZUAIhY7KBZcYybdDTHUELjfsWmGAdikq9M5wJQsHrmixOnqn89zIDnyFBZV8bZPdCyedKfWlNoqD46aWSP2SXwZJlgEIqFmo6E6RNMkz8brCbq7MR+/Xk519uX+WIpYv7/cVi0bOz9Agyicb2jJ337SylP7J73WPTHCywQixZAkxkmde5UOzxtGCuhFTOZMrQtKe4Xwztbzi9nz9qwtPtfKxJXFm5lZ4h+3Q1YT6/craUer7t2s+ZiUoRhkhMhXGihL7jj6l8iQRD5qqiELY50jYdNJqq3IvvCW/fdBLst+n0kgUIllKZmZlHbpMjCqKQWhakuJPBIOKFeAjf3g0GNWFSxveIRDN4KJXQnlqb4UjNCmOh4Y8PbP2i999kxlg5l5t+t2RFg6cholZQx92Cojc7cMiUSO9cUBITFebkNciHpRb8IoRyB5EdRHYQ2W6Rvd3m+5mxicwy0J6ea701R5dQyiye/Z1y0NVBV/97XZ3s2QdYSMw99lzeg/8ZxRYiKG1mKn3Q2UFnB53t1NnPXb+6hprRLlviIVhrLDNpWlkLGVvkUq1F2PpuDrjAxYPWDlo7aG1ba3XEC8DcNP1+35jHnMe836jpqF2l66+2W8g1NdbB3rdt/MoqHvNVkFEd9/ur3Dis41VpLNb9e8rRvbBSJCowkx4HubU0UiYVyg93pZMeUPe2DXMkikpngr1nV+PrKfsgEBZiGRqhxm5Avx+8H3Q3B43FHYjDywkLEQYyPikQLSwpvbsj6I33AfZXDg7SykpcXtO0sD0JCAt2WFFK1iRp/Hl031rzRjxqPpy11Pn9y9RnX+qZ8dMbFmwvhLLSNr75oHe8zbjLiRdOaoqi0r566nl4yRFPAktV5ZACiriSKWjnud3c7bRm5+EJa3rf7LhHSQnMaYvmXGJeJb3UFP00TFv/T5RJ+oWQut+4cP3R8OOni9Ph0flkNL64Hh8d9wY9fEAffGkcFkI/WQfdWW2+r20GvHo8MP7FHVeTL4QH7JdKSE0M8oGuGpnd8C2Z8YjHHXc1t1GjlRu+WiXCwSer6pqGv1Vglzy+uX2UltdiJh19zng8E8pt3pU9jfDVVXOr9po9d4PWGU4zKPTSS1tV9I1H/I46812XTvUt9YhBZGD9MoPhME2hxCcQWzdkpJB1qfowJmr/DVXf9us= +api: eJztWlFz2jgQ/isaPbVzDpA27fV44xLS45qmmYS2D7k8yPaC1ciSK60hDMN/v1nZJgQbwvX6cDPnh0xAlr/Var9v11605Cimjvdv+ZU1ETjHpHYodAT8LuAmAytQGj2KeZ9PActJo2pOwGNwkZUZTeJ9/h6QYQIs2wJj4aJ5/B4Wnb80D3gmrEgBwdJillyLFHifZ0/tfYAFD7gkS5nAhAfcwvdcWoh5H20O28sZ7zLJA+6iBFLB+0uOi4xsSY0wBcsDPjE2FVgMvT3hq9UdGXKZ0Q4c3fGq16N/BxiTjrk8orFJrtSCWcDcaohpBZHRCBoJSWSZkpHf6u43R3DLjQU+tbMdKOZA2Chh1QqZREgJv/TLhN8gQh5wodSnid/dp4C/C+dXnoFFCY5NjGVbgR7tgHy8i9ZZen8GE6llRZv1/jq0Uk9rlNnctnh9JxuddfgqqENeemL8ICixqhn2C1gni32v0eEg6FkB0Nmiz+tX+8yNxfSHfSkNMhRT75JDYfFM4IG746ezWCA8WTINHKFMgSBBx4cDgo6fgXNYgjWuBiFgRgMzEzY4HY++DAN2+unj1cVwPDwL2Ong8nR4MTwjdNB5ShmrmMYDvp5Hn8uJlL5QooJHxVRkviFjQwJZBTwRbqQjGZdCLP0MjVEgdM3RrwlgApZhIl1d7IlwTDALSiDETJawzFimDfogIWih8VBZFLMLKax2ukPaJAlzSlONgtxMnwcZvocFxaHRy2b9HAzdwGSfkFe+BIDeLjGHA/u7d6T7Nfq5MvNLE8OPwk+UmTNtYtg2sD8+/vpmkp/puBOJNNex6IhMdu5h4To6T0Owv/ycAsA+wIIJRCvDHMEx4ZjOU7AyYjOhcnAd72dmISK6VgW0LRpt0WiLRls0diTgfQTfXzXqj9XPlpF/qKbywb7BzPOFZa+pfZVlt739peYAg7tqTcMLyt44X/qy8gEW7rAyVJDrJ5Wh9j2kLSltSWlLSvse8h95D6EZJ3v6VzMZg1eQoOaVNkivC3JfwyqzJlSQPlswBpTNaSaLAYVUrEjf9GZSTAw9W9nt9fkp++3kza93LxLEzPW73fl83rGT6AhiicZ2jJ127SSiP5r3ssPGCVhgqViwEJiIYx9RoTbLicsgkhMZMTRVL9Ivhva86EHuryrF1XqM1kkmt7IWsgH7fD1iXn9yspB6Wjft75mIXBGGCE2O/VAJfc8fQ/kcMQbM5WkqbKmWbQNlzstdY1nZKhNNpPtjPL5iBQSLiHRUmitVkiFyIpVappQRT3q9gKfiofj2ttdbESZF/ABPNIOHTAntqbXtjtQsNRZK/njH1u3qnxMZY+VUbtutyYoGzwqPKkEdNwuK+tPgkCkR3btCSUzkmJDVQj4ssuAXIZRrRdaKrBXZbpG9rvP93NhQxjFoT8+13srSJZQy872/trS6anX1v9fVyYG/Zs4lJh57KmfgH5jZXBRKm5hctzprddbqbKfO3jS9dQ00o122xEOw1lhmoii3FmI2T6Rai7CyXRa4gout1lqttVqra20V8BQwMeWpJX+8CBPe591STUfVKl13WW9Oreh4ENhZdRgpt4r3+bKQ0arf7S4T43DVX2bG4qo7oxjNhJUiVAUz6XIht4pGykRC+eGmcNIF6glXbp4WLXn2jl0Pb8bsvUCYi7J9ZOwW9Lveu15zq8hY3IE4uBqxwsOCjBsJooIlpTd3bP3kQ4D9wSkHUW4lLm7otmJ7QhAW7CCnkKxJUtrz6L716SfxoPxwXlHnz69jH32pJ8bfXrKgvhCKStVO573OcZ1xVyMvnMikaa599tTT4iFHbDgWqdwhORRwJSPQznO7PKFWTbsorrCyo86OOxSUgjlV0pxKTPKwE5m0W/7osv4fKhN2UyF1tzThuqeDj58vzwZHF6PT4eXN8Oi40+vgA3rnM+MwFXpjHXTybvt5bdvh5WPB+Bcn9cp4ITxgN1NCamKQd3RZyuyW12TGA95v6ALfBaVWbvlyGQoHn61arWj4ew52wfu3d4/SKn4yko4+x7w/Ecptn/jb9PDFdXk28CXbdw6w0Z1yUOiFl7bK6RsP+D21aZva2as76uGDiMH6ZRYTB1EEGW5A1M75kULWqer9kKj9N+vEdpU= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Get the process instance by the process instance key. The process instance is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx index 7e5d0769e97..8bf6eba91c9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx @@ -5,7 +5,7 @@ description: "Get a role by its key." sidebar_label: "Get role" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7OCVTRpQTJ0150zh26uZjPI7THlwfQHAlIgYBBlha5mj43zNLkLJiyY4PvVUHDUUCePv1HkjsSpBcBJFdinNnUFwlwtXoJWlnTwuRiQVSP5CIAoPyuuYRkYn3SCDBO4OQt6ApwDW2k3+tSEQtvayQ0DPsSlhZocgET/2ArUiE5vW1pFIkwuP3RnssREa+wftGLkqMJhhbJCKoEispspWgtmZQbQkX6EUi5s5XkuKjN4ei664YPNTOBgy84uV0ypcHDOgAoVEKQ5g3xrTgkRpvsWCryllCS7xa1rXRqs9O+i0wxGrDqZ+xOW0QUHpVwugJaMKKMQf/Xf4NFXHOPKeddPT1GtudQT6enfspSIbUr4ECeW0XD+Pw9AmvkyHohcXiE1Y5+g/Yhg0U6b1sd4IEJHBzdifwtepXBxjRgBzQYIv95VyEpxWzSwRpMjik9ZSw4qddIg6nBw+UFb83GAiMVNcBbqTRBciGSrQ0VBCUx4JvpQmP1Ln2LjdY/fares/gLM6EAklqA7G4IAPEiTkWoC1cnp8cwR+Hr3+/elYS1SFL0+VyOfFz9QILTc5PnF+kfq74x/OeT+CiRI9QyRZyBFkUmm1KA3e0gVCj0nOtxiwPbgMnN+rycc7F0W2urGvReL1V9Rl8PT8F3Wdx3mq72Dbdr5nLxjCGzF1DWW6kvRZ3Nf0VQWcQmqqSvmVWbRvoEhFIUvNrLr16uZO3f15cnEGEAOUKhLnzQKUOoyEOotJWV00lssPpNBGVvI13b6bTjjG54k+IxALe1kbaSMB74WgLlfM48KcPTNtA0qr/qjLO64W+b3ciNvU1kPhdjGgU2attvp84n+uiQNvTc603HcA6AmmMWz66f+51tdfV/15Xh498kyw1lT3eQt+g5dcqLGVU19w1dq+tvbb22npQW693fe/PLHCWPfMQvXcenFKN91jAstSmh+dDwGh7eKlFLu61ttfaXmvbWusSUSGVbmgX9B0AKkUmUn6NhXQ1HP07PsGjvxkbA403IhOrqJcuS9NV6QJ12ap2nrr0hotxI72WuYkU5OGoq5Evxilp+se76sYDfKYd4zmSVWMLCW/h/PjLBbyXhEvZ9nlkkz9Dv52+ne5E5akPIM7OTiFGGFm3sROMsCzp3YfnfvJTgPveRkDVeE3tF14W05Oj9OhnDed+zYbBXo/O93GSSIY/JyNH/vrnoi+ztnPXLx/Kve0IVwV9iJ5PJwfb1Do77RWiXFU1tt8m7SJ+zciNwJRpAnFAiTBaoQ09iYdu0TjtYxyBv6NFOJhwUSJzxt1xoals8olyVarisvU1Ny5PK6ltOpgI6dHs09fP72YvPp4eHX/+cvziYDKd0C31wdcuUCXthh/c5vI7+l+ru7fBY62woQiEt5TWRmrLtOi9Xw0iuewbY0EkIhs7ZFfJwPRLsVrlMuBXb7qOH39v0Lciu7y6E0avpEIH/l+IbC5NuN9G2/T12fnQcHsO99tHO30dez627cVoGr4TSexQrXt63VWXiBJlgb73J47OlMKaNtZtdc+YyOut4/0xM/AHOuUOvw== +api: eJztWcty2zYU/ZU7WCVThpQTN025Ux0ndfOox3HahesFCF6JiEGAwcMyR8N/71yClGRLdtLHTDutFhqJBHDu6xyAvFoyz+eO5RfszChklwkzDVrupdEnJcvZHH0/kLASnbCyoRGWs9fogYM1CqFoQXoHV9imv2mWsIZbXqNHS7BLpnmNLGc09Q22LGGS1jfcVyxhFj8HabFkubcB7xo5rzCaIGyWMCcqrDnLl8y3DYFK7XGOliVsZmzNfbz1/JB13SWBu8Zoh45WPJ1M6OseA9KBC0Kgc7OgVAsWfbAaS7IqjPaoPa3mTaOk6LOTfXIEsdxw6jY2pQ0ccisqGD0B6bEmzMF/U3xC4VnCuFI/z/p03Qb5gTuExlJNvEQHM2OBgE/uwVlPJYdi6lfZct5KPd8q5SoJND1lXZcwL73CIQYyRW4wSult/Cts/wB8X8QuYdw5OddYvsO6QPsGW7cBwq3l7U4Mhx7MjFAcfdf9agcjGngDfjBFmaFMu23vul3h9TFv1vZal6ngddAlT3kjUzKa6kAWv/nzdYc32AL33soieCTXQYcarRRwzVVAl/aBNxYF92tN/Be5shbuw4q/K+t/ij0PbDQ7UvA+rHz7KmbFZP8FZu13lH/fjkK3DycH9xw6+Dmg86C4uHKkflkCD75C7QemgLBY0iVX7oFTqLGmUFh/kTtTOI0zoUTPpYJYYNqD4sQCS5AaLs5eHcH3h99+d/mo8r5xeZYtFovUzsQTLKU3NjV2ntmZoA/Ne5zCeYUWoeYtFAi8LCXZ5GqTZa5BIWdSjDkd3AZKZXxqeJh3cXSbGCs1Biu3ajyFj2cnIPsszlqp59um+zUzHhRh8MIEnxeK6yu2rumX2DgFF+qa25Y4tG2gS5jz3Icv7ybPnu5k6Y/n56cQIUCYEnvF+kq60RAFUUst61Cz/HAySVjNb+LV88mkI0yq+FdEogFvGsV1JOCdcKSG2lgc+NMHJrXzXIu/qzLGyrm8a/f29jGQ+GWMaBTZs22+vzK2kGWJuqfnSm/SgTYeuFJm8eDT3V5Xe13973V1+MAb00L6qseby2vUdIjCgkd1zUzQe23ttbXX1r3a+nZXN2KqgbJsiYdorbFghAjWYgmLSqoenloUo+3hUItc3Gttr7W91ra11iWsRl+ZoZnZ9yd9xXKW0THmsuXQmOyov4j2emxbBqtYzpZRL12eZcvKON/ly8ZY32XXVIxrbiUvVKQgDUddjXxRRnDV395VNxqg9+MxnqPYFYAXcHb84Rxec48LHt9vyeRt6BeTF5OdqDT1HsTp6QnECCPrNnaCEZYkvftVuZ/8NcB959WhCFb69gMti+kpkFu000C5X7FhsNej03WcxJLhx6uRIz/9et6XWeqZ6ZcP5d52hKqC1kXPJ+nBNrVOT3qFCFPXQffbpJ7Hpxm+EZhQwXkKKGFKCtQO1+2Pldm3cQR+iRbhIKWiROaMu+Nc+ioUqTB1NvR9Vt+FMkVWc6mzwYTLjqbvPr5/OX3y9uTo+P2H4ycH6ST1N74PvjHO11xv+EFNeLujO79cnwYPNeqHIni88VmjuNREi9775SCSi75t71jC8rF/f5kMTL9gy2XBHX60quvo9ueAtmX5xeVaGLH/JB39Llk+48rdbfJv+vrobPg74DHcbQTu9HXs8Oi2F6MKdMWS2EVa/ePQXXYJq5CXaHt/4uhUCGz8xrqt3j4RebV1vD4mBv4OKmmsqw== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Get a role by its key. The role is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The request lacks valid authentication credentials. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx index 31abfadc796..4918648851e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx @@ -5,7 +5,7 @@ description: "Get the start form of a process." sidebar_label: "Get process start form" hide_title: true hide_table_of_contents: true -api: eJztWU1z2zYQ/Ss7ODVTWpQTJ015U/yRuk08HttpD44PILmSEIMAAywtazT8750FKMmWqCSd6aEz1cEjkQDeYnffg8jnhSA58SK7FZfOFug9lDhWRpGyRtwlwtboJF+clyITE6Rrko66uWfWVSIRJfrCqTosycR7JKApgueJMLauAjsGCXVcM/hsPpsLSwg0lTxTeUBT1lYZgpnSGqzRc3BIjTOglbnHMqD4Adw8m1xa9GAsgW/q2joCrHIsy9X0z0YkopZOVkjoOMeFMLJCkYluLyerVP0fOBeJUJxALWkqEuHwa6McliIj1+BmljdTXGYE9zgfiET4YoqVFNlC0LzmKMoQTtCJRPCGJMVbb45E294xvq+t8eh5xcvhkD+2Y4T6KQ++KTjWuNGr4mAZUyysITTE62Vda1WEfqVfPIMstrdl8y9YENfGcXdJxS1wJK5C7zbucc5dpG5HnO53k0wEoZGGmDl9mHEUzk92IHtyykwYJ68rswvl3eXHix/BWJdhGyOO7YDoytUm4gGdV7Go2xjd4D+uEpdJkeZJLKdzwkq0Ld9+OTzqD7Xk3Ux6GNvGlAnkDYGxK7ZI722hJGEJM0VTUMRUaRNx1Mezd7IEZjt62k2n2tlcY/XzNq2eg43gMs6EEkkqDbF+IPlk4Yk5lqAM3F6dHcOvR69/uftpSlT7LE1ns9nAjYsDLBVZN7BukrpxwX887wXrHx1CJeeQI8iyDNKVGtZEBl9jocaqALKhD922gfsQ5fJtFcTRxQZ/nrStcWrryBvBp6tzUCUaUuO5MpPt0GHNWDaaMWRuG8pyLc29WPd/O+hmFN9UlXQrJT4PwBwnSY3/7gn06uUWNtPqt5ubS4gQUNgycDiez10gTqJSRlVNJbKj4TARlXyMV2+Gw5YxueM/kIkBfKy1NIFam+koA5V12PEnJKaMJ2mKf6sz1qmJ2ow7eKbFjsQnMaMoyKPhYb8gO/GAlsW9hwepVQmyoSlHjfKBwmHYhNR+sBfZXmR7ke0U2attvp9Zl6uyRBPoudKbis9/Ums7w3Kvq72u9rrarauep8kLS/EJci+dvXT20tkhndd9L00jA1xlxzxE56wDWxSNc/zKNVV69Za2jN39Zn3zlX2vtb3W/tdaaxNRIU1t5zUG/46mIhNpp6aDtTvp00Wvjdem42hLenQPS9+vcVpkYhEF1WZpuphaT222YOOwTR+4Ww/SKZnryFEejsJbEkrbQupwu6+xPMDm4jLhY1k1ppTwFq5Or2/gvSScyXkoNId8Dv12+HbYixpszX7E0eU5xAwHm/bWEpY13wv73O/6FnBwKj0WjVM0v+ZlsTw5Sodu1HBzVnTp4gV0vo6TRNJ9OVuS6Pe/bgIPlBnbsLzjw/ZGxBPTTQwHh9vcuzwPEipsVTUmnKNmEj0v+SSxQjeeOKFEaFWg8YHlnRm8nPYhjsCfnZN3OOCmROYsj8+JommTDwpbpUVctvrMtc3TSiqTdiF8ejz6+OniZHTw4fz49OL69OBwMBzQI4Xka+upkubJPtg4X1p7a/N8M+XF+sfjP2a1dywgfKS01lIFwzGUb9HJ+Fb0yFgkItvlx4cC3CWdGm/FYpFLj5+cblu+/bVBNxfZ7d1avEHtpfL8vRTZWGq/6d0/reBPV53L/wJ6HP3ejLqb0szDmaEbvhKJuGfvfMd/Ftq7NhFTlCW6sME4d1QUWNMTlC37ntW3OhDfn7Js/gbGd9/2 +api: eJztWUtz2zYQ/isYnJIpTcqJk7q8KX6kahLXYzvtwfEBJFcSIhBggKVljYb/vbMA9aacdKaHzkQHj0xisYvd/T4A3J1zFCPH03t+bU0OzrEChlJLlEbzh4ibCqygh0HBUz4CvEVhsZW9NLbkES/A5VZWfkrK3wMyHANzJMiGxpbMDJlgVZgTf9Ff9JVBYDgWJCkdA11URmpkU6kUM1rNmAWsrWZK6gkUXouL2d2GcGHAMW2QubqqjEUGZQZFsRT/onnEK2FFCQiWfJxzLUrgKW/Xcr501X2AGY+4JAcqgWMecQvfammh4CnaGra9vBvDwiM2gVnMI+7yMZSCp3OOs4qsSI0wAssjTgsSGF69PeFN80D6XWW0A0czXvV69LNrw8dPOubqnGwNa7UMDhTBxdxoBI00X1SVkrnPV/LVkZL57rJM9hVy5BEXSv059GHZtPtOOO9cBRYlOFoDo1QPEEpydFvPStRbAS00Ely6/AmjbHBOoMDWwTWlDq3UI95EPKtKvU/Lu+tPVz+iY+X7ro4wtkdF61sT8UewToZI7upoB/coeSb/EUeJioQWgaWgc8LFZjRpJmGz0/wEZt8JQYch/3IdKI+6iHNR1roQsahkPIGZi3VdZmB/2QVRAZWFXOCKGAdY/TSw+lemrzyEPsDM/RjkQnw7IHcA2E8DsOf3LXr9qnfSrXRxGk8FZb7WRcSyGpk2yzNUOGdySVsXm0ocM4l0gDYRP+k6fd+JgtEdABzuP2QrazIFZec+ua6sz66DJCsAhVQsJIoJum+RYAYFk5rd31yesd9O3vz68GKMWLk0SabTaWyH+REUEo2NjR0ldpjTH8m9pFsRWGClmLEMmCgKf6ERap0JroJcDmXO0Piot8tmFPVwifgON/zofCtLa/iordy5CPbZ55sBkwVolMOZ1KNd037OUNSKdIjM1JhmSugJX+V/1+i2FVeXpbBLRG0aIDKhwHrNjT34fv1qRzfB6ve7u2sWVLDcFB6x4dbaGiInSqllWZc8Pen1Il6Kp/D0ttdrSCdl/Ac80QyeKiW0h9a2O1Kz0lho8eMdk9qh0Pl/lRlj5Uhu2403uNiC+Dx4FAh50jvuJmRLHqZEPnHsUShZMFHjmKwG+rDcgl+EUC4+kOxAsgPJ9pLs9S7eL43NZFGA9vBc8k2Gr2KhlJlCceDVgVcHXu3nVcdt8spguEEeqHOgzoE6e6jzpuujqa8ZRdkSDsFaY5nJ89pa+uQaS7X8SlvYbs+sZwuZB64duPZTc62JeAk4Nm0Hxnc1cMxTnrRsOlr1bFwy72xuNMkwNGsc2MdFN6S2iqd8HgjVpEkyHxuHTTqndkqTPFK2HoWVIlMBozQciLcAlDK5UP51V2JpgFouC4fPQs2PnbKbi9s79l4gTMXMB5pMbqo+7Z32OrX6Zk+3xv71gAUP4+062kItcb5T7WZh7TnFvn/jIK+txNktTQvhyUBYsP2akrOES2vPa6fnIMSj9p/LBYj++PvO40DqofHTWzzsLoSvVfd4Lz7exd71wFMoN2VZa7+P6lGoeYk1x3JVOySHIq5kDtp5lLctsoXYxzDC/mpLhscxJSUgZ7F9jiSO6yzOTZm0Vd3lb6ZMlpRC6qQ14ZKz/qfPV+f9o4+Ds4ur24uj47gX4xN65yvjsBR6bR3UTlyU9lYtxW2X56vD43/WgGxRgPCESaWE9AVHH755S+N73kFjHvF0X5fSB+Ahatl4z+fzTDj4bFXT0OtvNdgZT+8fVuQNxXLp6P+Cp0Oh3HZHcz2CL27a3udL1tHn7PSofSn0zO8ZqqYnHvEJ1YD39FubhybiYxAFWL/AINvPc6hwTctOU5PYt9wQ318Qbf4BeWif6g== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -42,7 +42,7 @@ Note that this endpoint will only return linked forms. This endpoint does not su The form is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The process was found, but no form is associated with it. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx index 5edc09947f6..72378cba3fd 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx @@ -5,7 +5,7 @@ description: "Retrieves a single tenant by tenant Key." sidebar_label: "Get tenant" hide_title: true hide_table_of_contents: true -api: eJztWMtu2zgU/ZULrlqMYjlt2uloZ6Rpx9MHgtSdWWSyoKhriw1FqiQVRzD078UlJdu1nSYDzNILQ5bI+z6Hgs6Keb5wLLtmM9Rce3aTMFOj5V4aPS1Yxhbo+6WEFeiElTWtsYxdobcS79ABByf1QiH4sBPydvj3AdsRS1jNLa/Qo6VQK6Z5hSxjcc8HbFnCJHmsuS9Zwix+b6TFgmXeNrgbdlYiNFp+bxBkgdrLuUQLZg6+HBKgkE6UWHGWrZhva4omtccFWpawubEV9/HR6zPWdTcU09VGO3Rk8WI8pst+3L6qJXdg++oLcI0Q6Ny8USoUK4z2qD154HWtpAjNTL85crPaSmzHf/TtkFtRwpAPSI8Vee2rMPk3FDSL2tKcvIwZb1p5qOAHG+ha57E6WaCmkWMBZGM1V0Ol07ejAw1L+gmuQzlvpV4cjNQ7IoMRWcZ7gtZTrPs88X4/rS5h3Dm50Fh8wipH+wFbt+WVW8vbg04desLLLbaOrlWwdjB4A292sEQzcE+DElUovcL1QKceK3reJezsIVjV1tzJAgsouOcgHWjj4Y4rWfwCT7U1ucLqt8dwNYHLuBMK9FwqiBAC7iBuzMPc4frq3Tn8cfbq95tnpfe1y9J0uVyO7FycYCG9sSNjF6mdC/rRvucjmJVoESreQo7Ai0JSTK5gA05wNQo5l2Loap82UCtH/+rHkR1W97Gy7nxj5d6UJ/D1ajocD63Ui/3QwWbOG0U+eG4an+WK61u2meBjAJ2Aa6qK23Y4fX4O0CXMee6bx5Hz8sVBnP45m11CdAHCFAhzY8GX0g2BqIhKalk1FcvOxuOEVfw+3r0ejzvySRN/QiUa8L5WXAdo7ZYjNVTGYo+fUJjUznMt/q/JGCsXcjfuiG2zqQfx21jRQKjTw4SiNwg6D4qLWxeZBLzxJUWN9AFhMSTBlTuS7EiyI8keJtnLfby/MzaXRYE6wHPNt/7VxZUySzy+vI68OvLqF7w6e/AjgEg0N40+UuhIoSOFHqTQq0MfVBO9+YpFa40FI0RjLRawLKUK7ul7fYjdv7siFo9cO3LtyLV9rnUJq9CXplcEg6TnS5axNKokLl2tJaiO1De0d4Pa11jFMraKnOmyNF2VxvkuW9XG+i69o4HccSt5riIMaTlya8CMMoKr8PjQ7GiB9KWhpnNeNbrg8AauLr7M4D33uORt6CWF/Nn1m/Gb8UGvtPUBj5PLKcQKI/K2ToPBLdH6sPgUNj/FcdAlHYrGSt9+IbPYnhy5RTtpqP9rRPTxgne6j5tY0v95N+Dkr39mYdRSz00w70e+nwhNBa2LmY9Hp/vwupwGlghTVY0OR6VewFL6EvhWYUI1zlNBCVNSoHYByL0EPGz7GFfg7xgRTkc0lIic4YRcSF82+UiYKhXRbH3NlcnTikud9iFcej759PXz28nJx+n5xecvFyeno/HI3/tQfG2cr7jeyuM9+l7v2y1ztXkn/BfFux+Lx3uf1opLTUAJ9ax66lz3UqhjCcs2+u1N0uP/mq1WOXf41aquo8ffG7Qty65vNnQJ/Cqko/8Fy+ZcuV29fDv/Z1e9sv4cnqiiHyxjEFh1G5irGrpjCbsl+XlLiu5uuoSVyAu0IdG4PhECa79luSeSE+7Xp837CwLsD/VPf2s= +api: eJztWUtz2zYQ/isYnJIpTcmJk6a8qY6Tunl5HKU9uD6A4EpEDAIMHpI5Gv73zgKkJEty7Ew60wsPGooEsM/vW5CLFXVsbml2RaegmHL0OqG6BsOc0Oq8oBmdg+uGElqA5UbUOEYzegnOCFiAJYxYoeYSiAszSd70/95Bk9KE1sywChwYVLWiilVAMxrnvIOGJlSgxJq5kibUwDcvDBQ0c8bDrtppCcQr8c0DEQUoJ2YCDNEz4sreAFRpeQkVo9mKuqZGbUI5mIOhCZ1pUzEXH708oW17jTptrZUFiyuejcd42dfbebVklpjO+4JYzzlYO/NSBme5Vg6UQwmsrqXgIZijrxbFrLYM25EfZVtghpekt4cIBxVK7bzQ+VfgmAsm5adZiOZdMb8zC6Q2mEQnwJKZNiSKPr9H0mYyGhVzs46adUao+V7ut4KBC1LaJl06ETSPWd2lEG4dGMVkL+38dUpbFCachHVU0HR0jGKq7tq7AdGPqLWNdVAdzUEh1qEgiI49OxLKrBVzBcUHqHIw76CxW2qYMaw5qMWCQ0TeQGPxWoXVlvTSiNM7aMUs230P2sOhCBHaxtZCFSlnlVcFS1ktUlScKo9af/kZ3CF/CXPOiNw7JLolyldgBCcLJj3YNLhfG+AYxZ6wA1Yfj9VNWfo5sO6Xtf8Pvd8ptQfD9dGv7XsUsmOqfgrZQ0UdKurdiooDJ/dt/LXRC1FAQQrmGBGWKO2wBIriOzt+bXQuoXoQpxNyEWeSAhwTkkQgYbWNE/MQTnJ1+eaU/Hby4tfrJ6Vztc1Go+VymZoZP4JCOG1SbeYjM+P4w3lPUzItwQCpWENyIKwoBOpkchvPtgYuZoL3MezMJhi49B/1IL7j6D5U1tz3RuzldEK+XJ73L3CNUPN91WHNjHmJMliuvctyydQN3WTwIXxOiPVVxUzTvx/eVdAm1Drm/MO16/mzg6j8Yzq9IFEE4bqAUBtcKWyvCJ2ohBKVr2h2Mh4ntGK38e7leNyiTMz4IzxRBG5ryVSA1q47QpFKG+jwExwTyjqm+H+VGW3EXOzqvVtYOhC/jh71hDo+TCh8xwfriGT8xkYmEeZdiVojfQg3EIxg0g4kG0g2kOx+kj3fx/sbbXJRFKACPNd867YuJqVewrB5DbwaePUdXp3c+1GBJJpprwYKDRQaKHQvhV4c+qCaqM3HIRijDdGce2OgIMtSyCAeO6q97m7vilgcuDZwbeDaPtfahFbgSt2d2YRDF1fSjI5iT8SOVuvGTovnI2AW/XmMN5JmdBU502aj0arU1rXZqtbGtaMFJmTBjGC5jDDE4citHjNScybD40O5wwHsavU+ncaOHnlFLs8+T8lb5mDJmhBLVHlX9Kvxq/FBqTj1HomTi3MSPYzI26oGvVik9eFWU5j8GMHh5MgC90a45jMui+HJgRkwE4/xXyOi0xek432cRJPuz5seJ3/+PQ2pFmqmw/Iu5fuGYFbA2Gj5OD3eh9fFeWAJ11XlVSiVak6WwpWEbTnGpbcOHUqoFByUhU3bcq32fRwhf0WN5DjFpETk9BVyLlzp85TratT1bNfXXOp8VDGhRp0KOzqdfPjy8fXk6P356dnHz2dHx+k4dbcuOF9r6yqmtux4C67r7u26udrsCT9yJtmlxcGtG9WSCYVACf6sOupcda1QSxOabbqi10mH/yu6WuXMwhcj2xYff/NgGppdXW/oEvvJwuL/gmYzJu3uiea2/U8uu7PPp+SR55wH3ejbqaoJzJUe72hCb7Cpu9Xgba/bhJbACjDB0Dg+4Rxqt7Vy7xgTcb+uNm/PELD/AkCDfLg= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Retrieves a single tenant by tenant Key. The tenant was retrieved successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.api.mdx new file mode 100644 index 00000000000..7c2e975a0b7 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.api.mdx @@ -0,0 +1,56 @@ +--- +id: get-usage-metrics +title: "Get usage metrics" +description: "Retrieve the usage metrics by given start and end date." +sidebar_label: "Get usage metrics" +hide_title: true +hide_table_of_contents: true +api: eJztWE1z2zYQ/Ss7OCVTWpITJ0150zhO6k6S8Thye3B9AIGViIQEGGApWaPRf+8sQerbruu2Nx08MsnFvrfY9yBqF4LkJIj0VtwEOUEokbxRQdwlwlXoJRlnL7VIxQSpifjcBiRCY1DeVBwhUnHN93GKQDlCvZkLsjlMzBQtBJKeQFoNaDVoSdgTiaiklyUSeqaxEFaWKFLRxI5MiSIRhgF+1OjnIhEef9TGoxYp+Rp3aYxybGE4PYyd3yaTgLGqqLWxE6DchBWLoHIspUgXguZVJOCNnYhEjJ0vJYlUcOgJMaXlMlkRRaufR7Pbg/+P5B3TCJWzAQMvejUY8Mc+le1+BZRe5eAx1AX1/rQiEcpZQku8WlZVYVQjjP63wCkW+7xc9g0VcXM9y4hMJCBDMBOL8WKfhixdbQncGGprftQIUpGZMj30getvsxtLOEG/Wbax9PZMLBtAhSFc2kDSqr9HUh4loQbvHEG7GEy3+omgGpUJ7JSnouI9qpphu5X/EHKZCDJUcNCmK6/bbovlkkPOntZvlioGgrE0BeoefHYeQSNJUwSQHnlbpkajBmMbe3eigszp+aMCqbzLCix/2hfKNqkhXMXIFheigEAGiIFZRL+9/nAOv5y9+fnuRU5UhbTfn81mPT9WJ6gNOd9zftL3Y8V/HPeyB6McPUIp55AhSK0NY8oC1tKEUKEyY6OAXFNgSxu4D7G+x3Udnz7iytqbvRNzCDfXl2A0WjLjefT6DnSzZizrgnPIzNWUZoW038W6//uguyihLkvp5yy7fYBlwict1RtlPCC716/2crOUfh2NriCmAOV0PM2aQ6sF4iJKY01ZlyI9GwwSUcr7ePV2MGjMwx1/QiUW8L4qpG2ktVuOsVCuddsU1lnqP+qM82ZidnF7W15sRfw+VtSZ8PSwCTvbFVJ9DzCVhdEga8oZNdqHD6eGhCyaY+FosqPJjiY7bLLX+3r/4HxmtEbbyHPlNxPAOgJZFG6G+uiro6+OvnrIV28OvUEO+W2V0LMO0XvnwSlVe48aZrkpsHuN7rBb4x1fFI9eO3rtIa8tE1Ei5a6dtTRzEcpFKvrNj7WTcjV3Cein3bCk9oVIxSK6ZZn2+4vcBVqmi8p5Wvan3Iqp9EZmRRQgP46u6tRSOCWL5vahrvEDHnR01ZzLsrZawju4vvg6go+ScCbnzS4y5Hbqd4N3g4NZOfSBjMOrS4gVRs1tnANdWjb0wbQx+CmJm9lIQFV7Q/OvvCxuT4bSox/WvPMrLbR4TXa+jkEiaf/50Cnktz9GTZONHbtmedvsfSLcFfQhMh/0TveFdXXZ+EO5sqxtc0jaCcwM5SA3ClNFHYgLSkRhFPIv/3Q1mOrCPsUn8HtEhNMeNyUqpzsbJ4byOuspV/ZVXLb6zAqX9UtpbL+FCP3z4eebL++HJ58uzy++fL04Oe0NenRPTfGVC1RKu8HjI9L2wGG32sX6S+FfjBHbZhHeU78qpLEsn6bKRWulW7FtpbuktcOtWCwyGfDGF8sl345DPDaYNoG9o0U6lkXYneNtMn9x3U78XsKzh5AHa/iO85156FQWNccJHkM+m+Ez5o+P8FuPQdfs7taHj0hv75aJyFFq9M3OxmVDpbCijVV740XOsjoZP16wxf4CyTzXlA== +sidebar_class_name: "get api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Get usage metrics

    + + + +Retrieve the usage metrics by given start and end date. + +## Request + +

    Query Parameters

    + +The usage metrics search result. + +
    Schema
    + +The usage metrics request failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The request lacks valid authentication credentials. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +Forbidden. The request is not allowed. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx index 215c90b8658..09beda4752c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx @@ -5,7 +5,7 @@ description: "Get the form of a user task." sidebar_label: "Get user task form" hide_title: true hide_table_of_contents: true -api: eJztWU1z2zYQ/Ss7OCVTWpQT56O8KY6dqk08HsduD44PILmSEIEAAywtazT8750FKMn6cJLO9NCZ6uCRSABvsbvvQeTzQpAce5HdihuPDkj6qbhLhK3RSVLWDEuRiTESj15LPz23rhKJKNEXTtU8Q2TiAxLQBGFkXQV2BBKaJVjvi/liLiwh0ETyLOUBTVlbZQhmSmuwRs/BITXOgFZmimXA8T243phcWvRgLIFv6to6AqxyLMvV9C9GJKKWTlZI6DilhTCyQpGJptv8HzgXiVC85VrSRCTC4bdGOSxFRq7B7byuJ7jOBKY474lE+GKClRTZQtC8ZnRlCMfoRCJ4I5Lirdcnom3vOIKvrfHoecWLfp8/dqOEyikPvikK9H7U6FVRsIypFdYQGuL1sq61KkJ/0q+eQRa727L5VyyIa+K4m6TiFjgS12HvNqY45/4te8np/jDJRBAaaYiZsg8zjsLw/RPInpwyY8bJ68o8hfLu8tPFz2Csy7CLEceegOjK1SbiHp1Xsai7GN3gP64Sl0mR5kksoSFhJdqWb7/on+wPtWbeTHoY2caUCeQNgbErvkjvbaEkYQkzRRNQxGRpE3Gyj2nvZAnMePT0NKFqZ3ON1S+7xNoEG8BlnAklklQaYgVBeogTcyxBGbi9Oj+FX09evbl7NiGqfZams9ms50bFEZaKrOtZN07dqOA/nveclY8OoZJzyBFkWSqOKTWsqQy+xkKNVAFkQye6bQN3Igrm+zqIo4stBj1qXOPUzkE3gJurIagSDanRXJnxbuiwZiQbzRgytw1luZZmKtYM2A26HcU3VSXdSoubAZjlJKnxPzyDXr7YwWZi/XZ9fQkRAgpbBhbHk7kLxElUyqiqqUR20u8nopIP8ep1v98yJnf8JzIxgA+1liZQazsdZaCyDjv+hMSU8SRN8W91xjo1Vttxextq7Ej8PmYUJXnSP94vyU48oGUx9XAvtSpBNjThqFE+UDgMm5Da9w4iO4jsILInRfZyl+/n1uWqLNEEeq70puKTn9TazrA86Oqgq4OuntbVnufJC0vxCfIgnYN0DtJ5Qjqv9r00DQxwlR3zEJ2zDmxRNM7xK9dE6QDP7+zL2N1v1ndf2g9aO2jtf621NhEV0sR27mJw7mgiMpGy63HErodPF498uzYdRefRo7tf2nuN0yITi6ieNkvTxcR6arMF+4Ntes+tuZdOyVxHQvJwVNmSPdoWUofb+7rIA+whLrM7lVVjSglv4ers8zV8kIQzOQ9V5ZCb0G/7b/t7UYN7uR9xcDmEmGFv281awrLA98Ju2lvfAw7GpMeicYrmn3lZLE+O0qEbNNyJFTe6eAGdr+MkkXRfzpeM+f2v69B0ZUY2LO+av7sR8chjE/3e8S7RLodBL4WtqsaEQ9OMo8ElHyVW6MYTJ5QIrQo0PlC683yX0z7GEfizM+6Oe9yUyJzlWTlWNGnyXmGrtIjLVp+5tnlaSWXSLoRPTwefbi7eD44+Dk/PLj6fHR33+j16oJB8bT1V0jzaB3vjaydvtMc+X6x/Jf5DTnrXfcIHSmstVXAVQ9kWnVZvxVqrIhHZpsseMr1LOsndisUilx5vnG5bvv2tQTcX2e3dWqFB0qXy/L0U2Uhqv+3IPy7Vs6vOu38Oe336vQl0N6WZh6NBN3wlEjFlR3zj/wTtXZuICcoSXdhYnDEoCqzp0dodK56ltTraPpyxJv4GOW2+/Q== +api: eJztWU1z2zYQ/Ss7OCVTmpQTJ015Uxw7VZO4HkduD44PILmSEIEAA4CWNRr+984C1DflpDM9dCY6eGQRwFvs7nsAtbtgjo8tS+/YrUUDjtspu4+YrtBwJ7QaFCxlY3Q0OuR2eqlNySJWoM2NqGgGS9l7dOAmCCNtStAj4FAvweIv6ou60g7BTTjNEhZQFZUWysFMSAlayTkYdLVRIIWaYuFxbAzDrcmFRgtKO7B1VWnjAMsMi2I1/YtiEau44SU6NOTSgileIktZ3W7+A85ZxARtueJuwiJm8FstDBYsdabGXb+GE1x7AlOcxyxiNp9gyVm6YG5eEbpQDsdoWMRoI9yFR6/PWNPckwVbaWXR0ooXvR597FvxkRMWbJ3naO2olqugYBFcy7VyqByt51UlRe7zk3y1BLLY35bOvmLuWMS4lH+OfDi27b7lFqEylGon0NIegNI7cFiSo7s466neCiquHNGjy58wCoN3RIclNTZArTNCjVkTsawq1SGUt9efrn4EY+37PkYYOwDR+tZE7AGNFSGS+xjt4AGQJ/IfMSecpEnLwFLQGfFiO5q0ktjZaX6K8++EoMOQf7hJlAdVxDkva1XwmFcinuLcxqouMzS/7JOowMpgzt1aGkda/TS0+lemrzyFPuDc/hjlQnw7KHck2E9DsKfPLXr8onfWDbq+j2eccl+rIoKsdqD06hbl1upc0OEFM+EmIBxdoU3Ezrru37e8AHoPQOsOX7OV0ZnEsvOk3ATrw3WYCQU6LiSEVAG3ECZmWIBQcHdzeQ6/nb369f7ZxLnKpkkym81iM8pPsBBOm1ibcWJGOf3RvOf0PoQGoeRzyBB4UQiyyeWmFmyFuRiJHJz2cW+3DRT38BrxHXX40cVOnjYYUhux9/rXh9ubAYgClROjuVDjfdN+zYjXkjB4pmuXZpKrKVszYN/orhVblyU3K05tGyA5Oe7qDTcOMPzliz1sItbvw+E1BAjIdeE5G95XW0PkRCmUKOuSpWe9XsRK/hi+ve71GsKkjP+AJwrwsZJceWrtuiMUlNpgyx/vmFDWcZX/V5nRRozFrt14S40tid8Fj4Ikz3qn3ZJsxQOS51MLD1yKAnjtJmQ1yAdyg34TXNr4KLKjyI4iOyiyl/t8v9QmE0WBytNzpTcRfg9zKfUMi6Oujro66uqwrjreJ6+0C2+QR+kcpXOUzgHpvOr60dRXQFE2xEM0RhvQeV4bQz+5JkJ6eKpkLm23d9aTpcyj1o5a+6m11kSsRDfRbc/F9zPchKUsoarHCVU9bLLY6GY0ySj0Yyyah2XTozaSpWwR1NOkSbKYaOuadEFdkyZ5oNQ8cCN4JgMhaTiobMkeqXMu/eOuLNIAdVaW3p2HEh+8gZuLz0N4zx3O+NxHlUxuQ7/pvel1ovqeTjdi/3oAwcN4t2y2hCWBd8Ju19GeAvbtGot5bYSbf6ZlITwZcoOmX1MmVtxo7Xl0+h4msaj953LJmD/+HvqkCzXSfnmb/P2NsI1iHuvFp/tEux54veS6LGvlD001DgUuvuFYLmvryKGISZGjsp7SbSdsOe1jGIG/2grhaUxJCcxZnpVj4SZ1Fue6TNoi7uozkzpLSi5U0pqwyXn/0+3Vu/7Jx8H5xdXni5PTuBe7R+edr7R1JVcb+6CO4bqSN+poKi7Wt8T/qL/YZt/ho0sqyYWvKvqwLVqt3rG1VlnE0u3eo/f0Pmold8cWi4xbvDWyaejxtxrNnKV392uFhgK4sPR/wdIRl3a3T7kZqmc3bUfzOXR2LzsdaB9yNfdHg6zpG4vYlCq7W93T5r6J2AR5gcZvLMzo5zlWbmPtXoOSpLU62t5fkCb+ATWsfvE= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -42,7 +42,7 @@ Note that this endpoint will only return linked forms. This endpoint does not su The form is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    The user task was found, but no form is associated with it. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx index 9011260b49a..93d979f650e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx @@ -5,7 +5,7 @@ description: "Get the user task by the user task key." sidebar_label: "Get user task" hide_title: true hide_table_of_contents: true -api: eJztWU1z2zYQ/SsYnJIpLcmJk6a8aWTZUWunHsduD64PILkUEZMAgw/LGg3/e2cBUqJE2pHTHnXwmCJ29+1i9wEgdkUNm2sa3tFbDYoYph/ofUBlCYoZLsUsoSGdg8HRGxwMaAI6VrzEURrSczDEZEBso06i5c6LB1gO/hE0oCVTrAADCgFXVLACaEhtbfoPWNKAcjRaMpPRgCr4brmChIZGWdhFvumA0IDqOIOC0XBFzbJE61wYmIOiAU2lKpjxrz6e0Kq6RwRdSqFBo8a70Qj/vYTCNdE2jkHr1Ob5kigwVglIfHyxFAaEQSOsLHMeuykcftNoadX1TUbfIDY4MQon3HDvR3tCev15gCWR6fYsY/A/DDmo53ztgTaKi3knqQiCkiSVipiM6zZOFVBtmNnTjBPt9RaELbDwJtfT8c30lAZ08ufl1cW0fh5/mUwv3OPZeIYP91VAmdZ8LgD656UZfWlyalergEIOBQiDFb5PILU4mZ32mG+ZE9owEUOdvE5KXsxmg8FrI4PeHMZMJDxhBs6VtKVuwTCl2LIXZK1D5k6pN7MB5QYK3Z2Pqo2KS8FrQRHkJzBLJZFrp5BywZvlaJ9kbZJUmyDJ2obLVsfyT+Wrz3hfxmq5/1QbDdbLtYFvfso8Kj5TbgrcOna6N+cbDZLU3GfbGV9j4PiR4QU4HFmUObwSaa3zOqxU5rlc3Jb7I3mN16EkFvYHSCy8zroBwfZcvpzkmhSd5RyeDCjB8jOpimtIQYGI9/S6UXX1Q1Sj3M+xv0Bp7vfCPYrz0Uvvz7X371wZWW1k8RlYsr1MrTfbbaSJEyeZl6+XqJ2tgyWJA2T51dZG3bdgcam42Zd/jfhuzgkOZnyegffmkeUW3FPrZaOMHhZc8AK301FAC/bkn49HIwRNmc0NDT+M0EHDTY5eNee5mYGCVhUOnTx3/CmVfOQJJFieDI9AQhp0iScDcikVkAQM47kmTLWEuXBeNicsEslk+eIxqVQyyqH4pXtc2nZpTK68ZI1LfGYJw9pAwcij312fTchvJx9+vX+TGVPqcDhcLBYDlcZHkHAj1UCq+VClMf6h3Fs37wpIwZYkArJJO9kc0IguIeYpj4mRTV06ZzDdPr6XT3d+tMutdSVbxTvFMia31zPCExCGp0su5l1o2so1ZZG0JoxyJh7oJus/IvSYaFsUTLX3nBZAffCzure6d5jYV+6fb26uiDdBYpm0jpc10FYpn4zaxfxxNMIV1WV8j0gEgacyZ8LvQzvhcEGKTd26wJpd9X/KjFR8zndxB7TNwLqIT31EDQWP+ymIX0KgDclZ/KA99wizJkNUTx/cdJ0TLNeDA8kOJDuQ7FmSve/W+5lUEU8SEH7vbfhWb3YMz36QHHh14NWBV8/z6uRH12cLbjJndM4fQbjPzwXzFEulFQeCHQh2INizBPvQ94E2FgRn2X2Dg1JSERnHVilIyCLj+fq7ucGud7bDl9iBaweuPce1KqAFmEzWzS/XujIZDekQ97Ij3Mv0cNXq01TYegL12LS2rMppSFeeOFU4HK4yqU0VrkqpTDV8xKw8MsVZlPtaxGFPsKZwchmz3L3uSyAOuA5NHdiEFVYkjHwi19OvN+ScGViwpb+Gk2rH9KfRp1H/fZRU5hmL46sZ8RH68mstCY1Z5HZ/D8gJ72PYNeU0xBYvtr6imp+eCJgCNbaYhHVZ1HjOOv72QjSoH86aYvn97xuXby5S6dTrvHcdwaw0d5R0NDju1tjVzFEllkVhhVsvxdwfa1grsDi32mBAAc15DEK7aq77nY3YhR8h9a0oOR5gUnzlNMvknJvMRoNYFsPYq63/R7mMhgXjYlhD6OFkfHn75XR8dDGbTL98nR4dD0YD82T8zaTUpmCi5Qd2btdHs91IV5u94VUt3jo1Bp7MsMwZF1gsLqZVzaE7uuEQDWjY7nbeBzUR7uhqFTENtyqvKnz93YJa0vDufsMbR7SEa3xOaJiyXO/2iNtRvLmuu8lvSW/nuNfzpsUllo6wucVfNKAP2GLZatRW2J70t8jOMS8xjmMoTUu30xfGgl+vNedTrNR/ASt74Mg= +api: eJztW8Fy2zYQ/RUMTs2UpuTESVPeVFlO1DiOx7Hbg+sDSC4lxCTAAKBkjUb/3lmAlCiRsqWkhx548JgmgH1Y7r7FM0AuqWETTYN7eqdBEcP0I33wqMxBMcOlGMc0oBMw2HqLjR6NQUeK59hKA/oBDDFTIEU1nISLnRuPsPD/EdSjOVMsAwMKAZdUsAxoQIvS9CdYUI9yNJozM6UeVfC94ApiGhhVwC7ybQOEelRHU8gYDZbULHK0zoWBCSjq0USqjBl3690ZXa0eEEHnUmjQOOJ1v4+/nkPhmugiikDrpEjTBVFgCiUgdv5FUhgQBo2wPE95ZB9h75tGS8vm3GT4DSJDPcrS9Etin8k2+B9MA8kVRsNw0CSRilSRGBvI0ONdW5vuiOSe8RpRG8XFpBFEdBJ7WgAz5Xrjsk9XHtWGmQPN2K5EJts5gBMFUWSYaMOb0eB2dE49Ovzy+fpyVF4ProajS3t5MRjjxcPKo0xrPhEA7XGpWlvhtqe68iikkIEwmNGHOFJ2J+PzFvMrj0ZMxDxmBj4oWeS6ZpQpxRatNtdjyMQOan3eHuUGMt2c5aqOimlwLCiC/ABmriRm/DkkXPCqKBzyCDePrjRB4rUN9wwVWIqcH5xe1QgSl2nGtt1YkxzbTwzPwOLILE/hSKT1mOOwEpmmcn6XH47kRhyHEhdwOEBcwHHWDQh2IFNsz3WkG5UDngwowdILqbIbSECBiA6cdTUUEzYjqhpszTZS8i9Qmrsy2yj8TdMz1/u57NxeL968tmlUaCOzj8Dibe6ta+820tB2J1PXv+TdTpVicWwBWXq9VbfbWMil4mZxoItV992YE2yc8skU3GxmLC3AXtVuVoNxhhkXPMPK3fdoxp7c9Wm/j6AJK1JDg7d9nKDhJsVZ1RcoXMAoLrTbq1J9yW+t7I+wOK6oC22YiKA0+HJy1QCqQs9LG+0J9iOW91S98vbPzLmyvDVnTNgfMYbjfLovhLahLmdmIvYjlhUiZj7Luf8IC+2LIgtB/dqUOjHkCiJmNiquEz+d+OnETyd+OvHTiZ9O/BwvfvbvaLwgh557Ys/qoTakFwTSgVgvJ98W2k/51dRMbUhNEXWgeaeiWraZ2pPjygqmT7DQhwksR4YWgdXJqU5OdXKqk1OdnOrkVCenur2k//leEjad7Ttoy5Wc8RhirDAMD9uENJhVPPbJZ6mAxGAYTzVhqtaZCwtdneWRUMaLZw/kciXDFLLW3ar6lAbk2vUscYkjJ2EYBuwYOvT7m4sh+f3s7W8Pv0yNyXXQ683nc18l0QnE3EjlSzXpqSTCH+z3ylJHAcnYgoRANsytKzSdQ8QTHhEjq0DZyWBAnH/P6zXX2gzguhgVijfiOSB3N2PCYxCGJwsuJk1oWqMrZaEsTBCmTDzSTdRfypoB0UWWMVVPwhpAKRML3VqgdoppW0Z+vL29Js4EiWRcE6Ml0FY1OuvX69G7fh8XRRvxAzwRBJ7ylAknJXbc4YJkm7y1jlU0+48iIxWf8F3cbQaWSXzuPKooeNpOQTxzB21IyqJH7bhHWGGmiOrog7rJToKl2u9I1pGsI9lekr1p5vuFVCGPYxBOPlV8Kxc7hvId4o5XHa86Xu3n1dlLL2rNuZlaoxM+A2EV6pw5iiWyEB3BOoJ1BNtLsLdt/6ANBMGnbLdRQCmpiIyiQimIyXzK0/U/khV2ubJ1/4l1XOu4to9rK49mYKayfM3aviRtpjSgPVzLTnAt071lbY9rhS85g5pVL1EXKqUBXTrirIJebzmV2qyCZS6VWfVmGJUZU5yFqctFbHYEqxInlRFL7e22AGKDPc8pHRu6kynyntyMvt6SD8zAnC3cZpRUO6bf99/327cUpTJ7LA6ux8R56NKvVhIqs8jt9hMj2/kQw/b1bw1RgXuTX3GYezwhMAVqUGAQ1mlR4lnr+LfrRL3y4qJKlj//vrXx5iKRdngZ9+ZEMCrVNjPt+6fNHLseW6pEMssKYeulmDhZw2qORWmhDTrk0ZRHIDRsTurWsJeuhZQb2+TUx6C4zKnK5ISbaRH6kcx65dnj+neYyrCXMS56JYTuDQef767OByeX4+Ho6uvo5NTv++bJuM1lqU3GRG0e+I3AWprterrcrA1HfUxQhsbAk+nlKeMCk8X6tCw5dE83HKIeDeo7xQ9eSYR7ulyGTMOdSlcrvP29ALWgwf3DhjfuNJVrvI5pkLBU736NUPfil5vyu4VXpPUbhdaZV0dvYmEJmxb4F/XoI27Cbm1yr/Aw0x0E2Im5HoMogtzUxja+QMCEX9eaDyPM1H8B6EtHPw== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,11 +40,19 @@ Get the user task by the user task key. The user task is successfully returned. -
    Schema
      customHeaders object
      +
      Schema
        customHeaders object
        Custom headers for the user task. -
      +
    Schema
      customHeaders object
      + +Custom headers for the user task. + +
    Schema
      customHeaders object
      + +Custom headers for the user task. + +
    The provided data is not valid. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx index 562ed0ee3d7..aa3b84f7079 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx @@ -5,7 +5,7 @@ description: "Get the variable by the variable key." sidebar_label: "Get variable" hide_title: true hide_table_of_contents: true -api: eJztWUtz2zYQ/is7OCVTRpQTJ015Ux0nVZtmPI7jHFwfQHAlIgYBBlha1mj43zvLh0zr4bid3qqDRxKx+L59faC5XAmS8yCSK3EpvZapQXEdCVeil6SdnWYiEXOk9WIkMgzK65JXRSI+IAHlCLedAaTLh79vcDn6y4pIlNLLAgk9s62ElQWKRPR2f+BSREIzZCkpF5Hw+L3SHjORkK9wk/dik0NEIqgcCymSlaBlyeDaEs7Ri0jMnC8ktZfeHIu6vmaCUDobMPCOl+MxfzxCogOESikMYVYZswSPVHmLWRudcpbQEmPIsjRaNemLvwUGWg1ce8jQ5xUCSq9y6H0CTVhwTF0kLv2GijiLnmtDuvV6mL2d3t/gEmbOA+U6rEMZ4O7PUNRVaBP1kywQ3GwvYiCv7Zz330pT7QC45MtPQ+BEX+5GeV8ZA7dPhwrKlY+nqYFBaAwfw3wsZaV33CBTG0ha9SS+bgvobs+/pSa00hLrdYuwWYHpu6dlSocLX1klCXdgfc2RcvSdxDn7OgD19uA8WEcD2NQ5g9KKmj3UZHDQ81PCQtQ1Lx3vUt+vMgM+BDDQfoGV3qUGi59+JLQJnLWWkCFJbaBVFMgArWGKGWgLV+fvT+CX49c/Xz/LicqQxPFisRj5mXqBmSbnR87PYz9T/Md2z0dwkaNHKOQSUgSZZZo5pYF7rUIoUemZVkCur3rjDKepPUAeF3q7utqo1qAPKq+3zuYJfDmfgs7Qkp4ttZ1vUzd7ZrIyjCFTV1GSGmlvxH29tkk3WUJVFNIPO3pAwNojSVX44bn86uUWNmvlt4uLM2ghQLkM78+zjoiDKLTVRVWI5Hg8jkQh79pfb8bjmjG54k+IxALelUbaprU2w9EWCuex658msF6z/1FlnNdzvck7eqCdronftRH14jnafcp04gEj1Q2L3ugMZEU5s7byAeWxcUKaMDqI7CCyg8j2iuzVjn9CnE91lqFt2nOtNx34LgjSGLfA7KCrg64Outqvq+MdzxiOYOYqmx2kc5DOQTp7pPN610PTxAJn2XMfovfOg1Oq8h4zWOTarJ83e+7unvXoEOOgtYPW/tdaqyNRIOWuG4Y2w0zKRSLifpIS4tVgFlfzMBL9bT/rrLwRiVi1uqmTOF7lLlCdrErnqY5vuShrJA6Ul1t99X1jnJKmubyrfrxg14M5hBNZVDaT8BbOTz9fwAdJuJDLJp9M+RD67fjteCcqm+5BnJxNoY2w7b7BidDDsrR3wrbGTwFuxrQBVeU1LT/ztjY9KUqPflJxDdZd0fE16M3oqTESUfflfd8rv3+9aMqt7cw127uybzvCVUEfWs/Ho6PtFjubNkpRrigq2xyXdg4LTTnIQWDKVIE4oEgYrdCGppm7AXhv9rFdgcuWEY5GXJS2c/pTcq4pr9KRckWs2m3rz9S4NC6ktnFHEeKTyZ9fPr2bvPg4PTn99Pn0xdFoPKI7aoIvXaBC2oEfPMi/3TPlX93fGf7BwL+rC+EdxaWR2nKnNAGtOv1cDbo+Eslwmn0ddSK4EqtVKgN+8aau+fL3Cv1SJFfX95ppRJbpwN8zkcykCZsvDIYhPDvvXi08h12vEXb63V2UdinWk20hInHDI94Hc/j6uo5EjjJD3/jVWkyUwpIGe7feEnCvr0+ZD6fcpH8D1zXSZg== +api: eJztWk1z2zYQ/Ss7OCVTRpITJ015UxwnVZO6HsdxDq4PILgSEYMAA4C2ORr9986CpExLlKNO0lN50EgigLdf7wEkwCXzfOFYfMkuuJU8UciuImYKtNxLo2cpi9kC/boxYik6YWVBrSxm79GDzxBumg6QVA//X2M1+luziBXc8hw9WrK2ZJrnyGLW9vuAFYuYJMiC+4xFzOK3UlpMWextiZt2zzdtsIg5kWHOWbxkvioIXGqPC7QsYnNjc+7rS68O2Wp1RQZcYbRDRyOeTyb09YgR6cCVQqBz81KpCiz60mpM6+iE0R61JwxeFEqKkL7xV0dAy45rDy20eQWH3IoMWp9AeswppiYSk3xF4VnEuFJ/zUMCHwK94Q6hsFQ4L9HB3FhowWc7sO67k2N1QTZxT3iOYObgM+nWueiAOW+lXrBVxG64KnsALujyfgiU14t+lHelUnCzP5RHzbUn9m7VNLTA7O1+QNKd21IL7rEH60uGPkPbEJ6ckw582x+MBW18BzYxRiHXbEUeSq+wwwAqEhWRETUfVqarkV6OXmMVCv79cJwwxeM4ISsIoeN+KSqsIVXMtPNci73QmyEgmzH7GNqRs9DQldyNTkeC56VO+YgXcnSNlRvpMk/Q/vJjcoQPWAH33sqk9OiAO9BljlaKuvpuFKbHwmLDl3riGiQ8SPiHJbx7KfuZon7Myn8s80fW6v5MnwRJf8DK7TcF1IT4wSlgWJEHOQ8r8ndXZGo67LujfsNToBt7dH73TXNhTaIw/65Up3Ba94QUPZcKah3Rulx3TDAFqeHy7N0R/Hb48terJ5n3hYvH49vb25Gdi2eYSm/syNjF2M4Ffajf0xGcZ2gRcl5BgsDTVJJNrrqCdgUKOZcCvGlTGJyhLNUPBY/Lu25dbmS1M/+VVm49b03h89kMZIray3kl9WLbdBgz56UiDJ6Y0seJ4vqa3ddr2+imFVfmObddenQMEG0992UnjB3z94vnW9hEvN/Pz0+hhgBhUrzXSmOIgsillnmZs/hwMolYzu/qf68mkxVhUsX3iEQD3hWK60CtzXCkhtxYbPgTAmsF8JMqY6xcyE27owfaaUj8to6oFc9Bv2Qb8YDi4prEqWQKvPQZWa3lA8JicIKrcEM6iGwQ2SCyfpG96LmvMTaRaYo60HOtN+nozgG4UuYW00FXg64GXe3W1WHPY4vxMDelTgfpDNIZpLNDOi/7HpqmGijLlniI1hoLRojSWkzhNpNq/fDW2m7WrEcPJgatDVr7X2ttFbEcfWaaA85wQOkzFrNxu+PhxsvOPs+KDhjR3rTnl6VVLGbLWjereDxeZsb5VbwsjPWr8Q0VZY1EgVJzra+WN8oIrsLlvvpRg17v9SEc1Rua8BrOjj+dw3vu8ZZXIZ9k8iH068nrSS8qdd2BOD2dQR1hzb7OjNDCkrR7YevO+wCHo1eHorTSV59oWJ2eBLlFOy2pBmtWNPYCetiuC51Y1Px413Lljy/nodxSz00Y3pR92xGqClpXez4ZHWxT7HQWlCJMnpc6TJd6AbfSZ8A7gQlVOk8BRUxJgdrh/Y7t2uzHugUuaotwMKKi1MxpZ8mF9FmZjITJx82W9fo7USYZ51zqcWPCjY+mf34+eTt99nF2dHzy6fjZwWgy8nc+BF8Y53OuO37Q4XzLwc1Al/crw784xG/q4vHOjwvFpSamhICWjX4uO6yPWNzdKb2KGhFcsuUy4Q4/W7Va0eVvJdqKxZdX95qpd9Slo98pi+dcuc2XALohPDlrXhd4Cn2vBvT63VzkumLrzXLGInZN+6UP9nhXV6uIZchTtMGvusdUCCx8Z+zWyT9xfT3LvD8mkv4DWdOTGA== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -40,7 +40,7 @@ Get the variable by the variable key. The variable is successfully returned. -
    Schema
    +
    Schema
    Schema
    Schema
    Bad request diff --git a/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx index f57ef229677..7bc811b9e83 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx @@ -5,7 +5,7 @@ description: "Publishes a single message." sidebar_label: "Publish message" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/is7OCVTWlJSJ015U22ndZqHxpbbg60DSK5ExCDA4CFZo+F/7yxBmZQoOe5Mb41mNBKJxT6/b/HYMMcXlsW37BNayxfIZhHTJRruhFaXGYtZ6RMpbL4dj1iGNjWiJAEWs0kYRgscrFALiVAE0cGdaiZZ4AahUYQZOA22xFTMRQolN06QLgupLkrvMIO50QW4HIWBVBuDsvYG7nFtB3dqmiOgykotlINMowWlHay4cDDXBvjOHIPWSze4UzcWSeXWuR2hR2003/o0B28RUm6R7LGIGfzm0brfdLZm8aZ+FAYzFjvjMWKpVg6VoyFellKktdrhV0sZ2jCb5lhw+ufWJbKY6eQrpo5FrDSUayfQ0qjiBdLvboIpXBoBPe8GMGDRVp11RqgFq8iRx6D+xPVhXXsZ/a5aKvice+lYzMiGEwVO9UexPOSrKNCWXMELoaCwL6nSiZ/P0ezkXqv6MTH6Hk3HolAOF2hYxObaFNyFV29Puz6Mqog1egiehyL0SnzzCJfn+7HBFyXXVNu5l+QaKusNuSPXoFXr30q4vJ64EEtUcHl+p1ZCSsAlGki6SH6ReUoSCGdBijlScl4GzOxnUXkpeSIxgKaK2JIbQS/s4Si2zjyKAbfw4frLZ8h06gtUjjLHs6xmD5eTDpYCLPfR1vPAoeLKHUtjGN3LIVhU2U7RjgVYRR2e3AZw9xA6Izw5mrNtQHU/CQS6CqxjVRWU2VIrG9L1ejR6OmsrbtsyDdi/4OhxnR22tAjo8+YIuxvBo7zsc/EZxHhuEftc6LeP6ulahOw3xTg9lv/S6KXIMIOMOw4i9OYll+KpIpRGJxKLn75XjDFMgiRk6LiQEFJNxAiCCWYgFNxevT+DX0/f/DJ7kTtX2ng4XK1WAzNPTzATTpuBNouhmaf0JbmXA5jmaBAKviaCt6yCtojtmuV0AEHjDOVxh/NHEBBGNz3iPNbUG9FbX8dwc3UJIkPlxHxNvaZneqdF80R7FyeSq3vWVrRvdN+K9UXBTQvwHQNVxKzjznfCOILJn1/3dBMs/phOJxBUQKozrFdalwu7NURBFEKJwhcsPh2NIlbwh/D0dkQ9P1T8GZEowIdSchVWuL1waFnSBhv81IEJZR1X6X9VGW3EQuzbHeywqwHxeYgoEOrNIUKNFVCWDeEQjdEGdJp6YzCDVS5krT5Fa7e2m21KwOIPrv3g2g+u9blW7x9druuzjbY1dLjLWcyGzdpoh2W78LGIWTRLNHRK2jBvJIvZJrCmiofDTa6tq+JNqY2rhksqyc7GjoYDu7aokTrlMg+W+9Wjge52/4wXXmUc3sHVxfUUfucOV3xdZ5NM7qp+N3o3OqiVRI9oHE8uIUQYsNfpB1u1ROyDaoPwcxRX1YwSmXoj3PqapoX0JMgNmrGnAjxiorFXa6fnIMSi5s/7LVI+/D2ti0297Ko9ol088KIMTAxHqhZk+wekdqR7rBntHDFamW5hd3ZenSOYUHNdh9IAsJ8UUoTGhiyOBq/6YJ9c1pxNdVF4VeNQLcKhhHeSnEpvXdiKS5Eibc7aiLdiH8MI/BUswqsBASSgeNuvF8LlPhmkuhimYdrjbyJ1Miy4UMPGhB2ejT/dfD4fn3y8PLv4fH1x8mowGrgHVxeC+FRw1fGjuR7obGl3Yt20y9T/4yahQbjDBzcsJReKMFOXY9O0odst9ix1pk4jmkVNM7llm03CLd4YWVX0+ptHs2bx7ayFKD1VEcuRZ2jqznVf4/0spPtkSn6QuPTkT+9IVEXbGeM0xdI9KTvrtNTJl+spMbW5Kil0RnMMX9E1Cl+xmN2xO8bolqmuVX2fQu83THK18ASSmAW99PkH3OV8EA== +api: eJztWEtz2zYQ/isYnJIpTSmpk6a8KbbTOg/bY8vtwfYBJFciYhBg8JCs0fC/dxagREqUHDeT6aXWjEYCsdjnt4vlLqllU0OTG/oFjGFToHcRVRVoZrmSpzlNaOVSwU2x2o9oDibTvEICmtCLsA2GMGK4nAogZSCNb2VzyBCmgTSMICdWEVNBxic8IxXTliMvQzJVVs5CTiZalcQWwDXJlNYgvDbkHhYmvpXjAgjIvFJcWpIrMEQqS+aMWzJRmrCNMxqMEza+ldcGkOVKuQ2iNTc8b1xWEGeAZMwAyqMR1fDNgbHvVb6gydIvuYacJlY7iGimpAVpcYtVleCZZzv4atBDS2qyAkqG/+yiAppQlX6FzNKIVhp9bTkY3JWsBPzddDCaiztETboGxDRasTNWczmlNSqyNuoTLHbz2vLod9liwCfMCUsTijIsL2GsPvPZLl15CaZikrzgkpTmJUY6dZMJ6A3fK+mXqVb3oDsSubQwBU0jOlG6ZDY8envY1WFYR7Thg/DcZaGT/JsDcnq8bRs5l2KBsZ04gaqBNE6jOmJBlGz1m3Nb+INTPgNJTo9v5ZwLQWAGmqRdJL/IHTqJcGuI4BNA57wMmNn2onRCsFRAAE0d0RnTHB+Y3VaslFmTEWbIx6vzM5KrzJUgLXqO5bnPHiYuOlgKsNxGW08DC5JJu8+NYXfLh8SAzDeCts/AOurkyU0Adw+hd4gni2dWBcjXk5BAlyHraF0HZqZS0gR3vR4OH/fanJk2TDH9Fzm6n2cnW1oE9PNm7W8mxPmEJjfbPN8zA6RNfV91dlkf7N3FebNuPCmM/WzoF5D68WgEfVB7Wt9tK9Fw3Vt2+qXmB+V7sm4IZzKPM1Y6mbOYVTz214R0ZQr6l58WXvIJFoRZq3nqbMhF6UrQPCMzJhyY2BepSkPGbHszPEPiByGx9yp4mkZnPvyfYGGeBpdg7s+Dy3M1+O+qARIe7rsPKq1mPIec5MwywkOvOGOCP3YpVFqlAsrvwmFELgIlycEyLkgICRaHQJhCTrgkN5cfjsjvh29+u3tRWFuZZDCYz+exnmQHkHOrdKz0dKAnGX6R7mVMxgVoICVbYMPR3vJdpKx7aKsCDBtl0I8bPcg+pPjdZe8iX2ec07zX74/I9eUp4TlIyycL7H16ojdaRpYqZ5NUMHlP24j2hW5LMa4smW5TbENAHVFjmXUdM/ZUjF9f93gjLP4cjy9IYEEylYPPOltwsxKERpRc8tKVNDkcDiNasoewejvEHjRE/AmWSAIPlWAydNxb5mCbrDQ0+PGGcWksk9nPiozSfMq35cYb2dWA+DhYFBLqza6EGkmCXtaIQ9BaaaKyzGkNOZkXXHj2GRizkt28NgUsPufac64951o/1/z7rC2Un7Uo46HDbEETOmiuRjOo2ouPRtSAnoE2vpdwWtCELkPW1MlgsCyUsXWyrJS29WCGIdl40cTtkF0r1AiVMVEEyf3o4UZ3/HAUWifyjlyeXI3JH8zCnC28N1HkJut3w3fDnVyRdA/H0cUpCRYG7HXqwYotJvZOtoH4KYxr7FkMZE5zu7jCY8E9KTANeuQwAGtMNPI8d1wHIho1fz6skPLx77EPNtayy3ZkdPLAyipkYhjxtCDbHti0O90xy3Bj5NHSdAO78TrfGQlxOVHelAaAfacgI9AmeHEYv+qD/eLU52ymytJJj0M5DUMS1nFyJpyxYTQgeAbYnLUWr8g+hx3yV5BIXsUIkIDiVb2eclu4NM5UOWga9fVvKlQ6KBmXg0aEGRyNvlyfHY8OPp8enZxdnRy8ioexfbA+EJhPJZMdPZpxZafr3LB12V5T/4/JZoNwCw92UAnGJWLGh2PZlKGbFfYMVqZOIbqLmmJyQ5fLlBm41qKu8fE3B3pBk5u7FqK4qiNaAMtB+8p17/F+FNx9MEY9kFw41Kc3oqmj1YlRlkFlH6W965TUi/OrMWZqM7otVY5nNJvjWJfNaUJv6S2lOPX2sfLzXXy+pILJqUOQJDTwxc8/MBMfVQ== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -44,7 +44,7 @@ The message variables as JSON document. The message was published. -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx index 50358585666..aee11356a27 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx @@ -5,7 +5,7 @@ description: "Search for groups based on given criteria." sidebar_label: "Query groups" hide_title: true hide_table_of_contents: true -api: eJztWVtz2jgU/isaPe3OukDatNv1G6VJN7u9ZAPpPlBmItsHrEaWXEkOYRj/950j2WDAAbrTfVoywwSso3P9viNZWlLLZoaGY/pOqyKnk4CqHDSzXMmrhIbUANNx6gYNDWgCJtY8x2Ea0qEbJFOlycxJkIgZSIiSZMYfQJJYcwuas84XSQOq4VsBxr5RyYKGS/eTa0hoOGXCQEBjJS1Ii2MszwWPnRvdrwaNLamJU8gYftv0wjlHvKOkstGhAWVCfJrScLykdpEDDamKvkJsaUBzjUFaDsbpVdruah0qbcmUg0jWUdCgVsW0ZgsaUG4hc0qONeY07lobpVAZs4qgQyRaNMwZq7mc0TKgSieg2+e7IcIlmac8TleKbApEg2AWEm8C9YIsMqx6fzigAX17MRxg6ROYskJYGlbPLbcCqlx8Qu0XOK0sg0btxlVIk4a4K8VfBegFzrzxJaHlBGfmbAa7/l+zGZeu3BvZPjqrWmXtSeEygUeipsRVyiXFMm0ruHA5Izi3kWouLcxA04BOlc6Y9Y9ePMfkC57xFqignYw98qzIiCyyCPSGQQ220BILoyQ0AXqERe9mf2rbin61Csljn6FYhwyU9vV2Y1j+O8GMxVJ8ZqIAc0eq7C3QT0ZyDQ9cFWbNIZMraWAf3jfrUa5cfQNTpVsKvO1r5ORanZ1y/V97W7aC9ZrNYA3WoCXGlklPT9ilvmgtI8Jn1uxhXtBsEqCt53nBGlL0kAOSZdDIRtVUtps6uoOSmG1bu9bZCN9Zv3TGN8m9IdCWpNI3D18x59TzXm9PSppVLoRjzY9ZJdaYObbHHGxcXHr+4ncWqcK33g3/99b0X6ja77FVlomrmgNbGcaxqkdlzPpWiEZaFrv2BvXqHBvUFlnbS+nWoQcnUKPKzXP2sTH6NQrDIgZsh9waIDblph67azaXu2qlxG4gCUhToO+7ffWInrXZF492Hqd9r++uh/8w1/c1MA/tLUZukHElcQhB/AnwuAWvAo3n6T7njyCiy+ZhRDtbf8KikZI1OJ/qqvfgtlK72D2+H3pFKN/BicwYPpOQfABc7P+ERbNGdfgtSAKLlb+HhUNS5mYbUmurF8Cq4e5W/2ke7vReZH3L41YUOLHzvW24Ltc3nEmmjAtIOuSD0kASsIwLQ5gGXKgfeAJJgxa+upFKFv4d4InunWsVCch+OdTF++TaS1Z2iQcKYYZ4wchbH99cDshv5y9/nfyUWpubsNudz+cdPY2fQcKt0h2lZ109jfGDcj93yCgFjbhekAgISxKONpkgawgSk0PMpzyuS1W5TbBAPr4DHdmN7iJuVc9C8x3o9MntzRXhCUjLp4u6T2+Yps29u1swwkgweU/XADgE8z4xRZYxvaib3KYB3OBZZovDeHzxvBX8v49G18SrILFKwL01uj5ZGcIgMi5xF03D814voNWemoaver0SdWLFj4hEEnjMBavW0q1wuCTZGrcuMC6NZTL+UZVRms/4tt3NDVQF4rc+opqBZ+0MrJYHIlh8b3Al4glhhU3Raly/M4FzggmzZ4t0ItmJZP97kr3Yxful0hFPEpAOniu+cUOksoQJoeaQnHh14tWJV0/x6mXb9rGPL7IWNOIQtFaaqDgutIYEjyiFUx+DMbXtxnvQiWknpp2Ytsu0MqAZ2FTh1Uyu3JlfzmxKQ9r17+Fd/6ZG8TxWP4A27qCp0IKGdOnpUobd7jJVxpbhMlfalt0HrMUD05xFwiMQhz2targIFTORepO7ZcOB5qHhgGWFTBh5TW4uhiPyjlmYs4VLY766bqlVv+697rVqRdEnNPavr4iP0IOu0Qhqtcjo9vdwJ3yM4hKPSAzEheZ2McRpPj0RMA26X2DmV2Co7Dnt+NsL0aD6cllD5I+/R67K2MRu1ldiF48syz0F1yfF/oiicf/jL6vGq4uk1dBkfbXib0N6q/uK3tY9wnjpw2qe1+Oz0oF8qlxMFQR3s4NQAW18Onuds124X1851sYqywrpWreckTm3KWGNbMeiMHhfQdHPGPAoYh1wLfbej5DP3iI56yBSPJzrjj3jNi2iTqyybuynrf5HQkXdjHHZrUyY7qD/4fbj2/6z91eDi4/Di2dnnV7HPvrjQGRUxmTDD3dUUh1xbQe6XK9S33sTWiHGwqPt5oJxiaV1US0rPo/pymjF6ElQsXJMl0vUfqtFWeJjdypDw/FkTWL8VQY0BZb4itN7PDWjA+/xsxE6gOKicGdW2wfpZVDP6Mcx5Hav7KTRlK4/DUcI+eqON1MJztFsjve/bE5D+oV+oRSvmVGDY5N7vqSCyVnhIEy9Xvz7B9HxoJE= +api: eJztWm1v2zYQ/isEP22YIjtt1nX65qZJl/Uty0v3wQ0QSjpbbChSJak4hqH/Phwp2bKtOG6QYd3mAkFt8Xh3vHueO4rmjFo2NjQa0jdalQW9CqgqQDPLlTxJaUQNMJ1kbtDQgKZgEs0LHKYRPXeDZKQ0GTsJEjMDKVGSjPktSJJobkFzFn6WNKAavpZg7CuVTmk0c1+5hpRGIyYMBDRR0oK0OMaKQvDEudH7YtDYjJokg5zhp2UvnHPEO0pqGyENKBPi44hGwxm10wJoRFX8BRJLA1poXKTlYJxepe261nOlLRlxEOliFTRoVDGt2ZQGlFvInZJtjTmN69YuMqiNWUXQIRJPW+aM1VyOaRVQpVPQ3fPdEOGSTDKeZHNFNgOiQTALqTeBekGWOWZ9cH5IA/r66PwQU5/CiJXC0qh+brkVUMfiI2o/wmlVFbRyN6yXdNUSd6n4owQ9xZlnPiW0usKZBRvDuv+nbMylS/dStLeOqlZ5d1C4TOGOqBFxmXJBsUzbGi5cjgnObYWaSwtj0DSgI6VzZv2j588w+ILnvAMqaCdndzwvcyLLPAa9ZFCDLbXExCgJbYBuYdG7ORjZrqSfzJfksc9QLCSHSvt8uzFM/7VgxmIqPjFRgrkmdfSm6CcjhYZbrkqz4JAplDSwCe/L+ajmrr6CkdIdCV71NXZync6OuP67va06wXrKxrAAa9Cxxo5J909Yp77oTCPCZ9yuYV7QLBOgq+Z5wQZS9CEHJMuhFY26qKwWdXQHJTHatnEtXFq+s37sjC+Te0mgK0iVLx4+Y86pZ/3+hpC0s1wKx5qn6RJrmJnHbNua82Ah49LzGT+zWJW+FC+tZ2OOH6Fqs8dWWSZOGk6sRBzH6pqVM+tLIxrpaH7dBevFARasFfJ2p9b1pVsn0KDMzXP2sVD6noXLIgZsSC4NEJtx04xdt4vNdd05sTpIAtKU6Pt6nd2ihi3Xya2dx2nf6rur6U/m+qaC5qG+wtAlcs4lVhHD7wGLa3g1SDxPNzm7BRFd9DazcVnLK2aALJx1e1Cn+eQeRY8thb4yo3xHDURj6ElH6Ny8tzD9Fis3MA2RRMwYPpaQvgfcTLyFaTvnTXg7kAkWkXQDU4fM3M02pNHWNNi6oK+jqdlldi6z43EnhtD9Vlm+lWmYsLyUKQtZwUN0LvSbpJ8eV7LJW5gSZq3mcYnbBmZw0wWaJzUrQxecQkOCe14aWV3CrszvyvyuzH8nZf7JGfzvbw0Lrm3sDV1U/Ieaxf3VoTMUH8q5d1s1kiX5LVqKT9MjW8ruLWDXHnbt4XtpD7u3gP/AWwCKHWw82mmS/xVnkhHjAtKQvFcaSAqWcWEI0y67tzyFtEUqj5VYpVP/u8I9J0KFVrGA/MGeMCCnXrK2SzxacFviBWNvfXh2fEh+Pfj5l6sfMmsLE/V6k8kk1KNkD1JulQ6VHvf0KME/lPsxJBcZaGTJlMRAWJpytMlEG7OmgISPeNIkpnabYDr8+h6o5250HV7zqlxqvgaUAbk8OyE8BWn5aNpU+SXTtP17gGs3USyYvKELADyE6QExZZ4zPW1K5LIBPDS2zJYPbyueP+uE+m8XF6fEqyCJSsHx31XZ2hAuIucST+ZpdNDvB7Q+p6fRi36/Qp2Y8S1WIgncFYLVnXhlOVySfIFbtzAujWUyearMKM3HfNXucimqQfzar6hh4H43A+vmQgRLbgz2MZ4SVtoMrSbN7zDgnGDCbDh23ZFsR7L/Pcmer+P9WOmYpylIB88537ghUlnChFATSHe82vFqx6v7ePVz1/ZxgK/BFjTiELRWmqgkKbWGFK89CKc+AWMa2623qB3TdkzbMW2daVVAc7CZwutehXL3CApmMxrRnn+r7/k3NYp3PPQtaOPexEstaERnni5V1OvNMmVsFc0KpW3Vu8Vc3DLNWSw8AnHY06qBi1AJE5k3uZ42HGhfRDj0Z37kJTk7Or8gb5iFCfOvysX8Clej+mX/Zb9TK4reo3FwekL8Cj3oWoWgUYuM7n7rdsLbKK7wlMBAUmpup+c4zYcnBqZBD0qM/BwMtT2nHb97IRrUH44biPz+54XLMhaxs8U1u6M7lheegovbJ/7Uo3WnzF+AG84vp82HrhbXtfwNq/78DlR/5W7ScOaX1b4DhM8qB/KRcmuqIbgeHYQKaOPD2Q/31+F+euJYm6g8L6Ur3XJMJtxmhLWinYjS4B0oin4mgEcRiwU3Yu/8CPnkLZL9EJHi4dxU7DG3WRmHicp79VHz/P9YqLiXMy57tQnTOxy8v/zwerD37uTw6MP50d5+2A/tnT9MREblTLb8cEcl9YHZ6kJniy71rbcra8RYuLO9QjAuMbVuVbOaz0M6N1oz+iqoWTmksxlqv9SiqvCxO5Wh0fBqQWL8VgU0A5b6jNMbPNiih97jvQt0AMVF6U6oVi/nVEEzY5AkUNiNsletonT68fwCIV/fG81VinM0m+CdUjahEf1MP1OKV1dRg2OTez6jgslx6SBMvV789xfqtf8r sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -57,7 +57,23 @@ Pagination information about the search results. The matching groups. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching groups. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching groups. + +
    • Array [
    • ]
    The group search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx index 81cf8bef87c..e3bda88d497 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx @@ -5,7 +5,7 @@ description: "Search for roles based on given criteria." sidebar_label: "Query roles" hide_title: true hide_table_of_contents: true -api: eJztWVtv2zYU/isEnzZMlZ026zq9uW66Zesli53uwTUQSjq22FCkSlJxDEP/fTikZMu2nLhY9zQHMGKL5Ll+3yF1uKKWzQ2NJvRaCaDTgKoCNLNcycuURtQA00mGY4YGNAWTaF7gKI3oyI2RmdJE4wQSMwMpUZLM+T1IkmhuQXMWfpY0oBq+lmDsa5UuabRyP7mGlEYzJgwENFHSgrQ4xopC8MQZ0ftiUNeKmiSDnOG3bSPQNOKtJLWKkAaUCfFxRqPJitplATSiKv4CiaUBLTR6aDkYJ1Zpuy90pLQlMw4i3ThBg0YU05otaUC5hdwJOVaZk7ivbZxBrcwqggaReNlSZ6zmck6rgCqdgu5e74YIl2SR8SRbC7IZEA2CWUi9CpQLsswx44PRkAb0zcVoiHlPYcZKYWlUP7fcCqhj8RGlX+CyqgpaqZvULk1b010q/ipBL3HltU8Jraa4smBz2Lf/is25dNneivbRUdUq7w4Klyk8EDUjLlMuKJZpW8OFyznBta1Qc2lhDpoGdKZ0zqx/9OI5Bl/wnHdABfXk7IHnZU5kmcegtxRqsKWWmBgloQ3QIzR6Mwcz25X0y7VLHvsMp4VkqLTPtxvD9N8KZiym4hMTJZhbUkdviXYyUmi456o0Gw6ZQkkDj+F9Ox/V2tTXMFO6I8G7tsZuXqexM67/a2urTrBesTlswBp0+Nix6PCCzXQsUF1LKk8lb78z9Hm/340vX103LpfCQei7VMxN/I7l25Mk5tJjGb+zWJW+DG2Zb7YV/mtRj1tslWXissHDTnxxrOZrzqwvC6iko/B3k/XlOZJ1B7jdiXQ1+d5NQDxbV/i1sU4/Fglfr9EtYsCG5MYAsRk3zdhtm2i39a6BzJAEpCnR9v0acwR/t2vE0cbjsm+13dWz72b6Y2T20K63nk72rmc8hSB+ADyu+NegcSx9zPanaehi+TSe72DZisUGld2Vg9yBO07sY1ayHFqC6oPGQTk4PcR1zBg+l5C+B9zv/oRlOzWN2x0AAosJv4OlA1DuVhvSSGv2ANQVduT8MPva+cWwItX3n3Zm3s06f6zwNjn6igvJjHEBaUjeKw0kBcu4MIRpwH3qnqeQtpjgUxqrdOlPwAfqdaFVLCD/6am6PSBXfmatl3h0EGaInxh77ZPrt0Py6/nPv0x/yKwtTNTrLRaLUM+SZ5Byq3So9LynZwl+cN6PIRlnoBHKSxIDYWnKUScTZIM7YgpI+IwnTZpqswlmx/v3RBF2o/tgWyez1HwPNgNyc31JeArS8tmyKc1bqmn76Or2iCgWTN7RTfqfQviAmDLPmV42dW1bAZ5vLLPl02B88bwT+L+Px1fEiyCJSsG9MrnSWCtCJ3Iu8RBJo/N+P6D1kZJGL/v9CmVixo/wRBJ4KASrt88dd7gk+Qa3zjEujWUy+V6ZUZrP+a7ecOv4VIP4jfeoIeDZAQL6HYEIltwZ3Hx4SlhpM9SaNK8M4IxgwjxyKDqR7ESy/z3JXuzj/a3SMU9TkA6ea75xQ6SyhAmhFpCeeHXi1YlXh3j1c9fpcYDvrhY04hC0VpqoJCm1hhQ7dMKJT8CYRnfr1efEtBPTTkzbZ1oV0BxspvBaolDGQYfZjEa05169e/5FjWI3Ut+DNq61VGpBI7rybKmiXm+VKWOraFUobavePabinmnOYuEBiMOeVQ1ahEqYyLzG/azhAL4ZN94MWV7KlJFX5PpiNCa/MQsLtnRRLNaXDY3oV/1X/U6pOPWAxMHVJfEeesy16kAjFgnd/QruJh8juMKmiIGk1NwuR7jMhycGpkEPSgz8Ggu1Picdf/tJNKi/vG0Q8sffY5dkrGHXm/ugiweWF56B/j5msr4rWd9+TDe3B77h31+35Ps7rfLJytvebknjs8oBeaac4TXM9kOAeABtfMz64dk+pK8uHTMTleeldOVZzsmC24ywVkgTURpsyVO0MwHsNkSruuWyVvvOj5BPXiM5CxEOHrNNVZ5zm5VxmKi8l/hl6/+xUHEvZ1z2ahWmNxy8v/nwZvDs3eXw4sPo4tlZ2A/tg+/yIWtyJlt2uG6I71zt+rnabETfeNNXg8LCg+0VgnGJMHU+rWrGTmijsubsNKh5N6GrFQq/0aKq8LFru9BoMt3QFH9VAc2ApT7dviFGh97eZ2PUj9NF6RpSu73xKmhWDJIECvvo3Gmr6lx9HI0R1PUVZq5SXKPZAq832YJG9DP9TCneoaIExxf3fEUFk/PS4Zd6ufj3D0PWNyI= +api: eJztWltv2zYU/isEnzZMkZ027Tq9uW66Zesly6V7cAOEko4tNhSpklQcw9B/Hw4p2bKtOG6XYS3mAEFskTzX7zuHYjinlk0MjUb0TAmgVwFVBWhmuZInKY2oAaaTDMcMDWgKJtG8wFEa0XM3RsZKE40TSMwMpERJMuG3IEmiuQXNWfhR0oBq+FyCsS9VOqPR3H3lGlIajZkwENBESQvS4hgrCsETZ0Tvk0Fdc2qSDHKGn1aNQNOIt5LUKkIaUCbE+zGNRnNqZwXQiKr4EySWBrTQ6KHlYJxYpe2m0HOlLRlzEOnSCRo0opjWbEYDyi3kTsiuypzETW0XGdTKrCJoEIlnLXXGai4ntAqo0ino7vVuiHBJphlPsoUgmwHRIJiF1KtAuSDLHDM+OB/SgL46Ph9i3lMYs1JYGtXPLbcC6li8R+nHuKyqglbqRrVLV63pLhV/lqBnuPLMp4RWV7iyYBPYtP+UTbh02V6J9s5R1SrvDgqXKdwRNSYuUy4olmlbw4XLCcG1rVBzaWECmgZ0rHTOrH/09AkGX/Ccd0AF9eTsjudlTmSZx6BXFGqwpZaYGCWhDdAdNHozB2PblfSThUse+wynhWSotM+3G8P0XwtmLKbiAxMlmGtSR2+GdjJSaLjlqjRLDplCSQPb8L6aj2ph6ksYK92R4HVbYzev09gx1/+2tVUnWE/ZBJZgDTp87Fh0/4LldCxQXUsqTyVvvzP0Sb/fjS9fXZcul8JB6FEq5kb8Fg7syr8HSc2lxzZ+ZrEqfVlaccesEv4fi9pusVWWiZMGH2vxxrGavzmzvkygko5G0E3e50dI3jUgdyfW1ehbNwHxbV0j0MY6/Vg0fP1Gt4gBG5JLA8Rm3DRj123iXdddBJkiCUhTou2bNWcHPq/WjJ2Nx2Vfarurb49m+jZye6jXraiTzYsZ64jh94DFFf8aJI6l22x9mIYudtu5uCrkJTNAlqa6vRgKPrlHzqpXkuXQCmK90Vjf5jUViOD0cKUUNqrQjI6o3cDsC8TfwCxE5jBj+ERC+hawm/4Bs3aim6B2wBEswucGZg6OuVttSCOt6TCoKuxAULPL6nJv82knatD2Vh2+lWmYsLyUKQtZwUO0LPRbhJ++qkaTP2BGmLWaxyX2TGZwxwGaJzUNQxeYQkOCGz4aWV3Cvq7v6/q+rn8Tdf3R+fv99oIlw7Y1gy7+/Tfd4f6K0BWCd+XCtl06x8r0HXqIz83X9ZD9Pn/fD/b94NvoB/t9/ne6z8dZR9sOa5p8f8aFZMy4gDQkb5UGkoJlXBjCtEvoLU8hbbHIwyNW6cyfmt9zxlNoFQvIH+wBA3LqZ9Z6iUcIbj38xNhrH529HpJfjp79fPVDZm1hol5vOp2GepwcQMqt0qHSk54eJ/iL834MyUUGGmkxIzEQlqYcdTLRhqkpIOFjnjRJqc0mmAvv3wMF3I1uImtRhkvNN0AyIJdnJ4SnIC0fz5qyvqKato+7XX+JYsHkDV2m/yE4D4gp85zpWVMTVxXgmahltnx4E/H0SSfMf7u4OCVeBElUCo7yrqzWitCJnEs8eKbRUb8f0PoYmkbP+/0KZWLGd/BEErgrBKtb75o7XJJ8iVvnGJfGMpk8VmaU5hO+rne1/tQgfuU9agh4eA8BfTchgiU3BhsXTwkrbYZak+bfDOCMYMJsOUjdk2xPsv89yZ5u4v210jFPU5AOngu+cUOksoQJoaaQ7nm159WeV/fx6lnX7nGA770WNOIQtFaaqCQptYYU/6svnPgEjGl0t16b9kzbM23PtE2mVQHNwWYKrzIVyjjoMJvRiPbca3zPv6hRvMGgb0Eb9+5dakEjOvdsqaJeb54pY6toXihtq94tpuKWac5i4QGIw55VDVqESpjIvMbNrOEAvmU33gz9ER95Qc6Ozy/Ir8zClPm35GJxQakR/aL/ot8pFafeI3FwekK8hx5zrTrQiEVCd79wu8m7CK7waMBAUmpuZ+e4zIcnBqZBD0oM/AILtT4nHb/7STSoP7xuEPL7XxcuyVjDzpZ3yI7vWF54Bvo7XKPF/arFO/7V8saRvyTUX1zj6a9drxnNve3tayz4rHJAHitneA2zzRAgHkAbH7N+eLgJ6dMTx8xE5XkpXXmWEzLlNiOsFdJElAav8VC0MwE8bVgc3yzUvvEj5IPXSA5DhIPHbFOVJ9xmZRwmKu/Vx8eLv7FQcS9nXPZqFaY3HLy9fPdqcPDmZHj87vz44DDsh/bOnxAia3ImW3a40xB/Crbu53zZiL7wdmANCgt3tlcIxiXC1Pk0rxk7oo3KmrNXQc27EZ3PUfilFlWFj92xC41GV0ua4rcqoBmw1KfbH1rRobf34AL143RRuuOn9fs0VdCsGCQJFHbr3KtW1Tl9f36BoK6vPeYqxTWaTfFKJJvSiH6kHynFe5cowfHFPZ9TweSkdPilXi7+/A2f/YcQ sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -53,7 +53,23 @@ Pagination information about the search results. The matching roles. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching roles. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching roles. + +
    • Array [
    • ]
    The role search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx index 79a284f5608..f06e6eca3a7 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx @@ -5,7 +5,7 @@ description: "Retrieves a filtered and sorted list of tenants." sidebar_label: "Query tenants" hide_title: true hide_table_of_contents: true -api: eJztWtty2zYQ/RUMntopLcmJk6Z8U3xp1dxcX9IHxTOByKWIBAQYALSs0fDfOwuQIiVStpJJ35QZTyQC2F3snnMAAlpRy+aGhlN6A5JJS+8CqnLQzHIlJzENqQGmo9S3GhrQGEykeY7tNKRXYDWHezCEkYQLCxpiwmRMjNIWYiK4sUQlxPrxAxpQDd8KMPa1ipc0XLmvXENMw4QJAwGNlLQgLbaxPBc8crEMvxh0uKImSiFj+GkzEh8h8eGSygkNqF3mQEOqZl8gwu9MiA8JDaerTkuuceaWg3F+lLZdL9dKW5JwEDGJNLegORs0TpjWbEkDyi1kzsi+zpzFnjmlUDmzymWUzJYtd8ZqLue0DKjSMej+8a6JcEkWKY/StSGbAtEgGBbJuUC7IIsMsTC+PqUBPTu/PkU8xJCwQlgaVs8ttwKqXHxA6+c4rCyDVi2n1ZTuWt1dZf4pQC9x5FVVofIOR+ZsDt34L9mcS1f+jWzvnVWtsv6kcBnDA+LSVcolxTJdo4fLOcGxrVRzaWEOmgY0UTpj1j96/gyTL3jGe6CCfjL2wLMiI7LIZqA3HGqwhZZYGCWhxuueHn2Y48T2FX2ynpKnAsNuA3KqtK+3a8PyfxbMWCzFRyYKMJ9Jlb0lxslIruGeq8I0lDK5kgYew/tmPcp1qK8hUbqnwNuxzly/3mATrv/vaMtesF6yOTRg3RaUHYPaA7apLnrLhnCxGxrme5pNxPeKnu/5iOhthuDdTOJWDiop2ZZ3DGpy5gR8Hd4AEShZBvsNx54dA62k+SlcuBlsasJmj77kll50fKXd1J6NRo+ltg0PlLSftto0YNtXnJ5UPC498fEzm6nCa/ZG/I9i4wdMPQEbZZmY1OTZyge2VeKWMes1FJ30rJL9yvbyBHG1xfL+WroF7N51qJHlxjn/qKh+ccNpEQN2QG4NEJtyU7d9bqvS52qJRRmRBKQpMPauIO8hdpuCunfwOOx7Y3fi/9NCf0z5PLS3OLnBxnWPpxDEd4DHrZQ1aJqd4q7o96Giy+cemHaD38CylZUGn90wC8m/FUDM0ljIjuYgcasMMcExWjJRS/jkbNCL7/11szKEA5zifp9oV3HCQzesMqDMGD6XEL8D3Ja8gWUbFHW6e6ALbi//FZYOupkbbUhtrV6qa5Xv4m0387t6j0LT97wXea7fyS7tz7W65zHEJGaWEW6IVI6C3G16d6wAuVYzAdlvT60EY3Lpe5IYLOOCeKQRZojvOHPwINOri1Pyx8mL3+9+Sa3NTTgcLhaLgU6iI4i5VXqg9Hyokwj/sN+vA3KTgkZqLMkMCItjjj6ZIA2Gickh4gmP6uRXYRPM+OCTfJoArrULqXWBCs07YBiT26sJ4TFIy5NlLfUbrmn7vcGtOeFMMPmVNgV9CsdjYoosY3pZ6+SmA9xcWmaLpwH2/FkvnP+6ubkk3gSJVAwkUdpLbeUIJ5FxiTt4Gp6MRgGt9vM0fDkalWgTK77HTCSBh1ywajnemg6XJFMaKvy4iXFpLJPRz6qM0nzOt/1ubsMqEJ/5GdWEOu4nVLXCEMGir8YzibDCpug1qt/XwAXBhDmQ7ECyA8l2k+x5F+8XSs94HIN08FzzrVq6mBBqAYfF68CrA68e4dVJF+/vlSWJKmR8oM6BOgfq7KDOi74XqbFsXnJBa6WJiqJC433PIuXCmY/AmNp3fQrhsHjg2oFrB651uVYGNAObKrxozZU7us+ZTWlIh9U52NCfa1G8SdH3oI076S20oCFdeb6U4XC4SpWxZbjKlbbl8B6Lcc80ZzPhIYjNnlc1XoSKmEi9z27dsKF9cn/KskLGjLwiV+fXN+RPZmHBli6P+fqitDb9avRq1GsVu+6wOL6cED9Dj7qWEtRmkdL951Ku8z6GSzyjNBAVmtvlNQ7z6ZkB06DHBaZ+jYbKn7OO330nGlQfLmqM/P3vjSszqthVc7l9/sCy3HOwufNpTvEasPkzwdZtrr96nq6vhddNd81Fqb/bHK1vH0dbt4LTlZ9q+/YNn5UO+YlywVS47GYM4QPa+BSPBsddDlxOHJUjlWWFdHou52TBbUpYqwKRKAzePlKMMwI8qwtX9YTrbm99C/noPZLjAaLHQ7yW8Tm3aTEbRCobRn7Y+v+ZULNhxrgcVi7M8HT87vb92fjo7eT0/P31+dHxYDSwD/6MHmmWMdmKw50l1ufO2zNdNWvXj/zYoYKShQc7zAXjEuvrpraqmD6ljeeK63dBxdcpXa1mzMCtFmWJj79hqDSc3jX0xm9lQFNgsa87/Yqn2fTUh310gxFgd1G4093tS64yqEeMowhy+2jfu5ZeXX64vkEyVL/jyFSMYzRb4G882IKG9BP9RCn+ngQtOJ655ysqmJwXDsjU28V//wFI1fp4 +api: eJztWmFv2zYT/isEP22YI7tttrfTNzdJN69bmyXp9sENUEo6WVwpUiWpOIah//7iSMmWbDlxsw7bBxUIaonk3fHuee4k6tbUsoWh4ZzegGTS0tsRVQVoZrmSs4SG1ADTceZHDR3RBEyseYHjNKRXYDWHOzCEkZQLCxoSwmRCjNIWEiK4sUSlxPr1AR1RDZ9LMPaVSlY0XLtLriGhYcqEgRGNlbQgLY6xohA8draM/zKocE1NnEHO8FfXEm8h8eaSWgkdUbsqgIZURX9BjNdMiHcpDefrvZFC484tB+P0KG33tVwrbUnKQSQk1tyC5izYKmFasxUdUW4hd0KOVeYk9uwpg1qZVc6jJFq11BmruVzQakSVTkD3r3dDhEuyzHicbQTZDIgGwTBITgXKBVnmiIXp9Rkd0fOL6zPEQwIpK4WlYX3fciug9sU7lH6By6pq1IrlvN7SbWu6i8zvJegVrryqI1Td4sqCLWDf/ku24NKFv+Pto72qVd7vFC4TuEdcukg5p1imG/RwuSC4tuVqLi0sQNMRTZXOmfW3XjxH5wue8x6ooJ6c3fO8zIks8wh0R6EGW2qJgVESGrweqdGbOU1tX9Bnmy15KjCcFpAzpX283RiG/6NgxmIo/mCiBPOR1N5boZ2MFBruuCrNllKmUNLAQ3jvxqPamPoKUqV7Arxra+Tm9Rqbcv1PW1v1gvWSLWAL1t2EcmBRe8Eu1UVv2BAutpPD/EzTRXxv0vMzH0h6XRO8mlnS8kGdSnbTOxo1O3cJfGNegAiULIfjluPMPQEtp/ktvHY76OaE7ow+51Y+6fhIu609n0wecm0bHpjSvlq12QPbF9ebRzMglz4R4G8WqdLn8M5+HsTKE0Q9AiNlmZg1ZNrxD47VyS5n1udUVNJTNfsz3Q+niLMd1vfH1hW0OzehQZpb5/RjhvXFDrdFDNiAvDdAbMZNM/axnaU+1iUX04okIE2Jtu8n6COSXzfBHm08LvtS210x+GqmP5QJPdR3ONph52bGLmL4AbC4StmAZPukeMjaY6jo/PcwH7tiXjEDZGsuSZUmXvTsgKTu3o7PiHWWxwUul35ZOi4l/1wCgXsLWjLRSJud96VVNB031hMLv+4NrL5IrVkZC/nJAiS+I0BCkLx7dowoM4YvJCS/AT74vIFVG2ZNQHvIAO5t4ROsHBlyt9qQRlrzMNDUkX0EN4/E/a7ou9+LXNxBqxrcySSIWV7KhAWs4AHaF/hnuu+eWCnIG1gRZq3mUYmPOczgQyJoHtfJIHAOKjTE6GcaWl3CUF2G6jJUl/9MdfnqHB4q0m5F2rL375WkPvb/WzXqcEbqd9fbcmPfcfWrs+CISuZj+9RKNrzzDFVpqEr/nao0vPMM7zxPeufBeaeHzs8Kre54AglJmGWEGyKVozB3Hw4OnKIVWkUC8kcry5Rc+pkkAcu4IB5v+EDlJ0bO62R+9fqM/Hj6/f9uv8msLUw4Hi+Xy0Cn8Qkk3CodKL0Y6zTGP5z3bUBuMtBItRWJgLAk4aiTiTbsTQExT3ncuLo2m6B/gw/y8aLgRvcRtUntpeZ7oZ+S91czwhOQlqerplR0VNP2txdXs8JIMPmJbgP6GIynxJR5zvSqybNdBXhAb5ktH388efG8F7w/39xcEi+CxCoBl0Jcqq4V4SZyLvErCA1PJ5MRrb+J0PCHyaRCmRjxI3YiCdwXgtXlfGc7XJJcaajx4zbGpbFMxl8rMkrzBd/V280/NYjP/Y4aQj3rJ1RdoYhg8SfjmURYaTPUGjffvMAZwYQZSDaQbCDZYZK92Mf7a6UjniQgHTw3fKtLFxNCLWEoXgOvBl49wKvTfby/VZakqpTJQJ2BOgN1DlDn+74XqancvjuC1koTFcelxp65ZcaFEx+DMY3u5hTDYXHg2sC1gWv7XKtGNAebKWxWLZRrfyqYzWhIx/W52tifk1HsRtN3oI07Ciu1oCFde75U4Xi8zpSxVbgulLbV+A6Dccc0Z5HwEMRhz6sGL0LFTGRe537ccKDd/XTmz93JS3J1cX1DfmIWlmzl/Fhsmk0b0S8nLye9UnHqAYnTyxnxO/Soa2WCRixSuv8Uyk0+RnCF52oG4lJzu7rGZd49ETANelqi6zdoqPU56XjtJ9FR/eN1g5Ff/rxxYcYsdrVtEL64Z3nhObjtm9ueHW7B5k8iWx2xvn13vmmt3QzdbptNfX/oZNPBOdnprJyv/VbbHYx4r3LIT5UzpsblvscQPqCNd/EkeLbPgcuZo3Ks8ryULp/LBVlymxHWikAsSoMdnBTtjAHP6jZHrxu1v/oR8ofXSJ4FiB4P8SaNL7jNyiiIVT6uPwFt/o+EisY543JcqzDjs+lv79+eT09+nZ1dvL2+OHkWTAJ778/4kWY5ky073Flic469u9P1tnY9pWG8hpKFezsuBOMS4+u2tq6ZPqdbzTXXb0c1X+d0vY6YgfdaVBXe/oym0nB+u6U3XlUjmgFLfNzpJzwjpmfe7JMbtACni9Kd5e42ClajZsU0jqGwD869beWry3fXN0iGuhc+Vwmu0WyJffJsSUP6gX6gFHvyUYLjmbu/poLJRemATL1c/Pd/PgWu1w== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -57,7 +57,23 @@ Pagination information about the search results. The matching tenants. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching tenants. + +
    • Array [
    • ]
    Schema
      page object
      + +Pagination information about the search results. + +
      items object[]
      + +The matching tenants. + +
    • Array [
    • ]
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js index f8ca4248cdc..3540f685a93 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js +++ b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js @@ -597,6 +597,18 @@ module.exports = [ }, ], }, + { + type: "category", + label: "Usage metrics", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-usage-metrics", + label: "Get usage metrics", + className: "api-method get", + }, + ], + }, { type: "category", label: "User task", diff --git a/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx index 2fed02030c9..f69c378a56d 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx @@ -5,7 +5,7 @@ description: "Updates an existing tenant." sidebar_label: "Update tenant" hide_title: true hide_table_of_contents: true -api: eJztWFFv2zYQ/isEn1pMsZw27Tq9eWm6ZuuKIHW2h8QPJ/FssaVIlaTiGIb++3CkFDuW02RAHx0gsEQe73j3fR8l3Zp7WDieXfMpatCezxJuarTgpdHngme8qQV47GYTLtAVVtY0zTN+FSYdA83wTjov9YL5YDriCa/BQoUeLQVYcw0V8ozH+b9wxRMuyUkNvuQJt/i9kRYFz7xtcDfStETWaPm9QSYFai/nEi0zc+ZL3ArpihIr4Nma+1VN0aT2uEDLEz43tgIfh96e8LadxZjo/O9GrGhNYbRH7ekS6lrJIpQh/epoC+uhc5N/xYKqUlsqmpfoaDYmem/lvJV6MagdZaRxych6N5G23a7HdfQ4S7iXXpHLCEes/mXMgbcPF1ERw4CrjXZxY6/GY/oZ7iPGZUtwLOItmGuKAp2bN0qtqLI/qTYb9Pdh9CjmbuU8VkcL1MRNFIzWWA2q3/r5+z0QJ104IvJz4OiC4d3Ad5v8H1QfQXQ/ehEfgq9N+MljCNXW3EqBggnwwKRj2nh2C0qKH4BTW5MrrH4ZgvQwwIRdREsm0INULILHwLFomIeKs+vLD6fst5M3v85elN7XLkvT5XI5svPiCIX0xo6MXaR2XtA/2b0csWmJFlkFK5YjAyEkxQTFNrRgrsZCzmXBvAk167bNqNKjG82TpzgVZofI3NOhsXIA1IRdXZ73Z8kqHFy7ocOaOTSKfEBuGp/lCvQ3vsHyKTpMmGuqCuyq58PDAG3CnQffuCdPrNev9lLt43R6waILVhiBbG4s86V0fSBKopJaVk3Fs5PxOOEV3MW7t+NxSz4J8WdkQkd8rUAHau2mIzWrjMWOPyExqZ0HXfwsZIyVC7kb96GuOhK/jxn1gno95PsHY3MpBOpAT9Y9BXpVgVJmiQddHXR10NUPdHUy5Ptn49ncNFpEXW29Vej7mYOqDqo6qOoRVb3Z9/o30Zu3XbTWWGaKorEWBVuWUgX39Krex+4eZ5GLB60dtHbQ2lBrbcIr9KURsQFRlKFf4Uue8TQ+t1y6vv9Ybam1gPa2b2U0VvGMr6Nq2ixN16Vxvs3WtbG+TW8JkluwEnIViUjTUV09a5QpQIXhfejRxPZn5ClUjRbA3rHLsy9T9gd4XMIqVJNCPnT9bvxuvNcrmT7icXJxzmKGkXtb50HvloS91200fo7j0HRxWDRW+tUXWhbLkyNYtJOG6n/PiS5e8E730Ygn3cWHnil//jsNYNNZdrlp6JzdQVVHJXadp45kgYFzEyJ1/BjumQBE62KS49HxkIsX50FShamqRodzVS/YUvqSwVYNCtU4T7knXMkC6Ut/s6He7FOcYf/EiOx4RPhFkvXH6UL6sslHhanSIi67/82VydMKpE67EC49nfx99fn95OjT+enZ5y9nR8ej8cjf+VCn2jhfgd7aR2xFdO9ru5lutcWe6Pd1uHm882mtQGoqdchi3WnrumvIOJ7wbNMKmiWdQK75ep2Dwyur2paGvzdoVzy7nm30FAQopKNrwbM5KLfbLdze8ovLriX2kj2zh7g3jW4Q9CpIWzV0xxP+jTpZW12tdtYmvEQQaMNG4/xp3M7RlLxs1g8aaW3Sr5gUBdb+h7azrSPsYjI9/UjS6DqZlRG0yMKSOquw5Bm/4Te0YRNqFFQXxtdcgV40sCD76Jj+/gPNmZ2D +api: eJztWVtv2zYU/isEn1pMkZw27Tq9uWm6Zm2zIHW2h8QPlHhssaVIlaTiCIb++3BIKZYvuXTrywAHCCyRh+f6fRR1tKSOzS1Nr+gEFFOOTiOqKzDMCa1OOU1pXXHmoJuNKAebG1HhNE3ppZ+0hCkCt8I6oebEedGYRrRihpXgwKCBJVWsBJrSMP8RGhpRgUoq5goaUQPfa2GA09SZGjYtTQogtRLfayCCg3JiJsAQPSOugIFJmxdQMpouqWsqtCaUgzkYGtGZNiVzYej1EW3babAJ1r3VvME1uVYOlMNLVlVS5D4NyVeLLiy3levsK+SYlcpg0pwAi7Mh0Dsp64xQ863cYUQKFgSlNwNp22E+roLGaUSdcBJVhnKE7F+EGGi7vgiT6AdspZUNjr0YjfBn249glyyYJaHenNg6z8HaWS1lg5n917lhUv458wBYt/uWWSCrxJGZNmQ9ruA5Gn8438F7ROtTct6hCG4dGMVkH/vpO9pGP1K6e8q2u0QhFAyZIu52+Y+M+JEAbGMdlAdzUEhX4AShvh7R4x55gWE9bxSPc1bWirOYVSL+Bo2NVV1mYH7ZrjWHykCO1nvW7qv/M6q/2rX+W/l37HoP+3jmK/0RGvs0ZIQU7UDGHgf/r10ARY7uezxURt8IDpxw5hgRlijtyA2Tgj/wZKiMziSUO3eNoYExOQ+ShINjQpJQX8IsCYKZj4pcXbw/Jr8dvfp1+qxwrrJpkiwWi9jM8gPgwmkTazNPzCzHf5R7HpNJAQZIyRqSAWGcC7TJ5BBwtoJczEROnPZV7NwmWIH4Wj0OOz+7XbE74tVGbBVwTC4vTvuDTONPTZum/ZoZqyXqYJmuXZpJpr7RVS0fg8mY2LosmWl6hK4baCNqHXO13bnxDDeOly92QvDDZHJOggqSaw6evK4QtjeEQZRCibIuaXo0GkW0ZLfh7vVo1KJOrPgTIsHzZSWZ8tDaDEcoUmoDHX58YEJZx1T+syqjjZiLTbvrvOpA/C5E1BPq5Tbe32uTCc5BeXiS7gjas4pJqRew59WeV3tePcCro228n2lHZrpWPPBq8Eqj7mb2rNqzas+qe1j1atfxb6xWJ0owRhui87w2BjhZFEJ69dgn6G13j7OAxT3X9lzbc22ba21ES3CF5qH7mRe+WeoKmtIkPLdssrx7H2yxrwnmpu+j1kbSlC4Da9o0SZaFtq5Nl5U2rk1usCQ3zAiWyQBEnA7s6lEjdc6kH95VPZwYvtgeh7d+8oZcnHyZkN+ZgwVrfDbR5LrqN6M3o51aUfQejePzUxIiDNgb7Ae9WiT2TrVB+CmKfcfXQl4b4ZovuCykJwNmwIxrzP8dJjp7XjveByEadRfve6T88ffEFxv3sotVN/nklpVVYGLX9u5A5hE4095Sh49tn7GAYGwIchQfbmPx/NRTKtdlWSu/r6o5WQhXEDbIQS5r6zD2iEqRA77prxzqxT6FGfJXsEgOY6xfAFm/nc6FK+osznWZdC2gu99M6iwpmVBJZ8Imx+PPl2fvxgefTo9Pzr6cHBzGo9jdOp+nSltXMjXwI7QiuvPaZqSDnvwjHxu6ujm4dUklmVCYah/FsuPWVddisTSi6arbMo06glzR5TJjFi6NbFsc/l6DaWh6NV3xKXSwhMVrTtMZk3bzU8XQ5WcXXT/+OXniB4ydYXSDTDWe2rLGOxrRb9gsGjSO2mkb0QIYB+MdDfPHwZ2DCWpZrd/q4rdRv2Kc51C5B2Wngy3sfDw5/oDU6D6jlJrjIsMW+FmHLWhKr+k1Oqx9jjzr/PiSSqbmNZujfFCMf/8AhP03lQ== sidebar_class_name: "patch api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Updates an existing tenant. The tenant was updated successfully. -
    Schema
    +
    Schema
    Schema
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx index 455e45a6940..f8240c2d514 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx @@ -5,7 +5,7 @@ description: "Update a user task with the given key." sidebar_label: "Update user task" hide_title: true hide_table_of_contents: true -api: eJztWW1v2zYQ/isHflm3ybKSOF2rb17abdlLFyTOBiwJUFo622wlUuNLHMPQfx+OlGz5JU3Wdd9cIKhj3hvv7nnIHJfM8qlh6Q27NqjBcvOR3UVMVai5FUqe5yxlrsq5RRIY0XrEcjSZFhUJsJRd+2Xg4FoTMBd2BnaGMBX3KOEjLmIWsYprXqJFTQ6XTPISyXpj9xdcsIgJslhxO2MR0/i3ExpzllrtcNvtaIZkGNTEe1o7twpCxOTTZDMsOUuXzC4qciekxSlqFrGJ0iW34auXA1bXd8ElGvu9yheks45gwguDEcuUtCgtrfGqKkTms9T/YCik5a43Nf6AmaW9a8qpFWhoNZtxOUWD3tDmtn6++v0dBLWQxiCbh71xa7UYO4twzwuHJr6Vt5IyMVFFoeZCTtciBjIuYYzA8w/OWMzbsggDKPNKCWkj4HkuyDUvOpq3ci6KgnTFVCqNeUp+voH3GZe5oNz+qJWrzHvogaZ9wHgBlVb3IvchSMCysgsohLGbetRFz1fLHb7hFp+Sv7JayKnXCHm4rv6lWqWF0sIuSKUUUpSuhCSCkj/4j0dJEkGOE+4KC6cJJeOiY69pQmWwm32fbQ7vpSuK96FeoDSoUlhLesJCReHpe0o49XCF2ghfqZWZr0zQXBWaGyOmEpGKK5V9sr7OoMfH0OuFLmpXYzLppY3T1C9Ka+o7vEdpAUthjFASJkp33IbWjW8li3a6nLbKxwW2iF0310Wn/8PaJiKaSnegY3x1ujil/ulZUeIOBVFicofgiaghBNppDJdP1j/eibsmn+s2+g8xBTM9V325yDaR1ImNa80Xe6MgOJHvlaonS/P8cMgABSMslmY3HfWnwgxE8ZlxTr3y/xpoi/wnj4iT471Bt/obQbKINSzC0oS0PHOw9DSJWMMpLCVS2Y6njpgVln5lZ6szoo4Yz4LL7dNiCJkzVpUQBBqWsTNOh0dgcJ5laIwYFwgTrcrOQelhbogiXeEZya9v8AcIea/CIRfD+QSIcULeMY+IwbyXlhmtgtvmtnDLNhhiBZzH99veL8J14jIcxKyuSUajqZQ0gSqOk8FuIkYbV4A5N80dIAfjfAImrigWMeVykCRP6u/cXzp02xiO4TelEXK0XBQGuMZVZkBIr92GDWOVL0I+HrlAVFqNCyy/3b1IbNf7Ikg2ftubAjcQBMfB+83lD2fwenD63d2LmbWVSfv9+Xwe60nWw1xYpWOlp309yeiH5L6OYTRDjVDyRThTVteCNVGDqTATE5FRpf2B1QRDVd5/ImyyfFj9BJ06LXZQNoTry3MQOUorJgvq0x3XrIMxxsfK2XRccPmRrftr1+m2F+PKkusVkDcd1BEzlltnPpcnfhqNLiCYgEzl6E9Vj7XG0QZpDJIuU7xMkppsUsWfsRMJ+FAVXPrW2t6OkFCu+9ZvTEhjucy+VGWUFlOx7TdmXaw3Tfwm7ChgfPAMWO/CkpBOuJwoJ/P4ALADwA4AexRgrz8DYMK0p9lcKzn1GUbInNYobbE4nIIHkB5A+uVAerrvcjqUQFnW1IeoNQ0RMo/AHOYzUXjz/pLf+G6mWAesHbB2wNpjWKsjVqKdqTwMnLOZn1DbGUtZn07EHp2Ipr/szKdrGijTvK6ZYDtdsJQtA3TqtN9fzpSxdbqslLZ1/57qcs+1oD94fRlpOUCsbZ1CZbzwX+8rIS3QmLzd2hkvncw5vILLt1cj+JFbnPPwVy253DT9KnmV7B9ZKG0fsTi8OIeww9CAHVJozRK695oNws8x7EftBjNHg5MrUgvpGSPXqIeOirBqjMaft06/ByEWNR9+aNvl5z9HvuJEaJfrMf7bB15WAY6bU/d24MiOk+NB7+i4d3QyOjpJj16ng+N4cHLyF9seA35Kcnssd9M29N2eWVh3cT1/Ok06g57OyErIifL5aAdDO5mlNqPRsVdM4qNd2Fyce/Rnqiyd9EeAnLYD6rW9rKA5siZeKESG0vi0Ne80rdivYQX+CB7hKKYuC1BomX8q7MyN40yV/Syorf4fF2rcL7mQ/caF6Z8Nf7t+92bY+/X87O27q7e9oziJ7YP11ayUsSWXnTia56bVpXV7s8v1iff8p6mm1yw+2H5VcCEp8X5Py4YUbtiaFFjE0u6z1V3UIPuGLZdjbvBaF3VNX//tUC9YenO3JgLPHLkw9Hn9sPToFl5cNm9QX8PzXrz2bqWdvcqFp6TC0W8sYh9xsfUEV9/VEZshz1H7SIPEWYinNyI7aws7b2B11GoMswwr+4jsxuWDyGDFxBfD0dlPBO7mBa5UOSlrPqcHQT5nKbtltxS68snyvOG/X7KCy6njU5IPhunfP2aHBSg= +api: eJztWW1v2zYQ/isHftmbLCtZ0jb65qVdm67rgsTZgCUBSktnm61EqnyJYxj678ORki2/pMm67psLBHXMe+PdPQ+Z44JZPjEsvWZXBjVYbj6x24ipCjW3QsmznKXMVTm3SAJDWo9YjibToiIBlrIrvwwcXGsCZsJOwU4RJuIOJXzCecwiVnHNS7SoyeGCSV4iWW/s/oZzFjFBFitupyxiGj87oTFnqdUON90Op0iGQY29p5VzqyBETD5NNsWSs3TB7Lwid0JanKBmERsrXXIbvnp2xOr6NrhEY39R+Zx0VhGMeWEwYpmSFqWlNV5Vhch8lvofDYW02PamRh8xs7R3TTm1Ag2tZlMuJ2jQG1rf1tvLP95DUAtpDLJ52Bu3VouRswh3vHBo4ht5IykTY1UUaibkZCViIOMSRgg8/+iMxbwtizCAMq+UkDYCnueCXPOio3kjZ6IoSFdMpNKYp+TnR/iQcZkLyu1rrVxlPkAPNO0DRnOotLoTuQ9BApaVnUMhjF3Xoy56ulru8CW3+Jj8pdVCTrxGyMNV9S/VKi2UFnZOKqWQonQlJBGU/N5/PEiSCHIcc1dYOE4oGecde00TKoPd7Ptsc/ggXVF8CPUCpUGVwlrSExYqCk/fUcKphyvURvhKLc18Z4LmstDcGDGRiFRcqeyj9XUGPT4GXi90Ubsak0kvbZymflFaU9/hHUoLWApjhJIwVrrjNrRufCNZtNXltFU+KrBF7Kq5zjv9H9bWEdFUugMd46vTxSn1T8+KErcoiBKTOwRPRA0h0E5juHi0/vFW3DX5XLXRf4gpmOm56ttFto6kTmxcaz7fGQXBiXwvVT1ZmqeHQwYoGGGxNNvpqL8UZiCKr4xz4pX/10Bb5D96RPx8uDPoVn8tSBaxhkVYmpCWZw6WHicRaziFpUQqm/HUEbPC0q/sdHlG1BHjWXC5eVoMIHPGqhKCQMMydsrp8AgMzrMMjRGjAmGsVdk5KD3MDVGkKzwj+fU1/gAh71Q45GI4GwMxTsg75hExmPfSMqNVcNPcFm7YGkMsgfPwftv7RbhOXISDmNU1yWg0lZImUMVhcrSdiOHaFWDGTXMHyME4n4CxK4p5TLk8SpJH9bfuLx26bQzH8LvSCDlaLgoDXOMyMyCk127DhpHK5yEfD1wgKq1GBZY/bV8kNut9HiQbv+1NgRsIgqPg/fri11M4OTp+fvv91NrKpP3+bDaL9TjrYS6s0rHSk74eZ/RDcj/EMJyiRij5PJwpy2vBiqjBVJiJscio0v7AaoKhKu8+EdZZPqx+gU6dFlsoG8DVxRmIHKUV4zn16ZZr1sEY4yPlbDoquPzEVv217XTTi3FlyfUSyOsO6ogZy60zX8sTb4bDcwgmIFM5+lPVY61xtEYaR0mXKZ4lSU02qeJP2IkEvK8KLn1rbW5HSChXfes3JqSxXGbfqjJKi4nY9BuzLtabJn4ZdhQwfvQEWG/DkpBOuBwrJ/N4D7A9wPYAexBgJ18BMGHa02ymlZz4DCNkTmuUtpjvT8E9SPcg/XYgPd51OR1IoCxr6kPUmoYImUdgDrOpKLx5f8lvfDdTrD3W9ljbY+0hrNURK9FOVR4GztnUT6jtlKWsTydij05E01905tM1DZRpXtdMsJ0uWMoWATp12u8vpsrYOl1UStu6f0d1ueNa0B+8voy0HCDWtk6hMl74r3eVkBZoTN5u7ZSXTuYcXsDFq8shvOYWZzz8VUsu102/SF4ku0cWStsHLA7OzyDsMDRghxRas4TunWaD8FMM+1G7wczR4OSS1EJ6Rsg16oGjIiwbo/HnrdPvQYhFzYdf23Z5+9fQV5wI7WI1xn91z8sqwHF96t4OHNlhcnjUOzjsHZwMD47T5Hn680l88vzZ32xzDPglyc2x3HXb0Lc7ZmHdxdX86TjpDHo6Iyshx8rnox0MbWWW2oxGx14xiQ+2YXN+5tGfqbJ00h8BctIOqFf2soLmyJp4oRAZSuPT1rzTtGLvwgr8GTzCQUxdFqDQMv9E2KkbxZkq+1lQW/4/KtSoX3Ih+40L0z8d/H71/uWg9+7s9NX7y1e9gziJ7b311ayUsSWXnTia56blpXVzs4vViff0p6mm1yze235VcCEp8X5Pi4YUrtmKFFjE0u6z1W3UIPuaLRYjbvBKF3VNX392qOcsvb5dEYFnjlwY+rx6WHpwC99fNG9QP8DTXrx2bqWdvcq5p6TC0W8sYp9wvvEEV9/WEZsiz1H7SIPEaYinNyQ7Kwtbb2B11GoMsgwr+4Ds2uWDyGDJxOeD4ekbAnfzAleqnJQ1n9GDIJ+xlN2wGwpd+WR53vDfL1jB5cTxCckHw/TvHxGiBVY= sidebar_class_name: "patch api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null diff --git a/docs/apis-tools/node-js-sdk.md b/docs/apis-tools/node-js-sdk.md index 583c837affb..b11e5f327d7 100644 --- a/docs/apis-tools/node-js-sdk.md +++ b/docs/apis-tools/node-js-sdk.md @@ -1,7 +1,7 @@ --- id: node-js-sdk title: Node.js -description: Get started with the official Camunda 8 JavaScript SDK for Node.js, available via npm. +description: Get started with the official Camunda 8 JavaScript SDK for Node.js. --- As of 8.5.0, the official [Camunda 8 JavaScript SDK for Node.js](https://github.com/camunda/camunda-8-js-sdk) is available via [npm](https://www.npmjs.com/package/@camunda8/sdk). diff --git a/docs/apis-tools/spring-zeebe-sdk/configuration.md b/docs/apis-tools/spring-zeebe-sdk/configuration.md index 6cff515bf51..5c644b42928 100644 --- a/docs/apis-tools/spring-zeebe-sdk/configuration.md +++ b/docs/apis-tools/spring-zeebe-sdk/configuration.md @@ -275,7 +275,7 @@ A custom maxMessageSize allows the client to receive larger or smaller responses camunda: client: zeebe: - max-message-size: 3 + max-message-size: 4194304 ``` ### Request timeout diff --git a/docs/apis-tools/working-with-apis-tools.md b/docs/apis-tools/working-with-apis-tools.md index 10907399b5d..0f75b9bb805 100644 --- a/docs/apis-tools/working-with-apis-tools.md +++ b/docs/apis-tools/working-with-apis-tools.md @@ -72,6 +72,9 @@ Additionally, visit our documentation on [Operate](../self-managed/operate-deplo ### SDKs ### Postman diff --git a/docs/components/modeler/bpmn/user-tasks/user-tasks.md b/docs/components/modeler/bpmn/user-tasks/user-tasks.md index 90a64a6191c..b1a4919be5d 100644 --- a/docs/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/docs/components/modeler/bpmn/user-tasks/user-tasks.md @@ -36,6 +36,11 @@ attributes can be specified simultaneously: - `candidateUsers`: Specifies the users that the task can be assigned to. - `candidateGroups`: Specifies the groups of users that the task can be assigned to. +:::info +The assignee attribute must adhere to the userId field’s case-sensitivity requirements. +Note that in SaaS, all user IDs are converted to lowercase by default, as they are based on email addresses. +::: + :::info Assignment resources can also be used for set user task restrictions ([SaaS](/components/concepts/access-control/user-task-access-restrictions.md)/[Self-Managed](docs/self-managed/concepts/access-control/user-task-access-restrictions.md)), where users will see only the tasks they have authorization to work on. ::: diff --git a/docs/components/modeler/desktop-modeler/use-connectors.md b/docs/components/modeler/desktop-modeler/use-connectors.md index 921b5c0f693..6a0f28ee837 100644 --- a/docs/components/modeler/desktop-modeler/use-connectors.md +++ b/docs/components/modeler/desktop-modeler/use-connectors.md @@ -12,7 +12,7 @@ Desktop Modeler automatically fetches and updates [element templates](./element- ## Automatic Connector template fetching -Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. +Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. The fetch is triggered whenever you start the application, or every 24 hours if the application is not closed. After an update check has concluded, a notification indicates if the templates are up to date or have been updated: diff --git a/docs/self-managed/console-deployment/configuration/configuration.md b/docs/self-managed/console-deployment/configuration/configuration.md index 1c09cea48e1..69365322378 100644 --- a/docs/self-managed/console-deployment/configuration/configuration.md +++ b/docs/self-managed/console-deployment/configuration/configuration.md @@ -41,6 +41,20 @@ Console environment variables could be set in Helm via the `console.env` key. Fo Camunda 8 components without a valid license may display **Non-Production License** in the navigation bar and issue warnings in the logs. These warnings have no impact on Console startup or functionality. To obtain a license, visit the [Camunda Enterprise page](https://camunda.com/platform/camunda-platform-enterprise-contact/). ::: +### Proxy + +These settings are useful when the application needs to make outgoing network requests in environments that require traffic to pass through a proxy server. + +| Environment variable | Description | Example value | Default value | +| -------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | ------------- | +| `http_proxy` | Specifies the proxy server to be used for outgoing HTTP requests. | `http://proxy.example.com:8080` | - | +| `https_proxy` | Specifies the proxy server to be used for outgoing HTTPS requests. | `https://secureproxy.example.com:443` | - | +| `no_proxy` | A comma-separated list of domain names or IP addresses for which the proxy should be bypassed. | `localhost,127.0.0.1,.example.com` | - | + +:::note +The proxy-related environment variables are lowercase because they follow a widely accepted convention used in many system environments and tools. +::: + ## Telemetry You can enable telemetry and usage collection to help us improve our product by sending several telemetry metrics to Camunda. The information we collect will contribute to continuous product enhancement and help us understand how Camunda is used. We do not collect sensitive information and limit data points to several metrics. For more information, you can download collected data set metrics from the telemetry page at anytime. diff --git a/docs/self-managed/modeler/web-modeler/configuration/configuration.md b/docs/self-managed/modeler/web-modeler/configuration/configuration.md index 0fa011b7f38..5585791bf52 100644 --- a/docs/self-managed/modeler/web-modeler/configuration/configuration.md +++ b/docs/self-managed/modeler/web-modeler/configuration/configuration.md @@ -20,7 +20,9 @@ import Licensing from '../../../../self-managed/react-components/licensing.md' ### Clusters -Clusters configured using the following options can be selected when deploying from Web Modeler. If no clusters are configured, you will not be able to preform any actions that require a cluster (for example, deploy, start an instance, or Play a process). The Camunda 8 [Helm](/self-managed/setup/install.md) and [Docker Compose](/self-managed/setup/deploy/local/docker-compose.md) distributions provide a local Zeebe cluster configured by default. +Clusters must be configured using the following options to access the cluster from within Web Modeler. If no clusters are configured, you will not be able to perform any actions that require a cluster (for example, deploy, start an instance, or Play a process). + +The Camunda 8 [Helm](/self-managed/setup/install.md) and [Docker Compose](/self-managed/setup/deploy/local/docker-compose.md) distributions provide a local Zeebe cluster configured by default. To add additional clusters, increment the `0` value for each variable (`CAMUNDA_MODELER_CLUSTERS_1_NAME`). diff --git a/docs/self-managed/operational-guides/update-guide/860-to-870.md b/docs/self-managed/operational-guides/update-guide/860-to-870.md index 205beda3075..d8604906a77 100644 --- a/docs/self-managed/operational-guides/update-guide/860-to-870.md +++ b/docs/self-managed/operational-guides/update-guide/860-to-870.md @@ -12,3 +12,50 @@ The following sections explain which adjustments must be made to migrate from Ca Configuring a non-existing bucket for backups will not prevent Zeebe to start up anymore and will only result in logs (at WARN) in the startup phase. + +## Exported records + +### `USER_TASK` records + +To support User Task Listeners, some backward incompatible changes were necessary to the exported `USER_TASK` records. + +#### `assignee` no longer provided in `CREATING/CREATED` events + +Previously, when a user task was activating with a specified `assignee`, +we appended the following events of the `USER_TASK` value type: + +- `CREATING` with `assignee` property as provided +- `CREATED` with `assignee` property as provided + +The `ASSIGNING` and `ASSIGNED` events were not appended in this case. + +To support the new User Task Listeners feature, the `assignee` value will not be filled in the `CREATING` and `CREATED` events anymore. + +With 8.7, the following events are now appended: + +- `CREATING` with `assignee` always `""` (empty string) +- `CREATED` with `assignee` always `""` (empty string) +- `ASSIGNING` with `assignee` property as provided +- `ASSIGNED` with `assignee` property as provided + +#### `ASSIGNING` has become `CLAIMING` for `CLAIM` operation + +When claiming a user task, we previously appended the following records of the `USER_TASK` value type: + +- `CLAIM` +- `ASSIGNING` +- `ASSIGNED` + +A new `CLAIMING` intent was introduced to distinquish between claiming and regular assigning. +We now append the following records when claiming a user task: + +- `CLAIM` +- `CLAIMING` +- `ASSIGNED` + +The `ASSIGNING` event is still appended for assigning a user task. +In that case, we append the following records: + +- `ASSIGN` +- `ASSIGNING` +- `ASSIGNED` diff --git a/docs/self-managed/reference-architecture/img/management-cluster.jpg b/docs/self-managed/reference-architecture/img/management-cluster.jpg new file mode 100644 index 00000000000..026ecfcdb9f Binary files /dev/null and b/docs/self-managed/reference-architecture/img/management-cluster.jpg differ diff --git a/docs/self-managed/reference-architecture/img/orchestration-cluster.jpg b/docs/self-managed/reference-architecture/img/orchestration-cluster.jpg new file mode 100644 index 00000000000..276984d34ae Binary files /dev/null and b/docs/self-managed/reference-architecture/img/orchestration-cluster.jpg differ diff --git a/docs/self-managed/reference-architecture/manual/img/manual-ha.jpg b/docs/self-managed/reference-architecture/manual/img/manual-ha.jpg new file mode 100644 index 00000000000..5d06e9a1146 Binary files /dev/null and b/docs/self-managed/reference-architecture/manual/img/manual-ha.jpg differ diff --git a/docs/self-managed/reference-architecture/manual/img/manual-single.jpg b/docs/self-managed/reference-architecture/manual/img/manual-single.jpg new file mode 100644 index 00000000000..2d54eb33b3f Binary files /dev/null and b/docs/self-managed/reference-architecture/manual/img/manual-single.jpg differ diff --git a/docs/self-managed/reference-architecture/manual/manual.md b/docs/self-managed/reference-architecture/manual/manual.md new file mode 100644 index 00000000000..f82e348be42 --- /dev/null +++ b/docs/self-managed/reference-architecture/manual/manual.md @@ -0,0 +1,123 @@ +--- +id: manual +title: "Manual JAR deployment overview" +sidebar_label: Manual JAR +description: "Camunda 8 Manual (Java) deployment Reference architecture home " +--- + + + +This reference architecture provides guidance on deploying Camunda 8 Self-Managed as a standalone Java application. This deployment method is ideal for users who prefer manual deployment on bare metal servers or virtual machines (VMs), offering full control over the environment and configuration. It is particularly suited for scenarios with specific infrastructure requirements or highly customized setups. + +:::note +This method of deployment requires a solid understanding of infrastructure, networking, and application management. Consider evaluating your [deployment platform options](../reference-architecture.md) based on your familiarity and need. If you prefer a simpler and managed solution, [Camunda 8 SaaS](https://camunda.com/platform/) can significantly reduce maintenance efforts, allowing you to focus on your core business needs. +::: + +## Key features + +- **Single application JAR**: Starting from Camunda 8.7, all core components (Zeebe, Tasklist, Operate, Optimize, and Identity) are bundled into a single JAR file. This simplifies deployment by reducing the number of artifacts to manage. +- **Full control**: Users are responsible for all aspects of deployment, including installation, configuration, scaling, and maintenance. This offers maximum flexibility for custom environments. + +Other deployment options, such as containerized deployments or managed services, might offer more convenience and automation. However, VM based deployment gives you the flexibility to tailor the deployment to your exact needs, which can be beneficial for regulated or highly customized environments. + +For documentation on the orchestration cluster, Web Modeler and Console separation, refer to the [reference architecture overview](/self-managed/reference-architecture/reference-architecture.md#orchestration-cluster-vs-web-modeler-and-console). + +## Reference implementations + +This section includes deployment reference architectures for manual setups: + +- [Amazon EC2 deployment](/self-managed/setup/deploy/amazon/aws-ec2.md) - a standard production setup with support for high availability. + +## Considerations + +- This overview page focuses on deploying the [orchestration cluster](/self-managed/reference-architecture/reference-architecture.md#orchestration-cluster), the single JAR compromised of Identity, Operate, Optimize, Tasklist, and Zeebe, as well as the Connectors runtime. Web Modeler and Console deployments are not included. +- General guidance and examples focuses on **unix** users, but can be adapted by Windows users with options like [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) or included `batch` files. +- The Optimize importer is not highly available and must only run once within the whole setup. + +## Architecture + +![Single JAR](./img/manual-single.jpg) + +This above diagram illustrates a single-machine deployment using the single JAR package. While simple and effective for lightweight setups, scaling to multiple machines requires careful planning. + +Compared to the generalized architecture depicted in the [reference architecture](/self-managed/reference-architecture/reference-architecture.md#architecture), the `Optimize importer` can be enabled as part of the single JAR. + +### High Availability (HA) + +:::caution Non-HA Optimize importer +When scaling from a single machine to multiple machines, ensure that the `Optimize importer` is enabled on only one machine and disabled on the others. Enabling it on multiple machines will cause data inconsistencies. This limitation is known and will be addressed in future updates. +::: + +![HA JAR](./img/manual-ha.jpg) + +For high availability, a minimum of three machines is recommended to ensure fault tolerance and enable master election in case of failures. Refer to the [clustering documentation](/components/zeebe/technical-concepts/clustering.md) to learn more about the raft protocol and clustering concepts. + +### Components + +The orchestration core is packaged as a single JAR file and includes the following components: + +- **Zeebe** +- **Operate** +- **Tasklist** +- **Optimize** +- **Identity** + +The core facilitates: + +1. **gRPC communication**: For client workers. +2. **HTTP endpoints**: Used by the REST API and Web UI. + +Both types of endpoints can be routed through a load balancer to maintain availability, ensuring that the system remains accessible even if a machine becomes unavailable. While using a load balancer is optional, it is recommended for enhanced availability and security. Alternatively, you can expose static machines, ports, and IPs directly. However, direct exposure is generally discouraged due to security concerns. + +Connectors expose additional HTTP(s) endpoints for handling incoming webhooks, which can also be routed through the same http load balancer. + +The orchestration components rely on **Elasticsearch** or **OpenSearch** as their data store. + +Components within the orchestration core communicate seamlessly, particularly: + +- **Zeebe brokers** exchange data over gRPC endpoints for efficient inter-broker communication. + +## Requirements + +Before implementing a reference architecture, review the requirements and guidance outlined below. We are differentiating between `Infrastructure` and `Application` requirements. + +### Infrastructure + +Any of the following are just suggestions for the minimum viable setup, the sizing heavily depends on your use cases and usage. It is recommended to understand the documentation on [sizing your environment](/components/best-practices/architecture/sizing-your-environment.md) and run benchmarking to confirm your required needs. + +#### Minimum Requirements Per Host + +- Modern CPU: 4 cores +- Memory: 8 GB RAM +- Storage: 32 GB SSD (**1,000** IOPS recommended; avoid burstable disk types) + +Suggested instance types from cloud providers: + +- AWS: [m7i](https://aws.amazon.com/ec2/instance-types/m7i/) series +- GCP: [n1](https://cloud.google.com/compute/docs/general-purpose-machines#n1_machines) series + +#### Networking + +- Stable and high-speed network connection +- Configured firewall rules to allow necessary traffic: + - **8080**: Web UI / REST endpoint. + - **9090**: Connector port. + - **9600**: Metrics endpoint. + - **26500**: gRPC endpoint. + - **26501**: Gateway-to-broker communication. + - **26502**: Inter-broker communication. +- Load balancer for distributing traffic (if required) + +:::info Customizing ports +Some ports can be overwritten and are not definitive, you may conduct the documentation of each component to see how it can be done, in case you want to use a different port. Or in our example `Connectors` and `Web UIs` overlap on 8080 due to which we moved connectors to a different port. +::: + +### Application + +- Java Virtual Machine, see [supported environments](/reference/supported-environments.md) for version details. + +### Database + +- Elasticsearch / OpenSearch, see [supported environments](/reference/supported-environments.md) for version details. + +Our recommendation is to use an external managed offer as we will not go into detail on how to manage and maintain your database. diff --git a/docs/self-managed/reference-architecture/reference-architecture.md b/docs/self-managed/reference-architecture/reference-architecture.md new file mode 100644 index 00000000000..da8b632d49c --- /dev/null +++ b/docs/self-managed/reference-architecture/reference-architecture.md @@ -0,0 +1,144 @@ +--- +id: reference-architecture +title: "Camunda 8 reference architectures" +sidebar_label: "Overview" +description: "Learn about the Self-Managed reference architectures and how they can help you get started." +--- + +Reference architectures provide a comprehensive blueprint for designing and implementing scalable, robust, and adaptable systems. The reference architectures published here offer guidance to help enterprise architects, developers, and IT managers streamline deployments and improve system reliability. + +## Overview + +Reference architectures are not a one-size-fits-all solution, and each organization has unique requirements and constraints that may necessitate modifications to the provided blueprints. + +While these reference architectures offer a solid foundation and best practices, they should be adapted to fit the specific needs of your project. Use them as a starting point to start your Camunda 8 implementation process, but be prepared to make adjustments to ensure they align with your goals and infrastructure. + +### Target users + +- **Enterprise architects**: To design and plan the overall system structure. +- **Developers**: To understand the components and their interactions. +- **IT managers**: To ensure the system meets business requirements and is maintainable. + +### Key benefits + +- **Accelerated deployment**: Predefined best practices and guidelines simplify the deployment process, reducing the time and effort required to set up a reliable workflow automation solution. +- **Consistency**: Ensures consistency across deployments by standardizing system components and their configurations, which helps reduce the risk of errors and simplifies maintenance. +- **Enhanced security**: Reference architectures incorporate best practices for securing Camunda 8 deployments, ensuring that sensitive data and processes are protected through standard security measures like encryption, authentication, and access controls. + +### Support considerations + +Deviations from the reference architecture are unavoidable. However, such changes will introduce additional complexity, making troubleshooting more difficult. When modifications are required, ensure they are well-documented to facilitate future maintenance and troubleshooting more quickly. Camunda publishes [supported environment](/reference/supported-environments.md) information to help you navigate supported configurations. + +## Architecture + +### Orchestration cluster vs Web Modeler and Console + +When designing a reference architecture, it's essential to understand the differences between an orchestration cluster and Web Modeler and Console Self-Managed. These components play crucial roles in the deployment and operation of processes, but they serve different purposes and include distinct components. + +#### Orchestration Cluster + +![Orchestration Cluster](./img/orchestration-cluster.jpg) + +The orchestration cluster is the core of Camunda. + +The included components are: + +- [Zeebe](/components/zeebe/zeebe-overview.md): A workflow engine for orchestrating microservices and managing stateful, long-running business processes. +- [Operate](/components/operate/operate-introduction.md): A monitoring tool for visualizing and troubleshooting workflows running in Zeebe. +- [Tasklist](/components/tasklist/introduction-to-tasklist.md): A user interface for managing and completing human tasks within workflows. +- [Optimize]($optimize$/components/what-is-optimize/): An analytics tool for generating reports and insights based on workflow data. +- [Identity](/self-managed/identity/what-is-identity.md): A service for managing user authentication and authorization. +- [Connectors](/components/connectors/introduction.md): Pre-built integrations for connecting Zeebe with external systems and services. + +Each component within the orchestration cluster is part of an integrated system that works together to provide end-to-end process orchestration. These components form a unified cluster that is tightly integrated to ensure seamless communication and data flow. + +This design ensures that all components are in sync, working collectively to maintain consistent state management, data integrity, and smooth process orchestration across the entire cluster. This architecture ensures reliable process execution with clear boundaries between each workflow engine's operation. + +#### Web Modeler and Console + +![Web Modeler and Console](./img/management-cluster.jpg) + +Web Modeler and Console are designed to interact with multiple orchestration clusters. Console offers tools and interfaces for administrators to monitor clusters, and Web Modeler allows developers to create and deploy BPMN models. + +- [Console](/components/console/introduction-to-console.md): A central management interface for monitoring and managing multiple orchestration clusters. +- [Web Modeler](/self-managed/modeler/web-modeler/installation.md): A web-based tool for designing and deploying workflow models to any available orchestration cluster. + +Additionally, Web Modeler and Console require the following: + +- [Identity](/self-managed/identity/what-is-identity.md): A service for managing user authentication and authorization. + +Unlike the orchestration cluster, Web Modeler and Console run a separate and dedicated Identity deployment. For production environments, using an external [identity provider](/self-managed/setup/guides/connect-to-an-oidc-provider.md) is recommended. + +### Databases + +Databases can be deployed as part of the Camunda clusters, but using external databases or managed services offers several advantages: + +- **Flexibility**: Allows you to choose the database technology that best fits your needs and existing infrastructure while choosing one of the [supported environments](/reference/supported-environments.md#component-requirements). +- **Scalability**: External databases can be scaled independently of the Camunda components, providing better performance and resource management. +- **Maintenance**: Simplifies the maintenance and upgrade processes, as database management can be handled separately. +- **Compliance**: Ensures that you can adhere to specific data governance and compliance requirements. + +While some guides go into detail on how to deploy databases together with Camunda, the recommendation is to maintain this outside of Camunda. + +By decoupling databases from Camunda, you gain greater control and customization over your data storage and management strategies. + +### High availability (HA) + +High availability (HA) ensures that a system remains operational and accessible even in the event of component failures. While all components are equipped to be run in a highly available manner, some components need extra considerations when run in HA mode. + + + +While high availability is one part of the increased fault tolerance and resilience, you should also consider regional or zonal placement of your workloads. + +If you run infrastructure on cloud providers, you are often met with different regions and zones. For ideal high availability you should consider a minimum setup of 3 zones within a region as this will guarantee that in case of a zonal failure that the remaining two workloads can still process data. For more information on how Zeebe handles fault tolerance, have a look at the [raft consensus chapter](/components/zeebe/technical-concepts/clustering.md#raft-consensus-and-replication-protocol). + +If running a single instance is preferred, make sure to implement [regular backups](/self-managed/operational-guides/backup-restore/backup-and-restore.md) since resilience will be limited. + +## Available reference architectures + +:::note Documentation Update in Progress +This is a work in progress as the existing documentation is updated to provide better general guidance on the topic. The Kubernetes and Docker documentation may point to older guides. +::: + +Choosing the right reference architecture depends on various factors such as the organization's goals, existing infrastructure, and specific requirements. The following guides are available to help choose and guide deployments: + +### Kubernetes + +Kubernetes is a powerful orchestration platform for containerized applications. Using a reference architecture for Kubernetes can help organizations deploy and manage their applications more effectively. It provides guidelines for setting up clusters, managing workloads, and ensuring high availability and scalability. This approach is ideal for organizations looking to leverage the benefits of containerization and self-healing capabilities. + +- Ideal for organizations adopting containerization and microservices (see [Cloud Native computing foundation](https://www.cncf.io/)). +- Suitable for dynamic scaling and high availability. +- Best for teams with experience in managing containerized environments. +- A steeper learning curve but offers scalable and highly resilient platform. + +For more information and guides, see the reference for [Kubernetes](/self-managed/setup/install.md). + + + +### Containers + +Containers, such as Docker, offer a middle ground between the manual JAR and Kubernetes approaches. They provide a lightweight, portable, and consistent runtime environment, making it easier to develop, test, and deploy applications across different environments. Containers encapsulate an application and its dependencies, ensuring that it runs reliably regardless of where it is deployed. + +- Advisable as a middle ground between manual JAR and Kubernetes. Profit from containerization while not having the whole overhead of Kubernetes. +- Containers can run on any system that supports the container runtime, ensuring consistency across development, testing, and production environments. +- Each container runs in its own isolated environment, which helps prevent conflicts between applications and improves security. +- Containers can be easily scaled up or down to handle varying workloads, providing flexibility in resource management. + +For more information and guides, see the reference for [containers](/self-managed/setup/deploy/other/docker.md). + +### Manual JAR (bare metal/virtual machines) + +For organizations that prefer traditional infrastructure, reference architectures for bare metal or virtual machines (VMs) offer a structured approach to system deployment. These architectures provide best practices for setting up physical servers or VMs, configuring networks, and managing storage using Infrastructure as Service cloud providers. They are suitable for environments where containerization or use of Kubernetes services may not be feasible. + +- Suitable for organizations requiring use of IaaS, bare metal, and other traditional infrastructures. +- Ideal for traditional setups needing highly customized security, strict data residency, or industry-specific regulatory compliance. +- Applicable for high availability but requires more detailed planning. +- Best for teams with expertise in managing physical servers or virtual machines. + +For more information and guides, see the reference for [manual setups](./manual/manual.md). + + + +### Local development + +While the above options are suitable for trying out Camunda 8 locally, [Camunda 8 Run](/self-managed/setup/deploy/local/c8run.md) provides a simplified, developer-focused experience. diff --git a/docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md b/docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md index d196001567e..bc70916d34f 100644 --- a/docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md +++ b/docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md @@ -4,6 +4,8 @@ title: "Install Camunda 8 on an EKS cluster" description: "Set up the Camunda 8 environment with Helm and an optional Ingress setup on Amazon EKS." --- + + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -30,6 +32,7 @@ Multi-tenancy is disabled by default and is not covered further in this guide. I :::caution Optimize compatibility with OpenSearch **Migration:** The migration step will be disabled during the installation. For more information, refer to [using Amazon OpenSearch Service](/self-managed/setup/guides/using-existing-opensearch.md). + ::: ## Architecture @@ -427,7 +430,6 @@ https://github.com/camunda/camunda-tf-eks-module/blob/main/examples/camunda-8.7/ Use these environment variables in the `kubectl` command to create the secret. -- The values for `postgres-password` and `password` are not required if you are using an external database. If you choose not to use an external database, you must provide those values. - The `smtp-password` should be replaced with the appropriate external value ([see how it's used by Web Modeler](/self-managed/modeler/web-modeler/configuration/configuration.md#smtp--email)). ```bash reference @@ -569,7 +571,7 @@ Below is a summary of the necessary instructions: 1. Open Identity in your browser at `https://${DOMAIN_NAME}/identity`. You will be redirected to Keycloak and prompted to log in with a username and password. 2. Use `demo` as both the username and password. 3. Select **Add application** and select **M2M** as the type. Assign a name like "test." -4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Zeebe API** with "write" permission. +4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Core API** with "read" and "write" permission. 5. Retrieve the `client-id` and `client-secret` values from the application details ```shell @@ -591,7 +593,7 @@ kubectl port-forward services/camunda-keycloak 18080:80 --namespace camunda 1. Open Identity in your browser at `http://localhost:8080`. You will be redirected to Keycloak and prompted to log in with a username and password. 2. Use `demo` as both the username and password. 3. Select **Add application** and select **M2M** as the type. Assign a name like "test." -4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Zeebe API** with "write" permission. +4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Core API** with "read" and "write" permission. 5. Retrieve the `client-id` and `client-secret` values from the application details ```shell diff --git a/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md index 7a440c0e3b0..cad212c143a 100644 --- a/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md +++ b/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md @@ -96,25 +96,25 @@ Advanced users may want to handle this part differently and use a different back #### Set up AWS authentication The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) is required to create resources in AWS. Before you can use the provider, you must authenticate it using your AWS credentials. -You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods. -We recommend using the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials. +:::caution Ownership of the created resources -To configure the AWS CLI: +A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user. -```bash -aws configure -``` +::: -Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). +You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods: -:::caution Ownership of the created resources +- For development or testing purposes you can use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials. + To configure the AWS CLI: -A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user. + ```bash + aws configure + ``` -[Create access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` variables to use with the AWS CLI and `eksctl` + Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). -::: +- For production environments, we recommend the use of a dedicated IAM user. Create [access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console, and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. #### Create an S3 bucket for Terraform state management diff --git a/docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.jpg b/docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.jpg new file mode 100644 index 00000000000..0ef72f02ab6 Binary files /dev/null and b/docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.jpg differ diff --git a/docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.pdf b/docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.pdf new file mode 100644 index 00000000000..f53db5315da Binary files /dev/null and b/docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.pdf differ diff --git a/docs/self-managed/setup/deploy/amazon/aws-ec2.md b/docs/self-managed/setup/deploy/amazon/aws-ec2.md new file mode 100644 index 00000000000..8ffb1beba7c --- /dev/null +++ b/docs/self-managed/setup/deploy/amazon/aws-ec2.md @@ -0,0 +1,344 @@ +--- +id: aws-ec2 +title: "Amazon EC2" +description: "Learn how to install Camunda 8 on AWS EC2 instances." +--- + +This guide provides a detailed walkthrough for installing the Camunda 8 single JAR on AWS EC2 instances. It focuses on managed services by AWS and their cloud offering. Finally, you will verify that the connection to your Self-Managed Camunda 8 environment is working. + +This guide focuses on setting up the [orchestration cluster](/self-managed/reference-architecture/reference-architecture.md#orchestration-cluster-vs-web-modeler-and-console) for Camunda 8. The Web Modeler and Console are not covered in this manual deployment approach. These components are supported on Kubernetes and should be [deployed using Kubernetes](/self-managed/setup/install.md/#install-web-modeler). + +:::note Using other Cloud providers +This guide is built around the available tools and services that AWS offers, but is not limited to AWS. The scripts and ideas included can be adjusted for any other cloud provider and use case. + +When using this guide with a different cloud provider, note that you will be responsible for configuring and maintaining the resulting infrastructure. Our support is limited to questions related to the guide itself, not to the specific tools and services of the chosen cloud provider. +::: + +:::warning Cost management +Following this guide will incur costs on your Cloud provider account, namely for the EC2 instances, and OpenSearch. More information can be found on AWS and their [pricing calculator](https://calculator.aws/#/) as the total cost varies per region. + +To get an estimate, you can refer to this [example calculation](https://calculator.aws/#/estimate?id=8ce855e2d02d182c4910ec8b4ea2dbf42ea5fd1d), which can be further optimized to suit your specific use cases. +::: + +## Architecture + +The architecture as depicted focuses on a standard deployment consisting of a three-node setup distributed over 3 [availability zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) within an AWS region, as well as an OpenSearch domain with the same conditions. The focus is on a highly available setup and redundancy in case a zone should fail. + + + + +_Infrastructure diagram for a 3 node EC2 architecture (click on the image to open the PDF version)_ +[![AWS EC2 Architecture](./assets/aws-ec2-arch.jpg)](./assets/aws-ec2-arch.pdf) + +The setup consists of: + +- [Virtual Private Cloud](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) (VPC) is a logically isolated virtual network. + - a [Private Subnet](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html), which does not have direct access to the internet and cannot be easily reached. + - three [EC2](https://aws.amazon.com/ec2/) instances using Ubuntu, one within each availability zone, which will run Camunda 8. + - a [managed OpenSearch](https://aws.amazon.com/what-is/opensearch/) cluster stretched over the three availability zones. + - a [Public Subnet](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html), which allows direct access to the Internet via an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html). + - (optional) an [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html) (ALB) is used to expose the WebUIs like Operate, Tasklist, and Connectors, as well as the REST API to the outside world. This is done using sticky sessions, as generally requests are distributed round-robin across all EC2 instances. + - (optional) a [Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html) (NLB) is used to expose the gRPC endpoint of the Zeebe Gateway, in case external applications require it. + - (optional) a [Bastion Host](https://en.wikipedia.org/wiki/Bastion_host) to allow access to the private EC2 instances since they're not publicly exposed. + - Alternatively, utilize the [AWS Client VPN](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/what-is.html) instead to reach the private subnet within the VPC. The setup requires extra work and certificates, but can be set up by following the [getting started tutorial by AWS](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-getting-started.html). + - a NAT Gateway that allows the private EC2 instances to reach the internet to download and update software packages. This cannot be used to access the EC2 instances. +- [Security Groups](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html) to handle traffic flow to the VMs. +- an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) to allow traffic between the VPC and the Internet. + +Both types of subnets are distributed over three availability zones of a single AWS region, allowing for a highly available setup. + +:::note Single Deployment +Alternatively, the same setup can run with a single AWS EC2 instance, but be aware that in case of a zone failure, the whole setup would be unreachable. +::: + +## Requirements + +- An AWS account to create any resources within AWS. + - On a high level, permissions are required on the **ec2**, **iam**, **elasticloadbalancing**, **kms**, **logs**, and **es** level. + - For a more fine-grained view of the permissions, check this [example policy](https://github.com/camunda/camunda-deployment-references/blob/main/aws/ec2/example/policy.json). +- Terraform (1.7+) +- Unix based Operating System (OS) with ssh and sftp + - Windows may be used with [Cygwin](https://www.cygwin.com/) or [Windows WSL](https://learn.microsoft.com/en-us/windows/wsl/install) but has not been tested + +### Considerations + +- The Optimize importer is not highly available and must only run once within the whole setup. + +### Outcome + +The outcome is a fully working Camunda orchestration cluster running in a high availability setup using AWS EC2 and utilizing a managed OpenSearch domain. +The EC2 instances come with an extra disk meant for Camunda to ensure that the content is separated from the operating system. + +## 1. Create the required infrastructure + +:::note Terraform infrastructure example +We do not recommend using the below Terraform related infrastructure as module as we do not guarantee compatibility. +Therefore, we recommend extending or reusing some elements of the Terraform example to ensure compatibility with your environments. +::: + +### Download the reference architecture GitHub repository + +The provided reference architecture repository allows you to directly reuse and extend the existing Terraform example base. This sample implementation is flexible to extend to your own needs without the potential limitations of a Terraform module. + +```sh +wget https://github.com/camunda/camunda-deployment-references/archive/refs/heads/main.zip +``` + +### Update the configuration files + +1. Navigate to the new directory: + +```sh +cd camunda-deployment-references-main/aws/ec2/terraform +``` + +2. Edit the `variables.tf` file to customize the settings, such as the prefix for resource names and CIDR blocks: + +```hcl +variable "prefix" { + default = "example" +} + +variable "cidr_blocks" { + default = "10.0.1.0/24" +} +``` + +3. In `config.tf`, configure a new Terraform backend by updating `backend "local"` to [AWS 3](https://developer.hashicorp.com/terraform/language/backend/s3) (or any other non-`local` backend that fits your organization). + +:::note +`local` is meant for testing and development purposes. The state is saved locally, and does not allow to easily share it with colleagues. More information on alternatives can be found in the [Terraform documentation](https://developer.hashicorp.com/terraform/language/backend). +::: + +### Configure the Terraform AWS provider + +1. Add the [Terraform AWS provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) in the `config.tf`: + +```hcl +provider "aws" {} +``` + +This can be done via a simple script or manually: + +```sh +echo 'provider "aws" {}' >> config.tf +``` + +:::note +This is a current technical limitation, as the same files are used for testing. Terraform does not allow defining the provider twice. +::: + +1. Configure authentication to allow the [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) to create resources in AWS. You must configure the provider with the proper credentials before using it. You can further change the region and other preferences and explore different authentication methods. + +There are several ways to authenticate the AWS provider: + + - **Testing/development**: Use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) to configure access. Terraform will automatically default to AWS CLI configuration when present. + - **CI/CD**: Set the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, which can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). + - **Enterprise grade security**: Use an [AWS IAM role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#assuming-an-iam-role). + +Ensure you have set the `AWS_REGION` either as environment variable or in the Terraform AWS provider to deploy the infrastructure in your desired region. AWS resources are region bound on creation. + +:::note Secret management +We strongly recommend managing sensitive information using a secure secrets management solution like HashiCorp Vault. For details on how to inject secrets directly into Terraform via Vault, see the [Terraform Vault secrets injection guide](https://developer.hashicorp.com/terraform/tutorials/secrets/secrets-vault). +::: + +### Initialize and deploy Terraform + +1. Initialize the Terraform working directory. This step downloads the necessary provider plugins: + +```sh +terraform init +``` + +1. Plan the configuration files: + +```sh +terraform plan -out infrastructure.plan # describe what will be created +``` + +1. After reviewing the plan, confirm and apply the changes: + +```sh +terraform apply infrastructure.plan # apply the creation +``` + +The execution takes roughly 30 minutes. Around 25 minutes is solely for the creation of a managed highly available OpenSearch cluster. + +1. After the infrastructure is created, access the outputs defined in `outputs.tf` using `terraform output`. + +For example, to retrieve the OpenSearch endpoint: + +```sh +terraform output aws_opensearch_domain +``` + +### Connect to remote machines via Bastion host (optional) + +The EC2 instances are not public and have to be reached via a Bastion host. Alternatively, utilize the [AWS VPN Client](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/what-is.html) to connect securely to a private VPC. This step is not described, as setup requires specific manual user interaction. + +```sh +export BASTION_HOST=$(terraform output -raw bastion_ip) +# retrieves the first IP from the camunda_ips array +export CAMUNDA_IP=$(tf output -json camunda_ips | jq -r '.[0]') + +ssh -J admin@${BASTION_HOST} admin@${CAMUNDA_IP} +``` + +## 2. Deploy Camunda 8 + +### Configure and run the installation script + +1. Navigate to the script directory: + +```sh +cd camunda-deployment-references-main/aws/ec2/scripts +``` + +The script directory contains bash scripts that can be used to install and configure Camunda 8. + +2. Configure any script features using the following environment variables: + + - `CLOUDWATCH_ENABLED`: The default is false. If set to true will install the CloudWatch agent on each EC2 instance and export Camunda logs and Prometheus metrics to AWS CloudWatch. + - `SECURITY`: The default is false. If set to true will use self-signed certificates to secure cluster communication, based on the procedure described in the [documentation](/self-managed/zeebe-deployment/security/secure-cluster-communication.md). This requires a manual step as a prerequisite as described below in step 3. + +3. Configure any variables in the `camunda-install.sh` script to overwrite the default for Camunda and Java versions: + + - `OPENJDK_VERSION`: The Temurin Java version. + - `CAMUNDA_VERSION`: The Camunda 8 version. + - `CAMUNDA_CONNECTORS_VERSION`: The Camunda 8 connectors version. + + :::note + The above variables must be set in `camunda-install.sh` . They cannot be set as environment variables. + ::: + +4. Execute the `SECURITY` script (optional): + +If `SECURITY` was enabled in step 2, execute the `generate-self-signed-cert-authority.sh` script to create a certificate authority. + +This certificate should be saved somewhere securely, as it will be required to upgrade or change configuations in an automated way. If the certificate is lost, recreate the certificate authority via the script and all manually created client certificates. + +:::note Self-signed certificates for testing +Self-signed certificates are advocated for development and testing purposes. Check the [documentation](/self-managed/zeebe-deployment/security/secure-cluster-communication.md) on secure cluster communication to learn more about PEM certificates. +::: + +1. Execute the `all-in-one-install.sh` script. + +This script installs all required dependencies. Additionally, it configures Camunda 8 to run in a highly available setup by using a managed OpenSearch instance. + +The script will pull all required IPs and other information from the Terraform state via Terraform outputs. + +During the first installation, you will be asked to confirm the connection to each EC2 instance by typing `yes`. + +### Connect and use Camunda 8 + +The Application Load Balancer (ALB) and the Network Load Balancer (NLB) can be accessed via the following Terraform outputs: + +- `terraform output alb_endpoint`: Access Operate (or the Connectors instance on port `9090`). The ALB is designed for handling Web UIs, such as Operate, Tasklist, Optimize, and Connectors. +- `terraform output nlb_endpoint`: Access the gRPC endpoint of the Zeebe gateway. The NLB is intended for managing the gRPC endpoint of the Zeebe Gateway. This is due to the difference of protocols with ALB focusing on HTTP and NLB on TCP. + +The two endpoints above use the publicly assigned hostname of AWS. Add your domain via CNAME records or use [Route53](https://aws.amazon.com/route53/) to map to the load balancers, allowing them to easily enable SSL. This will require extra work in the Terraform blueprint as it listens to HTTP by default. + +Alternatively, if you have decided not to expose your environment, you can use the jump host to access relevant services on your local machine via port-forwarding. + +For an enterprise grade solution, you can utilize the [AWS Client VPN](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/what-is.html) instead to reach the private subnet within the VPC. The setup requires extra work and certificates, described in the [getting started tutorial by AWS](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-getting-started.html). + +The following can be executed from within the Terraform folder to bind the remote ports to your local machine: + +```sh +export BASTION_HOST=$(terraform output -raw bastion_ip) +# retrieves the first IP from the camunda_ips array +export CAMUNDA_IP=$(tf output -json camunda_ips | jq -r '.[0]') + +# 26500 - gRPC; 8080 - WebUI; 9090 - Connectors +ssh -L 26500:${CAMUNDA_IP}:26500 -L 8080:${CAMUNDA_IP}:8080 -L 9090:${CAMUNDA_IP}:9090 admin@${BASTION_HOST} +``` + +### Turn off bastion host (optional) + +If you used the [bastion host](#turn-off-bastion-host-optional) for access, it can be turned off when longer needed for direct access to the EC2 instances. + +To turn off the bastion host, set the `enable_jump_host` variable to `false` in the `variables.tf` file, and reapply Terraform. + +## 3. Verify connectivity to Camunda 8 + +Using Terraform, you can obtain the HTTP endpoint of the Application Load Balancer and interact with Camunda through the [REST API](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md). + +1. Navigate to the Terraform folder: + +```sh +cd camunda-deployment-references-main/aws/ec2/terraform +``` + +2. Retrieve the Application Load Balancer output: + +```sh +terraform output -raw alb_endpoint +``` + +3. Use the REST API to communicate with Camunda: + +Follow the example in the [REST API documentation](/apis-tools/camunda-api-rest/camunda-api-rest-authentication.md) to authenticate and retrieve the cluster topology. + +## Manage Camunda 8 + +### Upgrade Camunda 8 + +:::info Direct upgrade not supported +Upgrading directly from a Camunda 8.6 release to 8.7 is not supported and cannot be performed. +::: + +To update to a new patch release, the recommended approach is as follows: + +1. Remove the `jars` folder: This step ensures that outdated dependencies from previous versions are completely removed. +2. Overwrite remaining files: Replace the existing files with those from the downloaded patch release package. +3. Restart Camunda 8. + +The update process can be automated using the `all-in-one-install.sh` script, which performs the following steps: + +- Detects an existing Camunda 8 installation. +- Deletes the jars folder to clear outdated dependencies. +- Overwrites the remaining files with the updated version. +- Regenerates configuration files. +- Restarts the application to apply the updates. + +### Monitoring + +Our default way of exposing metrics is in the Prometheus format, please conduct the general [metrisc related documentation](/self-managed/zeebe-deployment/operations/metrics.md) to learn more how to scrape Camunda 8. + +In an AWS environment, you can leverage CloudWatch not only for log collection but also for gathering [Prometheus metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContainerInsights-Prometheus-metrics.html). It's important to note that while Camunda natively supports Grafana and Prometheus, integrating CloudWatch for metric visualization is possible but requires additional configuration. + +### Backups + +Please conduct the general topic of backups in the [documentation](/self-managed/operational-guides/backup-restore/backup-and-restore.md). + +With AWS as chosen platform you can utilize [S3](https://aws.amazon.com/s3/) for the backups both for Zeebe and Elasticsearch. + +If you are using a managed OpenSearch domain instead, you should check out the [official documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-snapshots.html) on creating backups and snapshots in OpenSearch. + +## Troubleshooting + +Please conduct the general topic of troubleshooting in the [documentation](/self-managed/operational-guides/troubleshooting/troubleshooting.md). + + + + diff --git a/docs/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.jpg b/docs/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.jpg new file mode 100644 index 00000000000..862eacd4fe0 Binary files /dev/null and b/docs/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.jpg differ diff --git a/docs/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.pdf b/docs/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.pdf new file mode 100644 index 00000000000..5506e354c8c Binary files /dev/null and b/docs/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.pdf differ diff --git a/docs/self-managed/setup/deploy/amazon/openshift/terraform-setup.md b/docs/self-managed/setup/deploy/amazon/openshift/terraform-setup.md new file mode 100644 index 00000000000..150827308ef --- /dev/null +++ b/docs/self-managed/setup/deploy/amazon/openshift/terraform-setup.md @@ -0,0 +1,384 @@ +--- +id: terraform-setup +title: "Deploy a ROSA HCP Cluster with Terraform" +description: "Deploy Red Hat OpenShift on AWS using a Terraform module for a quick Camunda 8 setup." +--- + + + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +This guide provides a detailed tutorial for deploying a [Red Hat OpenShift on AWS (ROSA) cluster with Hosted Control Plane (HCP)](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/architecture/index#architecture-overview) capabilities. It is specifically tailored for deploying Camunda 8 using Terraform, a widely-used Infrastructure as Code (IaC) tool. + +We recommend this guide for building a robust and sustainable infrastructure. However, if you are looking for a quicker trial or proof of concept, or if your needs aren't fully met by our module, consider following the official [ROSA Quickstart Guide](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/getting_started/rosa-quickstart-guide-ui#rosa-quickstart-guide-ui). + +This guide aims to help you leverage IaC to streamline and reproduce your cloud infrastructure setup. While it covers the essentials for deploying an ROSA HCP cluster, for more advanced use cases, please refer to the official [Red Hat OpenShift on AWS Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4). + +:::tip + +If you are completely new to Terraform and the idea of IaC, read through the [Terraform IaC documentation](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code) and give their [interactive quick start](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code#quick-start) a try for a basic understanding. + +::: + +## Requirements + +- A [Red Hat Account](https://www.redhat.com/) to create the Red Hat OpenShift cluster. +- An [AWS account](https://docs.aws.amazon.com/accounts/latest/reference/accounts-welcome.html) to create any resources within AWS. +- [AWS CLI (2.17+)](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html), a CLI tool for creating AWS resources. +- [Terraform (1.9+)](https://developer.hashicorp.com/terraform/downloads) +- [kubectl (1.30+)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the cluster. +- [ROSA CLI](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/getting_started/rosa-quickstart-guide-ui#rosa-getting-started-environment-setup_rosa-quickstart-guide-ui) to interact with the cluster. +- [jq (1.7+)](https://jqlang.github.io/jq/download/) to interact with some Terraform variables. +- This guide uses GNU/Bash for all the shell commands listed. + +### Considerations + +This setup provides a foundational starting point for working with Camunda 8, though it is not optimized for peak performance. It serves as a solid initial step in preparing a production environment by leveraging [Infrastructure as Code (IaC) tools](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code). + +Terraform can seem complex at first. If you're interested in understanding what each component does, consider trying out the [Red Hat OpenShift on AWS UI-based tutorial](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/tutorials/getting-started-with-rosa#creating-account-wide-roles). This guide will show you what resources are created and how they interact with each other. + +If you require managed services for PostgreSQL Aurora or OpenSearch, you can refer to the definitions provided in the [EKS setup with Terraform](../amazon-eks/terraform-setup.md) guide. However, please note that these configurations may need adjustments to fit your specific requirements and have not been tested. By default, this guide assumes that the database services (PostgreSQL and Elasticsearch) integrated into the default chart will be used. + +For testing Camunda 8 or developing against it, you might consider signing up for our [SaaS offering](https://camunda.com/platform/). If you already have a Red Hat OpenShift cluster on AWS, you can skip ahead to the [Helm setup guide](/self-managed/setup/deploy/openshift/redhat-openshift.md). + +To keep this guide concise, we provide links to additional documentation covering best practices, allowing you to explore each topic in greater depth. + +:::warning Cost management + +Following this guide will incur costs on your cloud provider account and your Red Hat account, specifically for the managed OpenShift service, OpenShift worker nodes running in EC2, the hosted control plane, Elastic Block Storage (EBS), and Route 53. For more details, refer to [ROSA AWS pricing](https://aws.amazon.com/rosa/pricing/) and the [AWS Pricing Calculator](https://calculator.aws/#/) as total costs vary by region. + +::: + +### Variants + +Unlike the [EKS Terraform setup](../amazon-eks/terraform-setup.md), we currently support only one main variant of this setup: + +- The **standard installation** uses a username and password connection for Camunda components (or relies solely on network isolation for certain components). This option is straightforward and easier to implement, making it ideal for environments where simplicity and rapid deployment are priorities, or where network isolation provides adequate security. + +- The second variant, **IRSA** (IAM Roles for Service Accounts), may work but has not been tested. If you’re interested in setting it up, please refer to the EKS guide as a foundational resource. + +### Outcome + + + + +_Infrastructure diagram for a single region ROSA setup (click on the image to open the PDF version)_ +[![Infrastructure Diagram ROSA Single-Region](./assets/rosa-single-region.jpg)](./assets/rosa-single-region.pdf) + +Following this tutorial and steps will result in: + +- A [Red Hat OpenShift with Hosted Control Plane](https://www.redhat.com/en/topics/containers/what-are-hosted-control-planes#rosa-with-hcp) cluster running the latest ROSA version with six nodes ready for Camunda 8 installation. +- The [EBS CSI driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html) is installed and configured, which is used by the Camunda 8 Helm chart to create [persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/). + +## 1. Configure AWS and initialize Terraform + +### Terraform prerequisites + +To manage the infrastructure for Camunda 8 on AWS using Terraform, we need to set up Terraform's backend to store the state file remotely in an S3 bucket. This ensures secure and persistent storage of the state file. + +:::note +Advanced users may want to handle this part differently and use a different backend. The backend setup provided is an example for new users. +::: + +#### Set up AWS authentication + +The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) is required to create resources in AWS. Before you can use the provider, you must authenticate it using your AWS credentials. + +:::caution Ownership of the created resources + +A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user. + +::: + +You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods: + +- For development or testing purposes you can use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials. + To configure the AWS CLI: + + ```bash + aws configure + ``` + + Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). + +- For production environments, we recommend the use of a dedicated IAM user. Create [access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console, and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. + +#### Create an S3 bucket for Terraform state management + +Before setting up Terraform, you need to create an S3 bucket that will store the state file. This is important for collaboration and to prevent issues like state file corruption. + +To start, set the region as an environment variable upfront to avoid repeating it in each command: + +```bash +export AWS_REGION= +``` + +Replace `` with your chosen AWS region (for example, `eu-central-1`). + +Now, follow these steps to create the S3 bucket with versioning enabled: + +1. Open your terminal and ensure the AWS CLI is installed and configured. + +1. Run the following command to create an S3 bucket for storing your Terraform state. Make sure to use a unique bucket name and set the `AWS_REGION` environment variable beforehand: + + ```bash + # Replace "my-rosa-tf-state" with your unique bucket name + export S3_TF_BUCKET_NAME="my-rosa-tf-state" + + aws s3api create-bucket --bucket "$S3_TF_BUCKET_NAME" --region "$AWS_REGION" \ + --create-bucket-configuration LocationConstraint="$AWS_REGION" + ``` + +1. Enable versioning on the S3 bucket to track changes and protect the state file from accidental deletions or overwrites: + + ```bash + aws s3api put-bucket-versioning --bucket "$S3_TF_BUCKET_NAME" --versioning-configuration Status=Enabled --region "$AWS_REGION" + ``` + +1. Secure the bucket by blocking public access: + + ```bash + aws s3api put-public-access-block --bucket "$S3_TF_BUCKET_NAME" --public-access-block-configuration \ + "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true" --region "$AWS_REGION" + ``` + +1. Verify versioning is enabled on the bucket: + + ```bash + aws s3api get-bucket-versioning --bucket "$S3_TF_BUCKET_NAME" --region "$AWS_REGION" + ``` + +This S3 bucket will now securely store your Terraform state files with versioning enabled. + +#### Create a `config.tf` with the following setup + +Once the S3 bucket is created, configure your `config.tf` file to use the S3 backend for managing the Terraform state: + +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/config.tf +``` + +#### Initialize Terraform + +Once your `config.tf` and authentication are set up, you can initialize your Terraform project. The previous steps configured a dedicated S3 Bucket (`S3_TF_BUCKET_NAME`) to store your state, and the following creates a bucket key that will be used by your configuration. + +Configure the backend and download the necessary provider plugins: + +```bash +export S3_TF_BUCKET_KEY="camunda-terraform/terraform.tfstate" + +echo "Storing terraform state in s3://$S3_TF_BUCKET_NAME/$S3_TF_BUCKET_KEY" + +terraform init -backend-config="bucket=$S3_TF_BUCKET_NAME" -backend-config="key=$S3_TF_BUCKET_KEY" +``` + +Terraform will connect to the S3 bucket to manage the state file, ensuring remote and persistent storage. + +### OpenShift cluster module setup + +This module sets up the foundational configuration for ROSA HCP and Terraform usage. + +We will leverage [Terraform modules](https://developer.hashicorp.com/terraform/language/modules), which allow us to abstract resources into reusable components, simplifying infrastructure management. + +The [Camunda-provided module](https://github.com/camunda/camunda-tf-rosa) is publicly available and serves as a robust starting point for deploying a Red Hat OpenShift cluster on AWS using a Hosted Control Plane. It is highly recommended to review this module before implementation to understand its structure and capabilities. + +Please note that this module is based on the official [ROSA HCP Terraform module documentation](https://docs.openshift.com/rosa/rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.html). It is presented as an example for running Camunda 8 in ROSA. For advanced use cases or custom setups, we encourage you to use the official module, which includes vendor-supported features. + +#### Set up ROSA authentication + +To set up a ROSA cluster, certain prerequisites must be configured on your AWS account. Below is an excerpt from the [official ROSA planning prerequisites checklist](https://docs.openshift.com/rosa/rosa_planning/rosa-cloud-expert-prereq-checklist.html): + +1. Verify that your AWS account is correctly configured: + + ```bash + aws sts get-caller-identity + ``` + +1. Check if the ELB service role exists, as if you have never created a load balancer in your AWS account, the role for Elastic Load Balancing (ELB) might not exist yet: + + ```bash + aws iam get-role --role-name "AWSServiceRoleForElasticLoadBalancing" + ``` + + If it doesn't exist, create it: + + ```bash + aws iam create-service-linked-role --aws-service-name "elasticloadbalancing.amazonaws.com" + ``` + +1. Create a Red Hat Hybrid Cloud Console account if you don’t already have one: [Red Hat Hybrid Cloud Console](https://console.redhat.com/). + +1. Enable ROSA on your AWS account via the [AWS Console](https://console.aws.amazon.com/rosa/). + +1. Enable HCP ROSA on [AWS Marketplace](https://docs.openshift.com/rosa/cloud_experts_tutorials/cloud-experts-rosa-hcp-activation-and-account-linking-tutorial.html): + + - Navigate to the ROSA console: [AWS ROSA Console](https://console.aws.amazon.com/rosa). + - Choose **Get started**. + - On the **Verify ROSA prerequisites** page, select **I agree to share my contact information with Red Hat**. + - Choose **Enable ROSA**. + + **Note**: Only a single AWS account can be associated with a Red Hat account for service billing. + +1. Install the ROSA CLI from the [OpenShift AWS Console](https://console.redhat.com/openshift/downloads#tool-rosa). + +1. Get an API token, go to the [OpenShift Cluster Management API Token](https://console.redhat.com/openshift/token/rosa), click **Load token**, and save it. Use the token to log in with ROSA CLI: + + ```bash + export RHCS_TOKEN="" + rosa login --token="$RHCS_TOKEN" + + # Verify the login + rosa whoami + ``` + +1. Verify your AWS quotas: + + ```bash + rosa verify quota --region="$AWS_REGION" + ``` + + **Note**: This may fail due to organizational policies. + +1. Create the required account roles: + + ```bash + rosa create account-roles --mode auto + ``` + +1. Verify your AWS quotas, and if quotas are insufficient, consult the following: + + - [Provisioned AWS Infrastructure](https://docs.openshift.com/rosa/rosa_planning/rosa-sts-aws-prereqs.html#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs) + - [Required AWS Service Quotas](https://docs.openshift.com/rosa/rosa_planning/rosa-sts-required-aws-service-quotas.html#rosa-sts-required-aws-service-quotas) + +1. Ensure the `oc` CLI is installed. If it’s not already installed, follow the [official ROSA oc installation guide](https://docs.openshift.com/rosa/cli_reference/openshift_cli/getting-started-cli.html#cli-getting-started): + + ```bash + rosa verify openshift-client + ``` + +#### Set up the ROSA cluster module + +1. Create a `cluster.tf` file in the same directory as your `config.tf` file. +2. Add the following content to your newly created `cluster.tf` file to utilize the provided module: + + :::note Configure your cluster + + Customize the cluster name, availability zones, with the values you previously retrieved from the Red Hat Console. + Additionally, provide a secure username and password for the cluster administrator. + + Ensure that you have set the environment `RHCS_TOKEN` is set with your [OpenShift Cluster Management API Token](https://console.redhat.com/openshift/token/rosa). + + By default, this cluster will be accessible from the internet. If you prefer to restrict access, please refer to the official documentation of the module. + + ::: + + ```hcl reference + https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/cluster.tf + ``` + + :::caution Camunda Terraform module + + This ROSA module is based on the [official Red Hat Terraform module for ROSA HCP](https://registry.terraform.io/modules/terraform-redhat/rosa-hcp/rhcs/latest). Please be aware of potential differences and choices in implementation between this module and the official one. + + We invite you to consult the [Camunda ROSA module documentation](https://github.com/camunda/camunda-tf-rosa/blob/v2.0.0/modules/rosa-hcp/README.md) for more information. + + ::: + +3. [Initialize](#initialize-terraform) Terraform for this module using the following Terraform command: + + ```bash + terraform init -backend-config="bucket=$S3_TF_BUCKET_NAME" -backend-config="key=$S3_TF_BUCKET_KEY" + ``` + +4. Configure user access to the cluster. By default, the user who creates the OpenShift cluster has administrative access. If you want to grant access to other users, follow the [Red Hat documentation for granting admin rights to users](https://docs.openshift.com/rosa/cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-admin-rights.html) when the cluster is created. + +5. Customize the cluster setup. The module offers various input options that allow you to further customize the cluster configuration. For a comprehensive list of available options and detailed usage instructions, refer to the [ROSA module documentation](https://github.com/camunda/camunda-tf-rosa/blob/v2.0.0/modules/rosa-hcp/README.md). + +### Define outputs + +**Terraform** allows you to define outputs, which make it easier to retrieve important values generated during execution, such as cluster endpoints and other necessary configurations for Helm setup. + +Each module that you have previously set up contains an output definition at the end of the file. You can adjust them to your needs. + +### Execution + +:::note Secret management + +We strongly recommend managing sensitive information (for example, the OpenSearch or Aurora username and password) using a secure secrets management solution like HashiCorp Vault. For details on how to inject secrets directly into Terraform via Vault, see the [Terraform Vault Secrets Injection Guide](https://developer.hashicorp.com/terraform/tutorials/secrets/secrets-vault). + +::: + +1. Open a terminal in the created Terraform folder where `config.tf` and other `.tf` files are. + +2. Plan the configuration files: + + ```bash + terraform plan -out cluster.plan # describe what will be created + ``` + +3. After reviewing the plan, you can confirm and apply the changes. + + ```bash + terraform apply cluster.plan # apply the creation + ``` + +Terraform will now create the OpenShift cluster with all the necessary configurations. The completion of this process may require approximately 20-30 minutes for each component. + +### Reference files + +Depending on the installation path you have chosen, you can find the reference files used on this page: + +- **Standard installation:** [Reference Files](https://github.com/camunda/camunda-deployment-references/tree/feature/openshift-ra-standard/aws/rosa-hcp/camunda-versions/8.7) + +## 2. Preparation for Camunda 8 installation + +### Access the created OpenShift cluster + +You can access the created OpenShift cluster using the following steps: + +Set up the required environment variables: + +```shell +export CLUSTER_NAME="$(terraform console << + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; Red Hat OpenShift, a Kubernetes distribution maintained by [Red Hat](https://www.redhat.com/en/technologies/cloud-computing/openshift), provides options for both managed and on-premises hosting. -:::note -Deploying Camunda 8 on Red Hat OpenShift is achievable using Helm, given the appropriate configurations. However, it's important to note that the [Security Context Constraints (SCCs)](#security-context-constraints-sccs) and [Routes](./redhat-openshift.md?current-ingress=openshift-routes#using-openshift-routes) configurations might require slight deviations from the guidelines provided in the [general Helm deployment guide](/self-managed/setup/install.md). -::: +Deploying Camunda 8 on Red Hat OpenShift is supported using Helm, given the appropriate configurations. + +However, it's important to note that the [Security Context Constraints (SCCs)](#security-context-constraints-sccs) and [Routes](./redhat-openshift.md?current-ingress=openshift-routes#using-openshift-routes) configurations might require slight deviations from the guidelines provided in the [general Helm deployment guide](/self-managed/setup/install.md). ## Cluster Specification When deploying Camunda 8 on an OpenShift cluster, the cluster specification should align with your specific requirements and workload characteristics. Here's a suggested configuration to begin with: -- **Instance type:** 4 vCPUs (x86_64, >3.1 GHz), 16 GiB Memory (for example, [m5.xlarge on AWS](https://aws.amazon.com/en/ebs/general-purpose/)) +- **Instance type:** 4 vCPUs (x86_64, >3.1 GHz), 16 GiB Memory (for example, [mi7.xlarge on AWS](https://aws.amazon.com/en/ebs/general-purpose/)) - **Number of dedicated nodes:** 4 - **Volume type:** SSD volumes (with between 1000 and 3000 IOPS per volume, and a throughput of 1,000 MB/s per volume, for instance, [gp3 on AWS](https://aws.amazon.com/en/ebs/general-purpose/)) +If you need to set up an OpenShift cluster on a cloud provider, we recommend our [guide to deploying a ROSA cluster](/self-managed/setup/deploy/amazon/openshift/terraform-setup.md). + ### Supported Versions We conduct testing and ensure compatibility against the following OpenShift versions: | OpenShift Version | [End of Support Date](https://access.redhat.com/support/policy/updates/openshift) | | ----------------- | --------------------------------------------------------------------------------- | +| 4.17.x | June 27, 2025 | | 4.16.x | December 27, 2025 | | 4.15.x | August 27, 2025 | | 4.14.x | May 1, 2025 | -| 4.13.x | November 17, 2024 | -:::caution +:::caution Versions compatibility + Camunda 8 supports OpenShift versions in the Red Hat General Availability, Full Support, and Maintenance Support life cycle phases. For more information, refer to the [Red Hat OpenShift Container Platform Life Cycle Policy](https://access.redhat.com/support/policy/updates/openshift). + ::: -## Deploying Camunda 8 in OpenShift +## Requirements -Depending on your OpenShift cluster's Security Context Constraints (SCCs) configuration, the deployment process may vary. +- [Helm (3.16+)](https://helm.sh/docs/intro/install/) +- [kubectl (1.30+)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the cluster. +- [jq (1.7+)](https://jqlang.github.io/jq/download/) to interact with some variables. +- [GNU envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) to generate manifests. +- [oc (version supported by your OpenShift)](https://docs.openshift.com/container-platform/4.17/cli_reference/openshift_cli/getting-started-cli.html) to interact with OpenShift. +- A namespace to host the Camunda Platform, in this guide we will reference `camunda` as the target namespace. - - +## Deploy Camunda 8 via Helm charts + +### Configure your deployment + +Start by creating a `values.yml` file to store the configuration for your environment. +This file will contain key-value pairs that will be substituted using `envsubst`. +Over this guide, you will add and merge values in this file to configure your deployment to fit your needs. + +You can find a reference example of this file here: + +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/base.yml +``` + +:::warning Merging YAML files + +This guide references multiple configuration files that need to be merged into a single YAML file. Be cautious to avoid duplicate keys when merging the files. Additionally, pay close attention when copying and pasting YAML content. Ensure that the separator notation `---` does not inadvertently split the configuration into multiple documents. + +We strongly recommend double-checking your YAML file before applying it. You can use tools like [yamllint.com](https://www.yamllint.com/) or the [YAML Lint CLI](https://github.com/adrienverge/yamllint) if you prefer not to share your information online. + +::: + +#### Configuring the Ingress + +Before exposing services outside the cluster, we need an Ingress component. Here's how you can configure it: + + + + + +[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) expose services externally by linking a URL to a service within the cluster. OpenShift supports both the [standard Kubernetes Ingress and routes](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html), giving cluster users the flexibility to choose. + +The presence of routes is rooted in their specification predating Ingress. The functionality of routes differs from Ingress; for example, unlike Ingress, routes don't allow multiple services to be linked to a single route or the use of paths. + +To use these routes for the Zeebe Gateway, configure this through Ingress as well. + +#### Setting Up the application domain for Camunda 8 + +The route created by OpenShift will use a domain to provide access to the platform. By default, you can use the OpenShift applications domain, but any other domain supported by the router can also be used. + +To retrieve the OpenShift applications domain (used as an example here), run the following command: + +```bash +export OPENSHIFT_APPS_DOMAIN=$(oc get ingresses.config.openshift.io cluster -o jsonpath='{.spec.domain}') +``` + +Next, define the route domain that will be used for the Camunda 8 deployment. For example: + +```bash +export DOMAIN_NAME="camunda.$OPENSHIFT_APPS_DOMAIN" + +echo "Camunda 8 will be reachable from $DOMAIN_NAME" +``` + +If you choose to use a custom domain instead, ensure it is supported by your router configuration and replace the example domain with your desired domain. For more details on configuring custom domains in OpenShift, refer to the official [custom domain OpenShift documentation](https://docs.openshift.com/dedicated/applications/deployments/osd-config-custom-domains-applications.html). + +#### Checking if HTTP/2 is enabled + +As the Zeebe Gateway also uses `gRPC` (which relies on `HTTP/2`), [HTTP/2 Ingress Connectivity must be enabled](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html#nw-http2-haproxy_configuring-ingress). + +To check if HTTP/2 is already enabled on your OpenShift cluster, run the following command: + +```bash +oc get ingresses.config/cluster -o json | jq '.metadata.annotations."ingress.operator.openshift.io/default-enable-http2"' +``` + +Alternatively, if you use a dedicated IngressController for the deployment: + +```bash +# List your IngressControllers +oc -n openshift-ingress-operator get ingresscontrollers + +# Replace with your IngressController name +oc -n openshift-ingress-operator get ingresscontrollers/ -o json | jq '.metadata.annotations."ingress.operator.openshift.io/default-enable-http2"' +``` + +- If the output is `"true"`, it means HTTP/2 is enabled. +- If the output is `null` or empty, HTTP/2 is not enabled. + +
    + Enable HTTP/2 + +If HTTP/2 is not enabled, you can enable it by running the following command: + +**IngressController configuration:** + +```bash +oc -n openshift-ingress-operator annotate ingresscontrollers/ ingress.operator.openshift.io/default-enable-http2=true +``` + +**Global cluster configuration:** + +```bash +oc annotate ingresses.config/cluster ingress.operator.openshift.io/default-enable-http2=true +``` + +This will add the necessary annotation to [enable HTTP/2 for Ingress in your OpenShift cluster](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html#nw-http2-haproxy_configuring-ingress) globally on the cluster. + +
    + +#### Configure Route TLS + +Additionally, the Zeebe Gateway should be configured to use an encrypted connection with TLS. In OpenShift, the connection from HAProxy to the Zeebe Gateway service can use HTTP/2 only for re-encryption or pass-through routes, and not for edge-terminated or insecure routes. -### With restrictive SCCs +1. **Core Pod:** two [TLS secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) for the Zeebe Gateway are required, one for the **service** and the other one for the **route**: + - The first TLS secret is issued to the Zeebe Gateway Service Name. This must use the [PKCS #8 syntax](https://en.wikipedia.org/wiki/PKCS_8) or [PKCS #1 syntax](https://en.wikipedia.org/wiki/PKCS_1) as Zeebe only supports these, referenced as `camunda-platform-internal-service-certificate`. This certificate is also use in the other components such as Operate, Tasklist. + + In the example below, a TLS certificate is generated for the Zeebe Gateway service with an [annotation](https://docs.openshift.com/container-platform/latest/security/certificates/service-serving-certificate.html). The generated certificate will be in the form of a secret. + + Another option is [Cert Manager](https://docs.openshift.com/container-platform/latest/security/cert_manager_operator/index.html). For more details, review the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html#nw-ingress-creating-a-reencrypt-route-with-a-custom-certificate_secured-routes). + +
    + PKCS #8, PKCS #1 syntax + + > PKCS #1 private key encoding. PKCS #1 produces a PEM block that contains the private key algorithm in the header and the private key in the body. A key that uses this can be recognised by its BEGIN RSA PRIVATE KEY or BEGIN EC PRIVATE KEY header. NOTE: This encoding is not supported for Ed25519 keys. Attempting to use this encoding with an Ed25519 key will be ignored and default to PKCS #8. + + > PKCS #8 private key encoding. PKCS #8 produces a PEM block with a static header and both the private key algorithm and the private key in the body. A key that uses this encoding can be recognised by its BEGIN PRIVATE KEY header. + + [PKCS #1, PKCS #8 syntax definitionfrom cert-manager](https://cert-manager.io/docs/reference/api-docs/#cert-manager.io/v1.PrivateKeyEncoding) + +
    + + - The second TLS secret is used on the exposed route, referenced as `camunda-platform-external-certificate`. For example, this would be the same TLS secret used for Ingress. We also configure the Zeebe Gateway Ingress to create a [Re-encrypt Route](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html#nw-ingress-creating-a-route-via-an-ingress_route-configuration). + + To configure a Zeebe cluster securely, it's essential to set up a secure communication configuration between pods: + + - We enable gRPC ingress for the Core pod, which sets up a secure proxy that we'll use to communicate with the Zeebe cluster. To avoid conflicts with other services, we use a specific domain (`zeebe-$DOMAIN_NAME`) for the gRPC proxy, different from the one used by other services (`$DOMAIN_NAME`). We also note that the port used for gRPC is `443`. + + - We mount the **Service Certificate Secret** (`camunda-platform-internal-service-certificate`) to the Core pod and configure a secure TLS connection. + + Update your `values.yml` file with the following: + + ```yaml reference + https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/core-route.yml + ``` + + The actual configuration properties can be reviewed: + + - [in the Operate configuration documentation](/self-managed/operate-deployment/operate-configuration.md#zeebe-broker-connection), + - [in the Tasklist configuration documentation](/self-managed/tasklist-deployment/tasklist-configuration.md#zeebe-broker-connection), + - [in the Zeebe Gateway configuration documentation](/self-managed/zeebe-deployment/configuration/gateway.md). + +2. **Connectors:** update your `values.yml` file with the following: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/connectors-route.yml +``` + +The actual configuration properties can be reviewed [in the Connectors configuration documentation](/self-managed/connectors-deployment/connectors-configuration.md#zeebe-broker-connection). + +1. Configure all other applications running inside the cluster and connecting to the Zeebe Gateway to also use TLS. + +1. Set up the global configuration to enable the single Ingress definition with the host. Update your configuration file as shown below: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/domain.yml +``` + + + + +     + + + +[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) serve as OpenShift's default Ingress implementation. + +If you find that its features aren't suitable for your needs, or if you prefer to use a Kubernetes-native Ingress controller, such as the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx), [you have that option](https://www.redhat.com/en/blog/a-guide-to-using-routes-ingress-and-gateway-apis-in-kubernetes-without-vendor-lock-in). + +For guidance on installing an Ingress controller, you can refer to the [Ingress Setup documentation](/self-managed/setup/guides/ingress-setup.md). + +:::note Difference between ingress-nginx and NGINX Ingress + +Do not confuse the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx) with the [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift) that is endorsed by Red Hat for usage with OpenShift. Despite very similar names, they are two different products. + +If you should decide to use the Red Hat endorsed [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift), you would require additional adjustments done to the Camunda 8 Ingress objects and the NGINX Ingress Controller itself to make `gRPC` and `HTTP/2` connections work. In that case, please refer to the [example and the prerequisites](https://github.com/nginxinc/kubernetes-ingress/blob/main/examples/ingress-resources/grpc-services/README.md). + +::: + + + +If you do not have a domain name or do not intend to use one for your Camunda 8 deployment, external access to Camunda 8 web endpoints from outside the OpenShift cluster will not be possible. + +However, you can use `kubectl port-forward` to access the Camunda platform without a domain name or Ingress configuration. For more information, refer to the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/). + +To make this work, you will need to configure the deployment to reference `localhost` with the forwarded port. Update your `values.yml` file with the following: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/no-domain.yml +``` + + +     + +#### Configuring the Security Context Constraints + +Depending on your OpenShift cluster's Security Context Constraints (SCCs) configuration, the deployment process may vary. By default, OpenShift employs more restrictive SCCs. The Helm chart must assign `null` to the user running all components and dependencies. + + + + The `global.compatibility.openshift.adaptSecurityContext` variable in your values.yaml can be used to set the following possible values: - `force`: The `runAsUser` and `fsGroup` values will be null in all components. - `disabled`: The `runAsUser` and `fsGroup` values will not be modified (default). -To deploy Camunda 8 on OpenShift: - -1. Install [Helm and other CLI tools](/self-managed/setup/install.md#prerequisites). -2. Install the [Camunda Helm chart repository](/self-managed/setup/install.md#helm-repository). -3. Set `global.compatibility.openshift.adaptSecurityContext` to `force` - -```shell -helm install camunda camunda/camunda-platform --skip-crds \ - --set global.compatibility.openshift.adaptSecurityContext=force +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/scc.yml ``` -### With permissive SCCs - To use permissive SCCs, simply install the charts as they are. Follow the [general Helm deployment guide](/self-managed/setup/install.md). +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/helm-values/no-scc.yml +``` + -## Available Configurations of OpenShift Components +#### Enable Enterprise components + +Some components are not enabled by default in this deployment. For more information on how to configure and enable these components, refer to [configuring Enterprise components and Connectors](/self-managed/setup/install.md#configuring-enterprise-components-and-connectors). + +#### Fill your deployment with actual values + +Once you've prepared the `values.yml` file, run the following `envsubst` command to substitute the environment variables with their actual values: + +```bash +# generate the final values +envsubst < values.yml > generated-values.yml + +# print the result +cat generated-values.yml +``` + +:::info Camunda Helm chart no longer automatically generates passwords + +Starting from **Camunda 8.6**, the Helm chart deprecated the automatic generation of secrets, and this feature has been fully removed in **Camunda 8.7**. + +::: + +Next, store various passwords in a Kubernetes secret, which will be used by the Helm chart. Below is an example of how to set up the required secret. You can use `openssl` to generate random secrets and store them in environment variables: + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/generate-passwords.sh +``` + +Use these environment variables in the `kubectl` command to create the secret. + +- The `smtp-password` should be replaced with the appropriate external value ([see how it's used by Web Modeler](/self-managed/modeler/web-modeler/configuration/configuration.md#smtp--email)). + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/create-identity-secret.sh +``` + +### Install Camunda 8 using Helm + +Now that the `generated-values.yml` is ready, you can install Camunda 8 using Helm. + +The following are the required environment variables with some example values: + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/chart-env.sh +``` + +Then run the following command: + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.7/procedure/install/install-chart.sh +``` + +This command: + +- Installs (or upgrades) the Camunda platform using the Helm chart. +- Substitutes the appropriate version using the `$CAMUNDA_HELM_CHART_VERSION` environment variable. +- Applies the configuration from `generated-values.yml`. + +:::note + +This guide uses `helm upgrade --install` as it runs install on initial deployment and upgrades future usage. This may make it easier for future [Camunda 8 Helm upgrades](/self-managed/setup/upgrade.md) or any other component upgrades. + +::: + +You can track the progress of the installation using the following command: + +```bash +watch -n 5 ' + kubectl get pods -n camunda --output=wide; + if [ $(kubectl get pods -n camunda --field-selector=status.phase!=Running -o name | wc -l) -eq 0 ] && + [ $(kubectl get pods -n camunda -o json | jq -r ".items[] | select(.status.containerStatuses[]?.ready == false)" | wc -l) -eq 0 ]; + then + echo "All pods are Running and Healthy - Installation completed!"; + else + echo "Some pods are not Running or Healthy"; + fi +' +``` + +## Verify connectivity to Camunda 8 + +Please follow our [guide to verify connectivity to Camunda 8](/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md#verify-connectivity-to-camunda-8). + +The username of the first user is `demo`, the password is the one generated previously and stored in the environment variable `FIRST_USER_PASSWORD`. + +:::caution Domain name for gRPC Zeebe + +In this setup, the domain used for gRPC communication with Zeebe is slightly different from the one in the guide. Instead of using `zeebe.$DOMAIN_NAME`, you need to use `zeebe-$DOMAIN_NAME`. + +::: + +## Pitfalls to avoid + +For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md). ### Security Context Constraints (SCCs) @@ -144,220 +440,3 @@ If you deploy Camunda 8 (and related infrastructure) with permissive SCCs out of     - -## Ingress Configuration - -Before exposing services outside the cluster, we need an Ingress component. Here's how you can configure it: - - - - -### Using Kubernetes Ingress - -[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) serve as OpenShift's default Ingress implementation. - -If you find that its features aren't suitable for your needs, or if you prefer to use a Kubernetes-native Ingress controller, such as the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx), [you have that option](https://www.redhat.com/en/blog/a-guide-to-using-routes-ingress-and-gateway-apis-in-kubernetes-without-vendor-lock-in). - -For guidance on installing an Ingress controller, you can refer to the [Ingress Setup documentation](/self-managed/setup/guides/ingress-setup.md). - -:::note Difference between ingress-nginx and NGINX Ingress - -Do not confuse the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx) with the [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift) that is endorsed by Red Hat for usage with OpenShift. Despite very similar names, they are two different products. - -If you should decide to use the Red Hat endorsed [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift), you would require additional adjustments done to the Camunda 8 Ingress objects and the NGINX Ingress Controller itself to make `gRPC` and `HTTP/2` connections work. In that case, please refer to the [example and the prerequisites](https://github.com/nginxinc/kubernetes-ingress/blob/main/examples/ingress-resources/grpc-services/README.md). - -::: - - - - -### Using OpenShift Routes - -[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) expose services externally by linking a URL to a service within the cluster. [OpenShift supports both the standard Kubernetes Ingress and routes](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html), giving cluster users the flexibility to choose. - -The presence of routes is rooted in their specification predating Ingress. It's worth noting that the functionality of routes differs from Ingress; for example, unlike Ingress, routes don't allow multiple services to be linked to a single route or the use of paths. - -To use these routes for the Zeebe Gateway, configure this through Ingress as well. - -#### Prerequisite - -As the Zeebe Gateway also uses `gRPC` (which relies on `HTTP/2`), [HTTP/2 Ingress Connectivity has to be enabled](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html#nw-http2-haproxy_configuring-ingress). - -Additionally, the Zeebe Gateway should be configured to use an encrypted connection with TLS. In OpenShift, the connection from HAProxy to the Zeebe Gateway service can use HTTP/2 only for re-encryption or pass-through routes, and not for edge-terminated or insecure routes. - -#### Required Steps - -1. Provide two [TLS secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) for the Zeebe Gateway. - - - The first TLS secret is issued to the Zeebe Gateway Service Name. This must use the [PKCS #8 syntax](https://en.wikipedia.org/wiki/PKCS_8) or [PKCS #1 syntax](https://en.wikipedia.org/wiki/PKCS_1) as Zeebe only supports these, referenced as `camunda-platform-internal-service-certificate`. - - In the example below, a TLS certificate is generated for the Zeebe Gateway service with an [annotation](https://docs.openshift.com/container-platform/latest/security/certificates/service-serving-certificate.html). The generated certificate will be in the form of a secret. - - ```yaml - zeebeGateway: - service: - annotations: - service.beta.openshift.io/serving-cert-secret-name: camunda-platform-internal-service-certificate - ``` - - Another option is [Cert Manager](https://docs.openshift.com/container-platform/latest/security/cert_manager_operator/index.html). For more details, review the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html#nw-ingress-creating-a-reencrypt-route-with-a-custom-certificate_secured-routes). - -
    - PKCS #8, PKCS #1 syntax - - > PKCS #1 private key encoding. PKCS #1 produces a PEM block that contains the private key algorithm in the header and the private key in the body. A key that uses this can be recognised by its BEGIN RSA PRIVATE KEY or BEGIN EC PRIVATE KEY header. NOTE: This encoding is not supported for Ed25519 keys. Attempting to use this encoding with an Ed25519 key will be ignored and default to PKCS #8. - - > PKCS #8 private key encoding. PKCS #8 produces a PEM block with a static header and both the private key algorithm and the private key in the body. A key that uses this encoding can be recognised by its BEGIN PRIVATE KEY header. - - [PKCS #1, PKCS #8 syntax definitionfrom cert-manager](https://cert-manager.io/docs/reference/api-docs/#cert-manager.io/v1.PrivateKeyEncoding) - -
    - - - The second TLS secret is used on the exposed route, referenced as `camunda-platform-external-certificate`. For example, this would be the same TLS secret used for Ingress. - -1. Configure your Zeebe Gateway Ingress to create a [Re-encrypt Route](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html#nw-ingress-creating-a-route-via-an-ingress_route-configuration): - - ```yaml - zeebeGateway: - ingress: - grpc: - annotations: - route.openshift.io/termination: reencrypt - route.openshift.io/destination-ca-certificate-secret: camunda-platform-internal-service-certificate - className: openshift-default - tls: - enabled: true - secretName: camunda-platform-external-certificate - ``` - -1. Mount the **Service Certificate Secret** to the Zeebe Gateway Pod: - - ```yaml - zeebeGateway: - env: - - name: ZEEBE_GATEWAY_SECURITY_ENABLED - value: "true" - - name: ZEEBE_GATEWAY_SECURITY_CERTIFICATECHAINPATH - value: /usr/local/zeebe/config/tls.crt - - name: ZEEBE_GATEWAY_SECURITY_PRIVATEKEYPATH - value: /usr/local/zeebe/config/tls.key - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/zeebe/config/tls.crt - subPath: tls.crt - - name: key - mountPath: /usr/local/zeebe/config/tls.key - subPath: tls.key - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - - name: key - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.key - path: tls.key - defaultMode: 420 - ``` - -1. Mount the **Service Certificate Secret** to the Operate and Tasklist pods and configure the secure TLS connection. Here, only the `tls.crt` file is required. - - For Operate: - - ```yaml - operate: - env: - - name: CAMUNDA_OPERATE_ZEEBE_SECURE - value: "true" - - name: CAMUNDA_OPERATE_ZEEBE_CERTIFICATEPATH - value: /usr/local/operate/config/tls.crt - - name: CAMUNDA_OPERATE_ZEEBE_BROKERCONTACTPOINT - value: camunda-zeebe-gateway.camunda.svc.cluster.local:26500 - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/operate/config/tls.crt - subPath: tls.crt - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - ``` - - The actual configuration properties can be reviewed [in the Operate configuration documentation](/self-managed/operate-deployment/operate-configuration.md#zeebe-broker-connection). - - For Tasklist: - - ```yaml - tasklist: - env: - - name: CAMUNDA_TASKLIST_ZEEBE_SECURE - value: "true" - - name: CAMUNDA_TASKLIST_ZEEBE_CERTIFICATEPATH - value: /usr/local/tasklist/config/tls.crt - - name: CAMUNDA_TASKLIST_ZEEBE_BROKERCONTACTPOINT - value: camunda-zeebe-gateway.camunda.svc.cluster.local:26500 - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/tasklist/config/tls.crt - subPath: tls.crt - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - ``` - - The actual configuration properties can be reviewed [in the Tasklist configuration documentation](/self-managed/tasklist-deployment/tasklist-configuration.md#zeebe-broker-connection). - -1. Configure Connectors: - - ```yaml - connectors: - inbound: - mode: oauth - env: - - name: ZEEBE_CLIENT_BROKER_GATEWAY-ADDRESS - value: "camunda-zeebe-gateway.camunda.svc.cluster.local:26500" - - name: ZEEBE_CLIENT_SECURITY_PLAINTEXT - value: "false" - - name: CAMUNDA_CLIENT_ZEEBE_CACERTIFICATEPATH - value: /usr/local/certificates/tls.crt - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/certificates/tls.crt - subPath: tls.crt - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - ``` - - The actual configuration properties can be reviewed [in the Connectors configuration documentation](/self-managed/connectors-deployment/connectors-configuration.md#zeebe-broker-connection). - -1. Configure all other applications running inside the cluster and connecting to the Zeebe Gateway to also use TLS. - - - - -     -     - -## Pitfalls to avoid - -For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md). diff --git a/docusaurus.config.js b/docusaurus.config.js index a90cf5de490..1280a40afbf 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -101,15 +101,15 @@ module.exports = { }, ], [ - // Zeebe REST API docs generation + // Administration Self-Managed REST API docs generation "docusaurus-plugin-openapi-docs", { - id: "api-consolesm-openapi", + id: "api-adminsm-openapi", docsPluginId: "default", config: { - consolesm: { - specPath: "api/console-sm/console-sm-openapi.yaml", - outputDir: "docs/apis-tools/console-sm-api/specifications", + adminsm: { + specPath: "api/administration-sm/administration-sm-openapi.yaml", + outputDir: "docs/apis-tools/administration-sm-api/specifications", sidebarOptions: { groupPathsBy: "tag", }, diff --git a/optimize_sidebars.js b/optimize_sidebars.js index ab7552d80e3..a423fa57aa2 100644 --- a/optimize_sidebars.js +++ b/optimize_sidebars.js @@ -2075,12 +2075,1053 @@ function docsLink(label, href) { ), ], }, + { + "Clients & SDKs": [ + { + SDKs: [ + docsLink("Node.js", "apis-tools/node-js-sdk/"), + + { + "Spring Zeebe": [ + docsLink( + "Getting started", + "apis-tools/spring-zeebe-sdk/getting-started/" + ), + docsLink( + "Configuration", + "apis-tools/spring-zeebe-sdk/configuration/" + ), + ], + }, + ], + }, + { + Clients: [ + { + "Java client": [ + docsLink("Quick reference", "apis-tools/java-client/"), + docsLink("Job worker", "apis-tools/java-client/job-worker/"), + docsLink("Logging", "apis-tools/java-client/logging/"), + docsLink( + "Zeebe Process Test", + "apis-tools/java-client/zeebe-process-test/" + ), + + { + Examples: [ + docsLink("Overview", "apis-tools/java-client-examples/"), + docsLink( + "Deploy a process", + "apis-tools/java-client-examples/process-deploy/" + ), + docsLink( + "Create a process instance", + "apis-tools/java-client-examples/process-instance-create/" + ), + docsLink( + "Create non-blocking process instances", + "apis-tools/java-client-examples/process-instance-create-nonblocking/" + ), + docsLink( + "Create a process instance with results", + "apis-tools/java-client-examples/process-instance-create-with-result/" + ), + docsLink( + "Evaluate a decision", + "apis-tools/java-client-examples/decision-evaluate/" + ), + docsLink( + "Open a job worker", + "apis-tools/java-client-examples/job-worker-open/" + ), + docsLink( + "Handle variables as POJO", + "apis-tools/java-client-examples/data-pojo/" + ), + docsLink( + "Request cluster topology", + "apis-tools/java-client-examples/cluster-topology-request/" + ), + ], + }, + ], + }, + + { + "Community clients": [ + docsLink("Component clients", "apis-tools/community-clients/"), + + { + "Zeebe clients": [ + docsLink( + "JavaScript/Node.js", + "apis-tools/community-clients/javascript/" + ), + docsLink("Spring", "apis-tools/community-clients/spring/"), + { + "CLI client": [ + docsLink("Quick reference", "apis-tools/cli-client/"), + docsLink( + "Getting started with the CLI client", + "apis-tools/cli-client/cli-get-started/" + ), + ], + }, + + { + "Go client": [ + docsLink("Quick reference", "apis-tools/go-client/"), + docsLink( + "Getting started with the Go client", + "apis-tools/go-client/go-get-started/" + ), + docsLink( + "Job worker", + "apis-tools/go-client/job-worker/" + ), + ], + }, + ], + }, + docsLink( + "Build your own client", + "apis-tools/build-your-own-client/" + ), + ], + }, + ], + }, + ], + }, + + { + "Frontend development": [ + { + "Task applications": [ + docsLink( + "Introduction to task applications", + "apis-tools/frontend-development/task-applications/introduction-to-task-applications/" + ), + docsLink( + "User task life cycle", + "apis-tools/frontend-development/task-applications/user-task-lifecycle/" + ), + docsLink( + "Task application architecture", + "apis-tools/frontend-development/task-applications/task-application-architecture/" + ), + ], + }, + + { + Forms: [ + docsLink( + "Introduction to forms", + "apis-tools/frontend-development/forms/introduction-to-forms/" + ), + + { + "Embed forms": [ + docsLink( + "Concepts", + "apis-tools/frontend-development/forms/embed-forms/form-js-concepts/" + ), + docsLink( + "Embed forms in JavaScript", + "apis-tools/frontend-development/forms/embed-forms/embed-forms-in-javascript/" + ), + ], + }, + + { + "Customize & extend": [ + docsLink( + "Styling", + "apis-tools/frontend-development/forms/customize-and-extend/form-styling/" + ), + docsLink( + "Custom components", + "apis-tools/frontend-development/forms/customize-and-extend/custom-components/" + ), + docsLink( + "Integrate API data", + "apis-tools/frontend-development/forms/customize-and-extend/integrate-api-data/" + ), + ], + }, + ], + }, + ], + }, + ], + + "Self-Managed": [ + docsLink("Camunda 8 Self-Managed", "self-managed/about-self-managed/"), + + { + Setup: [ + docsLink("Overview", "self-managed/setup/overview/"), + docsLink("Install", "self-managed/setup/install/"), + docsLink("Upgrade", "self-managed/setup/upgrade/"), + + { + Deploy: [ + { + Local: [ + docsLink( + "Camunda 8 Run", + "self-managed/setup/deploy/local/c8run/" + ), + docsLink( + "Local Kubernetes cluster", + "self-managed/setup/deploy/local/local-kubernetes-cluster/" + ), + docsLink( + "Docker Compose", + "self-managed/setup/deploy/local/docker-compose/" + ), + docsLink("Manual", "self-managed/setup/deploy/local/manual/"), + ], + }, + + { + "Amazon (AWS)": [ + { + "Amazon EKS": [ + docsLink( + "Deploy an EKS cluster with eksctl", + "self-managed/setup/deploy/amazon/amazon-eks/eks-eksctl/" + ), + docsLink( + "Deploy an EKS cluster with Terraform", + "self-managed/setup/deploy/amazon/amazon-eks/eks-terraform/" + ), + docsLink( + "Install Camunda 8 on an EKS cluster", + "self-managed/setup/deploy/amazon/amazon-eks/eks-helm/" + ), + docsLink( + "Dual-region setup (EKS)", + "self-managed/setup/deploy/amazon/amazon-eks/dual-region/" + ), + docsLink( + "IAM roles for service accounts", + "self-managed/setup/deploy/amazon/amazon-eks/irsa/" + ), + ], + ROSA: [ + docsLink( + "Deploy a ROSA cluster with Terraform", + "self-managed/setup/deploy/amazon/openshift/terraform/" + ), + ], + }, + + docsLink( + "Install AWS Marketplace", + "self-managed/setup/deploy/amazon/aws-marketplace/" + ), + docsLink( + "Amazon EC2", + "self-managed/setup/deploy/amazon/aws-ec2/" + ), + ], + }, + + { + "Microsoft (Azure)": [ + docsLink( + "Microsoft AKS", + "self-managed/setup/deploy/azure/microsoft-aks/" + ), + ], + }, + + { + "Google (GCP)": [ + docsLink( + "Google GKE", + "self-managed/setup/deploy/gcp/google-gke/" + ), + ], + }, + + { + "Red Hat (OpenShift)": [ + docsLink( + "Red Hat OpenShift", + "self-managed/setup/deploy/openshift/redhat-openshift/" + ), + ], + }, + + { + Other: [ + docsLink("Docker", "self-managed/setup/deploy/other/docker/"), + docsLink("Manual", "self-managed/setup/deploy/local/manual/"), + ], + }, + ], + }, + + { + Guides: [ + docsLink( + "Accessing components without Ingress", + "self-managed/setup/guides/accessing-components-without-ingress/" + ), + docsLink( + "Ingress setup", + "self-managed/setup/guides/ingress-setup/" + ), + docsLink( + "Using existing Keycloak", + "self-managed/setup/guides/using-existing-keycloak/" + ), + docsLink( + "Using existing Elasticsearch", + "self-managed/setup/guides/using-existing-elasticsearch/" + ), + docsLink( + "Using Amazon OpenSearch Service", + "self-managed/setup/guides/using-existing-opensearch/" + ), + docsLink( + "Configure custom headers", + "self-managed/setup/guides/configure-db-custom-headers/" + ), + docsLink( + "Connect to an OpenID Connect provider", + "self-managed/setup/guides/connect-to-an-oidc-provider/" + ), + docsLink( + "Installing in an air-gapped environment", + "self-managed/setup/guides/air-gapped-installation/" + ), + docsLink( + "Running custom Connectors", + "self-managed/setup/guides/running-custom-connectors/" + ), + docsLink( + "Multi-namespace deployment", + "self-managed/setup/guides/multi-namespace-deployment/" + ), + docsLink( + "Verifying Camunda 8 installation with a demo app", + "self-managed/setup/guides/installing-payment-app-example/" + ), + ], + }, + ], + }, + { + "Reference Architecture": [ + docsLink("Overview", "self-managed/reference-architecture/"), + docsLink("Manual JAR", "self-managed/reference-architecture/manual/"), + ], + }, + { + "Operational guides": [ + { + "Update guide": [ + docsLink( + "Update 8.5 to 8.6", + "self-managed/operational-guides/update-guide/850-to-860/" + ), + docsLink( + "Update 8.4 to 8.5", + "self-managed/operational-guides/update-guide/840-to-850/" + ), + docsLink( + "Update 8.3 to 8.4", + "self-managed/operational-guides/update-guide/830-to-840/" + ), + docsLink( + "Update 8.2 to 8.3", + "self-managed/operational-guides/update-guide/820-to-830/" + ), + + { + Elasticsearch: [ + docsLink( + "Update 7 to 8", + "self-managed/operational-guides/update-guide/elasticsearch/7-to-8/" + ), + ], + }, + + { + Keycloak: [ + docsLink( + "Update Keycloak", + "self-managed/operational-guides/update-guide/keycloak/keycloak-update/" + ), + ], + }, + ], + }, + + docsLink( + "Configure multi-tenancy", + "self-managed/operational-guides/configure-multi-tenancy/" + ), + + { + "Backup and restore": [ + docsLink( + "Backup and restore Optimize data", + "self-managed/operational-guides/backup-restore/optimize-backup/" + ), + docsLink( + "Backup and restore Operate and Tasklist data", + "self-managed/operational-guides/backup-restore/operate-tasklist-backup/" + ), + docsLink( + "Backup and restore Zeebe data", + "self-managed/operational-guides/backup-restore/zeebe-backup-and-restore/" + ), + docsLink( + "Backup and restore Web Modeler data", + "self-managed/operational-guides/backup-restore/modeler-backup-and-restore/" + ), + ], + }, + + docsLink( + "Configure components", + "self-managed/operational-guides/application-configs/" + ), + docsLink( + "Configure flow control", + "self-managed/operational-guides/configure-flow-control/" + ), + + { + "Multi-region": [ + docsLink( + "Dual-region operational procedure", + "self-managed/operational-guides/multi-region/dual-region-operational-procedure/" + ), + ], + }, + + { + Troubleshooting: [ + docsLink( + "Troubleshooting", + "self-managed/operational-guides/troubleshooting/" + ), + docsLink( + "Log levels", + "self-managed/operational-guides/troubleshooting/log-levels/" + ), + ], + }, + ], + }, + + { + Concepts: [ + { + "Access control": [ + docsLink( + "Applications", + "self-managed/concepts/access-control/applications/" + ), + docsLink( + "Resource authorizations", + "self-managed/concepts/access-control/resource-authorizations/" + ), + docsLink( + "User task access restrictions", + "self-managed/concepts/access-control/user-task-access-restrictions/" + ), + ], + }, + + docsLink("Exporters", "self-managed/concepts/exporters/"), + + { + "Multi-region": [ + docsLink( + "Dual-region", + "self-managed/concepts/multi-region/dual-region/" + ), + ], + }, + + docsLink("Multi-tenancy", "self-managed/concepts/multi-tenancy/"), + docsLink("Mapping rules", "self-managed/concepts/mapping-rules/"), + docsLink( + "Elasticsearch privileges", + "self-managed/concepts/elasticsearch-privileges/" + ), + docsLink( + "OpenSearch privileges", + "self-managed/concepts/opensearch-privileges/" + ), + ], + }, + + { + Components: [ + { + Console: [ + docsLink("Overview", "self-managed/console-deployment/overview/"), + docsLink( + "Installation", + "self-managed/console-deployment/installation/" + ), + docsLink( + "Configuration", + "self-managed/console-deployment/configuration/" + ), + docsLink("Telemetry", "self-managed/console-deployment/telemetry/"), + ], + }, + + { + Zeebe: [ + docsLink( + "Overview", + "self-managed/zeebe-deployment/zeebe-installation/" + ), + + { + "Zeebe Gateway": [ + docsLink( + "Overview", + "self-managed/zeebe-deployment/zeebe-gateway/overview/" + ), + docsLink( + "Interceptors", + "self-managed/zeebe-deployment/zeebe-gateway/interceptors/" + ), + docsLink( + "Filters", + "self-managed/zeebe-deployment/zeebe-gateway/filters/" + ), + docsLink( + "Job streaming", + "self-managed/zeebe-deployment/zeebe-gateway/job-streaming/" + ), + ], + }, + + { + Configuration: [ + docsLink( + "Overview", + "self-managed/zeebe-deployment/configuration/" + ), + docsLink( + "Logging", + "self-managed/zeebe-deployment/configuration/logging/" + ), + docsLink( + "Gateway health probes", + "self-managed/zeebe-deployment/configuration/gateway-health-probes/" + ), + docsLink( + "Environment variables", + "self-managed/zeebe-deployment/configuration/environment-variables/" + ), + docsLink( + "Fixed partitioning", + "self-managed/zeebe-deployment/configuration/fixed-partitioning/" + ), + docsLink( + "Priority election", + "self-managed/zeebe-deployment/configuration/priority-election/" + ), + docsLink( + "Broker configuration", + "self-managed/zeebe-deployment/configuration/broker-config/" + ), + docsLink( + "Gateway configuration", + "self-managed/zeebe-deployment/configuration/gateway-config/" + ), + ], + }, + + { + Security: [ + docsLink("Overview", "self-managed/zeebe-deployment/security/"), + docsLink( + "Client authorization", + "self-managed/zeebe-deployment/security/client-authorization/" + ), + docsLink( + "Secure client communication", + "self-managed/zeebe-deployment/security/secure-client-communication/" + ), + docsLink( + "Secure cluster communication", + "self-managed/zeebe-deployment/security/secure-cluster-communication/" + ), + ], + }, + + { + Operation: [ + docsLink( + "Overview", + "self-managed/zeebe-deployment/operations/zeebe-in-production/" + ), + docsLink( + "Resource planning", + "self-managed/zeebe-deployment/operations/resource-planning/" + ), + docsLink( + "Network ports", + "self-managed/zeebe-deployment/operations/network-ports/" + ), + docsLink( + "Setting up a Zeebe cluster", + "self-managed/zeebe-deployment/operations/setting-up-a-cluster/" + ), + docsLink( + "Metrics", + "self-managed/zeebe-deployment/operations/metrics/" + ), + docsLink( + "Health status", + "self-managed/zeebe-deployment/operations/health/" + ), + docsLink( + "Backpressure", + "self-managed/zeebe-deployment/operations/backpressure/" + ), + docsLink( + "Disk space", + "self-managed/zeebe-deployment/operations/disk-space/" + ), + docsLink( + "Update Zeebe", + "self-managed/zeebe-deployment/operations/update-zeebe/" + ), + docsLink( + "Rebalancing", + "self-managed/zeebe-deployment/operations/rebalancing/" + ), + docsLink( + "Management API", + "self-managed/zeebe-deployment/operations/management-api/" + ), + docsLink( + "Backups", + "self-managed/zeebe-deployment/operations/backups/" + ), + docsLink( + "Cluster scaling", + "self-managed/zeebe-deployment/operations/cluster-scaling/" + ), + ], + }, + + { + Exporters: [ + docsLink( + "Install Zeebe exporters", + "self-managed/zeebe-deployment/exporters/install-zeebe-exporters/" + ), + docsLink( + "Elasticsearch", + "self-managed/zeebe-deployment/exporters/elasticsearch-exporter/" + ), + docsLink( + "OpenSearch", + "self-managed/zeebe-deployment/exporters/opensearch-exporter/" + ), + ], + }, + ], + }, + + { + Operate: [ + docsLink( + "Installation", + "self-managed/operate-deployment/install-and-start/" + ), + docsLink( + "Configuration", + "self-managed/operate-deployment/operate-configuration/" + ), + docsLink( + "Data retention", + "self-managed/operate-deployment/data-retention/" + ), + docsLink( + "Schema and migration", + "self-managed/operate-deployment/schema-and-migration/" + ), + docsLink( + "Importer and archiver", + "self-managed/operate-deployment/importer-and-archiver/" + ), + docsLink( + "Authentication and authorization", + "self-managed/operate-deployment/operate-authentication/" + ), + docsLink( + "Usage metrics", + "self-managed/operate-deployment/usage-metrics/" + ), + ], + }, + + { + Tasklist: [ + docsLink( + "Installation", + "self-managed/tasklist-deployment/install-and-start/" + ), + docsLink( + "Configuration", + "self-managed/tasklist-deployment/tasklist-configuration/" + ), + docsLink( + "Custom styling", + "self-managed/tasklist-deployment/tasklist-custom-styling/" + ), + docsLink( + "Data retention", + "self-managed/tasklist-deployment/data-retention/" + ), + docsLink( + "Importer and archiver", + "self-managed/tasklist-deployment/importer-and-archiver/" + ), + docsLink( + "Authentication", + "self-managed/tasklist-deployment/tasklist-authentication/" + ), + docsLink( + "Usage metrics", + "self-managed/tasklist-deployment/usage-metrics/" + ), + ], + }, + + { + Connectors: [ + docsLink( + "Installation", + "self-managed/connectors-deployment/install-and-start/" + ), + docsLink( + "Configuration", + "self-managed/connectors-deployment/connectors-configuration/" + ), + ], + }, + + { + Optimize: [ + "self-managed/optimize-deployment/install-and-start", + "self-managed/optimize-deployment/version-policy", + { + Configuration: [ + "self-managed/optimize-deployment/configuration/getting-started", + { + "System configuration": [ + "self-managed/optimize-deployment/configuration/system-configuration", + "self-managed/optimize-deployment/configuration/system-configuration-platform-8", + "self-managed/optimize-deployment/configuration/system-configuration-platform-7", + "self-managed/optimize-deployment/configuration/event-based-process-configuration", + ], + }, + "self-managed/optimize-deployment/configuration/logging", + "self-managed/optimize-deployment/configuration/optimize-license", + "self-managed/optimize-deployment/configuration/security-instructions", + "self-managed/optimize-deployment/configuration/shared-elasticsearch-cluster", + "self-managed/optimize-deployment/configuration/history-cleanup", + "self-managed/optimize-deployment/configuration/localization", + "self-managed/optimize-deployment/configuration/object-variables", + "self-managed/optimize-deployment/configuration/clustering", + "self-managed/optimize-deployment/configuration/webhooks", + "self-managed/optimize-deployment/configuration/authorization-management", + "self-managed/optimize-deployment/configuration/user-management", + "self-managed/optimize-deployment/configuration/multi-tenancy", + "self-managed/optimize-deployment/configuration/multiple-engines", + "self-managed/optimize-deployment/configuration/setup-event-based-processes", + "self-managed/optimize-deployment/configuration/common-problems", + ], + }, + + { + Plugins: [ + "self-managed/optimize-deployment/plugins/plugin-system", + "self-managed/optimize-deployment/plugins/businesskey-import-plugin", + "self-managed/optimize-deployment/plugins/decision-import-plugin", + "self-managed/optimize-deployment/plugins/elasticsearch-header", + "self-managed/optimize-deployment/plugins/engine-rest-filter-plugin", + "self-managed/optimize-deployment/plugins/single-sign-on", + "self-managed/optimize-deployment/plugins/variable-import-plugin", + ], + }, + "self-managed/optimize-deployment/reimport", + { + "Migration & update": [ + { + "Camunda 8": [ + "self-managed/optimize-deployment/migration-update/camunda-8/instructions", + "self-managed/optimize-deployment/migration-update/camunda-8/3.13_8.5-to-8.6", + "self-managed/optimize-deployment/migration-update/camunda-8/3.12_8.4-to-3.13_8.5", + "self-managed/optimize-deployment/migration-update/camunda-8/3.11_8.3-to-3.12_8.4", + "self-managed/optimize-deployment/migration-update/camunda-8/3.10-to-3.11_8.3", + "self-managed/optimize-deployment/migration-update/camunda-8/3.9-to-3.10", + "self-managed/optimize-deployment/migration-update/camunda-8/3.9-preview-1-to-3.9", + "self-managed/optimize-deployment/migration-update/camunda-8/3.8-to-3.9-preview-1", + "self-managed/optimize-deployment/migration-update/camunda-8/3.7-to-3.8", + ], + "Camunda 7": [ + "self-managed/optimize-deployment/migration-update/camunda-7/instructions", + "self-managed/optimize-deployment/migration-update/camunda-7/3.13-to-3.14", + "self-managed/optimize-deployment/migration-update/camunda-7/3.12-to-3.13", + "self-managed/optimize-deployment/migration-update/camunda-7/3.11-to-3.12", + "self-managed/optimize-deployment/migration-update/camunda-7/3.10-to-3.11", + "self-managed/optimize-deployment/migration-update/camunda-7/3.9-to-3.10", + "self-managed/optimize-deployment/migration-update/camunda-7/3.9-preview-1-to-3.9", + "self-managed/optimize-deployment/migration-update/camunda-7/3.8-to-3.9-preview-1", + "self-managed/optimize-deployment/migration-update/camunda-7/3.7-to-3.8", + "self-managed/optimize-deployment/migration-update/camunda-7/3.6-to-3.7", + "self-managed/optimize-deployment/migration-update/camunda-7/3.5-to-3.6", + "self-managed/optimize-deployment/migration-update/camunda-7/3.4-to-3.5", + "self-managed/optimize-deployment/migration-update/camunda-7/3.3-to-3.4", + "self-managed/optimize-deployment/migration-update/camunda-7/3.2-to-3.3", + "self-managed/optimize-deployment/migration-update/camunda-7/3.1-to-3.2", + "self-managed/optimize-deployment/migration-update/camunda-7/3.0-to-3.1", + "self-managed/optimize-deployment/migration-update/camunda-7/2.7-to-3.0", + "self-managed/optimize-deployment/migration-update/camunda-7/2.6-to-2.7", + "self-managed/optimize-deployment/migration-update/camunda-7/2.5-to-2.6", + "self-managed/optimize-deployment/migration-update/camunda-7/2.4-to-2.5", + "self-managed/optimize-deployment/migration-update/camunda-7/2.3-to-2.4", + "self-managed/optimize-deployment/migration-update/camunda-7/2.2-to-2.3", + "self-managed/optimize-deployment/migration-update/camunda-7/2.1-to-2.2", + ], + }, + ], + }, + + { + "Advanced features": [ + "self-managed/optimize-deployment/advanced-features/engine-data-deletion", + "self-managed/optimize-deployment/advanced-features/import-guide", + ], + }, + ], + }, + + { + Identity: [ + docsLink( + "What is Identity?", + "self-managed/identity/what-is-identity/" + ), + docsLink( + "Installation and first steps", + "self-managed/identity/getting-started/install-identity/" + ), + + { + "User guide": [ + { + Configuration: [ + docsLink( + "Making Identity production ready", + "self-managed/identity/user-guide/configuration/making-identity-production-ready/" + ), + docsLink( + "Configuring an external identity provider", + "self-managed/identity/user-guide/configuration/configure-external-identity-provider/" + ), + docsLink( + "Configure logging", + "self-managed/identity/user-guide/configuration/configure-logging/" + ), + docsLink( + "Connect to an existing Keycloak instance", + "self-managed/identity/user-guide/configuration/connect-to-an-existing-keycloak/" + ), + ], + }, + + { + Roles: [ + docsLink( + "Add and assign a role", + "self-managed/identity/user-guide/roles/add-assign-role/" + ), + docsLink( + "Add and assign a permission", + "self-managed/identity/user-guide/roles/add-assign-permission/" + ), + ], + }, + + { + Groups: [ + docsLink( + "Create a group", + "self-managed/identity/user-guide/groups/create-group/" + ), + docsLink( + "Assign users and roles to a group", + "self-managed/identity/user-guide/groups/assign-users-roles-to-group/" + ), + ], + }, + + { + Authorizations: [ + docsLink( + "Managing resource authorizations", + "self-managed/identity/user-guide/authorizations/managing-resource-authorizations/" + ), + docsLink( + "Managing user access", + "self-managed/identity/user-guide/authorizations/managing-user-access/" + ), + docsLink( + "Generating machine-to-machine (M2M) tokens", + "self-managed/identity/user-guide/authorizations/generating-m2m-tokens/" + ), + ], + }, + + { + Tenants: [ + docsLink( + "Managing tenants", + "self-managed/identity/user-guide/tenants/managing-tenants/" + ), + ], + }, + + { + "Mapping rules": [ + docsLink( + "Managing mapping rules", + "self-managed/identity/user-guide/mapping-rules/managing-mapping-rules/" + ), + ], + }, + + { + "Additional features": [ + docsLink( + "Adding an API", + "self-managed/identity/user-guide/additional-features/adding-an-api/" + ), + docsLink( + "Incorporate applications", + "self-managed/identity/user-guide/additional-features/incorporate-applications/" + ), + ], + }, + ], + }, + + { + Deployment: [ + docsLink( + "Configuration variables", + "self-managed/identity/deployment/configuration-variables/" + ), + docsLink( + "Application monitoring", + "self-managed/identity/deployment/application-monitoring/" + ), + docsLink( + "Starting configuration", + "self-managed/identity/deployment/starting-configuration-for-identity/" + ), + docsLink( + "Resource management", + "self-managed/identity/deployment/resource-management/" + ), + ], + }, + + docsLink( + "Troubleshoot Identity", + "self-managed/identity/troubleshooting/troubleshoot-identity/" + ), + ], + }, + + { + Modeler: [ + { + "Web Modeler": [ + docsLink( + "Installation", + "self-managed/modeler/web-modeler/installation/" + ), + + { + Configuration: [ + docsLink( + "Overview", + "self-managed/modeler/web-modeler/configuration/" + ), + docsLink( + "Database", + "self-managed/modeler/web-modeler/configuration/database/" + ), + docsLink( + "Identity", + "self-managed/modeler/web-modeler/configuration/identity/" + ), + docsLink( + "Logging", + "self-managed/modeler/web-modeler/configuration/logging/" + ), + docsLink( + "SSL", + "self-managed/modeler/web-modeler/configuration/ssl/" + ), + ], + }, + + { + Troubleshooting: [ + docsLink( + "Database connection", + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-database-connection/" + ), + docsLink( + "Zeebe connection", + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection/" + ), + docsLink( + "Missing data", + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-missing-data/" + ), + ], + }, + ], + }, + + { + "Desktop Modeler": [ + docsLink( + "Deploy diagram", + "self-managed/modeler/desktop-modeler/deploy-to-self-managed/" + ), + ], + }, + ], + }, ], }, ], }), { - "Clients & SDKs": [ + 7& SDKs": [ { SDKs: [ docsLink("Node.js", "apis-tools/node-js-sdk/"), diff --git a/package.json b/package.json index 0bc82be266a..1c85373daab 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "api:generate:operate": "npm run api:generate operate", "api:generate:tasklist": "npm run api:generate tasklist", "api:generate:zeebe": "npm run api:generate zeebe", - "api:generate:consolesm": "npm run api:generate consolesm", + "api:generate:adminsm": "npm run api:generate adminsm", "api:generate:camunda": "npm run api:generate camunda" }, "dependencies": { diff --git a/sidebars.js b/sidebars.js index 4add84d1d97..9b598667a66 100644 --- a/sidebars.js +++ b/sidebars.js @@ -965,7 +965,27 @@ module.exports = { "self-managed/setup/deploy/amazon/amazon-eks/irsa", ], }, - "self-managed/setup/deploy/amazon/aws-marketplace", + { + type: "category", + label: "ROSA", + link: { + type: "doc", + id: "self-managed/setup/deploy/amazon/openshift/terraform-setup", + }, + items: [ + "self-managed/setup/deploy/amazon/openshift/terraform-setup", + ], + }, + { + type: "category", + label: "Amazon MarketPlace", + link: { + type: "doc", + id: "self-managed/setup/deploy/amazon/aws-marketplace", + }, + items: [], + }, + "self-managed/setup/deploy/amazon/aws-ec2", ], "Microsoft (Azure)": [ "self-managed/setup/deploy/azure/microsoft-aks", @@ -1003,6 +1023,14 @@ module.exports = { ], }, ], + }, + { + "Reference architecture": [ + "self-managed/reference-architecture/reference-architecture", + "self-managed/reference-architecture/manual/manual", + ], + }, + { "Operational guides": [ { type: "category", diff --git a/static/.htaccess b/static/.htaccess index 99205f43616..20496bb89ff 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -98,6 +98,9 @@ RewriteRule ^docs/reference/bpmn-processes/?(.*)$ /docs/components/modeler/bpmn/ # Remove Tasklist GraphQL API RewriteRule ^docs/next/apis-tools/tasklist-api/(.*)$ /docs/next/apis-tools/camunda-api-rest/camunda-api-rest-overview/ [R=301,L] +# Finalize the renaming of Console SM API to Administration API (Self-Managed) +RewriteRule ^docs/next/apis-tools/administration-sm-api/specifications/sm-administration-api/?$ /docs/next/apis-tools/administration-sm-api/specifications/administration-api-self-managed/ [R=301,L] + # Remove Zeebe REST API RewriteRule ^docs/next/apis-tools/zeebe-api-rest/specifications/?$ /docs/next/apis-tools/camunda-api-rest/specifications/$1 [R=301,L] RewriteRule ^docs/next/apis-tools/zeebe-api-rest/zeebe-api-rest-overview/?$ /docs/next/apis-tools/camunda-api-rest/camunda-api-rest-overview/$1 [R=301,L] diff --git a/versioned_docs/version-8.4/components/modeler/bpmn/user-tasks/user-tasks.md b/versioned_docs/version-8.4/components/modeler/bpmn/user-tasks/user-tasks.md index b475a31143c..6141163fc38 100644 --- a/versioned_docs/version-8.4/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/versioned_docs/version-8.4/components/modeler/bpmn/user-tasks/user-tasks.md @@ -56,6 +56,11 @@ attributes can be specified simultaneously: - `candidateUsers`: Specifies the users that the task can be assigned to. - `candidateGroups`: Specifies the groups of users that the task can be assigned to. +:::info +The assignee attribute must adhere to the userId field’s case-sensitivity requirements. +Note that in SaaS, all user IDs are converted to lowercase by default, as they are based on email addresses. +::: + Typically, the assignee, candidate users, and candidate groups are defined as [static values](/docs/components/concepts/expressions.md#expressions-vs-static-values) (e.g. `some_username`, `some_username, another_username` and `sales, operations`), but they can also be defined as [expressions](/components/concepts/expressions.md) (e.g. `= book.author` and `= remove(reviewers, book.author)` and `= reviewer_roles`). The expressions are evaluated on activating the user task and must result in a diff --git a/versioned_docs/version-8.5/apis-tools/node-js-sdk.md b/versioned_docs/version-8.5/apis-tools/node-js-sdk.md index 3186f048f21..ffe800bbc5f 100644 --- a/versioned_docs/version-8.5/apis-tools/node-js-sdk.md +++ b/versioned_docs/version-8.5/apis-tools/node-js-sdk.md @@ -1,7 +1,7 @@ --- id: node-js-sdk title: Node.js -description: Get started with the official Camunda 8 JavaScript SDK for Node.js, available via npm. +description: Get started with the official Camunda 8 JavaScript SDK for Node.js. --- As of 8.5.0, the official [Camunda 8 JavaScript SDK for Node.js](https://github.com/camunda/camunda-8-js-sdk) is available via [npm](https://www.npmjs.com/package/@camunda8/sdk). diff --git a/versioned_docs/version-8.5/apis-tools/working-with-apis-tools.md b/versioned_docs/version-8.5/apis-tools/working-with-apis-tools.md index 9ee4f2daecb..57e5bbf0d50 100644 --- a/versioned_docs/version-8.5/apis-tools/working-with-apis-tools.md +++ b/versioned_docs/version-8.5/apis-tools/working-with-apis-tools.md @@ -84,6 +84,9 @@ Additionally, visit our documentation on [Operate](../self-managed/operate-deplo ### SDKs ### Postman diff --git a/versioned_docs/version-8.5/components/modeler/bpmn/user-tasks/user-tasks.md b/versioned_docs/version-8.5/components/modeler/bpmn/user-tasks/user-tasks.md index 7f7d2d48815..b00e97e7c75 100644 --- a/versioned_docs/version-8.5/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/versioned_docs/version-8.5/components/modeler/bpmn/user-tasks/user-tasks.md @@ -35,6 +35,11 @@ attributes can be specified simultaneously: - `candidateUsers`: Specifies the users that the task can be assigned to. - `candidateGroups`: Specifies the groups of users that the task can be assigned to. +:::info +The assignee attribute must adhere to the userId field’s case-sensitivity requirements. +Note that in SaaS, all user IDs are converted to lowercase by default, as they are based on email addresses. +::: + :::info Assignment resources can also be used for set user task restrictions ([SaaS](/components/concepts/access-control/user-task-access-restrictions.md)/[Self-Managed](docs/self-managed/concepts/access-control/user-task-access-restrictions.md)), where users will see only the tasks they have authorization to work on. ::: diff --git a/versioned_docs/version-8.5/components/modeler/desktop-modeler/use-connectors.md b/versioned_docs/version-8.5/components/modeler/desktop-modeler/use-connectors.md index 921b5c0f693..6a0f28ee837 100644 --- a/versioned_docs/version-8.5/components/modeler/desktop-modeler/use-connectors.md +++ b/versioned_docs/version-8.5/components/modeler/desktop-modeler/use-connectors.md @@ -12,7 +12,7 @@ Desktop Modeler automatically fetches and updates [element templates](./element- ## Automatic Connector template fetching -Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. +Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. The fetch is triggered whenever you start the application, or every 24 hours if the application is not closed. After an update check has concluded, a notification indicates if the templates are up to date or have been updated: diff --git a/versioned_docs/version-8.6/apis-tools/node-js-sdk.md b/versioned_docs/version-8.6/apis-tools/node-js-sdk.md index 583c837affb..b11e5f327d7 100644 --- a/versioned_docs/version-8.6/apis-tools/node-js-sdk.md +++ b/versioned_docs/version-8.6/apis-tools/node-js-sdk.md @@ -1,7 +1,7 @@ --- id: node-js-sdk title: Node.js -description: Get started with the official Camunda 8 JavaScript SDK for Node.js, available via npm. +description: Get started with the official Camunda 8 JavaScript SDK for Node.js. --- As of 8.5.0, the official [Camunda 8 JavaScript SDK for Node.js](https://github.com/camunda/camunda-8-js-sdk) is available via [npm](https://www.npmjs.com/package/@camunda8/sdk). diff --git a/versioned_docs/version-8.6/apis-tools/spring-zeebe-sdk/configuration.md b/versioned_docs/version-8.6/apis-tools/spring-zeebe-sdk/configuration.md index 6cff515bf51..5c644b42928 100644 --- a/versioned_docs/version-8.6/apis-tools/spring-zeebe-sdk/configuration.md +++ b/versioned_docs/version-8.6/apis-tools/spring-zeebe-sdk/configuration.md @@ -275,7 +275,7 @@ A custom maxMessageSize allows the client to receive larger or smaller responses camunda: client: zeebe: - max-message-size: 3 + max-message-size: 4194304 ``` ### Request timeout diff --git a/versioned_docs/version-8.6/apis-tools/working-with-apis-tools.md b/versioned_docs/version-8.6/apis-tools/working-with-apis-tools.md index 766d9a434e5..37a4f546afe 100644 --- a/versioned_docs/version-8.6/apis-tools/working-with-apis-tools.md +++ b/versioned_docs/version-8.6/apis-tools/working-with-apis-tools.md @@ -72,6 +72,9 @@ Additionally, visit our documentation on [Operate](../self-managed/operate-deplo ### SDKs ### Postman diff --git a/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md b/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md index 90a64a6191c..b1a4919be5d 100644 --- a/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md +++ b/versioned_docs/version-8.6/components/modeler/bpmn/user-tasks/user-tasks.md @@ -36,6 +36,11 @@ attributes can be specified simultaneously: - `candidateUsers`: Specifies the users that the task can be assigned to. - `candidateGroups`: Specifies the groups of users that the task can be assigned to. +:::info +The assignee attribute must adhere to the userId field’s case-sensitivity requirements. +Note that in SaaS, all user IDs are converted to lowercase by default, as they are based on email addresses. +::: + :::info Assignment resources can also be used for set user task restrictions ([SaaS](/components/concepts/access-control/user-task-access-restrictions.md)/[Self-Managed](docs/self-managed/concepts/access-control/user-task-access-restrictions.md)), where users will see only the tasks they have authorization to work on. ::: diff --git a/versioned_docs/version-8.6/components/modeler/desktop-modeler/use-connectors.md b/versioned_docs/version-8.6/components/modeler/desktop-modeler/use-connectors.md index 921b5c0f693..6a0f28ee837 100644 --- a/versioned_docs/version-8.6/components/modeler/desktop-modeler/use-connectors.md +++ b/versioned_docs/version-8.6/components/modeler/desktop-modeler/use-connectors.md @@ -12,7 +12,7 @@ Desktop Modeler automatically fetches and updates [element templates](./element- ## Automatic Connector template fetching -Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. +Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. The fetch is triggered whenever you start the application, or every 24 hours if the application is not closed. After an update check has concluded, a notification indicates if the templates are up to date or have been updated: diff --git a/versioned_docs/version-8.6/self-managed/console-deployment/configuration.md b/versioned_docs/version-8.6/self-managed/console-deployment/configuration.md index 8bfa775bf15..9da243ab378 100644 --- a/versioned_docs/version-8.6/self-managed/console-deployment/configuration.md +++ b/versioned_docs/version-8.6/self-managed/console-deployment/configuration.md @@ -33,6 +33,20 @@ Console environment variables could be set in Helm via the `console.env` key. Fo Camunda 8 components without a valid license may display **Non-Production License** in the navigation bar and issue warnings in the logs. These warnings have no impact on Console startup or functionality. To obtain a license, visit the [Camunda Enterprise page](https://camunda.com/platform/camunda-platform-enterprise-contact/). ::: +### Proxy + +These settings are useful when the application needs to make outgoing network requests in environments that require traffic to pass through a proxy server. + +| Environment variable | Description | Example value | Default value | +| -------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | ------------- | +| `http_proxy` | Specifies the proxy server to be used for outgoing HTTP requests. | `http://proxy.example.com:8080` | - | +| `https_proxy` | Specifies the proxy server to be used for outgoing HTTPS requests. | `https://secureproxy.example.com:443` | - | +| `no_proxy` | A comma-separated list of domain names or IP addresses for which the proxy should be bypassed. | `localhost,127.0.0.1,.example.com` | - | + +:::note +The proxy-related environment variables are lowercase because they follow a widely accepted convention used in many system environments and tools. +::: + ## Telemetry You can enable telemetry and usage collection to help us improve our product by sending several telemetry metrics to Camunda. The information we collect will contribute to continuous product enhancement and help us understand how Camunda is used. We do not collect sensitive information and limit data points to several metrics. For more information, you can download collected data set metrics from the telemetry page at anytime. diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md index 1a46c925e7b..328387b3915 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md @@ -4,6 +4,8 @@ title: "Install Camunda 8 on an EKS cluster" description: "Set up the Camunda 8 environment with Helm and an optional Ingress setup on Amazon EKS." --- + + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -427,7 +429,6 @@ https://github.com/camunda/camunda-tf-eks-module/blob/main/examples/camunda-8.6/ Use these environment variables in the `kubectl` command to create the secret. -- The values for `postgres-password` and `password` are not required if you are using an external database. If you choose not to use an external database, you must provide those values. - The `smtp-password` should be replaced with the appropriate external value ([see how it's used by Web Modeler](/self-managed/modeler/web-modeler/configuration/configuration.md#smtp--email)). ```bash reference diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md index 40fe91e4dc8..73c9e6c48ce 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md @@ -4,6 +4,8 @@ title: "Deploy an EKS cluster with Terraform (advanced)" description: "Deploy an Amazon Kubernetes Cluster (EKS) with a Terraform module for a quick Camunda 8 setup." --- + + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -96,25 +98,25 @@ Advanced users may want to handle this part differently and use a different back #### Set up AWS authentication The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) is required to create resources in AWS. Before you can use the provider, you must authenticate it using your AWS credentials. -You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods. -We recommend using the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials. +:::caution Ownership of the created resources -To configure the AWS CLI: +A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user. -```bash -aws configure -``` +::: -Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). +You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods: -:::caution Ownership of the created resources +- For development or testing purposes you can use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials. + To configure the AWS CLI: -A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user. + ```bash + aws configure + ``` -[Create access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` variables to use with the AWS CLI and `eksctl` + Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). -::: +- For production environments, we recommend the use of a dedicated IAM user and [create access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. #### Create an S3 bucket for Terraform state management diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.jpg b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.jpg new file mode 100644 index 00000000000..862eacd4fe0 Binary files /dev/null and b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.jpg differ diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.pdf b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.pdf new file mode 100644 index 00000000000..5506e354c8c Binary files /dev/null and b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/assets/rosa-single-region.pdf differ diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/terraform-setup.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/terraform-setup.md new file mode 100644 index 00000000000..eca6ea8c5eb --- /dev/null +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/openshift/terraform-setup.md @@ -0,0 +1,384 @@ +--- +id: terraform-setup +title: "Deploy a ROSA HCP Cluster with Terraform" +description: "Deploy Red Hat OpenShift on AWS using a Terraform module for a quick Camunda 8 setup." +--- + + + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +This guide provides a detailed tutorial for deploying a [Red Hat OpenShift on AWS (ROSA) cluster with Hosted Control Plane (HCP)](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/architecture/index#architecture-overview) capabilities. It is specifically tailored for deploying Camunda 8 using Terraform, a widely-used Infrastructure as Code (IaC) tool. + +We recommend this guide for building a robust and sustainable infrastructure. However, if you are looking for a quicker trial or proof of concept, or if your needs aren't fully met by our module, consider following the official [ROSA Quickstart Guide](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/getting_started/rosa-quickstart-guide-ui#rosa-quickstart-guide-ui). + +This guide aims to help you leverage IaC to streamline and reproduce your cloud infrastructure setup. While it covers the essentials for deploying an ROSA HCP cluster, for more advanced use cases, please refer to the official [Red Hat OpenShift on AWS Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4). + +:::tip + +If you are completely new to Terraform and the idea of IaC, read through the [Terraform IaC documentation](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code) and give their [interactive quick start](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code#quick-start) a try for a basic understanding. + +::: + +## Requirements + +- A [Red Hat Account](https://www.redhat.com/) to create the Red Hat OpenShift cluster. +- An [AWS account](https://docs.aws.amazon.com/accounts/latest/reference/accounts-welcome.html) to create any resources within AWS. +- [AWS CLI (2.17+)](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html), a CLI tool for creating AWS resources. +- [Terraform (1.9+)](https://developer.hashicorp.com/terraform/downloads) +- [kubectl (1.30+)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the cluster. +- [ROSA CLI](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/getting_started/rosa-quickstart-guide-ui#rosa-getting-started-environment-setup_rosa-quickstart-guide-ui) to interact with the cluster. +- [jq (1.7+)](https://jqlang.github.io/jq/download/) to interact with some Terraform variables. +- This guide uses GNU/Bash for all the shell commands listed. + +### Considerations + +This setup provides a foundational starting point for working with Camunda 8, though it is not optimized for peak performance. It serves as a solid initial step in preparing a production environment by leveraging [Infrastructure as Code (IaC) tools](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code). + +Terraform can seem complex at first. If you're interested in understanding what each component does, consider trying out the [Red Hat OpenShift on AWS UI-based tutorial](https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/tutorials/getting-started-with-rosa#creating-account-wide-roles). This guide will show you what resources are created and how they interact with each other. + +If you require managed services for PostgreSQL Aurora or OpenSearch, you can refer to the definitions provided in the [EKS setup with Terraform](../amazon-eks/terraform-setup.md) guide. However, please note that these configurations may need adjustments to fit your specific requirements and have not been tested. By default, this guide assumes that the database services (PostgreSQL and Elasticsearch) integrated into the default chart will be used. + +For testing Camunda 8 or developing against it, you might consider signing up for our [SaaS offering](https://camunda.com/platform/). If you already have a Red Hat OpenShift cluster on AWS, you can skip ahead to the [Helm setup guide](/self-managed/setup/deploy/openshift/redhat-openshift.md). + +To keep this guide concise, we provide links to additional documentation covering best practices, allowing you to explore each topic in greater depth. + +:::warning Cost management + +Following this guide will incur costs on your cloud provider account and your Red Hat account, specifically for the managed OpenShift service, OpenShift worker nodes running in EC2, the hosted control plane, Elastic Block Storage (EBS), and Route 53. For more details, refer to [ROSA AWS pricing](https://aws.amazon.com/rosa/pricing/) and the [AWS Pricing Calculator](https://calculator.aws/#/) as total costs vary by region. + +::: + +### Variants + +Unlike the [EKS Terraform setup](../amazon-eks/terraform-setup.md), we currently support only one main variant of this setup: + +- The **standard installation** uses a username and password connection for Camunda components (or relies solely on network isolation for certain components). This option is straightforward and easier to implement, making it ideal for environments where simplicity and rapid deployment are priorities, or where network isolation provides adequate security. + +- The second variant, **IRSA** (IAM Roles for Service Accounts), may work but has not been tested. If you’re interested in setting it up, please refer to the EKS guide as a foundational resource. + +### Outcome + + + + +_Infrastructure diagram for a single region ROSA setup (click on the image to open the PDF version)_ +[![Infrastructure Diagram ROSA Single-Region](./assets/rosa-single-region.jpg)](./assets/rosa-single-region.pdf) + +Following this tutorial and steps will result in: + +- A [Red Hat OpenShift with Hosted Control Plane](https://www.redhat.com/en/topics/containers/what-are-hosted-control-planes#rosa-with-hcp) cluster running the latest ROSA version with six nodes ready for Camunda 8 installation. +- The [EBS CSI driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html) is installed and configured, which is used by the Camunda 8 Helm chart to create [persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/). + +## 1. Configure AWS and initialize Terraform + +### Terraform prerequisites + +To manage the infrastructure for Camunda 8 on AWS using Terraform, we need to set up Terraform's backend to store the state file remotely in an S3 bucket. This ensures secure and persistent storage of the state file. + +:::note +Advanced users may want to handle this part differently and use a different backend. The backend setup provided is an example for new users. +::: + +#### Set up AWS authentication + +The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) is required to create resources in AWS. Before you can use the provider, you must authenticate it using your AWS credentials. + +:::caution Ownership of the created resources + +A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user. + +::: + +You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods: + +- For development or testing purposes you can use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials. + To configure the AWS CLI: + + ```bash + aws configure + ``` + + Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). + +- For production environments, we recommend the use of a dedicated IAM user. Create [access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console, and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. + +#### Create an S3 bucket for Terraform state management + +Before setting up Terraform, you need to create an S3 bucket that will store the state file. This is important for collaboration and to prevent issues like state file corruption. + +To start, set the region as an environment variable upfront to avoid repeating it in each command: + +```bash +export AWS_REGION= +``` + +Replace `` with your chosen AWS region (for example, `eu-central-1`). + +Now, follow these steps to create the S3 bucket with versioning enabled: + +1. Open your terminal and ensure the AWS CLI is installed and configured. + +1. Run the following command to create an S3 bucket for storing your Terraform state. Make sure to use a unique bucket name and set the `AWS_REGION` environment variable beforehand: + + ```bash + # Replace "my-rosa-tf-state" with your unique bucket name + export S3_TF_BUCKET_NAME="my-rosa-tf-state" + + aws s3api create-bucket --bucket "$S3_TF_BUCKET_NAME" --region "$AWS_REGION" \ + --create-bucket-configuration LocationConstraint="$AWS_REGION" + ``` + +1. Enable versioning on the S3 bucket to track changes and protect the state file from accidental deletions or overwrites: + + ```bash + aws s3api put-bucket-versioning --bucket "$S3_TF_BUCKET_NAME" --versioning-configuration Status=Enabled --region "$AWS_REGION" + ``` + +1. Secure the bucket by blocking public access: + + ```bash + aws s3api put-public-access-block --bucket "$S3_TF_BUCKET_NAME" --public-access-block-configuration \ + "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true" --region "$AWS_REGION" + ``` + +1. Verify versioning is enabled on the bucket: + + ```bash + aws s3api get-bucket-versioning --bucket "$S3_TF_BUCKET_NAME" --region "$AWS_REGION" + ``` + +This S3 bucket will now securely store your Terraform state files with versioning enabled. + +#### Create a `config.tf` with the following setup + +Once the S3 bucket is created, configure your `config.tf` file to use the S3 backend for managing the Terraform state: + +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/config.tf +``` + +#### Initialize Terraform + +Once your `config.tf` and authentication are set up, you can initialize your Terraform project. The previous steps configured a dedicated S3 Bucket (`S3_TF_BUCKET_NAME`) to store your state, and the following creates a bucket key that will be used by your configuration. + +Configure the backend and download the necessary provider plugins: + +```bash +export S3_TF_BUCKET_KEY="camunda-terraform/terraform.tfstate" + +echo "Storing terraform state in s3://$S3_TF_BUCKET_NAME/$S3_TF_BUCKET_KEY" + +terraform init -backend-config="bucket=$S3_TF_BUCKET_NAME" -backend-config="key=$S3_TF_BUCKET_KEY" +``` + +Terraform will connect to the S3 bucket to manage the state file, ensuring remote and persistent storage. + +### OpenShift cluster module setup + +This module sets up the foundational configuration for ROSA HCP and Terraform usage. + +We will leverage [Terraform modules](https://developer.hashicorp.com/terraform/language/modules), which allow us to abstract resources into reusable components, simplifying infrastructure management. + +The [Camunda-provided module](https://github.com/camunda/camunda-tf-rosa) is publicly available and serves as a robust starting point for deploying a Red Hat OpenShift cluster on AWS using a Hosted Control Plane. It is highly recommended to review this module before implementation to understand its structure and capabilities. + +Please note that this module is based on the official [ROSA HCP Terraform module documentation](https://docs.openshift.com/rosa/rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.html). It is presented as an example for running Camunda 8 in ROSA. For advanced use cases or custom setups, we encourage you to use the official module, which includes vendor-supported features. + +#### Set up ROSA authentication + +To set up a ROSA cluster, certain prerequisites must be configured on your AWS account. Below is an excerpt from the [official ROSA planning prerequisites checklist](https://docs.openshift.com/rosa/rosa_planning/rosa-cloud-expert-prereq-checklist.html): + +1. Verify that your AWS account is correctly configured: + + ```bash + aws sts get-caller-identity + ``` + +1. Check if the ELB service role exists, as if you have never created a load balancer in your AWS account, the role for Elastic Load Balancing (ELB) might not exist yet: + + ```bash + aws iam get-role --role-name "AWSServiceRoleForElasticLoadBalancing" + ``` + + If it doesn't exist, create it: + + ```bash + aws iam create-service-linked-role --aws-service-name "elasticloadbalancing.amazonaws.com" + ``` + +1. Create a Red Hat Hybrid Cloud Console account if you don’t already have one: [Red Hat Hybrid Cloud Console](https://console.redhat.com/). + +1. Enable ROSA on your AWS account via the [AWS Console](https://console.aws.amazon.com/rosa/). + +1. Enable HCP ROSA on [AWS Marketplace](https://docs.openshift.com/rosa/cloud_experts_tutorials/cloud-experts-rosa-hcp-activation-and-account-linking-tutorial.html): + + - Navigate to the ROSA console: [AWS ROSA Console](https://console.aws.amazon.com/rosa). + - Choose **Get started**. + - On the **Verify ROSA prerequisites** page, select **I agree to share my contact information with Red Hat**. + - Choose **Enable ROSA**. + + **Note**: Only a single AWS account can be associated with a Red Hat account for service billing. + +1. Install the ROSA CLI from the [OpenShift AWS Console](https://console.redhat.com/openshift/downloads#tool-rosa). + +1. Get an API token, go to the [OpenShift Cluster Management API Token](https://console.redhat.com/openshift/token/rosa), click **Load token**, and save it. Use the token to log in with ROSA CLI: + + ```bash + export RHCS_TOKEN="" + rosa login --token="$RHCS_TOKEN" + + # Verify the login + rosa whoami + ``` + +1. Verify your AWS quotas: + + ```bash + rosa verify quota --region="$AWS_REGION" + ``` + + **Note**: This may fail due to organizational policies. + +1. Create the required account roles: + + ```bash + rosa create account-roles --mode auto + ``` + +1. Verify your AWS quotas, and if quotas are insufficient, consult the following: + + - [Provisioned AWS Infrastructure](https://docs.openshift.com/rosa/rosa_planning/rosa-sts-aws-prereqs.html#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs) + - [Required AWS Service Quotas](https://docs.openshift.com/rosa/rosa_planning/rosa-sts-required-aws-service-quotas.html#rosa-sts-required-aws-service-quotas) + +1. Ensure the `oc` CLI is installed. If it’s not already installed, follow the [official ROSA oc installation guide](https://docs.openshift.com/rosa/cli_reference/openshift_cli/getting-started-cli.html#cli-getting-started): + + ```bash + rosa verify openshift-client + ``` + +#### Set up the ROSA cluster module + +1. Create a `cluster.tf` file in the same directory as your `config.tf` file. +2. Add the following content to your newly created `cluster.tf` file to utilize the provided module: + + :::note Configure your cluster + + Please customize the cluster name, availability zones, with the values you previously retrieved from the Red Hat Console. + Additionally, provide a secure username and password for the cluster administrator. + + Ensure that you have set the environment `RHCS_TOKEN` is set with your [OpenShift Cluster Management API Token](https://console.redhat.com/openshift/token/rosa). + + By default, this cluster will be accessible from the internet. If you prefer to restrict access, please refer to the official documentation of the module. + + ::: + + ```hcl reference + https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/cluster.tf + ``` + + :::caution Camunda Terraform module + + This ROSA module is based on the [official Red Hat Terraform module for ROSA HCP](https://registry.terraform.io/modules/terraform-redhat/rosa-hcp/rhcs/latest). Please be aware of potential differences and choices in implementation between this module and the official one. + + We invite you to consult the [Camunda ROSA module documentation](https://github.com/camunda/camunda-tf-rosa/blob/v2.0.0/modules/rosa-hcp/README.md) for more information. + + ::: + +3. [Initialize](#initialize-terraform) Terraform for this module using the following Terraform command: + + ```bash + terraform init -backend-config="bucket=$S3_TF_BUCKET_NAME" -backend-config="key=$S3_TF_BUCKET_KEY" + ``` + +4. Configure user access to the cluster. By default, the user who creates the OpenShift cluster has administrative access, if you want to grant access to other users, please follow the [Red Hat documentation for granting admin rights to users](https://docs.openshift.com/rosa/cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-admin-rights.html) when the cluster is created. + +5. Customize the cluster setup. The module offers various input options that allow you to further customize the cluster configuration. For a comprehensive list of available options and detailed usage instructions, refer to the [ROSA module documentation](https://github.com/camunda/camunda-tf-rosa/blob/v2.0.0/modules/rosa-hcp/README.md). + +### Define outputs + +**Terraform** allows you to define outputs, which make it easier to retrieve important values generated during execution, such as cluster endpoints and other necessary configurations for Helm setup. + +Each module that you have previously set up contains an output definition at the end of the file. You can adjust them to your needs. + +### Execution + +:::note Secret management + +We strongly recommend managing sensitive information such as the OpenSearch, Aurora username and password using a secure secrets management solution like HashiCorp Vault. For details on how to inject secrets directly into Terraform via Vault, see the [Terraform Vault Secrets Injection Guide](https://developer.hashicorp.com/terraform/tutorials/secrets/secrets-vault). + +::: + +1. Open a terminal in the created Terraform folder where `config.tf` and other `.tf` files are. + +2. Plan the configuration files: + + ```bash + terraform plan -out cluster.plan # describe what will be created + ``` + +3. After reviewing the plan, you can confirm and apply the changes. + + ```bash + terraform apply cluster.plan # apply the creation + ``` + +Terraform will now create the OpenShift cluster with all the necessary configurations. The completion of this process may require approximately 20-30 minutes for each component. + +### Reference files + +Depending on the installation path you have chosen, you can find the reference files used on this page: + +- **Standard installation:** [Reference Files](https://github.com/camunda/camunda-deployment-references/tree/feature/openshift-ra-standard/aws/rosa-hcp/camunda-versions/8.6) + +## 2. Preparation for Camunda 8 installation + +### Access the created OpenShift cluster + +You can access the created OpenShift cluster using the following steps: + +Set up the required environment variables: + +```shell +export CLUSTER_NAME="$(terraform console << + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; Red Hat OpenShift, a Kubernetes distribution maintained by [Red Hat](https://www.redhat.com/en/technologies/cloud-computing/openshift), provides options for both managed and on-premises hosting. -:::note -Deploying Camunda 8 on Red Hat OpenShift is achievable using Helm, given the appropriate configurations. However, it's important to note that the [Security Context Constraints (SCCs)](#security-context-constraints-sccs) and [Routes](./redhat-openshift.md?current-ingress=openshift-routes#using-openshift-routes) configurations might require slight deviations from the guidelines provided in the [general Helm deployment guide](/self-managed/setup/install.md). -::: +Deploying Camunda 8 on Red Hat OpenShift is supported using Helm, given the appropriate configurations. + +However, it's important to note that the [Security Context Constraints (SCCs)](#security-context-constraints-sccs) and [Routes](./redhat-openshift.md?current-ingress=openshift-routes#using-openshift-routes) configurations might require slight deviations from the guidelines provided in the [general Helm deployment guide](/self-managed/setup/install.md). ## Cluster Specification When deploying Camunda 8 on an OpenShift cluster, the cluster specification should align with your specific requirements and workload characteristics. Here's a suggested configuration to begin with: -- **Instance type:** 4 vCPUs (x86_64, >3.1 GHz), 16 GiB Memory (for example, [m5.xlarge on AWS](https://aws.amazon.com/en/ebs/general-purpose/)) +- **Instance type:** 4 vCPUs (x86_64, >3.1 GHz), 16 GiB Memory (for example, [mi7.xlarge on AWS](https://aws.amazon.com/en/ebs/general-purpose/)) - **Number of dedicated nodes:** 4 - **Volume type:** SSD volumes (with between 1000 and 3000 IOPS per volume, and a throughput of 1,000 MB/s per volume, for instance, [gp3 on AWS](https://aws.amazon.com/en/ebs/general-purpose/)) +If you need to set up an OpenShift cluster on a cloud provider, we recommend our [guide to deploying a ROSA cluster](/self-managed/setup/deploy/amazon/openshift/terraform-setup.md). + ### Supported Versions We conduct testing and ensure compatibility against the following OpenShift versions: | OpenShift Version | [End of Support Date](https://access.redhat.com/support/policy/updates/openshift) | | ----------------- | --------------------------------------------------------------------------------- | +| 4.17.x | June 27, 2025 | | 4.16.x | December 27, 2025 | | 4.15.x | August 27, 2025 | | 4.14.x | May 1, 2025 | -| 4.13.x | November 17, 2024 | -:::caution +:::caution Version compatibility + Camunda 8 supports OpenShift versions in the Red Hat General Availability, Full Support, and Maintenance Support life cycle phases. For more information, refer to the [Red Hat OpenShift Container Platform Life Cycle Policy](https://access.redhat.com/support/policy/updates/openshift). + ::: -## Deploying Camunda 8 in OpenShift +## Requirements -Depending on your OpenShift cluster's Security Context Constraints (SCCs) configuration, the deployment process may vary. +- [Helm (3.16+)](https://helm.sh/docs/intro/install/) +- [kubectl (1.30+)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the cluster. +- [jq (1.7+)](https://jqlang.github.io/jq/download/) to interact with some variables. +- [GNU envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) to generate manifests. +- [oc (version supported by your OpenShift)](https://docs.openshift.com/container-platform/4.17/cli_reference/openshift_cli/getting-started-cli.html) to interact with OpenShift. +- A namespace to host the Camunda Platform, in this guide we will reference `camunda` as the target namespace. - - +## Deploy Camunda 8 via Helm charts + +### Configure your deployment + +Start by creating a `values.yml` file to store the configuration for your environment. +This file will contain key-value pairs that will be substituted using `envsubst`. +Over this guide, you will add and merge values in this file to configure your deployment to fit your needs. + +You can find a reference example of this file here: + +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/base.yml +``` + +:::warning Merging YAML files + +This guide references multiple configuration files that need to be merged into a single YAML file. Be cautious to avoid duplicate keys when merging the files. Additionally, pay close attention when copying and pasting YAML content. Ensure that the separator notation `---` does not inadvertently split the configuration into multiple documents. + +We strongly recommend double-checking your YAML file before applying it. You can use tools like [yamllint.com](https://www.yamllint.com/) or the [YAML Lint CLI](https://github.com/adrienverge/yamllint) if you prefer not to share your information online. + +::: + +#### Configuring the Ingress + +Before exposing services outside the cluster, we need an Ingress component. Here's how you can configure it: + + + + + +[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) expose services externally by linking a URL to a service within the cluster. OpenShift supports both the [standard Kubernetes Ingress and routes](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html), giving cluster users the flexibility to choose. + +The presence of routes is rooted in their specification predating Ingress. The functionality of routes differs from Ingress; for example, unlike Ingress, routes don't allow multiple services to be linked to a single route or the use of paths. + +To use these routes for the Zeebe Gateway, configure this through Ingress as well. + +#### Setting Up the application domain for Camunda 8 + +The route created by OpenShift will use a domain to provide access to the platform. By default, you can use the OpenShift applications domain, but any other domain supported by the router can also be used. + +To retrieve the OpenShift applications domain (used as an example here), run the following command: -### With restrictive SCCs +```bash +export OPENSHIFT_APPS_DOMAIN=$(oc get ingresses.config.openshift.io cluster -o jsonpath='{.spec.domain}') +``` + +Next, define the route domain that will be used for the Camunda 8 deployment. For example: + +```bash +export DOMAIN_NAME="camunda.$OPENSHIFT_APPS_DOMAIN" + +echo "Camunda 8 will be reachable from $DOMAIN_NAME" +``` + +If you choose to use a custom domain instead, ensure it is supported by your router configuration and replace the example domain with your desired domain. For more details on configuring custom domains in OpenShift, refer to the official [custom domain OpenShift documentation](https://docs.openshift.com/dedicated/applications/deployments/osd-config-custom-domains-applications.html). + +#### Checking if HTTP/2 is enabled + +As the Zeebe Gateway also uses `gRPC` (which relies on `HTTP/2`), [HTTP/2 Ingress Connectivity must be enabled](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html#nw-http2-haproxy_configuring-ingress). + +To check if HTTP/2 is already enabled on your OpenShift cluster, run the following command: + +```bash +oc get ingresses.config/cluster -o json | jq '.metadata.annotations."ingress.operator.openshift.io/default-enable-http2"' +``` + +Alternatively, if you use a dedicated IngressController for the deployment: + +```bash +# List your IngressControllers +oc -n openshift-ingress-operator get ingresscontrollers + +# Replace with your IngressController name +oc -n openshift-ingress-operator get ingresscontrollers/ -o json | jq '.metadata.annotations."ingress.operator.openshift.io/default-enable-http2"' +``` + +- If the output is `"true"`, it means HTTP/2 is enabled. +- If the output is `null` or empty, HTTP/2 is not enabled. + +
    + Enable HTTP/2 + +If HTTP/2 is not enabled, you can enable it by running the following command: + +**IngressController configuration:** + +```bash +oc -n openshift-ingress-operator annotate ingresscontrollers/ ingress.operator.openshift.io/default-enable-http2=true +``` + +**Global cluster configuration:** + +```bash +oc annotate ingresses.config/cluster ingress.operator.openshift.io/default-enable-http2=true +``` + +This will add the necessary annotation to [enable HTTP/2 for Ingress in your OpenShift cluster](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html#nw-http2-haproxy_configuring-ingress) globally on the cluster. + +
    + +#### Configure Route TLS + +Additionally, the Zeebe Gateway should be configured to use an encrypted connection with TLS. In OpenShift, the connection from HAProxy to the Zeebe Gateway service can use HTTP/2 only for re-encryption or pass-through routes, and not for edge-terminated or insecure routes. + +1. **Zeebe Gateway:** two [TLS secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) for the Zeebe Gateway are required, one for the **service** and the other one for the **route**: + + - The first TLS secret is issued to the Zeebe Gateway Service Name. This must use the [PKCS #8 syntax](https://en.wikipedia.org/wiki/PKCS_8) or [PKCS #1 syntax](https://en.wikipedia.org/wiki/PKCS_1) as Zeebe only supports these, referenced as `camunda-platform-internal-service-certificate`. + + In the example below, a TLS certificate is generated for the Zeebe Gateway service with an [annotation](https://docs.openshift.com/container-platform/latest/security/certificates/service-serving-certificate.html). The generated certificate will be in the form of a secret. + + Another option is [Cert Manager](https://docs.openshift.com/container-platform/latest/security/cert_manager_operator/index.html). For more details, review the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html#nw-ingress-creating-a-reencrypt-route-with-a-custom-certificate_secured-routes). + +
    + PKCS #8, PKCS #1 syntax + + > PKCS #1 private key encoding. PKCS #1 produces a PEM block that contains the private key algorithm in the header and the private key in the body. A key that uses this can be recognised by its BEGIN RSA PRIVATE KEY or BEGIN EC PRIVATE KEY header. NOTE: This encoding is not supported for Ed25519 keys. Attempting to use this encoding with an Ed25519 key will be ignored and default to PKCS #8. + + > PKCS #8 private key encoding. PKCS #8 produces a PEM block with a static header and both the private key algorithm and the private key in the body. A key that uses this encoding can be recognised by its BEGIN PRIVATE KEY header. + + [PKCS #1, PKCS #8 syntax definitionfrom cert-manager](https://cert-manager.io/docs/reference/api-docs/#cert-manager.io/v1.PrivateKeyEncoding) + +
    + + - The second TLS secret is used on the exposed route, referenced as `camunda-platform-external-certificate`. For example, this would be the same TLS secret used for Ingress. We also configure the Zeebe Gateway Ingress to create a [Re-encrypt Route](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html#nw-ingress-creating-a-route-via-an-ingress_route-configuration). + + Finally, we mount the **Service Certificate Secret** (`camunda-platform-internal-service-certificate`) to the Zeebe Gateway Pod. + Update your `values.yml` file with the following: + + ```yaml reference + https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/zeebe-gateway-route.yml + ``` + + The domain used by the Zeebe Gateway for gRPC is `zeebe-$DOMAIN_NAME` which different from the one used for the rest, namely `$DOMAIN_NAME`, to avoid any conflicts. It is also important to note that the port used for gRPC is `443`. + +2. **Operate:** mount the **Service Certificate Secret** to the Operate pod and configure the secure TLS connection. Here, only the `tls.crt` file is required. + +Update your `values.yml` file with the following: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/operate-route.yml +``` + +The actual configuration properties can be reviewed [in the Operate configuration documentation](/self-managed/operate-deployment/operate-configuration.md#zeebe-broker-connection). + +1. **Tasklist:** mount the **Service Certificate Secret** to the Tasklist pod and configure the secure TLS connection. Here, only the `tls.crt` file is required. + + Update your `values.yml` file with the following: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/tasklist-route.yml +``` + +The actual configuration properties can be reviewed [in the Tasklist configuration documentation](/self-managed/tasklist-deployment/tasklist-configuration.md#zeebe-broker-connection). + +1. **Connectors:** update your `values.yml` file with the following: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/connectors-route.yml +``` + +The actual configuration properties can be reviewed [in the Connectors configuration documentation](/self-managed/connectors-deployment/connectors-configuration.md#zeebe-broker-connection). + +1. Configure all other applications running inside the cluster and connecting to the Zeebe Gateway to also use TLS. + +1. Set up the global configuration to enable the single Ingress definition with the host. Update your configuration file as shown below: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/domain.yml +``` + + + + +     + + + +[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) serve as OpenShift's default Ingress implementation. + +If you find that its features aren't suitable for your needs, or if you prefer to use a Kubernetes-native Ingress controller, such as the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx), [you have that option](https://www.redhat.com/en/blog/a-guide-to-using-routes-ingress-and-gateway-apis-in-kubernetes-without-vendor-lock-in). + +For guidance on installing an Ingress controller, you can refer to the [Ingress Setup documentation](/self-managed/setup/guides/ingress-setup.md). + +:::note Difference between ingress-nginx and NGINX Ingress + +Do not confuse the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx) with the [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift) that is endorsed by Red Hat for usage with OpenShift. Despite very similar names, they are two different products. + +If you should decide to use the Red Hat endorsed [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift), you would require additional adjustments done to the Camunda 8 Ingress objects and the NGINX Ingress Controller itself to make `gRPC` and `HTTP/2` connections work. In that case, please refer to the [example and the prerequisites](https://github.com/nginxinc/kubernetes-ingress/blob/main/examples/ingress-resources/grpc-services/README.md). + +::: + + + +If you do not have a domain name or do not intend to use one for your Camunda 8 deployment, external access to Camunda 8 web endpoints from outside the OpenShift cluster will not be possible. + +However, you can use `kubectl port-forward` to access the Camunda platform without a domain name or Ingress configuration. For more information, refer to the [kubectl port-forward documentation](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/). + +To make this work, you will need to configure the deployment to reference `localhost` with the forwarded port. Update your `values.yml` file with the following: + +```yaml reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/no-domain.yml +``` + + +     +#### Configuring the Security Context Constraints + +Depending on your OpenShift cluster's Security Context Constraints (SCCs) configuration, the deployment process may vary. By default, OpenShift employs more restrictive SCCs. The Helm chart must assign `null` to the user running all components and dependencies. + + + + The `global.compatibility.openshift.adaptSecurityContext` variable in your values.yaml can be used to set the following possible values: - `force`: The `runAsUser` and `fsGroup` values will be null in all components. - `disabled`: The `runAsUser` and `fsGroup` values will not be modified (default). -To deploy Camunda 8 on OpenShift: - -1. Install [Helm and other CLI tools](/self-managed/setup/install.md#prerequisites). -2. Install the [Camunda Helm chart repository](/self-managed/setup/install.md#helm-repository). -3. Set `global.compatibility.openshift.adaptSecurityContext` to `force` - -```shell -helm install camunda camunda/camunda-platform --skip-crds \ - --set global.compatibility.openshift.adaptSecurityContext=force +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/scc.yml ``` -### With permissive SCCs - To use permissive SCCs, simply install the charts as they are. Follow the [general Helm deployment guide](/self-managed/setup/install.md). +```hcl reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/helm-values/no-scc.yml +``` + -## Available Configurations of OpenShift Components +#### Enable Enterprise components + +Some components are not enabled by default in this deployment. For more information on how to configure and enable these components, refer to [configuring Enterprise components and Connectors](/self-managed/setup/install.md#configuring-enterprise-components-and-connectors). + +#### Fill your deployment with actual values + +Once you've prepared the `values.yml` file, run the following `envsubst` command to substitute the environment variables with their actual values: + +```bash +# generate the final values +envsubst < values.yml > generated-values.yml + +# print the result +cat generated-values.yml +``` + +:::info Camunda Helm chart no longer automatically generates passwords + +Starting from **Camunda 8.6**, the Helm chart deprecated the automatic generation of secrets, and this feature has been fully removed in **Camunda 8.7**. + +::: + +Next, store various passwords in a Kubernetes secret, which will be used by the Helm chart. Below is an example of how to set up the required secret. You can use `openssl` to generate random secrets and store them in environment variables: + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/generate-passwords.sh +``` + +Use these environment variables in the `kubectl` command to create the secret. + +- The `smtp-password` should be replaced with the appropriate external value ([see how it's used by Web Modeler](/self-managed/modeler/web-modeler/configuration/configuration.md#smtp--email)). + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/create-identity-secret.sh +``` + +### Install Camunda 8 using Helm + +Now that the `generated-values.yml` is ready, you can install Camunda 8 using Helm. + +The following are the required environment variables with some example values: + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/chart-env.sh +``` + +Then run the following command: + +```bash reference +https://github.com/camunda/camunda-deployment-references/blob/main/aws/rosa-hcp/camunda-versions/8.6/procedure/install/install-chart.sh +``` + +This command: + +- Installs (or upgrades) the Camunda platform using the Helm chart. +- Substitutes the appropriate version using the `$CAMUNDA_HELM_CHART_VERSION` environment variable. +- Applies the configuration from `generated-values.yml`. + +:::note + +This guide uses `helm upgrade --install` as it runs install on initial deployment and upgrades future usage. This may make it easier for future [Camunda 8 Helm upgrades](/self-managed/setup/upgrade.md) or any other component upgrades. + +::: + +You can track the progress of the installation using the following command: + +```bash +watch -n 5 ' + kubectl get pods -n camunda --output=wide; + if [ $(kubectl get pods -n camunda --field-selector=status.phase!=Running -o name | wc -l) -eq 0 ] && + [ $(kubectl get pods -n camunda -o json | jq -r ".items[] | select(.status.containerStatuses[]?.ready == false)" | wc -l) -eq 0 ]; + then + echo "All pods are Running and Healthy - Installation completed!"; + else + echo "Some pods are not Running or Healthy"; + fi +' +``` + +## Verify connectivity to Camunda 8 + +Please follow our [guide to verify connectivity to Camunda 8](/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md#verify-connectivity-to-camunda-8) + +:::caution Domain name for gRPC Zeebe + +In this setup, the domain used for gRPC communication with Zeebe is slightly different from the one in the guide. Instead of using `zeebe.$DOMAIN_NAME`, you need to use `zeebe-$DOMAIN_NAME`. + +::: + +## Pitfalls to avoid + +For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md). ### Security Context Constraints (SCCs) @@ -144,220 +449,3 @@ If you deploy Camunda 8 (and related infrastructure) with permissive SCCs out of     - -## Ingress Configuration - -Before exposing services outside the cluster, we need an Ingress component. Here's how you can configure it: - - - - -### Using Kubernetes Ingress - -[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) serve as OpenShift's default Ingress implementation. - -If you find that its features aren't suitable for your needs, or if you prefer to use a Kubernetes-native Ingress controller, such as the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx), [you have that option](https://www.redhat.com/en/blog/a-guide-to-using-routes-ingress-and-gateway-apis-in-kubernetes-without-vendor-lock-in). - -For guidance on installing an Ingress controller, you can refer to the [Ingress Setup documentation](/self-managed/setup/guides/ingress-setup.md). - -:::note Difference between ingress-nginx and NGINX Ingress - -Do not confuse the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx) with the [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift) that is endorsed by Red Hat for usage with OpenShift. Despite very similar names, they are two different products. - -If you should decide to use the Red Hat endorsed [NGINX Ingress Controller](https://www.redhat.com/en/blog/using-nginx-ingress-controller-red-hat-openshift), you would require additional adjustments done to the Camunda 8 Ingress objects and the NGINX Ingress Controller itself to make `gRPC` and `HTTP/2` connections work. In that case, please refer to the [example and the prerequisites](https://github.com/nginxinc/kubernetes-ingress/blob/main/examples/ingress-resources/grpc-services/README.md). - -::: - - - - -### Using OpenShift Routes - -[Routes](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html) expose services externally by linking a URL to a service within the cluster. [OpenShift supports both the standard Kubernetes Ingress and routes](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html), giving cluster users the flexibility to choose. - -The presence of routes is rooted in their specification predating Ingress. It's worth noting that the functionality of routes differs from Ingress; for example, unlike Ingress, routes don't allow multiple services to be linked to a single route or the use of paths. - -To use these routes for the Zeebe Gateway, configure this through Ingress as well. - -#### Prerequisite - -As the Zeebe Gateway also uses `gRPC` (which relies on `HTTP/2`), [HTTP/2 Ingress Connectivity has to be enabled](https://docs.openshift.com/container-platform/latest/networking/ingress-operator.html#nw-http2-haproxy_configuring-ingress). - -Additionally, the Zeebe Gateway should be configured to use an encrypted connection with TLS. In OpenShift, the connection from HAProxy to the Zeebe Gateway service can use HTTP/2 only for re-encryption or pass-through routes, and not for edge-terminated or insecure routes. - -#### Required Steps - -1. Provide two [TLS secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) for the Zeebe Gateway. - - - The first TLS secret is issued to the Zeebe Gateway Service Name. This must use the [PKCS #8 syntax](https://en.wikipedia.org/wiki/PKCS_8) or [PKCS #1 syntax](https://en.wikipedia.org/wiki/PKCS_1) as Zeebe only supports these, referenced as `camunda-platform-internal-service-certificate`. - - In the example below, a TLS certificate is generated for the Zeebe Gateway service with an [annotation](https://docs.openshift.com/container-platform/latest/security/certificates/service-serving-certificate.html). The generated certificate will be in the form of a secret. - - ```yaml - zeebeGateway: - service: - annotations: - service.beta.openshift.io/serving-cert-secret-name: camunda-platform-internal-service-certificate - ``` - - Another option is [Cert Manager](https://docs.openshift.com/container-platform/latest/security/cert_manager_operator/index.html). For more details, review the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html#nw-ingress-creating-a-reencrypt-route-with-a-custom-certificate_secured-routes). - -
    - PKCS #8, PKCS #1 syntax - - > PKCS #1 private key encoding. PKCS #1 produces a PEM block that contains the private key algorithm in the header and the private key in the body. A key that uses this can be recognised by its BEGIN RSA PRIVATE KEY or BEGIN EC PRIVATE KEY header. NOTE: This encoding is not supported for Ed25519 keys. Attempting to use this encoding with an Ed25519 key will be ignored and default to PKCS #8. - - > PKCS #8 private key encoding. PKCS #8 produces a PEM block with a static header and both the private key algorithm and the private key in the body. A key that uses this encoding can be recognised by its BEGIN PRIVATE KEY header. - - [PKCS #1, PKCS #8 syntax definitionfrom cert-manager](https://cert-manager.io/docs/reference/api-docs/#cert-manager.io/v1.PrivateKeyEncoding) - -
    - - - The second TLS secret is used on the exposed route, referenced as `camunda-platform-external-certificate`. For example, this would be the same TLS secret used for Ingress. - -1. Configure your Zeebe Gateway Ingress to create a [Re-encrypt Route](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html#nw-ingress-creating-a-route-via-an-ingress_route-configuration): - - ```yaml - zeebeGateway: - ingress: - grpc: - annotations: - route.openshift.io/termination: reencrypt - route.openshift.io/destination-ca-certificate-secret: camunda-platform-internal-service-certificate - className: openshift-default - tls: - enabled: true - secretName: camunda-platform-external-certificate - ``` - -1. Mount the **Service Certificate Secret** to the Zeebe Gateway Pod: - - ```yaml - zeebeGateway: - env: - - name: ZEEBE_GATEWAY_SECURITY_ENABLED - value: "true" - - name: ZEEBE_GATEWAY_SECURITY_CERTIFICATECHAINPATH - value: /usr/local/zeebe/config/tls.crt - - name: ZEEBE_GATEWAY_SECURITY_PRIVATEKEYPATH - value: /usr/local/zeebe/config/tls.key - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/zeebe/config/tls.crt - subPath: tls.crt - - name: key - mountPath: /usr/local/zeebe/config/tls.key - subPath: tls.key - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - - name: key - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.key - path: tls.key - defaultMode: 420 - ``` - -1. Mount the **Service Certificate Secret** to the Operate and Tasklist pods and configure the secure TLS connection. Here, only the `tls.crt` file is required. - - For Operate: - - ```yaml - operate: - env: - - name: CAMUNDA_OPERATE_ZEEBE_SECURE - value: "true" - - name: CAMUNDA_OPERATE_ZEEBE_CERTIFICATEPATH - value: /usr/local/operate/config/tls.crt - - name: CAMUNDA_OPERATE_ZEEBE_BROKERCONTACTPOINT - value: camunda-zeebe-gateway.camunda.svc.cluster.local:26500 - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/operate/config/tls.crt - subPath: tls.crt - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - ``` - - The actual configuration properties can be reviewed [in the Operate configuration documentation](/self-managed/operate-deployment/operate-configuration.md#zeebe-broker-connection). - - For Tasklist: - - ```yaml - tasklist: - env: - - name: CAMUNDA_TASKLIST_ZEEBE_SECURE - value: "true" - - name: CAMUNDA_TASKLIST_ZEEBE_CERTIFICATEPATH - value: /usr/local/tasklist/config/tls.crt - - name: CAMUNDA_TASKLIST_ZEEBE_BROKERCONTACTPOINT - value: camunda-zeebe-gateway.camunda.svc.cluster.local:26500 - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/tasklist/config/tls.crt - subPath: tls.crt - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - ``` - - The actual configuration properties can be reviewed [in the Tasklist configuration documentation](/self-managed/tasklist-deployment/tasklist-configuration.md#zeebe-broker-connection). - -1. Configure Connectors: - - ```yaml - connectors: - inbound: - mode: oauth - env: - - name: ZEEBE_CLIENT_BROKER_GATEWAY-ADDRESS - value: "camunda-zeebe-gateway.camunda.svc.cluster.local:26500" - - name: ZEEBE_CLIENT_SECURITY_PLAINTEXT - value: "false" - - name: CAMUNDA_CLIENT_ZEEBE_CACERTIFICATEPATH - value: /usr/local/certificates/tls.crt - extraVolumeMounts: - - name: certificate - mountPath: /usr/local/certificates/tls.crt - subPath: tls.crt - extraVolumes: - - name: certificate - secret: - secretName: camunda-platform-internal-service-certificate - items: - - key: tls.crt - path: tls.crt - defaultMode: 420 - ``` - - The actual configuration properties can be reviewed [in the Connectors configuration documentation](/self-managed/connectors-deployment/connectors-configuration.md#zeebe-broker-connection). - -1. Configure all other applications running inside the cluster and connecting to the Zeebe Gateway to also use TLS. - - - - -     -     - -## Pitfalls to avoid - -For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md). diff --git a/versioned_sidebars/version-8.6-sidebars.json b/versioned_sidebars/version-8.6-sidebars.json index 66f10535b88..cff47e1dc55 100644 --- a/versioned_sidebars/version-8.6-sidebars.json +++ b/versioned_sidebars/version-8.6-sidebars.json @@ -1834,6 +1834,17 @@ "self-managed/setup/deploy/amazon/amazon-eks/irsa" ] }, + { + "type": "category", + "label": "ROSA", + "link": { + "type": "doc", + "id": "self-managed/setup/deploy/amazon/openshift/terraform-setup" + }, + "items": [ + "self-managed/setup/deploy/amazon/openshift/terraform-setup" + ] + }, "self-managed/setup/deploy/amazon/aws-marketplace" ], "Microsoft (Azure)": [