@bpmnkit/camunda-docspack 0.0.0

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.create-mapping-rule.api.md

@@ -0,0 +1,26 @@
+# Create mapping rule
+
+`POST /mapping-rules`
+
+Create a new mapping rule
+
+- Required permissions: CREATE on MAPPING_RULE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: MappingRuleCreateRequest
+    mappingRuleId (MappingRuleId, required) — The unique ID of the mapping rule.
+
+Responses:
+  201 MappingRuleCreateResult — The mapping rule was created successfully.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — The request to create a mapping rule was denied. More details are provided in the response body.
+  404 ProblemDetail — The request to create a mapping rule was denied.
+  409 ProblemDetail — Mapping rule with this id already exists.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/create-mapping-rule.api

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

@@ -0,0 +1,30 @@
+# Create process instance
+
+`POST /process-instances`
+
+Creates and starts an instance of the specified process.
+The process definition to use to create the instance can be specified either using its unique key
+(as returned by Deploy resources), or using the BPMN process id and a version.
+
+Waits for the completion of the process instance before returning a result
+when awaitCompletion is enabled.
+
+- Required permissions: CREATE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ProcessInstanceCreationInstruction (required)
+
+Responses:
+  200 CreateProcessInstanceResult — The process instance was created.
+  400 ProblemDetail — The provided data is not valid.
+  409 ProblemDetail — The process instance creation was rejected due to a business ID uniqueness conflict. This can happen only when Business ID Uniqueness Control is enabled and an active root process instance with the provided business ID already exists for the same process definition and tenant.
+  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 .
+  504 ProblemDetail — The process instance creation request timed out in the gateway. This can happen if the `awaitCompletion` request parameter is set to `true` and the created process instance did not complete within the defined request timeout. This often happens when the created instance is not fully automated or contains wait states.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/create-process-instance.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.create-role.api.md

@@ -0,0 +1,29 @@
+# Create role
+
+`POST /roles`
+
+Create a new role.
+
+- Required permissions: CREATE on ROLE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: RoleCreateRequest
+    roleId (RoleId, required) — The ID of the new role.
+    name (string, required) — The display name of the new role.
+    description (string) — The description of the new role.
+
+Responses:
+  201 RoleCreateResult — The role was created successfully.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  409 ProblemDetail — Role with this id already exists.
+  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/create-role.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.create-tenant-cluster-variable.api.md

@@ -0,0 +1,33 @@
+# Create a tenant-scoped cluster variable
+
+`POST /cluster-variables/tenants/{tenantId}`
+
+Create a new cluster variable for the given tenant.
+
+- Required permissions: CREATE on CLUSTER_VARIABLE.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+
+Request body:
+  application/json: CreateClusterVariableRequest (required)
+    name (ClusterVariableName, required) — The name of the cluster variable. Must be unique within its scope (global or tenant-specific).
+    value (object, required) — The value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses.
+    metadata (object) — A generic key-value metadata bag attached to the cluster variable. Values must be strings or numbers. Limited to 100 entries and a configurable maximum…
+    kind (ClusterVariableKindEnum) — The kind of the cluster variable. Defaults to JSON if not specified.
+
+Responses:
+  200 ClusterVariableResult — Cluster variable created
+  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 tenant with the given ID was not found.
+  409 ProblemDetail — A cluster variable with this name already exists for the given tenant.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/create-tenant-cluster-variable.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.create-tenant.api.md

