@bpmnkit/camunda-docspack 0.0.0

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-message-subscriptions.api.md

@@ -0,0 +1,38 @@
+# Search message subscriptions
+
+`POST /message-subscriptions/search`
+
+Search for message subscriptions based on given criteria.
+
+By default, both start and intermediate event subscriptions are returned. Use the
+`messageSubscriptionType` filter to restrict results to a single type.
+
+**Version notes:**
+- Start event subscriptions are only captured for deployments made with 8.10 or later.
+- The `messageSubscriptionType` field is only populated for data created
+  with Camunda 8.10 or later. For pre-8.10 data, intermediate event entries have no
+  `messageSubscriptionType` value stored. For convenience, the API returns `PROCESS_EVENT`
+  as a default for such search results, though.
+- Searching for intermediate event subscriptions **including legacy data** can be achieved
+  by filtering for `messageSubscriptionType` not matching `START_EVENT`.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: MessageSubscriptionSearchQuery
+    sort (MessageSubscriptionSearchQuerySortRequest[]) — Sort field criteria.
+    filter (MessageSubscriptionFilter) — The incident search filters.
+
+Responses:
+  200 MessageSubscriptionSearchQueryResult — The message subscription search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-message-subscriptions.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-own-authorizations.api.md

@@ -0,0 +1,24 @@
+# Search own authorizations
+
+`POST /authentication/me/authorizations/search`
+
+Search for the current authenticated principal's own authorization records — including authorizations granted directly to the user or client, as well as those granted via a group, role, or mapping rule the principal belongs to.
+
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth
+
+Request body:
+  application/json: AuthorizationSearchQuery
+    sort (AuthorizationSearchQuerySortRequest[]) — Sort field criteria.
+    filter (AuthorizationFilter) — The authorization search filters.
+
+Responses:
+  200 AuthorizationSearchResult — The authorization search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-own-authorizations.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-process-definition-variable-names.api.md

@@ -0,0 +1,28 @@
+# Search process definition variable names
+
+`POST /process-definitions/{processDefinitionKey}/variable-names/search`
+
+Search for distinct variable names defined on a process definition, optionally narrowed by the name filter.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processDefinitionKey (path, string, required)
+
+Request body:
+  application/json: ProcessDefinitionVariableNameSearchQuery
+    filter (ProcessDefinitionVariableNameFilter) — The process definition variable name search filters.
+
+Responses:
+  200 ProcessDefinitionVariableNameSearchQueryResult — The process definition variable name search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-process-definition-variable-names.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-process-definitions.api.md

@@ -0,0 +1,26 @@
+# Search process definitions
+
+`POST /process-definitions/search`
+
+Search for process definitions based on given criteria.
+
+- Required permissions: READ_PROCESS_DEFINITION on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ProcessDefinitionSearchQuery
+    sort (ProcessDefinitionSearchQuerySortRequest[]) — Sort field criteria.
+    filter (ProcessDefinitionFilter) — The process definition search filters.
+
+Responses:
+  200 ProcessDefinitionSearchQueryResult — The process definition search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-process-definitions.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-process-instance-incidents.api.md

@@ -0,0 +1,35 @@
+# Search related incidents
+
+`POST /process-instances/{processInstanceKey}/incidents/search`
+
+Search for incidents caused by the process instance or any of its called process or decision instances.
+
+Although the `processInstanceKey` is provided as a path parameter to indicate the root process instance,
+you may also include a `processInstanceKey` within the filter object to narrow results to specific
+child process instances. This is useful, for example, if you want to isolate incidents associated with
+subprocesses or called processes under the root instance while excluding incidents directly tied to the root.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processInstanceKey (path, string, required)
+
+Request body:
+  application/json: IncidentSearchQuery
+    sort (IncidentSearchQuerySortRequest[]) — Sort field criteria.
+    filter (IncidentFilter) — The incident search filters.
+
+Responses:
+  200 IncidentSearchQueryResult — The process instance search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The process instance with the given key was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-process-instance-incidents.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-process-instances.api.md

@@ -0,0 +1,26 @@
+# Search process instances
+
+`POST /process-instances/search`
+
+Search for process instances based on given criteria.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ProcessInstanceSearchQuery
+    sort (ProcessInstanceSearchQuerySortRequest[]) — Sort field criteria.
+    filter (ProcessInstanceFilter) — The process instance search filters.
+
+Responses:
+  200 ProcessInstanceSearchQueryResult — The process instance search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-process-instances.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-resources.api.md

@@ -0,0 +1,31 @@
+# Search resources
+
+`POST /resources/search`
+
+Search for deployed resources based on given criteria.
+:::info
+This endpoint does not return BPMN process definitions, DMN decision definitions, or form
+resources. To query BPMN process definitions or DMN decision definitions, use their
+respective search APIs.
+:::
+
+- Required permissions: READ on RESOURCE.
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ResourceSearchQuery
+    sort (ResourceSearchQuerySortRequest[]) — Sort field criteria.
+    filter (ResourceFilter) — The resource search filters.
+
+Responses:
+  200 ResourceSearchQueryResult — The resource search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-resources.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-roles-for-group.api.md

