diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml index dad36c860a..1ee1906eb2 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/api/camunda/camunda-openapi.yaml @@ -10,7 +10,7 @@ info: url: https://github.com/camunda/camunda/blob/main/licenses/CAMUNDA-LICENSE-1.0.txt externalDocs: description: Find out more - url: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/overview/ + url: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/camunda-api-rest-overview/ servers: - url: "{schema}://{host}:{port}/v2" @@ -26,6 +26,7 @@ servers: description: The schema of the Camunda 8 REST API server. tags: + - name: Authentication - name: Authorization - name: Clock - name: Cluster @@ -35,9 +36,11 @@ tags: - name: Document - name: Element instance - name: Flow node instance + - name: Group - name: Incident - name: Job - name: License + - name: Mapping rule - name: Message - name: Process definition - name: Process instance @@ -48,7 +51,6 @@ tags: - name: User - name: User task - name: Variable - - name: Mapping Rule paths: /topology: @@ -83,6 +85,26 @@ paths: $ref: "#/components/schemas/LicenseResponse" "500": $ref: "#/components/responses/InternalServerError" + + /authentication/me: + get: + tags: + - Authentication + operationId: getAuthentication + summary: Get current user + description: Retrieves the current authenticated user. + responses: + "200": + description: The current user is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/CamundaUser" + "401": + $ref: "#/components/responses/Unauthorized" + "500": + $ref: "#/components/responses/InternalServerError" + /jobs/activation: post: tags: @@ -499,6 +521,255 @@ paths: "500": $ref: "#/components/responses/InternalServerError" + /tenants/{tenantKey}/users/{userKey}: + put: + tags: + - Tenant + operationId: assignUserToTenant + summary: Assign a user to a tenant + description: Assign a single user to a specified tenant. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The unique identifier of the user. + schema: + type: integer + format: int64 + responses: + "202": + description: The user was successfully assigned to the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or user was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + delete: + tags: + - Tenant + operationId: removeUserFromTenant + summary: Remove a user from a tenant + description: Removes a single user from a specified tenant without deleting the user. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The unique identifier of the user. + schema: + type: integer + format: int64 + responses: + "202": + description: The user was successfully removed from the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or user was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + /tenants/{tenantKey}/mapping-rules/{mappingKey}: + put: + tags: + - Tenant + operationId: assignMappingRuleToTenant + summary: Assign a mapping rule to a tenant + description: Assign a single mapping rule to a specified tenant. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: mappingKey + in: path + required: true + description: The unique identifier of the mapping rule. + schema: + type: integer + format: int64 + responses: + "202": + description: The mapping rule was successfully assigned to the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or mapping rule was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + delete: + tags: + - Tenant + operationId: removeMappingRuleFromTenant + summary: Remove a mapping rule from a tenant + description: Removes a single mapping rule from a specified tenant without deleting the rule. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: mappingKey + in: path + required: true + description: The unique identifier of the mapping rule. + schema: + type: integer + format: int64 + responses: + "202": + description: The mapping rule was successfully removed from the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or mapping rule was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + /tenants/{tenantKey}/groups/{groupKey}: + put: + tags: + - Tenant + operationId: assignGroupToTenant + summary: Assign a group to a tenant + description: Assign a single group to a specified tenant. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: groupKey + in: path + required: true + description: The unique identifier of the group. + schema: + type: integer + format: int64 + responses: + "202": + description: The group was successfully assigned to the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or group was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + delete: + tags: + - Tenant + operationId: removeGroupFromTenant + summary: Remove a group from a tenant + description: Removes a single group from a specified tenant without deleting the group. + parameters: + - name: tenantKey + in: path + required: true + description: The unique identifier of the tenant. + schema: + type: integer + format: int64 + - name: groupKey + in: path + required: true + description: The unique identifier of the group. + schema: + type: integer + format: int64 + responses: + "202": + description: The group was successfully removed from the tenant. + "400": + description: The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: Not found. The tenant or group was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /tenants/search: post: tags: @@ -880,7 +1151,7 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /user-tasks/{userTaskKey}/variables: + /user-tasks/{userTaskKey}/variables/search: post: tags: - User task @@ -2231,7 +2502,7 @@ paths: schema: $ref: "#/components/schemas/RoleCreateRequest" responses: - "202": + "201": description: | The role was created successfully. content: @@ -2297,30 +2568,281 @@ paths: - name: roleKey in: path required: true - description: The key of the role to update. + description: The key of the role to update. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/RoleUpdateRequest" + responses: + "204": + description: The role was updated successfully. + "400": + description: > + The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The role with the roleKey is not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + delete: + tags: + - Role + operationId: deleteRole + summary: Delete role + description: Deletes the role with the given key. + parameters: + - name: roleKey + in: path + required: true + description: The key of the role to delete. + schema: + type: integer + format: int64 + responses: + "204": + description: The role was deleted successfully. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The role with the roleKey was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /roles/search: + post: + tags: + - Role + operationId: searchRoles + summary: Query roles + description: | + Search for roles based on given criteria. + requestBody: + required: false + content: + application/json: + schema: + $ref: "#/components/schemas/RoleSearchQueryRequest" + responses: + "200": + description: The roles search result. + content: + application/json: + schema: + $ref: "#/components/schemas/RoleSearchQueryResponse" + "400": + description: > + The role search query failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + description: An internal error occurred while processing the request. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + + /groups: + post: + tags: + - Group + operationId: createGroup + summary: Create group + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/GroupCreateRequest" + responses: + "201": + description: The group was created successfully. + content: + application/json: + schema: + $ref: "#/components/schemas/GroupCreateResponse" + "400": + description: | + The group could not be created. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" + /groups/{groupKey}: + get: + tags: + - Group + operationId: getGroup + summary: Get group + description: | + Get a group by its key. + parameters: + - name: groupKey + in: path + required: true + description: The group key. + schema: + type: integer + format: int64 + responses: + "200": + description: The group is successfully returned. + content: + application/json: + schema: + $ref: "#/components/schemas/GroupItem" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + description: The group with the given key was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + patch: + tags: + - Group + operationId: updateGroup + summary: Update group + description: Update a group with the given key. + parameters: + - name: groupKey + in: path + required: true + description: The key of the group to update. + schema: + type: integer + format: int64 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/GroupUpdateRequest" + responses: + "204": + description: The group was updated successfully. + "400": + description: > + The provided data is not valid. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The group with the groupKey is not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + delete: + tags: + - Group + operationId: deleteGroup + summary: Delete group + description: Deletes the group with the given key. + parameters: + - name: groupKey + in: path + required: true + description: The key of the group to delete. + schema: + type: integer + format: int64 + responses: + "204": + description: The group was deleted successfully. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The group with the groupKey was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + /groups/{groupKey}/users/{userKey}: + post: + tags: + - Group + operationId: addUserToGroup + summary: Assign a user to a group + description: | + Assigns a user to a group. + parameters: + - name: groupKey + in: path + required: true + description: The group key. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The user key. schema: type: integer format: int64 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/RoleUpdateRequest" responses: - "204": - description: The role was updated successfully. + "202": + description: The user was assigned successfully to the group. "400": - description: > - The provided data is not valid. + description: | + The user could not be assigned. + More details are provided in the response body. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" - "401": - $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The role with the roleKey is not found. + description: The group or user with the given key was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "409": + description: The user with the given key is already assigned to the group. content: application/problem+json: schema: @@ -2329,55 +2851,71 @@ paths: $ref: "#/components/responses/InternalServerError" delete: tags: - - Role - operationId: deleteRole - summary: Delete role - description: Deletes the role with the given key. + - Group + operationId: unassignUserFromGroup + summary: Unassign a user from a group + description: | + Unassigns a user from a group. parameters: - - name: roleKey + - name: groupKey in: path required: true - description: The key of the role to delete. + description: The group key. + schema: + type: integer + format: int64 + - name: userKey + in: path + required: true + description: The user key. schema: type: integer format: int64 responses: - "204": - description: The role was deleted successfully. - "401": - $ref: "#/components/responses/Unauthorized" + "202": + description: The user was unassigned successfully from the group. + "400": + description: | + The user could not be unassigned. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "403": + $ref: "#/components/responses/Forbidden" "404": - description: The role with the roleKey was not found. + description: The group or user with the given key was not found, or the user is not assigned to this group. content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetail" "500": $ref: "#/components/responses/InternalServerError" - /roles/search: + /groups/search: post: tags: - - Role - operationId: searchRoles - summary: Query roles + - Group + operationId: searchGroups + summary: Query groups description: | - Search for roles based on given criteria. + Search for groups based on given criteria. requestBody: required: false content: application/json: schema: - $ref: "#/components/schemas/RoleSearchQueryRequest" + $ref: "#/components/schemas/GroupSearchQueryRequest" responses: "200": - description: The roles search result. + description: The groups search result. content: application/json: schema: - $ref: "#/components/schemas/RoleSearchQueryResponse" + $ref: "#/components/schemas/GroupSearchQueryResponse" "400": description: > - The role search query failed. + The group search query failed. More details are provided in the response body. content: application/problem+json: @@ -2397,7 +2935,7 @@ paths: /mapping-rules: post: tags: - - Mapping Rule + - Mapping rule operationId: createMappingRule summary: Create mapping rule description: | @@ -2436,6 +2974,70 @@ paths: $ref: "#/components/schemas/ProblemDetail" "500": $ref: "#/components/responses/InternalServerError" + /mapping-rules/{mappingKey}: + delete: + tags: + - Mapping rule + operationId: deleteMappingRule + summary: Delete a mapping rule + description: Deletes the mapping rule with the given key. + parameters: + - name: mappingKey + in: path + required: true + description: The key of the mapping rule to delete. + schema: + type: integer + format: int64 + responses: + "204": + description: The mapping rule was deleted successfully. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: The mapping rule with the mappingKey was not found. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "500": + $ref: "#/components/responses/InternalServerError" + + /mapping-rules/search: + post: + tags: + - Mapping rule + operationId: findMappings + summary: Query mappings + description: | + Search for mapping rules based on given criteria. + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/MappingSearchQueryRequest" + required: true + responses: + "200": + description: The mapping rule search result. + content: + application/json: + schema: + $ref: "#/components/schemas/MappingSearchResponse" + "400": + description: > + The mapping rule search query failed. + More details are provided in the response body. + content: + application/problem+json: + schema: + $ref: "#/components/schemas/ProblemDetail" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "500": + $ref: "#/components/responses/InternalServerError" /messages/publication: post: @@ -2656,7 +3258,7 @@ paths: "500": $ref: "#/components/responses/InternalServerError" - /document/{documentId}/links: + /documents/{documentId}/links: post: tags: - Document @@ -2719,7 +3321,7 @@ paths: $ref: "#/components/schemas/UserRequest" required: true responses: - "202": + "201": description: | The user was created successfully. content: @@ -3234,6 +3836,33 @@ components: items: $ref: "#/components/schemas/TenantItem" + MappingItem: + description: Mapping rule search response item. + 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. + type: array + items: + $ref: "#/components/schemas/MappingItem" + UserTaskSearchQueryRequest: allOf: - $ref: "#/components/schemas/SearchQueryRequest" @@ -3313,9 +3942,14 @@ components: type: integer description: The key of the element instance. format: int64 - variables: + processInstanceVariables: type: array - description: Variables associated with the user task. + description: Process Instance variables associated with the user task. + items: + $ref: "#/components/schemas/UserTaskVariableFilterRequest" + localVariables: + type: array + description: Local variables associated with the user task. items: $ref: "#/components/schemas/UserTaskVariableFilterRequest" UserTaskVariableFilterRequest: @@ -3334,6 +3968,9 @@ components: description: The key of the user task. type: integer format: int64 + name: + type: string + description: The name for this user task. state: type: string description: The state of the user task. @@ -3819,10 +4456,6 @@ components: description: The parent flow node instance key. allOf: - $ref: "#/components/schemas/LongFilterProperty" - treePath: - description: The path of keys to this process instance, separated by '/'. - allOf: - - $ref: "#/components/schemas/StringFilterProperty" startDate: description: The start date. allOf: @@ -3842,18 +4475,21 @@ components: description: The tenant ID. allOf: - $ref: "#/components/schemas/StringFilterProperty" + variables: + description: The process instance variables. + type: array + items: + $ref: "#/components/schemas/ProcessInstanceVariableFilterRequest" ProcessInstanceVariableFilterRequest: description: Process instance variable filter. type: object properties: name: + description: Name of the variable. + type: string + value: + description: The value of the variable. type: string - description: The variable name. - values: - type: array - description: The variable values. - items: - type: string ProcessInstanceSearchQueryResponse: description: Process instance search response. allOf: @@ -3898,9 +4534,6 @@ components: type: integer description: The parent flow node instance key. format: int64 - treePath: - type: string - description: The path of keys to this process instance, separated by '/'. startDate: type: string description: The start date. @@ -4006,9 +4639,6 @@ components: flowNodeName: type: string description: The flow node name. - treePath: - type: string - description: The path of keys from process instance to this flow node instance separated by '/'. hasIncident: type: boolean description: Shows whether this flow node instance has an incident related to. @@ -4058,8 +4688,8 @@ components: flowNodeId: description: The flow node ID for this flow node instance. type: string - treePath: - description: The path from process instance leading to this flow node instance. + flowNodeName: + description: The flow node name for this flow node instance. type: string type: description: Type of flow node as defined set of values. @@ -4214,9 +4844,6 @@ components: type: integer format: int64 description: The job key, if exists, associated with this incident. - treePath: - type: string - description: The path from process instance via flow node ids and flow node instance keys leading to this incident. tenantId: description: The tenant ID of the incident. type: string @@ -4291,9 +4918,6 @@ components: type: integer description: The job key, if exists, associated with this incident. format: int64 - treePath: - type: string - description: The path from process instance via flow node ids and flow node instance keys leading to this incident. tenantId: description: The tenant ID of the incident. type: string @@ -4337,6 +4961,7 @@ components: PermissionTypeEnum: description: Specifies the type of permissions. enum: + - ACCESS - CREATE - CREATE_PROCESS_INSTANCE - CREATE_DECISION_INSTANCE @@ -4495,6 +5120,15 @@ components: description: The user search filters. allOf: - $ref: "#/components/schemas/UserFilterRequest" + MappingSearchQueryRequest: + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + description: The mapping search filters. + allOf: + - $ref: "#/components/schemas/MappingFilterRequest" UserFilterRequest: description: User search filter. type: object @@ -4508,6 +5142,73 @@ components: email: description: The email of the user. type: "string" + MappingFilterRequest: + description: Mapping search filter. + type: object + properties: + claimName: + type: string + description: The claim name to match against a token. + claimValue: + type: string + description: The value of the claim to match. + 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" + displayName: + description: The display name of the User + type: "string" + authorizedApplications: + description: The applications the User is authorized to use + type: array + items: + type: "string" + tenants: + description: The tenants the User is a member of + type: array + items: + type: "object" + properties: + tenantId: + type: "string" + name: + type: "string" + groups: + description: The groups assigned to the user + type: array + items: + type: "string" + roles: + description: The roles assigned to the user + type: array + items: + type: "string" + salesPlanType: + description: The plan of the user + type: "string" + c8Links: + description: The links to the components in the C8 stack + type: array + items: + type: "object" + properties: + name: + type: "string" + link: + type: "string" + canLogout: + description: Flag for understanding if the user is able to perform logout + type: boolean + apiUser: + description: Flag for understanding if the user is an API user + type: boolean UserResponse: type: "object" properties: @@ -4619,6 +5320,82 @@ components: type: array items: $ref: "#/components/schemas/RoleItem" + + GroupCreateRequest: + type: "object" + properties: + name: + type: "string" + description: The display name of the new group. + GroupCreateResponse: + type: "object" + properties: + groupKey: + description: The key of the created group. + type: "integer" + format: "int64" + GroupUpdateRequest: + type: object + properties: + changeset: + description: The set of changed group attributes. + allOf: + - $ref: "#/components/schemas/GroupChangeset" + required: + - changeset + GroupChangeset: + description: A set of changed group attributes. + type: object + properties: + name: + type: string + description: The updated display name of the group. + GroupItem: + description: Group search response item. + type: object + 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 + GroupSearchQueryRequest: + description: Group search request. + allOf: + - $ref: "#/components/schemas/SearchQueryRequest" + type: object + properties: + filter: + description: The group search filters. + allOf: + - $ref: "#/components/schemas/GroupFilterRequest" + GroupFilterRequest: + description: Group filter request + type: object + properties: + name: + type: string + description: The name of the group. + GroupSearchQueryResponse: + description: Group search response. + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + type: object + properties: + items: + description: The matching groups. + type: array + items: + $ref: "#/components/schemas/GroupItem" + MappingRuleCreateRequest: type: object properties: @@ -4644,6 +5421,29 @@ components: claimValue: type: string description: The value of the claim to map. + MappingSearchResponse: + type: object + allOf: + - $ref: "#/components/schemas/SearchQueryResponse" + properties: + items: + description: The matching mapping rules. + type: array + items: + $ref: "#/components/schemas/MappingResponse" + MappingResponse: + 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. TopologyResponse: description: The response of a topology request. @@ -5135,9 +5935,7 @@ components: description: The field to sort by. type: string order: - description: The order in which to sort the field. - type: string - default: asc + $ref: "#/components/schemas/SortOrderEnum" required: - field SearchQueryResponse: @@ -5541,6 +6339,12 @@ components: - FAILED - UNSPECIFIED - UNKNOWN + SortOrderEnum: + description: The order in which to sort the related field. + enum: + - ASC + - DESC + default: ASC MessageCorrelationRequest: type: object diff --git a/api/operate/operate-openapi.yaml b/api/operate/operate-openapi.yaml index 2ef6348a54..823e724801 100644 --- a/api/operate/operate-openapi.yaml +++ b/api/operate/operate-openapi.yaml @@ -84,7 +84,6 @@ paths: searchAfter: - small - 9007199254741200 - required: true responses: "200": description: Success @@ -168,7 +167,6 @@ paths: sort: - field: bpmnProcessId order: ASC - required: true responses: "200": description: Success @@ -261,7 +259,6 @@ paths: sort: - field: bpmnProcessId order: ASC - required: true responses: "200": description: Success @@ -362,7 +359,6 @@ paths: searchAfter: - 1646904085499 - 9007199254743288 - required: true responses: "200": description: Success @@ -459,7 +455,6 @@ paths: searchAfter: - 1646904085499 - 9007199254743288 - required: true responses: "200": description: Success @@ -553,7 +548,6 @@ paths: sort: - field: decisionRequirementsId order: ASC - required: true responses: "200": description: Success @@ -645,7 +639,6 @@ paths: sort: - field: decisionId order: ASC - required: true responses: "200": description: Success @@ -737,7 +730,6 @@ paths: sort: - field: decisionId order: ASC - required: true responses: "200": description: Success @@ -1483,6 +1475,8 @@ components: processVersion: type: integer format: int32 + processVersionTag: + type: string bpmnProcessId: type: string parentKey: @@ -1501,6 +1495,8 @@ components: - ACTIVE - COMPLETED - CANCELED + incident: + type: boolean processDefinitionKey: type: integer format: int64 @@ -1549,6 +1545,8 @@ components: version: type: integer format: int32 + versionTag: + type: string bpmnProcessId: type: string tenantId: @@ -1602,6 +1600,7 @@ components: - UNKNOWN - IO_MAPPING_ERROR - JOB_NO_RETRIES + - EXECUTION_LISTENER_NO_RETRIES - CONDITION_ERROR - EXTRACT_VALUE_ERROR - CALLED_ELEMENT_ERROR diff --git a/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx new file mode 100644 index 0000000000..cd65f5d47d --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx @@ -0,0 +1,64 @@ +--- +id: add-user-to-group +title: "Assign a user to a group" +description: "Assigns a user to a group." +sidebar_label: "Assign a user to a group" +hide_title: true +hide_table_of_contents: true +api: eJztWMFy2zYQ/RUMTsmUJuXESR3eNI6duk1Sjy23B8cHEFiJSECAAUDLHA7/vbMAKSuS7GQ8PeqgoUgC+7DY9wDwddSzhaP5Df1gTVPT24SaGizz0uhzQXPKhLh2YGcmvk+oAMetrLEBzenUObnQjjDSOLDEG8LIAlumXzRNaM0sq8CDRYiOalYBzWlo8Be0NKESg9TMlzShFr430oKgubcNbCLNSoiRyTdoU5pQx0uoGM076tsaw0rtYQGWJnRubMV8fPT2iPZ9ssLGYT4HOqT3DORbDO5qox047PFq8govjwAsmSMsTCkI4hrOwbl5o1SLM+vHGUhpn9CjyeSJQNw0ShBtPClgFTH9oj8ZC0SAZ1I5wiyQ2po7KUAQqQPAOFhSGNHGInKjPWiPaKyuleSBHVltTaGg+u2rQ+hubVY2KEIuYssBl5jiK3BPmCOxYRHRby7PTsi7oze/374ova9dnmXL5TK1c34AQnpjU2MXmZ1z/GG7lymZlWCBVKwNaQohEZMpzKoG6yU44mrgci75OIPDsAmWLuY3FDEOC0m76vxQ4lWpnbdSL9Yr3Vi5LQtyfXlOpADt5byVerENHfrMWaMwBitM4/NCMf0Na+ulVztBN1FcU1XMtsTMdwD0CXWe+cb9lKmvX23FRib9MZtdkBiCcCOAzI0lvpRuBMIkKqll1VQ0P5pMElqx+3j3djLpMSZW/Bcy0QTua8V0oNZmOlKT6oG3ITGpnWea/1+VMVYu5CZuigvHWAs6kPh9zKjv+6DB19t8PzO2kEKADvQkuLSA80S6IEemlFmCSPe62utqr6tHdXW0e2+LBwBjh91S+jLuivIONO7OYQNFmc1No/ci24tsL7InRPbuqZPotrakI0xZYKJ9OKP+eCzdy20vt73cdsvtza7vtakmOMsWeQjWGksM5421IMiylCqEx2/AEXs4TO6/y/Za22vtMa31Ca3Alwbtq9q4QB20eXKahX3KZd3oQPUZbnYu6wZbqEd3B+zdaFg1VtGcdlFCfZ5lXWmc7/OuNtb32R3W545ZyQoVWYmvo9RGCinDmSrjMLZLiS/QmRpTPGFVowUjx+Ty9GpGPjAPS9aGqUXIH0MfT44nO6Ni00ciTi/OScwwEnFtcRjDosp3ho2NfyVw8L0c8MZK315htzg9BTALdtpgNVYEGfBCdLyPjWgy/DkbafPnv7NQeannJnQfGLA9EKwKWBdHPkkPt9l2cR5Ew01VNTqsnHoRzzxsLTGuGucxoYQqyUG7wOvBSRybfYxvyD8RkRymWJTInHHBXEhfNkXKTZXx2G11LZQpsopJnQ0QLjuZfrr+/H568PH85PTz1enBYTpJ/b0PySOhK6bXxhEt2G0HdjPp7mHD+JltOxTGw73PasWkRqqEjLpBSjfRxHU0ofmanRvUhM9Gm/U2GSRxQ7uuYA6urep7fPy9AdvS/Ob2QUFBckI6/C9oPmfKbXqx60m8uBxc25dkyxzemcHwkOk2yFY1eEcT+g3adVca3eJnj2LdJ37GIMZ562/7hJbABNgwK/HtlHOo/Vq/R/d91N9qEbz4+wqV8x9I3zlT +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +
All old Java client property names are refactored to more general ones. For example, `zeebe.client.tenantId` to `camunda.client.tenantId`.
Similarly, environment variables are renamed following the same concept: `ZEEBE_REST_ADDRESS` to `CAMUNDA_REST_ADDRESS`.