Merge branch 'main' into consoleSmSbom

api/camunda/camunda-openapi.yaml

@@ -841,6 +841,48 @@ paths:
  schema:
  $ref: "#/components/schemas/ProblemDetail"
 
+ /flownode-instances/search:
+ post:
+ tags:
+ - Flow node Instance
+ summary: Query flow node instances (alpha)
+ description: |
+ Search for flow node instances 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/FlowNodeInstanceSearchQueryRequest"
+ responses:
+ "200":
+ description: >
+ The Flow node instance search successful response.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/FlowNodeInstanceSearchQueryResponse"
+ "400":
+ description: >
+ The Flow node instance 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"
  /decision-definitions/search:
  post:
  tags:
@@ -967,6 +1009,48 @@ paths:
  The decision requirements search query failed.
  More details are provided in the response body.
 
+ /decisions/evaluation:
+ post:
+ tags:
+ - Decision
+ summary: Evaluate decision
+ description: |
+ 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.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EvaluateDecisionRequest"
+ responses:
+ "200":
+ description: The decision was evaluated.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EvaluateDecisionResponse"
+ "400":
+ description: The provided data is not valid.
+ content:
+ application/problem+json:
+ schema:
+ $ref: "#/components/schemas/ProblemDetail"
+ "404":
+ description: The decision is not found.
+ 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"
+
  /authorizations/{ownerKey}:
  patch:
  tags:
@@ -1883,6 +1967,97 @@ components:
  format: int64
  minimum: 1
 
+ FlowNodeInstanceSearchQueryRequest:
+ description: Flow node instance search request
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryRequest"
+ type: object
+ properties:
+ filter:
+ allOf:
+ - $ref: "#/components/schemas/FlowNodeInstanceFilterRequest"
+ FlowNodeInstanceFilterRequest:
+ type: object
+ properties:
+ flowNodeInstanceKey:
+ type: integer
+ description: The key of this flow node instance.
+ format: int64
+ processInstanceKey:
+ type: integer
+ description: The process instance key.
+ format: int64
+ processDefinitionKey:
+ type: integer
+ description: The process definition key.
+ format: int64
+ state:
+ type: string
+ description: The state, one of ACTIVE, COMPLETED, TERMINATED.
+ type:
+ type: string
+ description: The flow node type
+ flowNodeId:
+ type: string
+ description: The flow node id
+ flowNodeName:
+ type: string
+ description: The flow node name
+ treePath:
+ type: string
+ description: The path of keys from process instance to this flow node instance separated by '/'
+ incident:
+ type: boolean
+ description: Shows whether this flow node instance has an incident related to
+ incidentKey:
+ type: integer
+ description: The key of incident if field incident is true
+ format: int64
+ tenantId:
+ description: The tenant id
+ type: string
+ FlowNodeInstanceSearchQueryResponse:
+ allOf:
+ - $ref: "#/components/schemas/SearchQueryResponse"
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: "#/components/schemas/FlowNodeInstanceItem"
+ FlowNodeInstanceItem:
+ type: object
+ properties:
+ flowNodeInstanceKey:
+ type: integer
+ format: int64
+ processInstanceKey:
+ type: integer
+ format: int64
+ processDefinitionKey:
+ type: integer
+ format: int64
+ startDate:
+ type: string
+ endDate:
+ type: string
+ flowNodeId:
+ type: string
+ flowNodeName:
+ type: string
+ treePath:
+ type: string
+ type:
+ type: string
+ state:
+ type: string
+ incident:
+ type: boolean
+ incidentKey:
+ type: integer
+ format: int64
+ tenantId:
+ type: string
  DecisionDefinitionSearchQueryRequest:
  allOf:
  - $ref: "#/components/schemas/SearchQueryRequest"
@@ -2748,7 +2923,150 @@ components:
  description: The name of the resource from which this decision requirements was parsed.
  tenantId:
  type: string