@@ -0,0 +1,29 @@
+# Create tenant
+
+`POST /tenants`
+
+Creates a new tenant.
+
+- Required permissions: CREATE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: TenantCreateRequest (required)
+    tenantId (TenantId, required) — The unique ID for the tenant. Must be 31 characters or less and match `^[\w.-]{1,31} (word characters, `.`, `-`). The literal `<default>` is also accepted as…
+    name (string, required) — The name of the tenant.
+    description (string) — The description of the tenant.
+
+Responses:
+  201 TenantCreateResult — The tenant was created successfully.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The resource was not found.
+  409 ProblemDetail — Tenant with this id already exists.
+  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/create-tenant.api

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

@@ -0,0 +1,30 @@
+# Create user
+
+`POST /users`
+
+Create a new user.
+
+- Required permissions: CREATE on USER.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: UserRequest (required)
+    password (string, required) — The password of the user.
+    username (Username, required) — The username of the new user.
+    name (string) — The name of the user.
+    email (string) — The email of the user.
+
+Responses:
+  201 UserCreateResult — The user was created successfully.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  409 ProblemDetail — A user with this username already exists.
+  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/create-user.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-authorization.api.md

@@ -0,0 +1,24 @@
+# Delete authorization
+
+`DELETE /authorizations/{authorizationKey}`
+
+Deletes the authorization with the given key.
+
+- Required permissions: DELETE on AUTHORIZATION.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  authorizationKey (path, AuthorizationKey, required)
+
+Responses:
+  204 — The authorization was deleted successfully.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  404 ProblemDetail — The authorization with the authorizationKey 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/delete-authorization.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-decision-instance.api.md

@@ -0,0 +1,29 @@
+# Delete decision instance
+
+`POST /decision-instances/{decisionEvaluationKey}/deletion`
+
+Delete all associated decision evaluations based on provided key.
+
+- Required permissions: DELETE_DECISION_INSTANCE on DECISION_DEFINITION.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  decisionEvaluationKey (path, string, required)
+
+Request body:
+  application/json: DeleteDecisionInstanceRequest
+    operationReference (OperationReference)
+
+Responses:
+  204 — The decision instance is marked for deletion.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The decision instance is 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/delete-decision-instance.api

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

@@ -0,0 +1,26 @@
+# Delete decision instances (batch)
+
+`POST /decision-instances/deletion`
+
+Delete multiple decision instances. This will delete the historic data from secondary storage.
+This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
+
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: DecisionInstanceDeletionBatchOperationRequest (required)
+    filter (DecisionInstanceFilter, required) — The decision instance filter.
+    operationReference (OperationReference)
+
+Responses:
+  200 BatchOperationCreatedResult — The batch operation request was created.
+  400 ProblemDetail — The decision instance batch operation failed. More details are provided in the response body.
+  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/delete-decision-instances-batch-operation.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-document.api.md

@@ -0,0 +1,25 @@
+# Delete document
+
+`DELETE /documents/{documentId}`
+
+Delete a document from the Camunda 8 cluster.
+
+Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
+
+- Required permissions: DELETE on DOCUMENT.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  documentId (path, DocumentId, required)
+  storeId (query, string)
+
+Responses:
+  204 — The document was deleted successfully.
+  404 ProblemDetail — The document 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/delete-document.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-global-cluster-variable.api.md

@@ -0,0 +1,25 @@
+# Delete a global-scoped cluster variable
+
+`DELETE /cluster-variables/global/{name}`
+
+Delete a global-scoped cluster variable.
+
+- Required permissions: DELETE on CLUSTER_VARIABLE.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  name (path, ClusterVariableName, required)
+
+Responses:
+  204 — Cluster variable deleted successfully
+  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 — Cluster variable 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/delete-global-cluster-variable.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-global-task-listener.api.md

@@ -0,0 +1,26 @@
+# Delete global user task listener
+
+`DELETE /global-task-listeners/{id}`
+
+Deletes a global user task listener.
+
+- Required permissions: DELETE_TASK_LISTENER on GLOBAL_LISTENER.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  id (path, GlobalListenerId, required)
+
+Responses:
+  204 — The global listener was deleted successfully.
+  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 global user task listener 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/delete-global-task-listener.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-group.api.md

@@ -0,0 +1,24 @@
+# Delete group
+
+`DELETE /groups/{groupId}`
+
+Deletes the group with the given ID.
+
+- Required permissions: DELETE on GROUP.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  groupId (path, GroupId, required)
+
+Responses:
+  204 — The group was deleted successfully.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  404 ProblemDetail — The group with the given ID 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/delete-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-history-backup.api.md

@@ -0,0 +1,28 @@
+# Delete history backup
+
+`DELETE /backups/history/{backupId}`
+
+Deletes the history backup with the given id, by deleting every snapshot that makes it
+up.
+
+Only available on clusters whose secondary storage is Elasticsearch or OpenSearch.
+
+- Required permissions: DELETE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  backupId (path, BackupId, required)
+
+Responses:
+  204 — The backup has been successfully deleted.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — The request is forbidden, either because the authenticated caller lacks the required `BACKUP` permission, or because the cluster's secondary storage is neither Elasticsearch nor OpenSearch and therefore cannot serve history backups. The problem detail says which of the two applies.
+  404 ProblemDetail — A backup with the given id does not exist.
+  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/delete-history-backup.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-mapping-rule.api.md

@@ -0,0 +1,24 @@
+# Delete a mapping rule
+
+`DELETE /mapping-rules/{mappingRuleId}`
+
+Deletes the mapping rule with the given ID.
+
+- Required permissions: DELETE on MAPPING_RULE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  mappingRuleId (path, MappingRuleId, required)
+
+Responses:
+  204 — The mapping rule was deleted successfully.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  404 ProblemDetail — The mapping rule with the mappingRuleId 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/delete-mapping-rule.api

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

@@ -0,0 +1,30 @@
+# Delete process instance
+
+`POST /process-instances/{processInstanceKey}/deletion`
+
+Deletes a process instance. Only instances that are completed or terminated can be deleted.
+
+- Required permissions: DELETE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processInstanceKey (path, string, required)
+
+Request body:
+  application/json: DeleteProcessInstanceRequest
+    operationReference (OperationReference)
+
+Responses:
+  204 — The process instance is marked for deletion.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The process instance is not found.
+  409 ProblemDetail — The process instance is not in a completed or terminated state and cannot be deleted.
+  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/delete-process-instance.api

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

@@ -0,0 +1,27 @@
+# Delete process instances (batch)
+
+`POST /process-instances/deletion`
+
+Delete multiple process instances. This will delete the historic data from secondary storage.
+Only process instances in a final state (COMPLETED or TERMINATED) can be deleted.
+This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
+
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ProcessInstanceDeletionBatchOperationRequest (required)
+    filter (ProcessInstanceFilter, required) — The process instance filter.
+    operationReference (OperationReference)
+
+Responses:
+  200 BatchOperationCreatedResult — The batch operation request was created.
+  400 ProblemDetail — The process instance batch operation failed. More details are provided in the response body.
+  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/delete-process-instances-batch-operation.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-resource.api.md

@@ -0,0 +1,45 @@
+# Delete resource
+
+`POST /resources/{resourceKey}/deletion`
+
+Deletes a deployed resource. This can be a process definition, decision requirements
+definition, or form definition deployed using the deploy resources endpoint. Specify the
+resource you want to delete in the `resourceKey` parameter.
+
+Once a resource has been deleted it cannot be recovered. If the resource needs to be
+available again, a new deployment of the resource is required.
+
+By default, only the resource itself is deleted from the runtime state. To also delete the
+historic data associated with a resource, set the `deleteHistory` flag in the request body
+to `true`. History deletion is supported for process definitions and decision requirements
+definitions; for other resource types (forms, generic resources) the flag is ignored and no
+history is deleted.
+
+The two supported types differ in how the history is removed. For a decision requirements
+definition the history is deleted asynchronously via a batch operation whose details are
+returned in the `batchOperation` field of the response. For a process definition the
+definition first drains its running instances and its history is deleted asynchronously once
+the definition is fully removed cluster-wide; no batch operation is returned in the response.
+
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  resourceKey (path, ResourceKey, required)
+
+Request body:
+  application/json: DeleteResourceRequest
+    operationReference (OperationReference)
+    deleteHistory (boolean) — Indicates if the historic data associated with the resource should also be deleted asynchronously. This flag is effective for process definitions and decision…
+
+Responses:
+  200 DeleteResourceResponse — The resource is deleted.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The resource is 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/delete-resource.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-role.api.md

@@ -0,0 +1,24 @@
+# Delete role
+
+`DELETE /roles/{roleId}`
+
+Deletes the role with the given ID.
+
+- Required permissions: DELETE on ROLE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+
+Responses:
+  204 — The role was deleted successfully.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  404 ProblemDetail — The role with the ID 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/delete-role.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-runtime-backup-state.api.md

@@ -0,0 +1,23 @@
+# Delete runtime backup state
+
+`DELETE /backups/runtime/state`
+
+Resets the runtime backup state of every partition of the physical tenant, clearing
+all checkpoint info, backup info, checkpoint metadata, and backup ranges. Used when
+switching backup stores.
+
+- Required permissions: DELETE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  204 — The runtime backup state has been successfully reset.
+  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.
+  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/delete-runtime-backup-state.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-runtime-backup.api.md

@@ -0,0 +1,24 @@
+# Delete runtime backup
+
+`DELETE /backups/runtime/{backupId}`
+
+Deletes the runtime backup with the given id.
+
+- Required permissions: DELETE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  backupId (path, BackupId, required)
+
+Responses:
+  204 — The backup has been successfully deleted.
+  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.
+  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/delete-runtime-backup.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.delete-tenant-cluster-variable.api.md

@@ -0,0 +1,26 @@
+# Delete a tenant-scoped cluster variable
+
+`DELETE /cluster-variables/tenants/{tenantId}/{name}`
+
+Delete a tenant-scoped cluster variable.
+
+- Required permissions: DELETE on CLUSTER_VARIABLE.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  name (path, ClusterVariableName, required)
+
+Responses:
+  204 — Cluster variable deleted successfully
+  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 — Cluster variable 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/delete-tenant-cluster-variable.api