Update camunda REST API doc

api/camunda/camunda-openapi.yaml

@@ -693,6 +693,49 @@ paths:
  schema:
  $ref: "#/components/schemas/ProblemDetail"
 
+ /variables/search:
+ post:
+ tags:
+ - Variable
+ summary: Query process and local variables (alpha)
+ description: |
+ Search for variables based on given criteria.
+
+ :::note
+ This endpoint is an alpha feature and not enabled on Camunda clusters out of the box.
+ See the [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
+ for further details.
+ :::
+ requestBody:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/VariableSearchQueryRequest"
+ responses:
+ "200":
+ description: >
+ The variable search successful response.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/VariableSearchQueryResponse"
+ "400":
+ description: >
+ The user task search query failed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+
  /clock:
  put:
  tags:
@@ -792,6 +835,116 @@ paths:
  application/problem+json:
  schema:
  $ref: "#/components/schemas/ProblemDetail"
+ /process-definitions/{processDefinitionKey}:
+ get:
+ tags:
+ - Process definition
+ summary: Get process definition by key (alpha)
+ description: |
+ Returns process definition as JSON.
+ :::note
+ This endpoint is an alpha feature and not enabled on Camunda clusters out of the box.
+ See the [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
+ for further details.
+ :::
+ parameters:
+ - name: processDefinitionKey
+ in: path
+ required: true
+ description: The assigned key of the process definition, which acts as a unique identifier for this process definition.
+ schema:
+ type: integer
+ format: int64
+ responses:
+ "200":
+ description: >
+ The process definition is successfully returned.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ProcessDefinitionItem"
+ "400":
+ description: >
+ The process definition request failed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: >
+ The process definition with the given key was not found.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ /process-definitions/{processDefinitionKey}/xml:
+ get:
+ tags:
+ - Process definition
+ summary: Get process definition XML (alpha)
+ description: |
+ Returns process definition as XML.
+
+ :::note
+ This endpoint is an alpha feature and not enabled on Camunda clusters out of the box.
+ See the [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
+ for further details.
+ :::
+ parameters:
+ - name: processDefinitionKey
+ in: path
+ required: true
+ description: The assigned key of the process definition, which acts as a unique identifier for this process.
+ schema:
+ type: integer
+ format: int64
+ responses:
+ "200":
+ description: >
+ The XML of the process definition is successfully returned.
+ content:
+ text/xml:
+ schema:
+ type: string
+ "204":
+ description: >
+ The process definition was found but does not have XML.
+ content:
+ text/plain:
+ schema:
+ type: string
+ "400":
+ description: >
+ The process definition request failed.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: >
+ The decision with the given key was not found.
+ More details are provided in the response body.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "500":
+ description: >
+ An internal error occurred while processing the request.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
  /process-instances:
  post:
  tags:
@@ -2434,6 +2587,83 @@ components:
  minimum: 0
  maximum: 100
  default: 50
+ VariableSearchQueryRequest:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryRequest"
+ description: Variable search query request.
+ type: object
+ properties:
+ filter:
+ $ref: "#/components/schemas/VariableFilterRequest"
+ VariableFilterRequest:
+ description: Variable filter request.
+ type: object
+ properties:
+ variableKey:
+ description: The key for this variable.
+ type: integer
+ format: int64
+ name:
+ description: Name of the variable.
+ type: string
+ value:
+ description: The value of the variable.
+ type: string
+ scopeKey:
+ description: The key of the scope of this variable.
+ type: integer
+ format: int64
+ processInstanceKey:
+ description: The key of the process instance of this variable.
+ type: integer
+ format: int64
+ tenantId:
+ description: Tenant id of this variable.
+ type: string
+ isTruncated:
+ description: Whether the value is truncated or not.
+ type: boolean
+ VariableSearchQueryResponse:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryResponse"
+ description: Variable search query response.
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: "#/components/schemas/VariableItem"
+ VariableItem:
+ description: Variable search response item.
+ type: object
+ properties:
+ variableKey:
+ description: The key for this variable.
+ type: integer
+ format: int64
+ name:
+ description: Name of this variable.
+ type: string
+ value:
+ description: Value of this variable.
+ type: string
+ fullValue:
+ description: Full value of this variable.
+ type: string
+ scopeKey:
+ description: The key of the scope of this variable.
+ type: integer
+ format: int64
+ processInstanceKey:
+ description: The key of the process instance of this variable.
+ type: integer
+ format: int64
+ tenantId:
+ description: Tenant id of this variable.
+ type: string
+ isTruncated:
+ description: Whether the value is truncated or not.
+ type: boolean
  ProcessDefinitionSearchQueryRequest:
  allOf:
  - $ref: "#/components/schemas/SearchQueryRequest"
@@ -2563,7 +2793,7 @@ components:
  state:
  $ref: "#/components/schemas/ProcessInstanceStateEnum"
  description: The state, one of ACTIVE, COMPLETED, CANCELED.
- incident:
+ hasIncident:
  type: boolean
  description: Whether this process instance has a related incident or not.
  tenantId:
@@ -2642,7 +2872,7 @@ components:
  state:
  $ref: "#/components/schemas/ProcessInstanceStateEnum"
  description: The state, one of ACTIVE, COMPLETED, CANCELED.
- incident:
+ hasIncident:
  type: boolean
  description: Whether this process instance has a related incident or not.
  tenantId:
@@ -2690,7 +2920,7 @@ components:
  description: The process definition key associated to this flow node instance.
  format: int64
  processDefinitionId:
- description: The bpmn process id associated to this flow node instance.
+ description: The process definition id associated to this flow node instance.
  type: string
  state:
  description: State of flow node instance as defined set of values.
@@ -2737,7 +2967,7 @@ components:
  treePath:
  type: string
  description: The path of keys from process instance to this flow node instance separated by '/'.
- incident:
+ hasIncident:
  type: boolean
  description: Shows whether this flow node instance has an incident related to.
  incidentKey:
@@ -2772,7 +3002,7 @@ components:
  type: integer
  format: int64
  processDefinitionId:
- description: The bpmn process id associated to this flow node instance.
+ description: The process definition id associated to this flow node instance.
  type: string
  startDate:
  description: Date when flow node instance started.
@@ -2824,7 +3054,7 @@ components:
  - ACTIVE
  - COMPLETED
  - TERMINATED
- incident:
+ hasIncident:
  description: Shows whether this flow node instance has an incident. If true also an incidentKey is provided.
  type: boolean
  incidentKey:
@@ -2880,7 +3110,7 @@ components:
  IncidentFilterRequest:
  type: object
  properties:
- key:
+ incidentKey:
  type: integer
  format: int64
  description: The assigned key, which acts as a unique identifier for this incident.
@@ -2890,7 +3120,7 @@ components:
  description: The process definition key associated to this incident.
  processDefinitionId:
  type: string
- description: The bpmn process id associated to this incident.
+ description: The process definition id associated to this incident.
  processInstanceKey:
  type: integer
  format: int64
@@ -2955,7 +3185,7 @@ components:
  IncidentItem:
  type: object
  properties:
- key:
+ incidentKey:
  type: integer
  format: int64
  description: The assigned key, which acts as a unique identifier for this incident.
@@ -2965,7 +3195,7 @@ components:
  description: The process definition key associated to this incident.
  processDefinitionId:
  type: string
- description: The bpmn process id associated to this incident.
+ description: The process definition id associated to this incident.
  processInstanceKey:
  type: integer
  format: int64
@@ -3452,7 +3682,7 @@ components:
  ActivatedJob:
  type: object
  properties:
- key:
+ jobKey:
  description: the key, a unique identifier for the job
  type: integer
  format: int64