@bpmnkit/camunda-docspack 0.0.0

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

@@ -0,0 +1,25 @@
+# Delete tenant
+
+`DELETE /tenants/{tenantId}`
+
+Deletes an existing tenant.
+
+- Required permissions: DELETE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+
+Responses:
+  204 — The tenant was deleted successfully.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The tenant 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-tenant.api

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

@@ -0,0 +1,24 @@
+# Delete user
+
+`DELETE /users/{username}`
+
+Deletes a user.
+
+- Required permissions: DELETE on USER.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  username (path, Username, required)
+
+Responses:
+  204 — The user was deleted successfully.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The user 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-user.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.evaluate-conditionals.api.md

@@ -0,0 +1,30 @@
+# Evaluate root level conditional start events
+
+`POST /conditionals/evaluation`
+
+Evaluates root-level conditional start events for process definitions.
+If the evaluation is successful, it will return the keys of all created process instances, along with their associated process definition key.
+Multiple root-level conditional start events of the same process definition can trigger if their conditions evaluate to true.
+
+- Required permissions: CREATE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ConditionalEvaluationInstruction (required)
+    tenantId (TenantId) — Used to evaluate root-level conditional start events for a tenant with the given ID. This will only evaluate root-level conditional start events of process…
+    processDefinitionKey (ProcessDefinitionKey) — Used to evaluate root-level conditional start events of the process definition with the given key.
+    variables (object, required) — JSON object representing the variables to use for evaluation of the conditions and to pass to the process instances that have been triggered.
+
+Responses:
+  200 EvaluateConditionalResult — Successfully evaluated root-level conditional start events.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — The client is not authorized to start process instances for the specified process definition. If a processDefinitionKey is not provided, this indicates that the client is not authorized to start process instances for at least one of the matched process definitions.
+  404 ProblemDetail — The process definition was not found for the given processDefinitionKey.
+  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/evaluate-conditionals.api

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

@@ -0,0 +1,27 @@
+# Evaluate decision
+
+`POST /decision-definitions/evaluation`
+
+Evaluates a decision.
+You specify the decision to evaluate either by using its unique key (as returned by
+DeployResource), or using the decision ID. When using the decision ID, the latest deployed
+version of the decision is used.
+
+- Required permissions: CREATE_DECISION_INSTANCE on DECISION_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: DecisionEvaluationInstruction (required)
+
+Responses:
+  200 EvaluateDecisionResult — The decision was evaluated.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The decision 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/evaluate-decision.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.evaluate-expression.api.md

@@ -0,0 +1,57 @@
+# Evaluate an expression
+
+`POST /expression/evaluation`
+
+Evaluates a FEEL expression and returns the result. Supports references to tenant scoped
+cluster variables when a tenant ID is provided. Optionally, provide a `scopeKey` to make the
+variables of a specific process instance or element instance visible while evaluating the
+expression.
+
+When the expression references a secret (`camunda.secrets.<name>`), the endpoint never
+returns the resolved secret value. Instead, each reference resolves to its own literal
+placeholder text `camunda.secrets.<name>`, which composes like any other string. This
+changed in 8.10; previously such references evaluated to `null` and logged a warning:
+
+- `=camunda.secrets.TEST` now returns `"camunda.secrets.TEST"`.
+- `="Bearer " + camunda.secrets.TEST` now returns `"Bearer camunda.secrets.TEST"`.
+
+This placeholder mechanism is bypassed if the request-body `variables` include a variable
+literally named `camunda`. In that case the request-body variable takes precedence, so
+`camunda.secrets.<name>` resolves against it instead of producing a placeholder (typically
+evaluating to `null`).
+
+Every secret reference the evaluation encountered from a trusted source is listed in the
+`referencedSecrets` array of the response. That array reports every `camunda.secrets.<name>`
+name that was referenced, whether or not a matching secret is configured: a misspelled or
+unconfigured name is still listed here and only surfaces as an error later, in the `errors`
+array of the follow-up `POST /v2/secrets/resolve` call. To obtain the actual secret values,
+resolve those references yourself with that endpoint
+([`POST /v2/secrets/resolve`](/apis-tools/orchestration-cluster-api-rest/specifications/resolve-secrets.api.mdx)).
+
+For background on how the cluster resolves secret references in other contexts, such as
+during job activation, see
+[Secret resolution and job activation](/components/concepts/secret-resolution-and-job-activation.md).
+That page describes a different mechanism than this endpoint uses.
+
+- Added in Camunda 8.9.
+- Required permissions: EVALUATE on EXPRESSION.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ExpressionEvaluationRequest (required)
+    expression (string, required) — The expression to evaluate (e.g., "=x + y")
+    tenantId (string) — Required when the expression references tenant-scoped cluster variables
+    scopeKey (ScopeKey) — Key of the process instance or element instance whose variables should be made visible to the expression. Use a process instance key to evaluate against the…
+    variables (object) — Optional variables for expression evaluation. These variables are only used for the current evaluation and do not persist beyond it.
+
+Responses:
+  200 ExpressionEvaluationResult — Expression evaluated 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.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/evaluate-expression.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.fail-job.api.md

