From 598208fe26f5923229fe05c7d9627040afed1fb0 Mon Sep 17 00:00:00 2001 From: tmetzke Date: Thu, 10 Oct 2024 15:06:39 +0000 Subject: [PATCH] docs: update REST API spec --- api/camunda/camunda-openapi.yaml | 252 +++++++++++++++++- .../specifications/activate-jobs.api.mdx | 6 +- .../create-document-link-alpha.api.mdx | 4 +- ...get-decision-instance-by-key-alpha.api.mdx | 2 +- ...et-flow-node-instance-by-key-alpha.api.mdx | 4 +- .../get-incident-by-key-alpha.api.mdx | 4 +- ...et-process-definition-by-key-alpha.api.mdx | 60 +++++ .../get-process-definition-xml-alpha.api.mdx | 73 +++++ .../get-process-instance-alpha.api.mdx | 4 +- .../query-decision-instances-alpha.api.mdx | 2 +- .../query-flow-node-instances-alpha.api.mdx | 6 +- .../query-incidents-alpha.api.mdx | 6 +- ...-process-and-local-variables-alpha.api.mdx | 60 +++++ .../query-process-instances-alpha.api.mdx | 6 +- .../query-user-tasks-alpha.api.mdx | 2 +- ...eturn-user-task-by-a-user-task-key.api.mdx | 2 +- .../specifications/sidebar.js | 24 ++ .../specifications/update-user-task.api.mdx | 2 +- .../upload-document-alpha.api.mdx | 2 +- 19 files changed, 484 insertions(+), 37 deletions(-) create mode 100644 docs/apis-tools/camunda-api-rest/specifications/get-process-definition-by-key-alpha.api.mdx create mode 100644 docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml-alpha.api.mdx create mode 100644 docs/apis-tools/camunda-api-rest/specifications/query-process-and-local-variables-alpha.api.mdx diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml index a5679c6c60..d9cec7e22c 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/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 diff --git a/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx index 3555352c3b..d9ecbdd6d2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx +++ b/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: 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+h216pqjIyc7TzKh2tr11mvYLiotcNXKmlx0DO/LThs0HbGpl/YbGigChQ4HLsHi6oA91lAPRRx36hOu/KzJ4FiXScHLMn9xanQifEDTcQEUO08s+19XMPgaHCthkRAXudT3D7AmMatqVcFk1f+30uH1MnToxJKV1Ov8JeYqmt6Ba9AUh0EEWCJtRMC3JZsh1ir5pfNuZiSzQbiO4FH9iCm9vf72CVCcluaanovA09fHi8rpTHaqa/4kDYSj1bRHzQ81OsWiDZdCZqhD1xD3XpfIOqMhA4tyFoT2wbAoGlyu+prENCm2FE0s8Ow3tKfJUCtVTn3wbrQtTwtXuOMkXXKgILOHQO/vd1fQPwEJTlxM5Wsfz4jQUNKPVoQ4TmsCayauexapTi88Fj8PIzwOl18t1JzLS5FOjXXf4/h7VlrNAB46KtF4pe9gTOiNb3XjrZpzSQW7bXdlryaEJVz351bE2XBi9FCmlAnechh0a+5dcimrYOdKMC6Njifk/P9aUJ3AdKCFFx4WE4MFwHCPCOBzI7m5+vIBvXn359cOLzLnCjofD1Wo1MPPkHFPhtBlosxiaeUIfojsbwCxDQ4eBtcdVExBouzPYAhMxF0kd8Ept3zV3hrmPnCz3T1oNBEsj2P5hegLvbqYHFXFHdHdGZDzWpRvHkqsn1obzUOi+FFvmOTfrTgntCNhGzDruyu78cjSL93kTMH6aza4hsIBEp1gNLcLWgsiIXCg6ibHxq9HID4zh6avRyBcGivgJlijA50JyFTJuzxw6LGiDFX68YXWT+B9FRhuxEPtyBztJV4H4MlgUUurLvpSaKCAvG8IhGqMN6CQpjfGnJiGbRlfLruayz7n2Odc+59qxXKObIXSZTtmYFdrf6xTcZWzMhnRyG7btmkWMruf8LHi3YaWRbMw2IWG24+Fwk2nrtuNNoY3bDpcUjZ3ZgZZDYtWAkTrhMgtCDwNHC9357YLnpUo5vIabN7cz+A93uOJr70gSucv69ej1qJcrkR7hOLmeQrAwwK5TCmq2lNO9bAPxKYy32wdyZFIa4da3tC24J0Zu0ExK8n0Dh0qe507PgYhF1Zcfa5C8/X3m40xl7Ka9F37zzOkipg9f9dTcvmkuNEe9l4Wjg9u8u3rvw+Gl12jnLqal9Kifa69RhclDZxFy6gMlGw1eHuL/eurTONF5Xipfy9XCn3+Ad5yfyNI6cnrEpEiQJrbxhhGmOmJ/DitQHWHh5YCAE9Bdl/CFcFkZDxKdD5OwrfkfSx0Pcy7UsBJhhxeTX95dXU7Of55evLm6fXP+cjAauGfnA0QplnPV0WOyd+O0Y+mm7Vv/t98RKmQ4fHbDQnKhCPze/k1VCu5YpVunGDxEVULfsc0m5hbfGbnd0uv3JZo1G989tPlPT9uIhROirx7+XoddBOPOZ+F6bMll6e+I9m+mtlG9Y5IkWLgP0j50Ktr1r7czypbqNxI6i7IxM3xFv5/wFRuze3bPWMS0d7hPRP9+wyRXi5IviD7wpb+/APJLCPs= +api: eJztWVtv4zYW/isHfNkJVrE93Wl36rYLuMl069k2DRJPu0CSB0o6tphQpIak7LiG//vikLrZljMe7O7bBDBiiYfn+p0L6Q1zfGHZ+I691zF7iFiKNjGicEIrNmZTh4Y7BJcZXS4y4FLCk9IrBQU3ThCVBa5S4IkTS6J81LGFsgCnwWUIBj+WaB2mkPNnkZf54F6xiFWvf9Tpmo03/lEYTNnYmRIjlmjlUDla4kUhRcJJ0vDRklIbZpMMc07f3LpANmY6fsTEsYgVRhdonEDbrm72bCK1HnUMtBoBt5DiXChMQSiv8o/Xv15BYXSC1sIrHCwG8P2fiDGOHbdPl0TsDfcMfrhnBV/nqNy5RbMUCd4zGP7jzFtZaWedEWrBthFbafOEpl8lxXMEPfcqBLraqUItoFLaRpBr6+QaSospzLUBqRcLoihKU2iL9kBuxFQpJY8lBvduI+ZEjrp0h4pw7xmDrjTkET53aMBlwkJCoV8JKUFpBzE2EU8hXgNX2mVoAlWpnJBe40oOvBIKcnsGGbcQIyowyJMM066XhHK4QMMiNtcm5y68+uYN+S3nz+91bGd6Ugntd2EFsYBBp1tQxutgRAW7Twn921ckdI4uyX7nRgTXHbpKCusoYsuKxsv0uwhVNcya1e9AzAHzwq0jn0dLYUUssbOdu8ZrxLcOv1Y+0LRkE100KCHuPiIxNiHrepQbw9cH4Y+YcJh38qPB57bJy9kxfMzalG5EJzovJBIQVhkqMkIiJ8+ooKKwHaxo04Cq4TTbRckApvO+5R9gFAGnbOWldA22hPW5cGzX97RLakoQLSUlirCQCksOSX3p6myitdYckeeYCu5QriPAJapgoNIHZg1OAjIVV687G4/6khIVV26a2pewNr20Pvye1npcrDKRZDtwJ/wfwuBY2A9UqXAQCvJdIG9rRl82PtCyIwbURiYNbm+qfNtuA1NbaGVDbf5qNOqHV21pixkyZ8A+oyucyrT10ZEG4olajx3z5PHd/8J1f6l6QqoCUCrxsUQQKSon5gJNk+mPOj6tNh5vcrTSrRWvbKZLSZ2YStQq4w5W3LYt+qyvZVWNcKqs4yrBowY96vgvtmmboiInO08zo9rZttdp2i8oLnLVyJledgzsyE8bNi/Y1Mr6HY0VAUWHApdh8XRBLzWVA9EvIeS/FRk8ixJpPjnmT26tToTPCZpvoCKH6WWf62pmn4JDBWwyogL3uh5j9gRGNe1KuKwawXba3D6mTh0aktI6nf+MPEXTW1Mt+poQ6CALhM00mJZkM+Q6Rd83vuuMRRZotxFcij8xhfe3v11BqpOSXNNTVHia+nhxed0pEFXZ/8yZMFT7to75uWanWLTBMuhMVYt64p7rUnkHVGQgce7C3B5YNgWDyxVf0+QGhbbCiSWenYb2FHkqheqpT76T1oUp4Wp3ouQLLlQElnDonf3havpvwEJToxM5Wsfz4jQUNNPVoQ4TGsKa4asex6qDi88Fj8PIjwSl18t1hzLS5HOjXTf5/jbVlrNAB46KtF4pe9gTOlNb3XvrfpzSWW7bXdnryqEPV235zbFOXBi9FCmlAnec5h2a/JdcimreOdKPC6NjiflfP9WXJ3AdKCFFx4WE4MFwIiPCOJzJ7m5+uoBv33z994dXmXOFHQ+Hq9VqYObJOabCaTPQZjE084Q+RHc2gFmGhs4Da4+rJiDQNmiwBSZiLpI64JXavmvuzHOfOFzuH7YaCJZGsP3z9AQ+3EwPKuKO6O6YyHisSzeOJVdPrA3nodB9KbbMc27WnRLaEbCNmHXcld0R5mgW7/MmYPw8m11DYAGJTrEaWoStBZERuVB0GGPjN6ORnxnD0zejkS8MFPETLFGAz4XkKmTcnjl0XtAGK/x4w+om8T+KjDZiIfblDnaSrgLxZbAopNTXfSk1UUBeNoRDNEYb0ElSGuMPTkI2ja6WXc1lX3LtS659ybVjuUaXQ+gynbIxK7S/2im4y9iYDenwNmzbNYsY3dD5WfBuw0oj2ZhtQsJsx8PhJtPWbcebQhu3HS4pGjuzAy2HxKoBI3XCZRaEHgaOFrrz2wXPS5VyeAs3725n8E/ucMXX3pEkcpf129HbUS9XIj3CcXI9hWBhgF2nFNRsKad72QbiUxhvtw/kyKQ0wq1vaVtwT4zcoJmU5PsGDpU8z52eAxGLqi8/1SB5/8fMx5nK2E17NfzumdNdTB++6qm5fdPcaY567wtHBxd6d/Xeh8N7r9HOdUxL6VE/116jCpOHziLk1AdKNhq8PsT/9dSncaLzvFS+lquFP/8A7zg/kaV15PSISZEgTWzjDSNMdcT+ElagOsLC6wEBJ6C7LuEL4bIyHiQ6HyZhW/M/ljoe5lyoYSXCDi8mv364upyc/zK9eHd1++789WA0cM/OB4hSLOeqo8dk79Jpx9JN27f+bz8lVMhw+OyGheRCEfi9/ZuqFNyxSrdOMXiIqoS+Y5tNzC1+MHK7pdcfSzRrNr57aPOfnrYRCydEXz3oWmPMLoJx57NwQ7bksvTXRPuXU9uo3jFJEizci7QPnYp2/dvtjLKl+pmEzqJszAxf0U8ofMXG7J7dMxYx7R3uE9G/3zDJ1aLkC6IPfOnvP0L6ChY= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -37,7 +37,7 @@ Iterate through all known partitions and activate jobs up to the requested maxim The list of activated jobs. -
Schema
    jobs object[]
  • Array [
  • customHeaders object
    +
    Schema
      jobs object[]
    • Array [
    • customHeaders object
      a set of custom headers defined during modelling; returned as a serialized JSON document @@ -45,7 +45,7 @@ a set of custom headers defined during modelling; returned as a serialized JSON All variables visible to the task scope, computed at activation time -
    • ]
    +
  • ]
