Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions api/camunda/v2/batch-operations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,18 @@ components:
errorMessage:
description: the error message from the engine in case of a failed operation.
type: string
DecisionInstanceDeletionBatchOperationRequest:
type: object
description: The decision instance filter that defines which decision instances should be deleted.
properties:
filter:
allOf:
- $ref: "decision-instances.yaml#/components/schemas/DecisionInstanceFilter"
description: The decision instance filter.
operationReference:
$ref: "keys.yaml#/components/schemas/OperationReference"
required:
- filter
ProcessInstanceCancellationBatchOperationRequest:
type: object
description: The process instance filter that defines which process instances should be canceled.
Expand Down Expand Up @@ -598,6 +610,7 @@ components:
- ADD_VARIABLE
- CANCEL_PROCESS_INSTANCE
- DELETE_DECISION_DEFINITION
- DELETE_DECISION_INSTANCE
- DELETE_PROCESS_DEFINITION
- DELETE_PROCESS_INSTANCE
- MIGRATE_PROCESS_INSTANCE
Expand Down
4 changes: 4 additions & 0 deletions api/camunda/v2/camunda-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ paths:
$ref: "decision-instances.yaml#/paths/~1decision-instances~1search"
/decision-instances/{decisionEvaluationInstanceKey}:
$ref: "decision-instances.yaml#/paths/~1decision-instances~1{decisionEvaluationInstanceKey}"
/decision-instances/{decisionInstanceKey}/deletion:
$ref: "decision-instances.yaml#/paths/~1decision-instances~1{decisionInstanceKey}~1deletion"
/decision-instances/deletion:
$ref: "decision-instances.yaml#/paths/~1decision-instances~1deletion"
/decision-requirements/search:
$ref: "decision-requirements.yaml#/paths/~1decision-requirements~1search"
/decision-requirements/{decisionRequirementsKey}:
Expand Down
94 changes: 94 additions & 0 deletions api/camunda/v2/decision-instances.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,94 @@ paths:
$ref: "problem-detail.yaml#/components/schemas/ProblemDetail"
"500":
$ref: "common-responses.yaml#/components/responses/InternalServerError"
/decision-instances/{decisionInstanceKey}/deletion:
post:
tags:
- Decision instance
operationId: deleteDecisionInstance
summary: Delete decision instance
description: |-


[[CONSISTENCY:EVENTUAL]]

Delete all associated decision evaluations based on provided key.
parameters:
- name: decisionInstanceKey
in: path
required: true
description: The key of the decision instance to delete.
schema:
type: string
format: string<DecisionInstanceKey>
example: "22517998136843567"
description: System-generated key for a deployed decision instance.
requestBody:
required: false
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteDecisionInstanceRequest"
responses:
"200":
description: The operation to delete the decision instance was created.
content:
application/json:
schema:
$ref: "batch-operations.yaml#/components/schemas/BatchOperationCreatedResult"
"401":
$ref: "common-responses.yaml#/components/responses/Unauthorized"
"403":
$ref: "common-responses.yaml#/components/responses/Forbidden"
"404":
description: The decision instance is not found.
content:
application/problem+json:
schema:
$ref: "problem-detail.yaml#/components/schemas/ProblemDetail"
"500":
$ref: "common-responses.yaml#/components/responses/InternalServerError"
"503":
$ref: "common-responses.yaml#/components/responses/ServiceUnavailable"
/decision-instances/deletion:
post:
tags:
- Decision instance
operationId: deleteDecisionInstancesBatchOperation
summary: Delete decision instances (batch)
description: |


[[CONSISTENCY:EVENTUAL]]

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}).
requestBody:
required: true
content:
application/json:
schema:
$ref: "batch-operations.yaml#/components/schemas/DecisionInstanceDeletionBatchOperationRequest"
responses:
"200":
description: The batch operation request was created.
content:
application/json:
schema:
$ref: "batch-operations.yaml#/components/schemas/BatchOperationCreatedResult"
"400":
description: |
The decision instance batch operation failed. More details are provided in the response body.
content:
application/problem+json:
schema:
$ref: "problem-detail.yaml#/components/schemas/ProblemDetail"
"401":
$ref: "common-responses.yaml#/components/responses/Unauthorized"
"403":
$ref: "common-responses.yaml#/components/responses/Forbidden"
"500":
$ref: "common-responses.yaml#/components/responses/InternalServerError"
components:
schemas:
DecisionInstanceSearchQuerySortRequest:
Expand Down Expand Up @@ -179,6 +267,12 @@ components:
description: The key of the root decision definition.
allOf:
- $ref: "keys.yaml#/components/schemas/DecisionDefinitionKeyFilterProperty"
DeleteDecisionInstanceRequest:
type: object
nullable: true
properties:
operationReference:
$ref: "keys.yaml#/components/schemas/OperationReference"
DecisionInstanceSearchQueryResult:
type: object
allOf:
Expand Down
1 change: 0 additions & 1 deletion api/camunda/v2/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,6 @@ components:
description: The new description of the group.
required:
- name
- description
GroupUpdateResult:
type: object
properties:
Expand Down
82 changes: 33 additions & 49 deletions api/camunda/v2/job-metrics.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
paths:
/jobs/statistics/global:
post:
get:
tags:
- Job metrics
- Job
operationId: getGlobalJobStatistics
summary: Global job statistics
description: |
Expand All @@ -11,12 +11,32 @@ paths:
[[CONSISTENCY:EVENTUAL]]