@@ -0,0 +1,33 @@
+# Fail job
+
+`POST /jobs/{jobKey}/failure`
+
+Mark the job as failed.
+
+- Required permissions: UPDATE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  jobKey (path, string, required)
+
+Request body:
+  application/json: JobFailRequest
+    retries (integer) — The amount of retries the job should have left
+    errorMessage (string) — An optional error message describing why the job failed; if not provided, an empty string is used.
+    retryBackOff (integer) — An optional retry back off for the failed job. The job will not be retryable before the current time plus the back off time. The default is 0 which means the…
+    variables (object) — JSON object that will instantiate the variables at the local scope of the job's associated task.
+    leaseToken (string) — The token identifying a leased job's activation, obtained from `ActivatedJobResult.leaseToken`. For a leased job, the matching token must be supplied to prove…
+
+Responses:
+  204 — The job is failed.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The job with the given jobKey is not found. It was completed by another worker, or the process instance itself was canceled.
+  409 ProblemDetail — The job with the given key is in the wrong state (i.e: not ACTIVATED or ACTIVATABLE). The job was failed by another worker with retries = 0, and the process is now in an incident state.
+  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/fail-job.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-agent-definition.api.md

@@ -0,0 +1,25 @@
+# Get agent definition
+
+`GET /agent-definitions/{agentDefinitionKey}`
+
+Returns an agent definition by key.
+
+- Required permissions: READ_PROCESS_DEFINITION on PROCESS_DEFINITION.
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  agentDefinitionKey (path, string, required)
+
+Responses:
+  200 AgentDefinitionResult — The agent definition is successfully returned.
+  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 agent definition with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-agent-definition.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-agent-instance.api.md

@@ -0,0 +1,26 @@
+# Get agent instance
+
+`GET /agent-instances/{agentInstanceKey}`
+
+Returns agent instance as JSON.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  agentInstanceKey (path, string, required)
+
+Responses:
+  200 AgentInstanceResult — The agent instance is successfully returned.
+  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 agent instance with the given key was not found. 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/get-agent-instance.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-audit-log.api.md

@@ -0,0 +1,24 @@
+# Get audit log
+
+`GET /audit-logs/{auditLogKey}`
+
+Get an audit log entry by auditLogKey.
+
+- Required permissions: READ on AUDIT_LOG.
+- Added in Camunda 8.9.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  auditLogKey (path, string, required)
+
+Responses:
+  200 AuditLogResult — The audit log entry is successfully returned.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The audit log 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/get-audit-log.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-authentication.api.md

@@ -0,0 +1,19 @@
+# Get current user
+
+`GET /authentication/me`
+
+Retrieves the current authenticated user.
+
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth
+
+Responses:
+  200 CamundaUserResult — The current user is successfully returned.
+  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/get-authentication.api

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

@@ -0,0 +1,24 @@
+# Get authorization
+
+`GET /authorizations/{authorizationKey}`
+
+Get authorization by the given key.
+
+- Required permissions: READ on AUTHORIZATION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  authorizationKey (path, AuthorizationKey, required)
+
+Responses:
+  200 AuthorizationResult — The authorization was successfully returned.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The authorization 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/get-authorization.api

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

@@ -0,0 +1,23 @@
+# Get batch operation
+
+`GET /batch-operations/{batchOperationKey}`
+
+Get batch operation by key.
+
+- Required permissions: READ on BATCH.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  batchOperationKey (path, BatchOperationKey, required)
+
+Responses:
+  200 BatchOperationResponse — The batch operation was found.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The batch operation is 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/get-batch-operation.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-cluster-status.api.md

@@ -0,0 +1,17 @@
+# Get the status of the whole cluster
+
+`GET /cluster/v2/status`
+
+Checks the health status of the whole cluster, aggregated over all physical tenants. Returns `HEALTHY` when every physical tenant is healthy, `DOWN` when no physical tenant can process work, and `DEGRADED` in every other case. No per-tenant detail is reported; use `GET /cluster/v2/topology` for that.
+
+This endpoint is public and requires no authentication, unlike `PATCH /cluster/v2/mode` below, which needs cluster-admin credentials.
+
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Responses:
+  200 ClusterStatusResponse — The cluster can process work; the body reports whether it is fully healthy or degraded.
+  503 ClusterStatusResponse — The cluster is DOWN because no physical tenant can process work.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-cluster-status.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-cluster-topology.api.md