The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx index fe84c42930..f9784f197d 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Create a link to a document in the Camunda 8 cluster." sidebar_label: "Create document link (alpha)" hide_title: true hide_table_of_contents: true -api: eJzdV9tu20YQ/ZXFPiUoRVKOk7h8U22ndZGLYSstUMsPK3IobrIXZndpmRD478XskrpYsuMWQR9qwJConZ05M2duXFHHFpZmN/RM540E5Sy9jWgBNje8dlwrmtFTA8wBYURw9ZU4TRgpemnCFXEVkFMmG1UwckJy0VgHJp6pmcqyTGkHMzWtuCWgilpzvGMJU4SJumKkBOYaAzG5cCRvjAHlREu0Ei2xTV1r47wwVyMJUpt2Y9k6bSCaqWXF8wp1Ku2IBKYcKbUhtdFFk6MHpLEQezAzRSNaM8MkODDo9ooqJoFmdFB7UdCIcvS6Zq6iETXwreEGCpo508DD0EwrIBdnRJc+CmtsTvtYxTSiNq9AMpqtqGtrtGSd4WpBuy5aG/eubCx/a8C0O6ZLJuxzbXtlA4Ldo9Jo+TSm22AVrPtFFy1K7IHItXKgHJ6xuhY8Z4gn+WIR1Gpft55/gdxh4I2uwTgOFk/hvuYG7MTtw4hoqY1kDmlhDkaOS6CHvC98WqqCoARZVhCS0Tve60d3VSMEmwsIFHZdRB13+LhO+vdcfb0KftOuQwkDttbKBqxH6Rg/DgAYIutNLpklua+Vgtgmz8HashGiRQw/KGqNEYfitY9sKNVt/mPaRf9d3B+Lcx/g4zR9Tkx9PLGIS8YFFDH5gNldgGNcWMIMYKHf8QKKoRUNzJG5LtrYl/wjwa+NnguQP+2TsItqQi6DZG+XBHIIsyQIzoP1m6t3p+Tn49dvb19UztU2S5LlchmbMh9BwZ02sTaLxJQ5/qPcy5hMKzBAJGvJHAgrCo42mSAb2omtIeclzwc6e9gEyQv+PZ0z4fQJshvD92iekM9XF4QXoBwvW64W+6b9nZI1AnWwuW5cNhcMCV4T/71MnRDbSMlMO3SxXQNdRK1jrtlyg3LlYAFmGz9X7tXRwUT9bTq9JEEFyXUBfjI4HEa9IXRCcsVlI2l2nKYRlew+PL1J0w51IuPP8ERh5gumQrY+cIcrIjd56x3jyjqm8h/FjDZ8wR/a3S3CPonPgkddKEMJrtIFjjttferg1MtoMlRhstpMxi7BkrQ4QMDcDQPUtyS6CsXTZUmyqrR1XbbC4d0ld8jMHTMcO7AnEo9DkQ3JI3TORBUA7JOIBzgoB+c2u8bV+fWU/MocLFnrg4omd1WfpCfpQa0o+ojGyeUFCR6GFNxqC4NarO+DaoPwcxT7YWshbwx37TVeC+GZAzNgJg3ysE6N3p7Xjs9BiEb9l3dDwvz+59Rzji3tajPIz++ZrENBbvV/epQeHY/G6Sg9maZvs/E4O34Vvz5+81fIz1J7AH327LuCvIKxwfc0Hu9n6uWFL7hcS9ko33XVgiy5qwg7sDHSiAqeg7IeZ78aDWLvwwn5I1gk4xhpDbk3NNsFd1Uzj3MtkzxcW3/OhZ4nknGV9CZscjr58Pnj2WT0/uL0/OP1+Wgcp7G7dz58WAySqW0cYQfeHU4v/A778qHjq83A+Z/tzn02Orh3SS0YV5gp/U4SOsfNepOmEc12turQPG6jvgHc0NVqzix8NqLr8Oew9mJLKbjFbvHI4rsd3n+/Ax905Su0O+v4HRMNSlGs1aGJ/UOIL676Dfol+f7bwkFU/Y9MtduQBrRbMe5uu4hWwAowHmQQOA1QRlNUs1Gwt4biC0m4MclzqN2Tsrdbo+Py0/UUW1H/xiB1gXcMW+I7DFvSjM7oDAFrHx7f5fzvKyqYWjRsgfJBL/79DTcxBqU= +api: eJzdV21v2zYQ/isEP7WYLMlp2nX65iXp5qHtgsTdgMX5QEsniy1fVJKKIxj678ORkl9iJ82GYh8WILBlHu+eu+fetKaOLS3Nbui5zhsJyll6G9ECbG547bhWNKNnBpgDwojg6gtxmjBS9NKEK+IqIGdMNqpg5C3JRWMdmHiu5irLMqUdzNWs4paAKmrN8Y4lTBEm6oqREphrDMRk6kjeGAPKiZZoJVpim7rWxnlhrkYSpDbt1rJ12kA0V6uK5xXqVNoRCUw5UmpDaqOLJkcPSGMh9mDmika0ZoZJcGDQ7TVVTALN6KB2WtCIcvS6Zq6iETXwteEGCpo508DD0MwqINNzoksfhQ02p32sYhpRm1cgGc3W1LU1WrLOcLWkXRdtjHtXtpa/NmDaPdMlE/a5tr2yAcH+UWm0fBrTbbAK1v2sixYlDkDkWjlQDs9YXQueM8STfLYIan2oWy8+Q+4w8EbXYBwHi6dwX3MDduIOYUS01EYyh7QwByPHJdBj3hc+LVVBUIKsKgjJ6B3v9aO7qhGCLQQECrsuoo47fNwk/XuuvlwFv2nXoYQBW2tlA9aTdIwfRwAMkfUmV8yS3NdKQWyT52Bt2QjRIobvFLXGiGPxOkQ2lOou/zHtov8u7o/FuQ/waZo+J6Y+nljEJeMCiph8wOwuwDEuLGEGsNDveAHF0IoG5shCF23sS/6R4NdGLwTIHw5J2Ec1IZdBsrdLAjmEWRIEF8H6zdW7M/LT6esfb19UztU2S5LVahWbMh9BwZ02sTbLxJQ5/qPcy5jMKjBAJGvJAggrCo42mSBb2omtIeclzwc6e9gEyQv+PZ0z4fQJshvDD2iekE9XU8ILUI6XLVfLQ9P+TskagTrYQjcuWwiGBG+I/1amTohtpGSmHbrYvoEuotYx1+y4QblysASzi58r9+rkaKL+OptdkqCC5LoAPxkcDqPeEDohueKykTQ7TdOISnYfnt6kaYc6kfFneKIw8wVTIVsfuMMVkdu89Y5xZR1T+fdiRhu+5A/t7hdhn8TnwaMulKEEV+kCx522PnVw6mU0GaowWW8nY5dgSVocIGDuhgHqWxJdh+LpsiRZV9q6Llvj8O6SO2TmjhmOHdgTicehyIbkETpnogoADknEAxyUg3PbXePq4npGfmEOVqz1QUWT+6rfpm/To1pR9BGNk8spCR6GFNxpC4NarO+jaoPwcxT7YWshbwx37TVeC+FZADNgJg3ysEmN3p7Xjs9BiEb9l3dDwvz258xzji3tajvIL+6ZrENB7vR/epKenI7G6Wiczsavs/RN9uo0Pj0Z/xXys9QeQJ89h64gr2Bs8D2Nx4eZejn1BZdrKRvlu65akhV3FWFHNkYaUcFzUNbj7FejQex9OCF/BItkHCOtIfeGZrvkrmoWca5lkodrm8+F0ItEMq6S3oRNziYfPn08n4zeT88uPl5fjMZxGrt758OHxSCZ2sURduD94fTC77AvHzq+3g6c/9nu3Gejg3uX1IJxhZnS7yShc9xsNmka0Wxvqw7N4zbqG8ANXa8XzMInI7oOfw5rL7aUglvsFo8svrvh/fc78FFXvkC7t47fMdGgFMVaHZrYP4T44qrfoF+Sb78tHEXV/8hUuwtpQLsT4+62i2gFrADjQQaBswBlNEM1WwUHayi+kIQbkzyH2j0pe7szOi5/v55hK+rfGKQu8I5hK3yHYSua0TmdI2Dtw+O7nP99TQVTy4YtUT7oxb+/AQDYBpk= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -45,7 +45,7 @@ which is not meant for production use. The document link was created successfully. -
Schema
+
Schema
The document link creation failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance-by-key-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance-by-key-alpha.api.mdx index 98db3963b2..ab996c389c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance-by-key-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance-by-key-alpha.api.mdx @@ -54,7 +54,7 @@ The evaluated inputs of the decision instance. The matched rules of the decision instance. -
  • Array [
  • evaluatedOutputs object[]
  • Array [
  • ]
  • ]
  • +
  • Array [
  • evaluatedOutputs object[]
  • Array [
  • ]
  • ]
  • The decision instance request failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance-by-key-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance-by-key-alpha.api.mdx index 33070be15e..5c5d725101 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance-by-key-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance-by-key-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Returns flow node instance as JSON." sidebar_label: "Get flow node instance by key (alpha)" hide_title: true hide_table_of_contents: true -api: eJztGV1z2zbyr2DQl2QqS0rr9nJ6oyU6YSPLOpGyr2N7PBC5FNGQAAOAljUa/febBUlJFukkvsv1yQ8eGYvFfu9iudhQw5aaDm7oeSpXRMgICBfaMBECvevQCHSoeG64FHRAZ2AKJTSJG7iEafKHfznp3orBYCCkgVsRJFwTEFEuuTCEa8IEYWmeMBIDM4UCwkREhDQEBFukEBEpyJBlhYgYCdNCG1CayMIQGROTAFnIx+6t8AHs6qZGfU9mrh8QZ+oR+QDqgcPq7k2P5VyfGClT3QtLxBOW8xMF2jQAJ/W5bhb99KUAtcatt7cilorEhTIJKBKBYTzVpYa3gnZozhTLAKWkg5sNFSwDOqBoHLSNV5nmE6xph3K0X85MQjtUwZeCK4jowKgCjo0cJGhNzZcCIvIZ1rX2TaN3yCrhYUJYaDQ6gJFC8C8FEB6BMDzmoAhqYNARzeNd2qE6TCBjdLChZp2j9FwYWIKiHRpLlTFTgn4/pdvtHUqucyk0aDzxS7+PP03pW8KDa6KLMASt4yJN10TZSIKoaw0ZSmFAGKTG8jzlIUNqvb80ktw0hZSLvyA06AElc1CGlwIh38mR5ds0+7q9f4BVj01nBUXljyRrClLh7Q2HAcC0liFnBiJi5Nf4ftOHO0FGEHPBkfE3RYl2qP9/YbyoXZZFnom9baIXC6GN4mKJLLVhyoyYgSYjhJJVAqItgO05iJo0D/SKmIETwzNARiCi/4INGkInL+GzC/pnTHfAJPpW3DasZRTAFItWe4Qwk5BYyawZtimwiIvlS71TAhq81jlgFdwTYVVYQkQ02PvhgaUF6DazgSgyvODmE3/qDr1zzx3RDp3OLoeu79MO9edn9/uVe+VOgvunMD9wZsG93aEd6k0Cd3bhjjwncO+HTjD82L4VfJxdXu+2zi7nk5Ez+3MHcCej3f++O7vyhu594PifaIfO3KHrXe2Wc9+d1f9fOJO5M65X1Y/77+F47uOJD07gXjt/WlGasKkzc8Zjd3wAKtU9c3x3dAD13X/N3cnQvT8fX14j1/k48O69iR84CD27HCHW0BmP751h4F15Aa7P5r43cX3/fjYf74T3hzNvGuxWqHWt1uTT5PJ6Qu/KrGxLFR/BTz1/2HC8OASssC6KfnkxHbuBjQR0mTdxcIGicBHaQt8iTSJXGjPXtgPPhDVJmG10ajJd4sUEr3nCUi0Pdz7BGq/FXMkHHj3J+IWUKTBBD6RprdJetXlcl1fcJP9jZTYgmDDP1ZRyFwtK1ZvstG0mNRLjJkXQ+dH97BnI6HaLKKcv6CU+gCEx4ylEXXIhFdSdGWEKduYkXFjJ6o6FLGS0/mq3kSu5SCH7udl1PJXKIdMSs+JLym6kDEhEXJTcb2bnQ/LP09/+cfcmMSbXg15vtVp1VRyeQMSNVF2plj0Vh/iHeG+7JEhAAcnYmiyAsCiylyJLyb7PITqHkMc8LEurVdgKg2Yv9ft6k1SX2Gdvl0LxRo/kkPnMqxugtS3sx6ztmZgVKdJgC1mYwSJl4jPdB0CT6TEXXWQZU7uW9ymDqk4U+pvt6q+/tHZ5H4NgSkoSJMSQ2l2HFSNUIuOCZ1guTvv9Ds3YY7n6vd/fIk30+HdoIgg85ikTNrSO1eGCZPu47ZZ5Xn1z/RjPSMWX/Jhv90kyVkE8KjWqs/D0u7OwKjJAlvwBytZwxbT9nItlIV5z8zU3X3PzB+bmb203pIPthAGFcQhKSUVkGBZKYROQ8HT3EVfzxskDaPOaa6+59pprz+XatkMzMImM6IAuwUaO/QSmvXq0d1KLqXublnHfFgdroB7qwWChUjqgmzKRtoNeb5NIbbaDTS6V2fYe0EsPTHEcglqn4naZcHUgpTJkqQW3ORQ3cPpYK3o0Gf3ADKzY2hoYWT4l/b7/vt9KFVGfoYiz1lLDMhwPSkRNFnO9lWyJ/D2E7chRQ1gobtY+HivNswCmQDlFOZeowqTiZ6nbjyiLRDvVP+d18PxxHVj/cxFLe7yKg6Yg6BVQupS8333XjLmpZ1MnlFlWCFs/xbJsjNiBYtUoG5Mq5SEIbaO7mhbXaONyh1yVHMm7LjqljJy6bC65SYpFN5RZPcHe/S5SuehljItexUL3hs4FjhxOxt7Qnfjuybtuv2sejVU+l9pkTBzIYT+qml3eYm07uzd2bv/22AKb/R3y+jbw9G2gikoDj6aXp4zbr3nrzk1VTm5os5zQDh20vR/cdaqacEM3mwXTMFfpdotgKxEd3NztS4itORHX1m50ELNUHz8yHDruzax6jnhL/tanh1YLVUAm1rYmpgWuaId+xvlH69PKFoc2CbAIlFW8xHTCEHJzQKPxroC1ZVfmP7hYFP4Dh/dKRA== +api: eJztGV1z2zbyr2DQl2Sqr7RuL8c3WqYTNrKsEyn7OrZHA5FLEQ0JMABoWaPRf79ZkJRlUU7iu1yf/OCRsVjs9y6Wiw01bKmpc0PPM7kiQsZAuNCGiQjoXYfGoCPFC8OloA6dgimV0CRp4RKmyR/B5bh3KxzHEdLArQhTrgmIuJBcGMI1YYKwrEgZSYCZUgFhIiZCGgKCLTKIiRRkyPJSxIxEWakNKE1kaYhMiEmBLORD71YEAHZ106C+J1MvCIk78Ym8B3XPYXX3ps8KrrtGykz3owqxywreVaBNC9BtzvXy+KcvJag1br29FYlUJCmVSUGRGAzjma40vBW0QwumWA4oJXVuNlSwHKhD0ThoG782zSdY0w7laL+CmZR2qIIvJVcQU8eoEg6NHKZoTc2XAmLyGdaN9m2jd8gq5VFKWGQ0OoCRUvAvJRAegzA84aAIamDQEe3jPdqhOkohZ9TZULMuUHouDCxB0Q5NpMqZqUC/n9Dt9g4l14UUGjSe+GUwwJ+29EfCg2uiyygCrZMyy9ZE2UiCuGcNGUlhQBikxooi4xFDav2/NJLctIWUi78gMugBJQtQhlcCId/xgeWPafZ1e/8Aqx6azgqKyh9I1hakxns0HAYA01pGnBmIiZFf4/tNH+4EOYOEC46MvylKvEP9/wvjx98tC49fLIo2ioslMtaGKXPGDLTZIZSsUhDHwtieg7hNc0+7mBnoGp4DMgIR/xdsUEmdvoTPLvSfMeAek/hb0duyllEAEyxdx33DTEoSJfN28GbAYi6WL/VOBWjxWheAtfCRCKsDAmKiwd4S9ywrQR8zG4gyx2tuNg4m3tA/970z2qGT6eXQCwLaocHsdP648q68cTh/CgtCdxrO7Q7tUH8cetML78x3Q28+dMPhx+Nb4cfp5fVu6/RyNj5zp3/uAN74bPd/4E2v/KE3D93gE+3QqTf0/KvdchZ40+b/C3c8c0fNqv7x/j0czQI88cENvWv3TytKGzZxp+5o5I32QJW6p27gne1BA+9fM2889Obno8tr5Dobhf7cHwehi9DTyzPEGrqj0dwdhv6VH+L6dBb4Yy8I5tPZaCd8MJz6k3C3Qq0btcafxpfXY3pXZeWxVAkQ/NTz+23Hi0PACuuh6JcXk5EX2khAl/ljFxcoSsq0LyJb8Y8IlMqVxuS1fcEzkU1SZjseXpPpET8heN8Tlmm5v/MJ1ng/Fkre8/hJ0i+kzIAJzIk95LZAjaiHBXrFTfo/lmgDggnzXFmpdrGm1E3KTtt2XiMxbjIEnR9c1L6BnG63iHLygqbiAxiSMJ5B3CMXUkHTohGmYGdOwoWVrGldyELG66+2HYWSiwzyn9vtx1OpXDKpMGu+pGpLqphExEXF/WZ6PiT/PPntH3dvUmMK7fT7q9Wqp5KoCzE3UvWkWvZVEuEf4r3tkTAFBSRna7IAwuLY3nksI48ND9EFRDzhUVVdrcJWGDR7pd/Xu6Wmyj57wZSKt5oll8ymftMJrW1tP2RtzySszJAGW8jSOIuMic/0MQDaTA+56DLPmdr1vk8Z1KWi1N/sW3/95Wi79zEMJ6QiQSIMqd2NWDNCJXIueI4V42Qw6NCcPVSr3weDLdJEj3+HJoLAQ5ExYUPrUB0uSP4Yt70qz+uPrx/jGan4kh/y7T1JxjqIzyqNmiw8+e4srIsMkCW/h6pHXDFtv+sSWYrX3HzNzdfc/IG5+duxG9LFdsKAwjgEpaQiMopKpbAJSHm2+4JqeOMIArR5zbXXXHvNtedybduhOZhUxtShS7CRY7+Cab+Z8XUbMXV/c2Tut8UJG6j7ZkJYqow6dFMl0tbp9zep1GbrbAqpzLZ/j166Z4rjNNQ6FberhGsCKZMRyyz4mENxA8eQjaIHI9IPzMCKra2BkeVT0u8H7wdHqSLqMxRx6FppWIXjXoloyGKuHyVbIX8PYTt71BCVipt1gMcq8yyAKVBuWY0m6jCp+Vnq9iPKItFO/c95Ezx/XIfW/1wk0h6v46AtCHoFlK4kH/TetWNu4tvUiWSel8LWT7GsGiO2p1g908akyngEQtvorsfGDdqo2iFXFUfyrodOqSKnKZtLbtJy0Ytk3oyyd7+LTC76OeOiX7PQ/aF7gVOH7sgfeuPA677rDXrmwVjlC6lNzsSeHPajqt3lLda2s3tjB/hvDy2webxDXh8Jnj4S1FFp4MH0i4xx+zVv3bmpy8kNbZcT2qHOsYeEu05dE27oZrNgGmYq224RbCWizs3dYwmxNSfm2tqNOgnL9OFrw77j3kzrd4m35G99gzhqoRrIxNrWxKzEFe3Qzzj/OPrGsrVzG2AxKKt4helGERRmj0brgQFry67Mf/CwKPwHTBtN3A== sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -45,7 +45,7 @@ for further details. The flow node instance is successfully returned. -
    Schema
    +
    Schema
    The flow node instance Get failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx index fac7dde1e0..08b53456ff 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Returns incident as JSON." sidebar_label: "Get incident by key (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWd1v2zYQ/1cI7qXFFNvd0q3Tm2YrmdpENmwlK5YEBiWdLLYSqZKUHcPw/z6QlBx/tfG27i0PgW3yeJ+/uyMvK6zITGL3DgcsoSkwhR8cnIJMBK0U5Qy7eAyqFkwi2lAgItH7yTDs3DPXdRlXcM+inEoELK04ZQpRiQhDpKhygjIgqhaACEsR4woBI3EBKeIM9UlZs5SgpKilAiERrxXiGVI5oJg/du7ZBMD8umtJ36GxP4mQNwoQn4OYU1g8vOqSisozxXkhu4klPCMVPRMg1cHCWXuuU6Y/fKlBLPXW63uWcYGyWqgcBEpBEVpIa+E9ww6uiCAlaC2xe7fCjJSAXdy65AMssYOp9lZFVI4dLOBLTQWk2FWihn2XRjkgIiWdMUjRZ1i2Vrf8HLTIaZIjkiip3U1QzeiXGpDZpRkFgbS+Sru9PdTBDpZJDiXB7gqrZWU1VDADgR2ccVESZZd+Ocfr9YPWUlacSZD6xE+9nv441HQTeCqRrJMEpMzqolgiYZABace4KOFMaQC5K0yqqqAJ0Ty6n6RmtDpUjcefIFHat4JXIBS1anyG5Sn6P+fSf+nCtVFHmziAjDKquX/49xo1vFC6YWbCTaTkCSUKUqT4KSoE6ZYGUgnKZkflxVXJNkJpeqqggElFWALfwVLasDrJThCCi8hIe866tj4hcwZpYrSgKkfEOhdSJMGUjzkpapA6G4DVpa5tN+Fk5PeDi8AfYAffhB/C4Z8hdnAwnF57o1EQXk798Xg4xg5+P/x9Gg6nYz8aB/4EO7g/DAdBFAzDDYn/MRp7/Wh6613d+JvVvnd15Q+m/pV/7YfRZvkm/MMLB2ZHr0z9Wz+MsIOv/cnEu/Snk+Avf+p/7Pv+wCjXsBn4/WCyLfRpQYv1dhS6GI6vp+Ewml4Mb8IBfmgdew1SktkJvvWNS0tL3uSNpYhBmsJknU4ZKrmApjyaCGYFX4Q8hVMBqukR4ymcgs4N8/8Ozy25/wSgiQBTxSJanuDHAVGgEbgpmO3xzraSKVFwpjTDtYOlIuoEzhPVsN5R8eQE8PpRcOtr2AWXYy8ySBv7k+HVrfk68sNBEF4a5Hzi8dfcfOjVTzy2tZZmCB6pVNLZdqlR76BH7TciBysBMNJ98yQI6Q6LMsHLw5ozp2QHYdJcO47HXqICSErZ7HjkFTDClIX1oQ52V2N4r3NrA3dNWGtmVBWwVcQCBSVer/XW+bNd9xIUyggtIO2g66f0k4gIU3bnNIVU56bWo+3oKObp8pt9uRI8LqD88bA/7+rioZGlbOQi27d1T21rhJF+N77oo9/O3/768CpXqpJut7tYLDoiS84gpYqLDhezrsgS/afpXndQlIMAVJIligGRNDW9jhTo6UaAZAUJzWhio2QMNspoJ1v7vn2dUF/pLhsU1oIewMxDN+OgvSksDUb2RZszGakLzYPEvFZuXBD2GT+F+zkwe0jWZUnE5vq3K6CpDrV8tub9/NPRRPkjikbIskCJhv/mvtMI0kaUlNFSV4nzXs/BJXm0v37p9daap474CZYwBI9VQZiB1r45R9pGm4jfKTJc0Bndl9vZSb0GxANrUZt758/kXlPBAM3oHOzdbUGkechkvGYvGfmSkS8Z+R0z8u2xbugxpL0sNA7tRZQnSS2EvmHktNi8PVrZ+u0NUr3k2kuuveTa13Jt7eASVM5T7OIZGOSYGzjuts1Pdldb8621ni6BmLcTsFoU2MUrmzdrt9td5VyqtbuquFDr7lwHZU4E1dM+E0O9bfOrxU3BE1KY5WPx0xt6zNbatTcCvCQKFmRppxhc7LF+13vXO/544EJ9haMeKloLLfq2KkLLVqf2UbaW+BTGZu4mIakFVcuJPmbdEwMRILx65xXUyDPc9W9LhJ3my0WLlfd/RibclGXcHG/CfqiIjgoIaTXvdd4cQmwUmExJeFnWzJRLNmsfmk/8mpmtzqGCJsCkAXMzFm3JruwOurUS0ZuODopFTlslZ1TlddxJeNmOajefccHjbkko6zYiZLfvXd+EA+/sKuj74cQ/e9PpddSjMsZXXKqSsC099Mtpc5WLl+b69sqMpV/v2716ahQvA++tvqLgUXWrglCmc8KEbtVUirvN+FtiB7vbs/AHp0n3O7xaxUTCjSjWa71sFMDu3cNTdTDlJKXSuAm7GSnk/sB8Ozqvxs1o/TX638boR41vFglbmtJW1PoXduzAeudfAWs9SMmBpCCMcZbCSxKo1NbZgym5Lg2bonzp65z+G3170sA= +api: eJztWN1v2zYQ/1cI7qXFFNvt0q3Tm2YrmdpENmwlG5YEBiWdLLYSqZKUHcPw/z6QlBx/dfHW7i0PgSPyeJ+/uyNvhRWZSeze4YAlNAWm8IODU5CJoJWinGEXj0HVgklEGwpEJPowGYade+a6LuMK7lmUU4mApRWnTCEqEWGIFFVOUAZE1QIQYSliXCFgJC4gRZyhPilrlhKUFLVUICTitUI8QyoHFPPHzj2bAJivu5b0PRr7kwh5owDxOYg5hcXDqy6pqDxTnBeym1jCM1LRMwFSHSyctec6ZfrDlxrEUm+9vmcZFyirhcpBoBQUoYW0Ft4z7OCKCFKC1hK7dyvMSAnYxa1LPsISO5hqb1VE5djBAr7UVECKXSVq2HdplAMiUtIZgxR9hmVrdcvPQYucJjkiiZLa3QTVjH6pAZldmlEQSOurtNvbQx3sYJnkUBLsrrBaVlZDBTMQ2MEZFyVRdunnc7xeP2gtZcWZBKlPvO319M+hppvAU4lknSQgZVYXxRIJgwxIO8ZFCWdKA8hdYVJVBU2I5tH9JDWj1aFqPP4EidK+FbwCoahVY9unJ9jxnGv/oyvXRi1t6gAyyqjm/g0aNbxQumFmwk6k5AklClKk+CkqBOmWBlIJymanyqPpqeICJhVhCXwHe2nD6iRrQQguIiPtORvbaoXMGaSJ0YKqHBFrMqRIgikmc1LUIHVuAKtLXeluwsnI7wcXgT/ADr4JP4bDP0Ls4GA4vfZGoyC8nPrj8XCMHfxh+Ns0HE7HfjQO/Al2cH8YDoIoGIYbEv/PaOz1o+mtd3Xjb1b73tWVP5j6V/61H0ab5Zvwdy8cmB29MvVv/TDCDr72JxPv0p9Ogr/8qf9n3/cHRrmGzcDvB5NtoU8LWqy3o9DFcHw9DYfR9GJ4Ew7wQ+vYa5CSzE7wrW9cWlryJnssRQzSlCnrdMpQyQU0xdJEMCv4IuQpnApTTY8YT+EUdG6Yfzs8t+T+G4AmAkxNi2h5gh8HRIFG4KZ8tsc720qmRMGZ0gzXDpaKqBM4T1TDekfFkxPA60fBra9hF1yOvcggbexPhle35t+RHw6C8NIg5xOPv+bmQ69+4rGtuDRD8Eilks62S416Bx1rvy05WAmAke6ip1U6onKUCV4e1pw5JTsIk+YScjz2EhVAUspmxyOvgBGmLKwPdbC7GsN7fVwbuGvCWjOjqoCtIhYoKPF6rbfOn+3Bl6BQRmgBaQddP6WfRESYsjunKaQ6N7UebX9HMU+X/9ilK8HjAsofD7v1ri4eGlnKRi6yXVx31rZGGOl344s++vX83S8Pr3KlKul2u4vFoiOy5AxSqrjocDHriizRf5rudQdFOQhAJVmiGBBJU9O3SIGe7gdIVpDQjCY2SsZgo4x2srXvny8X6ivdZYPCWtADmHnoZhy094Wlwci+aHMmI3WheZCY18qNC8I+46dwPwdmD8m6LInYXAZ3BTTVoZbP1ryf3h5NlN+jaIQsC5Ro+G9uPY0gbURJGS11lTjv9Rxckkf79XOvt9Y8dcRPsIQheKwKwgy09s050jbaRPxOkeGCzui+3M5O6jUgHliL2tw7fyb3mgoGaEbnYG9wCyLNsybjNXvJyJeMfMnI75iR7451Q48h7WWhcWgvojxJaiH0DSOnxebt0crWL3GQ6iXXXnLtJde+lmtrB5egcp5iF8/AIMfcwHG3bX6yu9qazKz1rAnEvJ2H1aLALl7ZvFm73e4q51Kt3VXFhVp35zoocyKonv2ZGOptm18tbgqekMIsH4uf3tBDt9auvYHgJVGwIEs7xeBij/X73vve8ccDF+orHPWI0Vpo0bdVEVq2OrWPsrXEpzA2UzgJSS2oWk70MeueGIgA4dU7r6BGnuGuvy0Rdpp/LlqsfPgjMuGmLOPmeBP2Q0V0VEBIq3mv8+YQYqPAZErCy7JmplyyWfvQfOLXTHB1DhU0ASYNmJshaUt2ZXfQrZWI3nR0UCxy2io5oyqv407Cy3Zwu/mNCx53S0JZtxEhu33v+iYceGdXQd8PJ/7Zm06vox6VMb7iUpWEbemhX06bq1y8NNe3V2ZI/Xrf7tVTo3gZf2/1FQWPqlsVhDKdEyZ0q6ZS3G0GtxI72N2e4j44Tbrf4dUqJhJuRLFe62WjAHbvHp6qgyknKZXGTdjNSCH3x+fb0Xk1bgbtr9H/NlQ/anyzSNjSlLai1l/YwZ/1uGRniL3Wg5QcSArCGGcpvCSBSm2dPZiZ69KwKcqXvs7pvwGDE9hq sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -45,7 +45,7 @@ for further details. The incident is successfully returned. -
    Schema
    +
    Schema
    The incident Get failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-by-key-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-by-key-alpha.api.mdx new file mode 100644 index 0000000000..3dccb8f653 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-by-key-alpha.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-process-definition-by-key-alpha +title: "Get process definition by key (alpha)" +description: "Returns process definition as JSON." +sidebar_label: "Get process definition by key (alpha)" +hide_title: true +hide_table_of_contents: true +api: eJztWEtz2zYQ/is76MWeUqSSOGnKm8ZxUreJ67GV9mD7AJJLEQkJMHhI1mj43zsLkpYsMrE9k+nJB49MYPHt81sSu2GWLwyLr9i5VikaAxnmQgorlGQ3AcvQpFrU/jFmF2idlgbqgSxwA39e/n0WXss4jqWyeC3nhTCAMquVkBaEAS6Bl3XBIUdunUbgMgOpLKDkSYkZKAnHvHIy45CWzljUBpSzoHKwBUKibsNreYnon6560bdwcXI5h9n5Kagl6qXA1c1BxGthJlap0kRpKzjhtZhoNHawMOnPhVX2yzeHek1bh9cyVxpyp22BGjK0XJSm9fBasoDVXPMKyUoWX22Y5BWymHXBeXcXm79wzQImKIA1twULmMZvTmjMWGy1w/0ozwsEboxYSMzgK65794dRD2BViLQAnlpDGeDgpPjmEESG0opcoAZywVImhsdDFjCTFlhxFm+YXddkvpAWF6hZwHKlK27bpTdHrGluyHJTK2nQ0ImX0yn9DK0fqQ9hwLiUVnNXlmvQvpQwC30kUyUtSktovK5LkXI6FH0xBLkZGqmSL5haSoFWNWorWoNGQz9qIYX1gcg8GI+gy/g+/hmvsM3ZQ9jGaiEXhKTRKKdTPBtFvOh2gRQ+0u4t9hK1EW0g78P+0248ztbxOLx6uaNhzhffV2L54qlBGaTzNBviD/sWiOypmixKLu0Y/NzvPBmSMIUtcWvgjhcWK9Y0JHP0BAZR00BjIeeixCyET0pj35SAa39mKTLMQEjfL3quQqKy9Q95VmuVlFj9OuTbfctmcN5Kdnqh5SG1nlYwabVfXbw/ht+PXv92c1BYW5s4ilarVajzdIKZsEqHSi8inaf0R3KHIcwL1AgVX0OCwLPMO81L2DIcTI2pyEUKVvUN0RtDsW/9+3F7aHc3e7naKWinBdvvxjP4fHHaN9S1kIuhan8m564kDJ4oZ+Ok5PIr21bBUOm+FuOqiuvdZr+joAmYsdw682CjfvVygE319Md8fg4tBKQqu99ESBE5UQkpKlex+Gg6DVjFb9unN9NpQ5iU8Ud4IgFv65JLX1r77ggJ1bZuvWNCGstl+rMyo7RYiH294T4jafFd61HPxKNHM3ElbOHRF2KJ0r9LVtz4L5lcOfnMzWduPnPzJ3Lz9dhbciaBoqypDlFrpUGlqdMaM/ooLu+I2+vuXp/PXHvm2jPXvse1JmAV2kJlLGYL9JVDN9aYRR2bJtvXoIk2Y/ethi6VqJf9rdjpksVs01KpiaNoUyhjm3hTK22baEl5WnItaALg00rbLeX6UipVyku/PJZS2pB3Vy6EvbHAB25xxdc+xKTyPvTb6dvpKCqJfgeRBg2th21B7jSJHpbYPgrbCj8G2F+3DaZOC7u+pGNteBLkGvXMUVruCqXT59HpuRViQffP+758/vx37itAyFz5410lDA1hO/dGNg1fDKvu/NSTJ1VV5aTvoHLRfhrxHce6OQ7RqhQpSuPruxuV9GIf2x3o74ovQkpKWzl941wIW7gkTFXVj2/ufpNSJVHFhYw6FSY6nn36fPZuNvl4enxydnkyeRFOQ3trvfO1MrbicseOD2jHvvOStf+2O/BDq8P9CGy2b5Hnwdj9wVhXlRZvbVSXXEjiiU/npmsoV2ykobCAxaMjnJug6wpXbLNJuMHPumwaWvY2sfjqZttEfNfJhPGRY3HOS7M/YttN3cFFN4w7hP918DYao26Ry7XviqWjJxawrzTHGh9vNTdNwArkGWrveSs6S1Os7Q7IYKxG7eWu1384ob7wH6hhsbc= +sidebar_class_name: "get api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Get process definition by key (alpha)

    + + + +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. +::: + +## Request + +

    Path Parameters

    + +The process definition is successfully returned. + +
    Schema
    + +The process definition request failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The process definition with the given key was not found. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml-alpha.api.mdx new file mode 100644 index 0000000000..ace97d3f84 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml-alpha.api.mdx @@ -0,0 +1,73 @@ +--- +id: get-process-definition-xml-alpha +title: "Get process definition XML (alpha)" +description: "Returns process definition as XML." +sidebar_label: "Get process definition XML (alpha)" +hide_title: true +hide_table_of_contents: true +api: eJztWEtv20YQ/iuD7cVGKVJJnTTlTXCc1K0dGLbSBpB1WJJDcRNyl9mHZEHgfy9mScqKRCE5pDcdBIrL2Xl+35CzG2b5wrB4xu60StEYyDAXUlihJJsHLEOTalH725jdo3VaGqgPZIEb+HR7Ez7KRxnHsVQWH+W0EAZQZrUS0oIwwCXwsi445Mit0whcZiCVBZQ8KTEDJeGSV05mHNLSGYvagHIWVA62QEjUU/goHxD93awXfQP3Vw9TmNxdg1qiXgpczc8iXgszskqVJkpbwRGvxUijsQcLo35fWGW/fHWo1/To/FHmSkPutC1QQ4aWi9KEPsJHyQJWc80rJC9ZPNswyStkMeuy83abnL9xzQImKIM1twULmMavTmjMWGy1w/00TwsEboxYSMzgC6778A/THsCqEGkBPLWGSsDBSfHVIYgMpRW5QA0UgqVKdNtDFjCTFlhxFm+YXdfks5AWF6hZwHKlK27bpdcXrGnm5K6plTRoaMfL8Zguhy5/ur057imV37iUVnNXlmvQHkuYhT6TqZIWpfUe4ZONnqqS/h/4aawWcsGapmkC9nJ8MezJgPkVN5ArJzNInIVMofHAK/gSO+AOeFGXnKr2PT8ujmVkwA+qPBoLORclZiHcKo09soBrv2cpMsxASJ/KPveQqGx94Cav61KknFRHtVZJidWvn43ac/pbzyZw10p2dkElnzG1hJ9WMGmtz+7fXcIfF69+n58V1tYmjqLVahXqPB1hJqzSodKLSOcp/UjuPIRpgRqh4mtIEHiW+aB5SVHVqK1AA6bGVOQiBat6rHhnKLNtfF2OW7eIZtvNzxXYr8QOcJ0WbJ9SE/h4f92zYi3k4tC035NzV5IOnihn46Tk8gtrAmaFLQeN7lsxrqq43mXsjoEmYMZy68x3iffbywPdhKc/p9M7aFVAqjL8httkiIKohBSVq1h8MR4HrOJP7d3r8bghnVTxH4hEAj7VJZceWvvhCAnVM259YEIay2X6syqjtFiIfbsha55rwToQv20j6pl4pCNkmArj+4Cwhde5EEuUvrtSa6Be4NvDiZEnRp4Y+fMY+Wro3TiRQFnWhEPUWmlQaeq0xoy+Z8rti7O33b00T1w7ce3EtWNcawJWoS1UxmK2QI8cGjZiFnVsGj1/hppoMzSlNP67O2AG9bIfapwuWcw2LZ2aOIo2hTK2iTe10raJllSrJdeCBjhfWnrc0q6HU6lSXvrlobLSA5qc+nD3prr33OKKr32ayeS3qt+M34wHtZLoEY00J7YRtqDcaRS9WmL8oNpW+EcU+8HJYOq0sOsH2tamJ0GuUU8clWYLls6e1073rRALuj/vegj99e/Uo0DIXPntHRoOHaGqoDat5+PwxSHy7q49gVJVVU76LioX7ecR3wmsG8OJWqVIURqP8W7S7cVu2ifwT2sRXoRUlBY5ffNcCFu4JExV1U/f22tSqiSquJBRZ8JEl5Pbjx/eTkY315dXHx6uRi/CcWifrA++VsZWXO748R7t0KxFA+mZP3A43w9/8/waOZ1q7J1qdJjcmYCbrpibrqXM2EBLYQGLjxx9UFeZB11nmLHNJuEGP+qyaWjZe8bi2fy5kfjOkwnj88finJdm/5Rkt4Jn9915yjn8/2cng+npFrlc+3ZYOrpjAfuC62MnQs28CViBPEPtw21FJ2mKtd1Rsj0OoX6ybfDvr6gR/Af/Pdv+ +sidebar_class_name: "get api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    Get process definition XML (alpha)

    + + + +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. +::: + +## Request + +

    Path Parameters

    + +The XML of the process definition is successfully returned. + +
    Schema
      + +string + +
    + +The process definition was found but does not have XML. + +
    Schema
      + +string + +
    + +The process definition request failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +The decision with the given key was not found. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/get-process-instance-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-instance-alpha.api.mdx index cb8af867ad..4fa0c25811 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-process-instance-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-instance-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Get the process instance by the process instance key." sidebar_label: "Get process instance (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWUtz2zYQ/is76CHOlKLk1ElT3jSykrp1XI2tJAfbB4hciYhJgAGWkjUa/ffOgqQfEm2rnh518MgCl99iH98utFgJkjMnoksxsiZG50BpR1LHKK4DkaCLrSpIGS0i8RkJKEUoNiRhsmxfv8FleKWvdBRF2hBe6XGqHKBOCqM0gXIgNcisSCVMUVJpEaROQBsC1HKSYQJGw0DmpU4kxFnpCK0DUxKYqVc5Mbfhlb5A9N8uG9GPcD68GEN/dAJmjnaucHF90JWFch0yJnPduBLsyEJ1LDraWug074V58svPEu2SH7290lNjYVpaStFCgiRV5kJv4ZUWgSiklTnyLkV0uRJa5igiUTvmpPbL37gUgVDs0kJSKgJh8WepLCYiIlvipt/HT/lWBMLFKeZSRCtBy4J1KU04QysCMTU2l1QtfTgS6/U1K3KF0Q4dv/Gu1+OPHZQpB66MeW1aZtkSLFJpNSa8g9hoQk2MJIsiU7FkpO4Px3CrBxt8rGcz3cChtHEKzQ5BEeaMX9tlJj8wJnaxNQVaUpUNLa5t88W2jTe4rJJIuS17wxbvBY2qY5wqrRjpJHmgy5FVetaqqoFP7t4ElYStkGc+YV4JytnWDvsNrVNVPHZwTQv0vALYdMxv755TN5azV9tSKwSSs3aTdo90C3pNnu0YW2No9NqU4pefJGpLPkmL+vXaqtf/s75PmVmcmQRfrXCamQVok+AOKskijrjE7ZYGklLm5A0uHZBp52YADrnKEibcd9503/j8cCQtHUvakT1eHBJJj7nOCx1SOTIk6mR3QNTJC3COarDW3RAGYDSy+f3B+OTbMIDBP19Gp8Px8DiAQf9sMDwdHjM66jLnfl2JiUDcyfH/tSA3b1KU4X2lbQJ+wcqGDLLmJhSrpK7etZETYzKUesvK7yn6ptcaFUilAwkWMx+YBhaM5W7uI0SopaZda2YlXdXJ9ZO2nBDmYr1miaNnmtlcJejDI7mT8fFiLjP1XPcqrJlkmP/6Uhfrw6iSrM8CULUpkFxuWHDivQGX558G8MfR+9+vD1KiwkXd7mKxCO007mCiyNjQ2FnXTmP+Y7m3IYxTtAi5XMIEQSaJL10yg/sGCK7AWE1VXLHF2+o3w/4N/YHk+e5ZPd2Ox10Gl1ZthacPX89PwMdXTZdKz7ZV+3emsswYQ05MSdEkk/pG3IfypSTogyvzXNplc9R7rKAmVOlePPr89q41wf4cj0dQQUDM1YwPdk1usyI2Ilda5Uy3o14vELm8rb596PXWjMkR38ESDXhbZFL71No0R2nIjcU6f8KKlPUJ/P+JjLFqpjb1btGKF48rixpCHbYTig+r6AgyGd+4ikkgS0pZa0UfiC36TcjM7Um2J9meZE+T7GjHn2ALRanHnqk5+hMsLGTVzKam1PtmtufZnmdP8ux92+mwr4G9bDkP0VpjwcRxaS0msEhVdkfCRnfd+PZM2zNtz7R2pq0DkSOlJhGRmKHPHP/zX3RrLnWaXbruant2t+aJJtp5Mz8tbSYisapotI663VVqHK2jVWEsrbtzjtFcWsWzYh9SflzRrUmjzMQy88tt4eQHPDZrzNwYIH+WhAu5rCZQxm5Af+x97LUPMoylJxB5JF1ZWCXjgwLRwDLT24cWXngXYD/rdRiXVtHygl+r3DNBadH2y0cTmVqfR/cDAC8kgvqfT03q/PV97KOv9NT41+ss2N4IR6WZOIpeeLidcaMTT5zY5HmpffXUs+qIIx8YVk/8mVKZilE7n9v1UL0RO62eQD10hMOQg1JlTlM0Z4rSchLGJm8G/Xefk8xMurlUulurcN1B/8vXs+N+5/RkMDy7GHYOw15It+SNL4yjXOoH++Bbka3T2oG/1Xi7afjqvnHsb1Nevk2pE5TwlrpFJpVmyvjIruq6cim26ooIRNRyK3Ad1MXhUqxWE+nwq83Wa172+xHR5fV9LfHFJ1HOe01EU5m5zVuZh6E8OK/vb97Cc3c1rebUi1IvfS3LSv4mAnHDc9m264319ToQKcoErd9mJdiPYyzoAcTWXQyXhLva/HnIXP4Xyfq2fQ== +api: eJztWUtz2zYQ/is76CHOlHo4ddKUN42tpGodV2MrycH2ASKXImISYIClZI1G/72zIOmHRNuqp0cdPJLA5bfYx7cLL1aC5MyJ8FKMrYnQOVDakdQRiutAxOgiqwpSRotQfEYCShGKDUmYLtvXb3DZvdJXOgxDbQiv9CRVDlDHhVGaQDmQGmRWpBISlFRaBKlj0IYAtZxmGIPRcCzzUscSoqx0hNaBKQlM4lVOzW33Sl8g+l+XjehHOB9eTGAwHoGZo50rXFwf9GShXIeMyVwvqgQ7slAdi462FjrNe908/uVniXbJj95e6cRYSEpLKVqIkaTKXNdbeKVFIAppZY68SxFeroSWOYpQ1I4Z1X75G5ciEIpdWkhKRSAs/iyVxViEZEvc9PvkKd+KQLgoxVyKcCVoWbAupQlnaEUgEmNzSdXShyOxXl+zIlcY7dDxG+/6ff7YQZly4MqI15Iyy5ZgkUqrMeYdREYTamIkWRSZiiQj9X44hls92OBjPZvpBg6ljVJodgiKMGf82i4z/YERsYutKdCSqmxocW2bL7ZtvMFllUTKbdnbbfFe0Kg6wURpxUij+IEuR1bpWauqBj6+exNU3G2FPPMJ80pQzrZ22G9onarisYNrWqDnFcCmY35795y6iZy92pZaIZCctZu0e6Rb0GvybMfYGkPj16YUv/wkUVvySVrUr9dWvf6f9X3KzOLMxPhqhUlmFqBNjDuoJIs45hK3WxpISpmTN7h0QKadmwE45CpLGHPfedN74/PDkbR0ImlH9nhxiCU95jovdEjlyJCo490BUccvwDmqwVp3QxiA0cjmD44no2/DAI7/+TI+HU6GJwEcD86Oh6fDE0ZHXebcrysxEYg7Of5eC3LzJkUZ3lfaJuAXrGzIIOtApNKNdKTiuoDXdk6NyVDqLUO/p+j7XmtgIJUOJFjMfGxUDQvGckP3QSLUUtOuZbOSrkrl+klzRoS5WK9Z4uiZfjZXMfoISW5mfMKYy0w918AKa6YZ5r++1MgGMK4k6+MAVJ0KJFccFpx6b8Dl+adj+OPo/e/XBylR4cJeb7FYdG0SdTBWZGzX2FnPJhH/sdzbLkxStAi5XMIUQcaxr14yg/seCK7ASCUqqgjjbfWbYf92/Znk+QZaPd2Ox10Sl1ZthWcAX89H4OOrkqXSs23V/p1ElhljyKkpKZxmUt+I+1C+lAQDcGWeS7tsTnuPFdScKt2Lp5/f3rUm2J+TyRgqCIi4oPHZrsltVsRG5EqrnBl31O8HIpe31a8P/f6aMTniO1iiAW+LTGqfWpvmKA25sVjnjzfs7hD+/0TGWDVTm3q3aMWLJ5VFDaEO2wnF51V0BJmMblzFJJAlpay1og9EFv0mZOb2JNuTbE+yp0l2tON/YQtFqceeqTn6QywsZNXMElPqfTPb82zPsyd59r7tdDjQwF62nIdorbFgoqi0FmNYpCq7I2Gju258e6btmbZnWjvT1oHIkVITi1DM0GeOnwCIXs2lTrNL11ttj+/WPNREO29GqKXNRChWFY3WYa+3So2jdbgqjKV1b84xmkureFzsQ8qPK7o1aZSZSGZ+uS2c/IAnZ42ZGzPkz5JwIZfVEMrYDeiP/Y/99lmGsfQEIk+lKwurZHxQIBpYZnr73MIL7wLsx70Oo9IqWl7wa5V7pigt2kH5aChT6/PofgDghURQf/nUpM5f3yc++konxr9eZ8H2RjgqzdBR9LuH2xk3HnniRCbPS+2rp55VRxz5wLB66M+UylSE2vncrufqjdhp9QTquSMcdjkoVeY0RXOmKC2n3cjkzaz/7nOamWkvl0r3ahWudzz48vXsZNA5HR0Pzy6GncNuv0u35I0vjKNc6gf74IuRrdPagb/YeLtp+Oq+cewvVF6+UKkTlPCWekUmlWbK+Miu6rpyKbbqighE2HIxcB3UxeFSrFZT6fCrzdZrXvb7EeHl9X0t8cUnVs57TYSJzNzmxczDUB6c11c4b+G565pWc+pFqZe+lmUl/xKBuOHRbNsNx/qaR3coY7R+m5XgIIqwoAcQW9cxXBLuavPnIXP5X1+1t5k= sidebar_class_name: "get api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -46,7 +46,7 @@ for further details. The process instance is successfully returned. -
    Schema
    +
    Schema
    The provided data is not valid. diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx index 7fb7b72cf6..dcd4246539 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx @@ -46,7 +46,7 @@ for further details. The decision instance search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • ]
    The decision instance search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx index 067416d456..341e4fc145 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Search for flow node instances based on given criteria." sidebar_label: "Query flow node instances (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWu2P2jga/1cs34dtdRmg3e5ej28ZJrObLWVYEqa3mhmNTPKEeJvYqe0MgxD/+8l2AgFCC93qdKdrpWrw2/Pi5+1nOyusyFzi/h2+zvgCMR4D8plUhEWAHxwcg4wELRTlDPdxAEREKUq4QMlmOq2mSzQjEmLEGZrTJ2AoElSBoKRzz+5Zv99nXME9C1MqEbC44JQpRCUiDJGsSAlKgKhSACIsRowrBIzMMktwQPKSxQRFWSkVCIl4qRBPkEoBzfhz554FAKZ1V099iyZeECJ37CP+BOKJwuLhRZcUVF4ozjPZjezEC1LQCwFSHXRc1Os6efy3TyWIpR56ec+M/qVQKQgUgyI0kx2j4T3DDhbwqQSpLnm8xP2VaVIBMe4nJJPg4IgzBUzpMVIUGY2I3t3un1Jv8QrLKIWc6F+7e399sOFIWnNUDLGDSZbdJLh/t8JqWQDuYz77EyI9UghegFAUpOHBheFfzSJCkCV2MFWQm/FT6SQUsrhBSCpB2RyvHcxFDOJwRDtUQspMaa4ywuu109igu4rgg4MVVRlsPO53vfkBF2pSqbp+0CsLMoezxBU8b8hEmYI5COzghIucKNv142stf0Zzqk6ca83gJmpH44NN3ZVtvVl4CQkXcM7Kdev+jMkctvvjtPBrWXR8waGts0rBk7c744sRj6HOJ+9g2bqju34epoCIlHTOIEYfYemgRUqjFJFISUQkIqhk9FMJiMbAFE0oCJOQlM4rh1mps2eyn99okxWCRyDl+ZJVC7cx+BGWWlweUaIgRop/lSBXkFBGNZ/zRYk3a7+5MH58mIc061mRs+1WxKfzPMgTUhEFh0wC3a0T/CEZ7QNGZYiRBFMFnkhWgjyk72BgZa7zijsI/VsPO3hw83489ELvCjs49Cbv/ZGrGw/reu2BustiT5Cv4T8dBWNv4F/7hvF4cjPwggA7OJhePm5b3q03Ch93+4LQnYSPZgQ72B9pob0r3w29x4EbDn5tHwp/ndx82Axd3kxHV+7kj02HN7ra/A68ya0/8B5DN3iHHTzxBp5/u2lOA29S/37vjqbusG5Vf7x/DYbTQK/4xQ29D+4fRpTDvrE7cYdDb9josupeuoF31egNvN+n3mjgPV4Pbz5ortNh6D/6oyB0de/lzZWeNXCHw0djVT/U7ctp4I+8IHicTIcb4YPBxB+Hm5bWulZr9G5082Fk7L5JUy2VrC3uGi4Zfz7zNIiPSA7nkmckt0SUABgTlZ5GoCAq1V75EZYS6ZJ3mLSOBymSUBBhInm2RD90fzACUBaZbNsQYMZ5BoQdSBCkfCHRIgWDjo5xSYnBfTVdJCCrsscOv9OToc58PNkSpAkyWKLRI5ES5ZHMp4ARpo6lOzuKaNySwhpl9Xqv3l2birkLWY7NbSvJa4uOZMGZtBX1da/XLuFxcCjLSNs+KTNUk+oYmHoyDD213J+LxhRXJPP3ME47zrJGSqiQSqPAW5Nvz8NaGfnatZ9DW3ZDz4FbR1fsb8++PF+Q838efH1rrHWCQx0DX98ea32NMP8R8CXUVSsA0706i7PWGqHXQUs2bOgVEwUXiuagGQGLv4KN3giZnsNnt5T/ldLdslvNKnyk6rZX2wxITNn8XOt8x6P/n3j0v+hI1MR93wDmdZCfGBCGSCZ5c+QdLDVAKwR/ovFOxNc48xAV7grk1zhvLy8vqEr/YmY+ERzW95Ebbc8CixoI7YKNz0LEGkaYFW/OgIXVFa4hgxJCM4g76D0XUN9kIiJgYwhEmdGpho5oxuPlZ/FjIfgsg/zvX7rOdNHYzqz4IotjrCvriTPL/W5yPUD/fPPTPx5epEoVst/tLhaLjkiiC4ip4qLDxbwrkkj/1/NedlCYggCUkyWaASJxbMopydAWISFZQEQTGtmkbBQ2wmiDWf2+AF6r5Hy0LpWCHqArF00nfg2dlqYk7LPevSGd8VL1ZxlhH/HWMb50BnSRLPOciGXtkLsMqgxTfhl1//i6FR/+GoZjZEmgSPvWppBWjLQSOWU014nmTa/n4Jw829bPvd5a09QWP0EThuC5yAgzrrWvDmUo3/ptdW6sXi6+jWW4oHO6z7ezE8aVE19ZjWw4/tQWjq5OdgqE9kMQggvEo6gUQqeolGYbiFnzri71v8fa91j7HmvHYm3t4BxUymPcxwU3T2CFQei4q6u9rnwXm+fJrr0RwfrdRTyBkOaOohQZ7uOVDZ11v9tdpVyqdX9VcKHW3SdtlyciqH6KNGbUwzbEatfJeESy1LI/NKEe0Dd5tWp775O/EAULsjRbWlTPclvSb3tve+2XfFyoIxT1i6fV0DpgIynUZHV0t5K1k08hvNY3GBKiUlC1DPQyuz0zIAKEW+7cVlb8DHUD6swk7FQ/rmt3+e1DaCyuE9pk+4zqPZO8sOG4fYVqveDotd8u9I6d9dsGNNDbunKFxrdwuVJp9wTVPHg2wmDn8nfbvz1Jbvu2UFsD5D2w22uC0OYB3jjM3eYhdkuuen+1j6wP26dS+wTa2zxw9vaeL+9W1q7Nh0ndtzYRn3Bj1CoeD91DxwoIaf2p13l1GPtj36SwiOd5yUwdY3OL0UnD3apnfp3cMhqBRrr9FWZ2G+tpQzuCbi1H9KqjQ8XGc12+5lSl5awT8bx+3d/8nWV81s0JZd2KhewO3Pf6YHox9AfeKPAuXnV6HfVsL/N0eskJa8hRQeiW7yBemO8ZXu5rv9rW8e9fUpzyJUUVagqeVbfICDWnQGPgVZXn7/Bhnse1/+rvCGy2vsOrld7SqcjWa91tZMD9u4dtctettYNTILENBPxRhx4eWJtd6IsXUwuy0lzH7t+Zr516hRtFUKjPzn1oFK7xTaDvPWbV9yI5j/UaQRb6WxKywH18j++xjmnjRybLmv4VzgiblyaysaWr//0bEio4xA== +api: eJztWu2P2jga/1cs34dtdRmg3e5ej28ZJrObLWVYEqa3mhmNTPKEeJvYqe0MgxD/+8l2AgFCC93qdKdrpWrw2/Pi5+1nOyusyFzi/h2+zvgCMR4D8plUhEWAHxwcg4wELRTlDPdxAEREKUq4QMlmOq2mSzQjEmLEGZrTJ2AoElSBoKRzz+5Zv99nXME9C1MqEbC44JQpRCUiDJGsSAlKgKhSACIsRowrBIzMMktwQPKSxQRFWSkVCIl4qRBPkEoBzfhz554FAKZ1V099iyZeECJ37CP+BOKJwuLhRZcUVF4ozjPZjezEC1LQCwFSHXRc1Os6efy3TyWIpR56ec+M/qVQKQgUgyI0kx2j4T3DDhbwqQSpLnm8xP2VaVIBMe4nJJPg4IgzBUzpMVIUGY2I3t3un1Jv8QrLKIWc6F+7e399sOFIWnNUDLGDSZbdJLh/t8JqWQDuYz77EyI9UghegFAUpOHBheFfzSJCkCV2MFWQm/FT6SQUsrhBSCpB2RyvHcxFDOJwRDtUQspMaa4ywuu109igu4rgg4MVVRlsPO53vfkBF2pSqbp+0CsLMoezxBU8b8hEmYI5COzghIucKNv142stf0Zzqk6ca83gJmpH44NN3ZVtvVl4CQkXcM7Kdev+jMkctvvjtPBrWXR8waGts0rBk7c744sRj6HOJ+9g2bqju34epoCIlHTOIEYfYemgRUqjFJFISUQkIqhk9FMJiMbAFE0oCJOQlM4rh1mps2eyn99okxWCRyDl+ZJVC7cx+BGWWlweUaIgRop/lSBXkFBGNZ/zRYk3a7+5MH58mIeOsKbx6ZwPsoVURMEhq0B36zR/SEZ7guEOMZJgasETyUqQh/QdDKzMdXZxB6F/62EHD27ej4de6F1hB4fe5L0/cnXjYV2vPVB6WewJ8jX8p6Ng7A38a98wHk9uBl4QYAcH08vHbcu79Ubh425fELqT8NGMYAf7Iy20d+W7ofc4cMPBr+1D4a+Tmw+bocub6ejKnfyx6fBGV5vfgTe59QfeY+gG77CDJ97A8283zWngTerf793R1B3WreqP96/BcBroFb+4offB/cOIctg3difucOgNG11W3Us38K4avYH3+9QbDbzH6+HNB811Ogz9R38UhK7uvby50rMG7nD4aKzqh7p9OQ38kRcEj5PpcCN8MJj443DT0lrXao3ejW4+jIzdN8mqpZ61RV/DJePP558G8RHJ4VzyjOSWiBIAY6LS0wgURKXaKz/CUiJd+A5T1/EgRRIKIkwkz5boh+4PRoCUSJ9FJu02ZJhxngFhB0IEKV9ItEjBwKRjjFJiACCt6CIBWZVADMu6//SsqFMgT7YEaYIMqGj0SKREeSQFKmCEqWN5z44iGrdksUZ9vd4rfNemdO5il2Nz22rz2sIkWXAmbWl93eu1S3gcJcoy0uZPygzVpDoGr56MR0+t++fCMsUVyfw9sNMOuKyREiqk0nDw1qTc80BXRr527edgl93Qc3DX0RX727Mvzxfk/J9HYd8adJ3gUMdQ2LcHXV8jzH8QhQl11YrEdK/O5ay1WOh10JITG9rFRMGFojloRsDir2CjlZTpOXx2a/pfqeEtu9Usx0fKb3vZzYDElM3Ptc53YPr/CUz/i85GewDwG+C9DvITg8YQySRvjryDpUZqheBPNN4J+hpwHsLDXYFqUfcT9IKq9C+m6BNRYn1DudH2LNSoEdEu6vgsVqzxhFnx5gx8WF3qGjIoITSDuIPecwH13SYiAjaGQJQZnWoMiWY8Xn4WSBaCzzLI//6lC04Xje3Mii+ygMZ6s544s9zvJtcD9M83P/3j4UWqVCH73e5iseiIJLqAmCouOlzMuyKJ9H8972UHhSkIQDlZohkgEsemWpIMbaESkgVENKGRzctGYSOMNpjV7wsotsrPR0tTKegBzHLRdOLXGGppqsI+69070xkvVX+WEfYRbx3jS+dBF8kyz4lY1g65y6BKMuWX4fePr1uB4q9hOEaWBIq0b21qacVIK5FTRnOda970eg7OybNt/dzrrTVNbfETNGEInouMMONa++pQhvKt31YHyOot49tYhgs6p/t8OzthXDnxldXIhuNPbeHo6mSnQGg/BCG4QDyKSiF0ikpptsF3Ne/qmv97rH2Pte+xdizW1g7OQaU8xn1ccPMoVhiQjru62uvKd7F5sOzaqxGsX2LEEwhpLitKkeE+XtnQWfe73VXKpVr3VwUXat190nZ5IoLqx0ljRj1sQ6x2nYxHJEst+0MT6gF9q1ertvdi+QtRsCBLs6VF9VC3Jf2297bXfuHHhTpCUb+BWg2tAzaSQk1WR3crWTv5FMJrfZUhISoFVctAL7PbMwMiQLjlzs1lxc9QN6DOTMJO9eO6dpffPoTG4jqhTbYPq94zyQsbjtt3qdabjl77NUPv2KG/bUADva0rV4B8i5grlXYPUc2zZyMMdi6Ct/3bw+S2bwdta4y8h3d7TRzaPMYbn7nbvM5uKVaPsvbl9WH7fmrfRXubV8/e3pvm3cqatvlaqfvWJugTbuxaheShh+hwASGtS/U6rw7Df+ybLBbxPC+ZKWVsbmE6aXhc9fav81tGI9Bgt7/CzO5kPW1oR9Ct5YhedXS02JCuK9icqrScdSKe10/+m7+zjM+6OaGsW7GQ3YH7Xh9PL4b+wBsF3sWrTq+jnu3Fns4wOWENOSoU3fJxxAvzkcPLfe1X21L+/fOKUz6vqKJNwbPqFhmh5iBoDLyqUv0dPkz1uPZf/XGBTdh3eLXSWzoV2Xqtu40MuH/3sM3vuqUPvkBiGwj4ow49PLA2u9DXL6YcZKW5mt2/P1879Qo3iqBQn5370Khd45tA337Mqo9Ich7rNYIs9AcmZIH7+B7fYx3Txo9MojX9K5wRNi9NZGNLV//7NwE5QRA= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -42,11 +42,11 @@ for further details. ## Request -

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
    +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
    The Flow node instance search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • ]
    The Flow node instance Search Query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx index 971540e777..b1dfdf09ad 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Search for incidents based on given criteria." sidebar_label: "Query incidents (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWltv47YS/isEz8sujnxJNtumevPaSqo2kX1sJy3qBAYtjWzuSqSWpOK4hv/7AUnJV2XjtPtQoA4QJOJlZjj85qLRLLEiU4ndEfZZSCNgCj86OAIZCpopyhl28QCICGco5gLRYpFEEyIhQpyhKX0ChkJBFQhK6g/sgbmuy7iCBzacUYmARRmnTCEqEWGIJNmMoBiIygUgwiLEuELAyCSxBNskzVlEUJjkUoGQiOcK8RipGaAJf64/sAGAeRqVSy9R3xsMUavnI/4E4onC/PFdg2RU1hTniWyEdmGNZLQmQKqDgVq5r55G//mag1joqfcPTJ86zoWagUARKEITWTcnfGDYwQK+5iDVJx4tsLs0j1RAhN2YJBIcHHKmtE7dJSZZltCQaJ02Pkut2CWW4QxSYmaTpBtjd7TEapEBdjGffIZQYQdngmcgFAVpdnBhqBWriBBkgR1MFaTyLXRiCkm0RUgqQdkUrxzMRQTicEaDIiZ5ojRXGeLVytk67qgg+OhgRVUCa9T8T6tywIXqW03h1aPemZEpvElcwdMtmShTMAWBHRxzkRJlhz6ca/kTmlJ15FppZGzFaufEB0rdlW213vgJYi7gLTtXlfrpkSls9ONU8KvY9PKGw7tOigMeq+4vsHhVgz9c4H1HMZwBIlLSKYMIfYGFg+YzGs4QCZVERCKCcka/5oCMD6ExBWG8itJuonQtdX0xmeAhSNmBmDKqqf/61yUqaKFoTUzLpgXlISUKIqT4MSL4FfZSxW+SpWzNlEbHMvKZVISF8B1OSgtSR50ThOBiaLi9droyRCCzB+nFaE7VDBGrXIiQBOOrn0iSg6xjBwPLU+0f7oJBz2v7V77XwQ6+C34Nur8F2MF+d3zb6vX84Hrs9fvdPnbwL91P46A77nvDvu8NsIPb3aDjD/1usF7i/T7st9rD8X3r5s5bj7ZbNzdeZ+zdeLdeMFwP3wU/t4KOmdEjY+/eC4bYwbfeYNC69sYD/w9v7P3e9ryOEa4g0/Ha/mCb6WZAs23tCHTV7d+Og+5wfNW9Czr4sVTsLUhZ+Lpv69YzKk3t8sJu7IoJSBPtrNIpQykXUMQic4NxwucBj+BYgOr1iPEIjkHnmvjfh+cW37cANBRgouaQpkfosUMUaASWJFC5vb4tZEQU1JQmqJ25IuoIygNVkN4R8WgDaLWH/r2nYedf91tDg7S+N+je3Jt/e17Q8YNrg5zPfPI31PyZT6zzpTGCZyqVdLZ1bOQ91LISAD2iZsdBKCNqhnRQPvQ5T5TsIEyaHK/67iVKgESUTatvXgEjTFlYH8pgZzWGi+Rws9fZT2u2QmjpxK5MVNxNS/bXVIXblc18ZMaZtNHyvNmslnCNEZsuIJmHWldxnqCSQN2kkd89TXxrfqW4Iom/l7W8iDrtFqiQSud19wbob8ueEvJX934rf7IKfUsC9eKOffXsy/OKnKd06pROndKpUzp1Sqf+6enUd8mequLjvy6d0snDboCuTKLKkGtWXhybOJmCHIoJTSCqo9uNwUpEhHHUTzSCSFuzlrxMrtCERwudYRleZ4e87hjJ1YwL+idEL6dhmeCTBNL/HqZju9RaqGdXFsIhmw7oUF26HiPiqH/VRj9dfPzx8d1MqUy6jcZ8Pq+LOKxBRBUXdS6mDRGH+leve19HwxkIQClZoAkgEkUmhJIEbRINJDMIaUxDe/lGK0YYfXc2zXwlB3whaK3BnQt6gN4Wuuv7ZQKyMNDbZ71bOpzwXLmThLAveIOV12ykhWSepkQsSmzuMiicTv568vrhvNL+fh4Oe8iSQKG2qnUaVTDSh0gpo6l2PhfNpoNT8myffmg2V5qmvvEjTsIQPGcJYQZa+8epiEalfX+nm+GCTuk+3/qORRcg7tgTlZb64RDvV1xMaBTBN95gTqZzMp1/velcHOI94ArFPGenqHMynZPpvGQ6H6vyQ58pEBqEEsQTCPsedzKjkxmdzKjSjFYOTkHNeIRdnHFpoGNeTHFj3c3RsO9ZWH/Y1kYlTck4Fwl28dJazMptNJYzLtXKXWZcqFXjSV/HExFUd26Y29PT1rJKxCQ8JMnMcj28OT3BSArlifbaOa6JgjlZ2Kpe0fewIX3ZvGxWv0xzoV6gqBtE7Akt7rZ8QUlWG3UlWbv4GMIrXVCWEOaCqsVAb7PqmQARIFr5TlWg4Geo62e7CDvFP1clSn75bWguWvux/qbrxHsmaWatcPOZ39Sbmy+VfasmdFFgA82qEmpzp7S5V3/crc1tYXyrlFYxukd/tzKFz5vnF7WzZq15OWz+6J6duRcf6h8vLv/A6xLTpghUlnia25WXDcdN5WOr0cW20ozWvTCb5UULjO1zedx0q9gulOa6x6S510EyWtqb3+4N0WMr4wpibq69MNRDAGlrAiEt4pr1s0On0PONbwt5mubMBDg2LQtmG3pF35T2egkNQZdb3CXWdrbF9sbOoHvLEZ3VtTFZiy/j2pSqWT6phzwt26XWfycJnzRSQlmjYCEb7dbtXdBp1W78thcMvNpZvVlXz/bri/Y7KWFbcphy0FY72TvTFvZ+/8zLTVg/taG93IZW+BIFz6qRJYSaipe5zGXh7Ed4rTNcQlR3a1mXPcLLpdbknUhWKz1sWGN39Ljx8Ppp5eAZkMhi3boZ3LYXVDOOQS9PcvOJbP875sopd7TCEDL1zbWPW0Gr1x3ozwuToscu5ZHeI8hc99+ROXbxA37A2mwNaIyrNeNLnBA2za1PsnT1z/8BEMUNmA== +api: eJztWllz2zgS/iso7EtSSx0+ksnyTZFoD2dsSivJnqmRXSqIbIpISIABQMtalf77FgBSt2N5k5etkatcNnF0NxpfH2z2AisyldgdYZ+FNAKm8KODI5ChoLminGEXD4CIMEExF4iWiySaEAkR4gxN6RMwFAqqQFBSf2APzHVdxhU8sGFCJQIW5ZwyhahEhCGS5glBMRBVCECERYhxhYCRSWoJtklWsIigMC2kAiERLxTiMVIJoAl/rj+wAYB5GlVLP6G+NxiiVs9H/AnEE4XZ47sGyamsKc5T2QjtwhrJaU2AVHsDtWpfPYv+8a0AMddT7x+YPnVcCJWAQBEoQlNZNyd8YNjBAr4VINVnHs2xuzCPVECE3ZikEhwccqa0Tt0FJnme0pBonTa+SK3YBZZhAhkxs2najbE7WmA1zwG7mE++QKiwg3PBcxCKgjQ7uDDUylVECDLHDqYKMvkWOjGFNNogJJWgbIqXDuYiArE/o0ERkyJVmqsM8XLpbBx3VBJ8dLCiKoUVav6tVTngQvWtpvDyUe/MyRTeJK7g2YZMlCmYgsAOjrnIiLJDF+da/pRmVB25VhoZW7HaOvGeUrdlW642foaYC3jLzuVB/fTIFNb6cQ7wO7Dp5Q37d52WBzxW3ZWZ/w7zVzX58RLvOoxhAohISacMIvQV5g6aJTRMEAmVREQiggpGvxWADBMaUxDGuyjtLiredX1BueAhSNmBmDKqqf+ARCUtFK2Iadm0oDykREGEFD9GBP+A3RzJj0bHsvOZVISF8BPOS0tSR50WhOBiaLi9dsYqYCCzB+nFaEZVgog9MkRIgvHcTyQtQNaxg4EVmfYWd8Gg57X9K9/rYAffBb8H3T8C7GC/O75t9Xp+cD32+v1uHzv4t+7ncdAd971h3/cG2MHtbtDxh343WC3x/hz2W+3h+L51c+etRtutmxuvM/ZuvFsvGK6G74JfW0HHzOiRsXfvBUPs4FtvMGhde+OB/5c39v5se17HCFeS6Xhtf7DJdD2g2ba2BLrq9m/HQXc4vureBR38WCn2FqQsPd/3desZlWZ2eWk9dsUEpIl9VumUoYwLKCOTucE45bOAR3AsTPV6xHgEx6BzRfzH4bnB9y0ADQWYGDqk2RF67BAFGoEVCVRtr28KGREFNaUJateuiDqC8kCVpLdEPNoAWu2hf+9p2PnX/dbQIK3vDbo39+bfnhd0/ODaIOcLn/yAmr/wiXXBNEbwTKWSzqaOjbz7WlYCoEdUcqSnIypBOkTv+5wnSrYQJk3Gd/juJUqBRJRND9+8AkaYsrDel8HOagyXqeJ6r7Ob5GwE1MqJXZkYuZ2k7K45FHyXNg+SOWfSxs7zZvOwhCuM2OQBySLUuoqLFFUE6iap/OlJ41uzLcUVSf2dHOZF1Gm3QIVUOsu7N0B/Wy6Vkv917/eyKavQt6RTL+7Yy4525HlFzlNydUquTsnVKbk6JVf/X8nVT8mlDkXLv11ypVOJ7XB9MKWqArBZeXlsGmWKdSgmNIWojm7XBisREcZRP9EIIm3NWvIq1UITHs11vmV4ne3zumOkUAkX9D8QvZyU5YJPUsj+uZ+cbVNroZ5dWQqHbHKgA3bleoyIo/5VG/3r8sMvj+8SpXLpNhqz2awu4rAGEVVc1LmYNkQc6l+97n0dDRMQgDIyRxNAJIpMOCQpWqcdSOYQ0piG9vKNVoww+u5s0vlKRvhC0FqBuxB0D70tdNf3qzRkbqC3y3q7rDjhhXInKWFf8Rorr9lIC8kiy4iYV9jcZlA6neL1VPbi/KD9/Toc9pAlgUJtVatkqmSkD5FRRjPtfC6bTQdn5Nk+fWw2l5qmvvEjTsIQPOcpYQZau8c5EI0q+/5JN8MFndJdvvUtiy5B3LEnqiz1Yh/vV1xMaBTBd95nTqZzMp2/velc7uM94ArFvGCnqHMynZPpvGQ6Hw7lhz5TIDQIJYgnEPY97mRGJzM6mdFBM1o6OAOV8Ai7OOfSQMe8mOLGqtOjYd+zsP7orY1KmgJyIVLs4oW1mKXbaCwSLtXSXeRcqGXjSV/HExFUd3WY29PT1rIqxKQ8JGliue7fnJ5gJIPqRDutHtdEwYzMbVWv7IlYk/7U/NQ8/DLNhXqBom4esSe0uNvwBRVZbdQHydrFxxBe6vKyhLAQVM0HeptVzwSIANEqtqoCJT9DXT/bRdgp/7mqUPLbH0Nz0dqP9dcdKd4zyXJrhesWgK3qc/OlIvChCV0cWEP0UCm1uVXi3KlDbtfoNrC+UVI7MLpDf7tChc+b55e1s2btrDk8++A2P7oXl/XL84u/8KrUtC4GVaWe5mYFZs1xXQHZaIax7TajVb/MennZJmN7YR7XHS22U6W56kNp7nSZjBYWAZv9I3psaVxCzM31lwa7DyRtVSCkRV6zfrbvHHq+8XEhz7KCmUDHplXhbE2v7K3S3i+lIeiyi7vA2t422N7YGXRvOaKzujYqa/lVfJtSlRSTesizqqVq9XeS8kkjI5Q1Shay0W7d3gWdVu3Gb3vBwKud1Zt19Wy/yWj/kxG2IYcpC220nL0zrWPvd8+8WIf3U6vay61qpU9R8KwaeUqoqXyZy1yUTn+0cg4SVxDVHV3WdY/wYqE1eSfS5VIPG9bYHT2uPb1+Wjo4ARJZrOOv2uJw215QzTgGvTwtzIez3a+bS6fa0QpDyNV31z5uBK9ed6A/M0zKPryMR3qPIDPdo0dm2MUP+AFrszWgMS7XjC9wSti0sD7J0tU//wVavBwO sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -39,11 +39,11 @@ for further details. ## Request -

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
    +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
    The incident search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • ]
    The incident search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-process-and-local-variables-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-process-and-local-variables-alpha.api.mdx new file mode 100644 index 0000000000..d19cf90fd4 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/query-process-and-local-variables-alpha.api.mdx @@ -0,0 +1,60 @@ +--- +id: query-process-and-local-variables-alpha +title: "Query process and local variables (alpha)" +description: "Search for variables based on given criteria." +sidebar_label: "Query process and local variables (alpha)" +hide_title: true +hide_table_of_contents: true +api: eJztWUtz2zYQ/isY9JJMJUpJnDTlTXHs1m0erq04B0kHiFyKiEGAAUDJGg3/e2cBUqQk+pXJIQd7JuOQ2Af28X0A1xtq2cLQcEKvmOZsLoDOejQGE2meW64kDeklMB2lJFGaLCshQ+bMQEyUJAu+BEkizS1ozoKpnMowDKWyMJXjlBsCMs4Vl5ZwQ5gkTOQpIwkwW2ggTMZEKktAolln8JhlhYwZiURhLGhDVGGJSohNgczVTTCVlwDuaVKLviUXJ5djMjo/I2oJeslhNXs2YDk3fauUMIPIC/ZZzvsajD140a/1giz+7XsBeo1Lz6cSo04KbVPQJAbLuDCBi3AqaY9q+F6Ase9UvKbhxj1yDTENEyYM9GikpAVpcY3lueARw5wOvhlM7IaaKIWMuVUhPic0nGyoXedAQ6rm3yCytEdzrXLQloNxGko7a5UU05qtaY9yC5l5jJ2Eg4hbhozVXC5o2aNKx6APV7ApElYIi15NRMuy1wp3Uhmc9ajlVsC2a/7DVF4qbS98pmg5Q82cLeBR29Uqa+2JSwsL0LRHE6UzZv2rVy9x/4Jn3D5Q1rg9jhK7E/FBUnf3Vm4V30GiNDxGs+zMzzlbQJOfXoe/DqW2wi5eayQTv0vi2plUrRrQffuHrSGqfNxi1gs83GBNGv/C+tDqOAVyDWvHLhbpopZu2e0u4ZsjLKFkGRxa/cQyqDmjw2DT7Usmig79sdMTxcOMmEjld0dXWXGC/uHxkeZaRWDMmTSWyehB/ioVwiudH3VtQTJpz+IOh26F8Pgu002muBnrQkbMQoetryk4mrXb5HNDbC1PlMaTomV2rpQAJncAUjfpqevRLUY6JLqgVHpWM7mSxvfuy+Hwtu7YBZkpIkx1UghSGwjcEfHTj4DHcqdVlomzPUa6q9oJ18YiZ19hEczjmFGwH9W9ixt9Qh9Dji2Nh7FjVbN72Wx//wdx3e2udkRQ/hfnzvvQfAt5XjXEeZ+FpBDiqtvKaSFEm4PvM/VEwr8cCSPp7AK7k3xrqDrJo9sItzC4K2aud4GbMC4gDshHpaG+oBOmXdqXPIaYcOmC2QJvruL1ndScazUXkP1+SNG7uxqRcy9Z+SUew4QZ4gXn3vvk4vSY/Hn0+o/Zs9Ta3ISDwWq1CnQS9SHmVulA6cVAJxH+Q7nnARmnoIFkbE3mQFgcc/TJBGnYgZgcIp7wiFhV95nbDBbGx3fPueBWD+/5284rNKf77DkiXy7OCI9BWp6suVwcut79VJirwoZzweQ1bfqg6+Ni14spsozpNoZaDhDtltni/gPt1csD29hLf4/H58SbIJGKoWHQyhEGkXHJsyKj4dFw2KMZu/FPb4bDEm1ixR8QiSRwkwsmXWvth8MlyZq+dYHVLPGTKqM0X/B9v8EOWqsmfu8j8ih83YXCkSSYZY19CForTVQUFVpDTFYpF1umq33XHwhPWHvC2hPWbsFa2aMZ2FTFNKS5Mq51mE1pSAfbYdvAn3gU5w56Cdq4W3+hBQ3pxiOmDAeDTaqMLcNNrrQtB0ssx9YEhojLHll1xwgVMZF6r4eVwwXZ+pDem7b9xSys2NplMq/GUo3pt8O3w06rKHqLRZzf+Qh937W4oDaLoO4064UfYrjEbwIDUaG5XV+imk/PHJgGPSow+dt+qPw56+6644Ror/rPad0l/3wdu0Ijj100Q8GTG5blHoXNWGXnTj+sr+FN61XX6uZFc7Uddt9Ah+3bYaO3c9GzugBMqqvUZDsBbKSrwZ+f7s2aGZ2fvQ23k7Xh3txssvEJbU/E8F3pEJYol82q/w/rgvGCNr6Qw+DFIdbOzxxlRCrLCunODbkgK25Twlp1rqbFSCaCR4AXynBTp7YW++BXyJX3SF4E2KMeSPVxseA2LeZBpLJ6SLz9PRdqPsgYl4PKhRkcjz5++fR+1P9wdnzy6fKk/yIYBvbGf5cinDMmW/twF97tBwHOvh0CW2P1Z248/nw/C5vm/Hwax98+jq9Aa+HGDnLBuEQaceXdVKw6aVFi3bQ4tfbcOKGbDWbyixZlia+daxpOZg2V4lPZoymw2Hc/vUYI0mNfoP4Y99CA+GDmU/ZqjVEUQW7vlJ21Tofzz5djJJ7qbw2ZilFHsxX+HYKtaEindEoRyK5pHKe59xsqmFwUDs7U28Wf/wG7EQEd +sidebar_class_name: "post api-method" +info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api +custom_edit_url: null +hide_send_button: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

    + Query process and local variables (alpha) +

    + + + +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. +::: + +## Request + +

    Body

      sort object[]
    • Array [
    • ]
    • page object
      filter object
      + +Variable filter request. + +
    + +The variable search successful response. + +
    Schema
      page object
      items object[]
    • Array [
    • ]
    + +The user task search query failed. More details are provided in the response body. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    + +An internal error occurred while processing the request. + +
    Schema
      = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
    diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx index e0668c782e..5e6cfd1581 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx @@ -5,7 +5,7 @@ description: "Search for process instances based on given criteria." sidebar_label: "Query process instances (alpha)" hide_title: true hide_table_of_contents: true -api: eJztWltv2zgW/isE92FarCwraTrT0ZsncXez26bexO0A4+SBlo4sTiRSQ1JxDEP/fXFIyTfJjhPMowMEsaVz4eG5feTJkho20zSc0JGSEWhNuNCGiQjog0dj0JHiheFS0JDeAVNRShKpSLFDrMmUaYiJFGTGn0CQSHEDijP/XtyLMAyFNHAvxinXBERcSC4M4ZowQVhWpIwkwEypgDAREyENAcGmmRN4yfJSxIxEWakNKE1kaYhMiEmBTOWzfy/uAOy3SUP6idwO78ZkMLom8gnUE4f5w7s+K7juGSkz3Y8cYY8VvKdAm9aDXsPn5/E//ipBLfDV+3uB1ielMikoEoNhPNO+tfBeUI8q+KsEbX6T8YKGS/uVK4hpmLBMg0cjKQwIg+9YUWQ8Yri3/T81bvCS6iiFnOGn7Z3f9Q3RzhW1Op96lGXZt4SGkyU1iwJoSOX0T4gM9WihZAHKcNBWhVRWfU3FlGIL6lFuILfvj5WTcMjiDUHaKC5mtPKoVDGo9huMpoSVmUGtOqJV5W3sz6QW+OBRw00Gq3D7H+79nVTm1tlKqwfkLNgMXrVcJfONNXFhYAaKejSRKmfGPfpwjuvPeM7NkbTOD4PEbFnc2tTttVUrxt8gkQpew1l17s+IzWC9P16Hvg6m/QxtX2e1gevtPi5AHSfG52ENdT25rtn/C4tOB2wrHadAHmHhagHXraLk77js5wt0WU11BQkXHCVdd4Rxl6pGfLziJDz2O0XesBzeLFSwHLrF/gCluasUR2xNh+gnJ2B3Y1ws71M3ZrM321IrJIbNuk063tMd0h9h0e1jJaUZvTWkkLkVS/t1FUyBeLs2x/5qfZ8zOb+RMbxZYZLJOREyhiNUGgUwYiY9MgyYSTEnH2GhiZHduekRDQVTzEBMpgvyU/8nGx/aMGWumDkyeyw5iZnZznV80DM8BxQJIj5eIIj4BXHa1MI6V2PAI1IAmj+4HF//GHrk8tvX0ZfheHjlkcvBzeXwy/AKpYMoc2x7jox6dEWHn2vCzXa4E2F3qGyIQiqPchHxuMYVtZFTKTNgomXl7ylY7NLpFZIyTRhRkFnHNGKJVAjKrIcMCCbMsTXTUbs6We215bPtEtsNfp/ZHf2rclBCF1Jo107Og6DbRS2D6z6lywifJ2VGGkHopL8drq1FHwtcXgt0jDQsu96BD90QxiV3wpU2CLB+sKwE/ToYk7G38h4CMm6XXoNk9nLsbs/uelrrfJ0nCfKd4M0J3pzgzQnenODNCd502YLdeLvjHQI1TSuzDBevBTL2qookjGcQ++SrVNDcUhGmLNsTj63t9sZs1cemMl749gprD+YplJxmkP/zJewzICNHWeslriUShqUNCadO++T28yX59eLjLw/vUmMKHfb78/ncV0nUg5gbqXypZn2VRPiLdO99Mk5BAcnZgkyBsDi2ZZJlZN1siS4g4gmPXGZag+1i0JfOvhfgk33b9v0qW0rFW6EwIN9vr4mNJZ4suJi1VW9ff01lacJpxsQjXUfFSwE3ILrMc6YWzeXntoI6ecuXcd+H885g/vd4PCJOBImwcuJVZ5NHqAiNyLngOab2RRB4NGfP7tvPQVChTPT4EZYIAs9FxoQNrV1zuCD5Om59VwDqO+m/xzNS8Rnf1dtKYXx45SxyyfixKxkHguAuK4xDUEoqIqOoVApiMk95tsrURvfGle0p006Zdsq0dqZVHs3BpDKmIS2ktqFj4Rnt18nUW82d+q7vUbxRVwjH7RG5VBkN6dJlThX2+8tUalOFy0IqU/Wf0C1PTHGcMVkv4muXYU3kZDJiWeq0tz2IL/Ag01i2M3j6FzMwZwt3JqgHLmvRn4JPQTe0lMrskYijLGehi7+NmtCIxeTuhpGW+BjBFR6gNUSl4mZxh2xue6bAFKhBuYWRa31WuoVkloh69YfPTbT85/exdTjWs9v1fGz4zPLCZeN6vtB1UA72HGrXgbnngHqAYHXU7BK+eTA8IKNZ3L7TWHDo8BQcPOkEm4eS9RI2jg/0PDi/6J0FveDTOPglPDsLLz74Hy+CP+jGkeAQ0RpTG1XCJvDdGOW5YeFkNe1bL6Ue8rlJ3sN6HufmbMFqihbszMgmSxdim9MvfFbZ2pNIG191ZWhHKqZt4zka+GftKjS6tsU0knleCttRxYzMuUkJ24j8epSMZTbjESDeDpdUuKhpyL64N6QOB3LmY9a60tI00hk3aTn1I5k3E+TV32kmp/2ccdGvVej+5eDr95urQe/L9eXw5m7YO/MD3zy7ay0sdDkTG+uw54GOSfs7OzF/v2v7co0nTpP6lyf1dREz8Gz6Rca4wHi3zl3W3WZCW92GNqGLJ1fXMyZ0ucQd/a6yqsLHdgk0nDysWwx+qzyaAotdDtBHzHJ66RzWG+NakDwr7Z3k7lVz5TUcgyiCwhykfdjonqNvd2MsyPW/I+QyRh7F5vivCmxOQ3pP7ymmsw0iW+vt8yXNmJiVNqmpk4s//weMWt9l +api: eJztWltv2zgW/isE92FarGwradrt6s2TuLuZbVNv4naAdfJAS0cWJxSpIak4hqH/vjik5KvsOME8OkAQWzoXHp7bR54sqGVTQ6MxHWoVgzGES2OZjIE+BDQBE2teWK4kjegdMB1nJFWaFFvEhkyYgYQoSab8CSSJNbegOevey3sZRZFUFu7lKOOGgEwKxaUl3BAmCRNFxkgKzJYaCJMJkcoSkGwivMBLlpcyYSQWpbGgDVGlJSolNgMyUc/de3kH4L6NG9LP5HZwNyL94TVRT6CfOMwe3vVYwU3HKiVML/aEHVbwjgZjdx50Gr5unvztzxL0HF+9v5dofVpqm4EmCVjGhek6C+8lDaiGP0sw9leVzGm0cF+5hoRGKRMGAhoraUFafMeKQvCY4d72/jC4wQtq4gxyhp82d37bN8R4V9TqujSgTIjvKY3GC2rnBdCIqskfEFsa0EKrArTlYJwKpZ36moppzeY0oNxC7t4fKyflIJI1QcZqLqe0CqjSCejdNxhNKSuFRa0mplUVrO3PuBb4EFDLrYBluP0X9/5OaXvrbaXVA3IWbAqvWq5W+dqauLQwBU0DmiqdM+sffTjH9Quec3skrfdDP7UbFu9s6ubaqiXjr5AqDa/hrFr3Z8imsNqfoEVfC9N+hl1fi9rA1XYfF6CeE+PzsIa6nlzX7P+BeasDNpWOMiCPMPe1gJudotTdctmnC3RZTXUFKZccJV23hHGbqkZ8suQkPOm2irxhObxZqGQ5tIv9CdpwXymO2JoW0U9ewPbG+Fjep27Epm+2pVZILJu2m3S8p1ukP8K83cdaKTt8a0gh804s7ddVMA3y7do8+6v1fRFqdqMSeLPCVKgZkSqBI1RaDTBkNjsyDJjNMCcfYW6IVe25GRADBdPMQkImc/JL7xcXH8Yyba+YPTJ7HDlJmN3MdXzQsTwHFAkyOV4gyOQFccbWwlpXYyEgSgKa378cXf8cBOTy+7fh18FocBWQy/7N5eDr4AqlgyxzbHuejAZ0SYefa8L1drgVYXeobIBCqoBmzFzLmCc1tKjtnCglgMkdQ3/PwMGXVseQjBnCiAbhfMNrsURpxGXOSRYkk/bYsumpfams9przxTWKzR6/z/KWFlZ5NGEKJY3vKOdh2O6lHYPrVmXKGJ+npSCNIPTTX47YVqKPxS6vxTpWWSautxBEO4rx+Z1ybSxirJ9MlGBeh2QEeyvvISzjd+k1YGYvx/b2bK9nZ52v8yRBvhPCOSGcE8I5IZwTwjkhnD3mYEPebHqHcE3TzRzDxWuxjLuwIinjApIu+aY0NHdVhGnH9sQTZ7u7N1u2solK5l13kbUH9hRaTQTkf38J/vTJ0FPWeonvioRhdUPCidc+vv1ySf558fEfD+8yawsT9Xqz2ayr07gDCbdKd5We9nQa4y/Sve+SUQYaSM7mZAKEJYmrlEyQVb8lpoCYpzz2yekMdotBX3r7XkBQ7u2u75cJU2q+Ewp98uP2mrhY4umcy+mu6s1LsIkqbTQRTD7SVVS8FHB9Yso8Z3reXIFuKqjzt3wZ+n04bw3mf49GQ+JFkBiLJ154NnmEitCInEueY3ZfhGFAc/bsv30KwwplosePsEQSeC4Eky60ts3hkuSruHWGLW+m/xrPKM2nfFvvTgrjwytvkU/Gj23J2JcEd1ljHILWShMVx6XWkJBZxsUyUxvdaxe3p0w7Zdop03YzrQpoDjZTCY1ooYwLHYfQaK9Ops5y+tTzfY/ivbpGRO5OyaUWNKILnzlV1OstMmVsFS0KpW3Ve0K3PDHNcdLkvIivfYY1kSNUzETmte96EF/gWaaxbGv89C9mYcbm/lhQj11Woj+Hn8N2dKm03SMRB1reQh9/azWhEYvJ3Y4kHfExgis8QxuIS83t/A7Z/PZMgGnQ/XIDJtf6nHQHyRwRDeoPX5po+e33kXM41rPb1ZRs8MzywmfjasrQdlYO95xrV4G554x6gGB52mwTvn42PCCjWdy+A1l46PwUHjzshOvnktUS1k4Q9Dw8v+ichZ2zcHT2MQo/RR8uuhdnH/9H104Fh4g2YLXVJaxj37WZnp8ajpdjv9Vq6mmfH+k9rAZzfuAWLsdp4dawbLzwUbY+BsNnlSs/qXIhVheH3WDFzG2cR8Pu2W4hGl67ehqrPC+la6pySmbcZoStBX89U8ZKK3gMCLmjBZU+cBqyr/4NqSOCnHUxcX11aXrplNusnHRjlTej5OXfiVCTXs647NUqTO+y/+3HzVW/8/X6cnBzN+icdcOuffaXW1jrcibX1uGOBC0j93dudP5+2/bFClKcRvYvj+zrOmbh2fYKwbjEeHfOXdQNZ0x3Gg5tQhfPr75tjOligTv6Q4uqwsduCTQaP6y6DH7DwyywxOcAfcREp5feYZ0RrgXJReluJrcvnKug4ejHMRT2IO3DWgMdfr8bYU2u/y8hVwnyaDbD/1lgMxrRe3pPMZ1dELly754vqGByWrqkpl4u/vwfiB/isw== sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -46,11 +46,11 @@ for further details. Process instance search filter. -
    +
    The process instance search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • ]
    The process instance search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx index f617bcbe49..834df9cb45 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx @@ -47,7 +47,7 @@ User task filter request. The user task search successful response. -
    Schema
      page object
      items object[]
    • Array [
    • customHeaders object
    • ]
    +
    Schema
      page object
      items object[]
    • Array [
    • customHeaders object
    • ]
    The user task search query failed. More details are provided in the response body. diff --git a/docs/apis-tools/camunda-api-rest/specifications/return-user-task-by-a-user-task-key.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/return-user-task-by-a-user-task-key.api.mdx index 0eff6f0481..7b2e0188d9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/return-user-task-by-a-user-task-key.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/return-user-task-by-a-user-task-key.api.mdx @@ -46,7 +46,7 @@ for further details. The user task is successfully returned. -
    Schema
      customHeaders object
    +
    Schema
      customHeaders object
    Bad request diff --git a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js index 4371298844..3114264856 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js +++ b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js @@ -141,6 +141,18 @@ module.exports = [ }, ], }, + { + type: "category", + label: "Variable", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/query-process-and-local-variables-alpha", + label: "Query process and local variables (alpha)", + className: "api-method post", + }, + ], + }, { type: "category", label: "Clock", @@ -169,6 +181,18 @@ module.exports = [ label: "Search process definitions (alpha)", className: "api-method post", }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-process-definition-by-key-alpha", + label: "Get process definition by key (alpha)", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-process-definition-xml-alpha", + label: "Get process definition XML (alpha)", + className: "api-method get", + }, ], }, { diff --git a/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx index 84a0731052..a58a6de44e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx @@ -5,7 +5,7 @@ description: "Update a user task with the given key." sidebar_label: "Update user task" hide_title: true hide_table_of_contents: true -api: eJztWW1v2zYQ/isHflm3ybLSJm2nb16abenWLkicDVgSILR0ttlIpMaXOIah/z4cKdnyS5qs6765QFDH5L3w7p7nmOOCWT4xLL1ilwY1WG7u2E3EcjSZFpUVSrKUXVY5twgcXLsHZsJOwU4RJuIeJdzhPGYRq7jmJVrUpHHBJC+RpYykhtzc/YpzFjFBGitupyxiGv92QmPOUqsdbpodTpEUgxp7SyvjVoHzLpFNk02x5CxdMDuvyJyQFieoWcTGSpfchq9eH7K6vgkm0dgfVT4nmZUHY14YjFimpEVpaY1XVSEyTt70PxlyabFtTY0+YWbp7FpVqK1AQ6vZlMsJGvSK1o/1/uL3jxDEQhjD3jycjVurxchZhHteODTxtbyWFImxKgo1E3Ky2mIg4xJGCDz/5IzFvE2LMIAyr5SQNgKe54JM86IjeS1noihIVkyk0pinZOc7uM24zAXF9metXGVuoQeazgGjOVRa3YvcuyABy8rOoRDGrstRHT1fLHf4jlt8av+F1UJOvESIw2X1L8UqLZQWdk4ipZCidCUkEZT8wX88SJIIchxzV1g4SigYZx19TREqg93o+2hzuJWuKG5DvkBpUKWwluSEhYrc0/cUcKrhCrURPlNLNd+YILlMNDdGTCQiJVcq+2R+nUGPj4GXC1XUrsak0u82TlO9KK2p7vAepQUshTFCSRgr3TEbSje+lizaqnI6Kh8V2CJ2VVxnnfoPa+uIaDLdgY7x2enilOqnZ0WJbBcX5A7BE1FDCHTSGM6fzH+85XdNNldl9B98Cmp6rvp6nq0jqeMb15rPd3pBcCLbS1FPlub57pACckZYLM12OOrPuRmI4gv9nHjh/9XRFvlPtohXL3c63cqvOcki1rAISxOS8szB0qMkYg2nsJRIZdOfOmJWWPqVHS97RB0xngWTm91iAJkzVpUQNjQsY6ecmkdgcJ5laIwYFQhjrcpOo/QwN0SRrvCM5NfX+AOEvFehycVwOgZinBB3zCNiMG+lZUar4JqF3nvN1hhiCZzHz3vZ3APCdeI8NGJW17RHo6mUNIEqXiaH24EYrl0BZtw0d4AcjPMBGLuimMcUy8MkeVJ+6/7SodtGcQwflEbI0XJRGOAal5EBIb106zaMVD4P8XjkAlFpNSqw/H77IrGZ77Ows7Hb3hS4gbBxFKxfnf90DD8cHr25eTG1tjJpvz+bzWI9znqYC6t0rPSkr8cZ/dC+b2MYTlEjlHweesryWrAiajAVZmIsMsq0b1iNM5Tl3R1hneXD6mfo1GmxhbIBXJ6fgshRWjGeU51umWYdjDE+Us6mo4LLO7aqr22jm1aMK0uul0BeN1BHzFhunflSnvhlODyDoAIylaPvqh5rjaE10jhMukzxOklq0kkZf8ZJJOBDVXDpS2vzOEJCuapbfzAhjeUy+1qZUVpMxKbdmHWx3hTxu3CigPHDZ8B6G5aEdMLlWDmZx3uA7QG2B9ijAPvhCwAmTNvNZlrJiY8wQua0RmmL+b4L7kG6B+nXA+nRrsvpQAJFWVMdotY0RMg8AnOYTUXh1ftLfmO7mWLtsbbH2h5rj2GtjliJdqryMHDOpn5CbacsZX3qiD3qiKa/6Mynaxoo07yumWA7XbCULQJ06rTfX0yVsXW6qJS2df+e8nLPtaA/eH0aaTlArC2dQmW88F/vSiEt0Ji8PdoxL53MObyF85OLIfzMLc54+KuWTK6rfpu8TXaPLJS2j2gcnJ1COGEowA4ptGoJ3TvVhs3PUexH7QYzR4OTCxIL4Rkh16gHjpKwLIzGntdOv4dNLGo+/NSWy/s/hz7jRGjnqzH+yQMvqwDH9al7O3BkL5OXh72DpJe8HSZv0oOD9PBVfPQq+YttjgE/t3NzLHfVFvTNjllYd3E1fzpKOoOezshKyLHy8WgHQ1uRpTKj0bEXTOKDbdicnXr0Z6osnfQtQE7aAfVKX1bQHFkTLxQiQ2l82Jp3mnbbb2EF/ggW4SCmKgtQaJl/IuzUjeJMlf0siC3/HxVq1C+5kP3GhOkfDz5cfnw36P12enzy8eKkdxAnsX2wPpuVMrbksuNH89y0vLRuHnax6njPf5pqas3ig+1XBReSAu/PtGhI4YqtSIFFLO0+W91EDbKv2GIx4gYvdVHX9PXfDvWcpVc3KyLwzJELQ59XD0uPHuHFefMG9S0878Vr51Ha2auce0oqHP3GInaH840nuPqmjtgUeY7aexp2HAd/ekPSs9Kw9QZWR63EIMuwso/sXbt8EBksmfhsMDz+hcDdvMCVKidhzWf0IMhnLGXX7JpcVz5Ynjf89wtWcDlxfEL7g2L69w9+q/nw +api: eJztWW1v2zYQ/isHftmbLCut03X65qXdlq7tgsTZgCUBSktnm41EqnyJYxj678ORki2/pMm67psLBHVM3gvv7nmOOS6Z5VPD0it2aVCD5eaW3UQsR5NpUVmhJEvZZZVzi8DBtXtgLuwM7AxhKu5Qwi0uYhaximteokVNGpdM8hJZykhqxM3t77hgEROkseJ2xiKm8ZMTGnOWWu1w2+xohqQY1MRbWhu3Cpx3iWyabIYlZ+mS2UVF5oS0OEXNIjZRuuQ2fPViwOr6JphEY39W+YJk1h5MeGEwYpmSFqWlNV5Vhcg4edP/aMil5a41Nf6ImaWza1WhtgINrWYzLqdo0CvaPNabiz/eQxALYQx783A2bq0WY2cR7njh0MTX8lpSJCaqKNRcyOl6i4GMSxgj8PyjMxbzNi3CAMq8UkLaCHieCzLNi47ktZyLoiBZMZVKY56Sne/hQ8ZlLii2v2rlKvMBeqDpHDBeQKXVnci9CxKwrOwCCmHsphzV0dPFcoevuMXH9l9YLeTUS4Q4XFb/UqzSQmlhFyRSCilKV0ISQcnv/cejJIkgxwl3hYXjhIJx1tHXFKEy2I2+jzaHD9IVxYeQL1AaVCmsJTlhoSL39B0FnGq4Qm2Ez9RKzTcmSK4SzY0RU4lIyZXKPppfZ9DjY+jlQhW1qzGp9LuN01QvSmuqO7xDaQFLYYxQEiZKd8yG0o2vJYt2qpyOyscFtohdF9dZp/7D2iYimkx3oGN8dro4pfrpWVEi28cFuUPwRNQQAp00hvNH8x/v+F2TzXUZ/Qefgpqeq76eZ5tI6vjGteaLvV4QnMj2StSTpXm6O6SAnBEWS7Mbjvpzbgai+EI/p174f3W0Rf6jLeL5s71Ot/IbTrKINSzC0oSkPHOw9DiJWMMpLCVS2fanjpgVln5lJ6seUUeMZ8HkdrcYQuaMVSWEDQ3L2Bmn5hEYnGcZGiPGBcJEq7LTKD3MDVGkKzwj+fUN/gAh71RocjGcToAYJ8Qd84gYzFtpmdEquGah916zDYZYAefh814294BwnTgPjZjVNe3RaColTaCKZ8lgNxCjjSvAnJvmDpCDcT4AE1cUi5hiOUiSR+V37i8dum0Ux/BOaYQcLReFAa5xFRkQ0ku3bsNY5YsQjwcuEJVW4wLLH3YvEtv5Pgs7G7vtTYEbCBvHwfrV+S8n8NPg+Mebb2fWVibt9+fzeawnWQ9zYZWOlZ729SSjH9r3XQyjGWqEki9CT1ldC9ZEDabCTExERpn2DatxhrK8vyNssnxY/QydOi12UDaEy/NTEDlKKyYLqtMd06yDMcbHytl0XHB5y9b1tWt024pxZcn1CsibBuqIGcutM1/KE7+NRmcQVECmcvRd1WOtMbRBGoOkyxQvkqQmnZTxJ5xEAt5XBZe+tLaPIySU67r1BxPSWC6zr5UZpcVUbNuNWRfrTRG/CicKGB88Ada7sCSkEy4nysk8PgDsALADwB4E2E9fADBh2m4210pOfYQRMqc1SlssDl3wANIDSL8eSI/3XU6HEijKmuoQtaYhQuYRmMN8Jgqv3l/yG9vNFOuAtQPWDlh7CGt1xEq0M5WHgXM28xNqO2Mp61NH7FFHNP1lZz5d00CZ5nXNBNvpgqVsGaBTp/3+cqaMrdNlpbSt+3eUlzuuBf3B69NIywFibekUKuOF/3pfCmmBxuTt0U546WTO4SWcv74Ywa/c4pyHv2rJ5Kbql8nLZP/IQmn7gMbh2SmEE4YC7JBCq5bQvVdt2PwUxX7UbjBzNDi5ILEQnjFyjXroKAmrwmjsee30e9jEoubDL225vPlr5DNOhHa+HuO/vudlFeC4OXVvB47sWfJs0DtKekfJ6Og4TV6kzwfxIHn+N9seA35u5/ZY7qot6Js9s7Du4nr+dJx0Bj2dkZWQE+Xj0Q6GdiJLZUajYy+YxEe7sDk79ejPVFk66VuAnLYD6rW+rKA5siZeKESG0viwNe807ba3YQX+DBbhKKYqC1BomX8q7MyN40yV/SyIrf4fF2rcL7mQ/caE6Z8M312+fzXsvT09ef3+4nXvKE5ie299NitlbMllx4/muWl1ad0+7HLd8Z7+NNXUmsV7268KLiQF3p9p2ZDCFVuTAotY2n22uokaZF+x5XLMDV7qoq7p608O9YKlVzdrIvDMkQtDn9cPSw8e4dvz5g3qO3jai9feo7SzV7nwlFQ4+o1F7BYXW09w9U0dsRnyHLX3NOw4Cf70RqRnrWHnDayOWolhlmFlH9i7cfkgMlgx8dlwdPIbgbt5gStVTsKaz+lBkM9Zyq7ZNbmufLA8b/jvl6zgcur4lPYHxfTvH1kR+eY= sidebar_class_name: "patch api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null diff --git a/docs/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx index 2a3abc9a19..828c2d62a4 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx @@ -42,7 +42,7 @@ which is not meant for production use. The document was uploaded successfully. -
    Schema
      metadata object
    +
    Schema
      metadata object
    The document upload failed. More details are provided in the response body.