Returns global aggregated counts for jobs. Optionally filter by the creation time window and/or jobType.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GlobalJobStatisticsQuery"
parameters:
- name: from
in: query
required: true
description: |
Start of the time window to filter metrics. ISO 8601 date-time format.
schema:
type: string
format: date-time
example: "2024-07-28T15:51:28.071Z"
- name: to
in: query
required: true
description: |
End of the time window to filter metrics. ISO 8601 date-time format.
schema:
type: string
format: date-time
example: "2024-07-29T15:51:28.071Z"
- name: jobType
in: query
required: false
description: Optional job type to limit the aggregation to a single job type.
schema:
type: string
example: fetch-customer-data
responses:
"200":
description: Global job metrics
Expand All @@ -34,61 +54,25 @@ paths:
$ref: "common-responses.yaml#/components/responses/InternalServerError"
components:
schemas:
GlobalJobStatisticsQuery:
type: object
required:
- filter
properties:
filter:
$ref: "#/components/schemas/GlobalJobStatisticsFilter"
GlobalJobStatisticsFilter:
description: Filters for global job statistics query.
type: object
required:
- from
- to
properties:
from:
description: |
Start of the time window to filter metrics. ISO 8601 date-time format.
type: string
format: date-time
example: "2024-07-28T15:51:28.071Z"
to:
description: |
End of the time window to filter metrics. ISO 8601 date-time format.
type: string
format: date-time
example: "2024-07-29T15:51:28.071Z"
jobType:
description: Optional job type to limit the aggregation to a single job type.
type: string
example: fetch-customer-data
GlobalJobStatisticsQueryResult:
description: Global job statistics query result.
type: object
required:
- items
properties:
items:
description: List of aggregated job statistics.
type: array
items:
$ref: "#/components/schemas/GlobalJobStatisticsItem"
GlobalJobStatisticsItem:
description: Aggregated job metrics for a time bucket.
type: object
required:
- created
- completed
- failed
- isIncomplete
properties:
created:
$ref: "#/components/schemas/StatusMetric"
completed:
$ref: "#/components/schemas/StatusMetric"
failed:
$ref: "#/components/schemas/StatusMetric"
isIncomplete:
description: True if some data is missing because internal limits were reached and some metrics were not recorded.
type: boolean
example: false
StatusMetric:
description: Metric for a single job status.
type: object
Expand Down
1 change: 0 additions & 1 deletion api/camunda/v2/roles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,6 @@ components:
description: The description of the new role.
required:
- name
- description
RoleUpdateResult:
type: object
properties:
Expand Down
1 change: 0 additions & 1 deletion api/camunda/v2/tenants.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -822,7 +822,6 @@ components:
description: The new description of the tenant.
required:
- name
- description
TenantUpdateResult:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: activate-ad-hoc-sub-process-activities
title: "Activate activities within an ad-hoc sub-process"
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
description: "<MarkerStronglyConsistentExtension />"
sidebar_label: "Activate activities within an ad-hoc sub-process"
hide_title: true
hide_table_of_contents: true
Expand All @@ -21,6 +21,7 @@ import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";

<Heading
as={"h1"}
Expand All @@ -36,19 +37,15 @@ import Heading from "@theme/Heading";
context={"endpoint"}
></MethodEndpoint>

<MarkerStronglyConsistentExtension /> [Learn about endpoint
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
<MarkerStronglyConsistentExtension />

Activates selected activities within an ad-hoc sub-process identified by element ID.
The provided element IDs must exist within the ad-hoc sub-process instance identified by the
provided adHocSubProcessInstanceKey.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
></Heading>
<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"}>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>

<ParamsDetails
parameters={[
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: activate-jobs
title: "Activate jobs"
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
description: "<MarkerStronglyConsistentExtension />"
sidebar_label: "Activate jobs"
hide_title: true
hide_table_of_contents: true
Expand All @@ -21,6 +21,7 @@ import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";

<Heading
as={"h1"}
Expand All @@ -34,17 +35,13 @@ import Heading from "@theme/Heading";
context={"endpoint"}
></MethodEndpoint>

<MarkerStronglyConsistentExtension /> [Learn about endpoint
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
<MarkerStronglyConsistentExtension />

Iterate through all known partitions and activate jobs up to the requested maximum.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
></Heading>
<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"}>
<Translate id="theme.openapi.request.title">Request</Translate>
</Heading>

<ParamsDetails parameters={undefined}></ParamsDetails>

Expand Down
Loading
Loading