@@ -0,0 +1,21 @@
+# Get the topology of the whole cluster
+
+`GET /cluster/v2/topology`
+
+Obtains the topology of the whole cluster, aggregated over all physical tenants. Cluster-level information is reported once; partition layout, replication and per-partition role, health and state are reported per physical tenant.
+
+Requires the cluster-admin security chain. Although this operation lists `bearerAuth` / `basicAuth` like the rest of the Orchestration Cluster API, it does not accept an Orchestration Cluster user's credentials — only the separate cluster-admin credentials are valid here. Use `GET /v2/topology` for the topology of a single physical tenant.
+
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 ClusterTopologyResponse — The topology of the whole cluster, aggregated over all physical tenants.
+  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/get-cluster-topology.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-decision-definition-xml.api.md

@@ -0,0 +1,25 @@
+# Get decision definition XML
+
+`GET /decision-definitions/{decisionDefinitionKey}/xml`
+
+Returns decision definition as XML.
+
+- Required permissions: READ_DECISION_DEFINITION on DECISION_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  decisionDefinitionKey (path, string, required)
+
+Responses:
+  200 string — The XML of the decision definition is successfully returned.
+  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 decision definition with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-definition-xml.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-decision-definition.api.md

@@ -0,0 +1,25 @@
+# Get decision definition
+
+`GET /decision-definitions/{decisionDefinitionKey}`
+
+Returns a decision definition by key.
+
+- Required permissions: READ_DECISION_DEFINITION on DECISION_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  decisionDefinitionKey (path, string, required)
+
+Responses:
+  200 DecisionDefinitionResult — The decision definition is successfully returned.
+  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 decision definition with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-definition.api

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

@@ -0,0 +1,25 @@
+# Get decision instance
+
+`GET /decision-instances/{decisionEvaluationInstanceKey}`
+
+Returns a decision instance.
+
+- Required permissions: READ_DECISION_INSTANCE on DECISION_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  decisionEvaluationInstanceKey (path, DecisionEvaluationInstanceKey, required)
+
+Responses:
+  200 DecisionInstanceGetQueryResult — The decision instance is successfully returned.
+  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 decision instance with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-instance.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-decision-requirements-xml.api.md

@@ -0,0 +1,25 @@
+# Get decision requirements XML
+
+`GET /decision-requirements/{decisionRequirementsKey}/xml`
+
+Returns decision requirements as XML.
+
+- Required permissions: READ on DECISION_REQUIREMENTS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  decisionRequirementsKey (path, string, required)
+
+Responses:
+  200 string — The XML of the decision requirements is successfully returned.
+  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 decision requirements with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-requirements-xml.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-decision-requirements.api.md

@@ -0,0 +1,25 @@
+# Get decision requirements
+
+`GET /decision-requirements/{decisionRequirementsKey}`
+
+Returns Decision Requirements as JSON.
+
+- Required permissions: READ on DECISION_REQUIREMENTS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  decisionRequirementsKey (path, string, required)
+
+Responses:
+  200 DecisionRequirementsResult — The decision requirements is successfully returned.
+  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 decision requirements with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-requirements.api

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

@@ -0,0 +1,26 @@
+# Download document
+
+`GET /documents/{documentId}`
+
+Download 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: READ on DOCUMENT.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  documentId (path, DocumentId, required)
+  storeId (query, string)
+  contentHash (query, string)
+
+Responses:
+  200 string — The document was downloaded 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/get-document.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-element-instance.api.md

@@ -0,0 +1,25 @@
+# Get element instance
+
+`GET /element-instances/{elementInstanceKey}`
+
+Returns element instance as JSON.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  elementInstanceKey (path, string, required)
+
+Responses:
+  200 ElementInstanceResult — The element instance is successfully returned.
+  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 element instance with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-element-instance.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-exporting-status.api.md

@@ -0,0 +1,27 @@
+# Get exporting status
+
+`GET /exporting`
+
+Returns the exporting status of the physical tenant, aggregated over every replica of
+every one of its partitions.
+
+Because pause and resume are applied to all replicas, the status is only a single phase
+if every replica reports that phase; otherwise it is `MIXED`, which means a pause or
+resume is still in flight or was only partially applied. Backup tooling should treat
+only `PAUSED` and `SOFT_PAUSED` as confirmation that exporting is paused.
+
+- Required permissions: PAUSE on EXPORTER.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 ExportingStatusResponse — The current exporting status of the physical tenant.
+  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/get-exporting-status.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-form-by-key.api.md

@@ -0,0 +1,25 @@
+# Get form by key
+
+`GET /forms/{formKey}`
+
+Get a form by its unique form key.
+
+- Required permissions: READ on RESOURCE.
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  formKey (path, string, required)
+
+Responses:
+  200 FormResult — The form is successfully returned.
+  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 form 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/get-form-by-key.api