@@ -0,0 +1,30 @@
+# Search group roles
+
+`POST /groups/{groupId}/roles/search`
+
+Search roles assigned to a group.
+
+- Required permissions: READ on ROLE.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  groupId (path, GroupId, required)
+
+Request body:
+  application/json: RoleSearchQueryRequest
+    sort (RoleSearchQuerySortRequest[]) — Sort field criteria.
+    filter (RoleFilter) — The role search filters.
+
+Responses:
+  200 GroupRoleSearchResult — The roles assigned to the group.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The group with the given ID was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-roles-for-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-roles-for-tenant.api.md

@@ -0,0 +1,25 @@
+# Search roles for tenant
+
+`POST /tenants/{tenantId}/roles/search`
+
+Retrieves a filtered and sorted list of roles for a specified tenant.
+
+- Required permissions: READ on ROLE.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+
+Request body:
+  application/json: RoleSearchQueryRequest
+    sort (RoleSearchQuerySortRequest[]) — Sort field criteria.
+    filter (RoleFilter) — The role search filters.
+
+Responses:
+  200 TenantRoleSearchResult — The search result of roles for the tenant.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-roles-for-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-roles.api.md

@@ -0,0 +1,26 @@
+# Search roles
+
+`POST /roles/search`
+
+Search for roles based on given criteria.
+
+- Required permissions: READ on ROLE.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: RoleSearchQueryRequest
+    sort (RoleSearchQuerySortRequest[]) — Sort field criteria.
+    filter (RoleFilter) — The role search filters.
+
+Responses:
+  200 RoleSearchQueryResult — The roles search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-roles.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-tenants.api.md

@@ -0,0 +1,27 @@
+# Search tenants
+
+`POST /tenants/search`
+
+Retrieves a filtered and sorted list of tenants.
+
+- Required permissions: READ on TENANT.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: TenantSearchQueryRequest
+    sort (TenantSearchQuerySortRequest[]) — Sort field criteria.
+    filter (TenantFilter) — The tenant search filters.
+
+Responses:
+  200 TenantSearchQueryResult — The tenants search result
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-tenants.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-user-task-audit-logs.api.md

@@ -0,0 +1,26 @@
+# Search user task audit logs
+
+`POST /user-tasks/{userTaskKey}/audit-logs/search`
+
+Search for user task audit logs based on given criteria.
+
+- Added in Camunda 8.9.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  userTaskKey (path, string, required)
+
+Request body:
+  application/json: UserTaskAuditLogSearchQueryRequest
+    sort (AuditLogSearchQuerySortRequest[]) — Sort field criteria.
+    filter (UserTaskAuditLogFilter)
+
+Responses:
+  200 AuditLogSearchQueryResult — The user task audit log search result.
+  400 ProblemDetail — The provided data is not valid.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-user-task-audit-logs.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-user-task-effective-variables.api.md

@@ -0,0 +1,34 @@
+# Search user task effective variables
+
+`POST /user-tasks/{userTaskKey}/effective-variables/search`
+
+Search for the effective variables of a user task. This endpoint returns deduplicated
+variables where each variable name appears at most once. When the same variable name exists
+at multiple scope levels in the scope hierarchy, the value from the innermost scope (closest
+to the user task) takes precedence. This is useful for retrieving the actual runtime state
+of variables as seen by the user task. By default, long variable values in the response are
+truncated.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  userTaskKey (path, string, required)
+  truncateValues (query, boolean)
+
+Request body:
+  application/json: UserTaskEffectiveVariableSearchQueryRequest
+    page (OffsetPagination) — Pagination parameters.
+    sort (UserTaskVariableSearchQuerySortRequest[]) — Sort field criteria.
+    filter (UserTaskVariableFilter) — The user task variable search filters.
+
+Responses:
+  200 VariableSearchQueryResult — The user task effective variable search result.
+  400 ProblemDetail — The provided data is not valid.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-user-task-effective-variables.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-user-task-variables.api.md

@@ -0,0 +1,34 @@
+# Search user task variables
+
+`POST /user-tasks/{userTaskKey}/variables/search`
+
+Search for user task variables based on given criteria. This endpoint returns all variable
+documents visible from the user task's scope, including variables from parent scopes in the
+scope hierarchy. If the same variable name exists at multiple scope levels, each scope's
+variable is returned as a separate result. Use the
+`/user-tasks/{userTaskKey}/effective-variables/search` endpoint to get deduplicated variables
+where the innermost scope takes precedence. By default, long variable values in the response
+are truncated.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  userTaskKey (path, string, required)
+  truncateValues (query, boolean)
+
+Request body:
+  application/json: UserTaskVariableSearchQueryRequest
+    sort (UserTaskVariableSearchQuerySortRequest[]) — Sort field criteria.
+    filter (UserTaskVariableFilter) — The user task variable search filters.
+
+Responses:
+  200 VariableSearchQueryResult — The user task variable search result.
+  400 ProblemDetail — The provided data is not valid.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-user-task-variables.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-user-tasks.api.md