- description: The tenant id of the decision requirements.
+ description: The tenant ID of the decision requirements.
+ EvaluateDecisionRequest:
+ type: object
+ properties:
+ decisionKey:
+ description: |
+ The unique key identifying the decision to be evaluated.
+ Cannot be used together with decisionId.
+ type: integer
+ format: int64
+ decisionId:
+ description: |
+ The ID of the decision to be evaluated.
+ Cannot be used together with decisionKey. When using the decision ID, the latest
+ deployed version of the decision is used.
+ type: string
+ variables:
+ description: The message variables as JSON document.
+ additionalProperties: true
+ type: object
+ tenantId:
+ description: The tenant ID of the decision.
+ type: string
+ EvaluateDecisionResponse:
+ type: object
+ properties:
+ decisionKey:
+ description: The unique key identifying the decision which was evaluated.
+ type: integer
+ format: int64
+ decisionId:
+ description: The ID of the decision which was evaluated.
+ type: string
+ decisionName:
+ description: The name of the decision which was evaluated.
+ type: string
+ decisionVersion:
+ description: The version of the decision which was evaluated.
+ type: integer
+ format: int32
+ decisionRequirementsId:
+ description: The ID of the decision requirements graph that the decision which was evaluated is part of.
+ type: string
+ decisionRequirementsKey:
+ description: The unique key identifying the decision requirements graph that the decision which was evaluated is part of.
+ type: integer
+ format: int64
+ decisionOutput:
+ description: |
+ JSON document that will instantiate the result of the decision which was evaluated.
+ type: string
+ failedDecisionId:
+ description: The ID of the decision which failed during evaluation.
+ type: string
+ failureMessage:
+ description: Message describing why the decision which was evaluated failed.
+ type: string
+ tenantId:
+ description: The tenant ID of the evaluated decision.
+ type: string
+ decisionInstanceKey:
+ description: The unique key identifying this decision evaluation.
+ type: integer
+ format: int64
+ evaluatedDecisions:
+ type: array
+ items:
+ $ref: "#/components/schemas/EvaluatedDecisionItem"
+ EvaluatedDecisionItem:
+ type: object
+ description: List of decisions that were evaluated within the requested decision evaluation.
+ properties:
+ decisionKey:
+ description: The unique key identifying the decision which was evaluate.
+ type: integer
+ format: int64
+ decisionId:
+ description: The ID of the decision which was evaluated.
+ type: string
+ decisionName:
+ description: The name of the decision which was evaluated.
+ type: string
+ decisionVersion:
+ description: The version of the decision which was evaluated.
+ type: integer
+ format: int32
+ decisionType:
+ description: The type of the decision which was evaluated.
+ type: string
+ decisionOutput:
+ description: |
+ JSON document that will instantiate the result of the decision which was evaluated.
+ type: string
+ tenantId:
+ description: The tenant ID of the evaluated decision.
+ type: string
+ matchedRules:
+ type: array
+ items:
+ $ref: "#/components/schemas/MatchedDecisionRuleItem"
+ evaluatedInputs:
+ type: array
+ items:
+ $ref: "#/components/schemas/EvaluatedDecisionInputItem"
+ MatchedDecisionRuleItem:
+ type: object
+ description: The decision rules that matched within this decision evaluation.
+ properties:
+ ruleId:
+ description: The ID of the matched rule.
+ type: string
+ ruleIndex:
+ description: The index of the matched rule.
+ type: string
+ evaluatedOutputs:
+ type: array
+ items:
+ $ref: "#/components/schemas/EvaluatedDecisionOutputItem"
+ EvaluatedDecisionInputItem:
+ type: object
+ description: The decision inputs that were evaluated within this decision evaluation.
+ properties:
+ inputId:
+ description: The ID of the evaluated decision input.
+ type: string
+ inputName:
+ description: The name of the evaluated decision input.
+ type: string
+ inputValue:
+ description: The value of the evaluated decision input.
+ type: string
+ EvaluatedDecisionOutputItem:
+ type: object
+ description: The evaluated decision outputs.
+ properties:
+ outputId:
+ description: The ID of the evaluated decision output.
+ type: string
+ outputName:
+ description: The name of the evaluated decision output.
+ type: string
+ outputValue:
+ description: The value of the evaluated decision output.
+ type: string
 
  MessageCorrelationRequest:
  type: object
@@ -2831,6 +3149,7 @@ components:
  tenantId:
  description: The tenant ID of the message.
  type: string
+
  DocumentReference:
  type: object
  properties:
@@ -2861,6 +3180,10 @@ components:
  type: string
  format: date-time
  description: The date and time when the document expires.