@@ -0,0 +1,25 @@
+# Search user tasks
+
+`POST /user-tasks/search`
+
+Search for user tasks based on given criteria.
+
+- Added in Camunda 8.6.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: UserTaskSearchQuery
+    sort (UserTaskSearchQuerySortRequest[]) — Sort field criteria.
+    filter (UserTaskFilter) — The user task search filters.
+
+Responses:
+  200 UserTaskSearchQueryResult — The user task search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-user-tasks.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-users-for-group.api.md

@@ -0,0 +1,29 @@
+# Search group users
+
+`POST /groups/{groupId}/users/search`
+
+Search users assigned to a group.
+
+- Required permissions: READ on GROUP.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  groupId (path, GroupId, required)
+
+Request body:
+  application/json: GroupUserSearchQueryRequest
+    sort (GroupUserSearchQuerySortRequest[]) — Sort field criteria.
+
+Responses:
+  200 GroupUserSearchResult — The users assigned to the group.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The group with the given ID was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-users-for-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-users-for-role.api.md

@@ -0,0 +1,29 @@
+# Search role users
+
+`POST /roles/{roleId}/users/search`
+
+Search users with assigned role.
+
+- Required permissions: READ on ROLE.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+
+Request body:
+  application/json: RoleUserSearchQueryRequest
+    sort (RoleUserSearchQuerySortRequest[]) — Sort field criteria.
+
+Responses:
+  200 RoleUserSearchResult — The users with the assigned role.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The role with the given ID was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-users-for-role.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-users-for-tenant.api.md

@@ -0,0 +1,24 @@
+# Search users for tenant
+
+`POST /tenants/{tenantId}/users/search`
+
+Retrieves a filtered and sorted list of users for a specified tenant.
+
+- Required permissions: READ on TENANT.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+
+Request body:
+  application/json: TenantUserSearchQueryRequest
+    sort (TenantUserSearchQuerySortRequest[]) — Sort field criteria.
+
+Responses:
+  200 TenantUserSearchResult — The search result of users for the tenant.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-users-for-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-users.api.md

@@ -0,0 +1,26 @@
+# Search users
+
+`POST /users/search`
+
+Search for users based on given criteria.
+
+- Required permissions: READ on USER.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: UserSearchQueryRequest
+    sort (UserSearchQuerySortRequest[]) — Sort field criteria.
+    filter (UserFilter) — The user search filters.
+
+Responses:
+  200 UserSearchResult — The user search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-users.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.search-variables.api.md

@@ -0,0 +1,37 @@
+# Search variables
+
+`POST /variables/search`
+
+Search for variables based on given criteria.
+
+This endpoint returns variables that exist directly at the specified scopes - it does not
+include variables from parent scopes that would be visible through the scope hierarchy.
+
+Variables can be process-level (scoped to the process instance) or local (scoped to specific
+BPMN elements like tasks, subprocesses, etc.).
+
+By default, long variable values in the response are truncated.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  truncateValues (query, boolean)
+
+Request body:
+  application/json: VariableSearchQuery
+    sort (VariableSearchQuerySortRequest[]) — Sort field criteria.
+    filter (VariableFilter) — The variable search filters.
+
+Responses:
+  200 VariableSearchQueryResult — The variable search result.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/search-variables.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.suspend-batch-operation.api.md

@@ -0,0 +1,29 @@
+# Suspend Batch operation
+
+`POST /batch-operations/{batchOperationKey}/suspension`
+
+Suspends a running batch operation.
+This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).
+
+- Required permissions: UPDATE on BATCH.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  batchOperationKey (path, BatchOperationKey, required)
+
+Request body:
+  application/json: 
+
+Responses:
+  204 — The batch operation pause request was created.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The batch operation was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/suspend-batch-operation.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.suspend-process-instance.api.md

@@ -0,0 +1,30 @@
+# Suspend process instance
+
+`POST /process-instances/{processInstanceKey}/suspension`
+
+Suspends a running process instance, pausing further processing until it is resumed.
+Only process instances in the ACTIVE state can be suspended.
+
+- Required permissions: SUSPEND_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processInstanceKey (path, string, required)
+
+Request body:
+  application/json: SuspendProcessInstanceRequest
+    operationReference (OperationReference)
+
+Responses:
+  204 — The process instance is suspended.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The process instance is not found.
+  409 ProblemDetail — The process instance is not in the ACTIVE state and cannot be suspended. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains `RESOURCE_EXHAUSTED`. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/suspend-process-instance.api