+ size:
+ type: integer
+ format: int64
+ description: The size of the document in bytes.
  DocumentLinkRequest:
  type: object
  properties:

docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx

@@ -5,7 +5,7 @@ description: "Iterate through all known partitions and activate jobs up to the r
 sidebar_label: "Activate jobs"
 hide_title: true
 hide_table_of_contents: true
-api: eJztWVtz2zYW/isYvmwylSW1m7ZZ9TKj2mmrtHU9ttLdGccPIAlJiEmCBUDJqkb/vd8BeJNIJcrs7lucsSMSB+f6nQugXWD50gST++C1CoOHQRALE2mZW6myYBLMrNDcCmZXWhXLFeNJwh4ztclYzrWVRGUYz2LGIyvXRPlOhYYVObMKmwTT4s9CGCtilvInmRbp8G0WDILy9Q8q3gaTnXuUWsTBxOpCDIJIZVZklpZ4nicy4iRp9M6QUrvARCuRcvpkt7mAmip8JyILvrlWuYBiwjSruyObSC1oyWh1wLhhsVjIDBrKzKn8w81v1wyMImEMeyaGyyH79i8hQjGx3DxeEbEz3DH47m2Q820KZS+M0GsZibcBG33/3FlZamesltky2A+CjdKPQverlPFUMLVwKni6yqnYzEqlzYClythkywoDjRdKs0Qtl0SRFzpXBoYfyx0EWZEkPEyEdy/0sDIVqrBdRbjzjBa20OQRvkD8IVsaFlHoNxJ/MmVZKOqIxyzcAgIKGmpPVWRWJk7jUg57Btem5jlbwduhEBkkcMQwbntJIuRLOGcQwKqUW//qqxfkN2AH8DRzNS2F9ruwhJjHIABYgxIaOiNK2H1I6D+/IKELYaPVH1xL77quqxJpLEVsXdI4mW4XoaqCWb36DZMLJtLcbgcuj9bSSLxvbee29hrxrcIPqFGgaclEwHeFEuLuIhKKOmRtj3Kt+bYT/kEgrUhb+VHjc1/n5fwUPuZNSteiI5XmiSAgbFYILYxIBCfPZF5F+L3BCuyoQFVzmh+iZMhmi77l79gYjqNs5UVia2yBPeXCqV3f0q5EUYKoJKFEwYZYGnJI7EpXaxOtNebINBWxhNoJIibWsM0ZmKmOWcOzgEzF1ekeTMZ9SSkyntlZbN6HtdmVceF3tMbhYrOSQFwb7oT/LgxOhb2jSokDX5DvPXlTM/qy8YGWLTGgNjKtcXtb5tt+75maHP3C1+YvxuN+eFWWNpghc4bBR3SFc5k2PjrRQBxR47FTnjyx+1Fs++sUFgjJRSbhHiZjGCUXEklRpTnknlcYT3c4WmkXimdmpYqE2jDVp80KabrhpunPz/v6VdkFZ5mxPIvEL6cMgoB/mLpnypKc7DzPjDBPs5tSVtwvgkhqCbOrlmktyXHdnN9jTdPB/xDaSA+ersC1Xzxf0Pt6SUf0SVfCZ/+tSO9TkQgaS075kxujIulSgcYaVpLDtX2uq5h9CAglpMmIEtbbano5EjioaDcSrTnrdrdjNJ07K0SFsSr9WfAYAewrpUa4UuDp2MoT1kNgXJDNmLJi4drFN61pCBUfu9GtE/kXnl/f/X7NYhUV5JqeWsLj2MWLJzetulBW+48cBX2Rb8qXG2cOykQTLCisyxLUE/dUYT4j7iUZuvXC+nHds6xLBU82fEsDG1qngSVr8fw8tMfwKXzXU5lcA61KUsSzw0GSL7nMBnAxFHTOfnM9+w8TuaL+hvYDIKT5eSioh6quDlOaveqZq5rCyvOKywWHw4GbBAqnl23PYqTJx0a76u393akpZ54OHyESpyzT7QatYa1quVUbjukIt2+vHDVj337LbvziVANG4q2RvEgFbjmNOTTwr4H5csw50YaxDX5MP/tQO56yG0+JlLMcBwXvQX8QI8LQH8Xub3+8ZP968eXXD89W1uZmMhptNpuhXkQXmMqs0kOllyM80i/RYXCE+pqOAVuHqzogrOnLzOQiQrONqoCXart+eTDGfeBMeXzGqiGI+hEcH6On7M3trFMRD0S3p8OAh5i0JmHCs8egCWdX6LEUU6Qp19tWCW0JACMkkC3ak8vJLD7mTcD4eT6/YZ4FciMW5bgiTSWIjEjRpHAGCybAlxsV/dNX47ErDBTxMyzJmHjKYb7PuCNz6JigEGfPzRlWNYn/UWSUljhTH8kdHiRdCeIrb5FPqS/7Ugq2kJc14VBoDZepKCq0duclmdSNrpJdTmSfcu1Trn3KtVO5RndCwq4UGmqA4cRBh9sVnkZ0Zhs17RordDHnZsH7HfSCS4KdT5g9cL5bYft+ssuVtvvRmqJxMDvQsk+sCjCJiniy8kK7gaOF9vx2ydMiizl7yW5f3c3ZT+jTmKqcI0nkIeuX45fjXq5EeoLj9GbGvIUedq1SULGlnO5l64nPYbzfP5AjUbik3d7RNu+eUHAt9LQg39dwKOU57vTsifDGf/ixAsnrf89dnKmM3TY3wq+eOF3B9OGrmpqbN/VV5rj3mnDcuce7r/Y+dK+7xge3MA2lQ/1COY1KTHadRcipDpTBePh5F/9wKKUx5krsdbUcOUDnH4y6Db8owcmEnD4IUPAFTWyQS5hqif3Vr7DyCMs+HxJwPLqrEr4E5yIcQtwo8tvq/8NEhaMU0/aoFGFGl9Pf3lxfTS9+nV2+ur57dQGOQ/tkXYAoxVKetfSYHt01HVi6a/rW/+0bhBIZVjzZEaqXzAj8zv5dWQrug1K3VjFAzH1C3we7XciNeKOT/Z5eQ4jGofb+ocl/egJTf0J01cPd6ASX3riLub8Yw2hcuNuh4zup/aDaMY0ikdv30j60KtrN73dzypby2xE6i+Kt5hv65gR/J8Fb/MODcg53ieje7wLU8WXBl0Tv+dLP38HHBn8=
+api: eJztWVtvGzcW/isHfNkYO5aUbtqmaruAaqdbZVvXsJW2gO0HzsyRhjaHnJAcyaqg/14ccm6SRomC7r7FgGDN8PBcv3MhtWGOLywb37G3OmYPEUvRJkYUTmjFxmzq0HCH4DKjy0UGXEp4UnqloODGCaKywFUKPHFiSZSPOrZQFuA0uAzB4PsSrcMUcv4s8jIf3CsWser1Dzpds/HGPwqDKRs7U2LEEq0cKkdLvCikSDhJGj5aUmrDbJJhzumbWxfIxkzHj5g4FrHC6AKNE2jb1c2eTaTWo46BViPgFlKcC4UpCOVV/uH6lysojE7QWniBg8UAvvsTMcax4/bpkoi94Z7B9/es4OsclTu3aJYiwXsGw3+feSsr7awzQi3YNmIrbZ7Q9KukeI6g516FQFc7VagFVErbCHJtnVxDaTGFuTYg9WJBFEVpCm3RHsiNmCql5LHE4N5txJzIUZfuUBHuPWPQlYY8wucODbhMWEgo9CshJSjtIMYm4inEa+BKuwxNoCqVE9JrXMmBF0JBbs8g4xZiRAUGeZJh2vWSUA4XaFjE5trk3IVXX70iv+X8+a2O7UxPKqH9LqwgFjDodAvKeB2MqGD3MaH/+oKEztEl2W/ciOC6Q1dJYR1FbFnReJl+F6Gqhlmz+i2IOWBeuHXk82gprIgldrZz13iN+Nbh18oHmpZsoosGJcTdRyTGJmRdj3Jj+Pog/BETDvNOfjT43DZ5OTuGj1mb0o3oROeFRALCKkNFRkjk5BkVVBS2gxVtGlA1nGa7KBnAdN63/D2MIuCUrbyUrsGWsD4Xju36jnZJTQmipaREERZSYckhqS9dnU201poj8hxTwR3KdQS4RBUMVPrArMFJQKbi6nVn41FfUqLiyk1T+yGsTS+tD7+ntR4Xq0wk2Q7cCf+HMDgW9gNVKhyEgnwXyNua0ZeND7TsiAG1kUmD25sq37bbwNQWWtlQm78YjfrhVVvaYobMGbBP6AqnMm19dKSBeKLWY8c8eWT3E67769QTUgmAUon3JYJIUTkxF2iaNH/U8WmF8XiHo5VuoXhhM11KasNUn1YZd7Ditu3PZ339quqCU2UdVwn+95hBjzr+h216pqjIyc7TzIiLXF1XstJ+EUTSSJhedkzrSE6b5vwBa9oO/hsaKwJ4DgUuw+Lpgj7USw5EH3XlE67/rsjgU5RIY8kxf3JrdSJ8KtBYAxU5TC/7XFcz+xgQKkiTERWs1/X0sicwqmlXwmXV5LXT3fbRdOqskJTW6fwn5Cma3lJq0ZeCQAdZIGyGwLQkmyHXKfp28W1nGrJAu43gUvyJKby9/fUKUp2U5JqeWsLT1MeLy+tOXaiq/SeOgqHIt+XLjzM7ZaINlkFnqhLUE/dcl8o7oCIDiXMXxvXAsikVXK74mgY2KLQVTizx7DS0p8hTKVRPZfINtC5JCVe7gyRfcKEisIRD7+x3V9M/AAtN/U3kaB3Pi9NQ0AxVhzpMaPZqZq56CqvOKz4XPA4jPwmUXi/XncVIk0+Ndt3b+7tTW84CHTgqz3ql7GE36Axrdcut23BKR7htd2WvGYf2W3XjV8cacGH0UqSUCtxxGnNo4F9yKaox50gbLoyOJeb//Fg7nsB1oIQUHRcSggfDQYwI43AUu7v58QK+efXl1w8vMucKOx4OV6vVwMyTc0yF02agzWJo5gl9iO5sALMMDR0D1h5XTUCg7ctgC0zEXCR1wCu1fb/cGeM+cqbcP2M1ECyNYPvH6Am8u5keVMQd0d3pkPFYl24cS66eWBvOQ6H7UmyZ59ysOyW0I2AbMeu4K7uTy9Es3udNwPhpNruGwAISnWI1rghbCyIjcqHoDMbGr0YjPyqGp69GI18YKOInWKIAnwvJVci4PXPomKANVvjxhtVN4n8UGW3EQuzLHewkXQXiy2BRSKkv+1JqooC8bAiHaIw2oJOkNMafl4RsGl0tu5rIPufa51z7nGvHco3uhNBlOmVjVmh/o1Nwl7ExG9KZbdi2axYxupjzs+DdhpVGsjHbhITZjofDTaat2443hTZuO1xSNHZmB1oOiVUDRuqEyywIPQwcLXTntwuelyrl8Bpu3tzO4D/c4YqvvSNJ5C7r16PXo16uRHqE4+R6CsHCALtOKajZUk73sg3EpzDebh/IkUlphFvf0rbgnhi5QTMpyfcNHCp5njs9ByIWVV9+rEHy9veZjzOVsZv2RvjNM6crmD581VNz+6a5yhz1XhOODu7x7uq9D4fXXaOdW5iW0qN+rr1GFSYPnUXIqQ+UbDR4eYj/66lP40Tneal8LVcLf/4B3nF+IkvryOkRkyJBmtjGG0aY6oj9OaxAdYSFlwMCTkB3XcIXwmVlPEh0PkzCtuZ/LHU8zLlQw0qEHV5Mfnl3dTk5/3l68ebq9s35y8Fo4J6dDxClWM5VR4/J3l3TjqWbtm/9335BqJDh8NkNC8mFIvB7+zdVKbhjlW6dYvAQVQl9xzabmFt8Z+R2S6/fl2jWbHz30OY/PW0jFk6Ivnr4Gx12EYw7n4WLsSWXpb8d2r+T2kb1jkmSYOE+SPvQqWjXv97OKFuqX0foLMrGzPAV/XLCV2zM7tk9YxHT3uE+Ef37DZNcLUq+IPrAl/7+AsHHBn8=
 sidebar_class_name: "post api-method"
 info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
 custom_edit_url: null