diff --git a/api/remove-duplicate-version-badge.js b/api/remove-duplicate-version-badge.js index 5f30a2deb49..60efc46963b 100644 --- a/api/remove-duplicate-version-badge.js +++ b/api/remove-duplicate-version-badge.js @@ -6,7 +6,7 @@ function removeDuplicateVersionBadge(generatedInfoFilePath) { console.log("removing duplicate version badge..."); replace.sync({ files: generatedInfoFilePath, - from: /^.*Version: .*$/m, + from: /]*\s*children=\{"Version: [^"]*"\}\s*>\n<\/span>\n/m, to: "", }); } diff --git a/docs/apis-tools/administration-sm-api/sidebar-schema.js b/docs/apis-tools/administration-sm-api/sidebar-schema.js index 5b070d4aee4..29c55283819 100644 --- a/docs/apis-tools/administration-sm-api/sidebar-schema.js +++ b/docs/apis-tools/administration-sm-api/sidebar-schema.js @@ -5,7 +5,7 @@ module.exports = { "apis-tools/administration-sm-api/administration-sm-api-overview", "apis-tools/administration-sm-api/administration-sm-api-authentication", { - Specifications: require("./specifications/sidebar.js"), + Specifications: require("./specifications/sidebar"), }, ], }; diff --git a/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx b/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx index 357adbd146d..68db1be250d 100644 --- a/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Administration API (Self-Managed)

+ Access the administration API of Console Self-Managed.
-

- Authentication -

+
@@ -53,9 +61,7 @@ Access the administration API of Console Self-Managed. >

Contact

- - URL: https://www.camunda.com - + URL: [https://www.camunda.com](https://www.camunda.com)

License

diff --git a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx index cca9bf58fdd..16d9033b7eb 100644 --- a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx @@ -5,48 +5,162 @@ description: "Returns a list of all automation and management clusters. Each clu sidebar_label: "Get current clusters" hide_title: true hide_table_of_contents: true -api: eJzFV9uO2zYQ/RViXtoCXNu9AYFQFHAXSbBFtgmyXgSo4QeaGluMKVJLUus4hv69GFKW5cvuGujtyRI1PJw5M3M43oKt0ImgrLnJIYMlhmtd+4DOAweHvrLGo4dsCz+MRvSTo5dOVbQDMni/Ag7SmoAm0FdRVVrJiDf87MlkC14WWAp6UgHLiFU5OjaohFzXKqffsKkQMvDBKbMEfnTUvVEPNTKVowlqodAxu2ChQCaTw9BwMKLEl5H+ECU+sdlXQl6IEE37GEx55mpjlFkyZQYE6YMItT+l7cbkxBJ6phZM9AEKFDoUG2YdMzYAP3EETV1CNoXWEDjUpv+8MnZtYMYhqKBp57U13mq8ux3npTLjSg3uklcNhyWaNvsvxzwplCcPY8S1c2gCe0TnlTU7MnfR90hNmMfxf8JvHLJc+aDMsla+oF1zDGtEw0QdbBmdYsLkrBRGLLGk41pcP2C3p4tMGanrHFmvBslbEZiQgS21nQutN0wRLFPGB6E15ixW75fAmVYrZC1bxP+tzVGjG7Dx3qHuMOFS7v9EnOOxDxTNgRcR+n3sNORsIvxKKx9ieO+roEr1FQfP5HrPCHDY8/F8lts+nhBmw6kz/TM9+ESeInv7SA5LvF/8LX2RDn4aKmeDwXMRfqV9V3NnV+iAt69LEXAtqKyTSCEBtIBxMTFHnKRUJS0iHoBDEopwcVeMq2rH1d+Sox5dl0uAOWb5v9WB2ulLBABZVc+1kuz+47snwv2XFOXoFIciVwa9v8zrzvwZx0sMTskLAVvjJ+Giiw+1cphTjiJgLKuuHhLnB3zNuiTb+WeUlHSR54q+Cf2h160LoT2+UMp77QXhXGyi0zCiCNnFoVad7++TmOKl3d64/buzF2EvNr7jIMrQPxfp9fFN00bbNOTvT6MfTxvvjXVzlecYs/7zuaHmDt0juiuvcmTonE3BH9p8xFA745nYk6j1RVfXayGL7sZHE9wmXkFCGX9c8j6ihAKVY4nVqKFi6SkD3aA24+BR1o7ELptuYY7CoYNsOmtmHCrhRInRMJvOYqEXtp31gD6HAjIYCqL0SlRqKPcDoI9M+IgaNQK2aZprsuFwW1gfmmxbWRca4PAonBJzne4T+paYXYhaB8hAWyl0XD5XivTB9Oay8Ycblk6PgxSdcQj3avRqdF6irAtPoOwn0T1OEUJ1FicZn0Vqmh7ld2SXgt4R30lICx6h6L014O3DG+tKQU78/mkSa0yZhY3b24KPda58SF0Unfj2DvXiKs0/+Xcnno+lJJ2LinS62S66AacPQ1XVCi9k8P1gNBi1Y72QkfaUe4rGZ8Pher0eSFHWJhcDaUtiViuJxscJIs3g8K5d4Uebcyt9t1vZ+D50uECHRuKwBfLDyEdlfSiF6cG+xdDdFb1CPSBhu/9H8r/2aaoBGi6HlRbK9G7a1HVT6LqO+O71c2qfKWy3c+Hx3ummoeWHGt0mtfGu22KbcxoD8tjzW1jhpi2EKsS21HUUxuO/Zk1fDN6+npAK1+RWV75H5RrRdzJrNj3sX36LBmxiV2h+Bd76EOgVmlnTNH8B6kAKmA== +api: eJzFV9tu2zgQ/RViXnYXYGzvDSj0ZgRtkUWzKRoHBdbwA02NLdYUqZBUs66gf18MKcvyJYmBvT1ZooaHM2dmDscN2AqdCMqamxwyWGO41rUP6DxwcOgrazx6yBr4aTKhnxy9dKqiHZDB3QY4SGsCmkBfRVVpJSPe+Isnkwa8LLAU9KQClhGrcnRsUAm5rlVOv2FbIWTgg1NmDfzoqAejHmtkKkcT1EqhY3bFQoFMJoeh5WBEia8j/S5KfGazr4S8ECGaDjGY8szVxiizZsqMCNIHEWp/StuNyYkl9EytmBgCFCh0KLbMOmZsAH7iCJq6hGwOnSFwqM3weWPsk4EFh6CCpp3X1nir8f52mpfKTCs1uk9etRzWaLrsvx7zrFCePIwR186hCewrOq+s2ZG5i35AasI8jv8zfueQ5coHZda18gXtWmJ4QjRM1MGW0SkmTM5KYcQaSzquw/Ujdnu6yJSRus6RDWqQvBWBCRnYWtul0HrLFMEyZXwQWmPOYvX+GTjTaoOsY4v4v7U5anQjNt071B8mXMr9H4hLPPaBojnwIkLfxU5DzmbCb7TyIYZ3VwVVqm84eiHXe0aAw56Pl7Pc9fGMMFtOnelf6MFn8hTZ20dyWOLD4u/oi3Tw01A5G41eivAb7btaOrtBB7x7XYuAT4LKOokUEkAHGBcTc8RJSlXSIuIBOCShCBd3xbSqdlz9LTka0HW5BJhjlv9bHaidvkQAkFX1UivJHj59eCbcf0lRjk5xKHJl0PvLvO7NX3C8xOCUvBCwM34WLrr4WCuHOeUoAsay6ushcX7A16JPsl1+QUlJF3mu6JvQHwfduhLa4yulvNdeEM7FJjoNI4qQXR1q1fn+PokpXtrdjTu8OwcRDmLjOw6iDP1zkV4f3zRdtG1L/v4y+fm08d5Zt1R5jjHrv54bau7RfUV35VWODJ2zKfhDm08Yamc8E3sStb7o6norZNHf+GiC28YrSCjjj0veR5RQoHIssRo1VKw9ZaAf1BYcPMrakdhl8waWKBw6yOaLdsGhEk6UGA2z+SIWemG7WQ/ocyggg7EgSq9EpcZyPwD6yISPqFEjoEnTXJuNx01hfWizprIutMDhq3BKLHW6T+hbYnYlah0gA22l0HH5XCnSBzOYy6Yfb1g6PQ5SdMYh3JvJm8l5ibIuPIOyn0T3OEUI1VmcZHwWqW0HlN+TXQp6R3wvIR14hKL3zoB3D++sKwU58dvnWawxZVY2bu8KPta58iF1UXTi+3vUq6s0/+Q/nHg+lZJ0LirS6Wa76gecIQxVVSe8kMGPo8lo0o31QkbaU+4pGp+Nx09PTyMpytrkYiRtScxqJdH4OEGkGRw+dCv8aHNupe93Kxvfxw5X6NBIHHdAfhz5qKwPpTAD2PcY+rtiUKgHJDT7fyT/a5+mGqDhclxpoczgpk1dN4e+64jvQT+n9plD0yyFxwen25aWH2t029TGu26Lbc5pDMhjzzewwW1XCFWIbanrKIzHf83aoRi8fzsjFa7Jrb58j8o1ou9k1mwH2E2TLGZ2g6YlMUhOBHqHdtG27V8VCQwO sidebar_class_name: "get api-method" info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get current clusters

+ - + Returns a list of all automation and management clusters. Each cluster entry contains the running apps and their status. -## Request + -
+ -Ok + -
Schema
  • Array [
  • apps object[]required
    - -The list of applications running in the cluster - -
  • Array [
  • ]
  • ]
- -Forbidden - -
- -Server-side error - -
+ diff --git a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx index 6b108eaf1ed..6b79ef3be7d 100644 --- a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx @@ -5,59 +5,152 @@ description: "Returns usage metrics for a specific cluster for a given time rang sidebar_label: "Get usage metrics for clusters" hide_title: true hide_table_of_contents: true -api: eJzlV99v2zYQ/leIe2oBxvZ+AYUwDMiKpciwbEWTYAMMP5zJs81GIhWSShsI+t+HoyRbsWWvGxLsoS+JJR8/fvzu7ju6BleSx2icvdSQwZribcA1XVH0RgWQ4CmUzgYKkNXw7WzG/zQF5U3JqyCDP+5AgnI2ko38LZZlblTCnH4MHFJDUBsqkD+VnneMpgU0mv/Gx5IggxC9sWuQe/g3GxJGk41mZcgLtxJxQ0LlVYjkJ9BIxlQUwqUNEa1qkQ8xKj6YKNqTiZXzIkT0kbTo1gvTA0xA7hGNLmI+4GqrYkkeJKycLzBCBtpVy5xG2bfBzPyQA4pQkjIrowRDT6BpWPT7ynjSkM27nRey39ktP5KKIAG1NrwJ5u8HVFeYB5IQTcw5+q2zweV0fXWuC2PPSzMZ5nenWMO8lQlcCP9WRvpMqmIde4SvXMiI4e42kP9iATEEs7akBa8UFS/9X4WT0DHqmjRSEQ77tNkqid7j4+i+6SwibjCmswWxwQcSSyI7OLQ7lqshj5fJ2802VfsMjIYRYxnrkmHCX4blhfNvW7uDpmGi38++O6ytC+eXRmuynJkfxpz6mvwD+bNgNAny3vl06qcxHyhW3obTddKZb/d6bR7IimgKEh7tmibisMzRk8D12tMa2SncA/lk47tVAq0Wxqq80sN6PerR8pTvyIR2pK8irgOnOEks+lG3kBBIVd7ER8jmNSwJPXnI5otmIaFEjwXF1NTz0a625r46MahAguHY+4o894rFghOfymxXd9FXJAfTcq/jGjm2dZIoKRkiFmW/8VDaIG5/v/xrEGOsKEyem0DKWR2OsEvIJwkems9TezpCmax+EcJkT+v5z3QXEgqKG9fdhtgEMG4ggylya55haaaptM+K7R0ppL5qK6PyOWRQt1s22XRab1yITVaXzscGJDygN7jMW2vl79o+XWGVM7HcKczT6zE/5S/4qL1k5+8vRbt7exFyfg/uzezNbBSJQ4+g7OTa4WxiLEdx2uBRpCRm31PXHNceuu+sbXl34AmKn7sA2X246JP26583ybGMXbm0vHPPZJomxPYim0i8uqZ8dXaFFtekXx8wP1fJTJgyHi52K9EZshjCsHdwnluIbyazyay7+aJKsre559OEbDr99OnTRGFRWY0T5QpWNjeKbCCO7Qr2t+6N3FusnQrb1cal56mnFXmyiqYdUJgmPUoXYoF2APuO4oiDd1YU9uWod9f3r8L/26qL9DlOyxxNGphJ/rpr9jlsm50z86TdF7Lr2jnU9RID3fq8afh160VpPJjALa63c/6o3K8+dF71WnzhFBllf0eP/TB5wLziAEjO+1+JPM9MOcG1Hy3PQ/c55skJsu1Y2VFd7Gw8XRAkbAh1ui3U3RJ2mHJ4wIOfxU9GzbtfbviuWHH1bX1xzwcTen/lto8D7B9/TgHixt2R/Ql62pEfoVk0TfM3+WOSPA== +api: eJzlV01v2zgQ/SvEnFqAsb1fQKFbUGyKLDa7RZNgFzB8GJNjm41EKiSVNBD034uhJFuxZW93kWAPvSSWPHx8fDPzhq7BleQxGmcvNWSwpngbcE1XFL1RASR4CqWzgQJkNfw4m/E/TUF5U/IqyODPO5CgnI1kI3+LZZkblTCnnwOH1BDUhgrkT6XnHaNpAY3mv/GpJMggRG/sGuQe/s2GhNFko1kZ8sKtRNyQUHkVIvkJNJIxFYVwaUNEq1rkQ4yKDyaK9mRi5bwIEX0kLbr1wvQAE5B7RKOLmA+42qpYkgcJK+cLjJCBdtUyp1H2bTAzP+SAIpSkzMoowdATaBoW/b4ynjRk827nhex3dsvPpCJIQK0Nb4L5xwHVFeaBJEQTc45+72xwOV1fnevC2PPSTIb53SnWMG9lAhfCv5WRvpCqWMce4TsXMmK4uw3kv1lADMGsLWnBK0XFS/9X4SR0jLomjVSEwz5ttkqi9/g0um86i4gbjOlsQWzwgcSSyA4O7Y7lasjjdfJ2s03VPgOjYcRYxrpkmPDXYXnh/PvW7qBpmOjPs58Oa+vC+aXRmixn5pcxp74m/0D+LBhNgrx3Pp36ecwnipW34XSddObbvV6bB7IimoKER7umiTgsc/QkcL32tEZ2CvdAPtn4bpVAq4WxKq/0sF6PerQ85TsyoR3pq4jrwClOEot+1C0kBFKVN/EJsnkNS0JPHrL5ollIKNFjQTE19Xy0q625r04MKpBgOPa+Is+9YrHgxKcy29Vd9BXJwbTc67hGjm2dJEpKhohF2W88lDaI2z8u/x7EGCsKk+cmkHJWhyPsEvJJgofm89yejlAmq1+FMNnTev4z3YWEguLGdbchNgGMG8hgityaZ1iaaSrts2J7Rwqpr9rKqHwOGdTtlk02ndYbF2KT1aXzsQEJD+gNLvPWWvm7tk9XWOVMLHcK8/R6zE/5Cz5qL9n5x0vR7t5ehJzfg3s3ezcbReLQIyg7uXY4mxjLUZw2eBQpidn31DXHtYfuO2tb3h14guLnLkB2Hy76pP32101yLGNXLi3v3DOZpgmxvcgmEm+uKV+dXaHFNem3B8zPVTITpoyHi91KdIYshjDsHZznFuKHyWwy626+qJLsbe75NCGbTh8fHycKi8pqnChXsLK5UWQDcWxXsL93b+TeYu1U2K42Lj1PPa3Ik1U07YDCNOlRuhALtAPYDxRHHLyzorAvR727vn8X/t9WXaQvcVrmaNLATPLXXbPPYdvsnJln7b6QXdfOoa6XGOjW503Dr1svSuPBBG5xvZ3zR+V+86nzqrfiG6fIKPs7euqHyQPmFQdAct7/SuRlZsoJrv1oeRm6LzFPTpBtx8qO6mJn4+mCIGFDqNNtoe6WsMOUwwMe/Cx+Nmo+/HrDd8WKq2/ri3s+mND7K7d9GmDXdRtx4+7INjxlWhKRn6FZNE3zFavQk7I= sidebar_class_name: "get api-method" info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get usage metrics for clusters

+ Returns usage metrics for a specific cluster for a given time range. The usage metrics are aggregated over the time range and include number of started process instances, executed decision instances, and assigned task users. -## Request - -

Query Parameters

- -Ok - -
Schema
    processInstances objectrequired
    - -The usage metrics for started process instances. - -
    decisionInstances objectrequired
    - -The usage metrics for executed decision instances. - -
    taskUsers objectrequired
    - -The usage metrics for assigned task users. - -
- -Forbidden - -
- -Server-side error - -
+ + + + + + + diff --git a/docs/apis-tools/administration-sm-api/specifications/sidebar.js b/docs/apis-tools/administration-sm-api/specifications/sidebar.js deleted file mode 100644 index 3d3722141b7..00000000000 --- a/docs/apis-tools/administration-sm-api/specifications/sidebar.js +++ /dev/null @@ -1,30 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/administration-sm-api/specifications/administration-api-self-managed", - }, - { - type: "category", - label: "Usage Metrics", - items: [ - { - type: "doc", - id: "apis-tools/administration-sm-api/specifications/get-usage-metrics", - label: "Get usage metrics for clusters", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Clusters", - items: [ - { - type: "doc", - id: "apis-tools/administration-sm-api/specifications/get-clusters", - label: "Get current clusters", - className: "api-method get", - }, - ], - }, -]; diff --git a/docs/apis-tools/administration-sm-api/specifications/sidebar.ts b/docs/apis-tools/administration-sm-api/specifications/sidebar.ts new file mode 100644 index 00000000000..bcbae3755f9 --- /dev/null +++ b/docs/apis-tools/administration-sm-api/specifications/sidebar.ts @@ -0,0 +1,36 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "apis-tools/administration-sm-api/specifications/administration-api-self-managed", + }, + { + type: "category", + label: "Usage Metrics", + items: [ + { + type: "doc", + id: "apis-tools/administration-sm-api/specifications/get-usage-metrics", + label: "Get usage metrics for clusters", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Clusters", + items: [ + { + type: "doc", + id: "apis-tools/administration-sm-api/specifications/get-clusters", + label: "Get current clusters", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/apis-tools/camunda-api-rest/sidebar-schema.js b/docs/apis-tools/camunda-api-rest/sidebar-schema.js index 465f7ac2831..10a6be03827 100644 --- a/docs/apis-tools/camunda-api-rest/sidebar-schema.js +++ b/docs/apis-tools/camunda-api-rest/sidebar-schema.js @@ -5,7 +5,7 @@ module.exports = { "apis-tools/camunda-api-rest/camunda-api-rest-overview", "apis-tools/camunda-api-rest/camunda-api-rest-authentication", { - Specifications: require("./specifications/sidebar.js"), + Specifications: require("./specifications/sidebar"), }, ], }; 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 59492ca42e9..e6bb1ccc8d7 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,56 +5,491 @@ 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: eJztWm1vGzcS/isEv1yMW6+UXtrLbdsDFDtt5baOYSu9A2x/4O6OtLS55IbkSlYF/ffDkPsmaWUrRQ5oAQUIEomz8/rMPFyRK2rZzNDoll6omN4HVBWgmeVKjlMaUZZYPmcWLlRsaEBTMInmBS7TiI4tigKxmVblLCNMCPIo1UKSgmnLUcoQJlNSayEPKjakLIhVxGZANHwqwVhISc6eeF7m4Z2kAa2+fqfSJY1W7iPXkNLI6hICmihpQVpcYkUheOLcHTwYdGpFTZJBzvB/dlkAjaiKHyCxNKCFxuAsB9OurrZiQrceVExwNSDMkBSmXEJKuHQuv7v69ZIUWiVgDHkF4Swk3/0OEENkmXk8R2EXuFPw/R0t2DIHaU8N6DlP4I6Swb9PXJSVd8ZqLmd0HdCF0o+g+12SLAeips4FL1cnlcsZqZw2AcmVsWJJSgMpmSpNhJrNUKIodaEMmB27AZWlECwW4NO7DqjlOajS7jrCXGY02FJjRtjUgiY244YkWPoFF4JIZUkMTcVTEi8Jk8pmoL1UKS0XzuPKDnnFJcnNCcmYITGAJBpYkkHazRKXFmagaUCnSufM+q++eYN5y9kTwnOiRpXR/hRWEPMYtKoFZbz0QVSwe8noP75Co1OwSfYb09ynbjdVghuLFZtXMs6mewpRVcOsWf2W8CmBvLDLwPXRnBseC+g8zmyTNdRbl19JV2hcMokqGpSgdleRGJqSdTPKtGbLnfIHlFvIO/3R4HPd9OVkHz4mbUs3phOVFwIQCIsMJAYhgGFmpHeRmw5WlG5A1WiabKIkJONp3/L3ZBgQht3KSmEbbHHjemHfU9/hU0JhgyghsFG4ISk3mJDUja7OQ7jWhsPzHFLOLIhlQGAO0gco1U5Y4UFAxuHqfKfRsK8pQTJpx6l5Dmvjc+PK72SNw8Ui40m2AfcHP8q3YLCv7DuuVDjwA/nWi7czo68b73HZogLkmFGD2+uq39Zrr9QUSho/m78aDvvhVUfaYgbDCelnsMKhStsc7SEQJ9SrcNe7F7LdWGBCfJjS6PaPkxeudGfAK5OpUiDD4uhZZMySBTMt9Z70UVFFcC2d4Wagz1pc5LKhw/F5x/DfTPN92qg5yNZvoA33Vds1OPeLhxt6boiDACTnfcExY1TCXR2R3EklTsbnfXEkpbEq/wlYCrq3Sw04lHk5knnBZn+RlqiI5CoFN4m+7RCtIfi05kzw3yElFzcfLkmqkhK96YEpS1OXBCauOqCpBsln7jL8/GgB7ZjyQcV9GdBgdYXPnmTmqpQuAZUYETC1fifoVTZQZWLBlrgXIIUy3PI5nBxWzxRYKrjs6Qw3m+uWSJjc3KOwGeMyIAaL65L98XL8XwKFwtHJczCW5cVhm5GGr3d9GCGtN3ReE3y1FXYAcwQeOJIpnV+2S/PoyedWu6aN/jnVNqyXIxbHg1rIZoOyW+Z1O83rCZ9eqPgdM0DX9z0z8mdY9iPiEXCvQ0rJP5VAeArS8ikH3exn9sCs6vaxNJbJBPbq35wNvBJHsweNoef8/iNzrh42L7ld5QOtVDlZ1nv8rYEU1LILbrPq/WRjD7gde997x5560nV3ZYu3PVO7Z7tcO5dpmLC8lCkLWcHDR1iaUJZ5DPrvRx4+8vCRh488fOThvzgPP5f0L8nMB9j50lz9nMk/GXvvd3UPLi4dDf8MS3MAs28IH8DxHpNHjj9y/JHjjxx/5Pi/Oscf37X/hO/aKPNm3+/ihVZznuJoY5bh6QOew82Z4NXpw55fxwutYgH5i8w9IldekqRgGRfEd4Q/H0XB2J+Q3l7/cEb+9ebrf96/yqwtTDQYLBaLUE+TU0i5VTpUejbQ0wT/otxJSCYZaDydW7o50TQYacFNTAEJn/KkbuDKbce/G6crLzD49tFnM1JKzXdOt0fk4/V4BxYbpruHNpTFqrRRLJh8pG05d41uWzFlnjO97OCoY2AdUGOZLbsbmL1TeVs3AuOnyeSKeBUkUSlUDc9NbQiDyLnEo1EavRkO3QmO//TNcOgGPVb8gEgkgadCMOkn6FY4eHqnNFT4cYHVnfKFKqM0n/Ftu+FG01UgPvcR+Zb6uq+lRpJgljXiELRWmqgkKbV2x5hcNN1e2652eMdeO/basdf29Rpe1QCbKbxXVCh30aJgNqMRHeCr26DdftGA4n0Zt7e/XdFSCxrRlW+YdTQYrDJl7DpaFUrb9WCO1djYC+Kyb6waMEIlTGTe6G7hcKG7Hz/zL7jkLbl+fzMhPzILC7Z0iUSTm6rfDt8Oe7Wi6B6No6sx8RF62HVGQa0We7pXrRc+RPEa94gGklJzu7zBx3x6YmAa9KjE3DdwqOw57fjZC9Gg+s8PNUgu/jNxdcYxdt1e1Hr/xPBmRB++6reg9pvmhtGw9/bOcOd6zW397P3uLZThxuWIVtKhfqqcRxUmd5OFyKlfgekwfL2L/6uxa+NE5Xkp3SyXM7cJJKyT/ESUxmLSAyp4Arhji1YUMdUx+4tfIdVLN3kdInA8uusRPuM2K+MwUfmg+pml+TcWKh7kjMtBZcIMzka/frw8H53+Mj57f3nz/vR1OAztk3UFwhbLmez4Mdq6ArIR6arlrf/bxb4KGRae7KAQjEsEv4t/VY2CW1r51hkG90HV0Ld0tYqZgY9arNf49acS9JJGt/dt/+OndUD9G7+bHvgOEtEzH9zpxN9XmTNRuh+Jtq+KrIP6iVGSQGGflb3vTLSrDzcT7Jbq0iL+tkAjqtkCLzSyBY3oHb2jFC9Yuvy5m434/YoKJmclm6G814t//gffQZhf +api: eJztWm2P2zYS/isDfrkEp9hOL+3l1PYAJ5u2TtvNInF6B2z2AyWNLe5SpEJS9rqG//thSEmWbXnjFDmgBRwgSGyO5vWZeSiTa+b43LL4mr3WCbuJmC7RcCe0mmQsZjx1YsEdvtaJZRHL0KZGlLTMYjZxJIrgcqOreQ5cSrhTeqmg5MYJkrLAVQaNFrjViYWqBKfB5QgGP1ZoHWZQ8HtRVMXgg2IRq79+obMVi9f+ozCYsdiZCiOWauVQOVriZSlF6t0d3lpyas1smmPB6X9uVSKLmU5uMXUsYqWh4JxAu11d78VEbt3qBGg1Am4hw5lQmIFQ3uUXV79eQml0itbCIxzMB/Dd74gJxo7buwsS9oF7Bd9/YCVfFajcE4tmIVL8wGD478c+yto764xQc7aJ2FKbOzT9LileIOiZdyHINUkVag610zaCQlsnV1BZzGCmDUg9n5NEWZlSW7QHdiOmKil5IjGkdxMxJwrUlTt0hPvMGHSVoYzwmUMDLhcWUir9UkgJSjtIsK14BskKuNIuRxOkKuWE9B7XduCRUFDYx5BzCwmiAoM8zTHrZkkoh3M0LGIzbQruwlffPKO8Ffye4DnV49pofwpriAUMOr0FZbIKQdSw+5TRf3xFRmfo0vw3bkRI3WGqpLCOKraoZbxN/xShqoFZu/otiBlgUbpV5PtoIaxIJHYe567NGultyq+VLzQt2VSXLUpIu69Igm3JuhnlxvDVQfkjJhwWnf5o8blp+3J6DB/TbUu3plNdlBIJCMscFQUhkVNmVHBR2A5WtGlB1Wqa7qJkAJNZ3/L3MIqAU7fySroWW8L6Xjj21Hf0lNTUIFpKahRhIROWEpL50dV5iNa24YiiwExwh3IVAS5QhQCVPghrcBKQabh631k86mtKVFy5SWYfwtrkwvrye1nrcbHMRZrvwP02jPI9GBwr+4ErNQ7CQL4O4tuZ0deNN7TsSAFxzLjF7du63zaboNSWWtkwm78ajfrh1US6xQyFM2CfwQqnKt3m6AiBeKFehYfefSLbrQUu5ZsZi6//OHnRSncGPLK5riQxLI2eZc4dLLndUu/jPiqqCW5LZ7QZ6LOWlIVq6XBy0TH8N9t+n7VqTrL1GxorQtUODS7C4umGHhriKJHI+Vhw3FqdCl9HIneoxWFy0RdHWlmni5+QZ2h6u9SiR1mQgzwItvuLrCJFUOgM/ST6tkO0FuhpI7gUv2MGr9+9uYRMpxV50wNTnmU+CVxedUBTD5LP3GWE+bEFtGfKW530ZcCgMzU+e5JZ6Er5BNRiIHHmwk4wqGyhyuWSr2gvAKW2wokFPj6tnhnyTArV0xl+NjctkXK1u0fhcy5UBJaK65P9/nLyX8BS0+gUBVrHi/K0zUjL14c+jInWWzpvCL7eCnuAeQKPPMlU3i/XpXny5HOr3dBG/5zaNmyQA0fjQS9Vu0E5LPNmO82bCZ+91skLbpFtbnpm5M+46kfEHdJeByolPlYIIkPlxEygafczR2BWd/tEWcdVikf1784GUYuT2ZPG0EN+/5E51wybT7ld54Os1DlZNXv8vYEUNbJL4fL6/WRnD7gfe997x5F6sk13ZY+3A1P7Z7tcu1DZIOVFpTI+4KUY3OHKDlRVJGj+fubhMw+fefjMw2ce/ovz8ENJ/5LMfIKdL83VD5n8k7H3cVeP4OLS0/DPuLInMPuO8AkcHzB55vgzx585/szxZ47/q3P8+V37T/iuTTLPjv0uXhq9EBmNNu44nT7QOdyCS1GfPhz5dbw0OpFYfJK5x3AVJCFDx4WE0BHhfJQEk3BCev32h5fwr2df//PmUe5caePhcLlcDswsfYKZcNoMtJkPzSylvyT3eADTHA2dzq38nGgbDLbgBltiKmYibRq4dtvz787pyicYfP/osx0plREHp9tjeP92cgCLHdPdQxvGE125OJFc3bFtOQ+N7luxVVFws+rgqGNgEzHruKu6G5ijU3lfNwHjp+n0CoIKSHWGdcML2xiiIAqh6GiUxc9GI3+CEz59Mxr5QU8VPyESBXhfSq7CBN0Lh07vtMEaPz6wplO+UGW0EXOxb3ew03Q1iC9CRKGlvu5rqbECyrIhHKIx2oBO08oYf4wpZNvtje16h3futXOvnXvtWK/RVQ10uaZ7RaX2Fy1K7nIWsyG9ug232y8WMbov4/f212tWGclitg4Ns4mHw3WurdvE61IbtxkuqBo7e0FaDo3VAEbqlMs8GD0sHC109+MvwwsuPIe3r95N4UfucMlXPpFkclf189HzUa9WEj2icXw1gRBhgF1nFDRqqad71QbhUxRvaI9oMa2McKt39FhIT4LcoBlXlPsWDrU9r50+ByEW1f/5oQHJ6/9MfZ1pjL3dXtR6dc/pZkQfvpq3oO037Q2jUe/tndHB9Zrr5tmbw1soo53LEVtJj/qZ9h7VmDxMFiGneQVmo8HTQ/xfTXwbp7ooKuVnuZr7TSDwTvJTWVlHSY+YFCnSji1eM8JUx+wvYQXql254OiDgBHQ3I3wuXF4lg1QXw/pnlvbfROpkWHChhrUJO3w5/vX95cX4yS+Tl68u37168nQwGrh75wtELVZw1fFjvHcFZCfS9Za3/m8X+2pkOLx3w1JyoQj8Pv51PQquWe1bZxjcRHVDX7P1OuEW3xu52dDXHys0KxZf32z7nz5tIhbe+P30oHeQmL0MwT2ZhvsqCy4r/yPR/lWRTdQ8MU5TLN2DsjediXb15t2UuqW+tEi/LbCYGb6kC418yWLG6HKlz52/1UjfrZnkal7xOckGnfTnf5Crl2M= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Activate jobs

+ - + Iterate through all known partitions and activate jobs up to the requested maximum. -## Request + -

Body

required
    )\n","type":"string"}}>
+ -The list of activated jobs. +)\n', + type: "string", + }, + worker: { + description: + "the name of the worker activating the jobs, mostly used for logging purposes", + type: "string", + nullable: true, + }, + timeout: { + description: + "a job returned after this call will not be activated by another call until the timeout (in ms) has been reached\n", + type: "integer", + format: "int64", + }, + maxJobsToActivate: { + description: "the maximum jobs to activate by this request", + type: "integer", + format: "int32", + }, + fetchVariable: { + description: + "a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned\n", + type: "array", + nullable: true, + items: { type: "string" }, + }, + requestTimeout: { + description: + "The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.\n", + type: "integer", + format: "int64", + default: 0, + nullable: true, + }, + tenantIds: { + description: + "a list of IDs of tenants for which to activate jobs", + type: "array", + items: { type: "string" }, + nullable: true, + }, + }, + required: ["type", "timeout", "maxJobsToActivate"], + title: "JobActivationRequest", + }, + }, + }, + }} +> -
Schema
    jobs object[]
    - -The activated jobs. - -
  • Array [
  • ]
Schema
    jobs object[]
    - -The activated jobs. - -
  • Array [
  • ]
Schema
    jobs object[]
    - -The activated jobs. - -
  • Array [
  • ]
- -The provided data is not valid. - -
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/add-user-to-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx index cd65f5d47d7..a618bac3bd1 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx @@ -12,53 +12,267 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a user to a group

+ Assigns a user to a group. -## Request + -

Path Parameters

+ -The user was assigned successfully to the group. + -
- -The user could not be assigned. -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}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The group or user with the given key was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user with the given key is already assigned to the group. - -
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/assign-group-to-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/assign-group-to-tenant.api.mdx index 0fd9e5aadda..67c23faf065 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/assign-group-to-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/assign-group-to-tenant.api.mdx @@ -12,48 +12,226 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a group to a tenant

+ Assign a single group to a specified tenant. -## Request - -

Path Parameters

- -The group was successfully assigned to the tenant. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant or group was not found. - -
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/assign-mapping-rule-to-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/assign-mapping-rule-to-tenant.api.mdx index 880eab7995f..16df610cafa 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/assign-mapping-rule-to-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/assign-mapping-rule-to-tenant.api.mdx @@ -12,48 +12,226 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a mapping rule to a tenant

+ Assign a single mapping rule to a specified tenant. -## Request - -

Path Parameters

- -The mapping rule was successfully assigned to the tenant. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant or mapping rule was not found. - -
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/assign-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx index 77758fd209c..f15c8198d3c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx @@ -5,55 +5,259 @@ description: "Assigns a user task with the given key to the given assignee." sidebar_label: "Assign user task" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/isHfFmLKba7pV2rNzdtt2y9BImzPSQBQlPHNhuKVHmxIxj678MhJTu+pC22PjqAEUk8PNfvO5TOknk+dSy/YpcOLXju7thNxkyFlntp9GnBcsadk1NNAiNaz1iBTlhZkQDL2TAuO+AQOh2wkH4GfoYwlXPUcIc1ePPgQVKJ2GMZq7jlJXq05MeSaV4iy1lozf2FNcuYJEMV9zOWMYtfgrRYsNzbgNvejGYYzZlJNLd2yZvWKtl0YoYlZ/mS+boic1J7nKJlGZsYW3KfHr04Zk1zk0yi869NUdOebQ+E0R61pyVeVUqKmLv+Z0ceLXeNmfFnFJ5Ct5RpL9HFvW1S6Ho3qG4VJsZuhtaDjfUyOA/aeBgjYFn5GoyFWx2UuqXQWx+ct1JPWcZogY8VsnzClcMmY1wps/g0R2tlsceZ1zUUOOFB+Sz6EbMrHVhsXShATkB6WHAHXFnkRd15V/TgAj34mXRUkNto8pYuLfpgNXANaK2xIDW4IGYguEOXIoyGYnR+hhom0roYZNArw97Qg9Utn3Kpe3DpMJlc0L7aBJjxeUqgg0qKO6mnMLGmhKk1oUqGvgQMGL2sLM5Re7BcIAijC0mZcL1rvU7n2BiFXG/kk8BB6RQpcdt5HIIIzpsSkgDMuQrkJ/ewkErFQIRA5+RYYXJvjeboEeXcBeVX7scgUReVkdqD1HOToNiD00mERGXNXBZYZLE+ZKUtJcV53SLwmm2EtgcpMbImY156umVdb0itoETtzxNjWNOQnEVXGe0SzH8ZHO9H+Cq6n1xbQtKUYFR8Ds5j0WNNxo4Hg69RJG7aof+ejiS4bmkiTFkpJP3wwViEAj2XygG3uEoZIZL2d7HA2BR1StQj/K+sGSssf97tA9tAOEuSrV1I/QG4gyQ4Ttavzt+dwKvj57/dPJl5X7m8318sFj07EUdYSG9sz9hp304E/UjuaeSNRSh5HeFUJOhyBevOA65CISdSdB26dRuo/BtAeKRtpdXlDlxWjTRYuXtowOX5KcgCtZeTmgC8YzruieCkM2hsgs/Hius7tgbertFtKy6UJber42DTQJMx57kP7psHwa+/7OgmwP0xGp1BUgHCFF1vlq4zREGUUssylCw/HgwyVvL7dPdiMGhIJ1X8OyLRgPeV4jpCazscqaFc4zYGJrXzXIsfVRlj5VRu2+2xh02gBfGbFFEi/vE3ub6PmMR4YubEBF30DgQ7EOxAsEcJ9uo/EEy67jRbWKOnMcMIIliL2qv6cAoeSHog6Y8j6fN9L6xDDZRlSzhMnzxGRAYWsJhJFdXHt//WdvsNeuDagWsHrj3GtSZjJfqZobFVZVyEDk2NctanA/GIDkTXXz4YLjX99VcjDYbQzrtJVLCK5WyZSNTk/f5yZpxv8mVlrG/6c6rQnFtJ38SxoLScyNaBSBnB1Sw5sltMWqBxVxfkCS+DLji8hPO3FyP4nXtc8Doml0xuqn45eDnYq5VEH9E4PDuFFGGC4oP20Kklnu9Vm4S/R3EcmTkUwUpfX9C2lJ4xcot2GKgeK4i09qL2OEiJQixrL951wPnzn1GsPbW28/U47u09p0/3zfHZGndbo6w0rusGMp1YxO7ERKdaZO2GR7VG69LGQe/ZLorPTiMZhSnLoGNH1tP08sUfpEsoGmRYoqmSArWLvrdDz07sfVqBv5NFeNajUic8do14Kv0sjHvClH2Rtq3+j5UZ90sudb814fonww+XH98Mj96fnrz9ePH26Flv0PP3PqaUiFJy/cCPNMdZv0NuB7tcH0D/e/zb4sDjve9XiktN9YihLlvuXrE1d1nG8s3R8AP63mQtBa/YcjnmDi+tahp6/CWgrVl+dbNmbKR4IR1dF+3w8ythPjlvh75P4ftGzHvjah9yXcfeoQLdsYzdYb01825umozNkBdoo6dJ4iT5czQiPWsNO1PnJut2DIXAyj8iu/G+QKxdNc+zTxcjImE78S4N0YdZvqABPF+wnF2za/LcxFxFfsfnS6a4ngY+Jfmkl/7+BWsSd60= +api: eJztWFtv2zYU/isHfFmLKbK7pV3rNzdNt2y9BImzPaQBQlPHNhuKVHmxIxj678MhJTu+pC22PjqAEUk8PNfvO5TOknk+dWxwza4cWvDc3bGbjJkKLffS6LOCDRh3Tk41CYxoPWMFOmFlRQJswIZx2QGH0OmAhfQz8DOEqZyjhjuswZsHD5JKxJxlrOKWl+jRkh9LpnmJbMBCa+4vrFnGJBmquJ+xjFn8EqTFgg28DbjtzWiG0ZyZRHNrl7xprZJNJ2ZYcjZYMl9XZE5qj1O0LGMTY0vu06MXx6xpbpJJdP61KWras+2BMNqj9rTEq0pJEXPX++zIo+WuMTP+jMJT6JYy7SW6uLdNCl3vBtWtwsTYzdBy2Fgvg/OgjYcxApaVr8FYuNVBqVsKvfXBeSv1lGWMFvhYIRtMuHLYZIwrZRYf52itLPY487qGAic8KJ9FP2J2pQOLrQsFyAlIDwvugCuLvKg774ocLtGDn0lHBbmNJm/p0qIPVgPXgNYaC1KDC2IGgjt0KcJoKEbnZ6hhIq2LQQa9MuwNPVjd8imXOocrh8nkgvbVJsCMz1MCHVRS3Ek9hYk1JUytCVUy9CVgwOhlZXGO2oPlAkEYXUjKhMs/6XU6x8Yo5HojnwQOSqdIidvO4xBEcN6UkARgzlUgP7mHhVQqBiIEOifHCpN7azRHjyjnLii/cj8GibqojNQepJ6bBMUcziYREpU1c1lgkcX6kJW2lBTnpxaBn9hGaHuQEiNrMualp1vW9YbUCkrU/iIxhjUNyVl0ldEuwfyX/vF+hK+i+8m1JSRNCUbF5+A8FjlrMnbc73+NInHTDv33dCTBdUsTYcpKIemH98YiFOi5VA64xVXKCJG0v4sFxqaoU6Ie4X9lzVhh+fNuH9gGwnmSbO1C6g/AHSTBcbJ+ffH2BF4dP//t5snM+8oNer3FYpHbiTjCQnpjc2OnPTsR9CO5p5E3FqHkdYRTkaDLFaw7D7gKhZxI0XXo1m2g8m8A4ZG2lVaXO3BZNdJg5e6hAVcXZyAL1F5OagLwjum4J4KTzqCxCX4wVlzfsTXwdo1uW3GhLLldHQebBpqMOc99cN88CH79ZUc3Ae6P0egckgoQpuh6s3SdIQqilFqWoWSD434/YyW/T3cv+v2GdFLFvyMSDXhfKa4jtLbDkRrKNW5jYFI7z7X4UZUxVk7ltt2cPWwCLYjfpIgS8Y+/yfV9xCTGEzMnJugiPxDsQLADwR4l2Kv/QDDputNsYY2exgwjiGAtaq/qwyl4IOmBpD+OpM/3vbAONVCWLeEwffIYERlYwGImVVQf3/5b2+036IFrB64duPYY15qMlehnhsZWlXEROjQ1GrAeHYhHdCC63vLBcKnprb8aaTCEdt5NooJVbMCWiUTNoNdbzozzzWBZGeub3pwqNOdW0jdxLCgtJ7J1IFJGcDVLjuwWkxZo3NUFecLLoAsOL+Hi9HIEv3OPC17H5JLJTdUv+y/7e7WS6CMah+dnkCJMUHzQHjq1xPO9apPw9yiOIzOHIljp60valtIzRm7RDgPVYwWR1l7UHgcpUYhl7cXbDjh//jOKtafWdrEex53ec/p03xyfrXG3NcpK47puINOJRexOTHSqRdZueFRrtC5t7OfPdlF8fhbJKExZBh07sp6mly/+IF1C0SDDEk2VFKhd9L0denZi79IK/J0swrOcSp3w2DXiqfSzMM6FKXsibVv9Hysz7pVc6l5rwvVOhu+vPrwZHr07Ozn9cHl69Czv5/7ex5QSUUquH/iR5jjrd8jtYJfrA+h/j39bHHi8971KcampHjHUZcvda7bmLsvYYHM0/IC+N1lLwWu2XI65wyurmoYefwloaza4vlkzNlK8kI6ui3b4+ZUwn1y0Q9+n8H0j5r1xtQ+5rmPvUIHuWMbusN6aeTc3TcZmyAu00dMkcZL8ORqRnrWGnalzk3U7hkJg5R+R3XhfINaumuf5x8sRkbCdeJeG6MMsX9AAni+S1ybmKXI7PlsyxfU08CnJJp309y+fRHax 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign user task

+ Assigns a user task with the given key to the given assignee. -## Request + -

Path Parameters

Body

required
+ -The user task's assignment was adjusted. + -
- -The assignment of the user task with the given key cannot be completed. 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 user task with the given key was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user task with the given key is in the wrong state currently. 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/assign-user-to-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/assign-user-to-tenant.api.mdx index 84d3a2644cb..51680068212 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/assign-user-to-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/assign-user-to-tenant.api.mdx @@ -12,48 +12,224 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a user to a tenant

+ Assign a single user to a specified tenant. -## Request - -

Path Parameters

- -The user was successfully assigned to the tenant. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant or user was not found. - -
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/broadcast-signal.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx index a328fa04332..29be1919d5e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx @@ -5,52 +5,286 @@ description: "Broadcasts a signal." sidebar_label: "Broadcast signal" hide_title: true hide_table_of_contents: true -api: eJztWN9v2zYQ/lcIPm2YIrld2nV6c9N0S9ulQeJuD6kfTtLZYiuRKknFMQT978ORki1bThYMK7AHBzBiWaf78X33keI13MLS8PiW34ilhILPA64q1GCFkhcZj3miFWQpGNsZBDxDk2pRkQWP+ev+vmHAjLMJecA1fqvR2NcqW/O4cZdCY8Zjq2sMeKqkRWnpFlRVIVIXMPpiyGfDTZpjCfTNrivkMVfJF0wtD3ilKT0r0Dg7F+8SSqSr3cRmOTIJJTK1YDbHLjdmFduURIl2AYzVQi55G/A70AKSwgeALBPkD4qrQWBfwzhcF2LjgQGB8u7m4yXzBQwCdhW1AbcoQVoC+1AJF2/6ArwdszlYplbSDKo6UEgbDEC/HSI1D7gVtiBjz+mGwmtPGm9b/7iplDQeiOeTyeH8uppXYHZx/dcMQ1F8XPD4dj/YazDItvSzhdJslL/PeAzzfuM8jnmH9Bb6vncI+lGlY+AfhNenR5Xwdn64md/j+nBStRTfavxuSTmbIVN3MgtTKGuZQQiVCL/i2oSyLhPUP41ZzLDSmILdSvzI63fkVUiLS9Q84AulS7D+p5enT0nz0nH4HtfmaZx7AA5wfmT4/6Jcsjp9aIWutLoTGWYsAwtMGCaVZXdQiOyRdbrSKimwPKj0YYApu/KWLEMLoug2Otr5vGGCGROS3V6/PWO/nr74Zf5Dbm1l4iharVahXqQnmAmrdKj0MtKLlD5k92PIZjlqZCWsWYJsuxMPW8lUmIqFSGlbt75WlwyBGH6W/9xN7m6zB/pAVbUWo1eeKft0fcFEhtKKxVrI5Ti0e2YBdUE+IFG1jZMC5Fe+pXMcdD+KqcsS9Lrvmt0AbcCNBVsPynhgVfj5+cg3tcXvs9kV8y5YqjJ0srS5MH0gKqIUUpR1yePTySTgJdz7q5eTSUs+ifEnVCIZ3lcFSNda++UIyUqlsesfV5iQxoJM/ytmlBZLsR833JFW18RvfEW9oE4ffeXplLRQtTwq6aiko5IeVNKLQ1vTVDJCWVMfotZKM5WmtdaYsVUuCuc+RWP62N2J0vfiUWtHrR21NtZaG/ASba5oclMp41oHbM5jHvldy0Sbl00ecIP6DrVx7+y1LnjMGy+ZNo6iJlfGtnFTKW3b6I742JmN0G0vrb5lCpVCkfuwY+roxnAgc+YPGuwVuz6/mbHfwOIK1g5KCrnr+tXk1eSgVzJ9wOP06oL5Cn3jDRaD3i2p+qBbb/wUxy2dBwymtRZ2fUOPeXgSBI16WhP6m4bo4jnvdO2NeNB9edu3ybu/Zo5pWsiut6O083soKy/D4ehr22dDgnZGS4MBl5AL5VLqumhcHDlCbTwak/DZuGOvLpzwUlWWtXSrr1yylbA5gwFYaVEbSyAFvBAp0lklbrj0OfdmH/wd9qePyJ6FRLTvxn7RXQqb10mYqjLqjqeb/0mhkqgEIaMuhInOpn98unwzPflwcXZ+eXN+8iychPbeOkBJFCXIQR6b81T3XrdfbLPdbB4adnbkWry3UVWAkASzq6Dp5NcP4AxRvRHgPOhEdMubJgGDn3TRtvTztxr1mse38y2ldNUGPEfIUDvFfqUDJz/z2Z3MKAkyL2pKZjR0a4P+iWmaYmUftZ0P1pGrjzczSrsb5ZYqo2c0rGjMCyse88/8M+c0OCYPrvnd7w0vQC5rWJK990t/fwNDZMq8 +api: eJztWF1v2zYU/SsEnzZMkdwu7Tq9uWm6pR9pkLjbQ+aHK+naYiuRKknFMQT99+GSki1bThYMK7AHBzBiWVf345x7SPE23MLS8PiW34ilhILPA64q1GCFkhcZj3miFWQpGNsZBDxDk2pRkQWP+ev+vmHAjLMJecA1fqvR2NcqW/O4cZdCY8Zjq2sMeKqkRWnpFlRVIVIXMPpiyGfDTZpjCfTNrivkMVfJF0wtD3ilKT0r0Dg7F+8SSqSr3cRmOTIJJTK1YDbHLjdmFduURIl2AYzVQi55G/A70AKSwgeALBPkD4qrQWBfwzhcF2LjgQGB8u7m0yXzBQwCdhW1AbcoQVoC+1AJF2/6ArwdszlYplbSDKo6UEgbDEC/HSI1D7gVtiBjz+mGwmtPGm9b/7iplDQeiOeTyeH8uppXYHZx/dcMQ1F8WvD4dj/YazDItvSzhdJslL/PeAzzfuM8jnmH9Bb6vncI+lGlY+AfhNenR5Xwdn64md/j+nBStRTfavxuSTmbIVN3MgtTKGuZQQiVCL/i2oSyLhPUP41ZzLDSmILdSvzI63fkVUiLS9Q84AulS7D+p5enT0nz0nH4HtfmaZx7AA5wfmT4/6Jcsjp9aIWutLoTGWYsAwtMGCaVZXdQiOyRdbrSKimwPKj0YYApu/KWLEMLoug2Otr5vGGCGROS3V6/PWO/nr74Zf5Dbm1l4iharVahXqQnmAmrdKj0MtKLlD5k92PIZjlqZCWsWYJsuxMPW8lUmIqFSGlbt75WlwyBGP4l/7mb3N1mD/SBqmotRq88U/b5+oKJDKUVi7WQy3Fo98wC6oJ8QKJqGycFyK98S+c46H4UU5cl6HXfNbsB2oAbC7YelPHAqvDz85FvaovfZ7Mr5l2wVGXoZGlzYfpAVEQppCjrksenk0nAS7j3Vy8nk5Z8EuNPqEQyvK8KkK619ssRkpVKY9c/rjAhjQWZ/lfMKC2WYj9uuCOtronf+Ip6QZ0++srTKWmhanlU0lFJRyU9qKQXh7amqWSEsqY+RK2VZipNa60xY6tcFM59isb0sbsTpe/Fo9aOWjtqbay1NuAl2lzR5KZSxrUO2JzHPPK7lok2L5s84Ab1HWrj3tlrXfCYN14ybRxFTa6MbeOmUtq20R3xsTMbodteWn3LFCqFIvdhx9TRjeFA5swfNNgrdn1+M2O/gcUVrB2UFHLX9avJq8lBr2T6gMfp1QXzFfrGGywGvVtS9UG33vgpjls6DxhMay3s+oYe8/AkCBr1tCb0Nw3RxXPe6dob8aD78rZvk3d/zhzTtJBdb0dp5/dQVl6Gw9HXts+GBO2MlgYDLiEXyqXUddG4OHKE2ng0JuGzccdeXTjhpaosa+lWX7lkK2FzBgOw0qI2lkAKeCFSpLNK3HDpc+7NPvg77A8fkT0LiWjfjf2iuxQ2r5MwVWXUHU83/5NCJVEJQkZdCBOdTT9+vnwzPflwcXZ+eXN+8iychPbeOkBJFCXIQR6b81T3XrdfbLPdbB4adnbkWry3UVWAkASzq6Dp5NcP4AxRvRHgPOhEdMubJgGDn3XRtvTztxr1mse38y2ldNUGPEfIUDvFfqUDJz/z2Z3MKAkyL2pKZjR0a4P+iWmaYmUftZ0P1pGrTzczSrsb5ZYqo2c0rGjMCysec05DY3raNb77reEFyGUNS7L1PunvbytLycA= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Broadcast signal

+ - + Broadcasts a signal. -## Request + -

Body

required
    variables object
    + -The signal variables as a JSON object. + -
- -The signal was broadcast. - -
Schema
Schema
Schema
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The signal is not found. - -
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/camunda-8-rest-api.info.mdx b/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx index c8c484fd2ab..eb8e1dac584 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Camunda 8 REST API

+ API for communicating with a Camunda 8 cluster.
-

- Authentication -

+
diff --git a/docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx index 831d4748c8d..a40e48fd8d1 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx @@ -5,51 +5,206 @@ description: "Cancels a running process instance. As a cancelation includes more sidebar_label: "Cancel process instance" hide_title: true hide_table_of_contents: true -api: eJztWN1v2zYQ/1eIe2oxRXK6tOv0MMBL0y1b2wWOuz0keaClk8WWIlWSimMI+t+HIyV/yUFbYC8DEsCIJR7v8/c789iC40sL6Q1cGZ2htUwo67jKEO4i0DUa7oRWlzmkkNFr2ctdDmIR5GgzI2qSgxTOvZRlnJlGKaGWrD7QHLMpLQd1Xj0TKpNNjpZV2iBzJVfsU2MdcyUyg5W+55Lpwj8eamMGrW5MhpFf3tU6rLCKdC2Q1do6zGOIoOaGV+jQUOwtKF4hpFDvx/YnriECQVHV3JUQgcEvjTCYQ+pMg4ehz0tkn3H9qKdO9+6RBzYrseKQtuDWNRkXyuESDURQaFNxF169OoOuuwuW0bpfdb6mPVtHCi4tRpBp5VA5WuN1LUXmU5B8suRZO7amF58wcxCBaqTkC4lDSLWhqjuBlqQ3CJhhgQap4Gl7EPaUmWHRh5+V2qJii7XPQmPRUEUdWwkpfRW4cZQjLiUzmGmTWypVIx2hpTC6Yq4Ulm1sx7fqfV/BX9iEiYJSey9yzONbBdFXExhBJZSomgrS066LwAlH8fZQPQD0LCQauo5EDdpaKxuS8WJyNo5+fqzSwvaVJrR1EZxNJo/u9IGwnDtO25R27J5L4VH6SFFroxcSqx/GxT0szFWQZDk6LiQLRWfcsiC4wJwJxW5mb8/Zz2cvf7p7VjpX2zRJVqtVbIrsBHPhtIm1WSamyOhDcs9jNi/RIKv4mqrC81yQTS7ZFj7M1piJQmSE+54P3hkq117hNljcx15Y3SDWOiPUcre6jRGj9jNlH2eXTOSonCjWBKiRab+n4I0kHXyhG5cuJFefYQuNsdFDK7apKm52ub5joIvAOu4a+1V6//hipJtg8ft8fsWCCpbpHFmhTSBFbyjeBfXZZBJBxR/C06vJpCOdVPFviEQxfKglV6FlHoQjVOjIQZsPbPP78N9URhuxFId2Y9ilaQ/iNyGiwMuz76EicarQjXri1BOnnjj1KKdeHvuRmtLhzKEhHKIx2jCdZY0xmLNVKeSGcIPt/pwSsPjEtSeuPXFtzLUuggpdqWmqopnEDySuhBSSnk4ng5s2acdTSZeE02WYc2iYQHM/zDKNkZBCG0jVpUnSltq6Lm1rbVyX3FPF7rkRdOj3BablQL4BVFJnXJbBsXFxaYEGpiHoc141KufsNZtdXM/Zb9zhiq99ssnkvurXk9eTo1pJ9BGN06tLFiIM0NxpF4Na4v1RtUH4WxT7Mcti1hjh1te0LaRngdygmTZUnw1kenteOz0HIYj6L28HIP3xz9xjgVrdbDvCXTzwqg5EPTZhTTxOC+0NboaVQ9epjmhsiHUSn44Re3XpiZfpqmqU775qyVbClYzvpCKTjXWUggikyFBZ71c/Eg9i78IK+ztYZKcxlTFgbWi6S+HKZhFnukqysG3zfyH1Iqm4UElvwibn0/cfP7yZnry7PL/4cH1xchpPYvfgfLqIFBVXe34Q4EfHu8OY2+1vzv/kJqIHlMMHl9SSC0UQ93lt+6ZwA6OmABGkRy8r9vrCXdRz+wbadsEtfjSy6+j1lwbNGtKbu20r8L0jF5a+b68VHk3us1l/A/Gcfde1x9Fw+5dcrX1vkg09QQSfcX38Vqa76yIokedovN9B8Dx4dzIndVtFo/uQLhp2TLMMa/eI7N4xhZrDpmdf/XU9J673lzGVzmmv4Su6IuIrSOEWbikA7TPn24h/34LkatnwJckHvfT3L0h9xuY= +api: eJztWFtv2zYU/isEn1pMkZwu7TI9DPDSdMvWdoHjbg9pHmjqyGJLkSovcQxB/304pOSbHLQF9jIgAYxY4uG5ft8xD1vq2NLS/JZeG83BWiKUdUxxoHcJ1Q0Y5oRWVwXNKcfXspe7GsQSWoDlRjQoR3N6EaQsYcR4pYRakuZAc0qmuBzVBfVEKC59AZbU2gBxFVPkk7eOuAqIgVrfM0l0GR4PtREDVnvDIQnLu1qHFVKjrgWQRlsHRUoT2jDDanBgMPaWKlYDzWmzH9ufsKYJFRhVw1xFE2rgixcGCpo74+Ew9HkF5DOsH/XU6d499MDyCmpG85a6dYPGhXKwBEMTWmpTMxdfvTqjXXcXLYN1v+pijXu2jpRMWkgo18qBcrjGmkYKHlKQfbLoWTu2phefgDuaUOWlZAsJQ0iNwao7ARalNwiYQQkGsOB5exD2lJhhMYTPK21BkcU6ZMFbMFhRR1ZCylAFZhzmiElJDHBtCoul8tIhWkqja+IqYcnGdvpRvesr+AuZEFFiau9FAUX6UdHkqwlMaC2UqH1N89OuS6gTDuPtoXoA6FlMNO06FDVgG61sTMaLydk4+vmxSgvbVxrR1iX0bDJ5dGcIhBTMMdymtCP3TIqA0keK2hi9kFD/MC7uYWGuoyQpwDEhSSw6YZZEwQUURChyO3tzQX4+e/nT3bPKucbmWbZarVJT8hMohNMm1WaZmZLjB+Wep2RegQFSszVWhRWFQJtMki18iG2Ai1JwxH3Ph+AMlmuvcBss7mMvrm4Qa50RarlbXW/EqP1MyYfZFREFKCfKNQJqZDrsKZmXqIMttHf5QjL1mW6hMTZ6aMX6umZml+s7BrqEWsect1+l948vRroRFr/P59ckqiBcF0BKbSIpekPpLqjPJpOE1uwhPr2aTDrUiRX/hkgUgYdGMhVb5kE4QsWOHLWFwDa/D/9NZbQRS3FoN6W7NO1B/DpGFHl59j1URE6V2qsnTj1x6olTj3Lq5bEfqSkezhwYxCEYow3RnHtjoCCrSsgN4Qbb/TklYvGJa09ce+LamGtdQmtwlcapCmeSMJC4iuY06+l0Mrhps3Y8lXRZPF3GOQeHCTD3wyzjjaQ5bSOpujzL2kpb1+Vto43rsnus2D0zAg/9ocC4HMk3gEpqzmQVHRsXFxdwYBqCvmC1VwUj52R2eTMnvzEHK7YOyUaT+6rPJ+eTo1pR9BGN0+srEiOM0NxpF4Na5P1RtVH4WxSHMcsC90a49Q1ui+lZADNgph7rs4FMby9ox+coRJP+y5sBSH/8Mw9YwFY3245wlw+sbiJRj01Yk4DTUgeDm2Hl0HWsIxgbY52kp2PEXl8F4nFd116F7quWZCVcRdhOKrj01mEKEioFB2WDX/1IPIi9jSvk72iRnKZYxoi1oekuhav8IuW6znjctvm/kHqR1UyorDdhs4vpuw/vX09P3l5dXL6/uTw5TSepe3AhXUiKmqk9PxDwo+PdYczt9jfnf3IT0QPKwYPLGsmEQoiHvLZ9U7ilo6ZAE5ofvazY6wt3Sc/tW9q2C2bhg5Fdh6+/eDBrmt/ebVtB6B2FsPh9e63waHKfzfobiOfku649jobbv2RqHXqT9PhEE/oZ1sdvZbq7LqEVsAJM8DsKXkTvTuaobqtodB/SJcOOKefQuEdk944p2Bw2Pfv6r5s5cr2/jKl1gXsNW+EVEVtF53XIWmgh4V1LJVNLz5YoG3Xi378/vMXq 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Cancel process instance

+ Cancels a running process instance. As a cancelation includes more than just the removal of the process instance resource, the cancelation resource must be posted. -## Request + -

Path Parameters

Body

    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
+ -The process instance is canceled. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + title: "CancelProcessInstanceRequest", + }, + }, + }, + }} +> -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The process instance is not found. - -
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/complete-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx index d6eb78f2f32..70bf0340a8d 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx @@ -5,79 +5,308 @@ description: "Complete a job with the given payload, which allows completing the sidebar_label: "Complete job" hide_title: true hide_table_of_contents: true -api: eJztWVtz27YS/is7eGl7SlGy66Qx33ycpHVOmnpsuZ2p7ZmA5EqCDQIsAFrmaPjfzyxAStTFdtLLmzLjiURir/i+BbS7YI5PLUuu2QedstuI6RINd0Krs5wlLNNFKdEhvYxYjjYzoqS3LGGn7TvgcKdTmAs3AzdDmIoHVFDyWmqeRzCfiWwGXEo9t9DqE2rql3JrdSa4wxwsmgeRIThu7+MbxSJWcsMLdGjIvQVTvECWsDud/g9rFjFBPpTczVjEDP5ZCYM5S5ypcNPR8QzhHmvQE2+UnHW6cwVjFjGbzbDgLFkwV5dkRSiHUzQsYhNtCu7Co9dHrGlugzm07r86r0lmZX3CpcWIZVo5VI7e8bKUIvMJHd5ZcmexbU2nd5g5CtlQ+p1AS28fuBE8leELz3NBWrg87y16KtylaD/SZfS0VRT2pnlVSUlSQW9DgdpKul2eri/d5UKQ7ZLe+ZB7B7iFnHa2EApzSGu/ZK7NPZp4Kw05KkHJXTqRai2Rqy1AnqmcUo0W5jN0MzQ9teC12OWTCESMMeAjbY9wsoZco1XfOOBlafQDgnAxvNcG8JGT6xFwGHN7Dx+FdajQQMYVaa378QmtKGLuYUyBWXQt2oWFieRT2hBKWQxnKjxdGnhSj7BgsDRoUbmQr0A5N+OuHyN5tNxsn2PKXAwnFni7H1tWWiwHG7S5mANXuV/mjRssuFAWeObEA8bwFie8ks4jy+M9sHULO5k2BjOyYXcBaH3rPlz++gnCu1BIuHNGpJXzW8YdzNGQ217lFmRu1I0iyE00VRlKd0+ckpL2ZCNYUam/bi6kpIViqrTBPCGl/4HP3FoxVYifYUApREe2CSEi94YUYFG6Gi6dEWrqRfIK33L3NRLB8avyK8UyrnKRc4c/GV2V9iVJKaxbl7uyaL5crDRCG+FqEiiEEkVVwCiCgj/6jwejUQR5QAe8GlH+znva2vqrLa5nnTYbPhN8PsMDlxWCNqALEXgjHHjgmwe0N4r2vERjiYL5Ss03NkjuQuJmNen2s4dJ6zO6hcmTdmVXwvzJtAvp7X7v0rg8PSjbAycK3DJDwM0rBFrxoqk+UP6GvaBmUJVfZnUdLz273Bhe77RAoCG9S1GoSHbTlHBY2O1AmuecCGD/i15MvfDfcKMjwYuXhR8Od7rUyW+60BKKJaOItYxiCVFq04UmYk44+kpXtgtf1U97tXbngs2np8sD4CLUf9Y0TTjwS61soMrh6Cicv5sx+DsEt71D3VZZhtZOKinrmPJ2NBo9I7t+VaS7WcaV0i4U6lZpDL9og3RR4EJa4Abb6oQ5COXlO3ch1Xkd2P/E3as0OpVYfL99B9sgPZyHla3d7lDypyktTIP164v3p3B89OrH229nzpU2GQ7n83lsJtkAc+G0ibWZDs0koz9a910M4xkdYgWvKczeIbQqUGBLzMREZP6W4NESnCGkhfievzKGt8/UhcqI7UIHVxdnIHJUTkzq7m6+ZtrL+MpOfEt15ZJUcnXPVrB6sZyCrYqCmyXy1w00EbOOu8r+VWL9PB6fQ1ABmc6pyJlwwWoNrbHsaNTn2evRiOq43/EviET5eyNXvLun9cMRCooVbn1gQlnHVfZP7Yw2Yio27cZrFG9B/DZEFLh99CydtylJDCdOTnSl8nhPrT219tR6klrHX0UtYbsTbG60mvrcImSVMaicrPcn356ee3r+c/R8tesyeqKAsmwIh2gM/ejMPANzallKr57utJ3ttlGy59qea3uuPcW1JmIFupmm2UGprYcOtegTNrzTqR0uQvu+Ga46kNR+p/ZO2+avjGQJWwTmNMlwuJhp65pkUWrjmuEDbctaY5xeB4Z1yJE643IWrG/vIL2gWUIX2SkvKpVzeAMX7y7H8BN3OOfhRyyZXFf9ZvRmtPtnvTbuCY0n52cQIgz469WETi2Re6fasPhLFPvBhMWsoubCJYmF9KTIDZqTijZhiYvWntfuO+p+EYvaD+87tHz4few3nOrZxWro8S50rDdnFGsDg65rH3pwG83gVROuh/6ui8YOR4dHg4PDwcHx+OBVMvox+eE4Pn59/Afb7H89t3KzZ3XdWbrd0Urqv1w1eEYez0JNtE9dC/rtTSBEUlPS79ooPtgm2PmZrxOZLopK+cNCTbvW50pfJivrwgREigyV9Rlu517dso/hDfwWLMJBTIAMrOnOiKlwsyqNM10MsyC2/D+VOh1SQ3/YmrDD05Nfrj69PRl8PDt99+ny3eAgHsXuMbSMiMMFV30/uvnC3fZIcLE6F//16WCLZIePblhKLhRxy6dh0Zaca5oVWhaxZDkz7FWd26itHNdssUi5xSsjm4Ye/1mhqVlyfbsqNL4y5cLS59WY78nYv71oJ4Lfwcuzx52BdJ1NVftyJyv6xiJ2j/VqBtrcNhGbIc/ReAfDy9PgxmBMKlbCW4PIJuokTrIMS/fE2rUrDdWYZX0///VyTCWjnYIWOidZw+c0kOVzlrAbdkNO63JJfP98wSRX04pP/TzX66V//wfyEJmO +api: eJztWW1z2zYS/is7+NL2jqJon90k/OZzkp7TNPXY8nWmjmcCkisJNgiwAGiZo+F/v1mAlKgX20nb++bMeCKR2Fc8zwLaXTLHZ5al1+yDzthNxHSFhjuh1VnBUpbrspLokF5GrECbG1HRW5ay0+4dcLjVGSyEm4ObI8zEPSqoeCM1LyJYzEU+By6lXljo9Ak180u5tToX3GEBFs29yBEct3fxZ8UiVnHDS3RoyL0lU7xElrJbnf2MDYuYIB8q7uYsYgb/qIXBgqXO1Ljt6GSOcIcN6Kk3Ss463buCMYuYzedYcpYumWsqsiKUwxkaFrGpNiV34dGPR6xtb4I5tO7fumhIZm19yqXFiOVaOVSO3vGqkiL3CR3fWnJnuWtNZ7eYOwrZUPqdQEtv77kRPJPhCy8KQVq4PB8seizclegw0lX0tFUU9rZ5VUtJUkFvS4HaWrp9nm4u3edCkO2T3vtQeAe4hYJ2thQKC8gav2ShzR2aeCcNBSpByV05kWktkasdQJ6pglKNFhZzdHM0A7XgtdjVkwhEjDHgA22PcLKBQqNV3zngVWX0PYJwMbzXBvCBk+sRcJhwewcfhXWo0EDOFWlthvEJrShi7mFMgVl0HdqFhankM9oQSlkMZyo8XRl4VI+wYLAyaFG5kK9AOTfnbhgjebTabJ9jylwMJxZ4tx87VjosBxu0uVgAV4Vf5o0bLLlQFnjuxD3G8BanvJbOI8vjPbB1Bzu5NgZzsmH3AWhz6z5c/voJwrtQSLhzRmS181vGHSzQkNte5Q5kPqvPiiA31VRlKN0DcUpKNpCNYE2l4bqFkJIWipnSBouUlP4DvnBrxUwhfoERpRAd2SaEiMIbUoBl5Rq4dEaomRcpanzL3bdIBMevqm8Uy7kqRMEd/mR0XdnnJKWwblPuyqL5erHKCG2Ea0igFEqUdQlJBCV/8B8PkiSCIqADjhPK3/lAW1d/tcXNrNNmwxeCzxe457JG0AZ0KQJvhAMPfHOP9rOiPa/QWKJgsVbznQ2S+5C4XU36/Rxg0vqM7mDypFvZlzB/Mu1Derff+zSuTg/K9siJEnfMEHCLGoFWPGtqCJS/YC+oGdXV11ndxMvALjeGN3stEGhI70oUapLdNiUclnY3kPYpJwLY/6QXMy/8F9zoSfDsZeFfh3td6uW3XegIxdIkYh2jWEqU2nahjZgTjr7Sle3CV/XTQa3du2D76enqALgI9Z+1bRsO/EorG6hymByF83c7Bn+H4HZwqNs6z9HaaS1lE1PejpLkCdnNqyLdzXKulHahUHdKY/hFG6SLAhfSAjfYVScsQCgv37sLmS6awP5H7l6V0ZnE8p+7d7At0sN5WNnZ7Q8lf5rSwixYv754fwpvjo5f3Xw/d66y6Xi8WCxiM81HWAinTazNbGymOf3Ruh9imMzpECt5Q2EODqF1gQJbYS6mIve3BI+W4AwhLcT39JUxvH2iLtRG7BY6uLo4A1GgcmLa9HfzDdNexld24luma5dmkqs7tobVs+UUbF2W3KyQv2mgjZh13NX2zxLrP5PJOQQVkOuCipwJF6zO0AbLjpIhz35MEqrjfse/IhLl741c8f6eNgxHKCjXuPWBCWUdV/nftTPaiJnYthtvULwD8dsQUeD20ZN03qUkMZw4OdW1KuIXar1Q64Vaj1LrzTdRS9j+BFsYrWY+twh5bQwqJ5uXk++Fni/0/PvoebzvMnqigLJsCIdoDP3ozD0DC2pZSq+e7rS97a5R8sK1F669cO0xrrURK9HNNc0OKm09dKhFn7Lxrc7seBna9+143YGk9ju1d7o2f20kS9kyMKdNx+PlXFvXpstKG9eO72lbNhrj9DowrEeO1DmX82B9dwfpBc0S+shOeVmrgsNruHh3OYGfuMMFDz9iyeSm6tfJ62T/z3pt3CMaT87PIEQY8DeoCb1aIvdetWHx1yj2gwmLeU3NhUsSC+nJkBs0JzVtwgoXnT2v3XfU/SIWdR/e92j58NvEbzjVs4v10ONd6Fhvzyg2BgZ91z704Laawesm3AD9fReNHSaHR6Pk1ejwzeTgOD0+SA9fx8mrg9/Zdv/rqZXbPavr3tLNnlbS8OW6wZN4PAs11T51Heh3N4EQSU1Jv2tJfLBLsPMzXydyXZa18oeFmvWtz7W+XNbWhQmIFDkq6zPczb36ZR/DG/hvsAgHMQEysKY/I2bCzessznU5zoPY6v9M6mxMDf1xZ8KOT09+ufr09mT08ez03afLd6ODOIndQ2gZEYdLroZ+9POF292R4HJ9Lv7fp4Mdkh0+uHEluVDELZ+GZVdyrmlWaFnE0tXMcFB1bqKuclyz5TLjFq+MbFt6/EeNpmHp9c260PjKVAhLn9djvkdj//6imwj+AM/PHvcG0nc2VePLnazpG4vYHTbrGWh700ZsjrxA4x0ML0+DG6MJqVgL7wwi26iXOMlzrNwjazeuNFRjVvX9/NfLCZWMbgpa6oJkDV/QQJYvgsO6WpHeP1syydWs5jM/y/U66d//ADVAmHY= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Complete job

+ Complete a job with the given payload, which allows completing the associated service task. -## Request + -

Path Parameters

Body

    variables objectnullable
    + -The variables to complete the job with. + -
    result objectnullable
    - -The result of the completed job as determined by the worker. - -
    corrections objectnullable
    - -JSON object with attributes that were corrected by the worker. - -The following attributes can be corrected, additional attributes will be ignored: - -- `assignee` - reset by providing an empty String -- `dueDate` - reset by providing an empty String -- `followUpDate` - reset by providing an empty String -- `candidateGroups` - reset by providing an empty list -- `candidateUsers` - reset by providing an empty list -- `priority` - minimum 0, maximum 100, default 50 - -Providing any of those attributes with a `null` value or omitting it preserves -the persisted attribute's value. - -
- -The job was completed successfully. - -
- -The job with the given key cannot be completed. 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 job with the given key was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the given key is in the wrong state currently. 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/complete-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx index 707f67a255b..7916bf58154 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx @@ -5,59 +5,253 @@ description: "Completes a user task with the given key." sidebar_label: "Complete user task" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SuYPSVTmlRSJ014Ux2ndZukHltuD7YPILmSEIMAA4CSNRz+984CpL5oTdxOjvKMxiKx2Lcf74HUNuD4zEJ6CzcWDXPcPsB9BLpCw53Q6qKAFHJdVhIdksmELCIo0OZGVGQCKZx1BpZxVvd+2FK4OXNzZDOxQMUecBVDBBU3vESHhlAbULxESKHuXP+JK4hAkNOKuzlEYPBbLQwWkDpT4z7yZI7kmOmpR9qAO836sAnV5nMsOaQNuFVFgEI5nKGBCKbalNyFW29PoW3vAyha96suVrRnE8OUS4sR5Fo5VI7WeFVJkftiJV8tBdUM0XT2FXNH2RsqrRNoaXXBjeCZDBe8KAR54fJyy+hQ0uut25nu1YAaQMnvB6FqKWlv8N5GwPPgudkDGrO8tk6XLBiwBZc1gXDHlkJKliHjeY7WikwimxpdbqHjApWzzKCtpRNqFtbdXFiGqqi0UI4JtdChdjG7mDKlHauMXogCi4iJDqXAKa+lo0Tv1ly8g/hObXKzzgg1G+bWRuCEo0vo2duRVWh1FboMbUt2Bm2llQ3NeD06HZZjsltdbteFL5itfSGmtZSrGNoITkej73oYCITlXFERMty4jtlnbZAV6LiQlnGD6xoxofz+PnSW6WIV6nKAoZXRmcTypyFT9zt/GSw7XBbIw7hlwTAL6LdXH8/Y+9M3v9y/mDtX2TRJlstlbKb5CRbCaRNrM0vMNKcP2b2M2WSOBlnJV54/a9azjTaYrTAXU5FTzynBLmxG3d7p+wFhhdVmwI611msjBqfYmN1cXTBRoHJiuiLGDqD9Hs9GSIFnunZpJrl6gA3PhqD7KLYuS27WZ9YuQBuBddzV9rtn1c+vB76JXr9PJpcsuGC5LpBNtQmq64AoiVIoUdYlpKejUQQlfwxXb0ejlnxSx5+RiWL4WEmuPLX20xGKlRve+sSEso6r/Ed1RhsxE/u4MWxrviPxh5BR0PnpM6Q9FCapnZQ51bUq4qPAjgI7CuygwN7/D4EJ2z/Nlkarma8wsrw2BpWTq+NT8CjSo0h/nEjfPPV6OlaMqmyIh2iMNkznXoEFW86F9O79636H3f1MOmrtqLWj1g5prY2gRDfXNEmptPXUodFGCgk9EE/ogWiTZmsC0ib5+jcqzS7QLPpxSW0kpNAEEbVpkjRzbV2bNpU2rk0W1KGdqQItB7H1JJI653IeAhk2kxZoJtMnecbLWhWcvWNX59cT9ht3uOThFy5B7rp+N3o3etIrmR7wOL68YCHDQMWt46F3Szp/0m0wfo5jP9WxmNdGuNU1bQvlyZAbNOOa+rGmSIfnvdN1MIKo+/KxJ84f/0x87+lou9pMjM4fOXVvf8CzNWfpSegZOtUeuuPPMAnqKBobNo7iV0OuXl54yeW6LGvlz101C69YfKsouayto2JEIEWOyvoIu/lbb/YprLC/AyJ7FVNDA+v643Ym3LzO4lyXSR62rf9nUmdJyYVKOgibnI0/33z5MD75dHF2/uX6/ORVPIrdo/OFIzmUXG3H0U+y1u+K++k2mwfNf5o7dr11+OiSSnKhqPo+sabT4y1s9AgRpLszyS1J3kedrG6haTJu8cbItqXb32o0K0hv7zcq9LIthKXvmwHiwZReXHWzxpfsubPNJzPrbnK18ieCrOkKInjA1d64tb1vI5gjL9D4WIPFWYjoZEJ+Nh4G08426neM8xwrd8B25y2AtLg+Ei//up6QtLpRa6kL2mv4kma/fAkp3MEdRa59tbxq/f0GJFezms/IPvilv38BCf/mzg== +api: eJztWE1z2zYQ/SsYnJIpTSqpkzq8qY7Tuk1Sjy23B8cHEFyKiEGAAUDJGg7/e2cBUl+0Jm4nR3lGY5FY7NuP90BqW+rY3NL0jt5aMMQx+0DvI6prMMwJrS5zmlKuq1qCAzSZoUVEc7DciBpNaErPewNLGGkGP2QpXElcCWQuFqDIA6xiGtGaGVaBA4OoLVWsAprSpnf9J6xoRAU6rZkraUQNfGuEgZymzjSwjzwrAR0TXXikDbjTZAgbUS0voWI0balb1QgolIM5GBrRQpuKuXDr7SntuvsACtb9qvMV7tnEUDBpIaJcKwfK4Rqraym4L1by1WJQ7RhNZ1+BO8zeYGmdAIurC2YEy2S4YHku0AuTV1tGh5Jeb93OdK8G2ABMfj8I1UiJe4P3LqKMB8/tHtCU8MY6XZFgQBZMNgjCHFkKKUkGhHEO1opMAimMrrbQYQHKWWLANtIJNQ/rrhSWgMprLZQjQi10qF1MLguitCO10QuRQx4R0aPkULBGOkz0y5qLX2j8RW1ys84INR/n1kXUCYeXdGBvT1ah1XXoMu06tDNga61saMbryem4HLPd6jK7LnxObOMLUTRSrmLaRfR0Mvmuh5FACGcKi5DBxnVMPmkDJAfHhLSEGVjXiAjl9w+hk0znq1CXAwytjc4kVD+Nmbrf+atg2eOSQB7CLAmGWUC/u/5wTt6dvvnl/kXpXG3TJFkul7Ep+AnkwmkTazNPTMHxg3YvYzIrwQCp2MrzZ816stEGsTVwUQiOPccE+7AJdnun7weEFVbbETvWWm+MGJ1iU3J7fUlEDsqJYoWMHUH7PZ6NNKUs041LM8nUA93wbAy6j2KbqmJmfWbtAnQRtY65xn73rPr59cg30uv32eyKBBeE6xxIoU1QXQ+ESVRCiaqpaHo6mUS0Yo/h6u1k0qFP7PgzMlEEHmvJlKfWfjpCkWrDW5+YUNYxxX9UZ7QRc7GPG9Ntzfckfh8yCjo/fYa0x8JEtaMyC92oPD4K7Ciwo8AOCuzd/xCYsMPTbGm0mvsKA+GNMaCcXB2fgkeRHkX640T65qnX06kiWGWDPARjtCGaewXmZFkK6d371/0eu/+ZdNTaUWtHrR3SWhfRClypcZJSa+upg6ONlCb4QDzBB6JN2q0JSJfw9W9UnF2AWQzjksZImtI2iKhLk6QttXVd2tbauC5ZYId2pgq4HMQ2kEhqzmQZAhk3ExdwJjMkec6qRuWMnJHri5sZ+Y05WLLwCxchd12fTc4mT3pF0wMep1eXJGQYqLh1PAxuUedPug3Gz3HspzoWeGOEW93gtlCeDJgBM22wH2uK9HjeO14HIxr1Xz4MxPnjn5nvPR5t15uJ0cUjw+7tD3i25iwDCT1DC+2he/6Mk8COgrFh4yR+Nebq1aWXHNdV1Sh/7qp5eMViW0XhsrEOixFRKTgo6yPs52+D2cewQv4OiORVjA0NrBuO27lwZZPFXFcJD9vW/zOps6RiQiU9hE3Op59uP7+fnny8PL/4fHNx8iqexO7R+cKhHCqmtuMYJlnrd8X9dNvNg+Y/zR373jp4dEktmVBYfZ9Y2+vxjm70SCOa7s4ktyR5H/WyuqNtmzELt0Z2Hd7+1oBZ0fTufqNCL9tcWPy+GSAeTOnFdT9rfEmeO9t8MrP+JlMrfyLIBq9oRB9gtTdu7e67iJbAcjA+1mBxHiI6maGfjYfRtLOLhh1TzqF2B2x33gJQi+sj8eqvmxlKqx+1VjrHvYYtcfbLliFq7SvlFevvtVQyNW/YHG2DT/z7F4GP5dI= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Complete user task

+ Completes a user task with the given key. -## Request + -

Path Parameters

Body

    variables objectnullable
    + -The variables to complete the user task with. + -
- -The user task was completed successfully. - -
- -The user task with the given key cannot be completed. 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 user task with the given key was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user task with the given key is in the wrong state currently. 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/correlate-message.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx index ddd8bcb7d20..b5355f72fee 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx @@ -5,57 +5,353 @@ description: "Publishes a message and correlates it to a subscription." sidebar_label: "Correlate message" hide_title: true hide_table_of_contents: true -api: eJztWW1v2zYQ/isEP22YKrtt1nX65qbp5r6kRuJuH5J8oKizxYYiVb7EMQz99+FEyZYtO81egHWYAwS2zOMd7+55TkdyRR2bW5pc0Q9gLZsDvYmoLsEwJ7QaZzShXBsDkjloJSKageVGlChCEzrxqRQ2B0sYKYIMYSoj64mWCEecJoxYn65nxtdqPFsLCa2IsMR6zsHamZc4ZyGkJAacN4q4HMhMGOtIaTTKEKGsY4oDuYVlPdwaXxvOyEK4PL5WNKIGvniw7pXOljRZ1Y/CQEYTZzxElGvlQDkcYmUpBa+XNPhs0cUVtTyHguE3tyyBJlSnn4E7GtHSYLicAIujihWAn9sRmnYWhxKEWZLBTCjIiAiuvZp8OG89q9fb2LHOCDWnVUQ7kXoHy/1GutHEqOhZNzA9rZjJGfPS0YSiiTtmBEtlcOWwC2sx9OPt5cdzkmnuCwxfRFmWCZzD5KQTmRDk3dgpLyUqCuNVRB0ophzCbtc+uhFGyUwbssgFz7eSLiwpGyBmexzdMYW2hMPHFvinm9BdBKjQqkI5A7bUyoagPBsOH46NsF34OU20AqINKbSBHnIt/RPAO2yzk+mO7WY0wiQtQEr8/AqJhLtWe8mzmzgm5ccZTa52V/WK2drLJu91qvbFN0Q03qN5m06H8TDd4GH8+rD3fSJ9JfNhZegHrW52l9MoPUi/BxOxj9NNFsZNEh6j+ED6Hqh/fzEGtVgXkncqizkrvMpYzEoR38LSxsoXKZgfvhm4knewJMw5I1LvQoVSvgAjOLlj0oMNgM6gNMBx2qHadIT434G4UA7mYGhEZ9oUzIWfXpz8C6A/vJRHxem8Bvg7WNrHESIk4dshxLF+/3/rNwqeHOpYSqPvRAYZyZhj2Lco7bBGiuxwV1IanUoovoruEZkESZKBY0KSgI/Q96JgGjrfq4s3p+Tnkx9/uvkud660yWCwWCxiM+NPIBNOm1ib+cDMOP6j3PcxmeZggBRsSVIgm26zC1tbAhczwbH/csHVejEYxv2E2IFtPbrqNZHrAuKN6G2DRuTTxZiIDJQTs6VQ877prYabpdq7JJVM3dJNQvtGd61YXxTMrPG0baCKqHXM+Y4bBwrg82c93YiKX6fTCQkqCNcZ1CXA5dhdB0PoRCGUKHxBk5PhMKIFuw9PL4bDCnVixh/hiSJwX0qmwnZlxx2hQssctNWOtVz5hzKjjZiLXbvxFrkaEL8OHrV8et7H+xttUpFloGp4kmav2ZKKSakXkMVHXh15deTVQV6d9PF+rnG779XxlXSkzpE6h6jz474Wb6QIRtkgDsEYbYjm3BuDTWUu5PowqrXdvLMCFo9cO3LtyLU+16qIFuByjfcipbY1dJjLaUIHzebNDjpn8DSiFswdGFvvtb2RNKGrwJoqGQxWubauSlalNq4a3GFKto7gcTiwq0WN1JzJPFjuZw8H6vuFxqvTcDhBXpKLs8sp+YU5WLBlHU00ua365fDlcK9WFD2gcTQZk+BhwF6nHrRqkdh71QbhxyiucCdvgXsj3PISp4XwpMAMmJHHBKwx0dirteNzEKJR8+VNi5S3v0/rZGMtu9jcDZ3ds6IMTAx3ORuQ7V7AbEa6Sdu6xegcFQg10/UyG3D1HUZFYGyI0DB+2gfyZFzzkeui8KouympeHxEQ1gkgl946DFxEpeCARwEbb1qx92GE/BYskqcxJj8gtK3Fc+Fyn8ZcF4PmmGv9mUqdDgom1KAxYQenow+fzl+Pnrwfn56dX549eRoPY3fv6iAjVwqmuutozzg6xytb3q42L6H/yA1jA0AH925QSiYUpr2O6KqpElftCZTdhhNeugauX9HVKmUWPhlZVfjzFw9mSZOrmw3K8KmKaA4sA1MXltsajqchXk+muA4Ulx7X07tVqqJ2xohzKN2Dsjedijf5eDlFIjVXqIXOcI5hC7xeZQua0Gt6TSleIKOGmqP17ysqmZp7zHJCg178+wMGZ7As +api: eJztWW1v2zYQ/isEP22YIrtt1nX65qbp5r6kRuJuH9J8oKizxYYiVb7EMQz99+FEyZYtO81egHWYAwS2zOMd7+55TiRvRR2bW5pc0/dgLZsDvYmoLsEwJ7QaZzShXBsDkjloJSKageVGlChCEzrxqRQ2B0sYKYIMYSoj64mWCEecJoxYn65nxp/UeLYWEloRYYn1nIO1My9xzkJISQw4bxRxOZCZMNaR0miUIUJZxxQHcgvLerg1vjackYVwefxJ0Yga+OLBupc6W9JkVT8KAxlNnPEQUa6VA+VwiJWlFLxe0uCzRRdX1PIcCobf3LIEmlCdfgbuaERLg+FyAiyOKlYAfm5HaNpZHEoQZkkGM6EgIyK49nLy/qL1rF5vY8c6I9ScVhHtROotLPcb6UYTo6Jn3cD0tGImZ8xLRxOKJu6YESyVwZXDLqzF0I83Vx8uSKa5LzB8EWVZJnAOk5NOZEKQd2OnvJSoKIxXEXWgmHIIu1376EYYJTNtyCIXPN9KurCkbICY7XF0xxTaEg4fW+CfbUJ3GaBCqwrlDNhSKxuC8nQ4fDg2wnbh5zTRCog2pNAGesi19E8A77DNTqY7tpvRCJO0ACnx8yskEu6T2kue3cQxKT/MaHK9u6qXzNZeNnmvU7UvviGi8R7N23Q6jIfpBg/jV4e97xPpK5kPK0M/aHWzu5xG6UH6PZiIfZxusjBukvAYxQfS90D9+4sxqMW6kLxTWcxZ4VXGYlaK+BaWNla+SMH88M3AlbyFJWHOGZF6FyqU8gUYwckdkx5sAHQGpQGO0w7VpiPE/w7EhXIwB0MjOtOmYC789Pz0XwD94aU8Kk4XNcDfwtI+jhAhCd8OIY71+/9bv1Hw9NCOpTT6TmSQkYw5hvsWpR3WSJEd3pWURqcSiq+ie0QmQZJk4JiQJOAj7HtRMA073+vL12fk59Mff7r5LneutMlgsFgsYjPjJ5AJp02szXxgZhz/Ue77mExzMEAKtiQpkM1uswtbWwIXM8Fx/+WCq/ViMIz7CbED23p01dtErguIN6J3DBqRj5djIjJQTsyWQs37prc23CzV3iWpZOqWbhLaN7prxfqiYGaNp20DVUStY8533DhQAJ897elGVPw6nU5IUEG4zqAuAS7H3XUwhE4UQonCFzQ5HQ4jWrD78PR8OKxQJ2b8EZ4oAvelZCocV3bcESpsmYO22rGWK/9QZrQRc7FrN94iVwPiV8Gjlk/P+nh/rU0qsgxUDU/SnDVbUjEp9QKy+MirI6+OvDrIq9M+3i80Hve9Or6SjtQ5UucQdX7ct8UbKYJRNohDMEYbojn3xuCmMhdyfRnV2m7eWQGLR64duXbkWp9rVUQLcLnGvkipbQ0d5nKa0EFzeLODzh08jagFcwfG1mdtbyRN6CqwpkoGg1WurauSVamNqwZ3mJKtK3gcDuxqUSM1ZzIPlvvZw4G6v9B4dRYuJ8gLcnl+NSW/MAcLtqyjiSa3Vb8Yvhju1YqiBzSOJmMSPAzY69SDVi0Se6/aIPwYxRWe5C1wb4RbXuG0EJ4UmAEz8piANSYae7V2fA5CNGq+vG6R8ub3aZ1srGWXm97Q+T0rysDE0MvZgGy3AbMZ6SZtq4vRuSoQaqbrZTbg6juMisDYEKFh/KQP5Mm45iPXReFVXZTVvL4iIKwTQC69dRi4iErBAa8CNt60Yu/CCPktWCRPYkx+QGhbi+fC5T6NuS4GzTXX+jOVOh0UTKhBY8IOzkbvP168Gp28G5+dX1ydnzyJh7G7d3WQkSsFU911tHccneuVLW9Xm5fQf6TD2ADQwb0blJIJhWmvI7pqqsR1ewNlt+GETdfA9Wu6WqXMwkcjqwp//uLBLGlyfbNBGT5VEc2BZWDqwnJbw/EsxOtkiutAcelxPb2uUhW1M0acQ+kelL3pVLzJh6spEqlpoRY6wzmGLbC9yhbYRMTmMc6u+Vn/tqKSqbnHDCc06MS/PwBYjq8w 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Correlate message

+ - + Publishes a message and correlates it to a subscription. If correlation is successful it will return the first process instance key the message correlated with. -## Request + -

Body

required
    variables objectnullable
    + -The message variables as JSON document + -
- -The message is correlated to one or more process instances - -
Schema
Schema
Schema
- -The provided data is not valid - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
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/create-deployment.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx index 5f7f999e043..0fb9cda78e7 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx @@ -12,94 +12,776 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Deploy resources

+ - + Deploys one or more resources (e.g. processes, decision models, or forms). This is an atomic call, i.e. either all resources are deployed or none of them are. -## Request - -

Body

required
- -The resources are deployed. - -
Schema
    deployments object[]
    - -Items deployed by the request. - -
  • Array [
  • processDefinition object
    - -Base properties for DeploymentProcess. - -
    decisionDefinition object
    - -Base properties for DeploymentDecision. - -
    decisionRequirements object
    - -Base properties for DeploymentDecisionRequirements. - -
    form object
    - -Base properties for DeploymentForm. - -
  • ]
Schema
    deployments object[]
    - -Items deployed by the request. - -
  • Array [
  • processDefinition object
    - -Base properties for DeploymentProcess. - -
    decisionDefinition object
    - -Base properties for DeploymentDecision. - -
    decisionRequirements object
    - -Base properties for DeploymentDecisionRequirements. - -
    form object
    - -Base properties for DeploymentForm. - -
  • ]
Schema
    deployments object[]
    - -Items deployed by the request. - -
  • Array [
  • processDefinition object
    - -Base properties for DeploymentProcess. - -
    decisionDefinition object
    - -Base properties for DeploymentDecision. - -
    decisionRequirements object
    - -Base properties for DeploymentDecisionRequirements. - -
    form object
    - -Base properties for DeploymentForm. - -
  • ]
- -The document upload 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}}>
+ + + + + + + diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx index b59905bb2f2..0817f5d0d91 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx @@ -5,31 +5,31 @@ 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: eJztV0tz2zYQ/is7ONlTipQTN015U22ndSdJPbbSHmwfVuRKREICDABa5mj43zsLkJZkybHb5ljN6EUs9/XtfrtcCYcLK9JrcaqzpiLlxG0kdE0GndTqPBepyAyho+H8vVRfRCRyspmRNQuJVJx4EUAopfoCTgNC3suDVOAKghOsGpUjvIWsbKwjE9+oG/VROwJXoANXSAtZYwwpV7agVdmCbepaG2cBFUg1qqjSpl1rtk4bimBZyKwAaUFpBxWhcjDXBmqj8yZjB6Gx5K2laaq0oxs1ZWOk8lpL9tAbuMayLhDmhK4xdHuQZLqqtSLlbEJoynaEWUbWJl4ufI56aRtX+SGgyqHCFmYEtpl9psxxKrIC1YJulFQwb1gYDJWElmzsPbpRIhI1GqzIkWEsVkJhRSIVQ6TnuYiE5ETX6AoRCUNfG2koF6kzDT1GY1oQnJ+CnvvEP6TLaQ9PLCJhs4IqFOlKuLZmS9YZqRai66IH4z67a8tfGzLtluk5lvaltr2ywYPto7nR1bd9ug1WybpfdN6yxI4TmVaOizddCazrUma+fJPPlp1a7erWHh5OvOFid5KsP5UVTfV7eUcbslI5WpARkZhrU6ELl94c73QBx84aRk6PSnlHO1nwwUsFlY39zXNsSifS12/G/Oq6SDjpSra52W2XIXbRdSxhyNZa2eDvq/ERf+26sW1yiRZCF+dgG1/F86YsW/biO2WuMeUudPsSNDDEZmJi0UWC7mtpyE7cPj0Pmc/R0YiTvFd57llI5R4GWBYUuMfb7PXH4qk89wk+Ho9fklOfTyaXOcqS8hg+cIXn5FCWFtAQE9CdzCkfGHBADmY6b2Pf9k8kvzZ6VlL1wy4I215N4CJI9nYhgANoIQjOgvXry3cn8PPxjz/dHhTO1TZNkuVyGZt5NqJcOm1ibRaJmWf8ZrnDGKYFGRroDPNcsk0sYQ072JoyOZfZAGfvNjB4Ib5nus2ffgPsxsgdmCfw6fIcZE7KyXkr1WLX9GZvCZzpxqWzEhngB+Cfq9QJ2Kaq0LRDD28b6CJhHbrGPksTr1/tLdTfptMLCCog0zn5ieVHYG+Ig6ikklVTifR4PI5Ehffh35vxuGOdjPgLIlFc+SWqUK2PwmEyWtetD0wq61Bl3wsZbeRCPra73YR9EZ+GiLrQhhW5QvP6UWvrS4cnXyqSoQttslqPxy7hnrQ8RcjcDVPUc5JYhe7p0iRZFdq6Ll3xUtEldwzNHRqJszIUJB+HLhuqp9QZlkXwYBdFPuBpOUS33nEuz66m8Cs6WmLrs8omt1W/Hb8d79XKok9onFycQ4gw1OAGLwxqucH3qg3CL1HsJ66lrDHStVd8W0jPjNCQmTQMxENt9Pa8dv4fhETU/3g3VMzvf0096Mxpl+tpfnaPVd135MbwHUYil+Nch9NQLLuOM4pkbIh0HB/tFubFue+vTFdVozzJqgUspSsA9+ylIhKlzEhZ71W/DQ1i78MJ/BkswlHMIIZKG7h1IV3RzOJMV0kWbnv4npV6llQoVdKbsMnJ5MOnj6eT0fvzk7OPV2ejo3gcu3vnk8W1X6Ha9CNs2tuz6MAvo4ePA1+t58v/G/p/3dD7cnd075K6RKm4AfutJ3DT9cO+zkSUbi3vgZ5uo55irsVqNUNLn0zZdXw5bNdMWrm0zEdP7NebkP77VXtvLF+o3dr677BsWEowGww0+Q9dPLjsF/VDeP6hZK9X/UVU7aZLg7cbOe5uu0gUhDkZ72QQOAmujKasZq1gZ9Pl555wxyTLqHbflL3dmE4Xf1xNmez6B5NK53yPwSU/KuFSpOJG3LDD2qfH86i/vhIlqkWDC5YPevn1N6xZZOg= +api: eJztV0tz2zYQ/is7ONlTipQTN015U22ndSdJPbbSHmwfVuRKREICDABa5mj43zsLkJZkybHb5ljN6EUs9/XtfrtcCYcLK9JrcaqzpiLlxG0kdE0GndTqPBepyAyho+H8vVRfRCRyspmRNQuJVJx4EUAopfoCTgNC3suDVOAKghOsGpUjvIWsbKwjE9+oG/VROwJXoANXSAtZYwwpV7agVdmCbepaG2cBFUg1qqjSpl1rtk4bimBZyKwAaUFpBxWhcjDXBmqj8yZjB6Gx5K2laaq0oxs1ZWOk8lpL9tAbuMayLhDmhK4xdHuQZLqqtSLlbEJoynaEWUbWJl4ufI56aRtX+SGgyqHCFmYEtpl9psxxKrIC1YJulFQwb1gYDJWElmzsPbpRIhI1GqzIkWEsVkJhRSIVQ6TnuYiE5ETX6AoRCUNfG2koF6kzDT1GY1oQnJ+CnvvEP6TLaQ9PLCJhs4IqFOlKuLZmS9YZqRai66IH4z67a8tfGzLtluk5lvaltr2ywYPto7nR1bd9ug1WybpfdN6yxI4TmVaOizddCazrUma+fJPPlp1a7erWHh5OvOFid5KsP5UVTfV7eUcbslI5WpARkZhrU6ELl94c73QBx84aRk6PSnlHO1nwwUsFlY39zXNsSifS12/G/Oq6SDjpSra52W2XIXbRdSxhyNZa2eDvq/ERf+26sW1yiRZCF+dgG1/F86YsW/biO2WuMeUudPsSNDDEZmJi0UWC7mtpyE7cPj0Pmc/R0YiTvFd57llI5R4GWBYUuMfb7PXH4qk89wk+Ho9fklOfTyaXOcqS8hg+cIXn5FCWFtAQE9CdzCkfGHBADmY6b2Pf9k8kvzZ6VlL1wy4I215N4CJI9nYhgANoIQjOgvXry3cn8PPxjz/dHhTO1TZNkuVyGZt5NqJcOm1ibRaJmWf8ZrnDGKYFGRroDPNcsk0sYQ072JoyOZfZAGfvNjB4Ib5nus2ffgPsxsgdmCfw6fIcZE7KyXkr1WLX9GZvCZzpxqWzEhngB+Cfq9QJ2Kaq0LRDD28b6CJhHbrGPksTr1/tLdTfptMLCCog0zn5ieVHYG+Ig6ikklVTifR4PI5Ehffh35vxuGOdjPgLIlFc+SWqUK2PwmEyWtetD0wq61Bl3wsZbeRCPra73YR9EZ+GiLrQhhW5QvP6UWvrS4cnXyqSoQttslqPxy7hnrQ8RcjcDVPUc5JYhe7p0iRZFdq6Ll3xUtEldwzNHRqJszIUJB+HLhuqp9QZlkXwYBdFPuBpOUS33nEuz66m8Cs6WmLrs8omt1W/Hb8d79XKok9onFycQ4gw1OAGLwxqucH3qg3CL1HsJ66lrDHStVd8W0jPjNCQmTQMxENt9Pa8dv4fhETU/3g3VMzvf0096Mxpl+tpfnaPVd135MbwHUYil+Nch9NQLLuOM4pkbIh0HB/tFubFue+vTFdVozzJqgUspSsA9+ylIhKlzEhZ71W/DQ1i78MJ/BkswlHMIIZKG7h1IV3RzOJMV0kWbnv4npV6llQoVdKbsMnJ5MOnj6eT0fvzk7OPV2ejo3gcu3vnk8W1X6Ha9CNs2tuz6MAvo4ePA1+t58v/G/p/3dD7cnd075K6RKm4AfutJ3DT9cO+zkSUbi3vgZ5uo55irsVqNUNLn0zZdXw5bNdMWrm0zEdP7NebkP77VXtvLF+o3dr677BsWEowGww0+Q9dPLjsF/VDeP6hZK9X/UVU7aZLg7cbOe5uu0gUhDkZ72QQOAmujKasZq1gZ9Pl555wxyTLqHbflL3dmE4Xf1xNmez6B5NK53yPwSU/KuEyOKt9ajyH+msrUaJaNLhg2aCTX38DK65j7A== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create document link (alpha)

+ Create a link to a document in the Camunda 8 cluster. @@ -41,14 +41,119 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature in future releases. ::: -## Request + -

Path Parameters

Query Parameters

Body

+ -The document link was created successfully. + -
Schema
- -The document link creation 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}}>
+ diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx index ab0f217f4a2..4e3e1a642c7 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx @@ -12,22 +12,25 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Upload document (alpha)

+ - + Upload a document to the Camunda 8 cluster. @@ -38,30 +41,183 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature in future releases. ::: -## Request - -

Query Parameters

Body

required
    metadata object
    - -Information about the document. - -
    customProperties object
    - -Custom properties of the document. - -
- -The document was uploaded successfully. - -
Schema
    metadata object
    - -Information about the document. - -
    customProperties object
    - -Custom properties of the document. - -
- -The document upload 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}}>
+ + + + + + + diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx index 5664d9a1006..af5a703d5c5 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx @@ -5,52 +5,179 @@ description: "Updates all the variables of a particular scope (for example, proc sidebar_label: "Update element instance variables" hide_title: true hide_table_of_contents: true -api: eJztWN1u4zYWfpUD3iTBKraTzbSzAraAm6a7aaczQeLpXsQBSklHFmcoUiUpO4YhoK+xr7dPsjikJP/IRnvRq90JECQiz//Pd0humOMLy+JndiexROVAKOu4SpG9RExXaLgTWt1nLGapQe6wpbtvyX7mRvBEomURy9CmRlTEwGL2scq4QwtcSnAFwrKjBJ0Dh4obJ9JacgM21RXCea4N4CsvK4kRVEanaG1vTgS51CvAAysvYCVc4eUvxBJVrwUy7vhorp4qTEW+9hSHzCCUX/8F9336Ede/kH28RIdmNFcsYv0nBWvDFC+RxWzIyCImyPuKu4JFzOCvtTCYsdiZGg9DNCsQPuOaAnLUPqeh9lE8CGCuyapZISykXEES9g9D5kWfcws6cVwozCCrjVCLLYHPqNDqIgJtgIcQzlVrRwS2TgvgFjhYNEtBFnH7Gc4t4unA6RDUTzqBEq3lC7wIIbRpgSVn8Ya5dUXRE8rhAg2LWK5NyV1Y+uqGNc1LCB1a963O1sRzGMlUK4fK0RavKilS78n4k6XIbobKdPIJU0eZNFTWTqCl3T6o9LGfnR+ePryHwAYGK4MWlaP47SfDabDoulpqI/Kf3/5tQ12PWMR4lgkSyuXDjvLgx755TcSkTrkcWnOfezVOg+c7MIIbhBLNAjOwzojUyTUIRcQFgpfYdRm3YH1PCMwgWZ/MIyXtgyvQrIQ9qo7iyBfcYRbqtMK2ky1wlXljufN8unZoSm0daIWjuZqrdxgilGplRYbGk+VaSr2iALcoEBPprECDXqFb6U7B2dWZV3J2fUY97j2jNWFDJ3BDfRQ81rknA2o2zHNMnVgeoBHxdKYbUnsFf/8GNjBnudZzBjFcQzNX191qwo1fvaLVuZqqrk3bmg2gNAwq9dLZ9Vm0o31XyRtoIu9WmzB0c9XmGyTyJbYl5V2tVVpwRQknDp59qq3r96/PKCd7pka9ojfQ+CR8u4YMc15LFwWDe7XEnHNJed8qXAkpCWp6i73Bc+WT3avdpdoJU0CAttYTrSVy5SeG189ir63ZmTiPmKNBmkODTpiC6TY9xKWFtqi6Wq6tLyfuelNo0viZIyUYTLXJLBi0tfTNnBtdgiMo7XWP4KfaOmL9BiYgcir1pcgw2/PiJHpFrBRKlHXJ4qum2Z0Bzztw8xIxJ5wkSU/oujH6GAqINU3gtJVWNoDT9eRmGIvZXluuqFVCKWYjwpKbyeQ4T+eRH5PUNko7WHIpMsKrE9haGZ1ILP8yxNjDBD0ESsjQcSE7EOUWAmGCGeHl8+P3t/C3mzdfv5wXzlU2Ho9Xq9XI5OklZsJpM9JmMTZ5Sr9Ed+G7mKCOryk9W1yFLap38JZCC3+t2UB528vgiZEQdvvBQXiqFrtpro0YnHam8PHxHkRGIyJfd1NiT/VuvTOe6NrFieTqMyWqLYWh0kMtti5Lbvojw76CJmLWcVfb3x2yf70eyKay+Ods9gBBBKQ6I0w2oTlaRaPd6r6ZTCJW8tfw9dVk0pBMyvgf8EQBvlaSK19ah+4IBaU22NaPd6w/l/45mdFGLMSh3hFrtrlgbRF/FzwKHfnmWENNFc1aNFSHaIw2oNO0NgYzWBVC9iezTnc7JUItfum1L732pdeGvdZErERXaLp5Vtr60qE7VczG7cHqsjPTjjfDs1YzXu5cTen+0t3daiNZzDaho5p4PN4U2rom3lTauGa8pHTtXQtoO3ReV1H+pFQEq4aZpQ26IHYe3/KyVhmHt/B49zSDf3CHK772kSaV+6LfTt5Ojkol0hMSpw/3EDwMdbmDFZ1YavqjYgPxHxHsb2UW09oIt34ithCeBLlBM60pOX29tPq8dH/m80Qsav/5vquiH/4184VAOPe4vfHdhRvA4Q1tez0Kx9Oj58WJr+Bce2va+hr6RUlGY0MgJqOrYS0/3PuWTHVZ1srjslqEgzLfiVMqa0uvBCxiUqSorDe6fR/oyN6FHfg5aISrEeU4FGIHxwvhijoZpbocp4Gt/5tInYxLLtS4VWHHt9OfPr7/bnr57v727v3T3eXVaDJyr87Hktql5GrHjvAWM3xgWJ56vdls59L/2ENOW58OX924klwo6hifiU0LMM9sADAsYvHRt56983zAiWe22STc4kcjm4aWf63RrFn8/LIl9ziUCUv/Z30xn8zA+WN7hbiA/68no6PJahe5CgmQNX2xiH3G9fEnuealiViBPEPjAx8Ib0N4L2ckbito8JjURB3HNE2xcido9w5shJT99Hr48DQj4GsfskqdEa/hK3of5CsWszmbkwPap95jql/fMMnVouYLog9y6ee/gBeNbg== +api: eJztWN1u4zYWfpUD3iTBKraTzbSzBrZAmqa7aaczQeLpXsQBeiwdWZyhSJWk7BiGgL7Gvt4+yeKQkvwbtBe92p0AQSLy/P98h+RaeJw7MX4St4pK0h6kdh51SuI5EaYii14afZeJsUgtoaeW7q4l+xmtxJkiJxKRkUutrJhBjMXHKkNPDlAp8AXBoqMEkwNChdbLtFZowaWmIjjNjQV6wbJSlEBlTUrO9eYkkCuzBNqz8gyW0hdB/lwuSPdaIEOPg6l+rCiV+SpQ7DOD1GH9F9r16Uda/cL2YUme7GCqRSL6Tw7WWmgsSYzFIaNIhGTvK/SFSISlX2tpKRNjb2vaD9GkIPhMKw7IUfu8gTpEcS+AuWGrJoV0kKKGWdzfD1kQfYoOzMyj1JRBVlup5xuCkFFp9FkCxgLGEE51a0cCrk4LQAcIjuxCskXoPsOpI3o9cCYG9ZOZQUnO4ZzOYghdWlCJYrwWflVx9KT2NCcrEpEbW6KPS19diaZ5jqEj57812Yp59iOZGu1Je97CqlIyDZ4MPzmO7PpQmZl9otRzJi2XtZfkeLcPKn/sZueHxw/vIbKBpcqSI+05frvJ8AYc+a6W2oj857d/u1jXA5EIzDLJQlHdbymPfuya1yRCmRTVoTV3eVDjDQS+PSPQEpRk55SB81amXq1AaiYuCILErsvQgQs9ISmD2erVPHLSPviC7FK6o+o4jjhHT1ms04raTnaAOgvGog98pvZkS+M8GE2DqZ7qdxQjlBrtZEY2kOVGKbPkALcoMGbSSUGWgkK/NJ2Ck4uToOTk8oR7PHjGa9LFTkDLfRQ9NnkgA242ynNKvVzsoRHzdKZbVnsBf/8G1jAVuTFTAWO4hGaqL7vVGdqwesGrU32tuzZtazaC0mFQuZdOLk+SLe3bSt5AkwS32oSRn+o236AIF9SWVHC11mmBmhPOHJh9qp3v9y9POCc7pia9ojfQhCR8u4KMcqyVT6LBvVpmzlFx3jcKl1Iphpre4mDwVIdk92q3qbbCFBGgrfWZMYpQh4kR9Itx0NZsTZwHyskSz6GDTrgG220GiEsL40h3tVy7UE7oe1N40oSZoxRYSo3NHFhytQrNnFtTgmco7XUP4KfaeWb9BkYgcy71hcwo2/HiVfRKRCm1LOtSjC+aZnsGPG3BzXMivPSKJT2S78boQywg0TSR01VGuwhOl6Orw1hMdtpyya0SSzEbMJZcjUbHeTqPwpjkttHGwwKVzBivXsHWypqZovIvhxi7n6D7SAkZeZSqA1F0EAlnlDFePj18fwN/u3rz9fNp4X3lxsPhcrkc2Dw9p0x6YwfGzoc2T/mX6c5CFzPU4YrTs8FV2KB6B28ptPDXmg2ct50MvjIS4m4/OBhP9Xw7zbWVB6eda/j4cAcy4xGRr7opsaN6u94FzkztxzOF+jMnqi2FQ6X7Wlxdlmj7I8OugiYRzqOv3e8O2b9eHsjmsvjnZHIPUQSkJmNMtrE5WkWD7eq+Go0SUeJL/PpqNGpYJmf8D3iigV4qhTqU1r47UkNpLLX1Exzrz6V/TmaMlXO5r3cgmk0uRFvE30WPYke+OdZQ15pnLVmuQ7LWWDBpWltLGSwLqfqTWae7nRKxFr/02pde+9Jrh73WJKIkXxi+eVbGhdLhO9VYDNuD1XlnphuuD89azXCxdTXl+0t3d6utEmOxjh3VjIfDdWGcb8bryljfDBecrp1rAW/HzusqKpyUimjVYWZ5gy+Incc3WNY6Q3gLD7ePE/gHelriKkSaVe6Kfjt6OzoqlUlfkXh9fwfRw1iXW1jRieWmPyo2Ev8RweFW5iitrfSrR2aL4ZkRWrLXNSenr5dWX5AeznyBSCTtP993VfTDvyahEBjnHjY3vtt4A9i/oW2uR/F4evS8OAoVnJtgTVtfh35xksm6GIjR4OKwlu/vQkumpixrHXBZz+NBGbfilKra8SuBSISSKWkXjG7fBzqyd3EHfo4a4WLAOY6F2MHxXPqing1SUw7TyNb/nSkzG5Yo9bBV4YY31z99fP/d9fm7u5vb94+35xeD0cC/+BBLbpcS9ZYd8S3m8IFh8drrzXozl/7HHnLa+vT04oeVQqm5Y0Im1i3APIkDgBGJGB9969k5z0eceBLr9QwdfbSqaXj515rsSoyfnjfkAYcy6fj/rC/mVzNw+tBeIc7g/+vJ6Giy2kXUMQGq5i+RiM+0Ov4k1zw3iSgIM7Ih8JHwJob3fMLiNoIOHpOapOO4TlOq/Cu0Owc2Rsp+et1/eJww8LUPWaXJmNfikt8HcRmNNyHtAU/D2loo1PMa50wbZfLPfwFdRYxy 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update element instance variables

+ Updates all the variables of a particular scope (for example, process instance, flow element instance) with the given variable data. Specify the element instance in the `elementInstanceKey` parameter. -## Request + -

Path Parameters

Body

required
    variables objectrequired
    + -JSON object representing the variables to set in the element’s scope. + { \"foo\" : 2 }\n2 => { \"bar\" : 1 }\n\nAn update request with elementInstanceKey as '2', variables { \"foo\" : 5 }, and local set\nto true leaves scope '1' unchanged and adjusts scope '2' to { \"bar\" : 1, \"foo\" 5 }.\n\nBy default, with local set to false, scope '1' will be { \"foo\": 5 }\nand scope '2' will be { \"bar\" : 1 }.\n", + type: "boolean", + default: false, + }, + operationReference: { + description: + "A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + required: ["variables"], + title: "SetVariableRequest", + }, + }, + }, + }} +> -
    { \"foo\" : 2 }\n2 => { \"bar\" : 1 }\n\nAn update request with elementInstanceKey as '2', variables { \"foo\" : 5 }, and local set\nto true leaves scope '1' unchanged and adjusts scope '2' to { \"bar\" : 1, \"foo\" 5 }.\n\nBy default, with local set to false, scope '1' will be { \"foo\": 5 }\nand scope '2' will be { \"bar\" : 1 }.\n","type":"boolean","default":false}}>= 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
- -The variables were updated. - -
- -The provided data is not valid. - -
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/create-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx index 8ba50e38e63..b213e181a14 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx @@ -5,53 +5,275 @@ description: "Create group" sidebar_label: "Create group" hide_title: true hide_table_of_contents: true -api: eJztWN9v2zYQ/lcIPm2YIjlt2nV689K0y/orSNztIckDRZ4tNhSp8kccwdD/PhwpO05sp33ogAFzgMCyeLq77+77SOsW1LOZo+UlfWtNaOl1Rk0Llnlp9KmgJeUWmIe0mFELXwM4/7sRHS0XlBvtQXu8ZG2rJI/PFV+c0XjP8Roahle+a4GW1FRfgHua0dZiFC/B4apmDaxZOW+lntGMCnDcyhZ90pJOaiBCulaxjuATxEyJr4FomJMZ5pfTvs+ol16hl5jyccz+PGVN+x4NLLjWaJdCPxsd4sdmpOiRzJkjqQKCuMA5ODcNSnU5zX4U+BjoHXTb07iBbolzmceANXtUrp3YE9q4vp7nrRY5Z03QguWslfkNdC7XoanA/rKJQUBrgWN8WnobIPu3UUntYQaWZnRqbMN8uvXy6Fs4P0YE76Bz34c4VW8L4v9K19DiaDR6iqXcBCWINp5Uq4D5lf5gLBABnknlCLNAWmtupQBBpI65LZVAKiO6/ErvJnVrTaWg2UqM9ZzG5CxZDnFJKh9hjiTDKkW/PH9zTH47evHr9U+1960ri2I+n+d2yg9ASG9sbuyssFOO/2j3c04mNVggDesQJRNCYkymyH1jiGuBy6nkxJsIcEibYM0Tvqe7mlY3N6IVBYOVG/vSmHw+PyVSgPZy2kk92wwdn5myoNAHq0zwZaWYvqH33f/W7jcmLjQNsytiPQzQZ9R55sMajB0Sev5s6876x2RyRpILwo0AMjWW+Fq6ZSAE0Ugtm9DQ8mg0ymjD7tK3l6NRjz6x49+BRBO4axXTkVqP4UhNmnveRmBSO880/1GdMVbO5OO4D8+OgcSvE6KlBnecFMOZSBTjN47cMiUFYcHXGDXJBzUZk2DKPXFy7EW2F9n/XmTPN/n+xthKCgE60nOlN+nikceUMnMQe13tdbXX1S5dvdj2A3KsCVbZIg/BWmOJ4TxYC4LMa6mie3zjWcYehLf/objX2l5ru7TWP/adXujSmxpWBnxtcLDSGhd5xXxNS1rEdUcz6sDegsWRzIIGq2hJF0lEfVkUi9o435eL1ljfF7fYoVtmJatU4iUuJ7EtSaQMZ6pOsTabiQvrs5Tj9HpMXpHzk4sJecs8zFkXi4shH7p+NXo12uoVTXd4HJ+dkoQwUXFte1i6RZ1vdZuMv8dx319jIXmw0ncX+FgqTwXMgh0HLPmKIkO86B2/JyOaDRdvlsT58+9J7D1ubef3c7CTO9a0SZhpjrV6tUdCTk2MNNBlM2dsIFiXQI7yw01qnp1GhXHTNEHHbVbPyFz6mrC1GnAVnEfsGVWSA44O7hNamr1PK+SvFJEc5ti/RLLl7jqTvg5Vzk1TDLOS1WelTFU0TOpiCOGK4/GHzx9fjw/enx6ffLw4OTjMR7m/87FOSPCG6fU8HkrhAdBVOzzc+aJVTGqsYExuMajkkg4quc4Gpl/SxaJiDj5b1fd4+2sA29Hy8vpeGPitz2gNTICNsrrBuQ09TifYwQTjorkKGH9jltdnyyfGnEPrn7S9XlP42aeLCdJoGJY2RuAzls1xkMrmtKRX9IpSnLiih8jQeH9BFdOzwGZon/zi3z9Qwn8i +api: eJztWN9v2zYQ/lcIPm2YIjlt2nV689K0y9qmQeJuD2keKPJssaFIlT/iCIb+9+FI2XFiO+1DBwyYAwSWxePdfXffR1m3oJ7NHC2v6FtrQkuvM2pasMxLo08FLSm3wDykxYxa+BrA+d+N6Gi5oNxoD9rjJWtbJXncV3xxRuM9x2toGF75rgVaUlN9Ae5pRluLUbwEh6uaNbBm5byVekYzKsBxK1v0SUs6qYEI6VrFOoI7iJkSXwPRMCczzC+nfZ9RL71CLzHl45j9Rcqa9j0aWHCt0S6FfjY6xI/NSNEjmTNHUgUEcYFzcG4alOpymv0o8DHQO+i2p3ED3RLnMo8Ba/aoXDuxJ7RxfT3PWy1yzpqgBctZK/Mb6FyuQ1OB/WUTg4DWAsf4tPQ2QPZvo5LawwwszejU2Ib5dOvl0bdwnkUE76Bz34c4VW8L4v9K19DiaDR6iqXcBCWINp5Uq4D5Z/3BWCACPJPKEWaBtNbcSgGCSB1zWyqBVEZ0+We9m9StNZWCZisx1nMak/NkOcQlqXyEOZIMqxT96uLNMfnt6MWv1z/V3reuLIr5fJ7bKT8AIb2xubGzwk45/qPdzzmZ1GCBNKxDlEwIiTGZIveNIa4FLqeSE28iwCFtgjVP+J7ualrdPIhWFAxWbpxLY/Lp4pRIAdrLaSf1bDN03DNlQaEPVpngy0oxfUPvu/+t029MXGgaZlfEehigz6jzzIc1GDsk9PzZ1pP1j8nknCQXhBsBZGos8bV0y0AIopFaNqGh5dFolNGG3aVvL0ejHn1ix78DiSZw1yqmI7Uew5GaNPe8jcCkdp5p/qM6Y6ycycdxHz47BhK/ToiWGtzxpBieiUQxfuPILVNSEBZ8jVGTfFCTMQmm3BNPjr3I9iL734vs+Sbf3xhbSSFAR3qu9CZdfOQxpcwcxF5Xe13tdbVLVy+2/YAca4JVtshDsNZYYjgP1oIg81qq6B7feJaxB+HtfyjutbbX2i6t9Y99pxe69KaGlQFfGxystMZFXjFf05IWcd3RjDqwt2BxJLOgwSpa0kUSUV8WxaI2zvflojXW98UtduiWWckqlXiJy0lsSxIpw5mqU6zNZuLC+izlOL0ek1fk4uRyQt4yD3PWxeJiyIeuX41ejbZ6RdMdHsfnpyQhTFRcOx6WblHnW90m4+9x3PfXWEgerPTdJW5L5amAWbDjgCVfUWSIF73j92REs+HizZI4f/49ib3Ho+3ifg52cseaNgkzzbFWr/ZIyKmJkQa6bOaMDQTrEshRfrhJzfPTqDBumiboeMzqGZlLXxO2VgOugvOIPaNKcsDRwX1CS7P3aYX8lSKSwxz7l0i2PF1n0tehyrlpimFWsvqslKmKhkldDCFccTz+8Ons9fjg/enxydnlycFhPsr9nY91QoI3TK/n8VAKD4Cu2uHhzhetYlJjBWNyi0ElV3RQyXU2MP2KLhYVc/DJqr7H218D2I6WV9f3wsBvfUZrYAJslNUNzm3ocXqCHUwwLpqrgPE3Znl9ttwx5hxa/6Tt9ZrCzz9eTpBGw7C0MQL3WDbHQSqb05JSnLbi7sjOeG9BFdOzwGZom3zi3z9nIH4m 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create group

+ - + Create group -## Request + -

Body

+ -The group was created successfully. + -
Schema
Schema
Schema
- -The group could not be created. -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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/create-mapping-rule.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx index 5428314b82a..d0de2f60524 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx @@ -5,53 +5,340 @@ description: "Create a new mapping rule" sidebar_label: "Create mapping rule" hide_title: true hide_table_of_contents: true -api: eJztWV1v2zYU/SsEnzZMkZw27TK9uWm6ZW3SIHG7h8QPFHVtsaFIlaTsCIb++3BJOZZjJ/W6vRRzgMD6uLpf5xySohbUsaml6Q09Z1Ul1JSYWgIdR1RXYJgTWp3lNKXcAHPQ2VyhSURzsNyICm1oSk+8BWFEwZyUPWe3ikbUwNcarHuj84amC8q1cqAcHrKqkoL7SMkXi64W1PICSoZHrqmAplRnX4A7GtHKYF5OgPVuJBPlBSuhZ2qdEWq6kd6oAKJYCURPiCuA+EeJ05hqTNso+PrMZL2jsxmaPulNfVdSXdti2rahZcJAjuCsCl1LtIszjqgTTmKgHkIBkKvQeNq2waettLKhey8Gh/izmVIfPTJnlgT0c2JrzsHaSS1lE2Mq3wsjk/LjhKY3/2uAn8EsoPSGWaDt+HFTOifvodkO3x00D2l3wPURReDWs94pGW/VR3mm8pizslY5i1kl4jtobKzqMgPzy54BPwgDhHIwBUMjOtGmZC5cen20W3oXHu330Njd2BF6tGfHj8KOfzg+oN3RYLDDpMJ1LXOitCPZQxLPTCiV0ZmEcgtx1uMMyWWwJDk4JiQJtCHMkmCYQU6EIjdX707Ib0evfh3/VDhX2TRJ5vN5bCb8AHLhtIm1mSZmwvEf7X6OyagAg1U0mDLLc4ExmSSr3hNbARcTwZEH2N0ubYLdjP0y6Hk2h7ubnHmQZm3EBoWG5NPVGRE5KCcmDXZ4I7R/ZsJqiT5YpmuXZpKpO7rC9VtEHRJblyUzD8xZD9BG1Drm6l4ZTwwtL19sFcEfo9ElCS4I1zmQiTbEFcIuA2ERpVCirEuaHg0GES3ZfTh7PRi06BMR36ESReC+kkx5aj0uRyhSagMdf3xhQlnHFP+vkNFGTMXjuOuC70j8NlS01NXL7brqVtbIOb5cgm8s4HJQAvL4Vp2virOEGZ/ATORBFs67C3Immc6bQNq9KPei3ItyuyiP/r0o9wrbK2yvsCcU9mrbcnKoCHbZIA/BGG2I5rw2BnIyL4T07nGfYhm7U+N+Nttrba+1p7TWRrQEV2jc7a209dRhrqApTbqZ6wBnLksjasHMwFj/fl4bSVO6CHJp0yRZFNq6Nl1U2rg2mSEWM2YEy2RgIN4OslrSRWrOZBFCbsKGN/qvyCdhU4Eck6vT6xH5nTmYs8a3EUOuuz4eHA+2ekXTJzwOL89IqDCQrjcQLN2iore6Dca7OG7xvd0Cr41wzTU+FtqTATNghjV2/oEMXTzvHc+DEY26g3dLivz518ijjIPY1WrH/fSelVWQYG/DZEWx/s7H6qpas/IsnWifVMehzfIQazA29GMQH27y9fLMy47rsqyVH3vVlMyFKwjrtYvL2jpsU0Sl4IC7C+limdDS7EO4Qz6HiOQwRqgDH5dD7lS4os5irsuk24x6+M2kzpKSCZV0IWxyMjz/dPF2ePDh7OT04vr04DAexO7e+ZaiJEqm+nmEhV1/Wfe43t6Hjm98H+mAdnDvkkoyobDhvpZFJ8Mbui7DcdRJ6YYuFhmz8MnItsXLX2swDU1vxivl4Vkb0QJYDsbr9g53h+hJSO9ghOHRPHBgYzO/jZZPDDmHyj1rO+6NJJcfr0fI0+67T6lzfMawOX4TYnOa0lt6Syl+bkIPXgL++oJKpqY1m6J98It/fwPzizqS +api: eJztWV1v2zYU/SsEnzZMkZw27TK9uWm6ZW3SIHG6h9QPFHVtsaFIlaTsCIb++3BJOZZjJ/W6vRRzgMD6uLxf5xyKohbUsaml6S09Z1Ul1JSYWgIdR1RXYJgTWp3lNKXcAHPQ2VyhSURzsNyICm1oSk+8BWFEwZyUPWefFY2oga81WPdG5w1NF5Rr5UA5PGRVJQX3kZIvFl0tqOUFlAyPXFMBTanOvgB3NKKVwbycAOvdSCbKC1ZCz9Q6I9R0I71RAUSxEoieEFcA8UOJ05hqTNso+PrEZL2jsxmaPulNfVdSXdti2rahZcJAjuCsCl1LtIszjqgTTmKgHkIBkKvQeNq2waettLKhey8Gh/izmVIfPTJnlgT0c2JrzsHaSS1lE2Mq3wsjk/LjhKa3/2uAn8EsoPSGWaDt+HFTOifvodkO3x00D2l3wPURReDWs94pGW/VR3mm8pizslY5i1kl4jtobKzqMgPzy54BPwgDhHIwBUMjOtGmZC5cen20W3oXHu330Njd2BF6tGfHj8KOfzg/oN3RYLDDQ4XrWuZEaUeyhySeeaBURmcSyi3EWY8zJJfBkuTgmJAk0IYwS4JhBjkRitxevTshvx29+nX8U+FcZdMkmc/nsZnwA8iF0ybWZpqYCcd/tPs5JqMCDFbRYMoszwXGZJKsek9sBVxMBEceYHe7tAl2M/bLoOfZHO5ucuZBmrURGxQakpurMyJyUE5MGuzwRmg/ZsJqiT5YpmuXZpKpO7rC9VtEHRJblyUzD8xZD9BG1Drm6l4ZT0wtL19sFcEfo9ElCS4I1zmQiTbEFcIuA2ERpVCirEuaHg0GES3ZfTh7PRi06BMR36ESReC+kkx5aj0uRyhSagMdf3xhQlnHFP+vkNFGTMXjuOuC70j8NlS01NXL7brqVtbIOb5cgm8s4HJQAvL4szpfFWcJMz6BmciDLJx3F+RMMp03gbR7Ue5FuRfldlEe/XtR7hW2V9heYU8o7NW25eRQEeyyQR6CMdoQzXltDORkXgjp3eM+xTJ2p8b902yvtb3WntJaG9ESXKFxt7fS1lOHuYKmNOmeXAf45LI0ohbMDIz17+e1kTSliyCXNk2SRaGta9NFpY1rkxliMWNGsEwGBuLtIKslXaTmTBYh5CZseKP/inwSNhXIMbk6vR6R35mDOWt8GzHkuuvjwfFgq1c0fcLj8PKMhAoD6XoTwdItKnqr22C8i+MW39st8NoI11zjsNCeDJgBM6yx8w9k6OJ573gejGjUHbxbUuTPv0YeZZzErlY77qf3rKyCBHsbJiuK9Xc+VlfVmpVn6UT7pDoObZaHWIOxoR+D+HCTr5dnXnZcl2Wt/NyrpmQuXEFYr11c1tZhmyIqBQfcXUgXy4SWZh/CHfIpRCSHMUId+LiccqfCFXUWc10m3WbUw28mdZaUTKikC2GTk+H5zcXb4cGHs5PTi+vTg8N4ELt751uKkiiZ6ucRFnb9Zd3jensfOr7xfaQD2sG9SyrJhMKG+1oWnQxv6boMx1EnpVu6WGTMwo2RbYuXv9ZgGprejlfKw7M2ogWwHIzX7R3uDtGTkN7BCMOjeeDAxmZ+Gy1HDDmHyj1rO+7NJJcfr0fI0+67T6lzHGPYHL8JsTlNKcVPTTja099fW1DJ1LRmU7QNPvHvbxxHOZY= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create mapping rule

+ - + Create a new mapping rule -## Request + -

Body

+ -The mapping rule was created successfully. + -
Schema
Schema
Schema
- -The mapping rule could not be created. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request to create a mapping rule was denied. -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 request to create a mapping rule was denied. - -
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/create-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx index dddb8e07e68..70e36289d21 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx @@ -5,29 +5,32 @@ description: "Creates and starts an instance of the specified process." sidebar_label: "Create process instance" hide_title: true hide_table_of_contents: true -api: eJztWUtv2zgQ/isETy1WkZ00abPaU17d9aZNg8RtD3EOlDS22FCkSlJ2BMP/fTGkJMuvNujjskiBwpY5nOc3H5nRnFo2MTS6o9daJWAM4dJYJhOg9wFVBWhmuZKDlEY00cAs1HKDRiygKZhE8wLlaETPnJQhTKbEWKYtfm21EjUmNgNiCkj4mENKCq8vHMlhBs0TSWHMJUeVxCpSGsAP74Db3+pLmCRxVx9wm4EmpeFyQrg1pJT8awnkAaqRfMEM0WBLLSElcUXOoRCqIhqMKnUC5mVAVLMXzZxev79qfRqcu6AYmYI2XMlwJEfyM0MbY6WdfKLyQoBzuw60WEsriWGsNNReoB2G5kthR3KWgSRsxrg9W+rhhoBksYA0HEkaUA1fSzD2VKUVjebukWtIaWR1CQFNlLQgLS6xohA8cfXrfTFYnDk1SQY5w2+2KoBGVMVfILE0oErChzGN7jZXLLcC2squ1f+mdqe6hIough/dPUjp4v5pwnQRUHhkmCCDgZxW21DzAC49psxzpqtWJWFbKtIqOG/3X0IV0oBOmSgB9WwToNH+wavDI5TSHCuE7iwWi2CHS4Pzn/FokDr0Ndj7pnOuXdG5vaPXb45R1O+i0f6GtwvnsQZTKGl8Rg/6ffxY7evhNjDPmKm7MkWPfhh8TIgafKtGT5lxVgvQloPvsx3Y8P6jF+vKl/t3JmtbsOu9v9bQncLOMp5kLhelgXSNqZb81mTNtXHtpLGaywlCesOvT03NtjlXF/QnnWoLGXZ94tLCBDQN6FjpnFn/06sD9NKCZNLuSplf7SSrxsamvW0Z6AKTsjR1cTBx3Smf57hVwydCOFvtdjLlhscCDwm3oJWyxCSq2IIOxP53SMcDC5HoKOo7aLr0vLOZmweofku1NhDUeL7Tk/pA5ClIi2em/l61/kJ/YvCuzTLQMAXtzi1HyCMpAVKzjcgw6BcQTkJyhs9iO6O/3BrQUyvjJLt0M5VpmLC8lCkLWcHDB6hMKMs8Bv3HJhWlUGhIMO4GXs/k9ExOz+T0G6v1+vB/RFe7Q3xq9a4cNV1CZZ5GZR6UW6jsmbieieuZuJ5vVb/oVoWyh9/4U3DKU0hJyizDIYVUlkyZ4GmIWTvatu8E50AWtGSCgNZKE5UkpdYufi7akjTTlzoTPo4df1sWWsUC8q0XuxXb5NpLkhQs44J4qBKGgEHBGFKE9t3N2zPy5+HRm/sXmbWFiXq92WwW6nGyBym3SodKT3p6nOB/lHsZkiEWj+SswnIuW6xLsfV8KsGa1+BzzmB1Vuq0g1/96nytmh0uKTXfGMWdkI83gwaRVZPVFdNuz5iVAnWwWJU2igWTD3SJk02j61bqkUanETsGFgE1ltmyE8ZuLlzXjUj7Zzi8Jl4FSVQK9bCNm8YQBpFzyfMyp9Fhvx/QnD36p9f9/gJ1YsWfEIkk8FgIJtnaBM+FwyXJcXLntbnA2lnpr6mM0nzC1+2GKz1bg/jcR1QPb3KwmcKRT6GMgw6zGY1or26nvcZNQwNqQOMp524FpRY0onPfMouo15tnythFNC+Utove9ICuHR+47FurgYxQCROZN7tZOlyQLG+nvmf+KkOOyc3F7ZD8zSzMWOVSiSZXVR/3j/tbtaLoDo0n1wPiI/TA65BBoxa7eqtaL/wUxQs8sQwkpea2usVtPj0xMA36pMTst4Co7Tnt+OyFaFB/edvA5N/PQ1dpJLKb5Yz3wk86d5+K/bWJXvc2sURjO8m/gTFocJjtu87UFqlflwmuelyAgBxWNWDEa5NpGo2ZMBDQMdgk+7T04a7ZdN9Oq4c8B1VaGvVd14yVS1BzDm2kujuxpP1wf7N/rgeOBhKV56V0Z4GckBm3GWGd0iWiNBZLFlDBE8BjLZpTRGTH7Du/QuqbIdkPEXa+N5ojYMJtVsZhovJefR1vP2Oh4l7OuOzVJkzv7OT9x6vzk713g7OLq9uLvf2wH9pHfy3CFs2Z7PrhryTrp/x6zPPlCfj8juU3v2OpW9fCo+0VgnGJZOIQMa/J9Y5ukut9UBPkHZ3PY2bgoxaLBf78tQSc+N/dL3sVnxYBzYCloF3XuTcW9MwXeW+ILrQz/s1xOr5q8TtOkgQK+03Z+84Zcf3hdojsU78/ylWKezSb4bslNqMRHdERdZRRM8Lc/z6ngslJySYo7/Xiv/8AHOQLng== +api: eJztWltv27gS/isEn1ocRXa6bbfHCyyQW8/x9hYk6e5DnAdKGlncUqRKUnEEw//9YEhJliW5m6LNy4ELFLEkcmY4l2+GQ66pZUtDZ7f0UqsYjCFcGstkDPQuoKoAzSxXcp7QGY01MAv1uHkzLKAJmFjzAsfRGT1zowxhMiHGMm3xZ0uVqJTYDIgpIOYph4QUnl64kDcZNE8kgZRLjiSJVaQ0gH+8AG5+Sy9mkkRdesBtBpqUhssl4daQUvKvJZAvUC3kM2aIBltqCQmJKnIOhVAV0WBUqWMwzwOimrnI5vTyw8dWpvm5WxQj96ANVzJcyIX8iyGPVGk3PlZ5IcCJXS+06KmVRJAqDbUUyIch+1LYhVxlIAlbMW7PtnS4ISBZJCAJF5IGVMPXEow9VUlFZ2v3yDUkdGZ1CQGNlbQgLX5iRSF47Ow3+dugcdbUxBnkDH/ZqgA6oyr6G2JLA6okfErp7Hb4hQmx50uh0UMsB4MU75nmKKh72HWKP64/fSR+GrEZs2TFhah1Ynlj1JZAq0+tlG1fExOrAhZyj2a9egbCJ4lzIyYuO8KirjYBtSCZtOjcfYHRF/1XNHuP49Y5wy1HYzWXS7rpRM0VpKABg2RA/4To5iN6JokzZUCiSyKj0oDu6CkCUjBtUQwmBNEQK52Y2m3QhVKtcmIzbkjLO1zID6WxOPf3KeEpCn/Pk8aLaqG5tLAETQOaKp0z61+9fkkDmnPJ8zKns+NNQF0gY8jrMkbqIyZ+z42T0A11RmnGhuS0Qp2xUthgPCjcMv1MZhfSIYR7gnuQNiTzrfzfooAeX41IsJAstaAJtyRjhkQAsgaTXXUwrVlFA8ot5GYsSHYdHgTkMO4/b0tbaiDwYEEiVhiS82WGUsWiTGC2kIQckYSnzgksQUZmXH1+KIu44LZCGDRgiVAxE72A2VJLhVr5aDGIUW+VJlKtApKpFdyD9ioccEKo4TliBreiIowsvN1PHWJd+MUuaHdKV3lNAGBccSvwVS9XuNTAlbzueZOb08O9oUoRaVtgGNgf04OfDM5dRgd14DlRqBupLFFxXGqy4jbj0oOOR9gbnoMqa4+t37XxGAtlIAnJOTcOmzFyaxff8ahIKQFMuizpvtJZyoRB8EnBxtmf+zGzCaitkSXLweBKI2gcKSGt0KZQ0iAKzlMCeWGrwKHFPTccwXNLppmB2OqcpF1VkxofFRQde+9qbARN/QfyjEuSm+e7Gt1JoI3Jdsy5hQ+idJ0mMQisIlNvniVI0DxuidqaYaxkypel3uopFqVxUGAcWvDHAmLXrc/GCqGrOi8zA3Rz14eKel3nbeZ4B9V41tmWK4QnIC1Pq6YaGeafgEC4DLclDaqRdfwepy1k0qtyCMikUByB9Yy5GIhczkmIVUtw5ROGAxkIPf/ZyqpQDZvgUHMcao5DzXGoOQ41x6HmONQcT1Zz7Es6/S7H3tTjkMAj5k5LJ1zI7ysk3kEVjsVxMBT6T99sGZe87sT0JA7JJykqNIThCaAhfGdlrKBBo3TSVD9rCOxl2T18cC6u9hHW/OVFNxyPjh9fIc0TZ9rHDEb9wQNDF3YOcFqN2fCLrzxNmedMVy3Jnbqx6VVV46ajAb1nooT9le3xi19evgp2yrMNrnlcpPn5j0g0T1xfrunKfVM418hE4Y5evf71DQ5t3Ot4IO1m43HGg5zT6IvpdNwRh7UBM226pz/QltsWwrtMMebJNt4dmO3xjRqkRwrVJ8eLVcbjzOmiRoVuD3fb+W209nSQ8L1CjVf4e2P7++v62jeG/MY0sLPL2b+76LfiT4To7XGaxDxIx0PveARCecf64R0v7kWewloDD2ok/6e9d73v5qD/yVq/1ZWRE22VgcZS13X0HSAvpARIzBiQ4aKfuc37GT6LcUR/Prqgx1rG17gduLmXSRizvJQJC1nBwy9QmVCWeQT6X0MoSqDQEOO6G/c6gNMBnA7g9ITWwqL//waufmRf46330UHTO6jM46DMO+UIlB2A6wBcB+A6VFU/qarCsS+/sRV03QSSMMuwRSDdeYLgSYhaezU27wTbKRa0ZIKA1kr7DqFvXXDRmqQ5Cao14dexZ29ZaBUJyEcLu91jgUs/kiRgGRfNmQlDh8GBke9k3V69PSP/fvnq17tnmbWFmU0mq9Uq1Gl8BAm3SodKLyc6jfE/jnsekhs0HslZhebchlgXYuubOzHavHY+JwxaZ/x4ZTci/Nd+h7CDJaXmg0tKJ+Tz1XzsfG3LutuvoSxSpZ1FgskvdOsnQ6Z9LnVLoxOIHQb+jMOW3QbnN7tHfU/7783NJfEkSKwSqDuavqOFjMLumcrL6TSgOXvwT6+n0w3SRIs/YiWSwEMhmGS9u01uOdhhxTtNnppbWHuL7OdYRmm+5H2+Yb/vjy/P/Yrq5k0ONlPY8imUca7DbEZndFKH01EjpqEBNaAxy7mqoNSCzujah8xmNpmsM2XsZrYulLabyf0L2ksf+NmHVuMy7rQk82yHpsMP2FpvlnTmSxnyhlxdXN+Q/zALK1Y5VSLLXdJvpm+mo1Rx6B6KJ5dz4lfoHa8DBg1ZjOpRsn7wYwhvMGMZiEvNbXWN07x6ImAa9EmJ2m8doubnqLtzCzeIBvWPt42b/PHXjbM0AtnV9vbbhe907s+K015Hr1tNbL1x7OR0Onr6eLtz+tbmjbuRcyR33jI8brltJt0Nzy+mLmpS5RTU5KGBqrsdSzoNj4fxczl3MBCrPC+lywVy6bvwrGO6+kgCAULwGDCtzdYUPbLD9r3/QurKkByH6HY+NpoUsOQ2K6MwVvmkLsfbv5FQ0SRnXE5qFmZydvLh88fzk6P387OLj9cXR8fhNLQPvizCEM2Z7MrhS5J+lu+veb3NgIfbp098+7QOXQsPdlIIxiWCifOIdQ2ut3QIrndBDZC3dL2OmIHPWmw2+PprCdjxv73bxio+bQKaAUtAu6hzJxb0zBv56AZFaHv8w3Y6XifxM07iGAr7zbF3nRxx+en6BtGnvlmbqwTnaLbCW7dsRWfUwUV7F8G9W1PB5LJkSxzraeK//wGQYjiv 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create process instance

+ - + Creates and starts an instance of the specified process. The process definition to use to create the instance can be specified either using its unique key @@ -36,52 +39,395 @@ The process definition to use to create the instance can be specified either usi Waits for the completion of the process instance before returning a result when awaitCompletion is enabled. -## Request + -

Body

required
    oneOf
    variables object
    + -JSON object that will instantiate the variables for the root variable scope -of the process instance. +0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + startInstructions: { + description: + "List of start instructions. By default, the process instance will start at\nthe start event. If provided, the process instance will apply start instructions\nafter it has been created.\n", + type: "array", + items: { + type: "object", + properties: { + elementId: { + description: + 'Future extensions might include:\n - different types of start instructions\n - ability to set local variables for different flow scopes\n\nFor now, however, the start instruction is implicitly a "startBeforeElement" instruction\n', + type: "string", + }, + }, + title: "ProcessInstanceCreationStartInstruction", + }, + }, + awaitCompletion: { + description: + "Wait for the process instance to complete. If the process instance completion does\nnot occur within the requestTimeout, the request will be closed. Disabled by default.\n", + type: "boolean", + default: false, + }, + fetchVariables: { + description: + "List of variables names to be included in the response.\nIf empty, all visible variables in the root scope will be returned.\n", + type: "array", + items: { type: "string" }, + }, + requestTimeout: { + description: + "Timeout (in ms) the request waits for the process to complete. By default or\nwhen set to 0, the generic request timeout configured in the cluster is applied.\n", + type: "integer", + format: "int64", + }, + }, + title: "CreateProcessInstanceRequestBase", + }, + ], + properties: { + processDefinitionKey: { + description: + "The unique key identifying the process definition, e.g. returned for a process in the\ndeploy resources endpoint. Cannot be used together with processDefinitionId.\n", + type: "integer", + format: "int64", + }, + }, + title: "CreateProcessInstanceRequestByKey", + }, + { + type: "object", + allOf: [ + { + type: "object", + properties: { + variables: { + description: + "JSON object that will instantiate the variables for the root variable scope\nof the process instance.\n", + type: "object", + additionalProperties: true, + }, + tenantId: { + description: "The tenant ID of the process definition.", + type: "string", + }, + operationReference: { + description: + "A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be >0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + startInstructions: { + description: + "List of start instructions. By default, the process instance will start at\nthe start event. If provided, the process instance will apply start instructions\nafter it has been created.\n", + type: "array", + items: { + type: "object", + properties: { + elementId: { + description: + 'Future extensions might include:\n - different types of start instructions\n - ability to set local variables for different flow scopes\n\nFor now, however, the start instruction is implicitly a "startBeforeElement" instruction\n', + type: "string", + }, + }, + title: "ProcessInstanceCreationStartInstruction", + }, + }, + awaitCompletion: { + description: + "Wait for the process instance to complete. If the process instance completion does\nnot occur within the requestTimeout, the request will be closed. Disabled by default.\n", + type: "boolean", + default: false, + }, + fetchVariables: { + description: + "List of variables names to be included in the response.\nIf empty, all visible variables in the root scope will be returned.\n", + type: "array", + items: { type: "string" }, + }, + requestTimeout: { + description: + "Timeout (in ms) the request waits for the process to complete. By default or\nwhen set to 0, the generic request timeout configured in the cluster is applied.\n", + type: "integer", + format: "int64", + }, + }, + title: "CreateProcessInstanceRequestBase", + }, + ], + properties: { + processDefinitionId: { + description: + "The BPMN process ID of the process definition to start an instance of.\nCannot be used together with processDefinitionKey.\n", + type: "string", + }, + processDefinitionVersion: { + description: + "The version of the process. Only considered when a processDefinitionId is provided.\nBy default, the latest version of the process is used.\n", + type: "integer", + format: "int32", + default: -1, + }, + }, + title: "CreateProcessInstanceRequestById", + }, + ], + title: "CreateProcessInstanceRequest", + }, + examples: { + "By process definition key": { + summary: "Create a process instance by processDefinitionKey.", + value: { processDefinitionKey: 12345, variables: {} }, + }, + "By process definition ID": { + summary: + "Create a process instance by processDefinitionId and version.", + value: { + processDefinitionId: "1234-5678", + version: 1, + variables: {}, + }, + }, + }, + }, + }, + }} +> -
    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be >0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
    startInstructions object[]
    - -List of start instructions. By default, the process instance will start at -the start event. If provided, the process instance will apply start instructions -after it has been created. - -
  • Array [
  • ]
  • variables object
    - -JSON object that will instantiate the variables for the root variable scope -of the process instance. - -
    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be >0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
    startInstructions object[]
    - -List of start instructions. By default, the process instance will start at -the start event. If provided, the process instance will apply start instructions -after it has been created. - -
  • Array [
  • ]
- -The process instance was created. - -
Schema
    variables object
    - -All the variables visible in the root scope. - -
Schema
    variables object
    - -All the variables visible in the root scope. - -
Schema
    variables object
    - -All the variables visible in the root scope. - -
- -The provided data is not valid. - -
- -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/create-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx index 8a4c2acaf12..09292cbab40 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx @@ -5,53 +5,275 @@ description: "Create a new role." sidebar_label: "Create role" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7OLVTmpQTJ015Ux2ndZM4HltpD7YPILASEYMAA4CWORr+984S1EciyckhnelBmtGIJJa7+3bfA8VdsMBnnuU37MpqZHcJszU6HpQ155LlTDjkAfu1hEn0wqmaFlnOTvsl4GBwDs5qTG8NS5jDzw368LuVLcsXTFgT0AQ65HWtleh9Z588+VgwL0qsOB2FtkaWM1t8QhFYwmpHmQSFnlYNr3DDygenzGwrpUmJIJWvNW+B7gA7hVDiOkPWdQkLKmhyQqgiiKuYM+s6Wnfoa2t8DPxsdEw/23HIH8y5h1giCb4RAr2fNlq3sRQ/CDtFeovt7jTusV2iXCYSkSZf1Wof8oi1X95M8sHIVPCqMZKnvFbpPbY+NU1VoPtlG4DE2qGg6CwPrsHkv4WkTMAZOpawqXUVD/HSy5NvgLzo03+Lrf8+uLFyO+D+L/pFBiej0RPsFLbREowNUKyipbfmvXUIEgNX2gN3CLWzD0qiBGX6xJYCgMLKp6lcO1torHYyYjOlMVxGyyEuxNIB9xANixj95urNKfx28uLXu5/KEGqfZ9l8Pk/dVByhVMG61LpZ5qaCvmT3cwqTEh1CxVtCyaVUFJNrWDcFfI1CTZWAYHuAQ9pAFY/4nu5oXN3efVbsa5za2ozG8PHqHJREE9S0VWa2Hbq/Z8obTT54YZuQF5qbe7bu/be2vDH4pqq4W7HqywBdwnzgodmAsUc9z5/t3E7/nEwuIboAYSXC1DoIpfLLQASiUkZVTcXyk9EoYRV/jGcvR6OOfFLHvwOJAXysNTc9tb6GowxUa972wJTxgRvxozpjnZqpr+N++cQYSPw6IlpKcN8DIj5UQHNx7+GBayWBN6GkqFE+pMk+Ca59ehDZQWQHke0V2fNtvr+xrlBSounpudKb8v0jj2tt5ygPujro6qCrfbp6sev/49gAVdkRD9E568AK0TiHEual0r17etNZxh6Ed/ijeNDaQWv7tNYlrMJQWhqq1Nb31OGhZDnL6F3Ns4R5dA/oaBizYI3TLGeLKJMuz7JFaX3o8kVtXeiyB+rBA3eKFzoyj5ajnJY00VZwXcZQ2+2ihc0RyWl8+YVXcHV2PYE/eMA5b/vyUcgvXb8avRrt9EqmezyOL88hIoxk29gAlm5JyTvdRuPvcdx1d1RI0TgV2mu6LZanQO7QjRuq+IoEQ7zeO51HI5YMB2+W1Pjrn0nfXdq8rtbjrbNHXtVRenE8tXp1J8pNbR9pIMR2ztRAdD6CHKXH2+S7PO81JGxVNabfSM0M5iqUwDdqIHTjA2FPmFYCaTawTmhp9i6uwN8xIhyn1L9IsuX+OVOhbIpU2CobJiGr30LbIqu4MtkQwmen4/cfL16Pj96dn55dXJ8dHaejNDyGvk7E74qbzTzirNDtmCNujAj3jRSHdgV8DFmtuTJU4T75xSCiGxZFdJcMQrhhi0XBPX50uuvo8ucGXcvym7u1buisS1iJXKLrVXdPUxt2GvM5mlBYMtcNhd8a4XXJ8o6xEFiHJ23vNvR/+eF6QiwbRqSVlXSP43Man/I5y9ktu2WMZrHkIQ6V6PqCaW5mDZ+RffRLn38BHrSEoA== +api: eJztWE1z2zYQ/Ss7OLVTmpQTJ015Ux2ndfPlseX24PgAAisRMQgwAGiZo+F/7yxBfSSSHB/SmR7kGY9IYbG7b/c9UNwFC3zmWX7DLq1GdpswW6PjQVlzLlnOhEMesF9LmEQvnKppkeXstF8CDgbn4KzG9JNhCXP4pUEffreyZfmCCWsCmkCXvK61Er3v7LMnHwvmRYkVp6vQ1shyZovPKAJLWO0ok6DQ06rhFW5Y+eCUmW2lNCkRpPK15i3QDrBTCCWuM2Rdl7CggiYnhCqCuIw5s66jdYe+tsbHwM9Gx/SxHYf8wZx7iCWS4Bsh0Ptpo3UbS/GDsFOkt9juTuMO2yXKZSIRafJNrfYhj1j75c0k741MBa8aI3nKa5XeYetT01QFul+2AUisHQqKzvLgGkz+W0jKBJyhYwmbWlfxEL96efIdkB/69N9i658GN1ZuB9z/Rb/I4GQ0eoSdwjZagrEBilW09JN5bx2CxMCV9sAdQu3svZIoQZk+saUAoLDycSrXzhYaq52M2ExpDBfRcogLsXTAPUTDIka/uXxzCr+dvPj19qcyhNrnWTafz1M3FUcoVbAutW6Wuamgf7L7OYVJiQ6h4i2h5FIqisk1rJsCvkahpkpAsD3AIW2gikd8j3c0rm6fPiv2NU5tHUZjuL48ByXRBDVtlZlth+73THmjyQcvbBPyQnNzx9a9/96RNwbfVBV3K1Z9HaBLmA88NBsw9qjn+bOdx+mfk8kFRBcgrESYWgehVH4ZiEBUyqiqqVh+MholrOIP8e7laNSRT+r4E5AYwIdac9NT61s4ykC15m0PTBkfuBE/qjPWqZn6Nu7XT4yBxK8joqUE9z0g4kMFNBd3Hu65VhJ4E0qKGuVDmuyT4NqnB5EdRHYQ2V6RPd/m+xvrCiUlmp6eK70p3z/yuNZ2jvKgq4OuDrrap6sXu34/jg1QlR3xEJ2zDqwQjXMoYV4q3bunN51l7EF4hx+KB60dtLZPa13CKgylpaFKbX1PHR5KlrOM3tU8S5hHd4+OhjEL1jjNcraIMunyLFuU1ocuX9TWhS67px7cc6d4oSPzaDnKaUkTbQXXZQy13S5a2ByRnMaXX3gFl2dXE/iDB5zzti8fhfza9avRq9FOr2S6x+P44hwiwki2jQNg6ZaUvNNtNH6K4667pUKKxqnQXtG2WJ4CuUM3bqjiKxIM8XrvdB+NWDJcvFlS469/Jn136fC6XI+3zh54VUfpxfHU6tWdKDe1faSBENs5UwPR+QhylB5vk+/ivNeQsFXVmP4gNTOYq1AC36iB0I0PhD1hWgmk2cA6oaXZu7gCf8eIcJxS/yLJlufnTIWyKVJhq2yYhKw+C22LrOLKZEMIn52O319/eD0+end+evbh6uzoOB2l4SH0dSJ+V9xs5hFnhW7HHHFjRLhvpDi0K+BDyGrNlaEK98kvBhHdsCii22QQwg1bLAru8drprqOvvzToWpbf3K51Q3ddwkrkEl2vujua2rDTmM/RhMKSuW4o/NYIr0uWO8ZCYB0etb3d0P/Fx6sJsWwYkVZW0h7H5zQ+5XOWM0ZzWNodB0r03YJpbmYNn5Ft9El//wIfGoOk 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create role

+ - + Create a new role. -## Request + -

Body

+ -The role was created successfully. + -
Schema
Schema
Schema
- -The role could not be created. -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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/create-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx index 77b0e5d1a19..f204f2566d9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx @@ -5,52 +5,277 @@ description: "Creates a new tenant." sidebar_label: "Create tenant" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/Ss7OLVTmpQTJ015Ux2ndZO6HltpD44PILgSEZMAgw/LGg3/e2cBUpZDOfYh0+lBmtGIJJb78fY9iNw1c3xhWX7FZqi4cuw6YbpFw53U6rRkORMGucN+NWElWmFkS8ssZ8dh0QIHhUtwwShlCTP4xaN1v+pyxfI1E1o5VI4OedvWUgT32WdLTtbMigobTkdu1SLLmS4+o6BoraFknEQbVoN/ympjaZ2RajHKa1YheCW/eAS8c2gUr/vs4PQt6xKmeIPPc0OWoOfgKtwU2HWxRGmwJOw2iV0nzElXk8uIWAToIsLBuoc3OuMxXLCtVjbW+GJySD/jPPr0l9xCbEkJ1guB1s59Xa8I9e8K83tc7U5kA+gNrgZghozcQJOHuFLZu3GJlQeD7ZRvVZkK3nhV8pS3Mr3BlU2Vbwo0P43LKbE1KCiBiGny3xUolcMFGpawuTYNd/HS66MnSz4LxbzHlX1e8RHJHcX/D3tJJkeTye6QrdG3ssQSSu44SAtKO7jltSy/QeHW6KLGZmfvtwNM4TxaQomOyxoiLMAtRMMCS5AKri7eHcMvR69+vv6hcq61eZYtl8vUzMUBltJpk2qzyMxc0JfsfkxhVqFBaPgKCgRelpJi8hruAQfbopBzKcDpAGWfNhCC6SfFniRmWB3vShtueSNHm9QUPl6cgixROTlfSbUYhw73zLmvyQcvtHd5UXN1w+57+dRWOAXrm4abDU0eBugSZh13fquMR7Tx8sXObfb32ewcogsQukSYawOuknYIREU0UsnGNyw/mkwS1vC7ePZ6MunIJ3X8GZUowLu25ipQ6+typIJGG+z5EwqTyjquxPfqjDZyIb+Omz7QVU/it7GiQVAvx3x/p00hyxJVoCf0f7uDqnhd6yXudbXX1V5X39DV0ZjvZ9rBXHtVDrqy2huB4elLbdb2utrraq+rR3T1atcD4FQBoRweOdEYbUAL4Y3BEpaVrIN7eqUZYvd/aJGLe63ttbbX2lhrXcIadJWmaU2rbaAOdxXLWRbf4SxLmEVzi4YmPWvmTc1yto5C6fIsW1faui5ft9q4LrulLtxyI3lRR+7RchTUQJRaC15XMdi4YbSwPTc5jm+z8AYuTi5n8Bt3uOSrACCFfOj6zeTNZKdXMn3E4/T8FGKFkW5bW8DglrS80200fo7jrrsmIIU30q0u6bYIT4HcoJl6wnxDgz5e8E7n0Ygl/cG7gRx//DML/aXt6+J+bHZyx5u2F99m7HXPrTi/2ryTExHnOhj3NBnXQU1FY2Phk/RwTMnz06AsoZvGq7C9qgUspauAb+Eiam8d4ZGwWgqkV/58PSQ0mH2IK/B3jAiHKfU0Em/YVRfSVb5IhW6yftyx+S1qXWQNlyrrQ9jsePrnx7O304MPp8cnZ5cnB4fpJHV3LmBHrG+42s4jzCTuZxgPKt0aSD46wey76PDOZW3NpSKQQ/7rXl3D2M/S1C8q5Iqt1wW3+NHUXUeXv3g0K5ZfXd8Lis66hFXISzRBjjc0nWHHMaWDGQUm89pTAqNBXpcMd0yFwNZ90/Z6a2s4/+tyRvTrZ7KNLukew5c0r+VLlrNP7BNjNP8lD4HZ4fqa1VwtPF+QffRLn38Bv8qvaw== +api: eJztWE1z2zYQ/Ss7OLVTmpQTJ3V5Ux2ndZO4HltpD64PILgSEYMAA4CWNRr+984CpCyHcuJDptODPOMRRSz24+17ELlr5vnCsfyazVBz7dlNwkyDlntp9FnJciYsco/9asJKdMLKhpZZzk7CogMOGpfgg1HKEmbxc4vO/2rKFcvXTBjtUXu65E2jpAjus0+OnKyZExXWnK78qkGWM1N8QkHRGkvJeIkurAb/lNXG0nkr9WKU16xCaLX83CLgvUerueqzg7M3rEuY5jU+zw1ZgpmDr3BTYNfFEqXFkrDbJHaTMC+9IpcRsQjQZYSDdY83ettiuOEao12s8cXkkD7GefTpL7mD2JISXCsEOjdvlVoR6t8V5ne42p3IBtBbXA3ADBn5gSaPcaWyd+MSKw8G2ynf6TIVvG51yVPeyPQWVy7VbV2g/WlcTomNRUEJREyT/65AqT0u0LKEzY2tuY+3Xh99s+TzUMw7XLnnFR+R3FH8/7CXZHI0mewO2VhzJ0ssoeSeg3SgjYc7rmT5FQo31hQK65293w4whYtoCSV6LhVEWIA7iIYFliA1XF++PYFfjl79fPND5X3j8ixbLpepnYsDLKU3NjV2kdm5oH+y+zGFWYUWoeYrKBB4WUqKyRU8AA6uQSHnUoA3Aco+bSAE0380+yYxw+r4VNpwq7VydEhN4ePlGcgStZfzldSLceiwZ85bRT54YVqfF4rrW/bQy28dhVNwbV1zu6HJ4wBdwpznvt0q4wltvHyx85j9fTa7gOgChCkR5saCr6QbAlERtdSybmuWH00mCav5ffz2ejLpyCd1/BmVaMD7RnEdqPVlOVJDbSz2/AmFSe081+J7dcZYuZBfxk0f6aon8ZtY0SCol2O+vzW2kGWJOtAT+p/dQVVcKbPEva72utrr6iu6Ohrz/dx4mJtWl4OunGmtwPD0pTdre13tdbXX1RO6erXrAXCqgVAOj5xorbFghGitxRKWlVTBPb3SDLH7H7TIxb3W9lrba22stS5hNfrK0LSmMS5Qh/uK5SyL73COJcyhvUNLk541a61iOVtHoXR5lq0r43yXrxtjfZfdURfuuJW8UJF7tBwFNRBFGcFVFYONG0YL23OTk/g2C8dweXo1g9+4xyVfBQAp5GPXx5PjyU6vZPqEx+nFGcQKI922joDBLWl5p9to/BzHXXdDQIrWSr+6om0RngK5RTttCfMNDfp4wTt9j0Ys6S/eDuT44+9Z6C8dX5cPY7PTe143vfg2Y68HbsX51eadnIg4N8G4p8m4DmoqWhcLn6SHY0penAVlCVPXrQ7Hq17AUvoK+BYuQrXOEx4JU1IgvfLn6yGhwex9XIG/YkQ4TKmnkXjDqbqQvmqLVJg668cdm89CmSKrudRZH8JlJ9MPH8/fTA/en52cnl+dHhymk9Tf+4Adsb7mejuPMJN4mGE8qnRrIPnkBLPvosd7nzWKS00gh/zXvbqGsZ+jqV9UyDVbrwvu8KNVXUe3P7doVyy/vnkQFH3rElYhL9EGOd7SdIadxJQOZhSYzFVLCYwGeV0y7JgKgY3/qu3N1tFw8efVjOjXz2RrU9Iey5c0r+VLljNGs1/aHVgd7q2Z4nrR8gXZRp/09y8VBK5v 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create tenant

+ - + Creates a new tenant. -## Request + -

Body

required
+ -The tenant was created successfully. + -
Schema
Schema
Schema
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The resource was not found. - -
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/create-user.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx index ea02fb106fd..3ffb793ae6f 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx @@ -5,57 +5,323 @@ description: "Create a new user." sidebar_label: "Create user" hide_title: true hide_table_of_contents: true -api: eJztWU1z2zYQ/SsYnNopTcmJkya8qY7Tuklcjy23B9uHJbgSEYMAA4CSNRr+984CpCVbkp1DOtODPKMxiV3u53ugtFhyD1PHs2t+5dDy24SbGi14afRpwTMuLILHIEt4gU5YWZOQZ/w4iBgwjXPWOLQpT7jFbw06/5spFjxbcmG0R+3pEupaSREsD746srDkTpRYAV35RY084yb/isLzhNeW4vASHUlrcG5ubEHXj4MYl8h6KTMT5kt8iKWz6byVesrbhJNAQ4XbzfTSF83sNvFdj2MFUm1/PoheMNAm3EuvaInachELzlsSUPWlxYJn3jYYFlxttItVfDU83J05m4NjsdsFc40Q6NykUWqR3mie/KhGkqdPuNgexh0u+tz7QJoIvOdLEIF40aUaxOsxznSRCqgaXUAKtUzvcOFS3VQ52l824y+wtijIeSxi8p9mJLXHaViYGFuBj0tvj17I8SxE/wkX7vuyjYXbku3/oVukcDQcbnq50pArZN50DlasuNFfjEVWoAepHAOLrLZmJgssmNRBr0c+y03xPIZra3KF1VYsrIczYudRs/PLYtUYOBYV8+j9+uLjMXt/9ObX259K72uXDQbz+Ty1E3GAhfTGpsZOB3Yi6EN6P6dsXKJFVsGC5cigKCT5BMVW/WCuRiEnUlA9KMEubEbVjvk938woXT7pzhrwGis39vgRu7o4ZbJA7eVkIfV003V4ZgKNIhuQm8ZnuQJ9x1d933T61ItrqgrsA6AeO2gT7jz4Zi2NHcR5/WrDNkH1j/H4nEUTTJgC2cRY5kvpekeURCW1rJqKZ0fDYcIruI93b4fDlmz6btN+IRPN8L5WoAO0nqYjNatWuA2JSe08aPGjOmOsnMqnftNHHOxA/CFm1NNvx5uhe50zBeLOsRkoWTBofEleI32ImyEIUC7dk2xPsj3JdpLs9SbePxqby6JAHeD5wDfpmDaegVJmjsWeV3te7Xm1m1fvt+E9/qiRvgzWpnKGevUTD5RFKBYM76Xzbv/1cM+wPcN2M+zNtl9nI82oypZwiNYay4wQjbVYsHkpVTBPQ4Ted/dq23Ntz7U913ZxrU14hb40NHqtjQvQAV/yjA/o3eV4wh3aGV1l10veWMUzvow0abPBYFka59tsWRvr28GMejADK2mOElpG4kinHibKCFBldLXZLhKsDzWP42SJvWMXJ5dj9jt4nMMilI9cPjb9bvhuuNUqqe6wODo/ZTHDCLa1DaA3S0zeajYqf4/htr2lQorGSr+4pMdieXIEi3bUUMUfQND5C9bpPirxpLv42EPjz3/Gobu0eV2sxuAn91DVkXqrMfYKWauZ9Grt6X03MV6bIUs9MSHEDkmbyVLn0bpYnWF6uIna89NAPmGqqtFhB9bT+IUJ1oonVON8HEQrKZBGdtmyj7BX+xwl7O/okR2m1PiIzn7jnUpfNnkqTDXo5pMP/3Nl8kEFUg86F25wPPpydfZhdPD59Pjk7PLk4DAdpv7ehwITMSrQ63HE+WCz5Zhi7Qxi+4lF12WP935QK5A6nBRYFRtGSLjmkXu3Scefa75c5uDwyqq2peVvDdoFz65vV3SjuzbhJUKBNpD1jiap/DhGczAmt6SuGnK/MVRvk/6JkRBY+2d1b9e2jfO/LscEzu4EpjIFPWNhTqczMOcZv+E3nNNBD1kIuA/rS65ATxuYkn60S3//AjDTB7w= +api: eJztWUtz2zYQ/isYnNopTcmJkya8qY7dunnUY8vtwfFhCa5ExCDAAKBkjYb/vbMAacmWZPuQzvQgzWhEYoF9fh8oLpbcw9Tx7JpfObT8JuGmRgteGn1W8IwLi+AxyBJeoBNW1iTkGT8OIgZM45w1Dm3KE27xe4PO/2aKBc+WXBjtUXu6hLpWUgTNg2+ONCy5EyVWQFd+USPPuMm/ofA84bUlP7xER9IanJsbW9D1QyfGJbJeysyE+RLvfel0Om+lnvI24STQUOF2Nb30WTW7VbxoOVYg1fb1QfSMgjbhXnpFQ1SWi5hw3pKAsi8tFjzztsEw4GqjXcziq+Hh7sjZHByL1S6Ya4RA5yaNUov0q+bJjyokWfqIi+1u3OKij713pInAezoFEYgXXahBvO7jTBepgKrRBaRQy/QWFy7VTZWj/WXT/wJri4KMxyQm/2lEUnuchoGJsRX4OPT26JkYvwTvP+LCvSzamLgt0f4fqkUTjobDTStXGnKFzJvOwIoVX/VnY5EV6EEqx8Aiq62ZyQILJnWY1yOf5aZ4GsO1NbnCaisW1t0ZsfM4s7PLYtYYOBYn5tH69cXpMXt/9ObXm59K72uXDQbz+Ty1E3GAhfTGpsZOB3Yi6Evzfk7ZuESLrIIFy5FBUUiyCYqt6sFcjUJOpKB8UICd24yyHeN7uphRunxUnTXgNVZu7PEjdnVxxmSB2svJQurppumwZgKNIh2Qm8ZnuQJ9y1d13zT62IprqgrsPaAeGmgT7jz4Zi2MHcR5/WpDN0H1j/H4nEUVTJgC2cRY5kvpekMURCW1rJqKZ0fDYcIruIt3b4fDlnT6btN+JhLN8K5WoAO0HocjNatWuA2BSe08aPGjKmOsnMrHdtMHHOxA/CFG1NNvx5Ohe5wzBeLWsRkoWTBofElWI32Im8EJUC7dk2xPsj3JdpLs9SbeT43NZVGgDvC855t0TBvPQCkzx2LPqz2v9rzazav32/AeX2qkL4O2qZyhXr3igbIIxYLhnXTe7f8e7hm2Z9huhr3Z9nY20oyybAmHaK2xzAjRWIsFm5dSBfXUROhtd4+2Pdf2XNtzbRfX2oRX6EtDrdfauAAd8CXP+ICeXY4n3KGd0VV2veSNVTzjy0iTNhsMlqVxvs2WtbG+HcyoBjOwkvoooWQkjnTqYaKMAFVGU5vlIsF6U/M4dpbYO3Zxcjlmv4PHOSxC+sjkQ9Xvhu+GW7XS1B0aR+dnLEYYwba2AfRqiclb1cbJL1HctjeUSNFY6ReXtCymJ0ewaEcNZfweBJ29oJ3u4ySedBenPTT+/Gccqkub18WqDX5yB1UdqbdqY6+QtepJr8Ye33cd47UestQTE1zskLQZLFUerYvZGaaHm6g9PwvkE6aqGh12YD2Nf5hgLXlCNc7HRrSSAqllly17D/tpn6KE/R0tssOUCh/R2W+8U+nLJk+FqQZdf/L+N1cmH1Qg9aAz4QbHo89XXz6MDj6dHZ98uTw5OEyHqb/zIcFEjAr0uh+xP9hsOaZYO4PYfmLRVdnjnR/UCqQOJwVWxYIREq555N5N0vHnmi+XOTi8sqptafh7g3bBs+ubFd3ork14iVCgDWS9pU4qP47eHIzJLE1XDZnfaKq3Sb9iJATW/sm5N2vbxvlfl2MCZ3cCU5mC1liY0+kMzHnGOR3y0OqA+TC25Ar0tIEpzY066fMvJOcGwA== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Create user

+ - + Create a new user. -## Request + -

Body

required
+ -The user was created successfully. + -
Schema
Schema
Schema
- -Unable to create the user. -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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -A user with the given username already exists. - -
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/delete-document.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-document.api.mdx index 6d0c334ab44..027b7168162 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-document.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-document.api.mdx @@ -12,24 +12,24 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete document (alpha)

+ Delete a document from the Camunda 8 cluster. @@ -41,18 +41,120 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature in future releases. ::: -## Request + -

Path Parameters

Query Parameters

+ -The document was deleted successfully. + -
- -The document with the given ID was not found. - -
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/delete-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-group.api.mdx index ba907e25239..a4c2d46bc95 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-group.api.mdx @@ -12,41 +12,176 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete group

+ - + Deletes the group with the given key. -## Request + -

Path Parameters

+ -The group was deleted successfully. + -
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The group with the groupKey was not found. - -
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/delete-mapping-rule.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-mapping-rule.api.mdx index 37eb4e5c5fc..a49b4fd7bdd 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-mapping-rule.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-mapping-rule.api.mdx @@ -12,44 +12,176 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete a mapping rule

+ Deletes the mapping rule with the given key. -## Request + -

Path Parameters

+ -The mapping rule was deleted successfully. + -
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The mapping rule with the mappingKey was not found. - -
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/delete-resource.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx index 41f29794c3f..3dfa2346e65 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx @@ -5,53 +5,209 @@ description: "Deletes a deployed resource." sidebar_label: "Delete resource" hide_title: true hide_table_of_contents: true -api: eJztWN9v2zYQ/leIe2oxRXK6rOv0MMBL0y1b2wWOuz0kAUpLJ4stRaokFUcw9L8PR0ryz6B92MuwBDBiicc73nffdya5BseXFtIbmKHVjckQ7iLQNRruhFaXOaSQo0SH43gEOdrMiJoMIIXXftgyznKspW4xZ6a3jW/VvBSWZVyxBTLOaqMztJblWAglyEHEcsyEFVoxg18aYbBC5XYttGGFNtXWu1s1xmqsUEvmSuzDj8EtQ5XXWigXs+saM1G03mwYZ61u2Iorx5xmIUcmlDf5ONj8ge1HVnPDK3Ro4lsFEYyPBNsaFK8QUtiaAREIAqbmroQI+rRySJ1pcB+9eYnsM7ZMF7uLG9e0h6Hb2B+Hc8fgKLYE3mBP2O7MOAAaIrBZiRWHdA2urSlZoRwu0UAEZM5dePXyDLruLiSM1v2i85bmbPIvuLQYQaaVQ+VojNe1FJmnWvLJEiDrw2h68QkzBxGoRkq+kDggWRsiqhNoyXok7QwLNKgypLe7aE+ZGQZ9ylmpLSq2CMxoLBIa3LGVkJLQrrlxHhcpmcFMm9xSiRrpiHSF0RVzVJwxdnyr3jXW0dyf2YSJgmp0L3LMA3m+BmAElVCiaipIT7suAicc5duLbNDgLCAMXUc2Bm2tlQ0ovJhMDtOebzNL2J5ZeQxdBGePTRgWznLuOM1S2rF7LkUew6NFrI1eSKy+OyzmfiGugiXL0XEhWSgy47Q4MlxgTmq8mb05Zz+d/fDj3bPSudqmSbJarWJTZCeYC6dNrM0yMUVGH7J7HrN5iQZZxVvfc/LcE5lLtqELs74fiIxk5kKufjFUnp1Cjdzb5VoYHRlqnRFquV3NxoiDRjllH2aXTOSonCjaoWvthPZzCt5I8sEXunHpQnL1GTZUOAy6H8U2VcXN2FJ2A3QRWMddY78q5+9fHPgmWvw2n1+x4IJlOkfqGEEEfaB4m8Rnk0kEFX8ITy8nk458UsW/IRPF8KGWXPHQqXbTEYpV2mDPH5+YUNbxXvf/QmW0EUuxHzeGbVn2JH4dMgpyPJucfV2BpKVCN+pJS09aetLSo1r64diP01QxQtkQD9EYbZjOssYYzNmqFBKHbdEQu9+PBC4+ae1Ja09aO9RaF0GFrtR04Ku19dSh80sKyXigStZbp5wu8btIWkgEFs39cCBqjIQU1kFBXZok61Jb16XrWhvXJfdUnntuBO3kfTVpOChtYJDUGZdlWMVhJWmATl1Dhue8alTO2Ss2u7ies1+5wxVvPbIUctf1q8mryVGvZPqIx+nVJQsZBh5u9YbBLYn8qNtg/C2O/dnJYtYY4dprmhbgWSA3aKYNFWPkRx/Pe6fnYARR/+XNwJrf/577wlNfm23OZRcPvKqDKo8dmyaelIX2AXvKHC6d6ojGhlwn8ekhPa8uvcoyXVWN8q1WLdlKuJLxLSgy2Vg6XUMEUmSorF9Xf64ezN6GEfZXiMhOYypj4NrQYZfClc0iznSVZGHa+H8h9SKpuFBJH8Im59N3H96/np68vTy/eH99cXIaT2L34DxcpICKq611hAPYuIfbz3W9+WH5312I9JR0+OCSWnKhSCS+Muu+h9yM1yMWIkh370rGNnIX9a3gBtbrBbf4wciuo9dfGjQtpDd3m87hW00uLH3fXC08WpNns/4W4jn7L9y4HIW0f8lV6zuobOgJIviM7d4FVHfXRVAiz9F4nILFeUDjZE5+Nh4O7mC6aJgxzTKs3SO2O1sm6l3j78fVn9dzakX9BVClc39Dxld0G8ZXkMIt3NLKta+U73L+/RokV8uGL8k++KW/fwA1zTCM +api: eJztWN9v2zYQ/leIe2oxRXK6rOv0MMBL0y1b2wWOuz0kAUpLJ4stRaokFUcw9L8PR0ryz6B92MuwBDBiicc73nffdya5BseXFtIbmKHVjckQ7iLQNRruhFaXOaSQo0SH43gEOdrMiJoMIIXXftgyznKspW4xZ6a3jW/VvBSWZVyxBTLOaqMztJblWAglyEHEcsyEFVoxg18aYbBC5XYttGGFNtXWu1s1xmqsUEvmSuzDj8EtQ5XXWigXs+saM1G03mwYZ61u2Iorx5xmIUcmlDf5ONj8ge1HVnPDK3Ro4lsFEYyPBNsaFK8QUtiaAREIAqbmroQI+rRySJ1pcB+9eYnsM7ZMF7uLG9e0h6Hb2B+Hc8fgKLYE3mBP2O7MOAAaIrBZiRWHdA2urSlZoRwu0UAEZM5dePXyDLruLiSM1v2i85bmbPIvuLQYQaaVQ+VojNe1FJmnWvLJEiDrw2h68QkzBxGoRkq+kDggWRsiqhNoyXok7QwLNKgypLe7aE+ZGQZ9ylmpLSq2CMxoLBIa3LGVkJLQrrlxHhcpmcFMm9xSiRrpiHSF0RVzVJwxdnyr3jXW0dyf2YSJgmp0L3LMA3m+BmAElVCiaipIT7suAicc5duLbNDgLCAMXUc2Bm2tlQ0ovJhMDtOebzNL2J5ZeQxdBGePTRgWznLuOM1S2rF7LkUew6NFrI1eSKy+OyzmfiGugiXL0XEhWSgy47Q4MlxgTmq8mb05Zz+d/fDj3bPSudqmSbJarWJTZCeYC6dNrM0yMUVGH7J7HrN5iQZZxVvfc/LcE5lLtqELs74fiIxk5kKufjFUnp1Cjdzb5VoYHRlqnRFquV3NxoiDRjllH2aXTOSonCjaoWvthPZzCt5I8sEXunHpQnL1GTZUOAy6H8U2VcXN2FJ2A3QRWMddY78q5+9fHPgmWvw2n1+x4IJlOkfqGEEEfaB4m8Rnk0kEFX8ITy8nk458UsW/IRPF8KGWXPHQqXbTEYpV2mDPH5+YUNbxXvf/QmW0EUuxHzeGbVn2JH4dMgpyPJucfV2BpKVCN+pJS09aetLSo1r64diP01QxQtkQD9EYbZjOssYYzNmqFBKHbdEQu9+PBC4+ae1Ja09aO9RaF0GFrtR04Ku19dSh80sKyXigStZbp5wu8btIWkgEFs39cCBqjIQU1kFBXZok61Jb16XrWhvXJfdUnntuBO3kfTVpOChtYJDUGZdlWMVhJWmATl1Dhue8alTO2Ss2u7ies1+5wxVvPbIUctf1q8mryVGvZPqIx+nVJQsZBh5u9YbBLYn8qNtg/C2O/dnJYtYY4dprmhbgWSA3aKYNFWPkRx/Pe6fnYARR/+XNwJrf/577wlNfm23OZRcPvKqDKo8dmyaelIX2AXvKHC6d6ojGhlwn8ekhPa8uvcoyXVWN8q1WLdlKuJLxLSgy2Vg6XUMEUmSorF9Xf64ezN6GEfZXiMhOYypj4NrQYZfClc0iznSVZGHa+H8h9SKpuFBJH8Im59N3H96/np68vTy/eH99cXIaT2L34DxcpICKq611hAPYuIfbz3W9+WH5312I9JR0+OCSWnKhSCS+Muu+h9yM1yMWIkh370rGNnIX9a3gBtbrBbf4wciuo9dfGjQtpDd3m87hW00uLH3fXC08WpNns/4W4jn7L9y4HIW0f8lV6zuobOgJIviM7d4FVHfXRVAiz9F4nILFeUDjZE5+Nh4O7mC6aJgxzTKs3SO2O1sm6l3j78fVn9dzakX9BVClc39Dxld0G8ZXYdXaV8l3OP9uDZKrZcOXZBt80t8/hpIvkA== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete resource

+ Deletes a deployed resource. This can be a process definition, decision requirements definition, or form definition deployed using the deploy resources endpoint. Specify the resource you want to delete in the `resourceKey` parameter. -## Request + -

Path Parameters

Body

    = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation.\nMust be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
+ -The resource is deleted. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + title: "DeleteResourceRequest", + }, + }, + }, + }} +> -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The resource is not found. - -
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/delete-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-role.api.mdx index 0364f27370c..f282c704ae6 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-role.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-role.api.mdx @@ -12,41 +12,176 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete role

+ - + Deletes the role with the given key. -## Request + -

Path Parameters

+ -The role was deleted successfully. + -
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The role with the roleKey was not found. - -
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/delete-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-tenant.api.mdx index 7a30c6f4db3..5345aba6bb4 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-tenant.api.mdx @@ -12,48 +12,217 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete tenant

+ Deletes an existing tenant. -## Request - -

Path Parameters

- -The tenant was deleted successfully. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant was not found. - -
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/delete-user.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/delete-user.api.mdx index 18745fd4d8a..992ed8ea260 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/delete-user.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/delete-user.api.mdx @@ -12,41 +12,176 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Delete user

+ - + Deletes a user. -## Request + -

Path Parameters

+ -The user was deleted successfully. + -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user is not found. - -
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/evaluate-decision.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx index 9848c410dfe..a0fbd17c284 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx @@ -5,31 +5,31 @@ description: "Evaluates a decision." sidebar_label: "Evaluate decision" hide_title: true hide_table_of_contents: true -api: eJztXO1v2zYT/1cIftowR3a7tOv0LY2zzeuaBkm6YUjygZbOFleJVPkSRzD8vw9HSrZsyXbqNnuerQpgxBKPd8d7I/mTqTk1bKppeEOHEHHNpSAxTLjghktB73pU5qAYXoxiGlK4Z6llBipi2qMx6Ejx3NGH9Kwk0ISRuCQKbsWf0hKdQ8QnBTEJLJuIkaTiSYCbBBQZF8RqLqaEG02s4B8tkA9QkG+YJgqMVQJiMi5uxRDyVBaXoKVVEXzbI1KVPddEjIYB+SMB0d7WczdSVNmQ2HGE+Fbcg3IEcrLegWtiNcTBLQ5dwUcL2ryWcUHDubvkCmIaGmWhRyMpDAiDTSzPUx45O/b/0mipOdVRAhnDb6bIgYZUjv+CyNAelQLeTWh402wx3KRQM3Plh8tSk+INFHTRO6DjKKaLu710dNGj8MCyPAWNmr8uVqZZxQ26y43QZhlTRY3dujHHq97DZec3UAS0R7EDIJNWCho+e/798QskU5yNvTaLxaK3TaPR8GCFRvEefVxmoD5HL17+8Io2lFo4xRToXArt7fZ8MPC86rlzXVdlxvQyM5wCB0cTS9MymtbFvWYaSK4wwQ0HTSZSkabbvdKowCbfVdftZmkb4mjYyKpZwqOkOeRSojaKiymGXlPIOcugXYxgGXxBQb/7gtAua1u12C2OCwNTULRHJ1JlzPhb3z+vK3Dpa0oGwuhPMKiqdSNTxfKEmISZvdphfcuZMkROWu0ircmtaarx69W7cxLLyKJEL2rG05RwoQ0ThleZpkDb1DzKTq7CNhSYMJ5CPPz8YPOMSGyRcyUWJ6ttUq2Ct6A1m7bEW9lA/N0xcpwlxX5reyVaRRoQTJhtw/KttdGteC5n3TauS7LKgrrJf9lU+hFUnf2Mm4SL0pluTqjJbLcjU4oVtEe5gUy3Vah1+Se11YFTYDN99hWeN372aVqttpjgMQjDJ0VjRdB0096MfXncXjK6AvgFCuBKgWvXqTUbivzwkf7PS9rTZHrGTJRAfGlTaMnxtaWGQho/wrLXKsu5frLkRrGfLHU995HF/iyr2CN1q60cGxHDQzsnjk17mO0K5aXH3rlQ2+KOpl+JD019uLX38123p2/Yb9GtPHdk2OMK1SGcf18tzRt1CZsO4b1oboWWc6Z348hARhd1wrc+NJZrZ4wqT1SLgZHYHgKrXaYj2j3/PmFmOvEtk++nJ6jjdFA8uZ6tTnctB0fTHr6fEUvbOO8KJRcNzUhq0m0l2dyp4a7O7eT/4VXS7mVEfRvzWYKfamMTLx2Cs3sEn67k3nzcEQ+bTnRE9V3+vYiDiGVWxCxgOQ8+QKEDYbMxqO+aCEAMuYIIh11BUR0m8B9aEneYQIcJdJhAhwl8tQWwwwQ6TKDDBDpMoMMEOkygwwT+HZjAY5ZJ/6cowWNUf0LcYLv4R7j+3GEEb6DQj8MUfIC2YAodgvAfWkB3CEKHIHQIQocgfLUFsEMQOgShQxA6BKFDEDoEoUMQ/h0IQvergs//VQGSHW87e5Arec9jDD5mGA5NSIPxyXedP8iVHKeQtf4KYb0QXHhKEoNhPCW+YBCmq/0NmlOQm8ufTsmPxy9+uPsmMSbXYb8/m80CNYmOIOZGqkCqaV9NIvwg3bcBuU6wmmWsIGMgLI5dJLK0DkP4w0c8wgNHxo/VKYNWXFtBbQEiTLlMXLd6bV62ircUv/eXo0bUrYl2fSbMpsiDjaU14Thl4gNd+bMpdFNKeaylqiLrAhY9qg0ztl6st64r2qb6X66vL4hnQSIZg4N0XGSWgnAQGRc8sxkNjwcDXCY++KuXg4FLA/T4I0YiCDzkKRMutDaHwwXJpIIyfgJfXH1efSHPSMWnfFNusJZbZRAP/YiqhDreN/P6XJpIK7pc6nKpy6WtufSibXI6wWWQAYVxCEpJRWQUWaVw7Zjw1LGPQC+Pd5YQko/FLte6XOtyrZlriOaASSQeXs2ldqHDTEJD2q/mraPVAVrdX60+aY9qUAjOuec/VqU0pHOfQIuw358nUptFOM+lMov+/fONE7EUm32iVQGUyoiliVei6UhsqO+/Tv1DK/KKXJ5dXZOfmYEZK5xhUeQ661eDV4NWrki6hePJxYj4EfowrJWGii3meCtbT/wYxgvcT2mIrOKmuMJu3jxjYArUiUVfLMOjlOe447Unor3yy09V0Pz6x7XzO5a1y9Xx9DN/ZnvHnm2wcWy5jiCubWcn0qlVxlVzgOjtCtSlg+BZM4YvRi4VI5llVrh6jE82uEkIqxksSq02aKgeTXkEuH8J51S4HfpS7G++hZQwMnkWoLN9RFZleMpNYsdBJLN++bhz+X+cynE/Y1z0SxG6f3ry9v358OTot9Hp2fnV2dGzYBCYB+OMimmSMVHTY3mMvLLq5mjnq/nn63o3Qhm3Bh5MP08ZFxg9zjHzss7c0LY6Q5eoFvcvoPDV4obO52Om4b1KFwu8/dECHuS/uVvFLV4tejQBFoNypcm9h4Ceeg8cOah/eZK/eYoe35vge5xEEeRmJ+1drXxevLu6xlQs3wORyRj7KDbDd0SwGQ3pLb2l+GKH3FRPx9z9OU2ZmFr39I96vvj3N9eW9ug= +api: eJztXG1z2zYS/isYfGrnaEpJnTSnb67l3qlpHI/ttHNj+wNErkQ0JMAAoGWORv/9ZgGSIkXqxXZ8d7kwM5mEBLi72H12ATwUuKSGzTUd3dAxBFxzKUgIMy644VLQO4/KFBTDi0lIRxTuWZwxA2Vn6tEQdKB4avuP6FnRQRNGwqKTfyv+JTOiUwj4LCcmgqqJGElKmQS4iUCRaU4yzcWccKNJJviXDMhnyMkPTBMFJlMCQjLNb8UY0ljml6BlpgL40SNSFU82VEzGPvkzAtHd5tkbMZpsSGglQngr7kHZDnLWfIBrkmkI/VscuoIvGWjziwxzOlraS64gpCOjMvBoIIUBYbCJpWnMA+vHwV8aPbWkOoggYfg/k6dAR1RO/4LAUI9KAR9ndHTTbmFxvKUlVRgpw0GjxHumOJvG7qIZoesISAJaszmQqhthmvx29fGchDLIEhDGR2VhaGHA4ouacDe2pvqVRw0IJgyCpEuhayWT8aZDUU8hSxvFxZyuUBg3MdTQVMLtsnA400BXd5uDLmWOKwC/h7zbnhqseAjC8FnewoaRZAoVOjHkp0wIafAuYoAYOQeL2AU3EWlrnxQwKcbHhYE5KOrRmVQJM+7W2+ODRpzjUFZej4hnImKbOW07nh//95AfWnluRVl6yEGV5/EOyiehddCefhg4eGBJWiDll3xtwXpiwMSxJSxLEqbymrimzdN8i1uoR/EB2JG2r17/dPzGa+B2hQPdYtFk/GSDJuEee+zUh/YcvXn78zvaMmplDVOgUym089vr4bAbaJUpC6Zr4KLPmC7WJaCpDpOCrBOCzKQi7bA7o2tZt6WAPCuXFhEPovaQN2DsdSg5Zwl0qxEsga+o6A+Xd926tiXlbnXdFf+n13UDLt2iASusfoRDVe0xMlcsjYiJmNlrHZaRlClD5KzTLzIzaWbaZjSmAqdqweOYcKENE4aXmaZAZ7E5yE9dhcyjM8ZjCMfPB5sTRMIMJZdqu+cXpzVT8MHNgm1NRQNxd6cocRHl+73tjOhU+cjpcS1zx0TpVQv0yoMd833VVMQRVF08TmZcFMG0c0JNZ7cfmVIspx7lBhLdVaGa+k9qc6w1YDN9XnRZ1w7T3ozFNVpXyegL4FcogGsDru1DndmQp08f6X+9pL1MpifMBBGEl9nWNf16ssA+boTFU+ss5/rFkhvVPlprM/dRxP4sK8Vj705fWTEihIduSRyb9gjbBeUqYh8t1LaEox1X4qCpn+7t/XKb/nQN+z26VeaODDusUD1F8h/rpXmrLmHTU2R3bJmqOdOFcWIgoat6xw8OGtXaGVHlOtUwMBHbIbDezNlOu+ffF8xMq75j8n18glpJT8KTfbIz6LblyWjaI/cZWNomeReULBraSGr329plc6f2nyG/HruMqG9jnqX4pTY2YRUQnN0DeLyRe/PxIDbGBdF2qu/y70XoByzJRMh8lnL/M+TaF1kyBfW3NgMQQqogwGF3s289J/BNL4l7TqDnBHpOoOcEvtsC2HMCPSfQcwI9J9BzAj0n0HMC3wYncMgy6X+UJTjE9BfkDZ74wyAX+nPLEbyHXB/GKTiAdnAKPYPwf7SA7hmEnkHoGYSeQfhuC2DPIPQMQs8g9AxCzyD0DELPIHwbDEL/q4Ln/6oAux1vO3uQKnnPQwQfMwyHhqdZ7lnMd50/SJWcxpB0/gqhWQguXE8SgmE8Jq5g4DmiYn+D7hTk5vLXU/L34zc/3/0QGZPq0WCwWCx8NQuOIORGKl+q+UDNAvyL/X70yXWE1SxhOZ69WR9CqtMQ7nQhD/DYjnFjtcagFxsrqC1EhCmWiU2v1+blTPGO4vfpctJCXUO1fWbGshhlsKnMzGgaM/GZruPZVrqppTjWUlaRpoKVR7VhJqsX663riq6p/p/X1xfEiSCBDMFSOhaZhSIcRMIFT7KEjo6HQ1wmPrirt8OhTQOM+AEjEQQe0pgJC63N4XBBEqmgwI/viqvLq68UGan4nG/q9Ru5VYB47EZUJtTxvpnX5dJMZqLPpT6X+lzamktvuianE1wGGVCIQ1BKKiKDIFMK144Rj634AHR1irKgkBwW+1zrc63PtXauIZsDJpJ4eDWV2kKHmYiO6KCct47WB2j1YL36pB7VoJCcs+9/MhXTEV26BFqNBoNlJLVZjZapVGY1uH+9cSKWYrNLtBJAsQxYHDkj2oHEhvr+69S9tCLvyOXZ1TX5BzOwYLl1LKpsin43fDfslIpdt0g8uZgQN0IHw1ppKMVijneKdZ0PEbzC/ZSGIFPc5Ff4mHPPFJgCdZJhLCp4FPqsdLx2nahX/OfXEjS//Xlt445l7XL9/Ykzd2Z7x55tuHFsuc4gNrazM2nNKnDVHiBGuyR16dB/1cbwxcSmYiCTJBO2HuObDTwkz2oOC+JMG3SUR2MeAO5fRksq7A69Uvu7ayEFjUxe+Rhsh8iyDM+5ibKpH8hkULzurP6dxnI6SBgXg0KFHpyefPh0Pj45+n1yenZ+dXb0yh/65sFYp2KaJEzU7KiOkZde3Rztcj3/fF8fPylwa+DBDNKYcYHosYFZFnXmhnbVGVqxWtx9YcZVixu6XE6Zhk8qXq3w9pcM8CD/zd0at3i18mgELARlS5P9DgE9dRE4slR/dZK/fYoev5/hnjgJAkjNzr53tfJ58fHqGlOx+NBLIkN8RrEFfgSGLeiI4ldbUlO+GbP3ljRmYp7ZN3/UycQ//wa7OFgm 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Evaluate decision

+ Evaluates a decision. @@ -37,78 +37,825 @@ You specify the decision to evaluate either by using its unique key (as returned DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used. -## Request - -

Body

required
    oneOf
    variables object
    - -The message variables as JSON document. - -
    variables object
    - -The message variables as JSON document. - -
- -The decision was evaluated. - -
Schema
    evaluatedDecisions object[]
    - -Decisions that were evaluated within the requested decision evaluation. - -
  • Array [
  • matchedRules object[]
    - -The decision rules that matched within this decision evaluation. - -
  • Array [
  • evaluatedOutputs object[]
    - -The evaluated decision outputs. - -
  • Array [
  • ]
  • ]
  • evaluatedInputs object[]
    - -The decision inputs that were evaluated within this decision evaluation. - -
  • Array [
  • ]
  • ]
Schema
    evaluatedDecisions object[]
    - -Decisions that were evaluated within the requested decision evaluation. - -
  • Array [
  • matchedRules object[]
    - -The decision rules that matched within this decision evaluation. - -
  • Array [
  • evaluatedOutputs object[]
    - -The evaluated decision outputs. - -
  • Array [
  • ]
  • ]
  • evaluatedInputs object[]
    - -The decision inputs that were evaluated within this decision evaluation. - -
  • Array [
  • ]
  • ]
Schema
    evaluatedDecisions object[]
    - -Decisions that were evaluated within the requested decision evaluation. - -
  • Array [
  • matchedRules object[]
    - -The decision rules that matched within this decision evaluation. - -
  • Array [
  • evaluatedOutputs object[]
    - -The evaluated decision outputs. - -
  • Array [
  • ]
  • ]
  • evaluatedInputs object[]
    - -The decision inputs that were evaluated within this decision evaluation. - -
  • Array [
  • ]
  • ]
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The decision is not found. - -
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/fail-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx index 41a216423a2..e71eb294e3e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx @@ -5,59 +5,265 @@ description: "Mark the job as failed" sidebar_label: "Fail job" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zgS/itduGxSy0jKrJPN8OZ4khlnJonLdnYPjg9NsinCBgEOAFpmqfjftxog9baTwx7lKpVJotHP72sSvRQe506kN+KTycRtIkxDFr00+rwQqShRKl5IREEut7LhFZGKz2jvwVcEdyYDdMByVHzXIhENWqzJk2WtS6GxJpGKO5P9SZ1IhOTtDfpKJMLS3620VIjU25Z2bVxXBPfUgSlXlrwJliYiES6vqEaRLoXvGrYgtac5WZGI0tgafXz09kT0/W00Rc6/N0XHe9aWS1SOEpEb7Ul7XsOmUTIPOZjeOXZluW/NZHeUew7Xcsa8JBf1ejtc7geDtWm153gGsVVcrjKtKqDCBwJFpQ+JfDauf/0SalJiq7xIZ30iyFpjP5NzOKd9+6caTLhGBXUUgiiRST2HRdWtnIm1nMB1JR1IBw1aL/NWoVUdtI7KVoEsAYOwbbUD025FhboA1CB1LgvSnnVYlI6KhKHiWe3oQo4aKlIN0GOjUOrgyObeBY6bJ5tJcd5KPReJ0K1SmCmKEOqTUIHuPeb3X8vycBkyzO9NWYKXNbHnL6SG2r2E0tiQA02PPsTSTX5ch7cnu3V4QCvZowACLAoZs36xgZNDaP909fULRFSBr9DDQioFUjuP2kv0FHxbKQf04YEyOSpwuWlogyj/cIDOmZz3FeDR3W+FsgLvTvb6RHjp+Za7wUeU6jLSRvR9H3LrGqNdDO2X2cnh/DIs5NgSJqJPxMlsdli0seZBFlRAgR55kzYeHlDJodpPsLKxJlNU/3OfnTugh4soCQV5lGrML7oR+1SA1HBz+fEMfj158+/bF5X3jUun08ViMbFl/ooK6Y2dGDuf2jLnH8u9ZHaQJaixg4xgXWZY9wNwDeWylDm3LR+jDc5wFQ7XY7uZxNXlHuZX+Gut3OvMp/Dt8hwCeWTZMbf3TG8iVmBmWp9mCvW9WNd/3+iuFdfWNdpVd9420CfCefSt+2F/HvrYLjD+uL6+gKgCclPQQE7uRtEQB1FLLeu2FunJbJaIGh/j3dsZ0zBW/Cci0bH36ACt3XC4NRhLA35CYJGS+f+rMsbKudy1OxGbXBxA/FuMKFLx5Dn2LaSvgrq5fCAN8d070qs0rT7S60ivI72epdevP02v+8gtqcOzhTV6HnJLkLfWkvaqm8DndZgO0G68+oZ947sVMlN0R3oe6Xmk59P0fHPog/KUjw2eLOMwHIbA5IGBBSwqqYL6nJwbbQ9HwiPXjlw7cu0prvWJqMlXhodBjXEBOjy8ScX0zmRuuowfl/2Uj3utJZ7MkH0Ypz+tVSIVy0ibPp1Ol5Vxvk+XjbG+nz5wTbYOzLwc6TXCJpxwq2h6v3y8wCOmMawzrFtdILyDyw9X1/A7elpgF9LJJrdVv5u9mx3UyqJPaDy9OIcYYQTfRkMY1TKzD6qNwj+jOMysHOWtlb674m0xPRmhJXvacgVWoBjsBe18H4VEMlx8HKHy6b/XodrczC7X87APj1g3kYqr8dVsd560Rt72gGW2Xb8+wLY0wbsBVPtxctHJupiY2eT1PoAvzgMPc1PXrQ7NmIdU/N2FG3nLVes85ysRSuakXQhimDiOYn/FFfhPtAivJ1zzCMyxB8+lr9pskpt6msdtq/+ZMtm0Rqmngwk3PTv9/O3Lb6ev/jo/+/Dl6sOr15PZxD/6kFvmSI16ww8eo/Bn426Qy/U757lx6lBjT49+GkZkjLrg/XJg4g0PV51IRLoaso5kvE0GQt2I5TJDR9+s6nt+/HdLthPpze26foGwhXR8vR6MPunzi8thhvoSnp/UHoxgeIi6Cx1AtXwnEnFP3Xpa3N/2iagIC7LBubh4Fl14dc0q1pv3xrZ9Mu44zXNq/BOyW694pt2q3118vbpmFg0z49oUvNfiglmAC5GK7+I7Ox0nq3EAzM+XQqGet5E4US///Q/qaREQ +api: eJztWEtz2zYQ/is7uDSZMpKSOmmim+MkrdM8PLbTHlwfluRShA0CDABa5mj43zsLkHrbyaFHeUZjkljs8/uWxC6Ex5kT0yvx0aTiOhGmJoteGn2ai6koUCpeSEROLrOy5hUxFZ/R3oIvCW5MCuiA5Sj/V4tE1GixIk+WtS6ExorEVNyY9C9qRSIkb6/RlyIRlr430lIupt42tG3jsiS4pRZMsbTkTbA0EolwWUkViulC+LZmC1J7mpEViSiMrdDHR6+ORNddR1Pk/FuTt7xnZblA5SgRmdGetOc1rGsls5CD8Y1jVxa71kx6Q5nncC1nzEtyUa+3/eVuMFiZRnuOpxdbxuVK06gcSrwjUFT4kMhH4/rtRahJgY3yYjrpEkHWGvuZnMMZ7do/1mDCNSqoohBEiVTqGczLdulMrOUILkvpQDqo0XqZNQqtaqFxVDQKZAEYhG2jHZhmIyrUOaAGqTOZk/asw6J0lCcMFc9qBxcy1FCSqoHua4VSB0fW985x2DxaT4rzVuqZSIRulMJUUYRQl4QKtG8xu/1aFPvLkGJ2a4oCvKyIPX8iNVTuKRTGhhxouvchlnb04zq8Otquwx1ayR4FEGCey5j1szWc7EP7x4uvXyCiCnyJHuZSKZDaedReoqfg21I5oA8PlMlQgctMTWtE+cUBOmcy3peDR3e7EcoSvFvZ6xLhpedb7gYfUKrzSBvRdV3IrauNdjG0F5Oj/fllWMihJYxEl4ijyWS/aG3Nncwphxw98iZtPNyhkn21H2BlbU2qqPp1l51boIezKAk5eZRqyC+6AfuUg9Rwdf7hBN4cvfz9+knpfe2m4/F8Ph/ZIntGufTGjoydjW2R8Y/lnjI7yBJU2EJKsCozrPoBuJoyWciM25aP0QZnuAr767HZTOLqYgfzS/w1Vu505mP4dn4KgTyyaJnbO6bXESswNY2fpgr1rVjVf9fothXXVBXaZXfeNNAlwnn0jfthf+772DYw/ry8PIOoAjKTU09O7kbREAdRSS2rphLTo8kkERXex7tXE6ZhrPhPRKJj79EBWtvhcGswlnr8hMAiJbP/qzLGypnctjsS61zsQfwuRhSpePQY++bSl0HdTN6RhvjuHehVmEYf6HWg14Fej9LrzU/T6zZyS+rwbG6NnoXcEmSNtaS9akfweRWmA7Rrr75+3/BuhdTk7YGeB3oe6PkwPV/u+6A85mODJ8s4DIchMFlgYA7zUqqgPiPnBtv9kfDAtQPXDlx7iGtdIirypeFhUG1cgA4Pb6ZifGNSN17Ej8tuzMe9xhJPZsjeDdOfxioxFYtIm246Hi9K43w3XdTG+m58xzXZODDzcqTXAJtwwi2j6d3y8QKPmIawTrBqdI7wGs7fX1zCH+hpjm1IJ5vcVP168nqyVyuLPqDx+OwUYoQRfGsNYVDLzN6rNgr/jOIws3KUNVb69oK3xfSkhJbsccMVWIKitxe0830UEkl/8WGAysd/LkO1uZmdr+Zh7++xqiMVl+OryfY8aYW8zQHLZLN+XYBtYYJ3Pah24+Sik3UxMZPR810An50GHmamqhodmjEPqfi7C9fylqnGec5XIpTMSLsQRD9xHMQ+xRX4O1qE5yOueQTm0INn0pdNOspMNc7ituX/VJl0XKHU496EG58cf/725d3xs0+nJ++/XLx/9nw0Gfl7H3LLHKlQr/nBYxT+bNwOcrF65zw2Tu1r7Onej8OIjFEXvF/0TLzi4aoTiZguh6wDGa+TnlBXYrFI0dE3q7qOH39vyLZienW9ql8gbC4dX68Gow/6/OS8n6E+hccntXsj6B+ibkMHUA3fiUTcUruaFnfXXSJKwpxscC4unkQXnl2yitXmnbFtlww7jrOMav+A7MYrnmm37HdnXy8umUX9zLgyOe+1OGcW4Dw6HKeqcfjLzxZCoZ41kTRRJ//9B7ktEBQ= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Fail job

+ Mark the job as failed -## Request + -

Path Parameters

Body

    variables objectnullable
    + -JSON object that will instantiate the variables at the local scope of the job's associated task. + -
- -The job is failed. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the given jobKey is not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the given key is in the wrong state currently. 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/find-authorizations.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx index 61350dad91c..21cb5aac09c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx @@ -5,91 +5,826 @@ description: "Search for authorizations based on given criteria." sidebar_label: "Query authorizations" hide_title: true hide_table_of_contents: true -api: eJztW22P27gR/isEP7WoYjt3ubvU3xxbm6jZtX1+ueK6WWxoaWzzIpEKSe2ua/i/F0NKtmTLGydICxSnAMHK5HBeOM8MRxS5pYatNO3e0l5m1lLxfzPDpaB3Ho1Ah4qn9meXToGpcE2WUhFWptRkwTRERAqy4g8gSKi4AcVZ64OgHpUpKEsXRLRLl1xEFTmaelTB5wy0eSOjDe1uaSiFAWHwkaVpzENL2P5DoxpbqsM1JMz2xvFoSbu3W2o2KdAulYs/IDTUo6lCsYaDtiOkstyO7JHKkCWHODpoTL2CFVOKbahHuYFEf40wy/FU2mwNuTAjCSpEFpuSOG0UFyu686hUEaj68baLcEEe1zxc7xmZNRAFMTMQORHIF0SWWKdO+9SjA3/adx5dsiw2tJu3G25iyOdihNx9HLbbOZ9wBRHycCbdlcgtFH7NQG1w5MT5j+7ucGTKVnCq/5ituLCOrMz2xbOqZFI/KVxE8ETkklhP2UkxTBmirY5crAiOLU01FwZWoKhHl1IlzLimH3/AyY95wmuggnIS9sSTLCEiSxagKgIVmEwJdIwU6Ao7GxdKdGr2lqbO6cHeJBd7DMlapC+V87ftQ/d/jJk26IrfWJyB/kjy2dugnoykCh64zHTBR4FOpdDwHN6r/tjtVX0DS6lqHHys68LS1Sq75Oq/re2uFqxjtoIDWL0aG2sGnR9wGvpxrRsRPpWUWVjmBuhqIFTH9s6PK83HGYXkowA1syR1OuFgnHJ0iiXFHymohGuNqblOwDk9L+VX5KX51J9Qj05G1z716NvJaD6mHr3pjcfB8C316Hw4Hfv94CrwB+XMMyosconqDhMmNr2HzZn0EF1oYX2Q/vyqAouKN66sF6rJr5awDkzVHGtUBrbBId0674dO5yugpEBnsU06Fy+f5137PKq+mOC5cFOIz2whM7dEVRR9FvPfwOp5jY00LA6KXHE0o9iX5/KEGbdkoJCaouA8Rjx6lNTqXWfX6wdLUMDSjrPycQFxazmaRTSYFplrIGbNddH3sZyEP+YVBWZNQUDoDHU/XX8uyO3V9eNi5XHY1+pu17rvpvpzid4F01FkVoJxT3GMGH4GLLYQyEFSrYIvV/rySPtT5G8FWmYqhC/bWVASs2Ym13DNHuB72HzgLQmLoraCRFY5EyPbRSm5r67ns3ejSfCv3iwYDQ/230/mdlpu/Om09xaf3vRm/XfUo73x+DroF+TT36cz/4Z6dOYPe8OZLdTH16Pfb3z7YzwZ9f3p9H7gXwXDIB8z8PvBNBgN7yf+r/Ng4iPtOZJKa+GjsudKnpmU3HBwTsn+EpALgJ9O55EnzkbA0YqyH1UPgmkKIV9yLCFLLvtGr1/EbO/gPnqAerQ/8Xszf/9wX/gmGE5nvWG/1LOf/VLXxO8N8j91I207+uV+1pu+LxrqGM3HA6eGe6hjlveU2Q38a9+Ocg/FqEPDYDI4/LgaTW5OaA8SSpgZV/x2GtJB9GXU9EjMtamEYDBwvjn4hBxeIdA7meCfM8gXdKydTpFWvFCXU/9B3cFsVO2q1GvFuvCG1a4N36ng3Gv4BS2eUdStZSVCr1LyPYioFbIkExFrsZS3PsFGt9z7699Oy8EIUgUh7iIUc9oUiE2B2BSITYHYFIhNgdgUiE2B2BSI/9MC8et3JAu9hrbGew8bfXHxWBlyQRnppq+mjGyKxqZobIrGpmhsisamaGyKxqZobIrG//tdRaR89VVfoz/jQkiWjMcQtciNVEAiMIzHmjAFeN7jgUcQldZ3K4ssZLRxx8bOfMVOlVzEkNRuX1b9P3aUuVziApgwTRzhwkm/nVz1yd9f/fTL3V/WxqS6224/Pj621DJ8ARE3UrWkWrXVMsT/SPfXFpmtQeGCvSELwKzOUSaLycGfRLtsEBZHXnK1bV5w9n2htMwTVtWppQIxU7wG8/NJQHgEwvDlpig4K6Jp+QiYrXy7i5iJT/SAhVOhx1J0liRMbQpAVgXgOSHDTFaOmrPnn+py/bvZbEwcCxLKCOyBQ1vw5YLQiIQLPIxFu686HY/mR7No9+dOZ4c80eMXWCIIPKUxy18KjszhgiQH3FrDuNCGifB7eUYqvuLHcluV0M1BPHAWFZH4sj4S8zqXxCz8pLGk5pGNTpQaFkfvwCrBYv3MUZEmyJog+9MH2Y+neL+SasGjCISF5z7euCZCGsLiWD5C1MRVE1dNXJ2Lq5/qysge7sgZUIhDUEoqIsMwUwoiPOkeW/YhaF3ILjZ0mkKxibUm1s7E2s6jCZi1xFs3qdQWOsysaZe2q1uMbffORvGAv3oApe3uRqZi2qVbFza7bru9XUttdt1tKpXZtR/QJw9McbaIHRKx24VXAZtYhixeO9Gn7sMOwZL91mDffWEgr8nEn87IW2bgkW3sdKb7+zsF69ed1536nSLcTa7n2BsHxFnowFdKCAVbjOxato74EsY7fLPXEGaKm80Uh7npWQBToPA9uwSKXJ7ljr8dEfXyh6sCKv/458x6G5PZ5HBZyn9iSepC8XD1oLy7Wzkdj4h3N6Fu97eU9tsFd4d7O+6qTWd/GaZzdEnldutMLF8GwbadBf5SWvtyWJ7OFMIGlHZT22m9PA2BcWAjOZRJkgmbzsWKPHKzJqw082Gc6fwORMxDwI2K7pYioEpir10P+c1JJC9biBoH7SKLr7hZZ4tWKJN2/pFr/3cRy0U7YVy0cxG63e/dzIeD3ovroO8Pp/6Ll61Oyzy5rx0YZQkTJT3s94CjHf1jg0v33b71il2OJgNPpp3GjAvEt7Vym8f8LT1RIo/6Oy+P3Fu63aKUuYp3O2y2ezi0e3t3CHT8tfPoGljkkEA/IbJo31nwwsIOyePMbs0dXz/YecWIXhhCap6lvSslsPFoilvXi/yGYCIjHKPYI94eZI+0Sz/QD9TeNjTFrrJt39KYiVVmoU0dX/z3H2CAej0= +api: eJztW22P27gR/isEP7WoYjt3uWvqb46tTdTs2j6/XHHdLja0NLZ5kUiFpHbXNfzfiyElW7LlXSdICxSnAMHK5HBeOM8MRxS5pYatNO3e0l5m1lLxfzPDpaB3Ho1Ah4qn9meXToGpcE2WUhFWptRkwTRERAqy4g8gSKi4AcVZ61+CelSmoCxdENEuXXIRVeRo6lEFXzLQ5p2MNrS7paEUBoTBR5amMQ8tYft3jWpsqQ7XkDDbG8ejJe3ebqnZpEC7VC5+h9BQj6YKxRoO2o6QynI7skcqQ5Yc4uigMfUKVkwptqEe5QYS/TXCLMdTabM15MKMJKgQWWxK4rRRXKzozqNSRaDqx9suwgV5XPNwvWdk1kAUxMxA5EQgXxBZYp067VOPDvxp33l0ybLY0G7ebriJIZ+LEXL3cdhu53zCFUTIw5l0VyK3UPglA7XBkRPnP7q7w5EpW8Gp/mO24sI6sjLbF8+qkkn9pHARwRORS2I9ZSfFMGWItjpysSI4tjTVXBhYgaIeXUqVMOOafvwBJz/mCa+BCspJ2BNPsoSILFmAqghUYDIl0DFSoCvsbFwo0anZW5o6pwd7k1zsMSRrkb5Uzt+2D93/KWbaoCt+ZXEG+hPJZ2+DejKSKnjgMtMFHwU6lULDc3iv+mO3V/UdLKWqcfCxrgtLV6vskqv/tra7WrCO2QoOYPVqbKwZdH7AaejHtW5E+FRSZmGZG6CrgVAd2zs/rjQfZxSSjwLUzJLU6YSDccrRKZYUf6SgEq41puY6Aef0vJRfkZfmU39CPToZXfvUo+8no/mYevSmNx4Hw/fUo/PhdOz3g6vAH5Qzz6iwyCWqO0yY2PQRNmfSQ3ShhfVB+vObCiwq3riyXqgmv1rCOjBVc6xRGdgGh3TrvB86na+AkgKdxTbpXLx8nnft86h6McFz4aYQn9lCZm6Jqij6LOa/gdXzGhtpWBwUueJoRrEvz+UJM27JQCE1RcF5jHj0KKnVu86u1w+WoIClHWfl4wLi1nI0i2gwLTLXQMya66LvUzkJf8orCsyagoDQGep+uv5ckNur68fFyuOwr9XdrnXfTfXnEr0LpqPIrATjnuIYMfwMWGwhkIOkWgVfrvTlkfaHyN8KtMxUCC/bWVASs2Ym13DNHuB72HzgLQmLoraCRFY5EyPbRSm5r67nsw+jSfDP3iwYDQ/230/mdlpu/Om09x6f3vVm/Q/Uo73x+DroF+TT36Yz/4Z6dOYPe8OZLdTH16Pfbnz7YzwZ9f3p9H7gXwXDIB8z8PvBNBgN7yf+L/Ng4iPtOZJKa+GjsudKnpmU3HBwTsn+EpALgJ9O55EnzkbA0YqyH1UPgmkKIV9yLCFLLvtGr1/EbO/gPnqAerQ/8Xszf/9wX/gmGE5nvWG/1LOf/VLXxO8N8j91I207+uV+1pt+LBrqGM3HA6eGe6hjlveU2Q38a9+Ocg/FqEPDYDI4/LgaTW5OaA8SSpgZV/x2GtJB9DJqeiTm2lRCMBg43xx8Qg6vEOidTPAvGeQLOtZOp0grXqjLqf+g7mA2qnZV6rViXXjHateG71Rw7jV8QYtnFHVrWYnQq5R8DyJqhSzJRMRaLOWtz7DRLff++pfTcjCCVEGIuwjFnDYFYlMgNgViUyA2BWJTIDYFYlMgNgXi/7RA/PodyUKvoa3xPsJGX1w8VoZcUEa66aspI5uisSkam6KxKRqborEpGpuisSkam6Lx/35XESnffNXX6C+4EJIl4zFELXIjFZAIDOOxJkwBnvd44BFEpfXdyiILGW3csbEzX7FTJRcxJLXbl1X/jx1lLpe4ACZME0e4cNJvJ1d98rc3P/317k9rY1LdbbcfHx9bahm+gogbqVpSrdpqGeJ/pPtzi8zWoHDB3pAFYFbnKJPF5OBPol02CIsjL7naNi84+14oLfOEVXVqqUDMFK/B/HwSEB6BMHy5KQrOimhaPgJmK9/uImbiMz1g4VTosRSdJQlTmwKQVQF4Tsgwk5Wj5uz5p7pc/2E2GxPHgoQyAnvg0BZ8uSA0IuECD2PR7ptOx6P50Sza/bnT2SFP9PgFlggCT2nM8peCI3O4IMkBt9YwLrRhIvxenpGKr/ix3FYldHMQD5xFRSS+ro/EvM4lMQs/ayypeWSjE6WGxdE7sEqwWD9zVKQJsibI/vBB9uMp3q+kWvAoAmHhuY83romQhrA4lo8QNXHVxFUTV+fi6qe6MrKHO3IGFOIQlJKKyDDMlIIIT7rHln0IWheyiw2dplBsYq2JtTOxtvNoAmYt8dZNKrWFDjNr2qXt6hZj272zUTzgrx5Aabu7kamYdunWhc2u225v11KbXXebSmV27Qf0yQNTnC1ih0TsduFVwCaWIYvXTvSp+7BDsGS/Ndh3XxjIWzLxpzPynhl4ZBs7nen+/k7B+m3nbad+pwh3k+s59sYBcRY68JUSQsEWI7uWrSO+hPEO3+w1hJniZjPFYW56FsAUKHzPLoEil2e5429HRL384aqAyt//MbPexmQ2OVyW8p9YkrpQPFw9KO/uVk7HI+LdTajb/S2l/XbB3eHejrtq09lfhukcXVK53ToTy5dBsG1ngb+U1r4clqczhbABpd3UdlqvT0NgHNhIDmWSZMKmc7Eij9ysCSvNfBhnOr8DEfMQcKOiu6UIqJLYa9dDfnUSyesWosZBu8jiK27W2aIVyqSdf+Ta/13EctFOGBftXIRu93s38+Gg9+o66PvDqf/qdavTMk/uawdGWcJESQ/7PeBoR//Y4NJ9t2+9YpejycCTaacx4wLxba3c5jF/S0+UyKP+zssj95ZutyhlruLdDpvtHg7t3t4dAh1/7Ty6BhY5JNDPiCzadxa8srBD8jizW3PH1w92XjGiF4aQmmdp70oJbDya4tb1Ir8hmMgIxyj2iLcH2SPtUnvT0BQ7yrZtS2MmVpmFNXU88d9/AIpyeUE= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query authorizations

+ Search for authorizations based on given criteria. -## Request - -

Body

required
    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Authorization search filter. - -
- -The authorization search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching authorizations. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching authorizations. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching authorizations. - -
  • Array [
  • ]
- -The authorization 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-decision-definitions.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx index f0dbba95912..ecc9f8b5cb7 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx @@ -5,91 +5,661 @@ description: "Search for decision definitions based on given criteria." sidebar_label: "Query decision definitions" hide_title: true hide_table_of_contents: true -api: eJztW1tv2zYU/isEnzZMsd2t2zq9uUm6eVvbLEm3BzdAaenI4kKRKknFMQz99+GQki1bcuxm6dABKlC0Fslz/c7Fx9SKWjY3NJzSM4i44UqSGBIuueVK0puAqhw0ww+TmIY04TKuN56t9xka0BhMpHnujoX0CpiOUpIoTeI2XUNmzEBMlCRzfgeSRJpb0JwN3ksaUA0fCzD2pYqXNFy5j1xDTMOECQMBjZS0IC2usTwXPHLyDf82yHpFTZRCxtyqEG8TGk5X1C5zoCFVs78hsjSguUa9LAfjTijtqO3ooLQlCQcRb+SjQU2Kac2WNKDcQmY+hZmj2OZ2nULFzCqCApHZssHOWM3lnJYBVToG3X3eLREuySLlUbomZFMgGgSzEHsWSBdkkaHbx1enNKBn51en6O0YElYIS8PqueVWQGWLt0j9HI+VZdDwyrRS6aax3bn/jwL0Ek9eeofS8gZP5mwObfkv2JxL58gtax9tVa2ybqNwGcM9UQlxnnJGsUxbYpyMXM4Jnm2YmksLc9A0oInSGbP+0XffovEFz3gHVJBPxu55VmREFtkM9BZDDbbQEh2jJLrCWeNIjl7McWK7nD5Zq+TjjeG2ATlV2vvbraH7PwhmLLriTyYKMB9IZb0lyslIruGOq8LUdDSYXEkDD+F92x/lWtSXkCjd4eBdWWduX6ewCdefW9qyE6wXbA4bsAYdOnYc2n+gHfqi040In440Wevnj5ntcNim0JG8t083bLNHuLiV1n+DZcN03SD94Xkr96M2zBg+lxCTW1gGVTpikTWEGcJIIfnHAgiPQVqecNCuUNiUmy4zDDAM2tJN4oZwVXrsEuXs9RsyOUPk2G4zO/qSZXA8Pdx9iOIdaMN9RToU5g9asKJziF39/NLn5QykNceYyO43kW6QInPN8pTYlNl9YhBuSI6ZVSV7JXoiSD21qBYkk/ZYRPndB0HVyBbtlumVi8rtwrh/d1e2KX0V9qnPRfC3o9En5xYNphDW911H91W7ieTYIn2w8nPpgYD/ZzNVeAduifpgGnwEqYcltsoyMamLyI5lca0q8hmzvpdAJh3d4l6klwHdqXbdLnSN3J3bUKPOnXP8sbPwTR6qRQzYAXlnwGfUau1Dszp/qFpNLKeSgDQFyt5uTI4o+tuNxdHC47FPld01QU8m+kMdgA+qnbDcCsL1jl3E8D1gcR1iBZKur0THi74f/i+ZAbIRx1XVdjJBOD+mHegL7hdecP/7KoZQQtB1xMGhdvIByT5b87i/EzlSmqf12EHTbmepA21BnZHKYKt638l4ELGskDEbsJwPbmFpBv476jftyh5DriHCSQENrS6gnSX6Wt/X+r7Wf75a/ykR2Ff/vvr/P6v/lzFM+uInEwfN/8YV8t9gaR7RK2wdPqJr8HDq6Br6HqHvEfoeoZ8H9B1B3xH084AvbR6AZ54/4qeBj0iHJIwLiAfktdK42zIuDGHa5ZU7HkPcSNiOI5mpePngDwq5VjMBWef4oSnfmFz4nRVf4lMTut1vnHnu08tXp+Sn59//ePNVam1uwuFwsVgMdBKdQMyt0gOl50OdRPgX9309INcpaMzASzIDwuLYac5EM1uaHCKe8Kj+WboSmyBEvH4HegW32obUOvcUmrcQNibvLic1mJd1B7HFmjavabhWJpwJJm/pBhuHcDwmpsgyptcA3maAv+VbZgvz2Nz5y/X1BfEkSKRi2IRkxQiVyLjECxM0fD4aBbS6PkHDH0YjF6Lo8SM0kQTuc8GqLm9HHS5JtsGtU4xLY5mMnsozSvM53+W7HcsViM+8RnU8PuuOx6pxIYJFtwZ7JB4TVtgUuUb19RhwQjDhmoQ+yPog64OsO8i+a+P9ldIzHscgHTzX8cYNkcoSJoRaQNzHVR9XfVzti6vvu5rJMY5YLGjEIWitNFFRVGgNMXbswpGPwJiad/0NvW8U+1jrY21PrJUBzcCmCq/e58o46DCb0pAO6y9uJ42Z0dB/c6N4FVfj2MLNhAotaEhXPnjKcDhcpcrYMlzlSttyeIeeuWOas5nweMRlH2Q1eISKmEi9AG0n4kJzIHPqB8fkBbk8v7omPzMLC7Z0Rs3XN+1r0i9GL0adVHHrHorjiwnxGnoINtJCTRbju5Os33wM4RKHGAaiQnO7vMJj3jwzYBr0uEA/rKFR8XPU8bPfRIPqP69qwPz617XzOaa0y817Duf3LMt9QDYvCXeOTEb7bsNu8OmHaZvP61FY4+zunKoZOHvGI6PmTKnxSoJ/f2K6frdhvXSzue3vL+iP1lfoRztX26crb+7mFXJ8VrpQTJSzdRUoba81daSjwbN2UF5MXG6JVJYV0hUYOScLblPCGiiIRGGq29KCR4ADlHBVm7Pe9rtfIX9Wg8FnA0SwD7O6rsy5TYvZIFLZsPodZf3vTKjZMGNcDisWZng6fv3uzdn45PfJ6fmbq/OTZ4PRwN77gTrGfcZkQw434OkcGu+qvdpU1n/3Sk6Fcgv3dpgLxiW63Wm8qjLSlHZlJFq7FN8O8XllSlcr5PVOi7LEx27ORMPpzSYN4acyoCmw2GOD3iL+6KnX5uQaxcHtonAD8t3bqmVQnxhHEeT2wb03jSR78fbqGoO2evUoUzGe0WyBryWxBQ3pe/qeUnwtyuuH7yfh8xUVTM4LB3bq6eKffwD0Z8K2 +api: eJztW1tz27gV/isYPLVTWlJ2s7sp3xTbadXdJK7tbB9UzwQkD0WsQYABQMsaDf975wCkRImUpbhOJ51hZjKJCOBcv3PREbimli0MDef0AmJuuJIkgZRLbrmS9C6gqgDN8MMsoSFNuUyajRebfYYGNAETa164YyG9AabjjKRKk6RL15CIGUiIkmTBH0CSWHMLmrPRvyUNqIYvJRj7ViUrGq7dR64hoWHKhIGAxkpakBbXWFEIHjv5xn8YZL2mJs4gZ25ViI8pDedralcF0JCq6A+ILQ1ooVEvy8G4E0o7ans6KG1JykEkW/lo0JBiWrMVDSi3kJuvYeYodrndZlAzs4qgQCRatdgZq7lc0CqgSieg+8+7JcIlWWY8zjaEbAZEg2AWEs8C6YIsc3T79OacBvTi8uYcvZ1AykphaVg/t9wKqG3xEalf4rGqClpemdcq3bW2O/f/swS9wpPX3qG0usOTBVtAV/4rtuDSOXLH2idbVau83yhcJvBIVEqcp5xRLNOWGCcjlwuCZ1um5tLCAjQNaKp0zqx/9OMPaHzBc94DFeSTs0eelzmRZR6B3mGowZZaomOURFc4a5zI0Ys5TW2f02cblXy8Mdw2IudKe3+7NXT/Z8GMRVf8zkQJ5jOprbdCORkpNDxwVZqGjgZTKGngKbzv+qPaiPoWUqV7HLwva+T29Qqbcv2tpa16wXrFFrAFa9CjY8+hwwe6oS963Yjw6UmTjX7+mNkNh10KPcl793TLNgeESzpp/VdYtUzXD9KfX3dyP2rDjOELCQm5h1VQpyMWW0OYIYyUkn8pgfAEpOUpB+0Khc246TPDCMOgK90saQlXp8c+US7efyCzC0SO7Tezoy9ZDqfTw93HKD6ANtxXpGNh/qQFazrH2DXPr31ezkFac4qJ7GET6RYpstCsyIjNmD0kBuGGFJhZVXpQoheC1EuLakEyaU9FlN99FFStbNFtmd65qNwtjId392Wbyldhn/pcBP8wmXx1btFgSmF933VyX7WfSE4t0kcrP5ceCPh/FqnSO3BH1CfT4DNIPS2xVZaJWVNE9iyLa3WRz5n1vQQy6ekWDyK9Cuhetet3oWvkHtyGBnXunOOPnYVv8lAtYsCOyCcDPqPWa5/b1flz3WpiOZUEpClR9m5jckLR320sThYej32t7K4JejHRn+oAfFDtheVOEG527COGHwCL6xBrkPR9JTpd9MPwf8sMkK04rqp2kwnC+TntwFBwv/OC+7+vYgglBF1PHBxrJ5+Q7Js1j4c7kROleVmPHTXtbpY60hY0GakKdqr3g0xGMctLmbARK/joHlZm5L+j/qVb2RMoNMQ4KaCh1SV0s8RQ64daP9T6b1frvyYCh+o/VP//z+r/fQyTvvvJxFHzf3CF/FdYmWf0CjuHT+gaPJx6uoahRxh6hKFHGOYBQ0cwdATDPOB7mwfgmdfP+GngC9IhKeMCkhF5rzTutowLQ5h2eeWBJ5C0ErbjSCKVrJ78QaHQKhKQ944f2vJNyZXfWfMlPjWh2/3GyHOfX787J399/dMvd3/KrC1MOB4vl8uRTuMzSLhVeqT0YqzTGP/ivj+PyG0GGjPwikRAWJI4zZloZ0tTQMxTHjc/S9diE4SI1+9Ir+BWu5Da5J5S8w7CpuTT9awB86rpIHZY0/Y1DdfKhJFg8p5usXEMx1NiyjxnegPgXQb4W75ltjTPzZ1/v729Ip4EiVUC25CsGaESOZd4YYKGryeTgNbXJ2j482TiQhQ9foImksBjIVjd5e2pwyXJt7h1inFpLJPxS3lGab7g+3x3Y7kG8YXXqInHV/3xWDcuRLD43mCPxBPCSpsh17i5HgNOCCZckzAE2RBkQ5D1B9mPXby/UzriSQLSwXMTb9wQqSxhQqglJENcDXE1xNWhuPqpr5mc4ojFgkYcgtZKExXHpdaQYMcuHPkYjGl4N9/Qh0ZxiLUh1g7EWhXQHGym8Op9oYyDDrMZDem4+eJ21poZjf03N4pXcTWOLdxMqNSChnTtg6cKx+N1poytwnWhtK3GD+iZB6Y5i4THIy77IGvAI1TMROYF6DoRF9oDmXM/OCZvyPXlzS35G7OwZCtn1GJz074h/WbyZtJLFbceoDi9mhGvoYdgKy00ZDG+e8n6zacQrnCIYSAuNberGzzmzRMB06CnJfphA42an6OOn/0mGtT/edcA5h//unU+x5R2vX3P4fKR5YUPyPYl4d6RyeTQbdgtPv0wbft5Mwprnd2fU7UD58B4ZNKeKbVeSfDvT8w37zZslu62t/39Bf3J5gr9ZO9q+3ztzd2+Qo7PKheKqXK2rgOl67W2jnQyetUNyquZyy2xyvNSugIjF2TJbUZYCwWxKE19W1rwGHCAEq4bczbbfvMr5Pd6MPhqhAj2YdbUlQW3WRmNYpWP699RNv9GQkXjnHE5rlmY8fn0/acPF9Oz32bnlx9uLs9ejSYj++gH6hj3OZMtOdyAp3dovK/2eltZ/7tXcmqUW3i040IwLtHtTuN1nZHmtC8j0cal+HaIzytzul4jr09aVBU+dnMmGs7vtmkIP1UBzYAlHhv0HvFHz702Z7coDm4XpRuQ799WrYLmxDSOobBP7r1rJdmrjze3GLT1q0e5SvCMZkt8LYktaUgpvhLldcN3k/DZmgomF6UDOvU08c9/APxmwbo= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query decision definitions

+ Search for decision definitions based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Decision definition search filter. - -
- -The decision definition search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision definitions. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision definitions. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision definitions. - -
  • Array [
  • ]
- -The decision definition 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-decision-instances.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx index acb009840c4..ae608f8a83a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx @@ -5,107 +5,912 @@ description: "Search for decision instances based on given criteria." sidebar_label: "Query decision instances" hide_title: true hide_table_of_contents: true -api: eJztXG1v2zgS/isE0Q+7OMd2umm36/vkOs6et2maS5zu4dJgS0tjm1uKVEnKiWH4vx+GlGzJkl/STXuHngoEtU0OZ4bzwuEjkQtq2cTQzi09hYAbriTh0lgmA6B3Dapi0MxyJQch7dAxl2HWbZD2MrRBQzCB5jH2ox16DUwHUzJWmoSbYxoyYgZCoiSZ8BlIEmhuQXPW/CBpg2r4nICxr1U4p52F+8o1hLQzZsJAgwZKWpAW21gcCx442Vp/GmS8oCaYQsRcqxDvxrRzu6B2HgPtUDX6EwJLGzTWqJPlYByF0m60DQ2UtmTMQYRr+WgjG4ppzea0QbmFyDyGmRuxzG04hZSZVQQFIqN5jp2xmssJXTao0iHoanrXRLgk91MeTFcD2SkQDYJZCD0LHBdkEqHBu9c92qCn/eseWjqEMUuEpZ30d8utgHQu3uHofSRbLhs5q9ymKt3lujvj/zMBPUfKK29QurxDyphNoCz/JZtw6QxZmO2DZ1WrqHpSuAzhgagxcZZyk2KZtsQ4GbmcEKTNTTWXFiagaYOOlY6Y9T/99BwnX/CIV7gK8onYA4+SiMgkGoEuMNRgE43uT5REU7jZOJCjF7M7tlVGH6xU8tHGsFuT9JT29nZtaP6PghmLpnjPRALmI0lnb45yMhJrmHGVmGwcDSZW0sAufy/aY7kS9TWMla4w8KasI9evUtgx119b2mWls16yCaydtVGhYwXRdoJy6ItKM6L7lJJkpp0nMsVgKNKXknaRNjcvWwQLN9L5G5jnJq3aPV+elHI+6vEJnJVslUpNcqEsEDtlmJS4IdwQqXyCSiT/nADhIUjLx9xHEDbgdzsn3BoQ4797B9mUdxB+JAb0DAxhxnWJNY+YnufGw7Vl2SipOghzmqZZtkqvwel2tVycWmYrvB5JXdMO6nUy7r/vnt90h/1T2qBn3cG5+3BzcX3Z7w3OBum3Nxfvfr/IZ9vNxfga+flE3aAwYyJxefWMcZH4yNyv7pqMjD3dbvXX/U+3zkNuzHDfjGx1dWbhyPII1jnhntspGSdCEBbOkD7M3D9gMRtxwdHNq4JASSguLqsJWTl6mPGjy8amLN2M3arTwQH3DD6X56g3heCTcSUTfE6Y4Jly3qHVjIcQEpxEKFcGW2Smz+QeVlw+ITN44Maarfy4t3iQaA3Srk3oyXJ8RkoJYC5gn00qFtxfNTALGlOJJIGKYqa5UfIJNJhUeW+BXWaep+UrKrQ8V/dfRUdRpWOO2dfRkMt9frHyh4jZYIrJXK4WkyJbc8Bav1Oe/FqexTHmliGP4Mwv08t8ii00XaZyYkHrIjsAY05hzCVHvZ5m9UyHJeFqXJdo05+fdqXOeBVSepaXS4odtOjvSuLnSk428veIGR789QS+dQLK2ft1kaNAmX5wnX/8b6TxHZI/cQ7fyelrJPBvHfjbFcxHvbM/emJFuG+0FeO9HBePryFP317kIqVy0AsWHVirSRbBIwZ+D9pwD5Xs239WcZt58nK8VzIbOg5VOQN5VyWNrBY+7fcG14N3F38Mu6/P+7RBzwfD/lX3/I/+vy6v+tfY9JjiuChSVh1bkEzaQ+3ne+/ZCiy3F+bem4poyNYivmKDufTAi9/tOo9/3m4/cjupwSTCeqDtYCBtMwseisrshXq49B6Hn9lIJX4vWBB15873C4baLbFVlolBllA25hXbUlTHJSoEj1w6LMODu5LsBryxZdOIyJ1PeZm3OTrHH6Ekj+qhWsSAbZIbA+mm2rd9zMMxH1NsEfETSUCaBGUvI1EHoDxFJOlg4ZHssbI71OvJRN8F+fiQ2gjJQgiuemx6DN/iLA4STJ2kjIAfLvjh0fb/C21kmMMBlf8esGMPMPHtAJW6yvh+qgyf6g6b5jQt7vSNb1u14Gr4mlXmvt248Q6Z/ndRYrp/R3+YXl+yf3/cyIft1r/IGPs9orig7qxes6Vz2SiUmTMZNgMWJTJkTRbz5ieYm6Z/eva3cgkaQqwhwGeYtGN1AuVCri5K66K0LkrrorQuSuuitC5K66L0u36Z4YAy9ft78PREJtzvWReuCn0Dc/PoMrdAekDB62OkouCty9u6vK3L27q8rcvburyty9u6vK0x1xpz/QLMFSlOHv2WwGccxSVNCJvkrdLY1zIuDGE6907Ouq5w/MhIhfOd7xbEWo0ERJUAb+HdWnLpe6Z8iV9/0Yl8x5Hnfnt11iO/nLz4+e6HqbWx6bRa9/f3TT0OjiDkVumm0pOWHgf4h/1+bJLhFDQWCnMyAsLC0FmOCbKOM2JiCPiYB9mRhFRsl9q8fntK2jQ5bl0cE81LftElN1eDLC7mWaFbYE3zR3Rcxd0ZCSY/0bVf7PO+LjFJ5CJw7do5Bmntkex/oWrLKvKP4fCS+CFIoEJwL6i5nJIyQiUiLvGwDO2ctNsNmh6doZ2X7bYLK7T4AZpIAg+xYOlmZEMdLkm09lun2OpM29NYRmk+4Zt8i1GcOvGp1yiLxuPqaEzrayIYvho3Y4KHhCV2ilyD7GgUOCGYcNVsHWR1kNVBVh1kP5X9/UzpEQ9DkM49V/GW1jpMCHUPYR1XdVzVcbUtrl5UlZJdLCAtaPRD0FppogL3iniIJ5HFqnrOeGdAUl0o1rFWx9qWWFs2aAR2qvDKhVgZ5zrMTmmHtrJt29EK2mz5fRvFQ9gacRwHXSZa0A5d+NBZdlqtxVQZu+wsYqXtsjVDu8yY5mwkvDdisw+xzHWECpiYevZlE2JDHqPq+acb5BW56l8Pya/Mwj2b+z346o6FbOhX7VftylGx65YRu5cDDyd40CCfFLJhMborh/WdDxl4iaiLgSDR3M6vkcxPzwiYBt1N0Aorx0j5udHxu+9EG+mHs8xdfvt96CyOCe1qfcNF/4FFsQ/H/PHwCoynXX14ee2ZFShpVaMHbunz9vOTo+PnR8e/DI9fdNo/d07azXb75b/pNiymXQ2k5MQqE1Qjqvk4rQZHd/VYoZztPCqXuyHDX+dxu7pqY9V0t758wt8X0V7d6NDeuGnhduF9IH+jAf62dNlhrJwDpLFbdiWMq0xK2m4el/PE5cClu0BFUSLdmicn/uwWy7lmIBKTHkQTPABEdDoLKv0UZd3OfQtJ54UcNzGsfOxnS92E22kyagYqaqVPIFf/j4QatSLGZStlYVq97tubi9Pu0fmg17+47h8dN9tN++AfRWEqipjMyeEQp4rHLZtKL9ZL/V+5HSYNOwsPthULxt0ZM6ftIk2Qt7ScIGlmTESQfZq7pYsFcrrRYrnEnx3oRTu3d+usiN+WDToFFnqvoJ/Qs2nPa3LkQHDsLhL3WGnzFA0eO/QU3SCA2O7se5fL+JfvroeYQ9I7cCIVIo1m93g/DrunHfqBfqB4BNLNrktP7vcFFUxOEufm1I+L//4DkwAUzg== +api: eJztXG1v2zgS/isE0Q+7OMd2su226/vkOs6er2maS5zu4XLBlpbGNrcUqZCUE8Pwfz8MKdmSJb+km/YOPRUIapsczgznhcNHIhfUsomhnVt6CgE3XEnCpbFMBkDvGlTFoJnlSg5C2qFjLsOs2yDtZWiDhmACzWPsRzv0GpgOpmSsNAk3xzRkxAyEREky4TOQJNDcguas+W9JG1TDfQLGvlXhnHYW7ivXENLOmAkDDRooaUFabGNxLHjgZGv9YZDxgppgChFzrUJ8GNPO7YLaeQy0Q9XoDwgsbdBYo06Wg3EUSrvRNjRQ2pIxBxGu5aONbCimNZvTBuUWIvMUZm7EMrfhFFJmVhEUiIzmOXbGai4ndNmgSoegq+ldE+GSPEx5MF0NZKdANAhmIfQscFyQSYQG7173aIOe9q97aOkQxiwRlnbS3y23AtK5+ICj95FsuWzkrHKbqnSX6+6M/48E9Bwpr7xB6fIOKWM2gbL8l2zCpTNkYbYPnlWtoupJ4TKER6LGxFnKTYpl2hLjZORyQpA2N9VcWpiApg06Vjpi1v/00wlOvuARr3AV5BOxRx4lEZFJNAJdYKjBJhrdnyiJpnCzcSBHL2Z3bKuMPlip5KONYbcm6Snt7e3a0PyfBDMWTfGRiQTMJ5LO3hzlZCTWMOMqMdk4GkyspIFd/l60x3Il6lsYK11h4E1ZR65fpbBjrr+2tMtKZ71kE1g7a6NCxwqi7QTl0BeVZkT3KSXJTDtPZIrBUKQvJe0ibW5etggWbqTzdzDPTVq1e/78spTzUY/P4Kxkq1Rqkgtlgdgpw6TEDeGGSOUTVCL5fQKEhyAtH3MfQdiA3+2ccGtAjP/qHWRT3kH4iRjQMzCEGdcl1jxiep4bD9eWZaOk6iDMaZpm2Sq9Bqfb1XJxapmt8HokdU07qNfJuP+xe37THfZPaYOedQfn7sPNxfVlvzc4G6Tf3l18+O0in203F+Nr5OcTdYPCjInE5dUzxkXiI3O/umsyMvZ0u9Vf9z/dOg+5McN9M7LV1ZmFI8sjWOeEB26nZJwIQVg4Q/owc/+AxWzEBUc3rwoCJaG4uKwmZOXoYcaPLhubsnQzdqtOBwfcC7gvz1FvCsFn40omuE+Y4Jly3qHVjIcQEpxEKFcGW2SmL+QeVlw+IzN45Maarfy4t3iQaA3Srk3oyXJ8RkoJYC5gX0wqFtxfNTALGlOJJIGKYqa5UfIZNJhUeW+BXWae5+UrKrQ8Vw9fRUdRpWOO2dfRkMt9frHyh4jZYIrJXK4WkyJbc8Bav1Oe/FqexTHmliGP4Mwv08t8ii00XaZyYkHrIjsAY05hzCVHvZ5n9UyHJeFqXJdo05+fd6XOeBVSepaXS4odtOjvSuLnSk428veIGR78+QS+dQLK2fttkaNAmX5wnX/8b6TxHZI/cw7fyelrJPBvHfjbFcxHvbM/emJFuG+0FeO9HBdPryFP31/kIqVy0AsWHVirSRbBEwb+CNpwD5Xs239WcZt58nK8VzIbOg5VOQN5VyWNrBY+7fcG14MPF78Pu2/P+7RBzwfD/lX3/Pf+Py+v+tfY9JTiuChSVh1bkEzaQ+3ne+/ZCiy3F+bem4poyNYivmKDufTAi9/tOo8/abefuJ3UYBJhPdB2MJC2mQUPRWX2Qj1ceo/Dz2ykEr8XLIi6c+f7BUPtltgqy8QgSygb84ptKarjEhWCRy4dluHBXUl2A97YsmlE5M6nvMzbHJ3jj1CSR/VQLWLANsmNgXRT7ds+5eGYTym2iPiJJCBNgrKXkagDUJ4iknSw8Ej2VNkd6vVsou+CfHxIbYRkIQRXPTY9hm9xFgcJpk5SRsAPF/zwaPv/hTYyzOGAyn8P2LEHmPh2gEpdZXw/VYZPdYdNc5oWd/rGt61acDV8yypz327ceIdM/7soMd2/oz9Mry/Zvz9t5MN2619kjP0eUVxQd1av2dK5bBTKzJkMmwGLEhmyJot58zPMTdM/PftLuQQNIdYQ4DNM2rE6gXIhVxeldVFaF6V1UVoXpXVRWheldVH6Xb/McECZ+v09eHomE+73rAtXhb6DuXlymVsgPaDg9TFSUfDW5W1d3tblbV3e1uVtXd7W5W1d3taYa425fgHmihQvn/yWwD2O4pImhE3yXmnsaxkXhjCdeydnXVc4fmSkwvnOdwtirUYCokqAt/BuLbn0PVO+xK+/6ES+48hzv70665FfXr56fffD1NrYdFqth4eHph4HRxByq3RT6UlLjwP8w34/NslwChoLhTkZAWFh6CzHBFnHGTExBHzMg+xIQiq2S21evz0lbZocty6OieYlv+iSm6tBFhfzrNAtsKb5Izqu4u6MBJOf6dov9nlfl5gkchG4du0cg7T2SPa/ULVlFfnbcHhJ/BAkUCG4F9RcTkkZoRIRl3hYhnZettsNmh6doZ2f220XVmjxAzSRBB5jwdLNyIY6XJJo7bdOsdWZtuexjNJ8wjf5FqM4deJTr1EWjcfV0ZjW10QwfDVuxgQPCUvsFLkG2dEocEIw4arZOsjqIKuDrDrIfir7+5nSIx6GIJ17ruItrXWYEOoBwjqu6riq42pbXL2qKiW7WEBa0OiHoLXSRAXuFfEQTyKLVfWc8c6ApLpQrGOtjrUtsbZs0AjsVOGVC7EyznWYndIObWXbtqMVtNny+zaKh7A14jgOuky0oB268KGz7LRai6kydtlZxErbZWuGdpkxzdlIeG/EZh9imesIFTAx9ezLJsSGPEbV8083yBty1b8ekl+ZhQc293vw1R0L2dBv2m/alaNi1y0jdi8HHk7woEE+KWTDYnRXDus7HzLwElEXA0GiuZ1fI5mfnhEwDbqboBVWjpHyc6Pjd9+JNtIPZ5m7/P23obM4JrSr9Q0X/UcWxT4c88fDKzCedvXh5bVnVqCkVY0euKUn7ZOXR+3XRye/DI9fdV4dd07eNNuvj/9Ft2Ex7WogJSdWmaAaUc3HaTU4uqvHCuVs51G53A0Z/jqP29VVG6umu/XlE/6+iPbqRof2xk0LtwvvA/kbDfC3pcsOY+UcII3dsithXGVS0nbzuJwnLgcu3QUqihLp1jw58We3WM41A5GY9CCa4AEgotNZUOmnKOt27ltIOi/kuIlh5WM/W+om3E6TUTNQUSt9Arn6fyTUqBUxLlspC9Pqdd/fXJx2j84Hvf7Fdf/ouNlu2kf/KApTUcRkTg6HOFU8btlUerFe6v/M7TBp2Fl4tK1YMO7OmDltF2mCvKXlBEkzYyKC7NPcLV0skNONFssl/uxAL9q5vVtnRfy2bNApsNB7Bf2Mnk17XpMjB4Jjd5G4x0qbp2jw2KGn6AYBxHZn37tcxr/8cD3EHJLegROpEGk0e8D7cdgD7VA8/uhm1qUm99uCCiYniXNx6sfEf/8BgSQT3g== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query decision instances

+ Search for decision instances based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Decision instance search filter. - -
    evaluationDate object
    - -The evaluation date of the decision instance. - -
    oneOf
    - -string - -
    decisionDefinitionKey object
    - -The key of the decision. - -
    oneOf
    - -integer - -
- -The decision instance search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision instances. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision instances. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision instances. - -
  • Array [
  • ]
- -The decision instance 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-decision-requirements.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx index 8f177b0102a..066484d0f5e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx @@ -5,91 +5,638 @@ description: "Search for decision requirements based on given criteria." sidebar_label: "Query decision requirements" hide_title: true hide_table_of_contents: true -api: eJztW1tz2zYW/isYPO1OaUlp0zbLN8V2drVtHNdWug+KZwIRhxJqEGAA0LJGw//eOQApURJ1STadTqfMjCe2AJz7dz4QhFbUsZml8YReQSKs0IoY+FQIAxkoZ+lDRHUOhjmh1YjTmKZC8XrqXXNmRDnYxIgcp9KY3gMzyZyk2hDeJppMmQVOtCIz8QSKJEY4MIL1PigaUZwJ1r3WfEnjFa0WchqnTFqIaKKVA+VwjOW5FIm3sP+bRd0rapM5ZMyPSvkupfFkRd0yBxpTPf0NEkcjmhv0zAmwfoU2XtqOE9o4kgqQfGMfjWpRzBi2pBEVDjL7Ocq8xH1t4zlUypwmaBCZLhvqrDNCzWgZUW04mPb1fogIRRZzkczXgtwciAHJHPCgAuWCKjJM/fD+kkb06vr+EvPNIWWFdDSuPnfCSahi8Q6lX+OysowaWZlULj00pvv8/1KAWeLKu5BQWj7gypzNYN/+WzYTyidyK9pnR9XorD0oQnF4JjolPlM+KI4ZR6y3UagZwbWNUAvlYAaGRjTVJmMufPTdtxh8KTLRUiqoJ2PPIisyoopsCmZLoQFXGIWJ0QpIVd5nagxmDlPXlvTR2qUAOIbTeuRSm5BvP4bp/yiZdZiKX5kswH4kVfSWaCcjuYEnoQtbyzFgc60sHKv37XyUa1NfQ6pNS4J3bZ36ea3GpsL80daWrcV6y2awKdaoxceWRYcX7ENftqYRy2fdJzmkQgkPhMq/sMxuw2FbQmsD317fiM4B83hLa/8Jlo3wtRfqDy/3CAA9YtaKmQJOHmEZVS2JJc4SZgkjhRKfCiCCg3IiFWA8W7i5sO2U0UMwKJZBw5yqKbYpv3p7Q3A2VoxrhndP5hMYKwJznILjUS8rOacVtoV5xE+75Sq3RlendThQTLlzpKIPYfYZghsAaNsHvPGFtt3tj81vA1EZyCUg2pflt4PBCci0Fb0BW0gXNhRnbxh28XEu+5ykNKFCKeHvbKqLQMpbph7F9xeIOm6x047JUd0dd2KLYxV7ZcwFkkQlLduggx2hjOhOG29Pot+hPPkJdfX5dV4/UmbYvaBbxILrkfcWQpuoxj42aedjtYdCnlAElC3Q9n3GPYPNthnzbONx2efa7tn9q5l+jNoCrHaguQXD9YzdihEHisVvfaoiOdA3zrX9cP2/ZhbIxh7PFW0dBSv6dPH/rWlk/Bk0YsDqwiRwc3bAmsGqV/sNdv1McpDgyYJZkjNjgf+JFIYFhMXWAoDT26Mj9n31zdAZfmz3gpMEXCO/jLZY8knxXsKyQnHWY7noPcLS9sJDzjf7DMohN5DgoyaNnSlgH4odp3ac2nHqH8ipnwPBjmU7lv2rseyfewhxhmc3nhx/gqX9IgbeWn4GF4d8tXBxx7wd83bM2z3Ndjzb8ezf92kWV708dIRcEc0nXENSJiTwHnmrDUbcMSEtYcZD9Ulw4I0m6KWTqebLo0fMudFTCVnrg3LTliG5DTMrvSRgHeMZJk6D9sndm0vyr5ff//jwj7lzuY37/cVi0TNpcgFcOG162sz6Jk3wB+f9s0fGczDY1ZZkCoRx7t8tMdlsQDaHRKQiqd/AVWYTrITg3wn+9aP7lbNuFYURe4U0JO/vRnWVLGtW3lJNm2+k/fYgnkqmHummEk6V65DYIsuYWdZQ2laAry0dc4X90lb3n/H4lgQRJNEcNrVeKUInMqHw3TCNXw4GEa3eFNP4h8HAtz7M+BmeKALPuWTVzmnHHaFItqlb75hQ1jGVfK3MaCNmYlfvNnarIr4KHtXYe9GOvWozQCRLHi3uOwQnrHBz1JrUNwHAG8Gk590OZB3IOpC1g+y7/Xp/o81UcA7Kl+cab8ISpR1hUuoF8A5XHa46XB3C1fdtG8chHls4MFiHYIw2RCdJYQxw3ApLLz4Ba2vd9VNvt1HssNZh7QDWyohm4OYa7xnn2vrSYW5OY9qvHxovmg+N/fDoRvHaocFjBn/OUhhJY7oK6Cnjfn8119aV8SrXxpX9J0zNEzOCTWUoSBwOKKurR+qEyXmwYD+LONA8FbgMp7HkFbm7vh+TfzMHC7b0Uc3Xt4pr0a8GrwatUnHqAYnD2xEJHoYabPSFWiwCvFVsmHyO4BIPCCwkhRFueY/LQnimwAyYYYGJWNdGpc9Lx7/DJBpVv7ypK+a//xv7pGNPu9vc6b5+ZlkeENm8EHngOGJQ3/rblOT6cGpw+NxoM3tz8tK4RB1ufE/Wt7HXQw+b+8nhSvFgfel3sHMZd7IKQWteesXPSo+oVPuIVfW+H/umH3TQe7GPrduRbxGJzrJCeZ5QM7IQbk5YI5eJLGx1u1OKBPDMY30muFb7cxghv1bHcS96WIcBLDU9zISbF9NeorN+9Yph/f9U6mk/Y0L1KxW2fzl8+/7manjx8+jy+ub++uJFb9Bzz+GsGeGbMdWww5/JtB/+7Pq92jDk//k1gqpaHTy7fi6ZUJh47/Oqai0T2tpaaJ1VvNIeGsSErlao7L2RZYkf+xMjGk8eNv0E/yojOgfGQ3nQRyxgehn8uRijPThdFv70ePcmYhnVK4ZJArk7Oveh0S5v392PEX3V9yUyzXGNYQv8LgVb0Jh+oB8oxW9zoAQPbP/5ikqmZoWvdxrk4r/fAZofoZU= +api: eJztW1tz2zYW/isYPG1naUlp026Wb4rttNomjtdW2gfVM4GIQwk1CDAAaFmj4X/fOQApURJ1SZpOZ6fMjCe2AJz7dz4QhFbUsZml8YReQSKs0IoY+FQIAxkoZ+lDRHUOhjmh1YjTmKZC8XrqXXNmRDnYxIgcp9KY3gMzyZyk2hDeJppMmQVOtCIz8QSKJEY4MIL1flM0ojgTrHut+ZLGK1ot5DROmbQQ0UQrB8rhGMtzKRJvYf93i7pX1CZzyJgflfJ9SuPJirplDjSmevo7JI5GNDfomRNg/QptvLQdJ7RxJBUg+cY+GtWimDFsSSMqHGT2c5R5ifvaxnOolDlN0CAyXTbUWWeEmtEyotpwMO3r/RARiizmIpmvBbk5EAOSOeBBBcoFVWSY+uH9JY3o1fX9JeabQ8oK6Whcfe6Ek1DF4j1Kv8ZlZRk1sjKpXHpoTPf5/28BZokr70JCafmAK3M2g337b9lMKJ/IrWifHVWjs/agCMXhmeiU+Ez5oDhmHLHeRqFmBNc2Qi2UgxkYGtFUm4y58NF332LwpchES6mgnow9i6zIiCqyKZgthQZcYRQmRisgVXmfqTGYOUxdW9JHa5cC4BhO65FLbUK+/Rim/6Nk1mEqfmGyAPuRVNFbop2M5AaehC5sLceAzbWycKzet/NRrk19Dak2LQnetXXq57UamwrzZ1tbthbrLZvBplijFh9bFh1esA992ZpGLJ91n+SQCiU8ECr/wjK7DYdtCa0NfHt9IzoHzOMtrf1nWDbC116oP7zcIwD0iFkrZgo4eYRlVLUkljhLmCWMFEp8KoAIDsqJVIDxbOHmwrZTRg/BoFgGDXOqptim/OrdDcHZWDGuGd49mU9grAjMcQqOR72s5JxW2BbmET/tlqvcGl2d1uFAMeXOkYo+hNlnCG4AoG0f8MYX2na3Pza/DURlIJeAaF+W3w4GJyDTVvQGbCFd2FCcvWHYxce57HOS0oQKpYS/s6kuAilvmXoU318g6rjFTjsmR3V33IktjlXslTEXSBKVtGyDDnaEMqI7bbw9iX6H8uQn1NXn13n9SJlh94JuEQuuRz5YCG2iGvvYpJ2P1R4KeUIRULZA2/cZ9ww222bMs43HZZ9ru2f3r2b6MWoLsNqB5hYM1zN2K0YcKBa/9amK5EDfONf2w/X/mlkgG3s8V7R1FKzo08X/t6aR8WfQiAGrC5PAzdkBawarXu032PUzyUGCJwtmSc6MBf4XUhgWEBZbCwBOb4+O2PfVN0Nn+LHdC04ScI38MtpiySfFewnLCsVZj+Wi9whL2wsPOf/cZ1AOuYEEHzVp7EwB+1DsOLXj1I5T/0RO/RwIdizbsez/G8v+tYcQZ3h248nxZ1jaL2LgreVncHHIVwsXd8zbMW/HvN3TbMezHc/+fZ9mcdXLQ0fIFdF8wjUkZUIC75F32mDEHRPSEmY8VJ8EB95ogl46mWq+PHrEnBs9lZC1Pig3bRmS2zCz0ksC1jGeYeI0aJ/cvbkk/375/b8e/jF3Lrdxv79YLHomTS6AC6dNT5tZ36QJ/uC8b3pkPAeDXW1JpkAY5/7dEpPNBmRzSEQqkvoNXGU2wUoI/p3gXz+6XznrVlEYsVdIQ/LhblRXybJm5S3VtPlG2m8P4qlk6pFuKuFUuQ6JLbKMmWUNpW0F+NrSMVfYL211P43HtySIIInmsKn1ShE6kQmF74Zp/HIwiGj1ppjGPwwGvvVhxs/wRBF4ziWrdk477ghFsk3deseEso6p5GtlRhsxE7t6t7FbFfFV8KjG3ot27FWbASJZ8mhx3yE4YYWbo9akvgkA3ggmPe92IOtA1oGsHWTf7df7G22mgnNQvjzXeBOWKO0Ik1IvgHe46nDV4eoQrr5v2zgO8djCgcE6BGO0ITpJCmOA41ZYevEJWFvrrp96u41ih7UOawewVkY0AzfXeM8419aXDnNzGtN+/dB40Xxo7IdHN4rXDg0eM/hzlsJIGtNVQE8Z9/urubaujFe5Nq7sP2FqnpgRbCpDQeJwQFldPVInTM6DBftZxIHmqcBlOI0lr8jd9f2Y/MgcLNjSRzVf3yquRb8avBq0SsWpByQOb0ckeBhqsNEXarEI8FaxYfI5gks8ILCQFEa45T0uC+GZAjNghgUmYl0blT4vHf8Ok2hU/fKmrpj//Dr2Sceedre50339zLI8ILJ5IfLAccSgvvW3Kcn14dTg8LnRZvbm5KVxiTrc+J6sb2Ovhx4295PDleLB+tLvYOcy7mQVgta89IqflR5RqfYRq+p9P/ZNP+ig92IfW7cj3yISnWWF8jyhZmQh3JywRi4TWdjqdqcUCeCZx/pMcK32bRghv1THcS96WIcBLDU9zISbF9NeorN+9Yph/f9U6mk/Y0L1KxW2fzl89+HmanjxdnR5fXN/ffGiN+i553DWjPDNmGrY4c9k2g9/dv1ebRjyD36NoKpWB8+un0smFCbe+7yqWsuEtrYWWmcVr7SHBjGhqxUq+2BkWeLH/sSIxpOHTT/Bv8qIzoHxUB70EQuYXgZ/LsZoD06XhT893r2JWEb1imGSQO6Ozn1otMvb9/djRF/1fYlMc1xj2AK/S8EWNKYUv8mBqz2o/WcrKpmaFb7WaZCJ//4HJrGgmQ== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query decision requirements

+ Search for decision requirements based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Decision requirements search filter. - -
- -The decision requirements search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision requirements. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision requirements. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching decision requirements. - -
  • Array [
  • ]
- -The 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-flow-node-instances.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx index 4b02b0715cb..43cf664bc2f 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx @@ -5,91 +5,879 @@ description: "Search for flow node instances based on given criteria." sidebar_label: "Query flow node instances" hide_title: true hide_table_of_contents: true -api: eJztXP9z2jgW/1c0+ulujgDd7e72+M0BZ+srJRRDejtpJhW2AG1tyZXkEIbhf795km0MGEK66V1nzp3pxNa396T3RZ/3hLzGmswV7tziq0gsERchRYwrTXhA8V0Di4RKopngXog7eMZ4CO0GIqRe1krhBg6pCiRLoB3uYJ8SGSzQTEg0OxhUoSlRNESCozl7oBwFkmkqGWl+4riBJf2aUqUvRbjCnbV5ZZKGuDMjkaINHAiuKddQR5IkYoFhrvWnAsprrIIFjQk87bJ0ODmkLJcZQdzAJIquZ7hzu8Z6lVDcwWL6Jw2gJpGwDJpRZWgIqQ8p+EJqNGM0Crczwo18KCIlWeEGZprGZpBziZkRD6mNFzQjpgUChtB0VSKntGR8jjcNLGRIZXV/U4UYR8sFCxbFQHpBkaQR0TS0JGBcytMYlMTxu7iBe67fBeUI6YykkcadrFwzHdFsLa5hdBe6bTaNkhxvsyndlZobSXxIqVxBz1Emkc0d9EzInB7yPyRzxo3od1b77FWVIq5eFMZD+ojEDBlJmUXRROpMWxifI+hbWmrGNZ1TiRt4JmRMtC36+SdY/IjFrEJVgE5MHlmcxoin8ZTKHYKS6lRyEIzgNNfPMylaNp2ZrhK6V0zJqj6BZk3UFdLK29SB+D9HRGkQxQ2JUqo+o2z1VsAnQYmkD0ykamtCKhFc0VP6viuPTcHqJZ0JWSHgfV6npl0lszMmvze3m0plHZI53Spro2KOFZ2Odzg0/ahSjMb2j/oz20vtWsOTztD2Ki3JMZ72nP87uiqt11YzDzkmSrE5pyH6QleNzOWQQCtEFCIo5exrShELKddsxqg0u4deMFUx1eae6v/6GlQ/kSKgSj2fs6zjdjG+0BWwKwJmnKDRs+cz0qMzxhnQeT4rYdH3xZnxjuwmFaS93vmUDzYepYmusGsfisEwKzSYZNRpiBTV0OjBWPTh+KUNqTv2blzcwN3r98O+O3Z7uIHH7ui9N3Dg5W6T9z2Y9CrZY+Rb6E8G/tDteleeITwcXXdd38cN7E8u77dv7o07GN/vlvljZzS+NzW4gb0BMO32PGfs3nedcfdtddX47ej6Y1F1eT0Z9JzRH0WBO+gVz747uvG67v3Y8d/hBh65Xde7KV4nvjvKn987g4nTz9+yP+6/u/2JDz1+d8buR+cPw8ph2dAZOf2+2y8V2eleOr7bK5X67oeJO+i691f9649AddIfe/fewB87UHp53YNWXaffvzdS9cbwfjnxvYHr+/ejSb9g3u+OvOG4eINZ59MavBtcfxwYuRfOKiyZXyHBU07V6532P6XBBySmzx2ek9gOsiDK44HxeqUxpkJElPBDXL0QS4WWC6oX9ChzaAEOFeCDHbfAcloYknn5+U4JPBDgk3xANsug57ZEIS3TIx5IU064PuZ2bC3yehVOpLSB7gcdV2a/2kWKx9pWbb4bC0otEjA720/t9nO3WklVGmkbt5wdl+zvr+dC1idxMON27eGZTEVqkfwOqydRwTcMdZpjLTSJvBxS7S0s1GWQNybaImsgUhE7VeNdq1x72K9agiassa4cFFmb2EkqbegDzrYhD0wLHH8TTRS15pXVfS5j1c+Z9gO45IhylQLvhzD9DAi8C7PPZh66PZd3ExK8GOun8LC1qT2b3LHBosW+xrAjymLipUxJKjIK53N+XPsviaJoy41x//uOBHT5abX/XyIuqXuVqAtKYePgld4M+tGwCuUUBhcSTS80iykQojz8BjIwSbV4Dp3d/fuv7NcVq7W/fz+1Xz+bQI06/z9R5w8U+OzByxdAk03kzQzWQyRSolzzjq4AByZSPLBwx8pzOHs+Fsw3uoLqs7AhuGlw5xUbzOn0xQns/qLZi6PJipfOTRz4pGOpiZfPRByQ3os79rJ9eSSxR2PJ9OIZVJ5Qil3gcjJMyCHKprED5x942AxInPKQNEnCml/oSjVtCvcfVUcQiaQBTAR3wGYOkUMN/mvwX4P/7wb+n2OAdThQhwN1OFCHA3U4UIcDP+xp5ncKEE6BrP96yHCKme8ZRByn+4RyDQz+f0dX6tkBxk7XM0INq+4VoUYdWNSBRR1Y1KcKdRhRhxF1GFGHEXUY8cOEEfWpQn2qsH+qAD1eH/vB0fG7Cl9hGDQjLKJhE70XkqKQasIihYikhZWUAJwhiKYiXJ38mVIixTSiceUZRpk9Bw1ty4wusmjFuhpoOLXUb0dXXfTP17/8dve3hdaJ6rRay+WyKWfBBQ2ZFrIp5LwlZwH8h3Z/b6LxgkpAZCs0pYiEoVEPEpXhk0powGYsyH/6nbGNQGB2fk/EDtnmeRQopJIdGKqDJiMvt8JVHlHskMblqxAmtOlMI8K/4K1iPOUOHKTSOCZylXupXQLZDpCW0efRewBVrubteDxEdggUgG4VviQjBJOIGYdLCbjzut1u4OyKAu782m5vYEyQ+Bkz4Yg+JhHJor696TCO4q3eZr9IzK4bvYxkhGRztk+3uWPGmRL37Ixyc3xVbY5ZIIMiEnxRsIWyEJFUL4BqkF9BoYYJEpnNtTay2shqI6s2sp8P9f1KyCkLQ8qNehb2xhTiQiMSRWJpkV9tV7Vd1XZVZVe/VGFJB8IoTSXoIZVSSCSCIJUSEPCCRQUaz2nnGbsaKNa2VtvaEVvbNHBM9ULAbfhEmHvjCdEL3MEtCCYhbLsoUsgtG7dhuOwqH6hUJkWcygh38NqazqbTaq0XQulNZ50IqTetB5DLA5GMTCOrjVBtTSxXnUgEJFpY8ocihAqTXMym1rXHSOgNGrn+GP1ONF2Slc0YFHfZ86HftN+0q+8mwpFB9YjO0EN2hlYBS04hHxasu3JY2/icgTeQeVE0SCXTKx+62eWZUiKpdFKQQqEYGT0zukkXmUa4kT1c5eryr49jI3FwaKPttwfcRxIn1hy313Ar8zzt6rRL+1hapKrCfFuhUOUs1bfNxWVT2k3PltPYJTPYyT9vy3dydvanUDupk3Y5i1bO/hv9uC2+Q1BU3W1v5tvL9O3iunt77xr67doKrnzdG8o2xqRnwkgtM7hD+YMxUKmswrSbrw6Ne+gZHxWIOE652aj43OZ4SEmfgihV2RXniAUU8jCdNeZ2nfJmfVuDbixF9KoJtmANNt+f5kwv0mkzEHErO58t/k4jMW3FhPFWRkK1us57SGtf9L2uO/Ddi1fNdlM/2oM68B8x4SU+PtgEz+Fh1P6s19sN+i99biNTLU0fdSuJCDP5VDPfdebXbvGhX8O5OOErDtY73eL1GihNZLTZQLHJVeHO7d3WmcEb5I8pCa1e4C+ge7hrp3IBpxjG90WpOXXbv0e3aeQ9nCCgiT7Z9q7kqIfXPhwiTLOPisQihD6SLOGDI2SJO/gT/oQxfO0ERjBexZSvcUT4PDWKju248O8/q8m8IQ== +api: eJztXP9z2jgW/1c0+ulujgDd7e71+M0BZ+srJRRDeju5TCpsAdrYEpXkEIbhf795km0MNoR007vOnDvTia1v70nviz7vCXmDNZkr3LnFV5FYIS5CihhXmvCA4rsGFksqiWaCeyHu4BnjIbQbiJB6aSuFGzikKpBsCe1wB/uUyGCBZkKiWWlQhaZE0RAJjubskXIUSKapZKT5b44bWNKvCVX6UoRr3NmYVyZpiDszEinawIHgmnINdWS5jFhgmGv9oYDyBqtgQWMCT/sslSeHlOUyJYgbmETR9Qx3bjdYr5cUd7CY/kEDqFlKWAbNqDI0hNRlCr6QGs0YjcLdjHAjG4pISda4gZmmsRnkXGJmxDK18YKmxLRAwBCargvklJaMz/G2gYUMqazub6oQ42i1YMEiH0gvKJI0IpqGlgSMS3kSg5I4fhc3cM/1u6AcIZ2RJNK4k5ZrpiOarsU1jO5Ct+22UZDjbTqlu0JzI4lPCZVr6DlKJbK9g55LMqdl/odkzrgR/d5qn72qUsTVi8J4SJ+QmCEjKbMomkidagvjcwR9C0vNuKZzKnEDz4SMibZFP/8Eix+xmFWoCtCJyROLkxjxJJ5SuUdQUp1IDoIRnGb6eSZFy6Yz01VC9/IpWdUn0KyJukJaeZs6EP+XiCgNorghUULVF5Su3hr4JGgp6SMTidqZkFoKrugpfd+XxzZn9ZLOhKwQ8CGvU9OuktkZk9+b222lsg7JnO6UtVExx4pOxzuUTT+qFKOx/aP+zPZS+9bwrDO0vQpLcoynA+f/ga4L67XTzDLHRCk25zRED3TdSF0OCbRCRCGCEs6+JhSxkHLNZoxKs3voBVMVU20eqP6vb0H1l1IEVKmXc5Z23C3GA10DuyJgxgkaPXs5Iz06Y5wBnZezEuZ9X50Z78huUkHa651PubTxKE10hV37UAyGWaHBJKVOQ6SohkaPxqLL4xc2pO7Yu3FxA3evPw777tjt4QYeu6OP3sCBl7tt1rc06fXygJFvoT8Z+EO36115hvBwdN11fR83sD+5vN+9uTfuYHy/X+aPndH43tTgBvYGwLTb85yxe991xt331VXj96Prz3nV5fVk0HNGv+cF7qCXP/vu6Mbruvdjx/+AG3jkdl3vJn+d+O4oe/7oDCZOP3tL/7j/6vYnPvT4zRm7n53fDSvlsqEzcvp9t18ostO9dHy3Vyj13U8Td9B176/615+B6qQ/9u69gT92oPTyugetuk6/f2+k6o3h/XLiewPX9+9Hk37OvN8decNx/gazzqY1+DC4/jwwcs+dVVgwv1yCp5yq1zvtfwqDD0hMXzo8J7EdZEGUxwPj9QpjTIWIKOFlXL0QK4VWC6oX9ChzaAEOFeCDHTfHcloYkln5+U4JPBDgk2xANkuh565EIS2TIx5IU064PuZ2bC3yehVOpLCBHgYdV2a/2keKx9pWbb5bC0otEjA720/t9ku3WklVEmkbt5wdlxzur+dC1mdxMON27eGZTEVikfweqydRwTcMdZpjLTSJvAxSHSws1KWQNybaImsgUhE7VeNdq1wH2K9agiassa4cFFmb2EkqbegDzrYhD0wLHH8TTRS15pXWfSli1S+p9gO45IhylQDvZZh+BgTeh9lnMw/dXsq7CQlejfVTeNja1IFN7tlg3uJQY9gRZTHxUqokFRmF8zk/rv2XRFG048a4/0NHArr8vNr/LxGX1L1K1AWlsHHwSm8G/WhYhXJygwuJpheaxRQIUR5+AxmYpFq8hM7+/v1n9uuK1Trcv5/br19MoEad/5+o8wcKfA7g5SugySbyZgbrIRIpUaz5QNeAA5dSPLJwz8ozOHs+Fsw2upzqi7AhuGlw5xUbzOn0xQns/qrZi6PJitfOTZR80rHUxOtnIkqkD+KOg2xfFkkc0FgxvXgBlWeUYh+4nAwTMoiybezB+UceNgMSJzwkTbJkzQe6Vk2bwv1b1RHEUtIAJoI7YDNl5FCD/xr81+D/u4H/lxhgHQ7U4UAdDtThQB0O1OHAD3ua+Z0ChFMg678eMpxi5nsGEcfpPqNcA4P/P9C1enGAsdf1jFDDqntFqFEHFnVgUQcW9alCHUbUYUQdRtRhRB1G/DBhRH2qUJ8qHJ4qQI+3x35wdPyuwlcYBs0Ii2jYRB+FpCikmrBIISJpbiUFAGcIoqkI1yd/prSUYhrRuPIMo8ieg4a2ZUoXWbRiXQ00nFrqt6OrLvrH21/+fveXhdZL1Wm1VqtVU86CCxoyLWRTyHlLzgL4D+3+2kTjBZWAyNZoShEJQ6MeJCrCJ7WkAZuxIPvpd8o2AoHZ+T0TO6Sb51GgkEhWMlQHTUZeZoXrLKLYI42LVyFMaNOZRoQ/4J1iPOcOHKSSOCZynXmpfQLpDpAU0efRewBVrub9eDxEdggUgG7lviQlBJOIGYdLCbjztt1u4PSKAu782m5vYUyQ+Bkz4Yg+LSOSRn0H02EcxTu9TX+RmF43eh3JCMnm7JBuc8+MUyXu2Rll5vim2hzTQAZFJHhQsIWyEJFEL4BqkF1BoYYJEpnNtTay2shqI6s2sp/L+n4l5JSFIeVGPXN7YwpxoRGJIrGyyK+2q9quaruqsqtfqrCkA2GUphL0kEopJBJBkEgJCHjBohyNZ7SzjF0NFGtbq23tiK1tGzimeiHgNvxSmHvjS6IXuINbEExC2HaRp5BbNm7DcNlVPlKpTIo4kRHu4I01nW2n1doshNLbzmYppN62HkEuj0QyMo2sNkK1NbFMdSIRkGhhyZdFCBUmuZhOrWuPkdA7NHL9MfqNaLoia5sxyO+yZ0O/a79rV99NhCOD6hGdoYfsDK0CFpxCNixYd+WwtvE5A28h86JokEim1z50s8szpURS6SQghVwxUnpmdJMuMo1wI324ytTln5/HRuLg0Ea7bw+4TyReWnPcXcOtzPO0q9Mu7WNpkaoK822FXJXTVN8uF5dOqZQgLWayC5awl4Lele+l7eyvofayJ+1iIq14AGBU5Db/FEFedbe7nG/v07fzG+/tg5votxsru+KNbyjbGqueCSO41ObKKgD2QKWyOtNuvinb99AzbioQcZxws1fxuU3zkIJKBVGi0lvOEQsopGI6G8ztOmXN+rYG3ViK6E0TzMHabLZFzZleJNNmIOJWekSb/51GYtqKCeOtlIRqdZ2PILiLvtd1B7578abZbuone1YHLiQmvMDHJ5vjKZ9HHc56s9uj/9QXN1Lt0vRJt5YRYSalaua7SV3bLS67NpyJEz7kYB3ULd5sgNJERtstFJt0Fe7c3u38GbxBCpmS0OoFfgDdw107lQs4yDDuL0rMwdvhVbptI+vhBAFd6pNt7wq+enjtg8lM0++KxCKEPpKs4JsjZIU7GMPHTqC3cSqmbIMjwueJUXJsx4R//wFAFbw7 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query flow node instances

+ Search for flow node instances based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Flow node instance filter. - -
- -The flow node instance search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching flow node instances. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching flow node instances. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching flow node instances. - -
  • Array [
  • ]
- -The Flow node instance 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-incidents.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx index b257ec82095..239553d08f3 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx @@ -5,88 +5,787 @@ description: "Search for incidents based on given criteria." sidebar_label: "Query incidents" hide_title: true hide_table_of_contents: true -api: eJztW/9z2rgS/1c0+um9eQ6QXnvX828UnJ6vCeSA5DqXZlJhL6DWtqgkJ2EY/vc3K9nGgEmcNnd9b0pnMgVL2l1pv312sZZUs6mi7hX1k4CHkGh67VAxB8k0F4kfUpdOeBLmo4o6NAQVSD7HcerSITAZzMhESMLzSWTMFIREJGTKbyEhgeQaJGeNDwl1qIQvKSj9RoQL6i7NVy4hpO6ERQocGohEoyDukrL5POKBEaX5SSG/JVXBDGJmRqOoP6Hu1ZLqxRyoS8X4EwSaOnQucQuagzIrhDTUtgQXUpMJhyhcy0ednBSTki2oQ7mGWD2FmaG4y200g4yZFgQFIuNFiZ3SkidTunKokCHI6vVmiPCE3M14MCsI6RkQCRHTEFoWSBeSNEa1tocd6tCuN+ygYkOYsDTS1M2ea64jyM6ij9Q9XLZaOSWtXGVbui5NNzr/IwW5wJUDq1C6usaVczaFXfnP2ZQnRpEbp137VKWIqw+FJyHcEzEhRlPmUDSTmigjI0+mBNeWjponGqYgqUMnQsZM20c/vcDDj3jMK0wF+cTsnsdpTJI0HoPcYChBpzJBxYgEVWFOoyZHK2Z7oquU7hdbsk7GcFqDdIS0+jZjqP6PEVMaVXHJohTUR5Kd3gLlZGQu4ZaLVOV0JKi5SBQ8ZO+b+lgVor6BiZAVCt6WdWzmVQo74fLvlnZVaaznbAprY3Uq9lixaP+CXdePKtVozdTGxnxTdq7a9IGtE61cUjqFPWLkrN7BonQ01Ub488udgI7SMqX4NIGQfIaFk4UbFmhFmCKMpAn/kgIxTPiEgzTRX8+4KrbZQNueSxGAUl2Y8IQj9W+QKKNFwoIYyoaCioCb0Ges61ER/LAkQRZ1a/Lzu3XZ+YnSLAngGfbLM1K1dgtSCjky3B7bY2FcZg3ByeSO6xlhdssQEgUaHfLWOGk5p1z0hudexz/xvS516EXvXa//Z4861O/fnLXPz/3e2xtvMOgPqEN/77+56fVvBt5o4HtD6tBOv9f1R36/V0zx3o8G7c7o5rJ9euEVTzvt01Ove+Odemdeb1Q8vuj91u51zQg+ufEuvd6IOvTMGw7bb72bof+Xd+O973he1wiXkel6HX9YZrp+gGzbGwKd9AdnN73+6Oakf9Hr0uv8YM9AqSy3PXy2njnS2E7PvMfOGGMUnEF26DwhsZBAQtCMR0aDk0jc9UQIdc0U55NEhFDHOgvi326ea75PMtBAgsEAIx7XOMcu02ASbW6r+fJGWciQaTjSSBBzlGa6BuWhzkhviFjbAdqdkX/podn5bwftkbG0gTfsn16aj+der+v33hrL+STG33DMn8TYhmA+IXDPlVZO+YyNvLunrCFhifb3oFA7ivZi9g+ltTtwtJQR84BxYrLQJuTbnlOVPVcWVdpUbvLUi1arXq6UoNJI2+KhdnGwnSPrIs1H4StPrOLwMxuL1ALwDVEfTOtfQephibXQLPJzJLR1nDiWIdWYaQuIkUlFybPXMjF0bEK2ar2ZasR6S25bZp3hj9HOViq4LfStBrlQkJuvRYZliPkxq5cQEyYEEpWi7LvougZy3UTHtYXHZU+V3SD5ZxP9IRhrPWnLAzc8r5ixgxD3GIspczIjKYr5+vLut/k3TAFZy2DwYh4s0HIfN/J/GMj9HyAp773XuTDA5dQfjryeNzggrf8VpPXj4Zy/FXNgiMAQUhXKKovdB/T4j5S2T4tHTyhkq6F7DXZPgukPFwq1nORJ/HZA8gMsvgYS7zGpzQRbCV7zFLpyNuDmbRI2AhanScgabM4bn2GhGrYz+J9dKBrCXEKA4lFXyxR2c90BnB7A6QGcPjM4fYrbHeDqAa4e4OoBrn4fuPpD/zbzvX4s+f7d8Ad6w8+Ce3ex0h5j7Rnk+g4WqjYk3lhSAxxbd6kAxwcofIDCByh86NMegO8B+B6A7w8GfA992kOf9nn7tDjzZd0XC77gYjJhPIKwQc7WkUcRJo1ObnkIYQlWGDZkLMIFvo5geB1X88pQBIlY8Fmhz/KQsFTP0GCD/EVYMPbLIuPNe15tmEsxjiCu7CuXmbbJuZ2Z7YHYDI3+kodas5OrwUmH/Pry1S/X/5ppPVdus3l3d9eQk+AIQq6FbAg5bcpJgH84798NMpqBRMyxIGMgLAyNP7CoDBXUHAI+4UH+lmcmtsmz9tWNR9DxniRexNVU8h1Da5OLgZ9HgUWOmTdY0/Jbzwa8u+OIJZ/p2qQeM+c2UWkcM7nIo+ImgyzMp2WktfeV3ypX+W00OieWBAnQKYtYljHCTcQ8wfePqfuy1XJo9jYydX9utVZIEzVeYycJgft5xLK6Zms7Fdk3Dw/PpBkh+ZRv8910/MyIu3ZHuUP/tGvvJ0KOeRhCYsyz8DeuSCI0YVEk7iA8+NXBrw5+tc+vXlUlyjb2OzRItEOLykUQpFJi0p7xqIAqOe+8XH7o9byDrx187Yf2tZVDY9Azgffp5kIZ02F6Rl3aLBo4TYtKKd60kbcglWnQpDKiLl1aj1m5zeZyJpReucu5kHrVvEV13DLJ2TiyRojD1rNyi4lEwKKZ5bqrORxIWAz5jjq2dUtek4E3HJG3TMMdW9jiprhIl5N+3Xrdqq5nsE1XTbF97hO7Q2t3pViQk0WnriRrJ9chvMIaVEGQSq4XQ1xmj2cMTIJsp3j4hT1k/Ax1/G4nUSf7cJJbye9/joyiMY4N1tcYvXsWz60Xru8AbVS8rX2laNWAuXVZmGhVRdna6Hxttac2WzMlWy91UiqebtHfbI3QF60XL4+OXxwd/zo6fuW2fnFfthqt41d/0aLHse5C5GViq9xuKF1xtPcxr4q7ksXQ9fr2oL3w1yqu5LW2rspdLa1+y1fS8NnKOPxEGOVm7rhrJugzIJW1q1bjeNf1z30TwQIRx2li0lgyzfsxa3pBlKrsTlbEA8AS1F1S9KYS21M7Qi4tR3LcQJexfp1nrynXs3TcCETczH46Kf4fR2LcjBlPmhkL1ey0zy563fbRqd/xekPv6LjRauh720PH6BKzpCSHKZHXfeLtvS7XSfsrLvNmDqThXjfnEeOmKDZ7W2YR7oqWWWcx7trJ4tQVXS6RwYWMVit8bGpy6l5dr8Mafls5dAYstKqnn9G8aMfKfWS8AKdHqel+b98LWDn5inYQwFw/OPe6FKnP+0NspY6zm8qxCHGNZHd4i5ndUZd+oB8oxQvTSMHEF/N8SSOWTFPrgJYu/vsv00kpdA== +api: eJztW/9z2jgW/1c0+uluzgGSbbdd/0bB6Xo3gRyQbGdzmVTYD1BrW1SSkzAM//vNk2xjwCROm93eTelMpmBJ7z3pffu8h7Wkmk0Vda+pnwQ8hETTG4eKOUimuUj8kLp0wpMwH1XUoSGoQPI5jlOXDoHJYEYmQhKeTyJjpiAkIiFTfgcJCSTXIDlr/CehDpXwJQWl34lwQd2l+colhNSdsEiBQwORaBTEXVI2n0c8MKI0Pynkt6QqmEHMzGgU9SfUvV5SvZgDdakYf4JAU4fOJW5Bc1BmhZCG2pbgQmoy4RCFa/mok5NiUrIFdSjXEKvnMDMUd7mNZpAx04KgQGS8KLFTWvJkSlcOFTIEWb3eDBGekPsZD2YFIT0DIiFiGkLLAulCksao1vawQx3a9YYdVGwIE5ZGmrrZc811BNlZ9JG6h8tWK6ekletsSzel6Ubn/05BLnDlwCqUrm5w5ZxNYVf+CzbliVHkxmnXPlUp4upD4UkID0RMiNGUORTNpCbKyMiTKcG1paPmiYYpSOrQiZAx0/bRTyd4+BGPeYWpIJ+YPfA4jUmSxmOQGwwl6FQmqBiRoCrMadTkaMVsT3SV0v1iS9bJGE5rkI6QVt9mDNX/MWJKoyquWJSC+kiy01ugnIzMJdxxkaqcjgQ1F4mCx+x9Ux+rQtR3MBGyQsHbso7NvEphJ1z+1dKuKo31gk1hbaxOxR4rFu1fsOv6UaUarZna2Jhvys5Vmz6wdaKVS0qnsEeMnNXvsCgdTbUR/vxqJ6CjtEwpPk0gJJ9h4WThhgVaEaYII2nCv6RADBM+4SBN9NczroptNtC251IEoFQXJjzhSP0bJMpokbAghrKhoCLgJvQZ63pSBD8sSZBF3Zr8/G5ddn6iNEsCeIH98oxUrd2ClEKODLen9lgYl1lDcDK553pGmN0yhESBRoe8M05azimXveGF1/FPfa9LHXrZ+73X/6NHHer3b8/bFxd+7/2tNxj0B9Shv/Xf3fb6twNvNPC9IXVop9/r+iO/3yumeB9Gg3ZndHvVPrv0iqed9tmZ1731zrxzrzcqHl/2fm33umYEn9x6V15vRB167g2H7ffe7dD/07v1PnQ8r2uEy8h0vY4/LDNdP0C27Q2BTvuD89tef3R72r/sdelNfrDnoFSW2x4/W88caWynZ95jZ4wxCs4gO3SekFhIICFoxiOjwUkk7nsihLpmivNJIkKoY50F8W83zzXfZxloIMFggBGPa5xjl2kwiTa31Xx5oyxkyDQcaSSIOUozXYPyUGekN0Ss7QDtzsi/8tDs/PeD9shY2sAb9s+uzMcLr9f1e++N5XwS42845k9ibEMwnxB44Eorp3zGRt7dU9aQsET7e1CoHUV7MfuH0todOFrKiHnAODVZaBPybc+pyp4riyptKjd56qTVqpcrJag00rZ4qF0cbOfIukjzSfjKE6s4/MzGIrUAfEPUR9P6V5B6XGItNIv8HAltHSeOZUg1ZtoCYmRSUfLstUwMHZuQrVpvphqx3pLbllln+GO0s5UKbgt9q0EuFeTma5FhGWJ+zOolxIQJgUSlKPsuuq6BXDfRcW3hcdlzZTdI/sVEfwzGWk/a8sANzytm7CDEPcZiypzMSIpivr68+23+HVNA1jIYvJgHC7Tcp438bwZy/wdIyvvgdS4NcDnzhyOv5w0OSOt/BWn9eDjnL8UcGCIwhFSFsspi9xE9/i2l7fPi0TMK2WroXoPds2D644VCLSd5Fr8dkPwIi6+BxHtMajPBVoLXPIWunA24eZeEjYDFaRKyBpvzxmdYqIbtDP5rF4qGMJcQoHjU1TKF3Vx3AKcHcHoApy8MTp/jdge4eoCrB7h6gKvfB67+0L/NfK8fS75/N/yR3vCL4N5drLTHWHsGuf4OC1UbEm8sqQGOrbtUgOMDFD5A4QMUPvRpD8D3AHwPwPcHA76HPu2hT/uyfVqc+aruiwVfcDGZMB5B2CDn68ijCJNGJ3c8hLAEKwwbMhbhAl9HMLyOq3llKIJELPis0Gd5SFiqZ2iwQf4iLBj7ZZHx5j2vNsylGEcQV/aVy0zb5MLOzPZAbIZGf8lDrdnJ9eC0Q3559frNzT9mWs+V22ze39835CQ4gpBrIRtCTptyEuAfzvtng4xmIBFzLMgYCAtD4w8sKkMFNYeAT3iQv+WZiW3yrH114wl0vCeJF3E1lXzH0NrkcuDnUWCRY+YN1rT81rMB7+44Yslnujapp8y5TVQax0wu8qi4ySAL82kZae195bfKVX4djS6IJUECdMoilmWMcBMxT/D9Y+q+arUcmr2NTN2fW60V0kSN19hJQuBhHrGsrtnaTkX2zcPDC2lGSD7l23w3HT8z4q7dUe7QP+3a+6mQYx6GkBjzLPyNK5IITVgUiXsID3518KuDX+3zq9dVibKN/Q4NEu3QonIRBKmUmLRnPCqgSs47L5cfez3v4GsHX/uhfW3l0Bj0TOB9urlQxnSYnlGXNosGTtOiUoo3beQdSGUaNKmMqEuX1mNWbrO5nAmlV+5yLqReNe9QHXdMcjaOrBHisPWs3GIiEbBoZrnuag4HEhZDvqOObd2St2TgDUfkPdNwzxa2uCku0uWk37betqrrGWzTVVNsX/jE7tDaXSkW5GTRqSvJ2sl1CK+wBlUQpJLrxRCX2eMZA5Mg2ykefmEPGT9DHb/bSdTJPpzmVvLbHyOjaIxjg/U1Ru+BxXPrhes7QBsVb2tfKVo1YG5dFiZaVVG2Njpfe3s6m02aktWXeioVT7c4bTZJ6Enr5NVR683RyS+j49fu62P35G2j9eb4T1p0O9b9iLxgbJUbD6XLjvZm5nVxa7IYulnfI7RX/1rF5bzW1qW566XVdPlyGj5bGdefCKPmzDF3DQa9B6SyFtZqHO8GgQvfxLJAxHGamISWTPPOzJpeEKUqu50V8QCwGHWXFP2qxPbMjpAry5EcN9B5rIfneWzK9SwdNwIRN7MfUYr/x5EYN2PGk2bGQjU77fPLXrd9dOZ3vN7QOzputBr6wXbTMc7ELCnJYYrldcd4e6/Ldfr+imu9mStpeNDNecS4KY/N3pZZrLumZdZZtLtxsoh1TZdLZHApo9UKH5vqnLrXN+sAh99WDp0BC63q6Wc0L9qxch8Zf8DpUWr64Ns3BFZOvqIdBDDXj869KcXsi/4Qm6rj7M5yLEJcI9k93mdm99SlFK9N42oTZcyzJY1YMk2t81ma+O+/CWsrkA== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query incidents

+ - + Search for incidents based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Incident search filter. - -
- -The incident search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching incidents. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching incidents. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching incidents. - -
  • Array [
  • ]
- -The incident search query failed. More details are provided in the response body. - -
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-mappings.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx index a9f16c87174..2c77ea59f78 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx @@ -5,88 +5,573 @@ description: "Search for mapping rules based on given criteria." sidebar_label: "Query mappings" hide_title: true hide_table_of_contents: true -api: eJztWlFz2zYM/is8Pm03R3a3buv05qbplm1tsyTdHtLcFZJgiwtFaiQVx+fTf9+BlGzJllO3175s7l2vqQgCIPDho4RgxR3MLY9v+CsoS6HmzFQS+e2I6xINOKHVecZjPhMqayQsH/EMbWpEScs85lcIJs3ZTBtWdLRYloDFjGnF5uIeFUuNcGgERO8UH3GD/1Ro3XOdLXm84qlWDpWjH6EspUi98fHflkysuE1zLMCvSvlmxuObFXfLEnnMdfI3po6PeGnIaSfQ+h3aeG1bvmrj2EygzDbu8FGrCoyBJR9x4bCwH2PMa9y1dp1jY8xpRg6xZNkxZ50Ras7rEdcmQzO83y8xodgiF2m+VuRyZAYlOMyCCdKLqioomdOrUz7iL86uTimVGc6gko7HzXMnnMQmFm9I+xltq+uQE2EwIx3hSLcdcZ/mPyo0S9p5GfLH61vaWcIcd/2/gLlQPpG9aB8cVaOL4aAIleED0zPmM+WD4sA4Zr2PhEDa2wm1UA7naPiIz7QpwIVH331LwZeiEANQITsFPIiiKpiqigRNz6BBVxlFidGKUuGjcaDF4OZ05oaSfr4+UqgrILGInWoT8u3XKP3vJVhHqfgTZIX2PWuityQ/gZUG74WubKvHoC21svgY3vv5qNeuPseZNgMJ3vY18XKDzs6E+dLe1oNgvYA5bsA6GjjjwKb9G3ZLXw6mMcAn0GFzpiBq+yXQ3/VqaEcnBnucSCWI4jUU2AlLwy7bbE1+eXGmoEBKTwGOYDYHoaxjwJy+QxURTr2cz9dheu9JlPLp1kZa/V6fOthD71ujqIli1MtVE6iXPkB9LtoSGcpqn+ycqdA/CJDzEf12Mnk8p3TFdcBaSV/8B19j2/k8lBM/SLRCBb6hnyHRVbgqeo4+isBPUPW4x047kOdtzW4FlNYaTvUwoch68OxezsOE+sNTAtYWuQxnzt+bHqK2hZbf5+0TkYc7lY7FLLqIvbXIXC5su/a+S4bvm5ud2EsxVLbyqNi5Bw7g2D6PH+w8bftY3/2d89lcf4xwQy1tlWSvFtcS24gRe8Diq68BSe9N83CfDy+0j6TULmF1mK/8rDxafiEWpep8DoO5aLb9hsvhhNzhcu2oQf862k3NwNvusPk+moaou4VLPepR673KohSKSmUQQSmiO1zaKLyvfbNLuxmWBlNyM9D+LnkdifhIxEciPhLxf5eI99fvsEOvPZn+hkt7KEn3dhxA1yFyA3R9JOcjOR/J+UjO/x9y/mxvyST49GOaGP+QAjYDITGL2CttkGXoQEjLwCC16+5FhlmnjLwpluhsGVr6e5ofpdGJxGLwbbzr2JRdBMnGLguYY2BZEEyC9ZvLl6fsp6ff/3j7Ve5caePxeLFYRGaWnmAmnDaRNvOxmaX0l+S+jth1joaOvWQJMsgyQTZBsk0amS0xFTORth3Lxm1GiQnn+wCD+9VdwK15uDJiB39T9vbynIkMlROzZcvrPdO828H3F0ycSFB3fIOED6F8ymxVFGDWIOwboDavA1d1mWBv+3qogn65vr5gQQVLdYb+d0GeVxtDdIhCKOql8/jpZDLiTWedxz9MJjXppIwfcBLF8KGU0Ny9W8cRihUb3PqDUU8TVPq5MqONmIttu322aED8IpyoLcQnw4XYXCdMQnpnidFExqByOVlN29+coHcCpH2kw3gssmOR/e+L7LtdvL/UJhFZhsrDc11vwjKlHQMp9QKzY10d6+pYV/vq6vuht8gpffg6NIRDNEYbptO0MgYzGlSQXn2K1ra22++m44visdaOtban1uoRL9DlmkauSm09dMDlPObj5ovtxH/Jj8MnG6fxDHOPxvov9cpIHvNVqJo6Ho9XubaujlelNq4e31NK7sEISGQAIi2H6mpRI3UKMg+Wd7NHC92P5dPQx2PP2OXZ1TX7GRwuYOmjWa6nr1rVzybPJoNaSXSPxunFOQsnDNjr8EGrlgp7UG0QPkRxTd/zFtPKCLe8om0hPAmCQTOtKAFrTDT2vHb6fxDio+aHly1Sfv3r2iebuOxyM+p29gBFGSpxMzjSaaJsMNfthmyeqp4UxcQH+mY9grZeut0MZYU5qsl60mmyNYF0swoR6E760LPal8VM++M3oN0NJKEKjQ2Rn0RPdgvk4tzXeaqLolKe7NWcLYTLGXQSk8rKNsMuUqRIXYx41R64Ffs9rLA/g0X2JCJQBeS3HD8XLq+SKNXFuOk0r/9NpE7GBQg1bkzY8en01dvXL6Ynv5+fnr2+Ojt5Ek0i9xBajlSDBaiOH77L0rZPdkYhO2OMnzgV2aDM4YMblxKEohz7460aKrjhPSrgbeJoVC8U9A1frcjIWyPrmh77zg6Pb2439U//q0c8R8gCAvgd9a74afD/5Jr8IPGAv51ZlnrU7pimKZbuUdnbDq1dvLm6pmppxj4LndEeAwsaCYUFj/k7/o5zGkAlDb4Q/fMVl6DmlYc0D3rpz782b+We +api: eJztWlFz2zYM/is8Pm03R3a3buv05qbplm1tsyTtHrLcFZJgiwtFqiQVx+fTf9+BlGzJllO3171s7l2vqQgCIPDho4RgxR3MLY9v+CsoS6HmzFQS+e2I6xINOKHVecZjPhMqayQsH/EMbWpEScs85lcIJs3ZTBtWdLRYloDFjGnF5uIeFUuNcGgERH8pPuIGP1Ro3XOdLXm84qlWDpWjH6EspUi98fHflkysuE1zLMCvSvlmxuObFXfLEnnMdfI3po6PeGnIaSfQ+h3aeG1bvmrj2EygzDbu8FGrCoyBJR9x4bCwn2LMa9y1dp1jY8xpRg6xZNkxZ50Ras7rEdcmQzO83y8xodgiF2m+VuRyZAYlOMyCCdKLqioomdOrUz7iL86uTimVGc6gko7HzXMnnMQmFm9I+xltq+uQE2EwIx3hSLcdcZ/mPyo0S9p5GfLH61vaWcIcd/2/gLlQPpG9aB8cVaOL4aAIleED0zPmM+WD4sA4Zr2PhEDa2wm1UA7naPiIz7QpwIVH331LwZeiEANQITsFPIiiKpiqigRNz6BBVxlFidGKUuGjcaDF4OZ05oaSfr4+UqgrILGInWoT8u3XKP3vJVhHqXgHskL7njXRW5KfwEqD90JXttVj0JZaWXwM7/181GtXn+NMm4EEb/uaeLlBZ2fC/Nve1oNgvYA5bsA6GjjjwKb9G3ZLXw6mMcAn0GFzpiBq+yXQ3/VqaEcnBnucSCWI4jUU2AlLwy7bbE1+eXGmoEBKTwGOYDYHoaxjwJy+QxURTr2cz9dheu9JlPLp1kZa/V6fOthD71ujqIli1MtVE6iXPkB9LtoSGcpqn+ycqdA/CJDzEf12Mnk8p3TFdcBaSV/8B19j2/k8lBM/SrRCBb6hnyHRVbgqeo4+isDPUPW4x047kOdtzW4FlNYaTvUwoch68OxezsOE+sNTAtYWuQxnzt+bHqK2hZbf5+0TkYc7lY7FLLqIvbXIXC5su/a+S4bvm5ud2EsxVLbyqNi5Bw7g2D6PH+w8bftU3/2d88Vcf4xwQy1tlWSvFtcS24gRe8Diq68BSe9N83CfDy+0T6TULmF1mK/8ojxa/kssStX5HAZz0Wz7DZfDCbnD5dpRg/51tJuagbfdYfN9NA1RdwuXetSj1nuVRSkUlcogglJEd7i0UXhf+2aXdjMsDabkZqD9XfI6EvGRiI9EfCTi/y4R76/fYYdeezL9DZf2UJLu7TiArkPkBuj6SM5Hcj6S85Gc/z/k/MXekknw6ac0MT6QAjYDITGL2CttkGXoQEjLwCC16+5FhlmnjLwpluhsGVr6e5ofpdGJxGLwbbzr2JRdBMnGLguYY2BZEEyC9ZvLl6fsp6ff/3j7Ve5caePxeLFYRGaWnmAmnDaRNvOxmaX0l+S+jth1joaOvWQJMsgyQTZBsk0amS0xFTORth3Lxm1GiQnn+wiD+9VdwK15uDJiB39T9vbynIkMlROzZcvrPdO828H3F0ycSFB3fIOEj6F8ymxVFGDWIOwboDavA1d1mWBv+3qogn65vr5gQQVLdYb+d0GeVxtDdIhCKOql8/jpZDLiTWedxz9MJjXppIwfcBLF8KGU0Ny9W8cRihUb3PqDUU8TVPqlMqONmIttu322aED8IpyoLcQnw4XYXCdMQnpnidFExqByOVlN29+coHcCpH2kw3gssmOR/e+L7LtdvL/UJhFZhsrDc11vwjKlHQMp9QKzY10d6+pYV/vq6vuht8gpffg6NIRDNEYbptO0MgYzGlSQXn2K1ra22++m44visdaOtban1uoRL9DlmkauSm09dMDlPObj5ovtxH/Jj8MnG6fxDHOPxvov9cpIHvNVqJo6Ho9XubaujlelNq4e31NK7sEISGQAIi2H6mpRI3UKMg+Wd7NHC92P5dPQx2PP2OXZ1TX7GRwuYOmjWa6nr1rVzybPJoNaSXSPxunFOQsnDNjr8EGrlgp7UG0QPkRxTd/zFtPKCLe8om0hPAmCQTOtKAFrTDT2vHb6fxDio+aHly1Sfv3z2iebuOxyM+p29gBFGSpxMzjSaaJsMNfthmyeqp4UxcQH+mY9grZeut0MZYU5qsl60mmyNYF0swoR6E760LPal8VM++M3oN0NJKEKjQ2Rn0RPdgvk4tzXeaqLolKe7NWcLYTLGXQSk8rKNsMuUqRIXYx41R64Ffs9rLB3wSJ7EhGoAvJbjp8Ll1dJlOpi3HSa1/8mUifjAoQaNybs+HT66u3rF9OT389Pz15fnZ08iSaRewgtR6rBAlTHD99ladsnO6OQnTHGz5yKbFDm8MGNSwlCUY798VYNFdzwHhXwNnE0qhcK+oavVmTkrZF1TY99Z4fHN7eb+qf/1SOeI2QBAfyOelf8NPh/ck1+kHjA384sSz1qd0zTFEv3qOxth9Yu3lxdU7U0Y5+FzmiPgQWNhMKCx5zT8Cnt9kXon624BDWvPJx50El//gGyv+Si 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query mappings

+ - + Search for mapping rules based on given criteria. -## Request - -

Body

required
    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Mapping search filter. - -
- -The mapping rule search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching mapping rules. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching mapping rules. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching mapping rules. - -
  • Array [
  • ]
- -The mapping rule 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-process-definitions.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx index ab8bb55d51a..61be8a653c5 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx @@ -5,91 +5,644 @@ description: "Search for process definitions based on given criteria." sidebar_label: "Query process definitions" hide_title: true hide_table_of_contents: true -api: eJztW1Fv4zYS/isEn644Rfa223arN2+SbX1ts7nE2z54AywtjWw2FKmSVBzD0H8/DCnZsiw7dq+LO7QKECQWyZkhZ775yBG9ppbNDY2m9FarGIwhCaRccsuVpA8BVTlohh/GCY1oymVS9bvadDM0oAmYWPPcjYroPTAdL0iqNMn3pBoyYwYSoiSZ8yeQJNbcguYs/ChpQDX8XoCxb1WyotHafeQaEhqlTBgIaKykBWmxjeW54LGzbvCbQc1rauIFZMy1CvE+pdF0Te0qBxpRNfsNYksDmmucleVg3AilnbTWFJS2JOUgkq19NKhFMa3ZigaUW8jMOcqcxH1tkwVUyqwiaBCZrRrqjNVczmkZUKUT0N3jXRPhkiwXPF5sBNkFEA2CWUi8CpQLssjQ56P7SxrQq+v7S/R1AikrhKVR9dxyK6Bai/co/RqHlWXQ8Mq0mtJDo7vz/r8L0CsceecdSssHHJmzOezbf8vmXDpH7qz2yauqVda9KFwm8ExUSpyn3KJYpi0xzkYu5wTHNpaaSwtz0DSgqdIZs/7RV1/i4gue8Y5QQT0Ze+ZZkRFZZDPQOwo12EJLdIyS6Aq3Gidq9GaOUtvl9PFmSh5uDLuF5FJp72/Xhu7/JJix6IpfmCjAfCLV6q3QTkZyDU9cFaaWo8HkSho4Fu+7/ig3pr6FVOkOB7dtnbl+ncamXH9ua8vOYL1lc9gGa9Axx45BhwfsQ190uhHDZz9L1tPzo8wuGlrgeWFwY2UOmJa3U/qPsOo29BFWLq3bBTcdVr8Y1t+8xrCWLOuIkRuWAfr4ZdnbfKjBqELHcNMp8a5qJfIPiH4CbbgnlV2pv/iG0+QdQ3elYcLmh5VYNj/X8D1vjjsYpyNoxlfnarIgmbRd4ieu5WyRDYztbTPeuWDeZZODnbsQWnrm8unCxf2Xw+G5eNRgCmH9VuXkrUgbfafy2otkyaWPKvyfzVTh6X7H1OOp43xRxy22yjIxrvNua2GxreLFjFlPv6ikY4N1LHu0CKLbg27v8+Q6+BDEDZY21ulHMvb7IpwWMWBD8sGAD9Sq7VOT0D5VuzNkIElAmgJt3+fyE3hyl4tPNh6HnWu72zf8aaYfI02PqRYodzC46dGOGH4gWNymqgqSjkPE6ZYfjv63zADZWuOIbS+TYDC/HPf/G0Y7jYl7Svt/pTSMLQzCDlh8ji3ZqSbtgv04t9a4LoMdDnySSRizrJAJC1nOw0dYmdAfjv65z48J5BpiPKLSyOoC9tHWM2bPmD1jfjbGPAeAPYf2HPr35dDDafYlI28c+/0IK3M+v+6MPYFp/cJ1MG3Pqz2v9rzan0R7Fu1Z9K96EsUhr8+v7P6OYkjKuIAkJD8rDSQBy7gwhGk38IknkDSynlNIZipZHa0H51rNBGSd596meSOEPPas9BKPcMLQWuw489qnd+8uyXevv/724R8La3MTDQbL5TLUaXwBCbdKh0rPBzqN8Rf7fRGSyQI0prEVmQFhSeJmzkQz55gcYp7yuH4RV5lN0GV+fi8Qrmtdt1zcgGah+d5NgRH5cDcmPAFpebqqaXhHNW2+mHb7gWgmmHyk28jYV9rWYoosY3pVc9iuAnx7aZktmin7YGppy8ag+mEyuSVeBIlVspsOURFOIuMSXxHT6PVwGNDqhTGNvhkOS5SJHj9hJpLAcy5YtVVqTYdLkm3j1k2MS2OZjP8szyjN57ytN2wDGR9e+RnVcHzVDceK/Ylg8aPBjQZPCCvsArXG9YUAcEYw4ai2B1kPsh5k3SD7aj/e3yk940kC0oXnBm/cEKksYUKoJSQ9rnpc9bg6hKuvu/aSI6xTWNAYh6C10kTFcaE1JHj/Tmw2mrXu+pjbbxR7rPVYO4C1MqAZ2IXCq8a5Mi50mF3QiA4qOF00Ci8Df3CjePdQ43HfFVYKLWhE1x47ZTQYrBfK2DJa50rbcvCEjnlimrOZ8OGIzR5jdewIFTOx8Pr3fYgN2/tkQC598ZW8IXfX9xPyPbOwZCu3pvnmanEt+s3wzbBTKnY9IHF0OyZ+hj4CG1mhFovw7hTrO58iuMSTv4G40Nyu7nGYX54ZMA16VKAbNpFR6XPS8bPvRIPqn3d1vPzr14lzOWa0u+3F7utnluUej9tbkd11hmF9W3Abjbt1qe3zTU1puFv92fboLN5sm7cVl0YZxl8Pn26ubm+aHraXmf394+HmhvCwdXN3uvaL27whi89Kh7tUuZWtULHvo+bU6DB8tY/A27FLJLHKskI6NpFzsuR2QVjD57EoTHUdVPAYsFiyqRdu1P7kW0hdInsVYrx6UNUkMud2UczCWGWD6s3D5u9MqNkgY1wOKhVmcDn6+cPN1ejip/Hl9c399cWrcBjaZ1+CRpBnTDbscMWcrjJre9brLYv+V983qCLawrMd5IJxiU53811XyWdKO5IPrf2JN999CpnS9RpVfdCiLPGxqyjRaPqwzTj4qQzoAljiA4M+YpTTSz+Xiwlag91F4QrK7WuFZVCPGMUx5PZo34dGOr19fz9BfFZfq8hUgmM0WyKg2JJG9CP9SCl+4cPPD797gc/XVDA5L1ykUy8Xf/4D0AmnrQ== +api: eJztW21v4zYS/isEP7WoYnvbbbunb94ke+e+ZHOJt/3gC7C0NLLZUKSWpOIYhv57MaRkS7Ls2NcuWtwpQJBYJGeGnHnmIUf0hlq2MDSc0VutIjCGxJBwyS1Xkj4EVGWgGX6YxDSkCZdx2e9q283QgMZgIs0zNyqk98B0tCSJ0iTbk2rInBmIiZJkwZ9AkkhzC5qzwX8kDaiGTzkY+1bFaxpu3EeuIaZhwoSBgEZKWpAW21iWCR4564a/GdS8oSZaQspcqxDvExrONtSuM6AhVfPfILI0oJnGWVkOxo1Q2klrTUFpSxIOIt7ZR4NKFNOarWlAuYXUnKPMSdzXNl1CqcwqggaR+bqmzljN5YIWAVU6Bt093jURLslqyaPlVpBdAtEgmIXYq0C5IPMUfT6+v6QBvbq+v0Rfx5CwXFgals8ttwLKtXiP0q9xWFEENa/Myik91Lo77/87B73GkXfeobR4wJEZW8C+/bdswaVzZGO1T15VrdLuReEyhmeiEuI85RbFMm2JcTZyuSA4trbUXFpYgKYBTZROmfWPvvkaF1/wlHeECupJ2TNP85TIPJ2DbijUYHMt0TFKoivcapyo0Zs5TmyX0yfbKXm4Mew2IJdKe3+7NnT/R8GMRVf8wkQO5iMpV2+NdjKSaXjiKjeVHA0mU9LAsXhv+qPYmvoWEqU7HNy2de76dRqbcP25rS06g/WWLWAXrEHHHDsGHR6wD33R6UYMn/0sWU3PjzJNNLTA88Lg2socMC1rp/QfYd1t6COsXVq3S246rH4xrL97jWEtWdoRIzcsBfTxy7J3+VCDUbmO4KZT4l3ZSuR/IfoJtOGeVJpSf/ENp8k7hu5Sw5QtDiuxbHGu4XvenHQwTkfQTK7O1WRBMmm7xE9dy9kiaxjb22a8c8HcZJODnbsQWnjm8unCxf3Xo9G5eNRgcmH9VuXkrUgbfafy2otkyaWPKvyfzVXu6b5h6vHUcb6o4xZbZZmYVHm3tbDYVvJiyqynX1TSscE6lj1aBNHtQbf3eXIdfAjiBksb6/QjGft9EU6LGLAD8sGAD9Sy7WOd0D6WuzNkIElAmhxt3+fyE3iyycUnG4/DzrXd7Rv+NNOPkabHVAuUDQxue7Qjhh8IFrepKoOk4xBxuuWHo/8tM0B21jhi28skGMwvx/1fw2inMXFPaX9XSsPYwiDsgMXn2JKdalIT7Me5tcJ1ETQ48EnGg4iluYzZgGV88AhrM/CHo6/2+TGGTEOER1QaWp3DPtp6xuwZs2fMz8aY5wCw59CeQ/9/OfRwmn3JyBvHfj/C2pzPr42xJzCtX7gOpu15tefVnlf7k2jPoj2L/q+eRHHI6/Mru59QDEkYFxAPyM9KA4nBMi4MYdoNfOIxxLWs5xSSuYrXR+vBmVZzAWnnubdu3hghjz1LvcQjnDC0FjvOvfbZ3btL8o/X337/8MXS2syEw+FqtRroJLqAmFulB0ovhjqJ8Bf7fTkg0yVoTGNrMgfC4tjNnIl6zjEZRDzhUfUirjSboMv8/F4gXNe6abm4Bs1c872bAmPy4W5CeAzS8mRd0XBDNa2/mHb7gXAumHyku8jYV9rWYvI0ZXpdcVhTAb69tMzm9ZR9MLW0ZWNQ/Ws6vSVeBIlU3EyHqAgnkXKJr4hp+Ho0Cmj5wpiG341GBcpEj58wE0ngOROs3Cq1psMlSXdx6ybGpbFMRn+WZ5TmC97WO2gDGR9e+RlVcHzVDceS/Ylg0aPBjQaPCcvtErVG1YUAcEYw4ai2B1kPsh5k3SD7Zj/e3yk953EM0oXnFm/cEKksYUKoFcQ9rnpc9bg6hKtvu/aSY6xTWNAYh6C10kRFUa41xHj/Tmw3mpXu6pjbbxR7rPVYO4C1IqAp2KXCq8aZMi50mF3SkA5LOF3UCi9Df3CjePdQ43HfFVZyLWhINx47RTgcbpbK2CLcZErbYviEjnlimrO58OGIzR5jVewIFTGx9Pr3fYgNu/tkQC598ZW8IXfX91PyT2ZhxdZuTbPt1eJK9JvRm1GnVOx6QOL4dkL8DH0E1rJCJRbh3SnWdz5FcIEnfwNRrrld3+MwvzxzYBr0OEc3bCOj1Oek42ffiQblP++qePnh16lzOWa0u93F7utnlmYej7tbkd11hlF1W3AXjc261O75tqY0alZ/dj06ize75l3FpVaG8dfDZ9ur29umh91lZn//eLS9ITxq3dydbfzi1m/I4rPC4S5RbmVLVOz7qD41Ohq82kfg7cQlkkilaS4dm8gFWXG7JKzm80jkprwOKngEWCzZ1gu3an/yLaQqkb0aYLx6UFUksuB2mc8HkUqH5ZuH7d+5UPNhyrgclirM8HL884ebq/HFT5PL65v764tXg9HAPvsSNII8ZbJmhyvmdJVZ27Pe7Fj0D33foIxoC892mAnGJTrdzXdTJp8Z7Ug+tPIn3nz3KWRGNxtU9UGLosDHrqJEw9nDLuPgpyKgS2CxDwz6iFFOL/1cLqZoDXYXuSsot68VFkE1YhxFkNmjfR9q6fT2/f0U8Vl+rSJVMY7RbIWAYisaUopf9vBzw+9d4LMNFUwuchfl1MvEn98BRDumsQ== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query process definitions

+ Search for process definitions based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Process definition search filter. - -
- -The process definition search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching process definitions. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching process definitions. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching process definitions. - -
  • Array [
  • ]
- -The process definition 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-process-instances.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx index f2ccbc6d451..c294a118eec 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx @@ -5,187 +5,1529 @@ description: "Search for process instances based on given criteria." sidebar_label: "Query process instances" hide_title: true hide_table_of_contents: true -api: eJztXeFv27YS/1cIYh82PMd22m5r/c1z0r28dW1e43bASwOUls42F4lUKSqOYfh/H46UZMmiJGdN2vRNA4ZlFnl35N39eDrxyA3VbBHT0SU9V9KDOCZcxJoJD+hVj8oIFNNcijOfjuicCz9tdZY2immP+hB7ikfYjI7oBTDlLclcKhLtUYzJjMXgEynIgt+AIJ7iGhRn/Q+C9qiCTwnE+hfpr+loY/6XK/DpaM6CGHrUk0KD0PiMRVHAPSPZ4M8Y+W5o7C0hZPhXWaD9cZHYSpiy69MeZUHwZk5Hlxuq1xHQEZWzP8HTtEcjhVOgOcSGhVS6yuBCKk3mHAJ/NyDay0gxpdia9ijXEBoihzIzFKvcpktImWlJUCAyWxfYxVpxsaDbHpXKB+Xubx4RLshqyb1lTkgvgSgImAbfskC6IJIQzWN8MaE9enJ6MUHD8GHOkkDTUfq75jqAdC7eIPVT7Lbd9gpqvEyHdFVoblTx3wTUGnu+tSqh2yvsGbEFONTJFlwYzZdm++BZVTJ0TwoXPtwSOSdGU2ZSNFM6NRcuFgT7FqaaCw0LULRH51KFTNufnj7ByQ94yB2mgnxCdsvDJCQiCWegSgwV6EQJVIwUUDTQAzhaMcdz7VL6WT4ka/sMm/XJRCqrb/MM1f8xYLFGVbxnQQLxR5LO3hrlZCRScMNlEu98KI6kiKHJ3sv62Oai/gJzqRwK3pd1Zto5hZ1z9dDSbp3Ges4WsDPWnmOMjk71HaquHzjViOazD6rZ4GyfuOwLhyGh7VqYlRqxojL2/wZrt4jXYBSglzyuiNsk3yspFjsVrrheknkSBIT5N9jVz+T1WMRmPOAol0tqKaCMBW6/+ekZ3fb2ZRhnvAIU5nvT7IfCDNXJ/guLubeTtKZ38/x+B5+qEzpZgncdm/UUPiUs4NnUaGsMN9wHn9ygA7QihRkx/U608OHivjjBLY91XMuMzw1tL1EKhN6p3nYrMJlJGQAThiYXbfRyOiHT3hJiwkRqkPvjiA+AgvoBFv3c6B8N+KX1XbSsFm0vHAvErwqYBkX0kgniyTBiisdSfK4eFtoBtCVemXndI9PAMb5XcnX/owtcoytwuu+xbbeFECYDjKLuC493P5+nVonRTS/D0hOYc8GzCLsJ7/28JTk7aUKiCxMBPgiO5sFlLWraFl8D8XaB7/3iW4Hu/wOaZcMxfsOvHY7Twr3EFimkM/ZBXCRRJBW+PKx44HtM+cRbMsU8jEuIDxEI8+5nJkmKOV8kqmCMAQeh7ZtgVdZ9b7NG7vC34oMWj3vNQsfwa3xOsLAxdum8rvO6zusO8Lr3oGIuHfNf43g3tn2T753ZlXrP+R7orcG8bdd6YtrHhP5Pnzyi0N8mCb5E6J9yegi3/RIRcyr+l42YU6YPHzHnjL5cxJyyfByvbSiMC9lSCHFAW+nJYdg2ZYu7whvRbNGFF1140YUXnxle1CYlHb53DesuHdmlI78tX+/SkV068gHSkQxN/vzADzy2dfVTVAeoHaB2gNoBageoKaC+DOTqtfThUESdB3JFhPShw9QOUztM7TC1w9QCppr9eCfMJTliqN2u5zPd+KEO+x9pHsKDoGaa3SiM38/4NQFn3ugrJtlqZH6YzFsts8f/2aBtBA+FG2187xM62nk9BHq0cf1KaVW3PK4EJmLLlIfgwLTyozKugfDrUQ3zqx2mdZjWYVqHad8QpsW6FtGqO9h1C77t5SUvsD0WmNwv3DkjSg09U4wh52Q8mZ69P+2RyZvfz1+dTk9PemQyfj05fXV6UiqUMc1oj+bt8O+0YbH4pW5UTaBaOxNfEmPr1PQ1p+zq/lD90Q7vm84MPJ65/Ma/krsG5gDn+mZloF6y+Ex43E8rK/dMZL+6848l6KVZER21PWTJYsLyEkKeksWVU0jdR3vTIJjQdXvd7dNuf3u3FabbCnPnrTA3THE2C6AGbSvOmrc/HLUrBYQZjYMdQjj33ONO/EzlGUmniRpVuMdnHh1AZFsLke/TTnZy82rNhh57La8amrrqQLe2PtoWpZrpeTIcHhoz5yWtSWBKhO+9Or5SK5ur9NBa69YCbi7sWwj+zWYysSXopaE1F7TenVSzxFpqFpzVhCz4LK3VNmCBC4Hx9WrRf1Pqfa9ouSY2wnp8C3qZTZt+hj8WiNtafRwWiUH3ybsY7KKcPvtYLLL+mJ4YgFXRgoCIE5S9Wl9+QO12uT78YOGx211lN7Xs9yZ6UyG3NfU9By55bN5i32Ia4tvcSCrnYHwG4u65p5nTZh+tfHPNFz0ONl7Yg6qzGpLOYvD9Asb9NMPBBY1NFVp/i6it2GopQan4611rUqo73Vt2hf+tsZR2ie9/CWunWP4y5s5EFZLQ7QSLSWk3uYb8z1fLqnzFd532KS28+zSEEeib6MIOJHKfztDOuPm0hoY91n/Lks12lpYNhwcQbtqA2Lb75mDydbtxWvTTGDI6V5VtrxSz3Qi/77EwET7rs4j3r2Ed9+1xMf/67HiO/AZrwrRWfJbgWSosxpNoQHGv8JLlQ6TAQ8umI60S6GLALgbsYsBHHQPeu193cWMXN3Zx4z88bmwy8LZjvqrLXkskeUdvSndGO9i0x5aNrJqrW+r4NUebBzCs3/xd2UzZqOfXJlL8DdbxXSPRUs8DYlJrlp8fk3Y5xi6+7OLLxx1fdjnGLlbsYsUuVuxyjN9ojhE7PLvr9+VPSITMGQ/A75PfpQLig2Y8iAlThY0SuxXXLhkz6a/tXoea79KRkrMAwtbYcYwrB7ZM+RK7VGB6wzacWe6Xb19OyItnP/589f1S6ygeDQar1aqv5t4R+FxL1ZdqMVBzD//Fdj/0yXQJCpfQNZkBYb5vrIcFxaUrjsDjc+5lR06nYhPUb2kvR12wZ5427L5NFK+Yx5i8e3tGjK/z+ToLAUusafEIdhOLjmYBE9d0ZxVtRjgmcRKGTBU32xQYpPiaHHSmksvA/z2dnhNLgnho4BgGZAiAjHAQIRd4GDodPRsOezQ9Gp2OfhoOt0gTNX7ASASB2yhgaZi+NxwuSLizWzOw/IqD+9GMVHzB9/lWXBh/PLEjypzx2O2MaeRJAoYblW5YwH3CEr1Erl529D0YIVgQN2z+6Jysc7J/vJM9rdr7S6lm3PdBGPPM/Y3HGFcRFgRyBX7nV51fdX5V51c/uiLJsTAHoCq0Q1BKKiI9s13Yx5tmgjzMzHhnKZYuUOx8rfO1Gl/b9mgIeinxBq5IxsZ0mF7SER2k7nSUJ/0G9rWN4h07ChM6JjuXqICO6MZ6znY0GGyWMtbb0Qa3s28HN6iW0u5xfGw9LLOcQHosWFruVQ3iA1HYwz2xHwrIc/L29GJKfmUaVix9a86v0MpIPx8+H7rfkDHF66Y4Pj8jdoTW/gqYkJFF53YnqkzjQwibMyti8BLF9foCu9npmQFToMYJKiG3i5SfoW4yPqYR7aV/vMys5T9/TI3CEc/e7m48O71lYWS9cXf7jyvdMqy5O2JnmDUpzoYGebLSRbyYWmygkQtXm3QZNuZMhqWMI30yfPLs6PjJ0fGL6fGPo+HPo6cv+i9ePP8fLWQRmxqV0nDpVoc8V7YbRsHsL7PqhOJTU26Q1w6YwlZjwJf5/Wy7h7sby+wlY8P8GrDh3vVclxtrWcVrsPC3rYGcuTRmlQJC1UBRsExhdNg/roLP+ZnBUE+GYSLMQioW6aHoBYP3giROizYC7gFmifIKjZztK/uEpFZAjvvorBZRsvVzwfUymfU9GQ7ST4T5f2eBnA1CxsUgZREPJuPf370+GR+9Opucvr44PTruD/v61n75QXwLmSjIYbJY1a8b+2Pe7MKHz7iBMHVlDbd6EAWMmxImM9ZNirmXtIK5NNMkZogtcl7SzQYZvVPBdos/mzQaHV1e7SwO/w/TxcB8axL0Gt2ATuw4jqYoy84EKzUdWKRme4w9DyLd2PaqsIacv7mYIiyl1yyG0sc+iq3wCka2oiP6gX6gWB5n5tYgnvl9QwMmFomxcWrp4j9/AVua62w= +api: eJztXeFv27YS/1cIYh82PMd2snbr/M1z0r28dW1e43bAywKUls42F4lUKSqOYfh/H46UZMmiJGdN2vRNA4ZlFnl35N39eDrxyA3VbBHT0RW9UNKDOCZcxJoJD+h1j8oIFNNcinOfjuicCz9tdZ42immP+hB7ikfYjI7oJTDlLclcKhLtUYzJjMXgEynIgt+CIJ7iGhRn/T8E7VEFHxOI9c/SX9PRxvwvV+DT0ZwFMfSoJ4UGofEZi6KAe0aywZ8x8t3Q2FtCyPCvskD74yKxlTBl16c9yoLgzZyOrjZUryOgIypnf4KnaY9GCqdAc4gNC6l0lcGlVJrMOQT+bkC0l5FiSrE17VGuITREDmVmKFa5TZeQMtOSoEBkti6wi7XiYkG3PSqVD8rd3zwiXJDVknvLnJBeAlEQMA2+ZYF0QSQhmsf4ckJ79PTscoKG4cOcJYGmo/R3zXUA6Vy8Qepn2G277RXUeJUO6brQ3KjivwmoNfZ8a1VCt9fYM2ILcKiTLbgwmi/N9sGzqmTonhQufLgjck6MpsykaKZ0ai5cLAj2LUw1FxoWoGiPzqUKmbY/fX+Ckx/wkDtMBfmE7I6HSUhEEs5AlRgq0IkSqBgpoGigB3C0Yo7n2qX083xI1vYZNuuTiVRW3+YZqv9DwGKNqnjPggTiDySdvTXKyUik4JbLJN75UBxJEUOTvZf1sc1F/RnmUjkUvC/rzLRzCjvn6rGl3TqN9YItYGesPccYHZ3qO1RdP3CqEc1nH1Szwdk+cdkXDkNC27UwKzViRWXs/xXWbhFvwChAL3lcEbdJvldSLHYqXHG9JPMkCAjzb7Grn8nrsYjNeMBRLpfUUkAZC9x+88Mzuu3tyzDOeAUozLem2XeFGaqT/WcWc28naU3v5vn9Bj5WJ3SyBO8mNuspfExYwLOp0dYYbrkPPrlFB2hFCjNi+o1o4cPFQ3GCOx7ruJYZnxvaXqIUCL1Tve1WYDKTMgAmDE0u2ujldEKmvSXEhInUIPfHER8ABfUDLPq50T8a8Evru2hZLdpeOBaIXxQwDYroJRPEk2HEFI+l+FQ9LLQDaEu8MvN6QKaBY3yv5OrhRxe4Rlfg9NBj224LIUwGGEXdFx7vfr5IrRKjm16Gpacw54JnEXYT3vt5S3J+2oRElyYCfBQczYPLWtS0Lb4E4u0C34fFtwLd/wc0y4Zj/IbfOBynhXuJLVJIZ+wPcZlEkVT48rDige8x5RNvyRTzMC4hPkQgzLufmSQp5nyRqIIxBhyEtm+CVVn3vc0aucPfig9aPO41Cx3Dr/E5wcLG2KXzus7rOq87wOveg4q5dMx/jePd2vZNvnduV+o953uktwbztl3riWkfE/p/f/KEQn+bJPgcoX/K6THc9nNEzKn4nzdiTpk+fsScM/p8EXPK8mm8tqEwLmRLIcQBbaUnh2HblC3uC29Es0UXXnThRRdefGJ4UZuUdPjeDay7dGSXjvy6fL1LR3bpyEdIRzI0+YsDP/DY1tVPUR2gdoDaAWoHqB2gpoD6MpCr19KHQxF1HsgVEdKHDlM7TO0wtcPUDlMLmGr2450yl+SIoXa7ns9044c67H+keQiPgpppdqMwfj/j1wSceaMvmGSrkflxMm+1zJ7+Z4O2ETwWbrTxfUjoaOf1GOjRxvULpVXd8rgSmIgtUx6CA9PKj8q4BsKvRzXMr3aY1mFah2kdpn1FmBbrWkSr7mDXLfi2l5e8xPZYYPKwcOeMKDX0TDGGnJPxZHr+/qxHJm9+u3h1Nj077ZHJ+PXk7NXZaalQxjSjPZq3w7/ThsXil7pRNYFq7Ux8ToytU9OXnLLrh0P1Jzu8rzoz8HTm8iv/Su4amAOc65uVgXrJ4nPhcT+trNwzkf3qzt+XoJdmRXTU9pAliwnLSwh5ShZXTiF1H+1Ng2BC1+11t0+7/e3dVphuK8y9t8LcMsXZLIAatK04a97+cNSuFBBmNA52COHcc4878TOVZySdJmpU4R6feXQAkW0tRL5PO9nJzas1G3rstbxuaOqqA93a+mhblGqm52Q4PDRmzktak8CUCD94dXylVjZX6aG11q0F3FzYtxD8m81kYkvQS0NrLmi9P6lmibXULDivCVnwWVqrbcACFwLj69Wi/6bU+17Rck1shPX4FvQymzb9DH8sELe1+jgsEoPuk3cx2EU5ffahWGT9IT0xAKuiBQERJyh7tb78gNrtcn34wcJjt/vKbmrZH0z0pkJua+p7Dlzy2LzFvsU0xLe5kVTOwfgExN1zTzOnzT5a+eaaL3ocbLywB1XnNSSdxeD7BYz7aYaDCxqbKrT+FlFbsdVSglLx1/vWpFR3urfsCv9bYyntEt//EtZOsfxlzJ2JKiSh2wkWk9Jucg35ny+WVfmC7zrtU1p492kII9A30YUdSOQ+naGdcfNpDQ17rP+WJZvtLC0bDg8g3LQBsW33zcHk63bjtOinMWR0rirbXilmuxV+32NhInzWZxHv38A67tvjYv71yfEc+RXWhGmt+CzBs1RYjCfRgOJe4SXLh0iBh5ZNR1ol0MWAXQzYxYBPOgZ8cL/u4sYubuzixn943Nhk4G3HfFWXvZZI8p7elO6MdrBpjy0bWTVXt9Txa442D2BYv/m7spmyUc+vTaT4K6zj+0aipZ4HxKTWLD89Ju1yjF182cWXTzu+7HKMXazYxYpdrNjlGL/SHCN2eHbf78sfkQiZMx6A3ye/SQXEB814EBOmChsldiuuXTJm0l/bvQ4136UjJWcBhK2x4xhXDmyZ8iV2qcD0hm04s9yv3r6ckJ+ePf/x+tul1lE8GgxWq1Vfzb0j8LmWqi/VYqDmHv6L7b7rk+kSFC6hazIDwnzfWA8LiktXHIHH59zLjpxOxSao39Jejrpgzzxt2H2bKF4xjzF59/acGF/n83UWApZY0+IR7CYWHc0CJm7ozirajHBM4iQMmSputikwSPE1OehMJZeB/3s6vSCWBPHQwDEMyBAAGeEgQi7wMHQ6ejYc9mh6NDod/TAcbpEmavyAkQgCd1HA0jB9bzhckHBnt2Zg+RUHD6MZqfiC7/OtuDD+eGpHlDnjsdsZ08iTBAw3Kt2ygPuEJXqJXL3s6HswQrAgbtj80TlZ52T/eCf7vmrvL6Wacd8HYcwz9zceY1xFWBDIFfidX3V+1flVnV89d0WSY2EOQFVoh6CUVER6ZruwjzfNBHmYmfHOUixdoNj5WudrNb627dEQ9FLiDVyRjI3pML2kIzpI3ekoT/oN7GsbxTt2FCZ0THYuUQEd0Y31nO1oMNgsZay3ow1uZ98OblEtpd3j+Nh6WGY5gfRYsLTcqxrEB6Kwh3tiPxSQF+Tt2eWU/MI0rFj61pxfoZWRfjF8MXS/IWOK101xfHFO7Ait/RUwISOLzu1OVJnGhxA2Z1bE4CWK6/UldrPTMwOmQI0TVEJuFyk/Q91kfEwj2kv/eJlZy39+nxqFI5693d14dnbHwsh64+72H1e6ZVhzd8TOMGtSnA0N8mSli3gxtdhAIxeuNukybMyZDEsZR3oyPHl2NPzx6OSn6fHz0fPj0cmL/vDH4//RQhaxqVEpDZdudchzZbthFMz+KqtOKD415QZ57YApbDUGfJXfz7Z7uLuxzF4yNsyvARvuXc91tbGWVbwGC3/bGsiZS2NWKSBUDRQFyxRGh/3jKvhcnBsM9WQYJsIspGKRHopeMHgvSOK0aCPgHmCWKK/QyNm+sk9IagXkuI/OahElWz8XXC+TWd+T4SD9RJj/dxbI2SBkXAxSFvFgMv7t3evT8dGr88nZ68uzo+P+sK/v7JcfxLeQiYIcJotV/bqxP+bNLnz4hBsIU1fWcKcHUcC4KWEyY92kmHtFK5hLM01ihtgi5xXdbJDROxVst/izSaPR0dX1zuLw/zBdDMy3JkFv0A3oxI7jaIqy7EywUtOBRWq2x9jzINKNba8La8jFm8spwlJ6zWIofeyj2AqvYGQrOqJYGmfm1aCd+W1DAyYWibFvamniP38BUV7qUA== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query process instances

+ Search for process instances based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Process instance search filter. - -
    processInstanceKey object
    - -The key of this process instance. - -
    oneOf
    - -integer - -
    processDefinitionId object
    - -The process definition ID. - -
    oneOf
    - -string - -
    processDefinitionName object
    - -The process definition name. - -
    oneOf
    - -string - -
    processDefinitionVersion object
    - -The process definition version. - -
    oneOf
    - -integer - -
    processDefinitionVersionTag object
    - -The process definition version tag. - -
    oneOf
    - -string - -
    processDefinitionKey object
    - -The process definition key. - -
    oneOf
    - -integer - -
    parentProcessInstanceKey object
    - -The parent process instance key. - -
    oneOf
    - -integer - -
    parentFlowNodeInstanceKey object
    - -The parent flow node instance key. - -
    oneOf
    - -integer - -
    startDate object
    - -The start date. - -
    oneOf
    - -string - -
    endDate object
    - -The end date. - -
    oneOf
    - -string - -
    state object
    - -The process instance state. - -
    oneOf
    tenantId object
    - -The tenant ID. - -
    oneOf
    - -string - -
    variables object[]
    - -The process instance variables. - -
  • Array [
  • ]
- -The process instance search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching process instances. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching process instances. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching process instances. - -
  • Array [
  • ]
- -The process instance 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-user-authorizations.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx index 0ef957f8d51..a0bbd34df02 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx @@ -5,91 +5,836 @@ description: "Search for user authorizations based on given criteria." sidebar_label: "Query user authorizations" hide_title: true hide_table_of_contents: true -api: eJztG2uT2jjyr6j0abfOAbKb3cvxjYAn4TIDLI+92ptMJcJuQBtbciR5ZjiK/37Vko1tMDNkL3dVV+tUpcaPfr/UFuodNWytafeW9lKzkYr/ixkuBb3zaAg6UDyxt106A6aCDVlJRVINirAyuCZLpiEkUpA1vwdBAsUNKM5aHwT1qExAWbhhSLt0xUW40KAqDDX1aMIUi8GAQnl2VLAYaJcit/ewpR7lKEfCzIZ6VMGXlCsIadeoFI6FnW+AfIYtkStiNkAyEvltRfQW9agONhAz2t1Rs02QJxcG1qCoR1dSxcy4Rz+/ovv9neMN2ryR4RZxAikMCIOXLEkiHli67d81irIrEWdRNF5Z1TI2cvk7BAY1V2giw0FbDKkstSMHSGXIikMUFtalXk6KKcWsjQzE+muYWYqn3NCCjpmRBAUiy22JnTaKizXde1SqEFQ9vn1FuCAPGx5sDoTQBQoiZiB0LJAuiDS2UTjrU48O/FnfheCKpRGa3z033ESQ2WKM1H1E2+/L8XCbqXRXArex+0sKaouYU+c/ur9DzISt4VT+CVtzYR1ZsfbFVlUyrjcKFyE8YiRaT1mjGKYM0VZGLtYEcUumro/FH39A40c85jWhgnxi9sjjNCYijZegKgwVmFQJdIwU6AprjQs5OjF7K1Pn9OFBJVcsGIK1SF8q52/7Dt3/KWLaoCt+ZVEK+hPJrGdTlJFEwT2Xqc7pKNCJFBqeiveqP/YHUd/ASqoaBx/LurRwtcKuuPpvS7uvDdYJW0MRrF6NjjVI5xFOUz+qdeP8uEbmmjkEXU2EKm7vPF7JHmcEkg8C1NyC1MmEyHkNt6B4k4CKuda4hNQxOCfnpfTyurSY+VPq0en42qcefTsdLybUoze9yWQ4eks9uhjNJn5/eDX0B+XKM841coXqDgsmPsIFrb48hBdq+MQSVbCveOPKeqFa/GoB64KpWmNxzbUPXKRb5/3Q6dSrdNoulDIljWzluXgNPe/fp0Pr2SrPhbMjXrOlTN06VRH0ycD/A6SelthIw6JhXjCOzIrvsoIeM+PWDWRS0xmcDxSPHlW2ev/ZRfveAuSxafEsf1xF3IKOahENpkUWGojZcJ2/+1SuxJ+ytgJLpyAgdIqyny5CFxT46iJysfCI9rWy2wXvm4n+VLV3GXWUnpWMPEAcRww/Eyy2G8iCpNq2Xy705Zn2pyjiCrRMVQDP65lDErNhJpNww+7hW+hc0JaEhWFbQSyrlImR7byfPLTYi/m78XT4z958OB4V+n+cLqxZbvzZrPcWr9705v131KO9yeR62M/BZ7/N5v4N9ejcH/VGc9utT67Hv9349mYyHff92ezjwL8ajoYZzsDvD2fD8ejj1P9lMZz6CHsOpPI091HZcyXPTEtuKJxT0r8UyHmAn5rzyBNnM+BoRTlg1QfBLIGArzj2kSWX/UGvX0Ts4OA+eoB6tD/1e3P/cPEx981wNJv3Rv3Sm4P1S6+mfm+Q/anDtM/RLx/nvdn7/EEdocVk4MRwF3XEsjdlcgP/2rdY7iLHKh4MpoPi5mo8vTmBLTiUYmZS8dtpSg/D56OmRyKuTSUFhwPnm8InpPiOQO+kgn9JIVvQ3abFcaTlX9Xl0l+IO5iPq68qTVu+LrxhtWvDN+o6DxI+I8UTgrq1rAToVVq+exG2AhanImQtlvDWZ9jqlvuI/ctpOxhCoiDArYTcpk2D2DSITYPYNIhNg9g0iE2D2DSITYP4P20Qv35bMpdrZHu897DVFzePFZQL2khnvpo2smkam6axaRqbprFpGpumsWkam6axaRr/73cVEfLV1/8k/QVXQ7JiPIKwRW6kAhKCYTzShCnAkx/3PISwtMhbhmQpw6077Hbmp+xEyWUEce0eZjUIJg4y40tcFhOmiQNcOu6306s++durn/56993GmER32+2Hh4eWWgUvIORGqpZU67ZaBfgf4b5vkfkGFK7aW7IELO0cebKIFE4l2pWEID/8kolti4PT75n+MqtaVc+WusRU8ZrAX0yHhIcgDF9t866zwpqWD4PZ9re7jJj4TIuAOGV6zEWncczU4RxglQGeGDLMpOXUOXsSqq7gv5vPJ8SRIIEMwZ6VtF1fxgiViLnAY1m0+6rT8Wh2SIt2f+509kgTPX6BJoLAYxKx7MvgSB0uSFzErVWMC22YCL6VZ6Tia37Mt1XJ3yyIB06jPB1f1qdj1uySiAWfNfbVPLTZiVyD/BAeWCFYpJ84L9IkWZNkf/ok+/E03q+kWvIwBGHD85BvXBMhDWFRJB8gbPKqyasmr87l1U91vWQPt+UMKIxDUEoqIoMgVQpCPPMeWfIBaJ3zznd1mkaxybUm187k2t6jMZiNxFmhRGobOjj006Vt/G7T7V02z7NvV/cd2+4bDgd6QN3nY0SpimiX7lwa7bvt9m4jtdl3d4lUZt++Rx/dM8XZMnKRia9duuVhFMmARRsnyqk78QXOKuVq9t3PDuQ1mfqzOXnLDDywrTVvcpjsyUm/7rzu1G8f4RZzPcXeZEichi4YSwUiJ4uZXkvWAV9C2I46aQhSxc12hmjOPEtgyg1vlYIk42ep470Dol52cZWHzt//Mbfex+I2Lcao/EcWJy41i6GE8pZv5dw8ZoCbkbo9zC8d9hDuiokeN4TTOYzJdI7GV253TsXymAg+29tEWEmrXxamp5bCsAGlnWk7rZenKTEZ2swOZBynwpZ3sSYP3GwIK1k+iFKdTUdEPADcvegeht9ysGv3hvzqOJKXLYwaF9p5VV9zs0mXrUDG7eyXr8PfZSSX7Zhx0c5Y6Ha/d7MYDXovrod9fzTzX7xsdVrm0f0EglkXM1GSw/5IUDf4d6x1aRzuPxoZzOLKwKNpJxHjAiPd6rvLqsGtnQxEAbrFiOCJcFlJuPOytL6lux0yXqhov8fHdsOHdm/viirgdkq5xuuQdlcs0scThmU1v5tmcxHfk6+cO6xVMt8iFFtbmKIU76hHP2PoH6Yh7ebiBljoAjl723dCvbBZU2CfjFTsvRyjFwSQmCdh70r1eDKe4Xb8Mht9jGWIOIo94Egme6Bd+oF+oHbk0+Q75fb5jkZMrFObmdTRxX//BtEfAsU= +api: eJztG2uP2zbyrxD81OIU22nTNvU3x9Ymvuzarh8tenuLhJbGNhuJVEhqd32G//thSMmSbHnX6eUOOFQBgtVj3i+OaM6OGrbWtHtLe6nZSMX/xQyXgt55NAQdKJ7Y2y6dAVPBhqykIqkGRVgZXJMl0xASKcia34MggeIGFGetfwrqUZmAsnDDkHbpiotwoUFVGGrq0YQpFoMBhfLsqGAx0C5Fbu9hSz3KUY6EmQ31qILPKVcQ0q5RKRwLO98A+QRbIlfEbIBkJPLbiugt6lEdbCBmtLujZpsgTy4MrEFRj66kiplxj358Rff7O8cbtHkjwy3iBFIYEAYvWZJEPLB0239oFGVXIs6iaLyyqmVs5PIPCAxqrtBEhoO2GFJZakcOkMqQFYcoLKxLvZwUU4pZGxmI9ZcwsxRPuaEFHTMjCQpEltsSO20UF2u696hUIah6fPuKcEEeNjzYHAihCxREzEDoWCBdEGlso3DWpx4d+LO+C8EVSyM0v3tuuIkgs8UYqfuItt+X4+E2U+muBG5j95cU1BYxp85/dH+HmAlbw6n8E7bmwjqyYu2LrapkXG8ULkJ4xEi0nrJGMUwZoq2MXKwJ4pZMXR+L33+Hxo94zGtCBfnE7JHHaUxEGi9BVRgqMKkS6Bgp0BXWGhdydGL2VqbO6cODSq5YMARrkb5Uzt/2Hbr/Y8S0QVf8yqIU9EeSWc+mKCOJgnsuU53TUaATKTQ8Fe9Vf+wPor6BlVQ1Dj6WdWnhaoVdcfXflnZfG6wTtoYiWL0aHWuQziOcpn5U68b5cY3MNXMIupoIVdzeebySPc4IJB8EqLkFqZMJkfMabkHxJgEVc61xCaljcE7OS+nldWkx86fUo9PxtU89+nY6XkyoR296k8lw9JZ6dDGaTfz+8GroD8qVZ5xr5ArVHRZMfIQLWn15CC/U8IklqmBf8caV9UK1+NUC1gVTtcbimmsfuEi3zvuu06lX6bRdKGVKGtnKc/Eaet6/T4fWs1WeC2dHvGZLmbp1qiLok4H/J0g9LbGRhkXDvGAcmRXfZQU9ZsatG8ikpjM4HygePaps9f6zi/a9Bchj0+JZ/riKuAUd1SIaTIssNBCz4Tp/97FciT9mbQWWTkFA6BRlP12ELijw1UXkYuER7UtltwveVxP9qWrvMuooPSsZeYA4jhh+JlhsN5AFSbVtv1zoyzPtL1HEFWiZqgCe1zOHJGbDTCbhht3D19C5oC0JC8O2glhWKRMj23k/eWixF/N34+nwH735cDwq9P8wXViz3PizWe8tXr3pzfvvqEd7k8n1sJ+Dz36fzf0b6tG5P+qN5rZbn1yPf7/x7c1kOu77s9mHgX81HA0znIHfH86G49GHqf/LYjj1EfYcSOVp7qOy50qemZbcUDinpH8pkPMAPzXnkSfOZsDRinLAqg+CWQIBX3HsI0su+5Nev4jYwcF99AD1aH/q9+b+4eJD7pvhaDbvjfqlNwfrl15N/d4g+1OHaZ+jXz7Me7P3+YM6QovJwInhLuqIZW/K5Ab+tW+x3EWOVTwYTAfFzdV4enMCW3Aoxcyk4rfTlB6Gz0dNj0Rcm0oKDgfON4VPSPEdgd5JBf+cQragu02L40jLv6rLpb8QdzAfV19VmrZ8XXjDateGr9R1HiR8RoonBHVrWQnQq7R89yJsBSxORchaLOGtT7DVLfcR+7fTdjCEREGAWwm5TZsGsWkQmwaxaRCbBrFpEJsGsWkQmwbxf9ogfvm2ZC7XyPZ472GrL24eKygXtJHOfDVtZNM0Nk1j0zQ2TWPTNDZNY9M0Nk1j0zT+3+8qIuSrL/9J+jOuhmTFeARhi9xIBSQEw3ikCVOAJz/ueQhhaZG3DMlShlt32O3MT9mJkssI4to9zGoQTBxkxpe4LCZMEwe4dNxvp1d98vOrH366+2ZjTKK77fbDw0NLrYIXEHIjVUuqdVutAvyPcN+2yHwDClftLVkClnaOPFlECqcS7UpCkB9+ycS2xcHp90x/mVWtqmdLXWKqeE3gL6ZDwkMQhq+2eddZYU3Lh8Fs+9tdRkx8okVAnDI95qLTOGbqcA6wygBPDBlm0nLqnD0JVVfw383nE+JIkECGYM9K2q4vY4RKxFzgsSzafdXpeDQ7pEW7P3Y6e6SJHr9AE0HgMYlY9mVwpA4XJC7i1irGhTZMBF/LM1LxNT/m26rkbxbEA6dRno4v69Mxa3ZJxIJPGvtqHtrsRK5BfggPrBAs0k+cF2mSrEmyv3ySfX8a71dSLXkYgrDhecg3romQhrAokg8QNnnV5FWTV+fy6oe6XrKH23IGFMYhKCUVkUGQKgUhnnmPLPkAtM5557s6TaPY5FqTa2dybe/RGMxG4qxQIrUNHRz66dI2frfp9i6b59m3q/uObfcNhwM9oO7zMaJURbRLdy6N9t12e7eR2uy7u0Qqs2/fo4/umeJsGbnIxNcu3fIwimTAoo0T5dSd+AJnlXI1++5nB/KaTP3ZnLxlBh7Y1po3OUz25KRfd1536rePcIu5nmJvMiROQxeMpQKRk8VMryXrgC8hbEedNASp4mY7QzRnniUw5Ya3SkGS8bPU8d4BUS+7uMpD5++/za33sbhNizEq/5HFiUvNYiihvOVbOTePGeBmpG4P80uHPYS7YqLHDeF0DmMynaPxldudU7E8JoLP9jYRVtLql4XpqaUwbEBpZ9pO6+VpSkyGNrMDGcepsOVdrMkDNxvCSpYPolRn0xERDwB3L7qH4bcc7Nq9Ib86juRlC6PGhXZe1dfcbNJlK5BxO/vl6/B3GcllO2ZctDMWut3v3SxGg96L62HfH838Fy9bnZZ5dD+BYNbFTJTksD8S1A3+HWtdGof7j0YGs7gy8GjaScS4wEi3+u6yanBrJwNRgG4xIngiXFYS7rwsrW/pboeMFyra7/Gx3fCh3du7ogq4nVKu8Tqk3RWL9PGEYVnNb6bZXMS35AvnDmuVzLcIxdYWpijFO+rRTxj6h2lIu7m4ARa6QM7e9p1QL2zWFNgnIxV7L8foBQEk5knYu1I9noxnuB2/zEYfYxkijmIPOJLJHpykMjH5Lrl9tqMRE+vUZiV1NPHfvwHZDwHJ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query user authorizations

+ Search for user authorizations based on given criteria. -## Request - -

Path Parameters

Body

required
    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Authorization search filter. - -
- -The user authorization search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching authorizations. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching authorizations. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching authorizations. - -
  • Array [
  • ]
- -The user authorization 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-user-task-variables.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx index 07d9f7fae71..3b3e75ac46d 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx @@ -5,79 +5,541 @@ description: "Search for user task variables based on given criteria." sidebar_label: "Query user task variables" hide_title: true hide_table_of_contents: true -api: eJztWt1v27YW/1cIPm24iuxu3W6v3tw03bxubW7idA+pgVLSkcWFIjWSSmIY+t8vDinJkq243m0G7MEFghoieT5/54PS2VDLVoZGt/TGgCaWmTu6DKgqQTPLlZynNKIZlykuL5i5+8g0Z7EAQwOagkk0L3Efjeg1MJ3kJFOaVC0tct9uJzEzkBIlyYrfgySJ5hY0Z+EnSQNaMs0KsKBRlA2VrAAa0arh+Q7WNKAcmZTM5jSgGv6suIaURlZXsCvJIgdyB2uiMmJz2EoT0oCaJIeC0WhD7bpEJlxaWIGmAc2ULpj1j358Set66RmBsa9VusYzW74ZEwYCmihpQVpcY2UpeOKsNvnDoCCbHjcmxIfMKdfwVfEfkFjUXaO1LQfjTijtqO3YVmlLMg4i3RqOBi0ppjVzFrJQmL/CzFHc54b288ysIigQidc9dsZqLle0DqjSKejx826JcEkecp7kHSH0hwbBLKSeBdIFWRUIwdn1OQ3om4vrc8RgChmrBPrDP7fcCmhs8QGpX+Cxuu6j4bZRadnb7mD53wr0Gk9eeYfSeoknS7aCffkv2YpL58iBtY+2qlbFuFG4TOERYek85YximbbEOBm5XBE82zP1ODi//w6NL3jBR6CCfAr2yIuqILIqYtADhhpspSU6Rkl0hbPGkRy9mLPMjjl93qnk8wDDbSE5V9r7262h+z8LZiy64iMTFZjPpLGei1dGSg33XFWmpaPBlEoaOIT3oT/qTtTXkCk94uBdWWO3b1TYjOu/W9p6FKyXbAVbsAYjOo4c6h8Yqtyl91bSP3H/CAA6ULfkdzP/GLvah6HX3Sn53XQ6js2x2rBrPFcTjk6tQx6tmLt67vmlU/TYuP5isuDSxwz+ZrGqfLrbKlcJa4aJ5KtJHZbYKsvEvMXdji9wrckLBbM+/SCTkQLzdI0M6E6AjDvd5f57t6Gtyu6c44/JyNcFVIsYsCG5MUBszk279rkf0J+b6oQRKAlIU6Hs+1A+Ik8Mc9HRwuOxvyq7y5vPJvqhpOGh3pS40SzR7dhFDH8CLK6oNCDp4vaQvIeDsg1HZ8PDMTkk9JoZIFuRXbfZEp8/QWuooe8td+m+ZwV453LTKTja8zggjGkoqiMpZJUQH8epvK2E8FA7jpQFyaSdj/VwboXM3xxHiJuFrmSCfdk+rd9zsDlm7Rwa4bghtt1PlCZS9cEbKyWAyUGR6jsJnTiCvVZAbPdHEYg9PTr8y+qYRJWH6TSB7DYeZ6JSqwSMmUtjmUyOot4cIbw5cwyjJ2w2DPnRWtwGdR0MCua9TMOEFZVMWchKHt7B2oS+M/zXVxZT8g7WhFmreVxh08QMtpygedLky9DdEksNDbL8be1UgE8F+FSA/0EF+Nnj+FS0T0X7yKJ9KLU9Xxk/xOVvLuwHXjCOW/q9q83vYG2OLvqDI0eUf4+hry3/p7v0qZSfSvk/q5Sf7tKnsny6Sz/fXRp3vvw/3mX7UpkxLiANyW9KA0nBMi4MYdppc89TSHs5zwdxrNL1wfffpVaxgOKLtXtGLv3Ohi/xMYy9vd8Ye+63V2/PyX9e/vDv5Te5taWJJpOHh4dQZ8kZpNwqHSq9mugswT/c921IFjloTGJrEgNhacqRJxP9ZGJKSHjGk/ZDSiM2QQ95/b5Qbt3qZsejvaJZab73CXpGbq7mhKcgLc/WbREesKb9D4uuG4hiweQd3SJin+kuF1MVBdN9aPYYYMhYZqt+qXnyq9rYp+ufF4tL4kmQRKWwjdOGESpRcImf+Gj0cjoNaPPBj0Y/Tqc10kSPH6GJJPBYCtY0SjvqcEmKLW6dYm3wPZNnlOYrvss3HMRtA+I3XiMfjz+MxeMMGz0LGnEIWitNVJJUWkOKn6BFl0Ba3m2fcIq1U6ydYu2JWKsDWoDNFU4Blco46OAETkQnWPvOsPaZyaY3qFNPulI48aUQh25A37ezPZUWNKIbH0p1NJlscmVsHW1KpW09uUc/dSRQd1z2IddCSaiEidyLs+9SXJBdCwrk3F9+yStydXG9ID8xCw9s7UxcdsM2LelX01fTUaq49QmKs8s58Rp6QPaSREsWo32UrN98DGE3jmQgqTS362s85s0TA9OgZxV6pQNKw89Rd12k20SD5sfbFj6//L5wCMAEd7Uddbp4ZEXpw9PPI912s0Jdb7XcTs/4gZdpN5Iy3RkVud142fsjGfisdijPlBO8weC+CRAPoI232TR8sY/3y7kL20QVRSVd7pYr8sBtTljPpImoDI6kUJQzAWzvuitMx/ZXv0I+eo7kRYhw8JhtU/aK27yKw0QVk+bFSvd/LFQ8KRiXk4aFmZzPfrt5/2Z29uv8/OL99cXZi3Aa2kd/Y8aQKpjsyeHaz7G+clfrzbZmfdXkXQMYC492UgrGJULY6btpQv2WbkOdBjQaTuX1BWzifRk0MXtLNxtkfqNFXeNj1xTT6Ha5Pefvpdzg7+1Y3ZOqfnPVzHp9Sw5N+Y1q1V6vpZfbXRopDegd3j4Gw4b1sg5oDiz16G12nHspzhZIZ0thbzilDtoTsySB0h7cu+xl2MsP1wuM0WbYsFApntHsASce2QON6Cf6CSVWzjIu/N3zDRVMrioXjtTTxX//A6XMpGQ= +api: eJztWt1v27YW/1cIPm24iuxu3db5zU3TzevW5iZO95AZKCUdWVwoUiOpJIah//3ikJIs2Yqr3WbAHlwgqCGS5/N3PiidLbVsbejslt4Y0MQyc0dXAVUFaGa5kouEzmjKZYLLS2buPjLNWSTA0IAmYGLNC9xHZ/QamI4zkipNyoYWuW+2k4gZSIiSZM3vQZJYcwuas/APSQNaMM1ysKBRlC2VLAc6o2XN8x1saEA5MimYzWhANfxVcg0JnVldwr4kywzIHWyISonNYCdNSANq4gxyRmdbajcFMuHSwho0DWiqdM6sf/T9S1pVK88IjH2tkg2e2fFNmTAQ0FhJC9LiGisKwWNntcmfBgXZdrgxIT6kTrmar4r+hNii7hqtbTkYd0JpR23PtkpbknIQyc5wNGhIMa2Zs5CF3PwdZo7iITe0n2dmFUGBSLTpsDNWc7mmVUCVTkAPn3dLhEvykPE4awmhPzQIZiHxLJAuyDJHCM6vz2lA31xcnyMGE0hZKdAf/rnlVkBtiw9I/QKPVVUXDbe1SqvOdgfL/5agN3jyyjuUVis8WbA1HMp/ydZcOkf2rD3aqlrlw0bhMoFHhKXzlDOKZdoS42Tkck3wbMfUw+D89hs0vuA5H4AK8snZI8/LnMgyj0D3GGqwpZboGCXRFc4aIzl6MeepHXL6olXJ5wGG20JyrrT3t1tD938SzFh0xUcmSjCfSG09F6+MFBruuSpNQ0eDKZQ0cAzvfX9UraivIVV6wMH7skZu36CwKdf/tLTVIFgv2Rp2YA0GdBw41D3QV7lN742kf+H+AQC0oG7I72f+IXaVD0Ovu1Pym+l0GJtDtWHfeK4mjE6tfR6NmPt6HvilVXRsXH82WXDpYwZ/s0iVPt3tlCuFNf1E8sWkjktslWVi0eBuzxe4VueFnFmffpDJQIF5ukYGdC9Ahp3ucv+929BUZXfO8cdk5OsCqkUM2JDcGCA246ZZ+9QN6E91dcIIlASkKVH2QyiPyBP9XDRaeDz2d2V3efPZRD+WNDzU6xI3mCXaHfuI4U+AxRWVGiRt3B6T93hQNuHobHg8JvuEXjMDZCey6zYb4osnaPU19L3lPt33LAfvXG5aBQd7HgeEIQ1FOZJCWgrxcZjK21IID7VxpCxIJu1iqIdzK2TxZhwhbpa6lDH2ZYe0fs/AZpi1M6iF44bYZj9RmkjVBW+klAAme0Wq6yR04gD2GgGx3R9EIPb06PDPq2NiVRynUwey2zjORIVWMRizkMYyGY+iXh8hvD4zhtETNuuH/GAtboK6CnoF814mYczyUiYsZAUP72BjQt8Z/ucLiyl5BxvCrNU8KrFpYgZbTtA8rvNl6G6JhYYaWf62dirApwJ8KsD/ogL87HF8Ktqnoj2yaB9Lbc9Xxo9x+YcL+5EXjMOWfu9q8zvYmNFFv3dkRPn3GPrS8n+6S59K+amU/7tK+ekufSrLp7v0892lcefL/+Ndti+VKeMCkpD8pjSQBCzjwhCmnTb3PIGkk/N8EEcq2Rx9/11oFQnIP1u75+TS76z5Eh/D2Nv7jZHnfnv19pz8+PK7H1ZfZdYWZjaZPDw8hDqNzyDhVulQ6fVEpzH+4b6vQ7LMQGMS25AICEsSjjyZ6CYTU0DMUx43H1JqsQl6yOv3mXLrVrd7Hu0UzVLzg0/Qc3JztSA8AWl5ummKcI817X5YdN3ALBJM3tEdIg6Z7nMxZZ4z3YVmhwGGjGW27JaaJ7+qDX26/nm5vCSeBIlVArs4rRmhEjmX+ImPzl5OpwGtP/jR2ffTaYU00eMjNJEEHgvB6kZpTx0uSb7DrVOsCb5n8ozSfM33+Ya9uK1B/MZr5OPxu6F4nGOjZ0EjDkFrpYmK41JrSPATtGgTSMO76RNOsXaKtVOsPRFrVUBzsJnCKaBCGQcdnMCZ0QnWvjOsfWay7QzqVJO2FE58KcShG9D3zWxPqQWd0a0PpWo2mWwzZWw12xZK22pyj35qSaDuuOxDroGSUDETmRfn0KW4INsWFMi5v/ySV+Tq4npJfmIWHtjGmbhoh20a0q+mr6aDVHHrExTnlwviNfSA7CSJhixG+yBZv3kMYTeOZCAuNbebazzmzRMB06DnJXqlBUrNz1F3XaTbRIP6x9sGPr/8vnQIwAR3tRt1unhkeeHD088j3bazQm1vtdpNz/iBl2k7kjLdGxW53XrZuyMZ+KxyKE+VE7zG4KEJEA+gjbfZNHxxiPfLhQvbWOV5KV3ulmvywG1GWMeksSgNjqRQlDMGbO/aK0zL9le/Qj56juRFiHDwmG1S9prbrIzCWOWT+sVK+38kVDTJGZeTmoWZnM9/u3n/Zn726+L84v31xdmLcBraR39jxpDKmezI4drPob5yX+vtrmZ90eRdDRgLj3ZSCMYlQtjpu61D/ZbuQp0GdNafyusKWMf7Kqhj9pZut8j8RouqwseuKaaz29XunL+XcoO/d2N1T6r61VU96/U1OTblN6hVc72WXm53aaQ0oHd4++gNG1arKqAZsMSjt95x7qU4WyKdHYWD4ZQqaE7M4xgKe3TvqpNhLz9cLzFG62HDXCV4RrMHnHhkD15a5aziQt8921LB5Lp0oUg9Tfz3Pycio2g= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query user task variables

+ Search for user task variables based on given criteria. -## Request + -

Path Parameters

Body

    sort object[]
    + -Sort field criteria. + -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
- -The user task variables search response. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching variables. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching variables. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching variables. - -
  • Array [
  • ]
- -The user task variables 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/find-user-tasks.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx index 15f345b3332..ee39edc7f92 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx @@ -5,128 +5,1107 @@ description: "Search for user tasks based on given criteria." sidebar_label: "Query user tasks" hide_title: true hide_table_of_contents: true -api: eJztHGtz2zbyr2Aw/dDOyZLSJm1O3xTZSX1xEp8fuQ+OZwKRKwk1CDAAKFuj0X+/WYCkSAmS6dju9e6YGU8kYbG7wD6wDxJLatnU0MEVvTSgiWXmhl53qEpBM8uVPI7pgE64jHH4gpkbQzs0BhNpnuI4HdBzYDqakYnSJCtwGDJmBmKiJJnyOUgSaW5Bc9b9ImmHaviWgbFvVLygg6X7yjXEdDBhwkCHRkpakBbHWJoKHjleen8YJLikJppBwtyoEJ8mdHC1pHaRAh1QNf4DIks7NNW4BsvBuBlKO2wbnCttyYSDiNf80U6BimnNFrRDuYXEPISYw7hN7WIGOTGrCDJExosKOWM1l1O66lClY9Dh+W6IcEluZzyalYjsDIgGwSzEngTiBZklKNjh+Yh26OHR+QglG8OEZcLSQf675VZAvhefEPsRTlutOhWpXOVLuq6AO6H/MwO9wJlnXqB0dY0zUzaFbf5P2ZRLJ8jabjfeVa2S8KZwGcMdURPiJOU2xTJtiXE8cjklOLey1VxamIKmHTpROmHW//TLz7j5gic8oCpIJ2F3PMkSIrNkDLpGUIPNtETBKImicLvRkKJnczixIaEfl0vyVsYQrEtGSnt5uzEU/1fBjEVRfGYiA/OV5Lu3QD4ZSTXMucpMgUeDSZU0sE/f6/JYlay+gYnSAQFv8jp2cEFmJ1w/N7eroLKesimslbUTWGNgUnVCfcml0yw4/YbwAQXY6SpEUOyobtkmbg9s6kazix8P3JyTLPfv72FR2c213m7zdwML5/TtjJs1s90NHf/1pdNxyyxU8ObOLoTWgaIa2OoeVB3a6OxoeHF0SDt09OnD6clR/nn4cXR04j6+HR7jh+tVhzJj+FRCQFuRVjEaJLdrj88d72uNveV2RiaZEITFcyYjiAuBRSxlYy447nFIAkpC3fWVZ8AmzWGJ2RP30r1fqj/At+2Vj2YQ3RgnO/iWMcGLReAWpFrNeQwxmaNlBs+nH+Q9WLn8Prxwx401O1FzL6Qo0xqkXQvAT6ugHCslgEmHk8v78JV4EmajGRjC5KJQiDrXpoH/KZaDtAW/CSjePdRrZBFDvmNf5HmWpkrjGX/LRRwxHZNoxjSL0CuQGFKQLuJym6TkhE8zXVFGwUFaH39t81p4vULRvJK/9e5pVT34KwOnOe947KPmcaW5XYRNrRh9kKkde/ezYWuPNrM9p/FOw8vnkB8d5E//CQvcF0Q8rU3upfQcVjoNhFzvNDA8wuyMSRKpJGWaGyUfy/7UBmyyRquQyhMSFYH1najbp1+dCK2uQukZ1vZne9jdzIQcWe5CAp6sNlJ3ZSAgAWmP42YhSw5Ojg8D3m3VoRGTMY+ZhXdaZWnYP5YwZIpAOyKrNiZpY5I2Jmkek5RWhYnRfYbnLK21u9buWrt7fC6gIjDmECZcclzrw8oK6x1HLCQu0YSrCzncsTQWGX4ULZ4jCVOyIFnDuMBBliFB3aGEdqhpsLEOMkLbUwleHrMbRUSzfzc29v0z05yNBVRNoDCNjVJwznkxk8yLqViSURFnXrNzf1FzxTsKfpveTrKkQcHpI0vK4k/Bg9tEZ2fNBOJAA0gqllQ0T4od8iZTlhWx7KwiJppv4AmC/7/vWgB0A+Q6BBMq7K58w8NXmd1O/NzvNyzLajCZyJ1p48ZVwzLyVtm7lFvTtsm9vRguvWHjZzZWme8m1da2t+T8Haj2c2yVZeK40NcNAeBY3nZxhyQGQO6M2+7fhfNE77k2+g9hSbvWmj/sC0V18xx97PX4thsuixiwXXJpwLv6fOxrtV/yNW/+YYNDEpAmQ9636/MN2jD1Vk9j5nHaQ3l3baknY31fT8ar+obN1my1hNjUGL5DWVzPLleSdWu6OcO7lf4NM2W4xsFHuoV/QdW9X8ubeVpcAkIG05L/0r7KVqz/rNWW+8/SQPXF7EgD9wT4tUzzoUSRyHfQfL4YMsJ6KFfysLF6FTNInKsZ29ETxPEDyxNwdFSSCnggpXLOw2hNlBDq9jJtTsnPeBiVOIPmBOIMHob96fIPuLOgJRNvlU7OYAIaZNSQ62IqKmxCdDE5nNZ8Bm24j34apCBzD908AfQ16CgzViW/A4vrtlf63o2s24GTmYfP7W6zJRXHjiATp/XoJGCF675XgyVWG2FVmRMcnPHpDHQeE2OAbOs/FpORw4RLfByFDvodmj+aQgcv+v3KMz6v+qEAGA8oPMACJ+nGUwB7c8RmTj2Yhe5Rrr1J6P2VhWaYd3i9vXWEh2Gu8YwK+z3IcF44JUIRhjOgYMSEB3YlHZnLuBuxJJMx67KUd29gYbr+qaa/PTZVIe9hQZi1mo8z6zJTfF4KNI8qdbMYUg0Rpqt0YHUGbXrTpjdtevP86c1D7K5NeNqEp0142oSnTXjahKdNeHY59X1R2J/eiPufa7duJ04N0fvMaRvlDuX46HKf97AwjZOq2pQG6ZW3n0enV20nqE2V2lSp7QS1iVGbGLWJUZsYtYlRmxj9JROjthP01+wEIeTLxs+2+exjwriAuEs+KA0kBsu4MITpyrPJ6zDS0SFjFS/2PhGXajUWkNybDw3JqYfM6RJvyNhW8oBjT/3q7O2I/P3lq9+uf5xZm5pBr3d7e9vVk+gAYm6V7io97elJhH8I95MzM41x4YKMgaytvBrNmRQiPuFR8eJ6zjZB4dUen96VwbjRbWGXjivTfEv2Q3J5dkx4DNLyyaLIa2qkafUiB5dgDcaCyRu61oP7NGxITJYkTFcVtkIgDymzRm9ehbT394uLU+JRkEjFlcA1J1TzXC/7Vd/1a7+PB6iTeIOVSAJ3qWB57rmxHC5JstZbt7DCJJ9IMkrzKd+kW7fWXIkP/YoKK3wRtsI8nSKC4bsBcyZ4TFhmZ0g1Ki7QAMcEEy6JaY2sNbLWyMJG9su2vr9VeszjGKQPtQp744ZIZQnDUB/i1q5au2rtapddvQqFkEPprklwGSForTRRkXtDL8b7qkQZExe0i7phGyi2ttba2g5bW3VoAnam8CK+VBmnOszO6ID2MF07cJXsns/XKF7Rpeeu9HG1pJkWdECX3mRWg15vOVPGrgZLfHV01ZujPObVd85w2JtWoTLuvbSZJ7stOhyQlZfBRr7rRV6Ts6PzC/KOWbhlC59RlzfwFahf91/3w3URbFiEMQ5Pj4lfoVe8ijMo0KJVh8veDrgJ4hWWQwxEGRZYznGa354xMA16mOHulwqR03PY8bsHop38w9tCTf7xrwsnaXRkZ+v7D4/uGBYxae0ysFrxpV8W9yt1+XXVfa2R6/JTv1ZKX0NsXkQRGPEvyleRhqos/XCJpF+tS+7BUR8OFYi2CVRejrwqmiZrHPmbh2XZ6Xr7lcoms1CnnKJeldc4VlEWLVR/F2G/vC2wv3GL39XSa1D1tjz8beV8ykQ59cktflsRkbGiVkr73Rfb3uX02DnJSCVJJt1JKaf53UgVxY5EZvKbAQSPAOs/ZbupJHviR0henSUvumiU3nMUB+SU21k27kYq6eV97fL/sVDjXsK47OUkTG80/HD58XB4cHI8Ovp4fnTwotvv2jvfr0QHljBZ4cPVpyo9uc3FLteBwffcNJobqYU720sF4+4iALe6Ze5Gr+jajdJCaHjVpXeGV3S5RAqXWqxW+LMridHB1fXad+K3VYf6KrLTnRvUYTrynB9cIBNrbdt6MxTvePAzhlEEqd0Le105D04/nV+gp8nvUU1UjHM0u8U7VtktHdAv9AvF2yXcbjon5n5fUsHkNHPqTD1e/PdvOyABXg== +api: eJztHGtz2zbyr2Aw/dDOyZLSJm1O3xTZbn1xEp8fuQ+uZwKRKwk1CDAAKFuj0X+/WYCkSAmS6dju9e6YGU8kYbG7wD6wDxJLatnU0ME1vTKgiWXmlt50qEpBM8uVPInpgE64jHH4kplbQzs0BhNpnuI4HdALYDqakYnSJCtwGDJmBmKiJJnyOUgSaW5Bc9b9XdIO1fA1A2PfqXhBB0v3lWuI6WDChIEOjZS0IC2OsTQVPHK89P4wSHBJTTSDhLlRIT5N6OB6Se0iBTqgavwHRJZ2aKpxDZaDcTOUdtg2OFfakgkHEa/5o50CFdOaLWiHcguJeQwxh3Gb2uUMcmJWEWSIjBcVcsZqLqd01aFKx6DD890Q4ZLczXg0KxHZGRANglmIPQnECzJLULDDixHt0MOjixFKNoYJy4Slg/x3y62AfC8+IfYjnLZadSpSuc6XdFMBd0L/ZwZ6gTPPvUDp6gZnpmwK2/yfsSmXTpC13W68q1ol4U3hMoZ7oibEScptimXaEuN45HJKcG5lq7m0MAVNO3SidMKs/+mnH3HzBU94QFWQTsLueZIlRGbJGHSNoAabaYmCURJF4XajIUXP5nBiQ0I/KZfkrYwhWJeMlPbydmMo/i+CGYui+MxEBuYLyXdvgXwykmqYc5WZAo8GkyppYJ++1+WxKll9BxOlAwLe5HXs4ILMTrh+aW5XQWU9Y1NYK2snsMbApOqE+pJLp1lw+hXhAwqw01WIoNhR3bJN3B7Y1I1mFz8euDknWe7f38Oisptrvd3m7xYWzunbGTdrZrsbOv7za6fjllmo4M2dXQitA0U1sNU9qDq00fnR8PLokHbo6NOHs9Oj/PPw4+jo1H08Hp7gh5tVhzJj+FRCQFuRVjEaJLdrjy8c72uNveN2RiaZEITFcyYjiAuBRSxlYy447nFIAkpC3fWVZ8AmzWGJ2RP30n1Yqt/B1+2Vj2YQ3RonO/iaMcGLReAWpFrNeQwxmaNlBs+n7+QDWLn8Nrxwz401O1FzL6Qo0xqkXQvAT6ugHCslgEmHk8uH8JV4EmajGRjC5KJQiDrXpoH/KZaDtAW/DSjeA9RrZBFDvmO/y4ssTZXGM/6OizhiOibRjGkWoVcgMaQgXcTlNknJCZ9muqKMgoO0Pv7a5rXweoWieSU/9u5pVT34KwNnOe947KPmcaW5XYRNrRh9lKmdePezYWtPNrM9p/FOw8vnkO8d5A//CQvcF0Q8r03upfQSVjoNhFy/amB4hNkZkyRSSco0N0o+lf2pDdhkjVYhlWckKgLrO1V3z786EVpdhdILrO3P9rC7mQk5styFBDxZbaTuykBAAtKexM1ClhycnBwGvNuqQyMmYx4zC79qlaVh/1jCkCkC7Yis2pikjUnamKR5TFJaFSZGDxmes7TW7lq7a+3u6bmAisCYQ5hwyXGtjysrrHccsZC4RBOuLuRwJ9JYZPhJtHiOJEzJgmQN4wIHWYYEdYcS2qGmwcY6yAhtTyV4ecpuFBHN/t3Y2PfPTHM2FlA1gcI0NkrBOefFTDIvpmJJRkWcec3O/UXNFe8o+G16O8mSBgWnjywpiz8FD24TnZ01E4gDDSCpWFLRPCl2yJtMWVbEsrOKmGi+gacI/v++awHQDZCbEEyosLvyDQ9fZXY78WO/37Asq8FkInemjRtXDcvIW2XvUm5N2yYP9mK49IaNn9lYZb6bVFvb3pLzN6Daz7FVlomTQl83BIBjedvFHZIYALkzbrt/F84Tvefa6D+EJe1aa/6wLxTVzXP0sdfj2264LGLAdsmVAe/q87Ev1X7Jl7z5hw0OSUCaDHnfrs83aMPUWz2Nmcdpj+XdtaWejfV9PRmv6hs2W7PVEmJTY/gOZXE9u1xJ1q3p5gzvVvp3zJThGgcf6Rb+BVX3YS1v5mlxCQgZTEv+S/sqW7H+i1ZbHj5LA9UXsyMN3BPg1zLNxxJFIt9A8+ViyAjroVzJw8bqVcwgca5mbEdPEMcPLE/A0VFJKuCRlMo5j6M1UUKou6u0OSU/43FU4gyaE4gzeBz258s/4N6ClkwcK52cwwQ0yKgh18VUVNiE6GJyOK35DNpwH/00SEHmHrp5Auhr0FFmrEp+AxbXba/0vRtZtwMnMw+f291mSyqOHUEmzurRScAK132vBkusNsKqMic4OOPTGeg8JsYA2dZ/LCYjhwmX+DgKHfQ7NH80hQ5e9fuVZ3ze9EMBMB5QeIAFTtKNpwD25ojNnHowC92jXHuT0IcrC80w7/B6e+sIj8Nc4xkV9luQ4bxwSoQiDGdAwYgJD+xKOjKXcTdiSSZj1mUp797CwnT9U01/e2qqQt7DgjBrNR9n1mWm+LwUaB5V6mYxpBoiTFfpwOoM2vSmTW/a9Obl05vH2F2b8LQJT5vwtAlPm/C0CU+b8Oxy6vuisD+9Efc/127dTpwaoveZ0zbKHcrx0eU+72FhGidVtSkN0itvP09Or9pOUJsqtalS2wlqE6M2MWoTozYxahOjNjH6SyZGbSfor9kJQsjXjZ9t89nHhHEBcZd8UBpIDJZxYQjTlWeT12Gko0PGKl7sfSIu1WosIHkwHxqSMw+Z0yXekLGt5AHHnvr1+fGI/P31m19uvp9Zm5pBr3d3d9fVk+gAYm6V7io97elJhH8I94MzM41x4YKMgaytvBrNmRQiPuFR8eJ6zjZB4dUen96VwbjRbWGXjivTfEv2Q3J1fkJ4DNLyyaLIa2qkafUiB5dgDcaCyVu61oOHNGxITJYkTFcVtkIgDymzRm9ehbT3t8vLM+JRkEjFlcA1J1TzXK/7Vd/1c7+PB6iTeIOVSAL3qWB57rmxHC5JstZbt7DCJJ9JMkrzKd+kW7fWXIkP/YoKK3wVtsI8nSKC4bsBcyZ4TFhmZ0g1Ki7QAMcEEy6JaY2sNbLWyMJG9tO2vh8rPeZxDNKHWoW9cUOksoRhqA9xa1etXbV2tcuu3oRCyKF01yS4jBC0VpqoyL2hF+N9VaKMiQvaRd2wDRRbW2ttbYetrTo0ATtTeBFfqoxTHWZndEB7mK4duEp2z+drFK/o0nNX+rhe0kwLOqBLbzKrQa+3nCljV4Mlvjq66s1RHvPqO2c47E2rUBn3XtrMk90WHQ7IystgI9/1Im/J+dHFJfmVWbhjC59RlzfwFajf9t/2w3URbFiEMQ7PTohfoVe8ijMo0KJVh8veDrgJ4hWWQwxEGRZYLnCa354xMA16mOHulwqR03PY8bsHop38w3GhJv/416WTNDqy8/X9h0f3DIuYtHYZWK340i+L+9UK/LrsvlbJdf2pX6ulryE2b6IIjPg35atIQ2WWfrhG0q8WJvfgqA+HKkTbBCpvR14XXZM1jvzVw7LudLP9TmWTWahUTlOvy3scqyiLHqq/jLBfXhfY37jG73rpVah6XR7+tnJOZaKc/uQmv62JyFhRLKX97qtt93J24rxkpJIkk+6olNP8cqSKZkciM/nVAIJHgAWgst9Ukj31IyQvz5JXXbRK7zqKE3LK7SwbdyOV9PLGdvn/WKhxL2Fc9nISpjcafrj6eDg8OD0ZHX28ODp41e137b1vWKIHS5is8OEKVJWm3OZil+vI4FuuGs2t1MK97aWCcXcTgFvdMvej13TtR2khNLzr0nvDa7pcIoUrLVYr/NnVxOjg+mbtPPHbqkN9Gdnpzi3qMB15zg8ukYm1tm29GoqXPPgZwyiC1O6FvakcCGefLi7R1eQXqSYqxjma3eElq+yODiheLeF20nkw99uSCianmVNl6nHiv38DvP0AmQ== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query user tasks

+ - + Search for user tasks based on given criteria. -## Request + -

Body

    sort object[]
    + -Sort field criteria. + -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -User task filter request. - -
    assignee object
    - -The assignee of the user task. - -
    oneOf
    - -string - -
    priority object
    - -The priority of the user task. - -
    oneOf
    - -integer - -
    candidateGroup object
    - -The candidate group for this user task. - -
    oneOf
    - -string - -
    candidateUser object
    - -The candidate user for this user task. - -
    oneOf
    - -string - -
    processInstanceVariables object[]
    - -Process Instance variables associated with the user task. - -
  • Array [
  • ]
  • localVariables object[]
    - -Local variables associated with the user task. - -
  • Array [
  • ]
- -The user task search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching user tasks. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching user tasks. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching user tasks. - -
  • 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-users.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx index f3114e19fb9..8fc7a5fad4a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx @@ -5,88 +5,588 @@ description: "Search for users based on given criteria." sidebar_label: "Query users" hide_title: true hide_table_of_contents: true -api: eJztWtty2zYQ/RUMntopQ8mJk6Z8U3xp3ebi+pI+OJoxSK5ExCDAAKBljYb/3lmAlCiJspVM+tIwM55IBLC72N1zAK52QS2bGhrd0GsDmo4DqgrQzHIlz1Ia0QmXKY4YGtAUTKJ5gWM0opfAdJKRidKkxAkkZgZSoiSZ8nuQJNHcguYs/CRpQDV8KcHYNyqd02hBEyUtSIsfWVEInjiNg88GRS+oSTLImRsV4sOERjcLaucF0Iiq+DMklga00Gip5WDcCqWdtA0blbZkwkGkK3No0IhiWrM5DSi3kJuvUeYkbmu7yqBWZhVBg0g8b6kzVnM5pVVAlU5Bd693Q4RLMst4ki0F2QyIBsEspF4FygVZ5hi50eURDejxyeURxi+FCSuFpVH93HIroPbFB5R+gsuqyseEa0hRht/SuDXdhffvEvQcV174+NFqjCsLNoVt+8/ZlEsXyDVv7+1VrfJup3CZwgNRE+Ii5ZximbbEOBu5nBJc23I1lxamoGlAJ0rnzPpHL56j8wXPeUeqoJ6cPfC8zIks8xj0mkINttQSA6MkhsJ5Y0+N3szRxHYF/Wy5JY8nhtNCcqS0j7cbw/DfCmYshuIjEyWYW1J7b452MlJouOeqNI0cDaZQ0sBj+b4ej2pp6huYKN0R4E1bYzev09gJ1/+1tVVnsp6zKaySNejYY8ei3Qu2oS86w4jpgzTYbMjPM+v5v77kemt6a/c71KMKyfKO2DQG4Cj62NbfOwlot4i9lkPOuOhe74aeENCKAfrg1O19nWDa411xWqcvq0twD3wSOU89Hw6fjpIGUwoH470PpM347MtuT1Iml5458DOLVelJf83QR9PpG0Q9brFVlomzBn0bjsSxmh1zZj0Jo5KOY7abGl8dYiZt0ER3xNwJeO8mNJnl1jn9SMn+dMRtEQM2JNcGiM24acZu27R2W5/RyEOSgDQl2r7N6Huw5Toj7208Lvta293p8d1Mf4w6PYY2cLiGweWMzYzhO5LFHa11kri74v627g8wvuNGdna8g44ey8v/I882gXvDOoN3B/NuVXcw/zZF64m2ovLWeLDGtvcyDROWlzJlISt4eAdzE/rL2C/bTJxCoSHBK7E/Abb5rOfmnpt7bu65+Ufk5t0e3KH6vePZv2BunuLttZl7MLjfcweD93zd83XP1z1f93z9Pe7SOOFwn6rHF0w9MmFcQBqSd0oDScEyLgxhGrBSd89TSFuIcipIrNK5r+bvqJYUWsUC8s67etugETn3M2u9xKchYYb4ibHXfnNxekR+O3z56/inzNrCRIPBbDYL9SR5Bim3SodKTwd6kuAfzvs5JFcZaITInMRAWJpy1MkEWQWImAISPuFJU6yszSYYCb+/J8jcjS42ItdK/VLzrZ9LRuT64ozwFKTlk3lD8Wuqabt4786aKBZM3tFV5LeVbmoxZZ4zvcyydQVY4bXMlm1y2Fm53pSNafTH1dU58SJIolJwP/84iq0V4SZyLrGMTqPD4TCgdVGdRq+Gwwpl2hqIT+xEEngoBKuP4Y3tcEnyVd66jXFpLJPJ94qM0nzKN/WGa/isk/jY76gB4EE3AOuThQiW3Bk8xHhKWGkz1Jo0P5qAM4IJ80hJsgdZD7IfHmQvtvP9VOmYpylIl55LvHFDpLKECaFmkPa46nHV42oXrl523R5H+A5s8ZIuCGitNFFJUmoNKfYoCCc+AWMa3c0rVH9R7LHWY20H1qqA5mAzhS1WhTIudZjNaEQH7qV+4F/VKHZk6Htsv8KX9lILGtGFR0sVDQaLTBlbRYtCaVsN7jEU90xzFgufgDjsUdVki1AJE5nXuB01HGi/TR/5Uh55TS5OLq/I78zCjM2dF4tlw1Uj+vXw9bBTKk7dIXF0fkb8Dn3OtXigEYuA7hTrJ+8juMI3dANJqbmdX+Iy754YmAY9KtHxy1yo9Tnp+N1PokH94bTJkD//uXJBRg67WHW3nTywvPAIXPWKrEogq1Tb/F4XKFolC9/TdrPsN1sOjVcdWL5parhsaxputBvdLPze2209+KxyQJgot/E6TbddiPkE2nifD8ODbUicnzlkJyrPS+noXU7JjNuMsFZIElGaur9F8ASwXhEtGg800976EfLRayQHIaaTz/mG1afcZmUcJiof1GXm5f+xUPEgZ1wOahVmcDR6d/3+ePTs7dnRyfvLk2cH4TC0D77eiKjLmWzZ4Spyvqa2uc9Ww+JX9j3WSWXhwQ4Kwbh0FTEtfBkbE++GNiprzI+DGrc3dLFA4ddaVBU+doUbGt2MVzDHb1VAM2CpD7evPdEjb++zK9SP00XpKoSbvS1V0KwYJQkU9tG54xZrnX+4vEJQ1A2duUpxjWYzbPZkMxrRT/QTpdhPihIc3tzzBRVMTkuXv9TLxX//AnBCxvs= +api: eJztWtty2zYQ/RUMntopTcmJm6Z8U3xp3ebi+pI+uJ4xSK5ExCDAAKBkjYb/3lmAlCiJspVM+tIwM55IBLC72N1zAK52QS2bGBrd0hsDmt4FVBWgmeVKnqc0omMuUxwxNKApmETzAsdoRK+A6SQjY6VJiRNIzAykREky4VOQJNHcguYs/EfSgGr4XIKxb1Q6p9GCJkpakBY/sqIQPHEaB58Mil5Qk2SQMzcqxIcxjW4X1M4LoBFV8SdILA1oodFSy8G4FUo7aRs2Km3JmINIV+bQoBHFtGZzGlBuITdfosxJ3NZ2nUGtzCqCBpF43lJnrOZyQquAKp2C7l7vhgiXZJbxJFsKshkQDYJZSL0KlAuyzDFyo6tjGtCT06tjjF8KY1YKS6P6ueVWQO2LDyj9FJdVlY8J15CiDL+lu9Z0F96/StBzXHnp40erO1xZsAls23/BJly6QK55e2+vapV3O4XLFB6JGhMXKecUy7QlxtnI5YTg2parubQwAU0DOlY6Z9Y/evkCnS94zjtSBfXk7JHnZU5kmceg1xRqsKWWGBglMRTOG3tq9GaOxrYr6OfLLXk8MZwWkmOlfbzdGIb/XjBjMRQfmSjB3JPae3O0k5FCw5Sr0jRyNJhCSQNP5ft6PKqlqW9grHRHgDdtjd28TmPHXP/X1ladyXrBJrBK1qBjjx2Ldi/Yhr7oDCOmD9JgsyE/z6zn//qSm63prd3vUI8qJMs7YtMYgKPoY1t/7ySg3SL2Wg4546J7vRt6RkArBuiDM7f3dYJpj3fFaZ2+rC7BPfBJ5Dz1Yjh8PkoaTCkcjPc+kDbjsy+7PUuZXHrmwM8sVqUn/TVDn0ynrxD1tMVWWSbOG/RtOBLHanbMmfUkjEo6jtluanx1hJm0QRPdEXMn4NRNaDLLrXP6kZL96YjbIgZsSG4MEJtx04zdt2ntvj6jkYckAWlKtH2b0fdgy3VG3tt4XPaltrvT45uZ/hR1egxt4HANg8sZmxnDdySLO1rrJHF3xf1t3R9gfMeN7PxkBx09lZf/R55tAveGdQbvAebdqh5g/nWK1hNtReWt8WCNbacyDROWlzJlISt4+ABzE/rL2E/bTJxCoSHBK7E/Abb5rOfmnpt7bu65+Xvk5t0e3KH6vePZP2FunuPttZl7MLjfcweD93zd83XP1z1f93z9Le7SOOFon6rHZ0w9MmZcQBqSd0oDScEyLgxhGrBSN+UppC1EORUkVuncV/N3VEsKrWIBeeddvW3QiFz4mbVe4tOQMEP8xNhrv708Oya/Hv38y90PmbWFiQaD2WwW6nFyACm3SodKTwZ6nOAfzvsxJNcZaITInMRAWJpy1MkEWQWImAISPuZJU6yszSYYCb+/Z8jcjS42ItdK/VLzrZ9LRuTm8pzwFKTl43lD8Wuqabt4786aKBZMPtBV5LeVbmoxZZ4zvcyydQVY4bXMlm1y2Fm53pSNafT79fUF8SJIolJwP/84iq0V4SZyLrGMTqOj4TCgdVGdRq+Gwwpl2hqIz+xEEngsBKuP4Y3tcEnyVd66jXFpLJPJt4qM0nzCN/WGa/isk/jE76gB4GE3AOuThQiWPBg8xHhKWGkz1Jo0P5qAM4IJ80RJsgdZD7LvHmQvt/P9TOmYpylIl55LvHFDpLKECaFmkPa46nHV42oXrn7uuj2O8B3Y4iVdENBaaaKSpNQaUuxREE58AsY0uptXqP6i2GOtx9oOrFUBzcFmClusCmVc6jCb0YgO3Ev9wL+qUezI0FNsv8KX9lILGtGFR0sVDQaLTBlbRYtCaVsNphiKKdOcxcInIA57VDXZIlTCROY1bkcNB9pv08e+lEdek8vTq2vyG7MwY3PnxWLZcNWIfj18PeyUilN3SBxdnBO/Q59zLR5oxCKgO8X6yfsIrvAN3UBSam7nV7jMuycGpkGPSnT8MhdqfU46fveTaFB/OGsy5I+/r12QkcMuV91tp48sLzwCV70iqxLIKtU2v9cFilbJwve03S77zZZDd6sOLN80NVy2NQ032o1uF37v7bYefFY5IIyV23idptsuxHwCbbzPh+HhNiQuzh2yE5XnpXT0Lidkxm1GWCskiShN3d8ieAJYr4gWjQeaaW/9CPnoNZLDENPJ53zD6hNuszIOE5UP6jLz8v9YqHiQMy4HtQozOB69u3l/Mjp4e358+v7q9OAwHIb20dcbEXU5ky07XEXO19Q299lqWPzCvsc6qSw82kEhGJeuIqaFL2Nj4t3SRmWN+bugxu0tXSxQ+I0WVYWPXeGGRrd3K5jjtyqgGbDUh9vXnuixt/fgGvXjdFG6CuFmb0sVNCtGSQKFfXLuXYu1Lj5cXSMo6obOXKW4RrMZNnuyGY0oxV5SXO2w5p4tqGByUrrcpV4m/vsXZy3F/w== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query users

+ - + Search for users based on given criteria. -## Request - -

Body

required
    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -User search filter. - -
- -The user search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching users. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching users. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching users. - -
  • Array [
  • ]
- -The user 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/find-variables.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx index b979d5573b5..950a9b76bfa 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx @@ -5,128 +5,979 @@ description: "Search for process and local variables based on given criteria." sidebar_label: "Query variables" hide_title: true hide_table_of_contents: true -api: eJztXFuP2zYW/isE0YcW69jOpW3Wb85k0vUmTWYzk/RhMkAo6dhihyIVkrLHMPzfF4fU1ZIvbRxsu1CAQWYk8ty/c0geSRtq2cLQyS39yDRngQB6N6AqBc0sV3IW0QmdcxkVdw0d0AhMqHmK9+mEXgPTYUzmSpNUqxCMIUxGRKiQCbIsppGAGYiIkmTBlyBJqLkFzdnwk6QDquFLBsa+UNGaTjbuT64hopM5EwYGNFTSgrR4j6Wp4KETbvS7QQk21IQxJMzdFeLdnE5uN9SuU6ATqoLfIbR0QFONSlkOxs1Q2lHbUUVpS+YcRFTJRwcFKaY1W9MB5RYS80eYOYptbjcx5MysIigQCdY1dsZqLhd0O6BKR6C757tbhEuyinkYl4RsDESDYBYizwLpgswSdPT0+oIO6MvL6wt0dQRzlglLJ/l1y62A3BbvkPolTttuBzWv3OYq3dWGuyj4TwZ6jTPfe4fS7R3OTNkC2vJfsQWXzpENa59sVa2SbqNwGcEDUXPiPOWMYpm2xDgZuVwQnFszNZcWFqDpgM6VTpj1l54+QeMLnvCOUEE+CXvgSZYQmSUB6AZDDTbTEh2jJLrCWeNEjl7M6dx2OX1WquRhx3DYkFwo7f3t7qH7PwtmLLriIxMZmM8kt94a5WQk1bDkKjMFHQ0mVdLAoXhv+mNbivoC5kp3OHhX1sCN6xR2zvW3lnbbGaxXbAFVsA46dOyYVJ/QVLlIk4WgX3B4h//3ZgrR6XWMtuUOaT/WNCGzRxo/9nQ5Cl6vYd0tzD2sXca3MTelZIdEeaPkonLqituYzDMhCIuWTIYQFVqFLGUBFxwl6ZJTSWhmh24k/fSMbge7MkwLXgKF+d4N+yG3zSHZXzDDw0rSPbMPW/Q7+NK25EUM4b1xhoQvGRO8MA1iItVqySOIyBIhcTR3OI3pd/IIHy7PxQkeuLFmLzM+d7TDTGuQtnK9n1ZjEiglgElHk8tj9Eo6CbNhDLjWcDmirYc5ITnsV7COfOd/DOBXHp4YWUe8vegoGb9oYIhCGzNJQpWkTHOj5Nf6YWE7Um+DVxFeZ2QqOvR7o1bn1050aVfjdG7dttvaoqZIGHXf125Xl6/yqMT1zoBKlnQI/ZYlUETqKRnz2q3/vknOLJeWezOkH/G/yG7Vsve8uaxG9/8hcxXqOIzw+454O8K9wRYp5Bb7JK+zNFUatw4rLqKQ6YiEMdMsxOUGiSAF6TZyzkhKzvki07VgFByk9du6tqy7yPJB3oGt+o0mupyY+5ZIIusx1mOsx9hXYsyEKj28+M+N6gb6P/qNQL8R+NtCvd8I9BuB828E8vPwmTQWp5+SUIsjdJ7P6XNrn1v73Nrn1j637uRWC5JJO+vqq7k7ZPayM3e2tirc3OhMhtgra9P6LQYbOzMUu0tuiC3Go2Gksl04q0V2cQrvtWh2xnbHdDUZtr755jseLvKfjMen9Qg0mEzkG4WTe6indTRaDZgSpac28I52Bbn0gYO/s0Blvq/ZUO1g++NPkDossVWWiVmR3nbMj/fyBqBLm7i3d8m53Uk+BMadTli3n12T1yfgIi+7eY4/dh19AxjVIgbskHww4KGQ3/tc79x9ztvQ2GqTBKTJUPZ2s+iEhmCz6Xiy8Djtj8ruGqRnE/1Qd9CH+g5iG0gtR+xGDN8TLK57nAdJ+YzEIXkPg7KAo7PhYUy2Vl1luefgVy8F8dkeWk0Njx12H0u/e47zPlZHecco4BL3YzeVV7j6XZ5O6u9XVNBJ6MSO2PvzTdyWOmc4D2rR/Fabo/0HYnWbNSHfWX4LUG8HjYK5lNEwZEkmIzZkKR/ew9oM/SMg//jKYkpew5owazUPMnw6ghl8tgQ0D2ur7QhSDXlkWZ1BX4D7AtwX4L9UAT47jvui3RftE4v2odR2vjJ+iMs3LuwHjhW6Lf3W1ebXsDYnF/3GlBPKv4+hry3//V66L+V9Kf9rlfJ+L92X5X4vfb69NI58tu/4OjPoSWbumwVyzriAaEh+VRpIBJZxYQjTtdZDlek8dAMVrQ+eeqdaBQKSoxV7Sq78yJwv8cjFFb0fGHjut+9fXZB/Pvvx57vvY2tTMxmNVqvVUM/DRxBxq/RQ6cVIz0P8wXE/DMlNDBpT15oEQFgUceTJRD2FmBRCPudh8Z5ELjZBvzQe/9lXZN3d3QeaaqUy07z1QteUfHg/IzwCafl8XZTeBmtaf2/IrQEmgWDynlZx0Ga6y8VkScJ0PSBrDBAoltnseCPx6ZMWbYylf93cXBFPgoQqggqdOSNUIuES3+Chk2fj8YDm7/PQyU/j8RZposdP0EQSeEgFy5dHO+pwSZIqbp1iBeTO5Bml+YLv8h020JoH8UuvUYHCx90ozCs+EQxbwksmeERYZmPkGhbva4ETgglXaHuQ9SDrQdYNsqcdKymlAx5FIF14lnjjBtcqhAmhVhD1uOpx1eNqH65+7FpCTvFswoLGOAStlSYqdI9GRfh6tCjXvAXvYmvbLxR7rPVY24O17YAmYGOFH4JIlXGhw2xMJ3RUHraM/HaN4gvhegnauNORTAs6oRuPmO1kNNrEytjtZINvPmxHS3RHSQJVxNseWUXEuI9IxJ5r23N4Q9beqrvwx7LkOXl/eX1DfmEWVmztLJmW33soSD8fPx93UsWheyhOr2bEa+jjrpYLCrII6k6yfvAphN3TcQbCTHO7vsZp3jwBMA16mqHxy3jI+Tnq7nzDDaKD/JdXRZT8+7cb52jMY++rr21cPrAk9Sis3j1vHHaMi/cZq9DLj5mqC9WRxrj7LGJcPw6q5jVOdrAHhkZ1nrotv5pRHj7cVd+R8J9+GJcfZxjvfDThduNNWP84AV7bOkzNlbNfHvFtT6CGoI133Xj4uI2uq5lLEqFKkky6SiEX/oFIVvNsKDKTP7YseAh4/lGe8ZVs3/g75KPnSB4PMSo9dIoCseA2zoJhqJJR3nko/w+ECkYJ43KUszCji+mvH96+nD56M7u4fHt9+ejxcDy0D/5IGQGcMFmTw53PVMemu7puqrp4lg+95FFr4cGOUsG4eyLZabvJ08otrQuTJ5a7QZ4cbulmgww+aLHd4mV3QkQnt3dVLsG/tgMaA4t8MNB7jEF64TV5dIMyVFHcehgSnzz2M6ZhCKk9OPaulh6v3l3fIPLyr9gkKsI5mq3wCzdsRSf0E/1E8fl6Z10Hand9QwWTi8xFN/V08d9/AYJ9AEc= +api: eJztXFuP2zYW/isE0YcW69jOpW3qN2cy6XqTJrOZSfowHSCUdGSxQ5EKSdljGP7vi0PqasuXNg7aLhRgkBmJPPfvHJJH0ppaNjd0cks/Ms1ZIIDeDajKQDPLlZxFdEJjLqPyrqEDGoEJNc/wPp3Qa2A6TEisNMm0CsEYwmREhAqZIItyGgmYgYgoSeZ8AZKEmlvQnA1/k3RANXzOwdgXKlrRydr9yTVEdBIzYWBAQyUtSIv3WJYJHjrhRr8blGBNTZhAytxdId7FdHK7pnaVAZ1QFfwOoaUDmmlUynIwbobSjtqWKkpbEnMQUS0fHZSkmNZsRQeUW0jNH2HmKO5yu0mgYGYVQYFIsGqwM1ZzOaebAVU6At09390iXJJlwsOkImQTIBoEsxB5FkgXZJ6io6fXF3RAX15eX6CrI4hZLiydFNcttwIKW7xD6pc4bbMZNLxyW6h01xjuouC/OegVznzvHUo3dzgzY3PYlf+Kzbl0jmxZ+2SrapV2G4XLCB6IionzlDOKZdoS42Tkck5wbsPUXFqYg6YDGiudMusvPX2Cxhc85R2hgnxS9sDTPCUyTwPQLYYabK4lOkZJdIWzxokcvZjT2HY5fVap5GHHcNiQXCjt/e3uofs/CWYsuuIjEzmYT6Sw3grlZCTTsOAqNyUdDSZT0sCheG/7Y1OJ+gJipTscvC1r4MZ1Chtz/bWl3XQG6xWbQx2sgw4dOyY1J7RVLtNkKehnHN7h/72ZQnR6HaNtsUXajzVtyOyRxo89XY6S12tYdQtzDyuX8W3CTSXZIVHeKDmvnbrkNiFxLgRh0YLJEKJSq5BlLOCCoyRdcioJ7ezQjaQfntHNYFuGaclLoDDfumHfFbY5JPsLZnhYS7pn9mGLfgOfdy15kUB4b5wh4XPOBC9Ng5jItFrwCCKyQEgczR1OY/qNPMKHy3NxggdurNnLjMeOdphrDdLWrvfTGkwCpQQw6WhyeYxeRSdlNkwA1xouR+zqYU5IDvsVbCLf+R8D+JWHJ0bWEW/PO0rGzxoYotAmTJJQpRnT3Cj5pX6Y247U2+JVhtcZmYoO/d6o5fm1E13aNTidW7fNprGoKRNG0/eN2/XlqyIqcb0zoJKlHUK/ZSmUkXpKxrx267+vkjOrpeXeDOlH/BXZrV72njeXNej+P2SuUh2HEX7fEW9HuLfYIoXCYr/J6zzLlMatw5KLKGQ6ImHCNAtxuUEiyEC6jZwzkpIxn+e6EYyCg7R+W7cr6zayfJB3YKt5o40uJ+a+JZLIe4z1GOsx9oUYM6HKDi/+C6O6gf6PfiPQbwT+sVDvNwL9RuD8G4HiPHwmjcXppyTU8gidF3P63Nrn1j639rm1z61budWCZNLOuvpq7g6ZvezMnTtbFW5udC5D7JXt0vo1AZs4M5S7S26ILcejYaSyXThrRHZ5Cu+1aHfGtsd0NRk2vvnmOx4u8p+Mx6f1CDSYXBQbhZN7qKd1NHYaMBVKT23gHe0KcukDB39ngcp9X7Ol2sH2x58gdVhiqywTszK9bZkf7xUNQJc2cW/vkvNuJ/kQGLc6Yd1+dk1en4DLvOzmOf7YdfQNYFSLGLBD8sGAh0Jx71Ozc/epaENjq00SkCZH2XebRSc0BNtNx5OFx2l/VHbXID2b6Ie6gz7UtxDbQmo1Yjti+J5gcd3jIkiqZyQOyXsYlCUcnQ0PY3Jn1VWVew5+9VISn+2h1dbw2GH3sfS75zjvY32Ud4wCLnE/dlN5havfxemk/nlFBZ2ETuyIvT/fxN1R5wznQTs0v9bmaP+BWNNmbch3lt8S1JtBq2AuZDQMWZrLiA1Zxof3sDJD/wjIv76wmJLXsCLMWs2DHJ+OYAafLQHNw8ZqO4JMQxFZVufQF+C+APcF+G9VgM+O475o90X7xKJ9KLWdr4wf4vKVC/uBY4VuS791tfk1rMzJRb815YTy72PoS8t/v5fuS3lfyv9epbzfS/dlud9Ln28vjSOf7Tu+zg16kpn7doGMGRcQDckvSgOJwDIuDGG60XqoM52HbqCi1cFT70yrQEB6tGJPyZUfWfAlHrm4ovcDA8/99v2rC/LTs+9/vPs2sTYzk9FouVwOdRw+gohbpYdKz0c6DvEHx303JDcJaExdKxIAYVHEkScTzRRiMgh5zMPyPYlCbIJ+aT3+s6/IurvbDzQ1SmWu+c4LXVPy4f2M8Aik5fGqLL0t1rT53pBbA0wCweQ9reNgl+k2F5OnKdPNgGwwQKBYZvPjjcSnT3ZoYyz9++bmingSJFQR1OgsGKESKZf4Bg+dPBuPB7R4n4dOfhiPN0gTPX6CJpLAQyZYsTzaUodLktZx6xQrIXcmzyjN53yb77CF1iKIX3qNShQ+7kZhUfGJYNgSXjDBI8JymyDXsHxfC5wQTLhC24OsB1kPsm6QPe1YSSkd8CgC6cKzwhs3uFYhTAi1hKjHVY+rHlf7cPV91xJyimcTFjTGIWitNFGhezQqwtejRbXmLXmXW9t+odhjrcfaHqxtBjQFmyj8EESmjAsdZhM6oaPqsGXkt2sUXwjXC9DGnY7kWtAJXXvEbCaj0TpRxm4ma3zzYTNaoDsqEqgi3vbIKiPGfUQi8Vx3PYc3ZOOtugt/LEuek/eX1zfkZ2ZhyVbOkln1vYeS9PPx83EnVRy6h+L0aka8hj7uGrmgJIug7iTrB59C2D0dZyDMNbera5zmzRMA06CnORq/ioeCn6PuzjfcIDoofnlVRsl/fr1xjsY89r7+2sblA0szj8L63fPWYce4fJ+xDr3imKm+UB9pjLvPIsbN46B6XutkB3tgaFTnqdvqqxnV4cNd/R0J/+mHcfVxhvHWRxNu196EzY8T4LWNw1SsnP2KiN/1BGoI2njXjYePd9F1NXNJIlRpmktXKeTcPxDJGp4NRW6Kx5YFDwHPP6ozvortG3+HfPQcyeMhRqWHTlkg5twmeTAMVToqOg/V/4FQwShlXI4KFmZ0Mf3lw9uX00dvZheXb68vHz0ejof2wR8pI4BTJhtyuPOZ+th0W9d1XRfP8qGXImotPNhRJhh3TyQ7bddFWrmlTWGKxHI3KJLDLV2vkcEHLTYbvOxOiOjk9q7OJfjXZkATYJEPBnqPMUgvvCaPblCGOop3HobEJ4/9jGkYQmYPjr1rpMerd9c3iLziKzapinCOZkv8wg1b0gnFZ+udZR2g3bU1FUzOcxfZ1NPEf/8DlGX/PA== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query variables

+ - + Search for process and local variables based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Variable filter request. - -
    variableKey object
    - -The key for this variable. - -
    oneOf
    - -integer - -
    name object
    - -Name of the variable. - -
    oneOf
    - -string - -
    value object
    - -The value of the variable. - -
    oneOf
    - -string - -
    scopeKey object
    - -The key of the scope of this variable. - -
    oneOf
    - -integer - -
    processInstanceKey object
    - -The key of the process instance of this variable. - -
    oneOf
    - -integer - -
- -The variable search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching variables. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching variables. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching variables. - -
  • 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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-authentication.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx index bc9719028d9..22f3a49997b 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-authentication.api.mdx @@ -12,61 +12,403 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get current user

+ - + Retrieves the current authenticated user. -## Request + -
+ -The current user is successfully returned. - -
Schema
    tenants object[]
    - -The tenants the user is a member of. - -
  • Array [
  • ]
  • c8Links object[]
    - -The links to the components in the C8 stack. - -
  • Array [
  • ]
Schema
    tenants object[]
    - -The tenants the user is a member of. - -
  • Array [
  • ]
  • c8Links object[]
    - -The links to the components in the C8 stack. - -
  • Array [
  • ]
Schema
    tenants object[]
    - -The tenants the user is a member of. - -
  • Array [
  • ]
  • c8Links object[]
    - -The links to the components in the C8 stack. - -
  • Array [
  • ]
- -The request lacks valid authentication credentials. - -
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-decision-definition-xml.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml.api.mdx index 7c059fc358e..35edef37696 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml.api.mdx @@ -12,56 +12,265 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision definition XML

+ Returns decision definition as XML. -## Request + -

Path Parameters

+ -The XML of the decision definition is successfully returned. + -
Schema
    - -string - -
- -The decision 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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-decision-definition.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx index 3d368a39766..f2d29502c1e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx @@ -12,52 +12,418 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision definition

+ Returns a decision definition by key. -## Request + -

Path Parameters

+ -The decision definition is successfully returned. + -
Schema
Schema
Schema
- -The decision 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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-decision-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx index 79b4c2e8fb2..ae8d7dc8790 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx @@ -12,64 +12,435 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision instance

+ Returns a decision instance. -## Request + -

Path Parameters

+ -The decision instance is successfully returned. + -
Schema
    evaluatedInputs object[]
    - -The evaluated inputs of the decision instance. - -
  • Array [
  • ]
  • matchedRules object[]
    - -The matched rules of the decision instance. - -
  • Array [
  • evaluatedOutputs object[]
    - -The evaluated decision outputs. - -
  • Array [
  • ]
  • ]
- -The decision instance 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The decision instance with the given ID 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-decision-requirements-xml.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml.api.mdx index 9dc3ff49753..5f4ed3bc81b 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml.api.mdx @@ -12,56 +12,265 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision requirements XML

+ Returns decision requirements as XML. -## Request + -

Path Parameters

+ -The XML of the decision requirements is successfully returned. + -
Schema
    - -string - -
- -The decision requirements 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The decision requirements 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-decision-requirements.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx index 965704f18bd..ddb52c207d9 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx @@ -12,52 +12,402 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision requirements

+ Returns Decision Requirements as JSON. -## Request + -

Path Parameters

+ -The decision requirements is successfully returned. + -
Schema
Schema
Schema
- -The decision requirements 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The decision requirements 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-document.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-document.api.mdx index 3b84aed358c..ff0c5d2a65c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-document.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-document.api.mdx @@ -12,24 +12,24 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Download document (alpha)

+ Download a document from the Camunda 8 cluster. @@ -41,22 +41,128 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature in future releases. ::: -## Request - -

Path Parameters

Query Parameters

- -The document was downloaded successfully. - -
Schema
    - -string - -
- -The document with the given ID was not found. - -
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-flow-node-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx index fea7a12d1c0..b4b6e4fefff 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx @@ -12,52 +12,594 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get flow node instance

+ Returns flow node instance as JSON. -## Request + -

Path Parameters

+ -The flow node instance is successfully returned. + -
Schema
Schema
Schema
- -The flow node instance 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The flow node instance 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-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx index 81389ad4e8d..b0d78498e3d 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx @@ -12,45 +12,305 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get group

+ - + Get a group by its key. -## Request + -

Path Parameters

+ -The group is successfully returned. + -
Schema
Schema
Schema
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The group with the given key was not found. - -
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-incident.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx index 2feb67dfb3c..1ae2b792129 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx @@ -12,52 +12,547 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get incident

+ Returns incident as JSON. -## Request + -

Path Parameters

+ -The incident is successfully returned. + -
Schema
Schema
Schema
- -The incident 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The incident 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-license.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx index 0d51cae0eb2..135494b7916 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx @@ -12,33 +12,112 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get license status

+ - + Obtains the status of the current Camunda license -## Request + -
+ -Obtains the current status of the Camunda license - -
Schema
- -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.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml.api.mdx index cdec028f056..1dbb952ac03 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml.api.mdx @@ -12,64 +12,269 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process definition XML

+ Returns process definition as XML. -## 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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-definition.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx index 4bd233946ca..97837c88054 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx @@ -12,52 +12,408 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process definition

+ Returns process definition as JSON. -## Request + -

Path Parameters

+ -The process definition is successfully returned. + -
Schema
Schema
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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx index e81a393c5fa..9d114723df1 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx @@ -12,52 +12,487 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process instance

+ Get the process instance by the process instance key. -## Request + -

Path Parameters

+ -The process instance is successfully returned. + -
Schema
Schema
Schema
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The process instance with the given key was not found. - -
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-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx index 8bf6eba91c9..d6727f24572 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx @@ -12,45 +12,302 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get role

+ - + Get a role by its key. -## Request + -

Path Parameters

+ -The role is successfully returned. + -
Schema
Schema
Schema
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The role with the given key was not found. - -
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-start-process-form.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx index 4918648851e..c1d8a0b79f2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx @@ -12,58 +12,378 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process start form

+ Get the start form of a process. Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. -## Request + -

Path Parameters

+ -The form is successfully returned. + -
Schema
Schema
Schema
- -The process was found, but no form is associated with it. - -
- -Bad request - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
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-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx index 72378cba3fd..a8707ef986e 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx @@ -12,49 +12,364 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get tenant

+ - + Retrieves a single tenant by tenant Key. -## Request + -

Path Parameters

+ -The tenant was retrieved successfully. + -
Schema
Schema
Schema
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Tenant not found. - -
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-topology.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-topology.api.mdx index 7a0a1749a58..445c34c37df 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-topology.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-topology.api.mdx @@ -12,41 +12,177 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get cluster topology

+ - + Obtains the current topology of the cluster the gateway is part of. -## Request + -
+ -Obtains the current topology of the cluster the gateway is part of. - -
Schema
    brokers object[]nullable
    - -A list of brokers that are part of this cluster. - -
  • Array [
  • partitions object[]
    - -A list of partitions managed or replicated on this broker. - -
  • Array [
  • ]
  • ]
- -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-usage-metrics.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.api.mdx index 7c2e975a0b7..3e2de91caa2 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.api.mdx @@ -12,45 +12,252 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get usage metrics

+ - + Retrieve the usage metrics by given start and end date. -## Request + -

Query Parameters

+ -The usage metrics search result. + -
Schema
- -The usage metrics 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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-user-task-form.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx index 09beda4752c..4c74ef8183c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx @@ -12,58 +12,378 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get user task form

+ Get the form of a user task. Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. -## Request + -

Path Parameters

+ -The form is successfully returned. + -
Schema
Schema
Schema
- -The user task was found, but no form is associated with it. - -
- -Bad request - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
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-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx index 93d979f650e..106f732b70c 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx @@ -12,64 +12,605 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get user task

+ Get the user task by the user task key. -## Request + -

Path Parameters

+ -The user task is successfully returned. + -
Schema
    customHeaders object
    - -Custom headers for the user task. - -
Schema
    customHeaders object
    - -Custom headers for the user task. - -
Schema
    customHeaders object
    - -Custom headers for the user task. - -
- -The provided data is not valid. 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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user task with the given key was not found. - -
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-variable.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx index aa3b84f7079..86a6f37ffad 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx @@ -12,52 +12,420 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get variable

+ Get the variable by the variable key. -## Request + -

Path Parameters

+ -The variable is successfully returned. + -
Schema
Schema
Schema
- -Bad request - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
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/migrate-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx index 62f988d0fc9..0c2d01dfdf3 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx @@ -5,31 +5,31 @@ description: "Migrates a process instance to a new process definition." sidebar_label: "Migrate process instance" hide_title: true hide_table_of_contents: true -api: eJztWF1v2zYU/SsXfFmLKZLTpV2nhwFekm7emi5InO0h9gMtXVtsJVIlKTuGof8+XFKyHUtuuo+XAQkQJDbJ+3nOkXg3zPKFYfE9u9YqQWNASGO5TJBNA6ZK1NwKJUcpi1khFppbbDaO2n0BS9EkWpS0kcXsym8zwKE8sAlWAQeJq+1KinMhBZ0MJ3KcCQMaP1doLCRcQqKk5UJCUeVWlDlCwctSyIUzqKuEzhky6szslmdoV4gSbIbAEyuWOJGHsXxjAHMsUFoDXKZguV6g7Qlsuy2cyIm8MwiW4rQKqnKheYpfTHSJ2pARNd/bpjRYNZEcUjGfo0bZ5zcADBchWfqEWMJaVRp0JWWbP/kxUJUnVp2k3CKshM0o5YnMqf47m6IotVpuk2ABK7nmBVrU1PoNk7xAFrPycWd/wzULmKCeltxmLGDUG6ExZbHVFR42fpwhfMI1pUqF79Yk4xZMpqo8hRlCA6c0ZAEzSYYFZ/GG2XVJoQhpcYGaBWyudMGt/+rNGavrqY8Djf1JpWs6cxgWwQalpSVelrlIHIajj4bC3HSdqdlHTCyVRRPirUDjVh0iGrhfbPtCZYk3x3PvQZBVbbZHKqOoCE+mHrAG4KM9+HdjufR4bdlgYK5V4RwbVemk179bPqBAu7wXG9eaO1BYLExfBbtV6aWs3zZDyNTKVYeXOzYeC/dxQXsCfiQmnXZ6a01xSND6etgEAaOL/aZRRHtVMFYLuaB++AD+kU0hH3W9tVnvs+y+E3TX5TRgVtgcd8p7INBXHcw4L1ttv0EnQQl2ox+CbhcdupNMGZQwW7vqVwa1J/VK5DlRuuTaOqXLc9CYKJ2SnhtSb7lo+yoMbH2HcFUZS0d/hAEIR56lSDH1DXyKEQErhBRFVbD49LByX2BvP4+eLOSNVx1W196XKZU0HluvBmf9ve9QTZg94asDdjYYHD3pKgEpt5yOSWVhyXPhBPOIxJVazXIsvu1K3WFjr/1OSNFykYMnMPAdNVMQEu5v3p3DD2evv5++yKwtTRxFq9Uq1PPkBFNhlQ6VXkR6ntAv7XsZwjhDTbRfU1t5mrqy8xx2bARTYiLmIml53IQN1O9HnT+mzG51c8CdPXhUWnTEaAh3NyMQKUor5msCZMe1OzPnVU42+ExVNp7lXH5yVPfY6Do99GKqouB6/zG456AOmLHcVubJZ913r3rl9Jfx+Bq8CUhUijCnlwkiVeMo3GfF2WBAYH/wn94MBjXZpI5/RSYS8KHMuXTQOkyH3sqUxgY/LrHtm+N/0xmlxUIc+g2ddrU8bUB84TPyvDz7O1QkTs1VJZ859cypZ04d5dTrvofUUNI7DGrCIWqtNKgkqbTGFFaZyLeEa303L+0ei89ce+baM9e6XKM7HtpM0bylVMZBh+7eMYsaOp1s7/7RpnthryP/dkmBBcygXrZ3/ErnLGYbz6g6jqJNpoyt402ptK2jJbVrybXgs9yDlJY981pE5Srheeaj6naWFmiQ0GZ8zotKphzews3l7Rh+5hZXfO0qTS4fm347eDvotUpbj1gcXo/AZ+hxuacVrVkifa9Zv/lrDLuBg8Gk0sKub+mYL88MuUY9rKg5W7w0/px1+uw3saD5512Lol//HDsgkM7d7IYZlw+8KBuWfmH4MDgyCLjvueTuINy5q27vnNP+2+DAcWKuXDgNYruVItj4GReL2SA87bLjeuRInqiiqKRTernwwyq+V/kkr4yligcsFwlK48rQTKbabe/9CvzRTNVOQ0KNh3Yr8Aths2oWJqqIEn9s+3eWq1lUcCGjxoWJzodXdx8uhifvR+eXH24vT07DQWgfrOsOEbDgci+O5mLYeZc8THqze8A9z0P/B/PQhr4WH2xU5lxIEhQHq02jv/eso78sYHHvyHQnwdOgkdF7ttnMuME7ndc1ff25Qr1m8f10p7qOwKkw9H/K4jnPzeGMdR9XL26aacdL+BeT197M22mfXLuHQl7RJxawT6Q+fWPieloHLEOeonZZ+I3nPtaTMZnbGerMZOugPTFMEiztkb2PXg5JtLZPyuvfb8ckss08uFApndV8RTNrvmIxm7AJJaDK7czUfb9hOZeLii9ov7dLP38BfdTUmw== +api: eJztWF1v2zYU/SsXfFmLKbLTpV2nhwFekm7Zmi5InO0h8QMtXVtsKVIlKTuGof8+XFKyHUtuuo+XAQkQJDbJ+3nOkXjXzPG5ZckduzI6RWtBKOu4SpFNIqZLNNwJrS4ylrBCzA132Gy8aPdFLEObGlHSRpawy7DNAodyzyY4DRwULjcrGc6EEnQyvlfjXFgw+LlC6yDlClKtHBcKiko6UUqEgpelUHNv0FQpnbNk1JvZLk/RLREVuByBp04s8F7tx/KNBZRYoHIWuMrAcTNH1xPYZlt8r+7VrUVwFKfTUJVzwzP8YqILNJaM6NnONm3A6XvFIROzGRpUfX4jwHgek6VPiCWsdGXAVEq1+ZMfC1V55PRRxh3CUricUr5Xkuq/tSmK0ujFJgkWsZIbXqBDQ61fM8ULZAkrH3f2N1yxiAnqacldziJGvREGM5Y4U+F+48c5widcUapU+G5Ncu7A5rqSGUwRGjhlMYuYTXMsOEvWzK1KCkUoh3M0LGIzbQruwldvTlhdT0IcaN1POlvRmf2wCDaoHC3xspQi9RgefLQU5rrrTE8/YuqoLIYQ7wRav+oR0cD9bNMXKkuyPpx7D4KcbrM9UBlNRXgy9Yg1AL/YgX83lvOA15YNFmZGF96x1ZVJe/375T0KtMs7sXFjuAeFw8L2VbBblV7Khm1ThFwvfXV4uWXjoXAfF7Qn4Edi0mlnsNYUhwStr4dNEHBxtts0iminCtYZoebUjxDAP7Ip1KOutzbrXZbddYLuupxEzAkncau8ewJ92cGM97LR9mv0EpRiN/oRmHbRozvNtUUF05WvfmXRBFIvhZRE6ZIb55VOSjCYapORnltSbzVv+yosbHzHcFlZR0d/hCEIT56FyDALDXyKERErhBJFVbDkeL9yX2BvP4+eLOR1UB1W18GXLbWyAVuvhif9ve9QTdgd4asjdjIcHjzpKwEZd5yOKe1gwaXwgnlA4kqjpxKLb7tSt9/Yq7ATMnRcSAgEBr6lZgZCwd31u1P44eT195MXuXOlTQaD5XIZm1l6hJlw2sTazAdmltIv7XsZwzhHQ7RfUVt5lvmycwlbNoItMRUzkbY8bsIG6vejzh9SZr+63uPODjwqIzpiNILb6wsQGSonZisCZMe1PzPjlSQbfKorl0wlV5881QM2uk73vdiqKLjZfQzuOKgjZh13lX3yWffdq145/WU8voJgAlKdIczoZYJI1TiKd1lxMhwS2B/CpzfDYU02qeNfkYkCfCglVx5a++nQW5k22ODHJ7Z5c/xvOqONmIt9v7HXrpanDYjPQkaBlyd/h4rEqZmu1DOnnjn1zKmDnHrd95AaKXqHQUM4RGO0AZ2mlTGYwTIXckO41nfz0h6w+My1Z649c63LNbrjocs1zVtKbT106O6dsEFDp6PN3X+w7l7Y60F4u6TAImbRLNo7fmUkS9g6MKpOBoN1rq2rk3WpjasHC2rXghvBpzKAlJYD81pESZ1ymYeoup2lBRoktBmf8qJSGYe3cH1+M4afucMlX/lKk8vHpt8O3w57rdLWAxZHVxcQMgy43NGK1iyRvtds2Pw1hv3AwWJaGeFWN3QslGeK3KAZVdScDV4af946fQ6bWNT8865F0a9/jj0QSOeut8OM8wdelA1LvzB8GB4YBNz1XHK3EO7cVTd3zkn/bXDoOTHTPpwGsd1KEWzCjIslbBgfd9lxdeFJnuqiqJRXejUPwyq+U/lUVtZRxSMmRYrK+jI0k6l22/uwAn80U7XjmFAToN0K/Fy4vJrGqS4GaTi2+TuVejoouFCDxoUdnI4ubz+cjY7eX5yef7g5PzqOh7F7cL47RMCCq504moth511yP+n19gH3PA/9H8xDG/o6fHCDUnKhSFA8rNaN/t6xjv6yiCW9I9OtBE+iRkbv2Ho95RZvjaxr+vpzhWbFkrvJVnU9gTNh6f+MJTMu7f6MdRdXL66bacdL+BeT197M22mfWvmHgqzoE4vYJ1KfvjFxPakjliPP0PgswsbTEOvRmMxtDXVmsnXUnhilKZbuwN5HL4ckWpsn5dXvN2MS2WYeXOiMzhq+pJk1X4bgdbmZl/rv1kxyNa/4nPYGm/TzFz4/058= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Migrate process instance

+ Migrates a process instance to a new process definition. @@ -40,26 +40,205 @@ Use this to upgrade a process instance to a new version of a process or to a different process definition, e.g. to keep your running instances up-to-date with the latest process improvements. -## Request - -

Path Parameters

Body

required
    mappingInstructions object[]required
    - -Element mappings from the source process instance to the target process instance. - -
  • Array [
  • ]
  • = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
- -The process instance is migrated. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The process instance is not found. - -
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}}>
+ + + + + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + required: ["targetProcessDefinitionKey", "mappingInstructions"], + title: "MigrateProcessInstanceRequest", + }, + }, + }, + }} +> + + diff --git a/docs/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx index 0828b8177da..ecaf810544f 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx @@ -5,31 +5,31 @@ description: "Modifies a running process instance." sidebar_label: "Modify process instance" hide_title: true hide_table_of_contents: true -api: eJztWd9z47YR/lcweGkypSg5ddIrHzqj+nyt0ruLx9alD5IeIHAlIgYBBgAlazT83zsLkBQlSid3kubJnrEtkcD+/L7Fcrmnjq0tTWb0wWgO1hKhrGOKA11EVBdgmBNaTVKa0FynYrWr102aZRFNwXIjClxHE/oJVwmwhBFTKiXUmhQnouO5mmbCEgO/lmAd4UwRrpVjQpG8lE4UEvxiU3KUaonThHEnNswBYYqAhByUI3pFXAatfG3mymniwORC1Uv9NmhV45aDgHiu5uqLBeLQHKeJgYIJQ1jPZOIy5oiwxLqSPxOtjswwxGn9jJdKJZQDlUJKCuayeK4+aEPgheWFhIgsgbPSBh9eHBjFJLE76yBH2Uo7wjZMSLaUgFJTDVb9yREDttAqJcwSeCmAO0jjuaIRLZhhOTgwmMI9VSwHmtDiOEX/hh2NqMDkoE00ohh4YSCliTMlnGZwmgF5ht1pdI9DYTNdypQsgeQh4WlMI2p5BjmjyZ66XYGmYDTWYGhEV9rkzIVLP9zSqloEO8C6f+h0h3tOzUJMgHJ4ixWFFNxjcfiLRTP3fWV6+Qtwh2ExiFwnwPq9NXImHUTh9WOvu3dJuLVE8G4zwbMm1bbjdyM2JULVqyzXBSJfpfWFDTMCk9ndxw3gLgxXbTczhvkUOcjtOX9eZ2kHkScpak2tUXMUnnoPUvw0JoiEyfsGCFeFHzyyzgi1plVEETHWaXNfa+lg8qy6DvCarSGsRya0WOyFlQgVz9UTOKTz4Ab/hjt+v4JtX8ZWuEwEQr8I6zCUvTXBpLlaSb0N9oRQXoM55m7FSuloMripItoA4rdg8Q8F1atUHgOqXdx37Mennz6TVPPyAKStkLKOsxNNng76VlhcMyBGa9derhFxoUDFczVxJC+t8/AkXmlwO8ISehDudWMJY0UReMwQgIMNkyWQFbOZ0CokmqWpQCeYfOg4G+rUcWQrLIO6gNcT6rh+nASgH/C5+ghsAwTywu1OAH7YJ5S/sJZ6iYfM1wLWRXLN3A5uKa2q7pEx6yR4EVEnnITm3D/tDn7uw51Wp+IOBeiauHG/knvj2hP/dy7xrdz/G7GuKj1fq69V0atF+6xnXzmsz2esY8a11E3PpMjLbXvMR1iBAWwpey6NiWlu+gOCZ9qCIsudd7G0YDq1ZAmkYMY3h0xKYoBrk2KzabG1VGuyMjoPHV+rOyaf6nLxdzIiYoUU2Yi0OTCvV/lcKJGXOU1uPB6/FonH0PQgD3xYsbWzIb3fjW7P57PXgwnb6buqiN6ORhd3ekdIyhxrmswNk8In/kKHVRi9lJD/ud9pneblIawkKTgmZF1lscjWSA9Vdfb44Y787fb7vy6+yZwrbDIcbrfb2Kz4AFLhtIm1WQ/NiuMvrvs2JtMMDFbmnS/ibfUlB0IQWwAXK8GxBtZ1zRuD6TpK3IXGMNzd90pfm93SiB6fx+TL44SIFJQTqx3iqaf6qHqypS5dspRMPdMDNPpKT7XYMs+Z6XbhHQV4xjjmSnu11f7Ldz3ZCIt/TacPJIggXKdQn7PCNoriLqhvR6OI5uwlfPthNKpQJmb8FZ5gW1VIpjy0Tt3BJz5toMaPd6x9AP19MqONWItTvTHt0rQG8fvgUeDl7f9CReTUSpfqjVNvnHrj1EVOfX/ukBorglH2oxAwRhuiOS+NAf8MLVvCNbrrmUHA4hvX3rj2xrU+16qI5uAyjWPbQlsPHRz9JXRY02nQmGmH+/68sBqG7jLwCQd7YDbNlLE0kiZ0H0hVJcPhPtPWVcm+0MZVww1m7GgGgLcD+RpQSc2ZzIJh/eTiDRxlNk7fsbxUKSPvyOP905T8kznYsp0PNqo8Fv1u9G50ViouvSBx/DAhwcMAzU65aMQi78+KDYtfI9iPPC3w0gi3e8JtITxLYAbMuMT8tJCp9Xnp+D0solH94UMDpB//M/VYwFL3eBin3oeJ8+Xx5+xo8HdA6NfmdYObSwOs2fHUpzsCaWeBC3T/wpP67Pyj7ahanH9AHHmerbQPWM2CfugRh2BsyNUovukz7mHiCwfXeV4qj3Z8MhcuI6yTSi5L6zCFEZWCg7I+rvWwvVn2MdwhPweN5CZGGAauNIfGWrisXMZc50MetrX/l1IvhzkTalirsMO78acvn9+PBx8nd/efn+4HN/Eodi/OpxtJnTPVsSM8a/ba01Of94cz8+1VzR/5qqbmtYMXNywkEworjYfHvq7NM9qrzTSiydm3OUfleRHVJXZG9/sls/DFyKrCy7+WYHY0mS0OxPVkS4XFzylNVkza0zdAXYx881jPfb4lv+G90Fnnm3ma2vkDQ5b4jUb0Gal/7iVWtagimgFLwXgvwsK7YOtgiuIOgnpvjKqo2THmHAp3Ye1R74j1pz1IH356mmIBrt9W5TrFvYZt8Y0a29KEzukcHdBFO4D01/dUMrUu2RrXB7n4818P6WWE +api: eJztWd1z47YR/1d28NJkSn04ddKrHjqj+nyt0ruLx9alD5IeIHIlIgYBBgAlazT83zsLkBQlSid3kubJnrEtkcB+/n6L5XLPHF9bNpqxB6NjtBaEso6rGNkiYjpHw53QapKwEct0Ila7at2kXhaxBG1sRE7r2Ih9olUCLXAwhVJCrSE/Ed2fq2kqLBj8tUDrIOYKYq0cFwqyQjqRS/SLTRGTVAtOA4+d2HCHwBWgxAyVA70Cl2IjX5u5chocmkyoaqnfho1q2nIQ0J+rufpiERyZ4zQYzLkwwDsmg0u5A2HBuiJ+Bq2OzDDgtH6mS4USyqFKMIGcu7Q/Vx+0AXzhWS4xgiXGvLDBhxeHRnEJdmcdZiRbaQd8w4XkS4kkNdFo1Z8cGLS5VglwC/iSY+ww6c8Vi1jODc/QoaEU7pniGbIRy49T9G/csYgJSg7ZxCJGgRcGEzZypsDTDE5ThGfcnUb3OBQ21YVMYImQhYQnfRYxG6eYcTbaM7fLyRSKxhoNi9hKm4y7cOmHW1aWi2AHWvcPnexoz6lZhAlUjm7xPJci9lgc/GLJzH1XmV7+grGjsBhCrhNo/d4KOZMWouj6sdftuxBuLQm821TEaZ1q2/K7FpuAUNUqG+uckK+S6sKGG0HJbO+LDdIuCldlNzeG+xQ5zOw5f15naQuRJylqTK1QcxSeag9R/DQmhITJ+xoIV4UfPLLOCLVmZcQIMdZpc19paWHyrLoW8OqtIaxHJjRY7IQVhOrP1RM6onPvhv6GO36/wm1Xxla4VARCvwjrKJSdNcGkuVpJvQ32hFBegznlbsUL6diod1NGrAbEb8HiHwqqV6k8BlSzuOvYj08/fYZEx8UBSFshZRVnJ+o8HfStqLimCEZr11yuEHGhQPXnauIgK6zz8ASvNLgdUQk9CPe6qYTxPA885gTA3obLAmHFbSq0ConmSSLICS4fWs6GOnUc2ZLKoM7x9YQ6rh8nAegGfK4+It8gYJa73QnAD/uE8hfWUi/pkPlawNpIrpjbwi1jZdk+MmatBC8i5oSTWJ/7p93Bz124s/JU3KEAXRM37lZyb1xz4v/OJb6R+38j1lWl52v1tSp6tWif9ewrh/X5jLXMuJa66ZkUeblNj/mIKzRILWXHpTGY+qY/IOJUW1Sw3HkXC4umVUuWCDk3vjnkUoLBWJuEmk1LraVaw8roLHR8je4+fKrKxd9hCGJFFNmIpD4wr1f5TCiRFRkb3Xg8fi0Sj6HpIR74sFJrZ0N6vxvens9npwcTttV3lRG7HQ4v7vSOQMIdr5vMDZfCJ/5Ch5UbvZSY/bnbaZ3m5SGshAQdF7KqslRkK6SHqjp7/HAHf7v9/q+Lb1LncjsaDLbbbd+s4h4mwmnT12Y9MKuYfmndt32YpmioMu98EW+qLxwIATbHWKxETDWwqmveGErXUeIuNIbh7r5T+prsFkZ0+DyGL48TEAkqJ1Y7wlNH9VH15EtduNFScvXMDtDoKj3VYoss46bdhbcU0BnjuCvs1Vb7L991ZBMs/jWdPkAQAbFOsDpnha0V9dugvh0OI5bxl/Dth+GwJJmU8Vd4Qm1VLrny0Dp1h574tMEKP96x5gH098mMNmItTvX2WZumFYjfB48CL2//FyoSp1a6UG+ceuPUG6cucur7c4fUWAFF2Y9C0BhtQMdxYQz6Z2jZEK7WXc0MAhbfuPbGtTeudblWRixDl2oa2+baeujQ6G/EBhWderWZdrDvzgvLQeguA59osIdmU08ZCyPZiO0DqcrRYLBPtXXlaJ9r48rBhjJ2NAOg24F8NaikjrlMg2Hd5NINGmXWTt/xrFAJh3fweP80hX9yh1u+88Emlcei3w3fDc9KpaUXJI4fJhA8DNBslYtaLPH+rNiw+DWC/cjTYlwY4XZPtC2EZ4ncoBkXlJ8GMpU+L52+h0Usqj58qIH043+mHgtU6h4P49T7MHG+PP6cHQ3+Dgj92ryud3NpgDU7nvq0RyDNLHBB7l94Up+df7QdlovzD4hDz7OV9gGrWNANPeEQjQ25GvZvuox7mPjCEessK5RHOz2ZC5cCb6UyloV1lMKISRGjsj6u1bC9XvYx3IGfg0a46RMMA1fqQ2MtXFos+7HOBnHY1vxfSr0cZFyoQaXCDu7Gn758fj/ufZzc3X9+uu/d9Id99+J8uonUGVctO8KzZqc9PfV5fzgz317V/JGvaipeO3xxg1xyoajSeHjsq9o8Y53azCI2Ovs256g8L6KqxM7Yfr/kFr8YWZZ0+dcCzY6NZosDcT3ZEmHpc8JGKy7t6RugNka+eazmPt/Cb3gvdNb5ep6mdv7AkAV9YxF7Juqfe4lVLsqIpcgTNN6LsPAu2NqbkriDoM4bozKqd4zjGHN3Ye1R70j1pzlIH356mlIBrt5WZTqhvYZv6Y0a3wbjdd4MH/21PZNcrQu+prVBJv38F4y/ZIg= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Modify process instance

+ Modifies a running process instance. @@ -39,39 +39,248 @@ to terminate an active instance of an element. Use this to repair a process instance that is stuck on an element or took an unintended path. For example, because an external system is not available or doesn't respond as expected. -## Request + -

Path Parameters

Body

required
    activateInstructions object[]
    + -Instructions describing which elements should be activated in which scopes and which variables should be created. + 0 if provided.\n", + type: "integer", + format: "int64", + minimum: 1, + }, + }, + title: "ModifyProcessInstanceRequest", + }, + }, + }, + }} +> -
  • Array [
  • variableInstructions object[]
    - -Instructions describing which variables should be created. - -
  • Array [
  • variables objectrequired
    - -JSON document that will instantiate the variables for the root variable scope of the process instance. -It must be a JSON object, as variables will be mapped in a key-value fashion. - -
  • ]
  • ]
  • terminateInstructions object[]
    - -Instructions describing which elements should be terminated. - -
  • Array [
  • ]
  • = 1`"} schema={{"description":"A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.\n","type":"integer","format":"int64","minimum":1}}>
- -The process instance is modified. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The process instance is not found. - -
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/pin-clock.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/pin-clock.api.mdx index ff19081ac91..43facd320a8 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/pin-clock.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/pin-clock.api.mdx @@ -5,29 +5,32 @@ description: "Set a precise, static time for the Zeebe engine’s internal clock sidebar_label: "Pin internal clock (alpha)" hide_title: true hide_table_of_contents: true -api: eJztV19v2zYQ/yoHPrWYIrld2mV689J0y9AVQeKswOw8nKmzxVYiVZKKYxgC9jX29fZJhiOl2IkdrA8D9pIASUzyeP9+vzsfN8Lj0ol8Kk4rI7+Im0SYhix6ZfR5IXLRKB1PElGQk1Y1fCRycUUeEBpLUjlKwHn0SoJXNcHCWPAlwR9EcwLSS6Xp7z//cqC0J6uxAskq05n+VJIOomEDlINGaU1FAsqDpRqVdoA+iLiGpFooKqIR1AUUhhxo4wGLW9SS0pmeGJAl6iWFOyyZ7BioW+dhTr0VwCUqDSvlS0DQtAryzmPdpDM903mea+NppielckC6aIzSnr1EDVOsmhJhQehbSzcvMmnqxmjS3mWEtlofoZTkXBbk4t+jXtqldfEyRFDjmv1x7fwzSQ9+8H6mlYZFy8JgqSJ05NLg0UyLRFj62pLzP5liLfJNWCpLhci9bSkR0mhP2vMRNk2lZMAz++wYuY1wsqQa+ZNfNyRyYYJ1kYjGMvpekQunQzZ48RD9SUlAd8guMxhKAzVGllCrqlKOpNGF42hWpZLlDgCuNG1VbCFIRTI4weRYkhWJWBhbo49bb49F1yU7EU533LpJhFe+4tuBpBdKX8bMiK6L11xjtIvhvB4dHw4kurZCB64NmC3aqloPJPHmEP0ORpzOtOgScTwaHTY0RLHlGTRosSZPlmlVK+eUXoKxzH/lQNMSvbolTtMToDbWzCuqv9sH96H9MVxESSjIo6oggg7oIArOqeCoppfvT+HH4zc/3LwovW9cnmWr1Sq1C3lEhfLGpsYuM7uQ/MtyL1OYlGRp4DIWhWKbWMGWTkP65JDO3m1g8NPA6X/hYji9Z6zzVunlLldaq/Z61BiuL89BFaS9Wqw5s3umw50FthXrwLlpfT6vUH9hHHtu7Rt9bMW1dY12DWZxwECXCG6O7U4YT3D9+9d7upk1v0wmFxBVgDTF0F+5WUZDHESttKrbWuTHo1EiaryLq7ejUcc6GfFviEQD3TUV6kCtx+EoDbWx1PMnBKa089x4/yNkjFVL9dhuGhrAUOc9id/FiGKVvzlUb2O9/boha40FI2VrufpWpaqCeq71wXbfUiMXn2vtudaea22/1rpE1ORLEybDNjAHfSlykcl+SHRkb8nyRLkRra1ELjaxSro8yzalcb7LN42xvstuGYJbtArnVSQeH8dqGlhSGYlV2D6EFh9orGmI4hTrVhcIJ3B5djWBn9HTCtche2zyoeqT0cnooFYWfULj+OIcYoSRazv1P6jlQj6oNgp/i+Kuu+FEytYqv77iazE9c0JLdtxyxu850NsL2nkdhUTSf3g/MOPXT5MALveuy+34eHaHddNX3nbcGwW+LUzc7iesPY8ZPrIuhjhKX+0z7+I8FJA0dd3q0EX1cpi3t/pk1TrPkSeiUpK0C+4wsDtmP8QT+D1ahFcpoxcpNjTPpfJlO0+lqTMZr93/n1dmnvF7IutNuOx0/Nv1x3fjow/np2cfr86OXqWj1N/5kKXGOF+j3vHjQulH7xd4EYb6l4/D3my/Pp5fSf/nK6mvEE93PmsqVGE4D4zZ9H1rKuTw7I29Zyo2mzk6urZV1/H215bsWuTTm22r4lWXiJKwIBsa3RdaM1Mj6kcTNsviVcvm915gXTLcGEtJjX9C9sGwwR3hvvNeXE+4vvvHX20KvmpxxQ9DXIlczMRMCH7Js6LQOsL+RlSoly0uWT6q5Z9/AGWmkiU= +api: eJztV19v2zYQ/yoHPrWYIrld2mV689J0y9AVQeKswOw8nKmzxVYiVZKKYxgC9jX29fZJhiOl2IkdrA8D9pIASUzyeP9+vzsfN8Lj0ol8Kk4rI7+Im0SYhix6ZfR5IXLRKB1PElGQk1Y1fCRycUUeEBpLUjlKwHn0SoJXNcHCWPAlwR9EcwLSS6Xp7z//cqC0J6uxAskq05n+VJIOomEDlINGaU1FAsqDpRqVdoA+iLiGpFooKqIR1AUUhhxo4wGLW9SS0pmeGJAl6iWFOyyZ7BioW+dhTr0VwCUqDSvlS0DQtAryzmPdpDM903mea+NppielckC6aIzSnr1EDVOsmhJhQehbSzcvMmnqxmjS3mWEtlofoZTkXBbk4t+jXtqldfEyRFDjmv1x7fwzSQ9+8H6mlYZFy8JgqSJ05NLg0UyLRFj62pLzP5liLfJNWCpLhci9bSkR0mhP2vMRNk2lZMAz++wYuY1wsqQa+ZNfNyRyYYJ1kYjGMvpekQunQzZ48RD9SUlAd8guMxhKAzVGllCrqlKOpNGF42hWpZLlDgCuNG1VbCFIRTI4weRYkhWJWBhbo49bb49F1yU7EU533LpJhFe+4tuBpBdKX8bMiK6L11xjtIvhvB4dHw4kurZCB64NmC3aqloPJPHmEP0ORpzOtOgScTwaHTY0RLHlGTRosSZPlmlVK+eUXoKxzH/lQNMSvbolTtMToDbWzCuqv9sH96H9MVxESSjIo6oggg7oIArOqeCoppfvT+HH4zc/3LwovW9cnmWr1Sq1C3lEhfLGpsYuM7uQ/MtyL1OYlGRp4DIWhWKbWMGWTkP65JDO3m1g8NPA6X/hYji9Z6zzVunlLldaq/Z61BiuL89BFaS9Wqw5s3umw50FthXrwLlpfT6vUH9hHHtu7Rt9bMW1dY12DWZxwECXCG6O7U4YT3D9+9d7upk1v0wmFxBVgDTF0F+5WUZDHESttKrbWuTHo1EiaryLq7ejUcc6GfFviEQD3TUV6kCtx+EoDbWx1PMnBKa089x4/yNkjFVL9dhuGhrAUOc9id/FiGKVvzlUb2O9/boha40FI2VrufpWpaqCeq71wXbfUiMXn2vtudaea22/1rpE1ORLEybDNjAHfSlykcl+SHRkb8nyRLkRra1ELjaxSro8yzalcb7LN42xvstuGYJbtArnVSQeH8dqGlhSGYlV2D6EFh9orGmI4hTrVhcIJ3B5djWBn9HTCtche2zyoeqT0cnooFYWfULj+OIcYoSRazv1P6jlQj6oNgp/i+Kuu+FEytYqv77iazE9c0JLdtxyxu850NsL2nkdhUTSf3g/MOPXT5MALveuy+34eHaHddNX3nbcGwW+LUzc7iesPY8ZPrIuhjhKX+0z7+I8FJA0dd3q0EX1cpi3t/pk1TrPkSeiUpK0C+4wsDtmP8QT+D1ahFcpoxcpNjTPpfJlO0+lqTMZr93/n1dmnvF7IutNuOx0/Nv1x3fjow/np2cfr86OXqWj1N/5kKXGOF+j3vHjQulH7xd4EYb6l4/D3my/Pp5fSf/nK6mvEE93PmsqVGE4D4zZ9H1rKuTw7I29Zyo2mzk6urZV1/H215bsWuTTm22r4lWXiJKwIBsa3RdaM1Mj6kcTNsviVcvm915gXTLcGEtJjX9C9sGwwR3hvvNeXE+4vvvHX20KvmpxxQ9DXIlcCH7Fs5LQNsLeRlSoly0uWTaq5J9/AC/4kSk= sidebar_class_name: "put 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Pin internal clock (alpha)

+ - + Set a precise, static time for the Zeebe engine’s internal clock. When the clock is pinned, it remains at the specified time and does not advance. @@ -38,18 +41,129 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature in future releases. ::: -## Request + -

Body

required
+ -The clock was successfully pinned to the specified time in epoch milliseconds. + -
- -The required timestamp parameter is missing or it is negative. - -
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/publish-message.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx index 7bc811b9e83..fa891af3ed6 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx @@ -5,51 +5,266 @@ description: "Publishes a single message." sidebar_label: "Publish message" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isYnJIpTSmpk6a8KbbTOg/bY8vtwfYBJFciYhBg8JCs0fC/dxagREqUHDeT6aXWjEYCsdjnt4vlLqllU0OTG/oFjGFToHcRVRVoZrmSpzlNaOVSwU2x2o9oDibTvEICmtCLsA2GMGK4nAogZSCNb2VzyBCmgTSMICdWEVNBxic8IxXTliMvQzJVVs5CTiZalcQWwDXJlNYgvDbkHhYmvpXjAgjIvFJcWpIrMEQqS+aMWzJRmrCNMxqMEza+ldcGkOVKuQ2iNTc8b1xWEGeAZMwAyqMR1fDNgbHvVb6gydIvuYacJlY7iGimpAVpcYtVleCZZzv4atBDS2qyAkqG/+yiAppQlX6FzNKIVhp9bTkY3JWsBPzddDCaiztETboGxDRasTNWczmlNSqyNuoTLHbz2vLod9liwCfMCUsTijIsL2GsPvPZLl15CaZikrzgkpTmJUY6dZMJ6A3fK+mXqVb3oDsSubQwBU0jOlG6ZDY8envY1WFYR7Thg/DcZaGT/JsDcnq8bRs5l2KBsZ04gaqBNE6jOmJBlGz1m3Nb+INTPgNJTo9v5ZwLQWAGmqRdJL/IHTqJcGuI4BNA57wMmNn2onRCsFRAAE0d0RnTHB+Y3VaslFmTEWbIx6vzM5KrzJUgLXqO5bnPHiYuOlgKsNxGW08DC5JJu8+NYXfLh8SAzDeCts/AOurkyU0Adw+hd4gni2dWBcjXk5BAlyHraF0HZqZS0gR3vR4OH/fanJk2TDH9Fzm6n2cnW1oE9PNm7W8mxPmEJjfbPN8zA6RNfV91dlkf7N3FebNuPCmM/WzoF5D68WgEfVB7Wt9tK9Fw3Vt2+qXmB+V7sm4IZzKPM1Y6mbOYVTz214R0ZQr6l58WXvIJFoRZq3nqbMhF6UrQPCMzJhyY2BepSkPGbHszPEPiByGx9yp4mkZnPvyfYGGeBpdg7s+Dy3M1+O+qARIe7rsPKq1mPIec5MwywkOvOGOCP3YpVFqlAsrvwmFELgIlycEyLkgICRaHQJhCTrgkN5cfjsjvh29+u3tRWFuZZDCYz+exnmQHkHOrdKz0dKAnGX6R7mVMxgVoICVbYMPR3vJdpKx7aKsCDBtl0I8bPcg+pPjdZe8iX2ec07zX74/I9eUp4TlIyycL7H16ojdaRpYqZ5NUMHlP24j2hW5LMa4smW5TbENAHVFjmXUdM/ZUjF9f93gjLP4cjy9IYEEylYPPOltwsxKERpRc8tKVNDkcDiNasoewejvEHjRE/AmWSAIPlWAydNxb5mCbrDQ0+PGGcWksk9nPiozSfMq35cYb2dWA+DhYFBLqza6EGkmCXtaIQ9BaaaKyzGkNOZkXXHj2GRizkt28NgUsPufac64951o/1/z7rC2Un7Uo46HDbEETOmiuRjOo2ouPRtSAnoE2vpdwWtCELkPW1MlgsCyUsXWyrJS29WCGIdl40cTtkF0r1AiVMVEEyf3o4UZ3/HAUWifyjlyeXI3JH8zCnC28N1HkJut3w3fDnVyRdA/H0cUpCRYG7HXqwYotJvZOtoH4KYxr7FkMZE5zu7jCY8E9KTANeuQwAGtMNPI8d1wHIho1fz6skPLx77EPNtayy3ZkdPLAyipkYhjxtCDbHti0O90xy3Bj5NHSdAO78TrfGQlxOVHelAaAfacgI9AmeHEYv+qD/eLU52ymytJJj0M5DUMS1nFyJpyxYTQgeAbYnLUWr8g+hx3yV5BIXsUIkIDiVb2eclu4NM5UOWga9fVvKlQ6KBmXg0aEGRyNvlyfHY8OPp8enZxdnRy8ioexfbA+EJhPJZMdPZpxZafr3LB12V5T/4/JZoNwCw92UAnGJWLGh2PZlKGbFfYMVqZOIbqLmmJyQ5fLlBm41qKu8fE3B3pBk5u7FqK4qiNaAMtB+8p17/F+FNx9MEY9kFw41Kc3oqmj1YlRlkFlH6W965TUi/OrMWZqM7otVY5nNJvjWJfNaUJv6S2lOPX2sfLzXXy+pILJqUOQJDTwxc8/MBMfVQ== +api: eJztWEtz2zYQ/isYnJIpTSmpk6a8KbbTOg/bY8vtwfYBJFciYhBg8JCs0fC/dxagREqUHDeT6aXWjEYCsdjnt4vlLqllU0OTG/oFjGFToHcRVRVoZrmSpzlNaOVSwU2x2o9oDibTvEICmtCLsA2GMGK4nAogZSCNb2VzyBCmgTSMICdWEVNBxic8IxXTliMvQzJVVs5CTiZalcQWwDXJlNYgvDbkHhYmvpXjAgjIvFJcWpIrMEQqS+aMWzJRmrCNMxqMEza+ldcGkOVKuQ2iNTc8b1xWEGeAZMwAyqMR1fDNgbHvVb6gydIvuYacJlY7iGimpAVpcYtVleCZZzv4atBDS2qyAkqG/+yiAppQlX6FzNKIVhp9bTkY3JWsBPzddDCaiztETboGxDRasTNWczmlNSqyNuoTLHbz2vLod9liwCfMCUsTijIsL2GsPvPZLl15CaZikrzgkpTmJUY6dZMJ6A3fK+mXqVb3oDsSubQwBU0jOlG6ZDY8envY1WFYR7Thg/DcZaGT/JsDcnq8bRs5l2KBsZ04gaqBNE6jOmJBlGz1m3Nb+INTPgNJTo9v5ZwLQWAGmqRdJL/IHTqJcGuI4BNA57wMmNn2onRCsFRAAE0d0RnTHB+Y3VaslFmTEWbIx6vzM5KrzJUgLXqO5bnPHiYuOlgKsNxGW08DC5JJu8+NYXfLh8SAzDeCts/AOurkyU0Adw+hd4gni2dWBcjXk5BAlyHraF0HZqZS0gR3vR4OH/fanJk2TDH9Fzm6n2cnW1oE9PNm7W8mxPmEJjfbPN8zA6RNfV91dlkf7N3FebNuPCmM/WzoF5D68WgEfVB7Wt9tK9Fw3Vt2+qXmB+V7sm4IZzKPM1Y6mbOYVTz214R0ZQr6l58WXvIJFoRZq3nqbMhF6UrQPCMzJhyY2BepSkPGbHszPEPiByGx9yp4mkZnPvyfYGGeBpdg7s+Dy3M1+O+qARIe7rsPKq1mPIec5MwywkOvOGOCP3YpVFqlAsrvwmFELgIlycEyLkgICRaHQJhCTrgkN5cfjsjvh29+u3tRWFuZZDCYz+exnmQHkHOrdKz0dKAnGX6R7mVMxgVoICVbYMPR3vJdpKx7aKsCDBtl0I8bPcg+pPjdZe8iX2ec07zX74/I9eUp4TlIyycL7H16ojdaRpYqZ5NUMHlP24j2hW5LMa4smW5TbENAHVFjmXUdM/ZUjF9f93gjLP4cjy9IYEEylYPPOltwsxKERpRc8tKVNDkcDiNasoewejvEHjRE/AmWSAIPlWAydNxb5mCbrDQ0+PGGcWksk9nPiozSfMq35cYb2dWA+DhYFBLqza6EGkmCXtaIQ9BaaaKyzGkNOZkXXHj2GRizkt28NgUsPufac64951o/1/z7rC2Un7Uo46HDbEETOmiuRjOo2ouPRtSAnoE2vpdwWtCELkPW1MlgsCyUsXWyrJS29WCGIdl40cTtkF0r1AiVMVEEyf3o4UZ3/HAUWifyjlyeXI3JH8zCnC28N1HkJut3w3fDnVyRdA/H0cUpCRYG7HXqwYotJvZOtoH4KYxr7FkMZE5zu7jCY8E9KTANeuQwAGtMNPI8d1wHIho1fz6skPLx77EPNtayy3ZkdPLAyipkYhjxtCDbHti0O90xy3Bj5NHSdAO78TrfGQlxOVHelAaAfacgI9AmeHEYv+qD/eLU52ymytJJj0M5DUMS1nFyJpyxYTQgeAbYnLUWr8g+hx3yV5BIXsUIkIDiVb2eclu4NM5UOWga9fVvKlQ6KBmXg0aEGRyNvlyfHY8OPp8enZxdnRy8ioexfbA+EJhPJZMdPZpxZafr3LB12V5T/4/JZoNwCw92UAnGJWLGh2PZlKGbFfYMVqZOIbqLmmJyQ5fLlBm41qKu8fE3B3pBk5u7FqK4qiNaAMtB+8p17/F+FNx9MEY9kFw41Kc3oqmj1YlRlkFlH6W965TUi/OrMWZqM7otVY5nNJvjWJfNcaiJE28fJz/bxWdLKpicOgRIQgNP/PwDxbQeWQ== 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Publish message

+ - + Publishes a single message. Messages are published to specific partitions computed from their correlation keys. The endpoint does not wait for a correlation result. Use the message correlation endpoint for such use cases. -## Request + -

Body

required
    variables objectnullable
    + -The message variables as JSON document. + -
- -The message was published. - -
Schema
Schema
Schema
- -The provided data is not valid. - -
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/remove-group-from-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/remove-group-from-tenant.api.mdx index 73e4cd9c8ec..4ef854763de 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/remove-group-from-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/remove-group-from-tenant.api.mdx @@ -12,48 +12,226 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Remove a group from a tenant

+ Removes a single group from a specified tenant without deleting the group. -## Request - -

Path Parameters

- -The group was successfully removed from the tenant. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant or group was not found. - -
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/remove-mapping-rule-from-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/remove-mapping-rule-from-tenant.api.mdx index c800f404151..f27c04214c8 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/remove-mapping-rule-from-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/remove-mapping-rule-from-tenant.api.mdx @@ -12,48 +12,226 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Remove a mapping rule from a tenant

+ Removes a single mapping rule from a specified tenant without deleting the rule. -## Request - -

Path Parameters

- -The mapping rule was successfully removed from the tenant. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant or mapping rule was not found. - -
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/remove-user-from-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/remove-user-from-tenant.api.mdx index a03636c960b..17ef336842a 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/remove-user-from-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/remove-user-from-tenant.api.mdx @@ -12,48 +12,226 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Remove a user from a tenant

+ Removes a single user from a specified tenant without deleting the user. -## Request - -

Path Parameters

- -The user was successfully removed from the tenant. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant or user was not found. - -
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/report-job-error.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/report-job-error.api.mdx index 2c64b0381f5..72bf38fffd1 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/report-job-error.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/report-job-error.api.mdx @@ -5,56 +5,259 @@ description: "Reports a business error (i.e. non-technical) that occurs while pr sidebar_label: "Report error for job" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/iuYPSVTWlRS58Wb6jit3Tw8stIeHB1AcCXCJgEGACVrOPzvnQVIvZ3m0N6kGY1EYLHP71uS24DjcwvJHVzrFKYR6AoNd1KrqwwSMFhp4651emmMNhBBhlYYWZEAJDD225ZxltZWKrSWIQmyZ3KAA6a0OnMociUFL54zl3PHtBC1sWyZywJZZbRAa6WaM87udTr4piCCihteokNDfjWgeImQwL1O/8QVRCDJcsVdDhEY/F5LgxkkztS4794kR/aAK6ZnzOXoDUAEVuRYckgacKuKNEvlcI4U3Uybkruw9Poc2nYaTKB1v+lsRWf2LQqtHCpHW7yqCil88uJ7Sx40h8Z0eo/CUZSGUu0kWtr1abvQGdLFYRQhq0JnGLK4lEXBUmQldyLHjC2lyxlXvRytMlygciGjnW3rjFRzaKNg7hNay+dHLI56RWWQCDYroxcyQ8t4lkmS5AXz0T8etRKBqouCpwWGVLURLLiRtOAj3mi52crEsTJe3375zELetqKXyjqunOQOfXXXyhl3fqHQghfMCl1hj4CD9AR9fgGtF3G50csu/p2w1oXbC6vdRuHdViGnETjpSA56Ao0DlqBtwzFbaWVDOl4Oz39QCGl7x2babMDcRnA+HB6HTFeujGXccVKgtGMLXsgshPUEcCuj0wLLXw4BvOcauwmSLEPHZdEXiFsWBFPMmFTsbvzhgr07f/Vm+ix3rrJJHC+Xy4GZiTPMpNNmoM08NjNBX5J7PmCTHA1he0UQ30LbhjLMVijkTArmtE9H5zajYh0v2y7fwm5zgNl1B6iNPGh3I/Z1fMVkhsrJ2Yq61oFpf2bG64J08FTXLkkLrh6oVB0aDo3uW7F1WXKz7lu7BtoIrOOutv/awX59eaCbgPHHZHLDgorQUQKkpO0NURClVLKsS0jOh8MISv4Yrl4Phy3ppIr/RCSK4WNVcOWhtR+OVKzUBjv8+MACp8V/VRlt5Fzu2x1Au6kFdCB+HyIKvDw/RsVJ4FzotKRuLheoWLgr9fSa6Vqd6HWi14leP6TXu5+m10PgllR+bWm0mvvcIhO1MahcsRqwT5swLeNm69bXnetvtCzV2epEzxM9T/R8mp6vjj1QjhSjLBvCYXgi9e9xhl499t/kAuP8g+6Jayeunbj2FNfaCEp0uaZBS6Wthw6NNRKI73Vq4yY8XLYxdsMXi2bRT0VqU0ACTSBNm8Rxk2vr2qShiUwbL6giO+/btB3I1YPGvyDnwfBh8WiDRi99UBe8rFXG2Vs2vrydsN+5wyVf+WSSyV3Vb4dvh0e1kugTGkc3VyxEGKC31Q56tcTro2qD8M8o9jMdi6I20q1u6VhIT4rcoBnVlP81JDp7XjtdByGIuj8feqBc/z3xtaZWNt7Miy4feVkFIm7NdzZA253CbNa369Z6sM6096qD0mF8dAiNDQkZDl4cwvbmyrNP6LKslW/Bat6NjbbyJYraOspTBIUUqKx3vpvA9WIfww77K1hkLwZU6wDIvvPOpcvrdCB0GYtwbP2bFjqNSy5V3Jmw8cXo09fP70dnH68uLj/fXp69GAwH7tH5nBIzSq62/AhTx+4+REHd63Q/4GZz1/mfppQdRGj8FVcFl4pA65PQdDS+o5mlhQiS9ewyMHkadWy8g6ZJucWvpmhbWv5eo1lBcjfdgMCzPZOW/meQzHhh9ydk28E+G3fDqOfs+PjzqN/dIlcrD7+ipiuI4AFXm9FrO20jyJFnaLxTYfMimD6bkIrN4YNhaBv1J0ZCYOWekN15KiCurlvkzZfbCVGvG8SWgUyGL2kOzJeQwDf4Rk5rnxbPar/eQMHVvA4kC3rp8w8ixe97 +api: eJztWEtz2zYQ/is7OCVTWlRSJ014Ux2ntRsnHllpD64OILgSYZMAA4CSNRz+984CpN5Oc2hv0oxGIrDY5/ctyW2Y43PLknt2rVM2jZiu0HAntbrKWMIMVtq4a51eGqMNi1iGVhhZkQBL2NhvW+CQ1lYqtBaQBOGFHOAAlFZnDkWupODFS3A5d6CFqI2FZS4LhMpogdZKNQcODzod/K1YxCpueIkODfnVMMVLZAl70OkfuGIRk2S54i5nETP4rZYGM5Y4U+O+e5Mc4RFXoGfgcvQGWMSsyLHkLGmYW1WkWSqHc6ToZtqU3IWlt+esbafBBFr3q85WdGbfotDKoXK0xauqkMInL36w5EFzaEynDygcRWko1U6ipV2ftgudIV0cRhGyKnSGIYtLWRSQIpTciRwzWEqXA1e9HK0CLlC5kNHOtnVGqjlro2DuBq3l8yMWR72iMkgEm5XRC5mhBZ5lkiR5AT76p6NWIqbqouBpgSFVbcQW3Eha8BFvtNxuZeJYGa/vvnyGkLet6KWyjisnuUNf3bVy4M4vFFrwAqzQFfYIOEhP0OcX0HoRlxu97OLfCWtduL2w2m0U3m8VchoxJx3JsZ5A44Al1rbhmK20siEdr4fn3ymEtL1jM202YG4jdj4cHodMV64MMu44KVDawYIXMgthPQPcyui0wPKnQwDvuQa3QRIydFwWfYG4hSCYYgZSwf344wW8P3/zy/RF7lxlkzheLpcDMxNnmEmnzUCbeWxmgr4k93IAkxwNYXtFEN9C24YyYCsUciYFOO3T0bkNVKzjZdvlW9htDjC77gC1kQftbgRfx1cgM1ROzlbUtQ5M+zMzXhekg6e6dklacPVIperQcGh034qty5Kbdd/aNdBGzDruavuvHezn1we6CRi/Tya3EFSEjhIgJW1viIIopZJlXbLkfDiMWMmfwtXb4bAlnVTxH4hEAT5VBVceWvvhSAWlNtjhxwcWOC3+q8poI+dy3+6AtZtasA7EH0JEgZfnx6g4CZwLnZbUzeUCFYS7Uk+vma7ViV4nep3o9V16vf9hej0Gbknl15ZGq7nPLYKojUHlitUAbjZhWuBm69bXnetvtJDqbHWi54meJ3o+T883xx4oRwooy4ZwGJ5I/XucoVeP/Te5wDj/oHvi2olrJ649x7U2YiW6XNOgpdLWQ4fGGgmLH3Rq4yY8XLYxdsMXi2bRT0VqU7CENYE0bRLHTa6ta5OGJjJtvKCK7Lxv03YgVw8a/4KcB8OHxaMNGr30QV3wslYZh3cwvrybwG/c4ZKvfDLJ5K7qd8N3w6NaSfQZjaPbKwgRBuhttYNeLfH6qNog/COK/UzHoqiNdKs7OhbSkyI3aEY15X8Nic6e107XQYhF3Z+PPVCu/5r4WlMrG2/mRZdPvKwCEbfmOxug7U5hNuvbdWs9WGfae9VB6TA+OoTGhoQMB68OYXt75dkndFnWyrdgNe/GRlv5EkVtHeUpYoUUqKx3vpvA9WKfwg78GSzCqwHVOgCy77xz6fI6HQhdxiIcW/+mhU7jkksVdyZsfDG6+fr5w+js09XF5ee7y7NXg+HAPTmfU2JGydWWH2Hq2N2HKKgHne4H3GzuOv/TlLKDCI2/4qrgUhFofRKajsb3NLO0LGLJenYZmDyNOjbes6ZJucWvpmhbWv5Wo1mx5H66AYFneyYt/c9YMuOF3Z+QbQf7YtwNo17C8fHnUb+7Ra5WHn5FTVcsYo+42oxe22kbsRx5hsY7FTYvgumzCanYHD4YhrZRf2IkBFbuGdmdpwLi6rpF3n65mxD1ukFsGchk+JLmwHwZHNY+JZ7Rfq1hBVfzOhAs6KTPP3eh7n8= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Report error for job

+ - + Reports a business error (i.e. non-technical) that occurs while processing a job. -## Request + -

Path Parameters

Body

required
    variables objectnullable
    + -JSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error. + -
- -An error is thrown for the job. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the given jobKey is not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the given key is in the wrong state currently. 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/reset-clock.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/reset-clock.api.mdx index 0da0637d761..efedb383906 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/reset-clock.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/reset-clock.api.mdx @@ -12,22 +12,25 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Reset internal clock (alpha)

+ - + Resets the Zeebe engine’s internal clock to the current system time, enabling it to tick in real-time. This operation is useful for returning the clock to @@ -38,14 +41,57 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature in future releases. ::: -## Request + -
+ -The clock was successfully reset to the system time. - -
- -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/resolve-incident.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx index 8397707e33e..22cb247ba02 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx @@ -12,44 +12,176 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Resolve incident

+ Marks the incident as resolved; most likely a call to Update job will be necessary to reset the job’s retries, followed by this call. -## Request + -

Path Parameters

+ -The incident is marked as resolved. + -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The incident with the incidentKey is not found. - -
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/search-groups.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx index aee11356a27..0ad1d3550c3 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx @@ -5,88 +5,566 @@ description: "Search for groups based on given criteria." sidebar_label: "Query groups" hide_title: true hide_table_of_contents: true -api: eJztWm1v2zYQ/isEP22YIjtt1nX65qZJl/Uty0v3wQ0QSjpbbChSJak4hqH/Phwp2bKtOG6QYd3mAkFt8Xh3vHueO4rmjFo2NjQa0jdalQW9CqgqQDPLlTxJaUQNMJ1kbtDQgKZgEs0LHKYRPXeDZKQ0GTsJEjMDKVGSjPktSJJobkFzFn6WNKAavpZg7CuVTmk0c1+5hpRGIyYMBDRR0oK0OMaKQvDEudH7YtDYjJokg5zhp2UvnHPEO0pqGyENKBPi44hGwxm10wJoRFX8BRJLA1poXKTlYJxepe261nOlLRlxEOliFTRoVDGt2ZQGlFvInZJtjTmN69YuMqiNWUXQIRJPW+aM1VyOaRVQpVPQ3fPdEOGSTDKeZHNFNgOiQTALqTeBekGWOWZ9cH5IA/r66PwQU5/CiJXC0qh+brkVUMfiI2o/wmlVFbRyN6yXdNUSd6n4owQ9xZlnPiW0usKZBRvDuv+nbMylS/dStLeOqlZ5d1C4TOGOqBFxmXJBsUzbGi5cjgnObYWaSwtj0DSgI6VzZv2j588w+ILnvAMqaCdndzwvcyLLPAa9ZFCDLbXExCgJbYBuYdG7ORjZrqSfzJfksc9QLCSHSvt8uzFM/7VgxmIqPjFRgrkmdfSm6CcjhYZbrkqz4JAplDSwCe/L+ajmrr6CkdIdCV71NXZync6OuP67va06wXrKxrAAa9Cxxo5J909Yp77oTCPCZ9yuYV7QLBOgq+Z5wQZS9CEHJMuhFY26qKwWdXQHJTHatnEtXFq+s37sjC+Te0mgK0iVLx4+Y86pZ/3+hpC0s1wKx5qn6RJrmJnHbNua82Ah49LzGT+zWJW+FC+tZ2OOH6Fqs8dWWSZOGk6sRBzH6pqVM+tLIxrpaH7dBevFARasFfJ2p9b1pVsn0KDMzXP2sVD6noXLIgZsSC4NEJtx04xdt4vNdd05sTpIAtKU6Pt6nd2ihi3Xya2dx2nf6rur6U/m+qaC5qG+wtAlcs4lVhHD7wGLa3g1SDxPNzm7BRFd9DazcVnLK2aALJx1e1Cn+eQeRY8thb4yo3xHDURj6ElH6Ny8tzD9Fis3MA2RRMwYPpaQvgfcTLyFaTvnTXg7kAkWkXQDU4fM3M02pNHWNNi6oK+jqdlldi6z43EnhtD9Vlm+lWmYsLyUKQtZwUN0LvSbpJ8eV7LJW5gSZq3mcYnbBmZw0wWaJzUrQxecQkOCe14aWV3CrszvyvyuzH8nZf7JGfzvbw0Lrm3sDV1U/Ieaxf3VoTMUH8q5d1s1kiX5LVqKT9MjW8ruLWDXHnbt4XtpD7u3gP/AWwCKHWw82mmS/xVnkhHjAtKQvFcaSAqWcWEI0y67tzyFtEUqj5VYpVP/u8I9J0KFVrGA/MGeMCCnXrK2SzxacFviBWNvfXh2fEh+Pfj5l6sfMmsLE/V6k8kk1KNkD1JulQ6VHvf0KME/lPsxJBcZaGTJlMRAWJpytMlEG7OmgISPeNIkpnabYDr8+h6o5250HV7zqlxqvgaUAbk8OyE8BWn5aNpU+SXTtP17gGs3USyYvKELADyE6QExZZ4zPW1K5LIBPDS2zJYPbyueP+uE+m8XF6fEqyCJSsHx31XZ2hAuIucST+ZpdNDvB7Q+p6fRi36/Qp2Y8S1WIgncFYLVnXhlOVySfIFbtzAujWUyearMKM3HfNXucimqQfzar6hh4H43A+vmQgRLbgz2MZ4SVtoMrSbN7zDgnGDCbDh23ZFsR7L/Pcmer+P9WOmYpylIB88537ghUlnChFATSHe82vFqx6v7ePVz1/ZxgK/BFjTiELRWmqgkKbWGFK89CKc+AWMa2623qB3TdkzbMW2daVVAc7CZwutehXL3CApmMxrRnn+r7/k3NYp3PPQtaOPexEstaERnni5V1OvNMmVsFc0KpW3Vu8Vc3DLNWSw8AnHY06qBi1AJE5k3uZ42HGhfRDj0Z37kJTk7Or8gb5iFCfOvysX8Clej+mX/Zb9TK4reo3FwekL8Cj3oWoWgUYuM7n7rdsLbKK7wlMBAUmpup+c4zYcnBqZBD0qM/BwMtT2nHb97IRrUH44biPz+54XLMhaxs8U1u6M7lheegovbJ/7Uo3WnzF+AG84vp82HrhbXtfwNq/78DlR/5W7ScOaX1b4DhM8qB/KRcmuqIbgeHYQKaOPD2Q/31+F+euJYm6g8L6Ur3XJMJtxmhLWinYjS4B0oin4mgEcRiwU3Yu/8CPnkLZL9EJHi4dxU7DG3WRmHicp79VHz/P9YqLiXMy57tQnTOxy8v/zwerD37uTw6MP50d5+2A/tnT9MREblTLb8cEcl9YHZ6kJniy71rbcra8RYuLO9QjAuMbVuVbOaz0M6N1oz+iqoWTmksxlqv9SiqvCxO5Wh0fBqQWL8VgU0A5b6jNMbPNiih97jvQt0AMVF6U6oVi/nVEEzY5AkUNiNsletonT68fwCIV/fG81VinM0m+CdUjahEf1MP1OKV1dRg2OTez6jgslx6SBMvV789xfqtf8r +api: eJztWm1v2zYQ/isEP22YIjtt2nX65qZJl/Uty0v3wQsQSjpbbChSJak4hqH/Phwp2bKtOG6QYd3mAkFt8Xh3vHueO4rmjFo2NjQa0rdalQW9CqgqQDPLlTxJaUQNMJ1kbtDQgKZgEs0LHKYRPXeDZKQ0GTsJEjMDKVGSjPktSJJobkFzFv4paUA1fC3B2NcqndJo5r5yDSmNRkwYCGiipAVpcYwVheCJc6P3xaCxGTVJBjnDT8teOOeId5TUNkIaUCbEpxGNhjNqpwXQiKr4CySWBrTQuEjLwTi9Stt1redKWzLiINLFKmjQqGJasykNKLeQOyXbGnMa161dZFAbs4qgQySetswZq7kc0yqgSqegu+e7IcIlmWQ8yeaKbAZEg2AWUm8C9YIsc8z64PyQBvTN0fkhpj6FESuFpVH93HIroI7FJ9R+hNOqKmjlblgv6aol7lLxewl6ijPPfEpodYUzCzaGdf9P2ZhLl+6laG8dVa3y7qBwmcIdUSPiMuWCYpm2NVy4HBOc2wo1lxbGoGlAR0rnzPpHz59h8AXPeQdU0E7O7nhe5kSWeQx6yaAGW2qJiVES2gDdwqJ3czCyXUk/mS/JY5+hWEgOlfb5dmOY/mvBjMVUfGaiBHNN6uhN0U9GCg23XJVmwSFTKGlgE96X81HNXX0NI6U7Erzqa+zkOp0dcf13e1t1gvWUjWEB1qBjjR2T7p+wTn3RmUaEz7hdw7ygWSZAV83zgg2k6EMOSJZDKxp1UVkt6ugOSmK0beNauLR8Z/3YGV8m95JAV5AqXzx8xpxTz/r9DSFpZ7kUjjVP0yXWMDOP2bY158FCxqXnM35msSp9KV5az8YcP0LVZo+tskycNJxYiTiO1TUrZ9aXRjTS0fy6C9bLAyxYK+TtTq3rS7dOoEGZm+fsY6H0PQuXRQzYkFwaIDbjphm7bheb67pzYnWQBKQp0ff1OrtFDVuuk1s7j9O+1XdX05/M9U0FzUN9haFL5JxLrCKG3wMW1/BqkHiebnJ2CyK66G1m47KW18wAWTjr9qBO88k9ih5bCn1lRvmOGojG0JOO0Ll572D6LVZuYBoiiZgxfCwh/QC4mXgH03bOm/B2IBMsIukGpg6ZuZttSKOtabB1QV9HU7PL7Fxmx+NODKH7rbJ8K9MwYXkpUxaygofoXOg3ST89rmSTdzAlzFrN4xK3Dczgpgs0T2pWhi44hYYE97w0srqEXZnflfldmf9OyvyTM/jf3xoWXNvYG7qo+A81i/urQ2coPpZz77ZqJEvyW7QUn6ZHtpTdW8CuPezaw/fSHnZvAf+BtwAUO9h4tNMk/yvOJCPGBaQh+aA0kBQs48IQpl12b3kKaYtUHiuxSqf+d4V7ToQKrWIB+YM9YUBOvWRtl3i04LbEC8be+vDs+JD8cvDi56sfMmsLE/V6k8kk1KNkD1JulQ6VHvf0KME/lPsxJBcZaGTJlMRAWJpytMlEG7OmgISPeNIkpnabYDr8+h6o5250HV7zqlxqvgaUAbk8OyE8BWn5aNpU+SXTtP17gGs3USyYvKELADyE6QExZZ4zPW1K5LIBPDS2zJYPbyueP+uE+q8XF6fEqyCJSsHx31XZ2hAuIucST+ZpdNDvB7Q+p6fRy36/Qp2Y8S1WIgncFYLVnXhlOVySfIFbtzAujWUyearMKM3HfNXucimqQfzGr6hh4H43A+vmQgRLbgz2MZ4SVtoMrSbN7zDgnGDCbDh23ZFsR7L/Pcmer+P9WOmYpylIB88537ghUlnChFATSHe82vFqx6v7ePWia/s4wNdgCxpxCForTVSSlFpDitcehFOfgDGN7dZb1I5pO6btmLbOtCqgOdhM4XWvQrl7BAWzGY1oz7/V9/ybGsU7HvoWtHFv4qUWNKIzT5cq6vVmmTK2imaF0rbq3WIubpnmLBYegTjsadXARaiEicybXE8bDrQvIhz6Mz/yipwdnV+Qt8zChPlX5WJ+hatR/ar/qt+pFUXv0Tg4PSF+hR50rULQqEVGd791O+FtFFd4SmAgKTW303Oc5sMTA9OgByVGfg6G2p7Tjt+9EA3qD8cNRH7748JlGYvY2eKa3dEdywtPwcXtE3/q0bpT5i/ADeeX0+ZDV4vrWv6GVX9+B6q/cjdpOPPLat8BwmeVA/lIuTXVEFyPDkIFtPHh7If763A/PXGsTVSel9KVbjkmE24zwlrRTkRp8A4URT8TwKOIxYIbsfd+hHz2Fsl+iEjxcG4q9pjbrIzDROW9+qh5/n8sVNzLGZe92oTpHQ4+XH58M9h7f3J49PH8aG8/7If2zh8mIqNyJlt+uKOS+sBsdaGzRZf61tuVNWIs3NleIRiXmFq3qlnN5yGdG60ZfRXUrBzS2Qy1X2pRVfjYncrQaHi1IDF+qwKaAUt9xukNHmzRQ+/x3gU6gOKidCdUq5dzqqCZMUgSKOxG2atWUTr9dH6BkK/vjeYqxTmaTfBOKZvQiFK8toqzHZPcsxkVTI5LB1/qdeK/vwAA4P4v 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query groups

+ - + Search for groups based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Group filter request - -
- -The groups search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching groups. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching groups. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching groups. - -
  • Array [
  • ]
- -The group 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/search-roles.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx index e3bda88d497..92c4a7392f0 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx @@ -5,84 +5,539 @@ description: "Search for roles based on given criteria." sidebar_label: "Query roles" hide_title: true hide_table_of_contents: true -api: eJztWltv2zYU/isEnzZMkZ027Tq9uW66Zesly6V7cAOEko4tNhSpklQcw9B/Hw4p2bKtOG6XYS3mAEFskTzX7zuHYjinlk0MjUb0TAmgVwFVBWhmuZInKY2oAaaTDMcMDWgKJtG8wFEa0XM3RsZKE40TSMwMpERJMuG3IEmiuQXNWfhR0oBq+FyCsS9VOqPR3H3lGlIajZkwENBESQvS4hgrCsETZ0Tvk0Fdc2qSDHKGn1aNQNOIt5LUKkIaUCbE+zGNRnNqZwXQiKr4EySWBrTQ6KHlYJxYpe2m0HOlLRlzEOnSCRo0opjWbEYDyi3kTsiuypzETW0XGdTKrCJoEIlnLXXGai4ntAqo0ino7vVuiHBJphlPsoUgmwHRIJiF1KtAuSDLHDM+OB/SgL46Ph9i3lMYs1JYGtXPLbcC6li8R+nHuKyqglbqRrVLV63pLhV/lqBnuPLMp4RWV7iyYBPYtP+UTbh02V6J9s5R1SrvDgqXKdwRNSYuUy4olmlbw4XLCcG1rVBzaWECmgZ0rHTOrH/09AkGX/Ccd0AF9eTsjudlTmSZx6BXFGqwpZaYGCWhDdAdNHozB2PblfSThUse+wynhWSotM+3G8P0XwtmLKbiAxMlmGtSR2+GdjJSaLjlqjRLDplCSQPb8L6aj2ph6ksYK92R4HVbYzev09gx1/+2tVUnWE/ZBJZgDTp87Fh0/4LldCxQXUsqTyVvvzP0Sb/fjS9fXZcul8JB6FEq5kb8Fg7syr8HSc2lxzZ+ZrEqfVlaccesEv4fi9pusVWWiZMGH2vxxrGavzmzvkygko5G0E3e50dI3jUgdyfW1ehbNwHxbV0j0MY6/Vg0fP1Gt4gBG5JLA8Rm3DRj123iXdddBJkiCUhTou2bNWcHPq/WjJ2Nx2Vfarurb49m+jZye6jXraiTzYsZ64jh94DFFf8aJI6l22x9mIYudtu5uCrkJTNAlqa6vRgKPrlHzqpXkuXQCmK90Vjf5jUViOD0cKUUNqrQjI6o3cDsC8TfwCxE5jBj+ERC+hawm/4Bs3aim6B2wBEswucGZg6OuVttSCOt6TCoKuxAULPL6nJv82knatD2Vh2+lWmYsLyUKQtZwUO0LPRbhJ++qkaTP2BGmLWaxyX2TGZwxwGaJzUNQxeYQkOCGz4aWV3Cvq7v6/q+rn8Tdf3R+fv99oIlw7Y1gy7+/Tfd4f6K0BWCd+XCtl06x8r0HXqIz83X9ZD9Pn/fD/b94NvoB/t9/ne6z8dZR9sOa5p8f8aFZMy4gDQkb5UGkoJlXBjCtEvoLU8hbbHIwyNW6cyfmt9zxlNoFQvIH+wBA3LqZ9Z6iUcIbj38xNhrH529HpJfjp79fPVDZm1hol5vOp2GepwcQMqt0qHSk54eJ/iL834MyUUGGmkxIzEQlqYcdTLRhqkpIOFjnjRJqc0mmAvv3wMF3I1uImtRhkvNN0AyIJdnJ4SnIC0fz5qyvqKato+7XX+JYsHkDV2m/yE4D4gp85zpWVMTVxXgmahltnx4E/H0SSfMf7u4OCVeBElUCo7yrqzWitCJnEs8eKbRUb8f0PoYmkbP+/0KZWLGd/BEErgrBKtb75o7XJJ8iVvnGJfGMpk8VmaU5hO+rne1/tQgfuU9agh4eA8BfTchgiU3BhsXTwkrbYZak+bfDOCMYMJsOUjdk2xPsv89yZ5u4v210jFPU5AOngu+cUOksoQJoaaQ7nm159WeV/fx6lnX7nGA770WNOIQtFaaqCQptYYU/6svnPgEjGl0t16b9kzbM23PtE2mVQHNwWYKrzIVyjjoMJvRiPbca3zPv6hRvMGgb0Eb9+5dakEjOvdsqaJeb54pY6toXihtq94tpuKWac5i4QGIw55VDVqESpjIvMbNrOEAvmU33gz9ER95Qc6Ozy/Ir8zClPm35GJxQakR/aL/ot8pFafeI3FwekK8hx5zrTrQiEVCd79wu8m7CK7waMBAUmpuZ+e4zIcnBqZBD0oM/AILtT4nHb/7STSoP7xuEPL7XxcuyVjDzpZ3yI7vWF54Bvo7XKPF/arFO/7V8saRvyTUX1zj6a9drxnNve3tayz4rHJAHitneA2zzRAgHkAbH7N+eLgJ6dMTx8xE5XkpXXmWEzLlNiOsFdJElAav8VC0MwE8bVgc3yzUvvEj5IPXSA5DhIPHbFOVJ9xmZRwmKu/Vx8eLv7FQcS9nXPZqFaY3HLy9fPdqcPDmZHj87vz44DDsh/bOnxAia3ImW3a40xB/Crbu53zZiL7wdmANCgt3tlcIxiXC1Pk0rxk7oo3KmrNXQc27EZ3PUfilFlWFj92xC41GV0ua4rcqoBmw1KfbH1rRobf34AL143RRuuOn9fs0VdCsGCQJFHbr3KtW1Tl9f36BoK6vPeYqxTWaTfFKJJvSiH6kHynFe5cowfHFPZ9TweSkdPilXi7+/A2f/YcQ +api: eJztWltv2zYU/isEnzZMkZ027Tq9uW66Zb1luXQPXoBQ0rHFhiJVkopjGPrvwyElW7YVx+0yrMUcIIgtkuf6fedQDOfUsomh0YieKQH0KqCqAM0sV/IkpRE1wHSS4ZihAU3BJJoXOEojeu7GyFhponECiZmBlChJJvwWJEk0t6A5C/+SNKAaPpdg7EuVzmg0d1+5hpRGYyYMBDRR0oK0OMaKQvDEGdH7ZFDXnJokg5zhp1Uj0DTirSS1ipAGlAnxYUyj0ZzaWQE0oir+BImlAS00emg5GCdWabsp9FxpS8YcRLp0ggaNKKY1m9GAcgu5E7KrMidxU9tFBrUyqwgaROJZS52xmssJrQKqdAq6e70bIlySacaTbCHIZkA0CGYh9SpQLsgyx4wPzoc0oK+Oz4eY9xTGrBSWRvVzy62AOhYfUPoxLquqoJW6Ue3SVWu6S8UfJegZrjzzKaHVFa4s2AQ27T9lEy5dtleivXNUtcq7g8JlCndEjYnLlAuKZdrWcOFyQnBtK9RcWpiApgEdK50z6x89fYLBFzznHVBBPTm743mZE1nmMegVhRpsqSUmRkloA3QHjd7Mwdh2Jf1k4ZLHPsNpIRkq7fPtxjD914IZi6n4yEQJ5prU0ZuhnYwUGm65Ks2SQ6ZQ0sA2vK/mo1qY+hLGSnckeN3W2M3rNHbM9b9tbdUJ1lM2gSVYgw4fOxbdv2A5HQtU15LKU8nb7wx90u9348tX16XLpXAQepSKuRG/hQO78u9BUnPpsY2fWaxKX5ZW3DGrhP/HorZbbJVl4qTBx1q8cazmb86sLxOopKMRdJP3+RGSdw3I3Yl1NfrWTUB8W9cItLFOPxYNX7/RLWLAhuTSALEZN83YdZt413UXQaZIAtKUaPtmzdmBz6s1Y2fjcdmX2u7q26OZvo3cHup1K+pk82LGOmL4PWBxxb8GiWPpNlsfpqGL3XYurgp5yQyQpaluL4aCT+6Rs+qVZDm0glhvNNa3eU0FIjg9XCmFjSo0oyNqNzD7AvE3MAuROcwYPpGQvgPspm9g1k50E9QOOIJF+NzAzMExd6sNaaQ1HQZVhR0IanZZXe5tPu1EDdreqsO3Mg0TlpcyZSEreIiWhX6L8NNX1WjyBmaEWat5XGLPZAZ3HKB5UtMwdIEpNCS44aOR1SXs6/q+ru/r+jdR1x+dv99vL1gybFsz6OLff9Md7q8IXSF4Xy5s26VzrEzfoYf43HxdD9nv8/f9YN8Pvo1+sN/nf6f7fJx1tO2wpsn3Z1xIxowLSEPyTmkgKVjGhSFMu4Te8hTSFos8PGKVzvyp+T1nPIVWsYD8wR4wIKd+Zq2XeITg1sNPjL320dnrIfnl6NnPVz9k1hYm6vWm02mox8kBpNwqHSo96elxgr8478eQXGSgkRYzEgNhacpRJxNtmJoCEj7mSZOU2myCufD+PVDA3egmshZluNR8AyQDcnl2QngK0vLxrCnrK6pp+7jb9ZcoFkze0GX6H4LzgJgyz5meNTVxVQGeiVpmy4c3EU+fdML8t4uLU+JFkESl4CjvymqtCJ3IucSDZxod9fsBrY+hafS8369QJmZ8B08kgbtCsLr1rrnDJcmXuHWOcWksk8ljZUZpPuHrelfrTw3iV96jhoCH9xDQdxMiWHJjsHHxlLDSZqg1af7NAM4IJsyWg9Q9yfYk+9+T7Okm3l8rHfM0BengueAbN0QqS5gQagrpnld7Xu15dR+vnnXtHgf43mtBIw5Ba6WJSpJSa0jxv/rCiU/AmEZ367Vpz7Q90/ZM22RaFdAcbKbwKlOhjIMOsxmNaM+9xvf8ixrFGwz6FrRx796lFjSic8+WKur15pkytormhdK26t1iKm6Z5iwWHoA47FnVoEWohInMa9zMGg7gW3bjzdAf8ZEX5Oz4/IL8yixMmX9LLhYXlBrRL/ov+p1Sceo9EgenJ8R76DHXqgONWCR09wu3m7yL4AqPBgwkpeZ2do7LfHhiYBr0oMTAL7BQ63PS8bufRIP6w+sGIb//eeGSjDXsbHmH7PiO5YVnoL/DNVrcr1q8418tbxz5S0L9xTWe/tr1mtHc296+xoLPKgfksXKG1zDbDAHiAbTxMeuHh5uQPj1xzExUnpfSlWc5IVNuM8JaIU1EafAaD0U7E8DThsXxzULtWz9CPnqN5DBEOHjMNlV5wm1WxmGi8l59fLz4GwsV93LGZa9WYXrDwbvL968GB29Phsfvz48PDsN+aO/8CSGyJmeyZYc7DfGnYOt+zpeN6AtvB9agsHBne4VgXCJMnU/zmrEj2qisOXsV1Lwb0fkchV9qUVX42B270Gh0taQpfqsCmgFLfbr9oRUdensPLlA/ThelO35av09TBc2KQZJAYbfOvWpVndMP5xcI6vraY65SXKPZFK9EsimNKMU7l7jaccU9m1PB5KR02KVeJv78DZajhhQ= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query roles

+ - + Search for roles based on given criteria. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
- -The roles search result. - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching roles. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching roles. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching roles. - -
  • Array [
  • ]
- -The role 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}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
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/search-tenants.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx index f06e6eca3a7..a3eb045c250 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx @@ -5,92 +5,631 @@ description: "Retrieves a filtered and sorted list of tenants." sidebar_label: "Query tenants" hide_title: true hide_table_of_contents: true -api: eJztWmFv2zYT/isEP22YI7tttrfTNzdJN69bmyXp9sENUEo6WVwpUiWpOIah//7iSMmWbDlxsw7bBxUIaonk3fHuee4k6tbUsoWh4ZzegGTS0tsRVQVoZrmSs4SG1ADTceZHDR3RBEyseYHjNKRXYDWHOzCEkZQLCxoSwmRCjNIWEiK4sUSlxPr1AR1RDZ9LMPaVSlY0XLtLriGhYcqEgRGNlbQgLY6xohA8draM/zKocE1NnEHO8FfXEm8h8eaSWgkdUbsqgIZURX9BjNdMiHcpDefrvZFC484tB+P0KG33tVwrbUnKQSQk1tyC5izYKmFasxUdUW4hd0KOVeYk9uwpg1qZVc6jJFq11BmruVzQakSVTkD3r3dDhEuyzHicbQTZDIgGwTBITgXKBVnmiIXp9Rkd0fOL6zPEQwIpK4WlYX3fciug9sU7lH6By6pq1IrlvN7SbWu6i8zvJegVrryqI1Td4sqCLWDf/ku24NKFv+Pto72qVd7vFC4TuEdcukg5p1imG/RwuSC4tuVqLi0sQNMRTZXOmfW3XjxH5wue8x6ooJ6c3fO8zIks8wh0R6EGW2qJgVESGrweqdGbOU1tX9Bnmy15KjCcFpAzpX283RiG/6NgxmIo/mCiBPOR1N5boZ2MFBruuCrNllKmUNLAQ3jvxqPamPoKUqV7Arxra+Tm9Rqbcv1PW1v1gvWSLWAL1t2EcmBRe8Eu1UVv2BAutpPD/EzTRXxv0vMzH0h6XRO8mlnS8kGdSnbTOxo1O3cJfGNegAiULIfjluPMPQEtp/ktvHY76OaE7ow+51Y+6fhIu609n0wecm0bHpjSvlq12QPbF9ebRzMglz4R4G8WqdLn8M5+HsTKE0Q9AiNlmZg1ZNrxD47VyS5n1udUVNJTNfsz3Q+niLMd1vfH1hW0OzehQZpb5/RjhvXFDrdFDNiAvDdAbMZNM/axnaU+1iUX04okIE2Jtu8n6COSXzfBHm08LvtS210x+GqmP5QJPdR3ONph52bGLmL4AbC4StmAZPukeMjaY6jo/PcwH7tiXjEDZGsuSZUmXvTsgKTu3o7PiHWWxwUul35ZOi4l/1wCgXsLWjLRSJud96VVNB031hMLv+4NrL5IrVkZC/nJAiS+I0BCkLx7dowoM4YvJCS/AT74vIFVG2ZNQHvIAO5t4ROsHBlyt9qQRlrzMNDUkX0EN4/E/a7ou9+LXNxBqxrcySSIWV7KhAWs4AHaF/hnuu+eWCnIG1gRZq3mUYmPOczgQyJoHtfJIHAOKjTE6GcaWl3CUF2G6jJUl/9MdfnqHB4q0m5F2rL375WkPvb/WzXqcEbqd9fbcmPfcfWrs+CISuZj+9RKNrzzDFVpqEr/nao0vPMM7zxPeufBeaeHzs8Kre54AglJmGWEGyKVozB3Hw4OnKIVWkUC8kcry5Rc+pkkAcu4IB5v+EDlJ0bO62R+9fqM/Hj6/f9uv8msLUw4Hi+Xy0Cn8Qkk3CodKL0Y6zTGP5z3bUBuMtBItRWJgLAk4aiTiTbsTQExT3ncuLo2m6B/gw/y8aLgRvcRtUntpeZ7oZ+S91czwhOQlqerplR0VNP2txdXs8JIMPmJbgP6GIynxJR5zvSqybNdBXhAb5ktH388efG8F7w/39xcEi+CxCoBl0Jcqq4V4SZyLvErCA1PJ5MRrb+J0PCHyaRCmRjxI3YiCdwXgtXlfGc7XJJcaajx4zbGpbFMxl8rMkrzBd/V280/NYjP/Y4aQj3rJ1RdoYhg8SfjmURYaTPUGjffvMAZwYQZSDaQbCDZYZK92Mf7a6UjniQgHTw3fKtLFxNCLWEoXgOvBl49wKvTfby/VZakqpTJQJ2BOgN1DlDn+74XqancvjuC1koTFcelxp65ZcaFEx+DMY3u5hTDYXHg2sC1gWv7XKtGNAebKWxWLZRrfyqYzWhIx/W52tifk1HsRtN3oI07Ciu1oCFde75U4Xi8zpSxVbgulLbV+A6Dccc0Z5HwEMRhz6sGL0LFTGRe537ccKDd/XTmz93JS3J1cX1DfmIWlmzl/Fhsmk0b0S8nLye9UnHqAYnTyxnxO/Soa2WCRixSuv8Uyk0+RnCF52oG4lJzu7rGZd49ETANelqi6zdoqPU56XjtJ9FR/eN1g5Ff/rxxYcYsdrVtEL64Z3nhObjtm9ueHW7B5k8iWx2xvn13vmmt3QzdbptNfX/oZNPBOdnprJyv/VbbHYx4r3LIT5UzpsblvscQPqCNd/EkeLbPgcuZo3Ks8ryULp/LBVlymxHWikAsSoMdnBTtjAHP6jZHrxu1v/oR8ofXSJ4FiB4P8SaNL7jNyiiIVT6uPwFt/o+EisY543JcqzDjs+lv79+eT09+nZ1dvL2+OHkWTAJ778/4kWY5ky073Flic469u9P1tnY9pWG8hpKFezsuBOMS4+u2tq6ZPqdbzTXXb0c1X+d0vY6YgfdaVBXe/oym0nB+u6U3XlUjmgFLfNzpJzwjpmfe7JMbtACni9Kd5e42ClajZsU0jqGwD869beWry3fXN0iGuhc+Vwmu0WyJffJsSUP6gX6gFHvyUYLjmbu/poLJRemATL1c/Pd/PgWu1w== +api: eJztWlFv2zYQ/isEnzbMkd022zq9uUm6ed3aLEm3By9AKelkcaVIlaTiGIb++3CkZEu2nLhZh+1BBYJaInl3vPu+O4m6NbVsYWg4pzcgmbT0dkRVAZpZruQsoSE1wHSc+VFDRzQBE2te4DgN6RVYzeEODGEk5cKChoQwmRCjtIWECG4sUSmxfn1AR1TDpxKMfaWSFQ3X7pJrSGiYMmFgRGMlLUiLY6woBI+dLeO/DCpcUxNnkDP81bXEW0i8uaRWQkfUrgqgIVXRXxDjNRPiXUrD+XpvpNC4c8vBOD1K230t10pbknIQCYk1t6A5C7ZKmNZsRUeUW8idkGOVOYk9e8qgVmaV8yiJVi11xmouF7QaUaUT0P3r3RDhkiwzHmcbQTYDokEwDJJTgXJBljliYXp9Rkf0/OL6DPGQQMpKYWlY37fcCqh98Q6lX+Cyqhq1Yjmvt3Tbmu4i81sJeoUrr+oIVbe4smAL2Lf/ki24dOHvePtor2qV9zuFywTuEZcuUs4plukGPVwuCK5tuZpLCwvQdERTpXNm/a0Xz9H5gue8ByqoJ2f3PC9zIss8At1RqMGWWmJglIQGr0dq9GZOU9sX9NlmS54KDKcF5ExpH283huH/IJixGIrfmSjBfCC191ZoJyOFhjuuSrOllCmUNPAQ3rvxqDamvoJU6Z4A79oauXm9xqZc/9vWVr1gvWQL2IJ1N6EcWNResEt10Rs2hIvt5DA/03QR35v0/MwHkl7XBK9mlrR8UKeS3fSORs3OXQLfmBcgAiXL4bjlOHNPQMtpfguv3Q66OaE7o8+5lU86PtJua88nk4dc24YHprQvVm32wPbZ9ebRDMilTwT4m0Wq9Dm8s58HsfIEUY/ASFkmZg2ZdvyDY3Wyy5n1ORWV9FTN/kz33SnibIf1/bF1Be3OTWiQ5tY5/ZhhfbHDbREDNiDvDRCbcdOMfWhnqQ91ycW0IglIU6Lt+wn6iOTXTbBHG4/LPtd2Vwy+mOkPZUIP9R2Odti5mbGLGH4ALK5SNiDZPikesvYYKjr/PczHrphXzADZmktSpYkXPTsgqbu34zNineVxgculn5eOS8k/lUDg3oKWTDTSZud9aRVNx431xMKvewOrz1JrVsZCfrIAie8IkBAk754dI8qM4QsJya+ADz5vYNWGWRPQHjKAe1v4CCtHhtytNqSR1jwMNHVkH8HNI3G/K/ru9yIXd9CqBncyCWKWlzJhASt4gPYF/pnumydWCvIGVoRZq3lU4mMOM/iQCJrHdTIInIMKDTH6mYZWlzBUl6G6DNXlf1NdvjiHh4q0W5G27P1nJamP/f9VjTqckfrd9bbc2Hdc/eosOKKS+dg+tZIN7zxDVRqq0v+nKg3vPMM7z5PeeXDe6aHzs0KrO55AQhJmGeGGSOUozN2HgwOnaIVWkYD80coyJZd+JknAMi6Ixxs+UPmJkfM6mV+9PiM/nH77/e1XmbWFCcfj5XIZ6DQ+gYRbpQOlF2OdxviH874OyE0GGqm2IhEQliQcdTLRhr0pIOYpjxtX12YT9G/wp3y8KLjRfURtUnup+V7op+T91YzwBKTl6aopFR3VtP3txdWsMBJMfqTbgD4G4ykxZZ4zvWrybFcBHtBbZsvHH09ePO8F7083N5fEiyCxSsClEJeqa0W4iZxL/ApCw9PJZETrbyI0/G4yqVAmRvyInUgC94VgdTnf2Q6XJFcaavy4jXFpLJPxl4qM0nzBd/V2808N4nO/o4ZQz/oJVVcoIlj80XgmEVbaDLXGzTcvcEYwYQaSDSQbSHaYZC/28f5a6YgnCUgHzw3f6tLFhFBLGIrXwKuBVw/w6nQf72+VJakqZTJQZ6DOQJ0D1Pm270VqKrfvjqC10kTFcamxZ26ZceHEx2BMo7s5xXBYHLg2cG3g2j7XqhHNwWYKm1UL5dqfCmYzGtJxfa429udkFLvR9B1o447CSi1oSNeeL1U4Hq8zZWwVrgulbTW+w2DcMc1ZJDwEcdjzqsGLUDETmde5HzccaHc/nflzd/KSXF1c35AfmYUlWzk/Fptm00b0y8nLSa9UnHpA4vRyRvwOPepamaARi5TuP4Vyk48RXOG5moG41NyurnGZd08ETIOeluj6DRpqfU46XvtJdFT/eN1g5Oc/blyYMYtdbRuEL+5ZXngObvvmtmeHW7D5k8hWR6xv351vWms3Q7fbZlPfHzrZdHBOdjor52u/1XYHI96rHPJT5YypcbnvMYQPaONdPAme7XPgcuaoHKs8L6XL53JBltxmhLUiEIvSYAcnRTtjwLO6zdHrRu0vfoT87jWSZwGix0O8SeMLbrMyCmKVj+tPQJv/I6Gicc64HNcqzPhs+uv7t+fTk19mZxdvry9OngWTwN77M36kWc5kyw53lticY+/udL2tXU9pGK+hZOHejgvBuMT4uq2ta6bP6VZzzfXbUc3XOV2vI2bgvRZVhbc/oak0nN9u6Y1X1YhmwBIfd/oRz4jpmTf75AYtwOmidGe5u42C1ahZMY1jKOyDc29b+ery3fUNkqHuhc9Vgms0W2KfPFvSkFLsx8fVjmPu3poKJhelAzH1MvHf35WArds= 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Query tenants

+ - + Retrieves a filtered and sorted list of tenants. -## Request - -

Body

    sort object[]
    - -Sort field criteria. - -
  • Array [
  • ]
  • page object
    - -Pagination criteria. - -
    filter object
    - -Tenant filter request - -
- -The tenants search result - -
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching tenants. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching tenants. - -
  • Array [
  • ]
Schema
    page object
    - -Pagination information about the search results. - -
    items object[]
    - -The matching tenants. - -
  • Array [
  • ]
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found - -
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/sidebar.js b/docs/apis-tools/camunda-api-rest/specifications/sidebar.js deleted file mode 100644 index 3540f685a93..00000000000 --- a/docs/apis-tools/camunda-api-rest/specifications/sidebar.js +++ /dev/null @@ -1,684 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/camunda-8-rest-api", - }, - { - type: "category", - label: "Authentication", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-authentication", - label: "Get current user", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Authorization", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-authorization", - label: "Update authorization", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-authorizations", - label: "Query authorizations", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-user-authorizations", - label: "Query user authorizations", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Clock", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/pin-clock", - label: "Pin internal clock (alpha)", - className: "api-method put", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/reset-clock", - label: "Reset internal clock (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Cluster", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-topology", - label: "Get cluster topology", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Decision definition", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-decision-definitions", - label: "Query decision definitions", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-decision-definition", - label: "Get decision definition", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-decision-definition-xml", - label: "Get decision definition XML", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/evaluate-decision", - label: "Evaluate decision", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Decision instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-decision-instances", - label: "Query decision instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-decision-instance", - label: "Get decision instance", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Decision requirements", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-decision-requirements", - label: "Query decision requirements", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-decision-requirements", - label: "Get decision requirements", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml", - label: "Get decision requirements XML", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Document", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-document", - label: "Upload document (alpha)", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-document", - label: "Download document (alpha)", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-document", - label: "Delete document (alpha)", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-document-link", - label: "Create document link (alpha)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Element instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-element-instance-variables", - label: "Update element instance variables", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Flow node instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-flow-node-instances", - label: "Query flow node instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-flow-node-instance", - label: "Get flow node instance", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Group", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-group", - label: "Create group", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-group", - label: "Get group", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-group", - label: "Update group", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-group", - label: "Delete group", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/add-user-to-group", - label: "Assign a user to a group", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/unassign-user-from-group", - label: "Unassign a user from a group", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/search-groups", - label: "Query groups", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Incident", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/resolve-incident", - label: "Resolve incident", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-incidents", - label: "Query incidents", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-incident", - label: "Get incident", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Job", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/activate-jobs", - label: "Activate jobs", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/fail-job", - label: "Fail job", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/report-job-error", - label: "Report error for job", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/complete-job", - label: "Complete job", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-job", - label: "Update job", - className: "api-method patch", - }, - ], - }, - { - type: "category", - label: "License", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-license", - label: "Get license status", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Mapping rule", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-mapping-rule", - label: "Create mapping rule", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-mapping-rule", - label: "Delete a mapping rule", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-mappings", - label: "Query mappings", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Message", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/publish-message", - label: "Publish message", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/correlate-message", - label: "Correlate message", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Process definition", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-process-definitions", - label: "Query process definitions", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-process-definition", - label: "Get process definition", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-process-definition-xml", - label: "Get process definition XML", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-start-process-form", - label: "Get process start form", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Process instance", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-process-instance", - label: "Create process instance", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-process-instance", - label: "Get process instance", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-process-instances", - label: "Query process instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/cancel-process-instance", - label: "Cancel process instance", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/migrate-process-instance", - label: "Migrate process instance", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/modify-process-instance", - label: "Modify process instance", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Resource", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-deployment", - label: "Deploy resources", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-resource", - label: "Delete resource", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Role", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-role", - label: "Create role", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-role", - label: "Get role", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-role", - label: "Update role", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-role", - label: "Delete role", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/search-roles", - label: "Query roles", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Signal", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/broadcast-signal", - label: "Broadcast signal", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Tenant", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-tenant", - label: "Create tenant", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-tenant", - label: "Update tenant", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-tenant", - label: "Get tenant", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-tenant", - label: "Delete tenant", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/assign-user-to-tenant", - label: "Assign a user to a tenant", - className: "api-method put", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/remove-user-from-tenant", - label: "Remove a user from a tenant", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/assign-mapping-rule-to-tenant", - label: "Assign a mapping rule to a tenant", - className: "api-method put", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/remove-mapping-rule-from-tenant", - label: "Remove a mapping rule from a tenant", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/assign-group-to-tenant", - label: "Assign a group to a tenant", - className: "api-method put", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/remove-group-from-tenant", - label: "Remove a group from a tenant", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/search-tenants", - label: "Query tenants", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "User", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/create-user", - label: "Create user", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-users", - label: "Query users", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/delete-user", - label: "Delete user", - className: "api-method delete", - }, - ], - }, - { - type: "category", - label: "Usage metrics", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-usage-metrics", - label: "Get usage metrics", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "User task", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/complete-user-task", - label: "Complete user task", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/assign-user-task", - label: "Assign user task", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-user-task", - label: "Get user task", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/update-user-task", - label: "Update user task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-user-task-form", - label: "Get user task form", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/unassign-user-task", - label: "Unassign user task", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-user-tasks", - label: "Query user tasks", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-user-task-variables", - label: "Query user task variables", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "Variable", - items: [ - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/find-variables", - label: "Query variables", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/camunda-api-rest/specifications/get-variable", - label: "Get variable", - className: "api-method get", - }, - ], - }, -]; diff --git a/docs/apis-tools/camunda-api-rest/specifications/sidebar.ts b/docs/apis-tools/camunda-api-rest/specifications/sidebar.ts new file mode 100644 index 00000000000..43940084690 --- /dev/null +++ b/docs/apis-tools/camunda-api-rest/specifications/sidebar.ts @@ -0,0 +1,690 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/camunda-8-rest-api", + }, + { + type: "category", + label: "Authentication", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-authentication", + label: "Get current user", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Authorization", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/update-authorization", + label: "Update authorization", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-authorizations", + label: "Query authorizations", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-user-authorizations", + label: "Query user authorizations", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Clock", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/pin-clock", + label: "Pin internal clock (alpha)", + className: "api-method put", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/reset-clock", + label: "Reset internal clock (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Cluster", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-topology", + label: "Get cluster topology", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Decision definition", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-decision-definitions", + label: "Query decision definitions", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-decision-definition", + label: "Get decision definition", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-decision-definition-xml", + label: "Get decision definition XML", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/evaluate-decision", + label: "Evaluate decision", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Decision instance", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-decision-instances", + label: "Query decision instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-decision-instance", + label: "Get decision instance", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Decision requirements", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-decision-requirements", + label: "Query decision requirements", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-decision-requirements", + label: "Get decision requirements", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml", + label: "Get decision requirements XML", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Document", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-document", + label: "Upload document (alpha)", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-document", + label: "Download document (alpha)", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-document", + label: "Delete document (alpha)", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-document-link", + label: "Create document link (alpha)", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Element instance", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-element-instance-variables", + label: "Update element instance variables", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Flow node instance", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-flow-node-instances", + label: "Query flow node instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-flow-node-instance", + label: "Get flow node instance", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Group", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-group", + label: "Create group", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-group", + label: "Get group", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/update-group", + label: "Update group", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-group", + label: "Delete group", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/add-user-to-group", + label: "Assign a user to a group", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/unassign-user-from-group", + label: "Unassign a user from a group", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/search-groups", + label: "Query groups", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Incident", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/resolve-incident", + label: "Resolve incident", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-incidents", + label: "Query incidents", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-incident", + label: "Get incident", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Job", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/activate-jobs", + label: "Activate jobs", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/fail-job", + label: "Fail job", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/report-job-error", + label: "Report error for job", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/complete-job", + label: "Complete job", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/update-job", + label: "Update job", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "License", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-license", + label: "Get license status", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Mapping rule", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-mapping-rule", + label: "Create mapping rule", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-mapping-rule", + label: "Delete a mapping rule", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-mappings", + label: "Query mappings", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Message", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/publish-message", + label: "Publish message", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/correlate-message", + label: "Correlate message", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Process definition", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-process-definitions", + label: "Query process definitions", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-process-definition", + label: "Get process definition", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-process-definition-xml", + label: "Get process definition XML", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-start-process-form", + label: "Get process start form", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Process instance", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-process-instance", + label: "Create process instance", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-process-instance", + label: "Get process instance", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-process-instances", + label: "Query process instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/cancel-process-instance", + label: "Cancel process instance", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/migrate-process-instance", + label: "Migrate process instance", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/modify-process-instance", + label: "Modify process instance", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Resource", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-deployment", + label: "Deploy resources", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-resource", + label: "Delete resource", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Role", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-role", + label: "Create role", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-role", + label: "Get role", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/update-role", + label: "Update role", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-role", + label: "Delete role", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/search-roles", + label: "Query roles", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Signal", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/broadcast-signal", + label: "Broadcast signal", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Tenant", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-tenant", + label: "Create tenant", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/update-tenant", + label: "Update tenant", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-tenant", + label: "Get tenant", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-tenant", + label: "Delete tenant", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/assign-user-to-tenant", + label: "Assign a user to a tenant", + className: "api-method put", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/remove-user-from-tenant", + label: "Remove a user from a tenant", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/assign-mapping-rule-to-tenant", + label: "Assign a mapping rule to a tenant", + className: "api-method put", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/remove-mapping-rule-from-tenant", + label: "Remove a mapping rule from a tenant", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/assign-group-to-tenant", + label: "Assign a group to a tenant", + className: "api-method put", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/remove-group-from-tenant", + label: "Remove a group from a tenant", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/search-tenants", + label: "Query tenants", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "User", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/create-user", + label: "Create user", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-users", + label: "Query users", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/delete-user", + label: "Delete user", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Usage metrics", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-usage-metrics", + label: "Get usage metrics", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "User task", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/complete-user-task", + label: "Complete user task", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/assign-user-task", + label: "Assign user task", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-user-task", + label: "Get user task", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/update-user-task", + label: "Update user task", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-user-task-form", + label: "Get user task form", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/unassign-user-task", + label: "Unassign user task", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-user-tasks", + label: "Query user tasks", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-user-task-variables", + label: "Query user task variables", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Variable", + items: [ + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/find-variables", + label: "Query variables", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/camunda-api-rest/specifications/get-variable", + label: "Get variable", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/apis-tools/camunda-api-rest/specifications/unassign-user-from-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/unassign-user-from-group.api.mdx index 3c5afc6296f..7b76a6553aa 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/unassign-user-from-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/unassign-user-from-group.api.mdx @@ -12,49 +12,228 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Unassign a user from a group

+ Unassigns a user from a group. -## Request - -

Path Parameters

- -The user was unassigned successfully from the group. - -
- -The user could not be unassigned. -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}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The group or user with the given key was not found, or the user is not assigned to this group. - -
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/unassign-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx index 42c6740b0bf..c2c0c31cea0 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx @@ -12,48 +12,219 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Unassign user task

+ Removes the assignee of a task with the given key. -## Request - -

Path Parameters

- -The user task was unassigned successfully. - -
- -The user task with the given key cannot be unassigned. 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 user task with the given key was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user task with the given key is in the wrong state currently. 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/update-authorization.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-authorization.api.mdx index d62e3a8b37b..73c9ee18064 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-authorization.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-authorization.api.mdx @@ -5,69 +5,364 @@ description: "Manage the permissions assigned to the authorization." sidebar_label: "Update authorization" hide_title: true hide_table_of_contents: true -api: eJztWV+T2jYQ/yoaPbVTB0h6bRPeKPgSt3dAjUmnvdzcCFtgNbLkSPJxlPF376xkgw2+JO30kZu5wZJW+/+3srV7bMhG4+EdHhUmlYr9TQyTAt97WOZU2UGQ4CEu8oQY2ibycEJ1rFhuR0N8SwTZUGRSinKqMqY1k0IjojXbCJogI+0aaTLpYQ/nRJGMGqpAkT0WJKN4iOVWUPUr3WEPM+CeE5NiDyv6qWCKJnhoVEFPVYhSij7SHZJrK8ryqAdncnWc0ozg4R6bXQ4imTB0QxX28FqqjBg39eMVLst7J5lq87NMdrAnlsJQYeCR5DlnseXb/0uDIvtz5nL1F40NmKvAtYZRbffGTvX9iSWBSIAl1YitW+7UqSx4glYUkSShCZIKKZrJR5qATZUwbRQTG+xhKorMhncywR4O/dvZex/fl2CNloWKaWQ3nEoHPwIr8F1NCfEjSdJ30lo6GdlfK5k1FDhYSzifrW1c/y8JB5OW0btZGPw5ioLZFHv4djSfB9O3D+Hyxoehv1iM3sLTz6No/A57eDSf3wTjmnzxxyLyb7GHI386mkbYwxN/fjP749a3g3k4G/uLxcPEvw6mQbVn4o+DRTCbPoT+b8sg9IH2OZLW7NtwtpxjDy8XfghxmN34gDHDDAdvhY1g+GBeCSFq2N/II6IU2Z1hL0pP/dXwJHiNGZrpL6fjkUd3YixyGrM1o9pCqg5gQ/K/yYGvYnYI9xjigT08Dv1R5B8eHupIBdNFNJqOGyuHWDSWQn80qX66dtp5iNJDNFr8Wk90MVrOJ04N99DFrFppspv4N77d5R7qXceJSTg5Dq5n4e0Z7VFCI4Pmrbgdc6iGVpB8OYdGiDNtWoAMJvqkniNFuS1LRkJ0CsE+FTRwyeUq8mmmVbWoLMsudSfRrL3UOmPmxMRp6AqvI2vXf2dhLoV26ftq8Kq7mLWKP9oSjXJgTROkizimWq8Lzne9DwKXHr4aDL6GS2wLsZAGinHFrvdB3EpFUUINYVwjoijKlXxkUKqZsM6sNUYrmViR3nOHSa7kitPsu/ND5TRyc0dZyUUOeoho5AhXTvpdeD1Gb65++On+m9SYXA/7/e1221Pr+AVNmJGqJ9Wmr9Yx/APdtz0UpVRRlJFddeQwkEk4OtYNpB2O4/qEr9S2iHb2fb7omKrUnB5eh1O4UKwjW5dhgFhChWHrHRObc9F2z5oUHHiQlSzMcMWJ+IiP6XYu9FSKLrKMqMMrRVtA6WFtiCn0F98ivn/VWbPfRdEcORYolglFa6mQSZmuBYERGRMsgyp4NRh4OCNPbvTjYFACT4j4V1giEH3KOREueU/MYQJlx7y1hjGhDRHx/xUZqdiGncrt4VZVcJMTZ1Fp8X41eNmNxep1DHESf9TokXCWWHyC1LgCqKJWCcLtSXIB2QVkF5B1g+z783y/lmrFkoQKm54HvDFtjzzCudy6b44Lri64uuCqG1dX3YeXu5iA11DA0loWIrm8CF6wdMHS57D05vMvgu7K43gfdnYfIjq+Ahl8xok1Z7H5T59upYd/6PpaHAkE4VcAEKqUVEjGcaEUTdA2Zdxyhs/O2imVEZcicCkClyLwXBEoPZxRk8rEtQPi1DYPTIqHuN+Ctu7v6/ZBCRf9VD3W3YVCcTzEe4edctjv71OpTTnc51KZsv8IgXkkipEVd+kIyw5jde5wGRNup7tiCAvQwqhtG5OsEAlBr1HoLyL0lhi6JTvrUxDZZv168HrQfbcrlXmG42geIGehy8BGVajZArw72Trir2FsWyCaxoViZreAbc49K0oUVXBp18iMSp7lDmNHhL3q4brOl19+j2zIoaKFx/aK/0Sy3OGxbo9UDYzWlfjdvn29eVdn5L29+mRiLa1OVT6dWwehpko7AYPey/PcnQcWgrHMskLYOiw2aMtMikjDWzEvtAEveZizmAptVa/6WDXZjVtB751E9LIHkXbpWJffDTNpserFMuvHbtvhd8Xlqp8RJvqVCN0fj26X08noxU0w9qcL/8XL3qBnnoz1aC61yYho6LG0Hbz2EXhqcKOr9Z+7eVUKGPpk+jknzJ6R1sx9BdY73AYr9vDw0O279yrE3eH9fkU0XSpeljD9qaBqh4d390eAup4C0/Cc4OGacH3aEmya9E1YXR5/i/5Vo7DTpPoqXexsxeAFjLCHP9Jds3tpUzGlJKHKauuWx06nF7bJctx+1kgsvXrHKI5pbp6hbb0ZAFAPZXJe9b5WVdcykwlsVmQLvVSyxUP8AX8AvWVu6k6Tnd9jTsSmIBugd4zh7x8KYlaz +api: eJztWV+T2jYQ/yoaPbVTB0h6TVPeXPAlbu+AGpNOer25EfaC1ciSI8nHUcbfvSPJBgO+JO30kZu5wZJW+/+3srU7rMla4eEd9kudCUn/JpoKju89LAqQdhCmeIjLIiUajok8nIJKJC3saIhvCSdrQDoDVIDMqVJUcIWIUnTNIUVa2DXSZtLDHi6IJDlokEaRHeYkBzzEYsNB/gpb7GFquBdEZ9jDEj6VVEKKh1qWcKpCnAH6CFskVlaU5dEMzuSqJIOc4OEO621hRFKuYQ0Se3glZE60m3p9havq3kkGpX8W6dbsSQTXwLV5JEXBaGL59v9SRpHdOXOx/AsSbcyVxrWagrJ7E6f67sSSkKeGJShEV0fuVJkoWYqWgEiaQoqERBJy8QipsakWprSkfI09DLzMbXjHY+zhKLidvg/wfWWsUaKUCcR2w6l040fDyviuoTTxI2nad9KOdNKiv5Iibymwt5YwNl3ZuP5fEvYmLeJ30yj8w4/D6QR7+NafzcLJ24docROYYTCf+2/N089+PHqHPezPZjfhqCGff5jHwS32cBxM/EmMPTwOZjfTD7eBHcyi6SiYzx/GwXU4Ces942AUzsPp5CEKfluEUWBonyM5mn0bTRcz7OHFPIhMHKY3gcGYppoZb0WtYATGvMqEqGV/K4+IlGR7hr04O/VXy5PGa1RDrr6cjgce3YkxLyChKwrKQqoJYEvyv8mBr2K2D/fIxAN7eBQFfhzsHx6aSIWTeexPRq2VfSxaS1Hgj+ufrp123kTpIfbnvzYTXYwWs7FTwz10MatX2uzGwU1gd7mHZtdhYhyND4PraXR7RnuQ0Mqg2VHcDjnUQCtMv5xDPmJU6SNAhmN1Us+RBGbLkhYmOiWnn0oIXXK5inyaaXUtqqqqS91xPD1eOjpjZkQnWeQKryM7rv/OwkJw5dL31eBVdzE7Kv5oQxQqDGtIkSqTBJRalYxte39yXHn4ajD4Gi6JLcRcaFOMa3a9P/mtkIBS0IQyhYgEVEjxSE2pptw6s9EYLUVqRXrPHSaFFEsG+Xfnh8pp5GaOspaLHPQQUcgRLp30u+h6hH66+uHH+28yrQs17Pc3m01PrpIXkFItZE/IdV+uEvNv6L7toTgDCSgn2/rIoUYmYehQN5ByOE6aE75W2yLa2ff5oqPrUnN6eO1P4VLSjmxdRCGiKXBNV1vK1+ei7Z4VKZnhQZai1MMlI/wjPqTbudBTKarMcyL3rxTHAioPK010qb74FvH9q86a/S6OZ8ixQIlIAa2ERDqjqhFkjMgpp7mpgleDgYdz8uRGrweDyvA0Ef8KSziCp4IR7pL3xBzKUX7IW2sY5UoTnvxfkRGSrump3B4+qgpucuwsqizerwYvu7FYv44hRpKPCj0SRlOLTyM1qQEqwSpBmD1JLiC7gOwCsm6QfX+e79dCLmmaArfpuccbVfbII4yJjfvmuODqgqsLrrpxddV9eLmLCfMaarC0EiVPLy+CFyxdsPQ5LP30+RdBd+VxuA87uw/hHV+B1HzG8RWjif5Pn26Vh3/o+lr0OTLhlwYgIKWQSCRJKSWkaJNRZjmbz87GKbURlyJwKQKXIvBcEag8nIPOROraAUlmmwc6w0PcP4K26u+a9kFlLvpBPjbdhVIyPMQ7h51q2O/vMqF0NdwVQuqq/2gC80gkJUvm0tEsO4w1ucNEQpid7oqhWTAtjMa2EclLnhL0BkXBPEZviYYN2VqfGpHHrN8M3gy673aF1M9w9Gchcha6DGxVhYatgXcnW0f8NYxtC0RBUkqqt3OzzblnCUSCNJd2rcyo5VnuZuyIsFc/XDf58svvsQ25qWjRob0SPJG8cHhs2iN1A+Oka3F6SX7XcYF9egl61+Ttvb0gpXwlrOZ11p37wCQESOXUGPRenmf4LLRATUSel9xWa75GG6ozRFo+TViptPGlhxlNgCtrYN3tashu3Ap67ySilz2TDy5pmyK9pjorl71E5P3Ebdv/LplY9nNCeb8Wofoj/3YxGfsvbsJRMJkHL172Bj39pK3fC6F0TnhLj4Xt8x0flKcGt3pf/7nnVyeKhifdLxih9iS1Zu5qSN/hY0hjDw/3PcF7r8blHd7tlkTBQrKqMtOfSpBbPLy7P8DYdR6oMs8pHq4IU6eNw7ZJ30T1FfO36F+1EztNai7c+dbWFVaaEfbwR9i2e5w2FTMgKUirrVseOZ1e2Ew+bD9rN1Zes8NPEij0M7RH7w8GzvtiOqs7ZMu6t5mL1GyWZGMwRzZOZ1Hophdl53aYEb4uydrQOqbm7x/j32Pw sidebar_class_name: "patch 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update authorization

+ Manage the permissions assigned to the authorization. -## Request + -

Path Parameters

Body

required
    permissions object[]
    + -The permissions to add/remove. + -
  • Array [
  • ]
- -The authorization was patched successfully. - -
- -The authorization could not be patched. -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 request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The owner was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request to add or remove permissions to an authorization was in conflict. -More details are provided in the response body. - -
- -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/update-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-group.api.mdx index d33a746bea8..dd97ca77e05 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-group.api.mdx @@ -5,56 +5,256 @@ description: "Update a group with the given key." sidebar_label: "Update group" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isYnJopLcqpk6a8qYqTuE1TjyO3B0eHFbgiEYMAA4CWNRz+984C1FtOfOhRntFY4mLf3weA23IPhePZHX9vTVPzacJNjRa8NPoq5xlv6hw8RmHCc3TCypqkPOO3QcaAFSRmC+lL5ktkhXxAze5xOeAJr8FChR4teWm5hgp5xoPGn7jkCZdkqgZf8oRb/NZIiznPvG1w39+kRLLKzDy6CV69YTFGcuZEiRXwrOV+WZMfqT0WaHnC58ZW4OOj1xe866bRHTr/u8mXpLPvXRjtUXsSQV0rKUJZ0q+OomkPnZnZVxSecrZURC/RkVSUoAt0GAwdZuTQU0ZxVd5nBd5bOWs8OkoLlPp7Hsq3qz56jvL3g4v9WKfgvJW6OOg0xRmrnLNculrBkpHmTisGvOsS7qVXZClAZrxOvZuScFPhu62yTPe0Iq5uYnN410VNVxvtYtAvhxfHa9kDEdw6WtcIgc7NG6WWA94l/GI4PK5bW/Mgc0oQPDDpmDaePYCS+eCL5k+iobZmprD6+RAV+726jitZjh6kYrEhDByLC2eYM6nZ3c27Mfvt4tWv059K72uXpelisRjYuTjDXHpjB8YWqZ0L+tC6FwM2KdEiq2DJZsggzyX5BMU2rWauRiHnUhBffMw2BEN9j/l9HydReoiTNa0aKw9gM2K3N1dM5qi9nC+lLg5dB505NIpswMw0Ppsp0Pd8A6UfgXPEXFNVYNcbw66DLuHOg2/cD7eFX14eBf6HyeSaRRNMmBzZ3FjmS+lWjiiJSmpZNRXPLobDhFfwGH+9Hg47skkdf0YmmuFjrUAHaO2nIzWrjMUePyExqZ0HLf6vzhgrC7nvd5fWPYjfxowiNy+G58cp1e+vTIG4d5FLDBpfktdIHyYshiBAhc3qRLITyU4kO06y759568tXf7NanWBz0+j8RK0TtU7Ueopar45dCUeaUZUt4RCtNZYZIRprMWeLUqpgnm6WK9/9WXe6K564duLaU1zrEl6hL00eX/lFGQYEvuQZT8PB5dJ2dYB19D6P9mE1OWis4hlvI2e6LE3b0jjfZW1trO/SB2rIA1gJMxVhSOLIrRVmlBGgwuNjvSPB9kvtGKpG58DesJvLzxP2HjwuIL5Ekstd02+Gb4ZHrdLSJyyOrq9YzDAib2s3WJklWh81Gxc/x3CYdDgUjZV++ZnUYnlmCBbtqKHqrxHR+wvW6XdcxJP+y7sVTv74dxJaTTvZzWaKcvkIVR15uDP16Kc+Pd66gMa5CX57rBxmQO1E62LKw8H5IS6vrwK9hKmqRoc9VhfxIgRbFRGqcZ4qkXAlBWqHWxGtln2MEvZP9MjOB9TNCLnV1lpIXzazgTBVKqLa+v9MmVlagdRp78Kl49Fft5/ejs4+Xo0vP32+PDsfDAf+0Yfka+N8BXorjn6UVhybs7Wb4+R5I7e+lx4ffVorkJrQFXJpe7bdxQGc4wnP1qO4adJT5o637Qwc3lrVdfT4W4N2ybO76YZhcRolHX3PeTYH5fbnddtx/3TTT35esB9P8Y7G3z8EvQw8Vw394gm/x+X2PLGbdgkvEXK0IcQoHsdAziZkZKN+MNXrkpXGSAis/RNrd85xotd6U7seTcYfiC79SLEyOSlbWNB0ExY841/4F4rbhCoFJobnLVegiwYKWh8N099/P6100Q== +api: eJztWEtz2zYQ/isYnJIpLcqpk6a8qYqTuE1TjyO3B1eHFbgiEYMAA4CWNRz+984C1FtOfOhRntFY4mLf3weA23IPhePZHf9gTVPzacJNjRa8NPoq5xlv6hw8RmHCc3TCypqkPOO3QcaAFSRmC+lL5ktkhXxAze5xOeAJr8FChR4teWm5hgp5xoPGH7jkCZdkqgZf8oRb/NZIiznPvG1w39+kRLLKzDy6CV69YTFGcuZEiRXwrOV+WZMfqT0WaHnC58ZW4OOjNxe866bRHTr/m8mXpLPvXRjtUXsSQV0rKUJZ0q+OomkPnZnZVxSecrZURC/RkVSUoAt0GAwdZuTQU0ZxVd5nBd5bOWs8OkoLlPprHsq3qz56jvL3g4v9WKfgvJW6OOg0xRmrnLNculrBkpHmTisGvOsS7qVXZClAZrxOvZuScFPhu62yTPe0Iq5uYnN410VNVxvtYtCvhhfHa9kDEdw6WtcIgc7NG6WWA94l/GI4PK5bW/Mgc0oQPDDpmDaePYCS+eBfzZ9EQ23NTGH10yEq9nt1HVeyHD1IxWJDGDgWF84wZ1Kzu5v3Y/brxetfpi9K72uXpelisRjYuTjDXHpjB8YWqZ0L+tC6lwM2KdEiq2DJZsggzyX5BMU2rWauRiHnUhBffMw2BEN9j/l9HydReoiTNa0aKw9gM2K3N1dM5qi9nC+lLg5dB505NIpswMw0Ppsp0Pd8A6UfgXPEXFNVYNcbw66DLuHOg2/cD7eFn18dBf7HyeSaRRNMmBzZ3FjmS+lWjiiJSmpZNRXPLobDhFfwGH+9GQ47skkdf0YmmuFjrUAHaO2nIzWrjMUePyExqZ0HLf6vzhgrC7nvd5fWPYjfxYwiNy+G58cp1e+vTIG4d5FLDBpfktdIHyYshiBAhc3qRLITyU4kO06y759568tXf7NanWBz0+j8RK0TtU7Ueopar49dCUeaUZUt4RCtNZYZIRprMWeLUqpgnm6WK9/9WXe6K564duLaU1zrEl6hL00eX/lFGQYEvuQZT8PB5dJ2dYB19D6P9mE1OWis4hlvI2e6LE3b0jjfZW1trO/SB2rIA1gJMxVhSOLIrRVmlBGgwuNjvSPB9kvtGKpG58DespvLLxP2ATwuIL5Ekstd02+Hb4dHrdLSJyyOrq9YzDAib2s3WJklWh81Gxc/x3CYdDgUjZV++YXUYnlmCBbtqKHqrxHR+wvW6XdcxJP+y/sVTn7/ZxJaTTvZzWaKcvkIVR15uDP16Kc+Pd66gMa5CX57rBxmQO1E62LKw8H5IS6vrwK9hKmqRoc9VhfxIgRbFRGqcZ4qkXAlBWqHWxGtln2KEvZ39MjOB9TNCLnV1lpIXzazgTBVKqLa+v9MmVlagdRp78Kl49Gft5/fjc4+XY0vP3+5PDsfDAf+0Yfka+N8BXorjn6UVhybs7Wb4+R5I7e+lx4ffVorkJrQFXJpe7bdxQGc4wnP1qO4adJT5o637Qwc3lrVdfT4W4N2ybO76YZhcRolHX3PeTYH5fbnddtxv7jpJz8v2Y+neEfj7x+CXgaeq4Z+8YTf43J7nthNu4SXCDnaEGIUj2MgZxMyslE/mOp1yUpjJATW/om1O+c40Wu9qV2PJuOPRJd+pFiZnJQtLGi6CYsYswkVCiwMz1quQBcNFLQ2GqW//wB/T3PV sidebar_class_name: "patch 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update group

+ - + Update a group with the given key. -## Request + -

Path Parameters

Body

required
    changeset object
    + -A set of changed group attributes. + -
- -The group was updated successfully. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The group with the groupKey is not found. - -
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/update-job.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-job.api.mdx index cf3600b8052..1538d6889d6 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-job.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-job.api.mdx @@ -5,66 +5,263 @@ description: "Update a job with the given key." sidebar_label: "Update job" hide_title: true hide_table_of_contents: true -api: eJztWNty2zYQ/ZUdPCUtTSmpkybsk+okjdMk9fjSPtieCUisJDggwOAiWaPhTH+jv9cv6SxASrJlN542j8qMJyKB3cXunrMkz5J5PnGsOGfvTMkuM2YatNxLow8FK1hoBPdISxkT6CorG1pjBTuLK8DhypQwl34KfoowkTPU8BkXOctYwy2v0aMl/0umeY2sYFem/BUXLGOS3DTcT1nGLH4J0qJghbcBb8c6nSL5BDOOQSiiN5DORoFcNcWas2LJ/KKhGFJ7nKBlGRsbW3Ofbj3fZ217mYKh8z8bsSCb27Eroz1qT0u8aZSsYjkGV47OstwOZsorrDzla6l4XqKj1WrK9QQdRkc383l38ttHSGapdGmviJlx760sg0eYcRXQ5Rf6QlMFxkYpM5d6st7ioOIaSgQuroLzKPpOSAeoRWOk9hlwISRF5mrD8kLPpVJkKyfaWBQFxfkOPln0VqL7BHtAUTXOgdcmaE/l7xZhbGzfip+gDs7HQ0BjnPRyhqBDXaLNo0MvazTB9w5FSPjqu0kBui0gNdQuA+e59ZTo2Jo6bqqCtag91KZG7WNJjqyZSRHLoTtoGIebtYm14KCDUqmWYCyYWvroW3poLDq0M3QxRoPWyVjElY+///zLJdNVF6hFFdfaxJQrUzcKycZYGHOp7mlBcJjy6PZHN51J/N1vdSC188hFfqFZ9hWIdd34KvB/eLpF3//dWpYxKiwvFSbitBnr2vgQIt51nm+BjO1jxXN5uqQRd7BiJS2sqX++wdfLGxZp0B2nmcHaNtm5xmiXSv90uL9N8R4qc+66QSXAhapC58ZBqUXO2oztD4d3WzYR2yhAcM9BOiC4zbiSHSzuGVGNNaXC+vvtUXUzxAiO0k4Q6AmB3SziDtLGEgVV/Pz4zQG83H/24+WjqfeNKwaD+Xye23G1h0J6Y3NjJwM7ruiP9j3OieIWoeaLNJZWk2eNXHANVnIsKxriPmUbD0OYeQjs0+oKY85bqSebEAtWbgFsBGfHhyAFai/HC4LQVuhoM+ZBkQ9emuCLUnH9ma0htB30dhQX6prb1bPqZoA2Y85zH/4zZd+enh5BcgGVEdixVbo+ECVRSy3rULNifzjMWM2v09Xz4bAln9TxB2SiAa8bxfUNSvbpEB2NxQ4/MTGaW1xX36ozxsqJvB03Z5t07kD8KmWUmLn/r2TsX1PSO0hPrLEJWuQ7Wu1otaPVvbR6+QBard7+iVlSx3tza/Qk1nb1rFaLHD6s03TA7cYjr7PrH7FQGrHYPfV29NzR8356PrvrRXKkgapsCYdoLX37VJGBAuZTqaJ7eh/tY3efxTuu7bi249p9XGszVqOfGpG0q2oadS4/ZQUbXJnSDZbp3bIlWYq0hU78Claxgi0TX9piMFhOjfNtsWyM9e1gRs2YcSvpwzX2jpYTr3q8KFNxFW/f1TdaIIWtz+eA10ELDi/g+PXJKfzCPc55+uykkDddvxi+GN7plbbe43F0dAgpw4S6jUnQuyVK3+k2bX6I4yjYOayClX5xQmapPCVyi3YUqPIrNHTxone6TptY1v1402Pk3R+nsc00xY7XYuDra07qzJZ4t5JZhhsSx7CNiBybGL/Dy3Ym1FbSlWLqw/zJNjaPDiPFKlPXQcc5qye9dLX2VynS96LsomSF2sVjdpJqv+19WoHfU0R4klNXE/T68TqRfhrKvDL1oEpmq/9LZcpBzaUedCHc4GD04ezjq9He+8OD1x9PXu89yYe5v07iSWOcr7neOEenCV9ty8XL9QPlIcpx10+P137QKC41ISzmsezYdk46smMZKzo9+TLrKHPOlsuSOzyzqm3p9peAdsGK88s1wyIlhXT0W7BizJW7LTpvnvjRcacTPYavSdF3nry7yfUislwFumIZ+4yLtSDeXrYZmyIXaOPx0uJBOsTeKblYG28J023WW4yqCht/z94bz2+i1mqYHY1OD94SVTpVvDaCjC2fkzzP56xgF+yCTm1ihZIASfeXTHE9CXwS1f3omP79A6Cibjs= +api: eJztWNty2zYQ/ZUdPCUtTSmpkybsk+okjdMk9fjSPtieCUisJDggwOAiWaPhTH+jv9cv6SxASrJlN542j8qMJyKB3cXunrMkz5J5PnGsOGfvTMkuM2YatNxLow8FK1hoBPdISxkT6CorG1pjBTuLK8DhypQwl34KfoowkTPU8BkXOctYwy2v0aMl/0umeY2sYFem/BUXLGOS3DTcT1nGLH4J0qJghbcBb8c6nSL5BDOOQSiiN5DORoFcNcWas2LJ/KKhGFJ7nKBlGRsbW3Ofbj3fZ217mYKh8z8bsSCb27Eroz1qT0u8aZSsYjkGV47OstwOZsorrDzla6l4XqKj1WrK9QQdRkc383l38ttHSGapdGmviJlx760sg0eYcRXQ5Rf6QlMFxkYpM5d6st7ioOIaSgQuroLzKPpOSAeoRWOk9hlwISRF5mrD8kLPpVJkKyfaWBQFxfkOPln0VqL7BHtAUTXOgdcmaE/l7xZhbGzfip+gDs7HQ0BjnPRyhqBDXaLNo0MvazTB9w5FSPjqu0kBui0gNdQuA+e59ZTo2Jo6bqqCtag91KZG7WNJjqyZSRHLoTtoGIebtYm14KCDUqmWYCyYWvroW3poLDq0M3QxRoPWyVjElY+///zLJdNVF6hFFdfaxJQrUzcKycZYGHOp7mlBcJjy6PZHN51J/N1vdSC188hFfqFZ9hWIdd34KvB/eLpF3//dWpYxKiwvFSbitBnr2vgQIt51nm+BjO1jxXN5uqQRd7BiJS2sqX++wdfLGxZp0B2nmcHaNtm5xmiXSv90uL9N8R4qc+66QSXAhapC58ZBqUXO2oztD4d3WzYR2yhAcM9BOiC4zbiSHSzuGVGNNaXC+vvtUXUzxAiO0k4Q6AmB3SziDtLGEgVV/Pz4zQG83H/24+WjqfeNKwaD+Xye23G1h0J6Y3NjJwM7ruiP9j3OieIWoeaLNJZWk2eNXHANVnIsKxriPmUbD0OYeQjs0+oKY85bqSebEAtWbgFsBGfHhyAFai/HC4LQVuhoM+ZBkQ9emuCLUnH9ma0htB30dhQX6prb1bPqZoA2Y85zH/4zZd+enh5BcgGVEdixVbo+ECVRSy3rULNifzjMWM2v09Xz4bAln9TxB2SiAa8bxfUNSvbpEB2NxQ4/MTGaW1xX36ozxsqJvB03Z5t07kD8KmWUmLn/r2TsX1PSO0hPrLEJWuQ7Wu1otaPVvbR6+QBard7+iVlSx3tza/Qk1nb1rFaLHD6s03TA7cYjr7PrH7FQGrHYPfV29NzR8356PrvrRXKkgapsCYdoLX37VJGBAuZTqaJ7eh/tY3efxTuu7bi249p9XGszVqOfGpG0q2oadS4/ZQUbXJnSDZbp3bIlWYq0hU78Claxgi0TX9piMFhOjfNtsWyM9e1gRs2YcSvpwzX2jpYTr3q8KFNxFW/f1TdaIIWtz+eA10ELDi/g+PXJKfzCPc55+uykkDddvxi+GN7plbbe43F0dAgpw4S6jUnQuyVK3+k2bX6I4yjYOayClX5xQmapPCVyi3YUqPIrNHTxone6TptY1v1402Pk3R+nsc00xY7XYuDra07qzJZ4t5JZhhsSx7CNiBybGL/Dy3Ym1FbSlWLqw/zJNjaPDiPFKlPXQcc5qye9dLX2VynS96LsomSF2sVjdpJqv+19WoHfU0R4klNXE/T68TqRfhrKvDL1oEpmq/9LZcpBzaUedCHc4GD04ezjq9He+8OD1x9PXu89yYe5v07iSWOcr7neOEenCV9ty8XL9QPlIcpx10+P137QKC41ISzmsezYdk46smMZKzo9+TLrKHPOlsuSOzyzqm3p9peAdsGK88s1wyIlhXT0W7BizJW7LTpvnvjRcacTPYavSdF3nry7yfUislwFumIZ+4yLtSDeXrYZmyIXaOPx0uJBOsTeKblYG28J023WW4yqCht/z94bz2+i1mqYHY1OD94SVTpVvDaCjC2fkzzP5+nEJlYniY90b8kU15PAJ1HZj07p3z/6nG0/ sidebar_class_name: "patch 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update job

+ - + Update a job with the given key. -## Request + -

Path Parameters

Body

required
    changeset objectrequired
    + -JSON object with changed job attribute values. + -The following attributes can be adjusted with this endpoint, additional attributes -will be ignored: - -- `retries` - The new amount of retries for the job; must be a positive number. -- `timeout` - The duration of the new timeout in ms, starting from the current moment. - -Providing any of those attributes with a null value or omitting it preserves the persisted attribute’s value. - -The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead. - -
- -The job was updated successfully. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the jobKey is not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The job with the given key is in the wrong state currently. 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/update-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-role.api.mdx index d3c4375064d..c5c3609de5f 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-role.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-role.api.mdx @@ -5,56 +5,256 @@ description: "Update a role with the given key." sidebar_label: "Update role" hide_title: true hide_table_of_contents: true -api: eJztWEtz2zYQ/isYnJIpLcqpk6a8qYrTuE1TjyK3B0eHJbgSEYMAA4CWNRz+984C1MuSEx96lGc0lrjY9/cB4Lbcw8Lx7JZPjEI+S7ip0YKXRl8VPONNXYDHIEt4gU5YWZOQZ/wmiBgwaxSypfQl8yWyhbxHze5wNeAJr8FChR4tuWi5hgp5xknhT1zxhEsyVIMvecItfmukxYJn3jb42Nu0RDLKzDx4CT69YTE+cuVEiRXwrOV+VZMXqT0u0PKEz42twMdHby54182iN3T+N1OsSOexc2G0R+1JBHWtpAglSb86CqY9dGbyryg8ZWypgF6iI6koQS/QYTB0mJBDTwnFVUVMCry3Mm88OsoKlPp7Hmq3rz16hu73Q4u92CTgvJV6cdBkijLWuGCFdLWCFSPN3T4MeNcl3EuvyBBhZbxJu5uRbFvd252SzPaVIp4msS+866Kiq412MeJXw4vjZYwABLeJ1DVCoHPzRqnVgHcJvxgOj6vW1tzLgpIDD0w6po1n96BkMfii+ZM4qK3JFVY/HeLhcZuu40pWoAepWGwGA8fiwhwLJjW7nbwfs18vXv8ye1F6X7ssTZfL5cDOxRkW0hs7MHaR2rmgD617OWDTEi2yClYsRwZFIcknKLZtM3M1CjmXgpjiY7YhGOp5zO/7GInSQ4xsCNVYeQCZEbuZXDFZoPZyvpJ6ceg66MyhUWQDctP4LFeg7/gWRz8C5oi5pqrAbnaEfQddwp0H37gfbgg/vzoK+g/T6TWLJpgwBbK5scyX0q0dURKV1LJqKp5dDIcJr+Ah/nozHHZkkzr+jEw0w4dagQ7QepyO1KwyFnv8hMSkdh60+L86Y6xcyMd+9zndg/hdzChS82J4/gQbI4OZAnHnIpcYNL4kr5E+TFgMQYAKG9WJZCeSnUh2nGTfPfLWd67+QrU+v+am0cWJWCdinYj1FLFeH7sQjjSjKlvCIVprLDNCNNZiwZalVME83SvXvvuT7nRTPHHtxLWnuNYlvEJfmiK+6YsyjAV8yTOe0rnl0rY/vjp6i0d7v54WNFbxjLeRMV2Wpm1pnO+ytjbWd+k9teMerIRcRRCSODJrjRhlBKjw+FjnSLD7MjuGqtEFsLdscvl5yn4Hj0uIL5Dkct/02+Hb4VGrtPQJi6PrKxYzjLjb2QvWZonUR83Gxc8xHOYbDkVjpV99JrVYnhzBoh01VPsNHnp/wTr9jot40n95v0bJH/9OQ6NpH5tsZyeXD1DVkYV7s45+0tOjrQtYnJvgt0fKYQbUTrQupjwcnB+i8voqkEuYqmp02GH1It6CYKciQjXOUyUSrqRA7XAnovWyj1HC/oke2fmAuhkht95YF9KXTT4QpkpFVNv8z5XJ0wqkTnsXLh2P/rr59G509vFqfPnp8+XZ+WA48A8+JF8b5yvQO3H00zN7ZLLWbs+SZw3Z+k56fPBprUBqwlbIpO2ZdhtGbo4nPFvP3mZJT5db3rY5OLyxquvo8bcG7Ypnt7Mtu+IASjr6XvBsDso9HtDtBv1i0s97XrIfju2OBt8/BL0KFFcN/eIJv8PVzviwm3UJLxEKtCHAKB3HMM6mZGOrfTDF65K1xkgIrP0Ta/fObyLWZjO7Hk3HH4go/QixMkUYbsKShpmw5Bn/wr9Q2CbUKHAwPG+5Ar1oYEHro2H6+w++d2q6 +api: eJztWEtz2zYQ/isYnJIpLcqpk6a8qYrTuE1SjyK3B1eHJbgSEYMAA4CWNRz+984C1MuSEx96lGc0lrjY9/cB4Lbcw8Lx7JZPjEI+S7ip0YKXRl8VPONNXYDHIEt4gU5YWZOQZ/wmiBgwaxSypfQl8yWyhbxHze5wNeAJr8FChR4tuWi5hgp5xknhT1zxhEsyVIMvecItfmukxYJn3jb42Nu0RDLKzDx4CT69YTE+cuVEiRXwrOV+VZMXqT0u0PKEz42twMdHby54182iN3T+N1OsSOexc2G0R+1JBHWtpAglSb86CqY9dGbyryg8ZWypgF6iI6koQS/QYTB0mJBDTwnFVUVMCry3Mm88OsoKlPprHmq3rz16hu73Q4u92CTgvJV6cdBkijLWuGCFdLWCFSPN3T4MeNcl3EuvyBBhZbxJu5uRbFvd252SzPaVIp4msS+866Kiq412MeJXw4vjZYwABLeJ1DVCoHPzRqnVgHcJvxgOj6vW1tzLgpIDD0w6po1n96BkMfhX8ydxUFuTK6x+OsTD4zZdx5WsQA9SsdgMBo7FhTkWTGp2O3k/Zr9evP5l9qL0vnZZmi6Xy4GdizMspDd2YOwitXNBH1r3csCmJVpkFaxYjgyKQpJPUGzbZuZqFHIuBTHFx2xDMNTzmN/3MRKlhxjZEKqx8gAyI3YzuWKyQO3lfCX14tB10JlDo8gG5KbxWa5A3/Etjn4EzBFzTVWB3ewI+w66hDsPvnE/3BB+fnUU9B+m02sWTTBhCmRzY5kvpVs7oiQqqWXVVDy7GA4TXsFD/PVmOOzIJnX8GZlohg+1Ah2g9TgdqVllLPb4CYlJ7Txo8X91xli5kI/97nO6B/G7mFGk5sXw/Ak2RgYzBeLORS4xaHxJXiN9mLAYggAVNqoTyU4kO5HsOMm+e+St71z9hWp9fs1No4sTsU7EOhHrKWK9PnYhHGlGVbaEQ7TWWGaEaKzFgi1LqYJ5uleuffcn3emmeOLaiWtPca1LeIW+NEV80xdlGAv4kmc8pXPLpW1/fHX0Fo/2fj0taKziGW8jY7osTdvSON9lbW2s79J7asc9WAm5iiAkcWTWGjHKCFDh8bHOkWD3ZXYMVaMLYG/Z5PLLlP0OHpcQXyDJ5b7pt8O3w6NWaekTFkfXVyxmGHG3sxeszRKpj5qNi59jOMw3HIrGSr/6QmqxPDmCRTtqqPYbPPT+gnX6HRfxpP/yfo2SP/6ZhkbTPjbZzk4uH6CqIwv3Zh39pKdHWxewODfBb4+UwwyonWhdTHk4OD9E5fVVIJcwVdXosMPqRbwFwU5FhGqcp0okXEmB2uFOROtlH6OE/R09svMBdTNCbr2xLqQvm3wgTJWKqLb5nyuTpxVInfYuXDoefbr5/G509vFqfPn5y+XZ+WA48A8+JF8b5yvQO3H00zN7ZLLWbs+SZw3Z+k56fPBprUBqwlbIpO2ZdhtGbo4nPFvP3mZJT5db3rY5OLyxquvo8bcG7Ypnt7Mtu+IASjr6XvBsDso9HtDtBv1i0s97XrIfju2OBt8/BL0KFFcN/eIJv8PVzviwm3UJLxEKtCHAKB3HMM6mZGOrfTDF65K1xkgIrP0Ta/fObyLWZjO7Hk3HH4go/QixMkUYbsKShpmwjCGbUJ/Av/Cs5Qr0ooEFrY1G6e8/JoRpvg== sidebar_class_name: "patch 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update role

+ - + Update a role with the given key. -## Request + -

Path Parameters

Body

required
    changeset object
    + -A set of changed role attributes. + -
- -The role was updated successfully. - -
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The request lacks valid authentication credentials. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The role with the roleKey is not found. - -
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/update-tenant.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx index f69c378a56d..11fd3fa5f46 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx @@ -5,52 +5,337 @@ description: "Updates an existing tenant." sidebar_label: "Update tenant" hide_title: true hide_table_of_contents: true -api: eJztWVtv2zYU/isEn1pMkZw27Tq9uWm6Zm2zIHW2h8QPlHhssaVIlaTiCIb++3BIKZYvuXTrywAHCCyRh+f6fRR1tKSOzS1Nr+gEFFOOTiOqKzDMCa1OOU1pXXHmoJuNKAebG1HhNE3ppZ+0hCkCt8I6oebEedGYRrRihpXgwKCBJVWsBJrSMP8RGhpRgUoq5goaUQPfa2GA09SZGjYtTQogtRLfayCCg3JiJsAQPSOugIFJmxdQMpouqWsqtCaUgzkYGtGZNiVzYej1EW3babAJ1r3VvME1uVYOlMNLVlVS5D4NyVeLLiy3levsK+SYlcpg0pwAi7Mh0Dsp64xQ863cYUQKFgSlNwNp22E+roLGaUSdcBJVhnKE7F+EGGi7vgiT6AdspZUNjr0YjfBn249glyyYJaHenNg6z8HaWS1lg5n917lhUv458wBYt/uWWSCrxJGZNmQ9ruA5Gn8438F7ROtTct6hCG4dGMVkH/vpO9pGP1K6e8q2u0QhFAyZIu52+Y+M+JEAbGMdlAdzUEhX4AShvh7R4x55gWE9bxSPc1bWirOYVSL+Bo2NVV1mYH7ZrjWHykCO1nvW7qv/M6q/2rX+W/l37HoP+3jmK/0RGvs0ZIQU7UDGHgf/r10ARY7uezxURt8IDpxw5hgRlijtyA2Tgj/wZKiMziSUO3eNoYExOQ+ShINjQpJQX8IsCYKZj4pcXbw/Jr8dvfp1+qxwrrJpkiwWi9jM8gPgwmkTazNPzCzHf5R7HpNJAQZIyRqSAWGcC7TJ5BBwtoJczEROnPZV7NwmWIH4Wj0OOz+7XbE74tVGbBVwTC4vTvuDTONPTZum/ZoZqyXqYJmuXZpJpr7RVS0fg8mY2LosmWl6hK4baCNqHXO13bnxDDeOly92QvDDZHJOggqSaw6evK4QtjeEQZRCibIuaXo0GkW0ZLfh7vVo1KJOrPgTIsHzZSWZ8tDaDEcoUmoDHX58YEJZx1T+syqjjZiLTbvrvOpA/C5E1BPq5Tbe32uTCc5BeXiS7gjas4pJqRew59WeV3tePcCro228n2lHZrpWPPBq8Eqj7mb2rNqzas+qe1j1atfxb6xWJ0owRhui87w2BjhZFEJ69dgn6G13j7OAxT3X9lzbc22ba21ES3CF5qH7mRe+WeoKmtIkPLdssrx7H2yxrwnmpu+j1kbSlC4Da9o0SZaFtq5Nl5U2rk1usCQ3zAiWyQBEnA7s6lEjdc6kH95VPZwYvtgeh7d+8oZcnHyZkN+ZgwVrfDbR5LrqN6M3o51aUfQejePzUxIiDNgb7Ae9WiT2TrVB+CmKfcfXQl4b4ZovuCykJwNmwIxrzP8dJjp7XjveByEadRfve6T88ffEFxv3sotVN/nklpVVYGLX9u5A5hE4095Sh49tn7GAYGwIchQfbmPx/NRTKtdlWSu/r6o5WQhXEDbIQS5r6zD2iEqRA77prxzqxT6FGfJXsEgOY6xfAFm/nc6FK+osznWZdC2gu99M6iwpmVBJZ8Imx+PPl2fvxgefTo9Pzr6cHBzGo9jdOp+nSltXMjXwI7QiuvPaZqSDnvwjHxu6ujm4dUklmVCYah/FsuPWVddisTSi6arbMo06glzR5TJjFi6NbFsc/l6DaWh6NV3xKXSwhMVrTtMZk3bzU8XQ5WcXXT/+OXniB4ydYXSDTDWe2rLGOxrRb9gsGjSO2mkb0QIYB+MdDfPHwZ2DCWpZrd/q4rdRv2Kc51C5B2Wngy3sfDw5/oDU6D6jlJrjIsMW+FmHLWhKr+k1Oqx9jjzr/PiSSqbmNZujfFCMf/8AhP03lQ== +api: eJztWVtv2zYU/isEn1pMkdw27TK9ubmsWbssSJ3tIfMDJR5bbClSJak4gqH/PhxSiuVLLt36MsABAkvk4bl+H0UdLaljc0vTGzoBxZSj04jqCgxzQqtzTlNaV5w56GYjysHmRlQ4TVN67SctYYrAnbBOqDlxXjSmEa2YYSU4MGhgSRUrgaY0zH+EhkZUoJKKuYJG1MC3WhjgNHWmhk1LkwJIrcS3GojgoJyYCTBEz4grYGDS5gWUjKZL6poKrQnlYA6GRnSmTclcGHp3SNt2GmyCde81b3BNrpUD5fCSVZUUuU9D8sWiC8tt5Tr7AjlmpTKYNCfA4mwI9F7KOiPUfCt3GJGCBUHpzUDadpiPm6BxGlEnnESVoRwh+1chBtquL8Ik+gFbaWWDY69HI/zZ9iPYJQtmSag3J7bOc7B2VkvZYGb/dW6YlH/MPADW7b5nFsgqcWSmDVmPK3iOxh/Pd/Ae0fqcnHcogjsHRjHZx35+Qtvoe0r3QNl2lyiEgiFTxN0u/5ER3xOAbayD8mAOCukKnCDU1yN62iMvMKznreJxzspacRazSsRfobGxqssMzE/bteZQGcjRes/affV/RPVXu9Z/K/+OXe9xHy98pT9CY5+HjJCiHcjY4+D/tQugyOFDj4fK6FvBgRPOHCPCEqUduWVS8EeeDJXRmYRy564xNDAml0GScHBMSBLqS5glQTDzUZGbq7Nj8svh25+nLwrnKpsmyWKxiM0sPwAunDaxNvPEzHL8R7mXMZkUYICUrCEZEMa5QJtMDgFnK8jFTOTEaV/Fzm2CFYj/Vk/Dzs9uV+yeeLURWwUck+ur8/4g0/hT06Zpv2bGaok6WKZrl2aSqa90VcunYDImti5LZpoeoesG2ohax1xtd248w43jzeudEPwwmVySoILkmoMnryuE7Q1hEKVQoqxLmh6ORhEt2V24ezcatagTK/6MSPB8WUmmPLQ2wxGKlNpAhx8fmFDWMZX/qMpoI+Zi0+46rzoQn4SIekK92cb7mTaZ4ByUhyfpjqA9q5iUegF7Xu15tefVI7w63Mb7hXZkpmvFA68GrzTqfmbPqj2r9qx6gFVvdx3/xmp1ogRjtCE6z2tjgJNFIaRXj32C3nb3OAtY3HNtz7U917a51ka0BFdoHrqfeeGbpa6gKU3Cc8smy/v3wRb7mmBu+z5qbSRN6TKwpk2TZFlo69p0WWnj2uQWS3LLjGCZDEDE6cCuHjVS50z64V3Vw4nhi+1xeOsnR+Tq9POE/MocLFjjs4km11UfjY5GO7Wi6AMax5fnJEQYsDfYD3q1SOydaoPwcxT7jq+FvDbCNZ9xWUhPBsyAGdeY/3tMdPa8drwPQjTqLs56pPz218QXG/eyq1U3+fSOlVVgYtf27kDmETjT3lKHj22fsYBgbAhyFL/axuLluadUrsuyVn5fVXOyEK4gbJCDXNbWYewRlSIHfNNfOdSLfQoz5M9gkbyKsX4BZP12OheuqLM412XStYDufzOps6RkQiWdCZscj3+/vjgZH3w6Pz69+Hx68Coexe7O+TxV2rqSqYEfoRXRndc2Ix305J/42NDVzcGdSyrJhMJU+yiWHbduuhaLpRFNV92WadQR5IYulxmzcG1k2+LwtxpMQ9Ob6YpPoYMlLF5zms6YtJufKoYuv7jq+vEvyTM/YOwMoxtkqvHUljXe0Yh+xWbRoHHUTtuIFsA4GO9omD8O7hxMUMtq/VYXv436FeM8h8o9KjsdbGGX48nxB6RG9xml1BwXGbbAzzpsEZzVPj+ecX5sSSVT85rNUTYoxb9/ALmeNpk= sidebar_class_name: "patch 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update tenant

+ - + Updates an existing tenant. -## Request + -

Path Parameters

Body

required
+ -The tenant was updated successfully. + -
Schema
Schema
Schema
- -The provided data is not valid. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Forbidden. The request is not allowed. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -Not found. The tenant was not found. - -
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/update-user-task.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx index f8240c2d514..1396027bb7e 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,74 +5,294 @@ description: "Update a user task with the given key." sidebar_label: "Update user task" hide_title: true hide_table_of_contents: true -api: eJztWW1v2zYQ/isHftmbLCtZ0jb65qVdm67rgsTZgCUBSktnm61EqnyJYxj678ORki2/pMm67psLBHXMe+PdPQ+Z44JZPjEsvWZXBjVYbj6x24ipCjW3QsmznKXMVTm3SAJDWo9YjibToiIBlrIrvwwcXGsCZsJOwU4RJuIOJXzCecwiVnHNS7SoyeGCSV4iWW/s/oZzFjFBFitupyxiGj87oTFnqdUON90Op0iGQY29p5VzqyBETD5NNsWSs3TB7Lwid0JanKBmERsrXXIbvnp2xOr6NrhEY39R+Zx0VhGMeWEwYpmSFqWlNV5Vhch8lvofDYW02PamRh8xs7R3TTm1Ag2tZlMuJ2jQG1rf1tvLP95DUAtpDLJ52Bu3VouRswh3vHBo4ht5IykTY1UUaibkZCViIOMSRgg8/+iMxbwtizCAMq+UkDYCnueCXPOio3kjZ6IoSFdMpNKYp+TnR/iQcZkLyu1rrVxlPkAPNO0DRnOotLoTuQ9BApaVnUMhjF3Xoy56ulru8CW3+Jj8pdVCTrxGyMNV9S/VKi2UFnZOKqWQonQlJBGU/N5/PEiSCHIcc1dYOE4oGecde00TKoPd7Ptsc/ggXVF8CPUCpUGVwlrSExYqCk/fUcKphyvURvhKLc18Z4LmstDcGDGRiFRcqeyj9XUGPT4GXi90Ubsak0kvbZymflFaU9/hHUoLWApjhJIwVrrjNrRufCNZtNXltFU+KrBF7Kq5zjv9H9bWEdFUugMd46vTxSn1T8+KErcoiBKTOwRPRA0h0E5juHi0/vFW3DX5XLXRf4gpmOm56ttFto6kTmxcaz7fGQXBiXwvVT1ZmqeHQwYoGGGxNNvpqL8UZiCKr4xz4pX/10Bb5D96RPx8uDPoVn8tSBaxhkVYmpCWZw6WHicRaziFpUQqm/HUEbPC0q/sdHlG1BHjWXC5eVoMIHPGqhKCQMMydsrp8AgMzrMMjRGjAmGsVdk5KD3MDVGkKzwj+fU1/gAh71Q45GI4GwMxTsg75hExmPfSMqNVcNPcFm7YGkMsgfPwftv7RbhOXISDmNU1yWg0lZImUMVhcrSdiOHaFWDGTXMHyME4n4CxK4p5TLk8SpJH9bfuLx26bQzH8LvSCDlaLgoDXOMyMyCk127DhpHK5yEfD1wgKq1GBZY/bV8kNut9HiQbv+1NgRsIgqPg/fri11M4OTp+fvv91NrKpP3+bDaL9TjrYS6s0rHSk74eZ/RDcj/EMJyiRij5PJwpy2vBiqjBVJiJscio0v7AaoKhKu8+EdZZPqx+gU6dFlsoG8DVxRmIHKUV4zn16ZZr1sEY4yPlbDoquPzEVv217XTTi3FlyfUSyOsO6ogZy60zX8sTb4bDcwgmIFM5+lPVY61xtEYaR0mXKZ4lSU02qeJP2IkEvK8KLn1rbW5HSChXfes3JqSxXGbfqjJKi4nY9BuzLtabJn4ZdhQwfvQEWG/DkpBOuBwrJ/N4D7A9wPYAexBgJ18BMGHa02ymlZz4DCNkTmuUtpjvT8E9SPcg/XYgPd51OR1IoCxr6kPUmoYImUdgDrOpKLx5f8lvfDdTrD3W9ljbY+0hrNURK9FOVR4GztnUT6jtlKWsTydij05E01905tM1DZRpXtdMsJ0uWMoWATp12u8vpsrYOl1UStu6f0d1ueNa0B+8voy0HCDWtk6hMl74r3eVkBZoTN5u7ZSXTuYcXsDFq8shvOYWZzz8VUsu102/SF4ku0cWStsHLA7OzyDsMDRghxRas4TunWaD8FMM+1G7wczR4OSS1EJ6Rsg16oGjIiwbo/HnrdPvQYhFzYdf23Z5+9fQV5wI7WI1xn91z8sqwHF96t4OHNlhcnjUOzjsHZwMD47T5Hn680l88vzZ32xzDPglyc2x3HXb0Lc7ZmHdxdX86TjpDHo6Iyshx8rnox0MbWWW2oxGx14xiQ+2YXN+5tGfqbJ00h8BctIOqFf2soLmyJp4oRAZSuPT1rzTtGLvwgr8GTzCQUxdFqDQMv9E2KkbxZkq+1lQW/4/KtSoX3Ih+40L0z8d/H71/uWg9+7s9NX7y1e9gziJ7b311ayUsSWXnTia56blpXVzs4vViff0p6mm1yze235VcCEp8X5Pi4YUrtmKFFjE0u6z1W3UIPuaLRYjbvBKF3VNX392qOcsvb5dEYFnjlwY+rx6WHpwC99fNG9QP8DTXrx2bqWdvcq5p6TC0W8sYp9wvvEEV9/WEZsiz1H7SIPEaYinNyQ7Kwtbb2B11GoMsgwr+4Ds2uWDyGDJxOeD4ekbAnfzAleqnJQ1n9GDIJ+xlN2wGwpd+WR53vDfL1jB5cTxCckHw/TvHxGiBVY= +api: eJztWW1v2zYQ/isHftmbLCtZsqb65qVdm67tgsTZgCUBSktnm61EqnyJYxj678ORki2/pMm67psLBHXMe+PdPQ+Z44JZPjEsvWZXBjVYbj6x24ipCjW3QsmznKXMVTm3SAJDWo9YjibToiIBlrIrvwwcXGsCZsJOwU4RJuIOJXzCecwiVnHNS7SoyeGCSV4iWW/s/o5zFjFBFitupyxiGj87oTFnqdUON90Op0iGQY29p5VzqyBETD5NNsWSs3TB7Lwid0JanKBmERsrXXIbvvrliNX1bXCJxv6q8jnprCIY88JgxDIlLUpLa7yqCpH5LPU/Ggppse1NjT5iZmnvmnJqBRpazaZcTtCgN7S+rTeXf7yHoBbSGGTzsDdurRYjZxHueOHQxDfyRlImxqoo1EzIyUrEQMYljBB4/tEZi3lbFmEAZV4pIW0EPM8FueZFR/NGzkRRkK6YSKUxT8nPj/Ah4zIXlNtXWrnKfIAeaNoHjOZQaXUnch+CBCwrO4dCGLuuR130dLXc4Qtu8TH5S6uFnHiNkIer6l+qVVooLeycVEohRelKSCIo+b3/eJAkEeQ45q6wcJxQMs479pomVAa72ffZ5vBBuqL4EOoFSoMqhbWkJyxUFJ6+o4RTD1eojfCVWpr5zgTNZaG5MWIiEam4UtlH6+sMenwMvF7oonY1JpNe2jhN/aK0pr7DO5QWsBTGCCVhrHTHbWjd+EayaKvLaat8VGCL2FVznXf6P6ytI6KpdAc6xleni1Pqn54VJW5RECUmdwieiBpCoJ3GcPFo/eOtuGvyuWqj/xBTMNNz1beLbB1Jndi41ny+MwqCE/leqnqyNE8PhwxQMMJiabbTUX8pzEAUXxnnxCv/r4G2yH/0iPj5cGfQrf5akCxiDYuwNCEtzxwsPU4i1nAKS4lUNuOpI2aFpV/Z6fKMqCPGs+By87QYQOaMVSUEgYZl7JTT4REYnGcZGiNGBcJYq7JzUHqYG6JIV3hG8utr/AFC3qlwyMVwNgZinJB3zCNiMO+lZUar4Ka5LdywNYZYAufh/bb3i3CduAgHMatrktFoKiVNoIrD5Gg7EcO1K8CMm+YOkINxPgFjVxTzmHJ5lCSP6m/dXzp02xiO4Z3SCDlaLgoDXOMyMyCk127DhpHK5yEfD1wgKq1GBZY/bV8kNut9HiQbv+1NgRsIgqPg/frit1N4fnT87Pb7qbWVSfv92WwW63HWw1xYpWOlJ309zuiH5H6IYThFjVDyeThTlteCFVGDqTATY5FRpf2B1QRDVd59IqyzfFj9Ap06LbZQNoCrizMQOUorxnPq0y3XrIMxxkfK2XRUcPmJrfpr2+mmF+PKkuslkNcd1BEzlltnvpYnXg+H5xBMQKZy9Keqx1rjaI00jpIuU/ySJDXZpIo/YScS8L4quPSttbkdIaFc9a3fmJDGcpl9q8ooLSZi02/MulhvmvhF2FHA+NETYL0NS0I64XKsnMzjPcD2ANsD7EGAPf8KgAnTnmYzreTEZxghc1qjtMV8fwruQboH6bcD6fGuy+lAAmVZUx+i1jREyDwCc5hNReHN+0t+47uZYu2xtsfaHmsPYa2OWIl2qvIwcM6mfkJtpyxlfToRe3Qimv6iM5+uaaBM87pmgu10wVK2CNCp035/MVXG1umiUtrW/Tuqyx3Xgv7g9WWk5QCxtnUKlfHCf72rhLRAY/J2a6e8dDLncAIXLy+H8IpbnPHwVy25XDd9kpwku0cWStsHLA7OzyDsMDRghxRas4TunWaD8FMM+1G7wczR4OSS1EJ6Rsg16oGjIiwbo/HnrdPvQYhFzYff2nZ589fQV5wI7WI1xn95z8sqwHF96t4OHNlhcnjUS571Dp8PD47T44P08CROnh38zTbHgF+S3BzLXbcNfbtjFtZdXM2fjpPOoKczshJyrHw+2sHQVmapzWh07BWT+GAbNudnHv2ZKksn/REgJ+2AemUvK2iOrIkXCpGhND5tzTtNK/Y2rMCfwSMcxNRlAQot80+EnbpRnKmynwW15f+jQo36JRey37gw/dPBu6v3Lwa9t2enL99fvuwdxEls762vZqWMLbnsxNE8Ny0vrZubXaxOvKc/TTW9ZvHe9quCC0mJ93taNKRwzVakwCKWdp+tbqMG2ddssRhxg1e6qGv6+rNDPWfp9e2KCDxz5MLQ59XD0oNb+P6ieYP6AZ724rVzK+3sVc49JRWOfmMR+4TzjSe4+raO2BR5jtpHGiROQzy9IdlZWdh6A6ujVmOQZVjZB2TXLh9EBksmPh8MT18TuJsXuFLlpKz5jB4E+SyErXyiPGf47xas4HLi+IRkg1H69w+3NwRC sidebar_class_name: "patch 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Update user task

+ Update a user task with the given key. -## Request + -

Path Parameters

Body

    changeset objectnullable
    + -JSON object with changed task attribute values. + -The following attributes can be adjusted with this endpoint, additional attributes -will be ignored: - -- `candidateGroups` - reset by providing an empty list -- `candidateUsers` - reset by providing an empty list -- `dueDate` - reset by providing an empty String -- `followUpDate` - reset by providing an empty String -- `priority` - minimum 0, maximum 100, default 50 - -Providing any of those attributes with a `null` value or omitting it preserves -the persisted attribute's value. - -The assignee cannot be adjusted with this endpoint, use the Assign task endpoint. -This ensures correct event emission for assignee changes. - -
- -The user task was updated successfully. - -
- -The user task with the given key cannot be updated. 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 user task with the given key was not found. - -
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
- -The user task with the given key is in the wrong state currently. 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/operate-api/sidebar-schema.js b/docs/apis-tools/operate-api/sidebar-schema.js index 747e15b625b..c680d76315f 100644 --- a/docs/apis-tools/operate-api/sidebar-schema.js +++ b/docs/apis-tools/operate-api/sidebar-schema.js @@ -6,7 +6,7 @@ module.exports = { "apis-tools/operate-api/operate-api-authentication", "apis-tools/operate-api/operate-api-tutorial", { - Specifications: require("./specifications/sidebar.js"), + Specifications: require("./specifications/sidebar"), }, ], }; diff --git a/docs/apis-tools/operate-api/specifications/by-id.api.mdx b/docs/apis-tools/operate-api/specifications/by-id.api.mdx index 5bd23389b1c..2e8f502d730 100644 --- a/docs/apis-tools/operate-api/specifications/by-id.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-id.api.mdx @@ -5,55 +5,191 @@ description: "Get decision instance by id" sidebar_label: "Get decision instance by id" hide_title: true hide_table_of_contents: true -api: eJzlV21v2zYQ/ivCfVo7JXLadCiEYoBbK4VWwwlipx0QBAVNnWM2EqmSlFND0H8fjnqxY8tetk8b+skS74V3z734UQmW3RsIb2GEXBihZCyNZZIj3PmgctTM0mECIczXcQI+5EyzDC1qMitBsgwhBEEiISGEnNkl+JCg4VrkZA0hxImnFl7S3OGJ9hIfNH4vhMYEQqsL9MHwJWYMwhLsOifPxmoh76Gq7kjZ5EoaNCR/NRjQz9OLpgXnaAz4wJW0KC2psDxPBXeZBN8M6ZX796j5N+SWEtSUtxX1LSLpicWHB1xvnQtp8R41+LBQOmO2PvrtnDSNZRb3ffiAssgI+YthPI5G4EP0eTi+Gc7c883k0+Tyy8Q9Ta+iD/FFHI3grvIBVywtXC6jXsdPVC6YSAvdr5VrRVCNcCGkIOVPz86pMW175fmGbQfE/ai24k1Mf6M4cd13ROEzaiPqih8N7/WrbauZUz1cslH0IZ7Gl5Ovs+H7cQQ+jONZdD0cf43+vLqOpiTaqdymolRDjaZI7bHaYRLLvLBmS4dpzdY0ZRYz868bVx5CjO7tk1Q+WGFTOtrdES5Ep9FFfVnY/0bYPugixQPt40QywR/P6osjCNTp1ioombS9Fx5xAFVF4vO+XRbLFUtF4tGKRGMP77Rcq3mK2a//dLfRairMM2cjQ2PYfT/U3T7vE9reYdoGJdJa6Q6J1/tIXCg9F0mC8ikGL4OX//90z/fTva4LjlR6owrN0ZPKegtVyOTn6II3ffMwvIq9rYQ9dAY/AR7EIpAXWti141xzZBr1ieMgt3eVXwJX6kGge7vb5V4f0e4zL2++9hxny9AuFdG7e3RQEHsLIVidBa3NSWtjglIkFVAwetXyv0KnEEJZg1uFQVAulbFVWOZKW1JeMS3YPK2xJVld2AVz/4CQKs5Sd7wb92yJHglo9RN7tEv0qAXq208dD1F6x93bwdtBrydSPeBl0xgbP0tr814/tXKvJ0dR20JNSa9Oui3O5i8xF0SZ2n81uLyKroez6GTaUQfHpBu7yn9S8M5LE6ILiN5rJWi1L9pe/ePLzPWVkAvlzJv+unTsHr2rYp4KTqnsJ6w85vi0x7gVK/SYTDyusjxF2k4NDeyaip681u1CaS9TUlhFne0srVYFdcJSKVsTKhpdxl0N60aipEwYBI+Pj6ecZYVM2ClXGYGQCo7SOBwb3MbNib9jnChuOmuh3HugcYEaJcegcWQCxx9agghnp4PTQd1VxmZMbl10fISeYNaVx+IPG+QpE5J8ugDLZrxuYXUGG7a5GTDwIRQJfXrVg3ILZTlnBm90WlV0/L1A7YZ+M1duChNh6DmBcMFSg3sxdSsSfrluPrheeIc/ynpTaJtXrqGjXQDNpxDxtoqo7RJZgtoFVQuGnGNut0z2vsZobLo19DGagQ+sIJw6LHda23nvDefde6fgzdQDyt+74Cy9UnxV9RfHqxkU +api: eJzlV9tu20YQ/RVintqUNuXELQK+qREdsBFsw5KTAIYQrJYja2Nyl9ldyhEI/nsxy4tulOL2qUWeRO5cdubMRYclWPZoIHyAEXJhhJKxNJZJjjDzQeWomaXDBEKYr+MEfMiZZhla1GRWgmQZQgiCREJCCDmzS/AhQcO1yMkaQogTTy28pLnDE+0lPmj8VgiNCYRWF+iD4UvMGIQl2HVOno3VQj5CVc1I2eRKGjQkfz0Y0M/uRZOCczQGfOBKWpSWVFiep4K7TIKvhvTKw3vU/CtySwlqytuK+haR9MTiwxOut86FtPiIGnxYKJ0xWx/9cUmaxjKLhz58QFlkhPzVMB5HI/Ah+jgc3w+n7vn++sP1zadr9zS5jd7FV3E0glnlA65YWrhcRr2Od1SumEgL3a+Va0VQjXAhpCDlDy/OqTFte+Xlhm0HxP2otuJNTD9QvHbdd0LhI2oj6oqfDO/N622rqVM9XrJR9C6exDfXX6bDP8cR+DCOp9HdcPwl+nx7F01ItFe5TUWphhpNkdpTtcMklnlhzZYO05qtacosZuZfN648hhjd2yepfLDCpnS0vyNciE6ji/qmsP+NsH3QRYpH2seJZILfX9QXJxCo061VUDJpey884QCqisSXfbssliuWisSjFYnGHt9puVbzFLPf/uluo9VUmBfORobGsMd+qLt93ie0vcO0DUqktdIdEm8OkbhSei6SBOUuBq+CV///dC8P072rC45UeqMKzdGTynoLVcjk5+iC3/vmYXgbe1sJe+gMfgI8iEUgL7Swa8e55sg06jPHQR5mlV8CV+pJoHub7XOv92gPmZc3X3uOs2Vol4ro3SM6KIi9hRCsLoLW5qy1MUEpkgooGL1q+V+hUwihrMGtwiAol8rYKixzpS0pr5gWbJ7W2JKsLuyCuX9ASBVnqTvej3u6RI8EtPqJPdoletQC9e3njocovefu7eDtoNcTqR7xsmmMjZ+ltXmvn1q515OjqG2hJqRXJ90WZ/OXmAuiTO2/GtzcRnfDaXQ26aiDY9KNXeXvFLzz0oToAqL3Wgla7au2V//6NHV9JeRCOfOmv24cu0fvtpinglMqhwkrjzk+7TFuxQo9JhOPqyxPkbZTQwO7pqInr3W7UNrLlBRWUWc7S6tVQZ2wVMrWhIpGl3FXw7qRKCkTBsHz8/M5Z1khE3bOVUYgpIKjNA7HBrdxc+LvGSeKm85aKPceaFygRskxaByZwPGHliDCxfngfFB3lbEZk1sXnR6hHcy68lj8boM8ZUKSTxdg2YzXA6wuYMM2NwMGPoQioU+velAeoCznzOC9TquKjr8VqN3Qb+bKTWEiDD0nEC5YavAgpm5Fwi93zQfXr97xj7LeFNrmlWvoaBdA8ylEvK0iartElqB2QdWCIeeY2y2Tg68xGptuDb2PpuADKwinDsu91nbee8Mpy1pjqp5QVlUXnaV3CrCq/gYA8BqK sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision instance by id

+ Get decision instance by id -## Request - -

Path Parameters

- -Success - -
Schema
    evaluatedInputs object[]
  • Array [
  • ]
  • evaluatedOutputs object[]
  • Array [
  • ]
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key-1.api.mdx b/docs/apis-tools/operate-api/specifications/by-key-1.api.mdx index 3975e1c8537..3065bae87d2 100644 --- a/docs/apis-tools/operate-api/specifications/by-key-1.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key-1.api.mdx @@ -5,55 +5,156 @@ description: "Get process instance by key" sidebar_label: "Get process instance by key" hide_title: true hide_table_of_contents: true -api: eJzlVt9v2zYQ/leIe2o7JXLabiiEYUCWOIWXNAkSr3sIjIGizjYbiVTJkzND0P8+HCU5jq0E2ePQF1sS77uf3/GuBpILD8kdXDur0PuJ8SSNQphFYEt0krQ1kwwSSNfnuP77CCIopZMFEjoG1mBkgZDAPa4hAm0ggVLSEiLI0CunS9YACZzjWti5KFs7QveGInD4vdIOM0jIVRiBV0ssJCQ10Lpk1doQLtBBBHPrCkntp18+QtPMGO5Lazx6RrwfjfjvqenbSrFNiEBZQ2iIRWRZ5lqF+OJvnuXqfcs2/YaKOGbH2SDdWuFYX+NewLHpr+i8bm28CPrwfh80lYstnCenzYKl0rIwfdWyQYlSOjR0/npng/xZbh8ubYY9FV6P9yQdnUrCQW/QZM+eeRo8YVBVMD2PT6aTr2OI4OTqy/XFeDo+5efjy5PxxfgUZg0zT+msq22nJbU2R2m2UnqKc2001/z1UREaaejFFO80T9ANSjtV5dK92Tl9G5RqylnTbts1TdNE8HGIxROzkrnOBLcLenqezaWzaY7FT/+V1VyEyr+SowV6LxfD1dz09tBh+2HvYCsnY+es22Tiw34mzqxLdZaheZqDd/G7/3+4H/fDvWkLjlx6byunUBhLYm4rk/0YLPh5qB+OrydiK2CBAfAD5IPvS1SV07QOAzhF6dAdhKF0N2uiGpS19xrD22x3Dn9G2hvCIl2Ldn4XSEvL436BIRU8yROIV0dxhznoMT6u73HdADvjVv0yULkcEqjb5DZJHNdL66lJ6tI6YuGVdFqmeZtbPmsLO5dVzpnMrZJ5+Lzr93SJgg943eBFgpYomAKt9cNwGVu3o+7T6NNoUBOLPqPlkRiPepZE5aCeVnhQU1hO+kLdslwbdF+cTbFlqc9D8rtN6up6fHM8HR/cjm9vJ1eX/VbV4XjybxV8o6VzMTgUhl8Qgl76rOfqH39NA6+0mdsA7/h1FbY9FNdVmmvFoewHbIUMm5SQivQKhTSZULYoc+TbaZdV/CR6tXPrRGGNJsvMDkhytmImLK2ldtpz60oVatgSiYPySRw/PDwcKllUJpOHyhachFwrND7kscvbRfcl2gFnVvkNWtvwHjuco0OjMO4U+Zi1rvpFDY4OR4ejllWeCmm2DL3cQk9ytikP4T8Ul7nUYR0JDtZde93B6gg2K8pjg0EECaucRV2j3EFdp9Ljny5vGv78vUIXmv6xr0IXZtrzcwbJXOYe93zaXJHw5qZbvt+K5xf0wRB68pp16Oq84jeI2t04/Da8li1RZuiCV+3JsVJY0hZmbxHnvtncQ5/HU4hAVpyox8XuKbeD9kF/fv09CIipvUfz28Y74lf2r2n+BXkpdA4= +api: eJzlVt9P20gQ/leseWp7BoeWO1V+Q2CqHBxEkLYPKDqt15Nki73r7o7DRZb/99Os7RASg3KPp74ktne++fnNztRAYuEgfoCJNRKdG2tHQkuEWQimRCtIGT3OIIZ0fYXrv08ghFJYUSChZWANWhQIMTziGkJQGmIoBS0hhAydtKpkDRDDFa4DMw/K1k6gekMhWPxZKYsZxGQrDMHJJRYC4hpoXbJqpQkXaCGEubGFoPbTH6fQNDOGu9Joh44RH0cj/ntp+r6SbBNCkEYTamIRUZa5kj6+6IdjuXrfskl/oCSO2XI2SLVWONZD3PM4Nv0NrVOtjTdBnz7ug6ZisYVzZJVesFRaFrqvWjYoUQqLmq4Od9bLX+bm6cZk2FPhcLwjYelCEA56gzp79czR4AmDqoLpeXY+HX9LIITz278m18k0ueDns5vz5Dq5gFnDzJMq62rbaUmNyVHorZRe4FxpxTU/PCpCLTS9meKd5vG6QSorq1zYdzun771SRTlr2m27pmmaEE6HWDzWK5GrLOB2QUevs7m0Js2x+O2/spqLULkDOVqgc2IxXM1Nbw8dth/2DrZyklhr7CYTn/YzcWlsqrIM9cscfIg+/P/DPd0P964tOHLpnamsxEAbCuam0tmvwYLfh/rhbDIOtgIO0AN+gXzwfYmysorWfgCnKCzaIz+UHmZNWIM05lGhf5vtzuEvSHtDOEjXQTu/C6Sl4XG/QJ8KnuQxRKuTqMMc9RgX1Y+4boCdsat+GahsDjHUbXKbOIrqpXHUxHVpLLHwSlgl0rzNLZ+1hZ2LKudM5kaK3H/e9Xu6xIAPeN3gRYKWGDAFWuvH/jI2dkfd59Hn0aAmFn1FyzMxnvUsicpBPa3woCa/nPSFume5Nui+OJtii1Jd+eR3m9TtJLk7myZH98n9/fj2pt+qOhxP/q2Cb7R0LnqH/PDzQtBLX/Zc/fP71PNK6bnx8I5ft37bw2BSpbmSHMp+wCYQfpMKhCS1wkDoLJCmKHPk22mXVfwU9GrnxgaF0YoMM9sjyZqKmbA0htppz60rpK9hSyQOysVR9PT0dCxFUelMHEtTcBJyJVE7n8cub9fdl3AHnBnpNmhl/HtkcY4WtcSoU+Qi1rrqFzU4OR4dj1pWOSqE3jL0dgu9yNmmPIT/UFTmQvl1xDtYd+31AKsT2Kwozw0GIcSschZ2jfIAdZ0Kh19t3jT8+WeF1jf9c1/5LsyU4+cM4rnIHe75tLki4d1dt3y/D15f0AdD6Mmr176r84rfIGx3Y//b8Fq2RJGh9V61J2dSYklbmL1FnPtmcw99SaYQgqg4Uc+L3Utue+2D/tR1KzE1j6ibZuMe8Ts72DT/Ag1odYQ= sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process instance by key

+ Get process instance by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key-2.api.mdx b/docs/apis-tools/operate-api/specifications/by-key-2.api.mdx index 39f7967ede2..605f0a1a229 100644 --- a/docs/apis-tools/operate-api/specifications/by-key-2.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key-2.api.mdx @@ -5,55 +5,146 @@ description: "Get process definition by key" sidebar_label: "Get process definition by key" hide_title: true hide_table_of_contents: true -api: eJzlVt9v4zYM/lcEPm03N0573XAwhgEdljt0HdaiybCHIhhkmY51tSWfJKcLDP/vAyXb+eXrbo/DvSSWRH4kP5KiWnB8YyF5ggejBVr7C+ZSSSe1gnUEukbDaXGbQQLp7g53f11BBDU3vEKHhlRbULxCSOAZdxCBVJBAzV0BEWRohZG1h0vgDndM56wOlli2NxWBwU+NNJhB4kyDEVhRYMUhacHtagKXyuEGDUSQa1NxF7Z+uIauW5O6rbWyaEnjaj6nv2Pjy0aQVYhAaOVQORLhdV1K4SOMP1qSa88t6/QjCkdRG+LDyWCFov0S96KenlHUOiPVhg62aKwMVl+FeXt1IL3im0mwtK5Un0TK1oSEQ8WVmzykU+lK2jovhK6j8+spVm/VlpcyY5Q+tO7z7NZGpyVW3/1Xlq3jrrFfyFCF1vLNNNdSWceVmD4MG6+xsjBGm5GJt+dMvNcmlVmG6piDN/Gb/3+41+fhPoaEI6Xe6sYIZEo7lutGZV9HFXw/1Q83D7fsIGCGXuEr4KOLwKJojHQ7PxJS5AbNhb8kn9Zd1ILQ+lmiX61PJ8MHdBNjgaU7FmZKha7QNII26Mmg6ZJAvL2Me62LvZaN22fcdUAOme0wohpTQgJtILhL4rgttHVd0tbaOBLeciN5WgZ+6SwkN+dNSWyWWvDSb5/6viqQ0QHd8jTeXIGMyiBYnxGRZOMY7t383XwSiUQ/g7Ivjj1O4Vw9iROEJ5H8wByStSS5EPSQoDHhvJZ3nv5+vt8/LB5vVouL5WK5vL3/fZj1vR6NoIOkjyi9i94hWgchGKTfD/X6658rX1tS5dqr9zV2798gyB6atJSCQjkPWDPupzvjwsktMq4yJnRVl0g31FBZQ7HTFxtgc21YpZV0mqrbazqjG6qEQmtHFR/alwufw1BIFJRN4vjl5WUmeNWojM+EroiEUgpU1vPY8/ZbvxOdKGda2FFbar+ODeZoUAmMeyAbHz0V4HI2n81DVVlXcXVg6N/a6Ii1MUEO/3ZxXXKpCNW72PYt9gTby3D5nDYZRJAQ6Drqm+UJ2jblFv8wZdfR9qcGjW/+fW/5Tsykpe8MkpyXFs+8Gq9K+OaxfxR+y157Ok6GMZSw2vneLhtaQRRebf63W3cRFMgzNN6vcHIjBNbuQOfsiUjdM95HHxYriIA3RNZI6EmFe/RJf3782QuwlX5G9dPonaMl+dd1/wB6G/xX +api: eJzlVt9v3DYM/lcEPq2dc76k2VD4LcCuRZZhCXI37CE4FLJM36mxJVeSLzMM/+8FJdv3y826x6Evd5ZEfiQ/kqJacHxjIXmCB6MFWvsb5lJJJ7WCdQS6QsNpcZtBAmlzh82nK4ig4oaX6NCQaguKlwgJPGMDEUgFCVTcbSGCDK0wsvJwCdxhw3TOqmCJZXtTERj8UkuDGSTO1BiBFVssOSQtuKYicKkcbtBABLk2JXdh69dr6Lo1qdtKK4uWNK7mc/o7Nr6sBVmFCIRWDpUjEV5VhRQ+wvizJbn23LJOP6NwFLUhPpwMVija73Ev6ukZRa0zUm3oYIfGymD1VZh3VwfSK76ZBEurUvVJpGxNSDhUXLnJQzqVrqCt80LoOjq/nmL1Vu14ITNG6UPrvs1uZXRaYPnzf2XZOu5q+50MlWgt30xzLZV1XInpw7DxGisLY7QZmXh3zsQHbVKZZaiOOXgbv/3/h3t9Hu5jSDhS6q2ujUCmtGO5rlX2Y1TBL1P9cPNwyw4CZugVfgA+uggsitpI1/iRkCI3aC78Jfm07qIWhNbPEv1qfToZPqKbGAssbViYKSW6raYRtEFPBk2XBOLdZdxrXey1bNw+Y9MBOWR2w4iqTQEJtIHgLonjdqut65K20saR8I4bydMi8EtnIbk5rwtis9CCF3771PfVFhkd0C1P481tkVEZBOszIpJsHMO9n7+fTyKR6DdQ9sWxx9k6V03iBOFJJD8wh2QtSS4EPSRoTDiv5J2nv5/v9w+Lx5vV4mK5WC5v7/8cZn2vRyPoIOkjSu+id4jWQQgG6Q9Dvf7+98rXllS59up9jd37NwiyhzotpKBQzgPWjPvpzrhwcoeMq4wJXVYF0g01VNZQ7PTFBthcG1ZqJZ2m6vaazuiaKmGrtaOKD+3Lhc9hKCQKyiZx/PLyMhO8rFXGZ0KXREIhBSrreex5+6PfiU6UMy3sqC21X8cGczSoBMY9kI2PngpwOZvP5qGqrCu5OjD0b210xNqYIIf/uLgquFSE6l1s+xZ7gt1luHxOmwwiSAh0HfXN8gRtm3KLf5mi62j7S43GN/++t3wnZtLSdwZJzguLZ16NVyX89Ng/Ct+w156Ok2EMJawa39tFTSuIwqvN/3brLoIt8gyN9yuc3AiBlTvQOXsiUveM99HHxQoi4DWRNRJ6UuEefdKftg0SK/2MqutG9xytycGu+wqWo/3N sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process definition by key

+ Get process definition by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key-3.api.mdx b/docs/apis-tools/operate-api/specifications/by-key-3.api.mdx index 8e4bbe0400e..68c8ba3c359 100644 --- a/docs/apis-tools/operate-api/specifications/by-key-3.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key-3.api.mdx @@ -5,52 +5,169 @@ description: "Get incident by key" sidebar_label: "Get incident by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivCfdo6NUr6MhTCMMC1mUyNIxu2nAYLAoGWzjEbiVRJKp1h6L8PR8nKi921/Tj0iy0d7/W5O/HZguW3BsJriGQmcpQWbnxQFWpuhZJRDiEsN+e4SV+DDxXXvESLmiy2IHmJEMIdbsAHISGEits1+JCjybSoyAOEcI4bT608sQvgg8bPtdCYQ2h1jT6YbI0lh3ALdlORSyEt3qIGH1ZKl9y2ot/fQNPckLmplDRoyOLV8TH9PQ05r7MMjQEfMiUtBQ23wKuqEJmrK/hkSG+7H1ktP2FGOVaaULCijUI1fk96zo5Cj3AlpKBY5z9qGkljuczw+w1blV7VWC3kLfiAsi6pt4t4PmXD6DRiI/BhEZ/Hk48x+BBN0ovBdBrFZymbzSYz8OHD5H0aT9IZS2YRm4MP7IoNF0k0idNxNE9YzGZPz4eTeBS5850LdpXMBsMkvRyMF6yXDgfjMRulbMwuWJz04kX81yAeuROSpOySxQn4cMHm88EZS+fR3yxlV0PGRi75zs2IDaP546APAgo7eJLQ6WR2kcaTJD2dLOIR3DQ+lGgMvz0AWuNDptENSSLKwwrGcvufeA+GSXTJqIrobDZIXOIzNp+ML93jlMWjKD5ziXxSyx/oM0ouLS3lXlZ0KmxBon6Tm4bEbw4tSCTveSFyjzYRjf36olRaLQssf/vRhSGMavPNul6/gm90Q3TbcPDw8OA/BoNprXSPxOt9JE6VXoo8R/kUgxfBi/9/uW/2y521DUdqvVG1ztCTynorVcv855iCt4f2YTCNvEcFe+gMfgI86HOGWa2F3bg7fYlco37p7rvrm8bfQqbUnUD3dvP8aj9D29/r3nLjtVSgRLtWxBxu0UFApCCE4P4k2OmaYHuHmwYouL7f8YlaFxDCtgWzCYNgu1bGNuG2UtqS8j3Xgi+LFks6axu54nVByBUq44UTP88zWaNHB8RYiIvYNXrU8jb6kbt8lX7m7t3xu+ODnkj1K14eBuHBz9ra6qCfVvmgJ8dzdo2Zk15b9K4ZfXN5Jc4d6B0Zm0wZ3Tgv52xO1+GOmHV2jf+kwb2XLkWXEL23SrDTPt3N5oePiZsjIVfKmXfzNHGEEb1pvSxERqXsF6w87kiZxzMr7tHjMvcyVVYF0teo4z7ebrDpydu5XSntlUoKq2iSnaXVqqZJWCtl28uXVpVnroftIFFRJgyCL1++HGW8rGXOjzJVEgiFyFAah2OH27iT+M+Mc5WZ3loo9x5oXKFGmWHQOTIBeaVBbos9OTo+Om6nytiSy0eBDq/ME6z6tlj8xwZVwYUkXy6xbbdO13B/4prbLRT4EJKrG79bjGvYbpfc4EIXTUPizzVqt9QPe+S2LheGnnMIV7wwuJdL/wmEX2Ydb//V2+f0B1PeDancuO0tanoDv6XT7rchErRGnqN22bQngyzDyj6y2ePutB/9d+aMEWXkNQHTg/dshp33g/n88d4peIm6Q/lnn52lV8qvaf4FfTtoRQ== +api: eJzlVttu20YQ/RVintqUsZxLi4BvqrR2GcukIFFOUMMgVuTI2pjcZXaXTgWC/17MkqIvUprksciLRM7O9cwM9zRg+a2B4BpCmYkcpYUbH1SFmluhZJhDAOvdBe7SN+BDxTUv0aImiwYkLxECuMMd+CAkBFBxuwUfcjSZFhV5gAAucOepjSf2AXzQ+LkWGnMIrK7RB5NtseQQNGB3FbkU0uItavBho3TJbSf64y207Q2Zm0pJg4YsXp+e0t/TkMs6y9AY8CFT0lLQoAFeVYXIXF2jT4b0msPIav0JM8qx0oSCFV0UqvF70nN2FHqKGyEFxbr4UdNQGstlht9v2KkMqsZqIW/BB5R1Sb1dRcs5m4RnIZuCD6voIoo/ROBDGKeX4/k8jM5TtljEC/DhffxnGsXpgiWLkC3BB/aRTVZJGEfpLFwmLGKLp+eTOJqG7nzvgn1MFuNJkl6NZys2SCfj2YxNUzZjlyxKBvEq+mscTd0JSVJ2xaIEfLhky+X4nKXL8G+Wso8TxqYu+d7NlE3C5eOgDwIKO36S0Fm8uEyjOEnP4lU0hZvWhxKN4bdHQGt9yDS6IUlEeVzBWG7/E+/xJAmvGFURni/GiUt8wZbx7Mo9zlk0DaNzl8gntf6BPqPk0tJSHmRFp8IWJBo2uW1J/PbYgoTynhci92gT0divL0ql1brA8rcfXRjCqDbfrOvNa/hGN0S/DUcPjw/+YzCY1koPSLw5ROJM6bXIc5RPMXgxevH/L/ftYbmLruFIrTeq1hl6Ullvo2qZ/xxT8PuxfRjPQ+9RwR46g58AD/qcYVZrYXfuTl8j16hfuvvu+qb1G8iUuhPo3m6eX+3naId73VvvvI4KlGi3ipjDLToIiBQEMLp/NdrrmlFzh7sWKLi+3/OJWhcQQNOB2QajUbNVxrZBUyltSfmea8HXRYclnXWN3PC6IOQKlfHCiZ/nmWzRowNiLMRF7BY9ankX/cRdvko/c/fu9N3pUU+k+hUvD4Pw4GdrbXXUT6d81JPjOfvGLEmvK3rfjKG5vBIXDvSejMVzRjfOyyVb0nW4J2a9Xes/afDgpU/RJUTvnRLstc/2s/n+Q+LmSMiNcub9PMWOMKI3r9eFyKiUw4KVxx0p83hmxT16XOZepsqqQPoa9dzH2w82PXl7txulvVJJYRVNsrO0WtU0CVulbHf50qryzPWwGyQqygSj0ZcvX04yXtYy5yeZKgmEQmQojcOxx23WS/xnxrnKzGAtlHsfadygRpnhqHdkRuSVBrkr9tXJ6clpN1XGllw+CnR8ZZ5gNbTF4j92VBVcSPLlEmv6dbqG+1euuf1CgQ8Bubrx+8W4hqZZc4MrXbQtiT/XqN1SP+yR27pcGHrOIdjwwuBBLsMnEH5Z9Lz9V++Q0x9NeT+kcue2t6jpDfyOTrvflkjQFnmO2mXTnYyzDCv7yOaAu9N+DN+Zc0aUkdcEzADesxl23o/m0zSdRqLuULbtkJ6ld0qwbf8FBbFpuw== sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get incident by key

+ - + Get incident by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key-4.api.mdx b/docs/apis-tools/operate-api/specifications/by-key-4.api.mdx index 43f441aff9b..ba88765b28f 100644 --- a/docs/apis-tools/operate-api/specifications/by-key-4.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key-4.api.mdx @@ -5,55 +5,184 @@ description: "Get flow node instance by key" sidebar_label: "Get flow node instance by key" hide_title: true hide_table_of_contents: true -api: eJzlV1tv2zYU/isCn7ZOjdI2HQphGKDYTKvFlT1JTlYEhkFLxzEbmVRJKplh6L8Ph7rEjp1eHoe+2CLPhefyHerTlhh2q4l/Qy4K+SBkDqHQhokMyMwlsgTFDJcizIlPFptL2MzPiEtKptgaDCi03BLB1kB8cgcb4hIuiE9KZlbEJTnoTPESPRCfXMLGkUtn2R7k8O4klyj4UnEFOfGNqsAlOlvBmhF/S8ymRN9cGLgFRVyylGrNTLP1+xmp6xma61IKDRotXp+e4t/+2UmVZaA1cUkmhQFhUIWVZcEzm6D3WaPe9vBkufgMmcGkFZbD8OYUTPZ7wrN2eHRX18sfNRzCkguOQX6/qTZMmSEzsKOvjeLiFqUg8mdl2J0IYZB/VRzZlh9R4CLjOQjz/bE2Kk9dYZTVGoE5jZIJHYQXIR0Sl0zi8YAmCXFJMj2fP67oFY3S+f5ekgZxOrcS4pIwSmn8kQ7DIKXzQZAOPhwXpR/i8XUvOh9Po2EQf+o3aDTsnxMaX4UDOk+D5JK4JKYDGl71y2lC4+75YxBNg1G3av/oP4PRNEGL90FKr4NPNpTDvUkQB6MRHe1sNemeBwkd7uwm9O8pjQZ0fjEaX+Op01EazsMoSQPcPR8PUWsQjEbzYJCGV2GK6/NpEkY0SebxdNQHnwzicJL2K8y6Syu6jMbXEZk1ODuGo8fm2WMoHjr+OBnR1PYQix1GAS5mO5DZ8bOQsgAmLDxAMGGOwhGl3BS4ddHBtrtT6hrFZ8fuglDcs4LnDl46oM3zd0Kp5KKA9W8/ejdgVSr9Tfi/eY35rUFrdvvcMLXZHBMen5vdolClpOor8eawEhdSLXieg9ivwQvvxf8/3bPDdOOm4YCt17JSGThCGmcpK5H/HCh4e2wegkno7CTsgDX4CeqBFxhkleJmY3nMApgC9dK+2m9mtbslmZR3HOxq9pTOvAdjuYyzR2acxcZpiNAazEoib7oFWwykRD7x7l95HQN62Rlpb3sHm5pgPOq+o1WVKohPtk19a9/ztiupTe1vS6kMKt8zxdmiaMqLsqa3S1YVWMxCZqyw209DT1fgoACJG1IyswIHUdCcfmLJh1RP3L07fXd61BOqPuPlERuPflbGlEf9NMpHPVmW1/UqQb0m6a4/fb9ZyS9t9VtOOp7QOEjpy4QmSTiOOn7a2tXuXs97L22INiD7OrJKpNO+6OD613VqocXFUlrzFmJjy5vBmVSLgmeYymHC0mGWkjosM/weHCZyJ5PrsgC8oFru18MKn5zO7VIqZy0FNxLBbS2NkhUiYSWlad7AOL0ssz1sgIRJad/zHh4eTjK2rkTOTjK5xiIUPAOhbR3buo3aHfeJcS4z3VtzadeegiUoEBl4rSPtoVcEcpPsq5PTk9MGVdqsmdg56FtTtFe1vkEG/jVeWTBuKYINcdtO2A25f0Uaoro/Y8QlPvqcue2s3JDtdsE0TFVR17j9pQJlR/9xtOwg5lzjc078JSs0HATVX5Tkl7j9kPnV+crXztEkOgCLjZ3sosIVcZsPDftbI1laActB2bAaSZBlUJodm4OvGpyd/jJ6T5G4sgpL9Ui39vFtvR+N549zq+Ck8g7En310BpcYX13/B+pfx+g= +api: eJzlV1tv2zYU/isCn7ZOjdM2HQq9KTbTanFkT5KTFYFh0NJxzEYmVZJKZgj678OhLrFjp5fHoS+2yHPhuXyH+lQRw+408W7JRS4fhcwgENowkQKZu0QWoJjhUgQZ8chyewnbxRlxScEU24ABhZYVEWwDxCP3sCUu4YJ4pGBmTVySgU4VL9AD8cglbB25clbtQQ7vTnKJgq8lV5ARz6gSXKLTNWwY8SpitgX65sLAHSjikpVUG2aarT/PSF3P0VwXUmjQaPH29BT/9s+OyzQFrYlLUikMCIMqrChyntoEB1806lWHJ8vlF0gNJq2wHIY3p2CyPxKetcOju7pe/qzhCFZccAzyx021YcqMmIEdfW0UF3coBZG9KMPuhAiD7Jvi0Lb8iAIXKc9AmB+PtVF57gqjLDcIzFkYT+kwuAjoiLhkGk2GNI6JS+LZ+eJpRa9pmCz29+LEj5KFlRCXBGFCoys6CvyELoZ+Mvx0XJR8iiY3veh8MgtHfvS536DhqH+OaXQdDOki8eNL4pKIDmlw3S9nMY265ys/nPnjbtX+0X+G41mMFh/9hN74n20oh3tTP/LHYzre2WrSPfdjOtrZjenfMxoO6eJiPLnBU2fjJFgEYZz4uHs+GaHW0B+PF/4wCa6DBNfnszgIaRwvotm4Dz4eRsE06VeYdZdWeBlObkIyb3B2DEdPzbPHUDx0cjUd08T2EIsdhD4u5juQ2fGzlDIHJiw8QDBhjsIRpdzkuHXRwba7U+oaxWfH7oJAPLCcZw5eOqDNy3dCoeQyh80fP3s3YFVK/V34v3uL+W1Aa3b30jC12RwTHp+b3aJQpaTqK/HusBIXUi15loHYr8Grwav/f7pnh+lGTcMBW69lqVJwhDTOSpYi+zVQ8P7YPPjTwNlJ2AFr8AvUAy8wSEvFzdbymCUwBeq1fbXfzmu3IqmU9xzsav6cznwEY7mMs0dmnOXWaYjQBsxaIm+6A1sMpEQeGTy8GXQM6HVnpAfVPWxrgvGoh45WlSonHqma+tbeYFCtpTa1VxVSGVR+YIqzZd6UF2VNb1eszLGYuUxZbrefh56swUEBEjekZGYNDqKgOf3Ekg+pnrn7cPrh9KgnVH3ByxM2nvysjSmO+mmUj3qyLK/rVYx6TdJdf/p+s4Jf2uq3nHQypZGf0NcxjeNgEnb8tLWr3b2e917aEG1A9nVklUinfdHB9a+bxEKLi5W05i3EJpY3gzMtlzlPMZXDhKXDLCV1WGr4AzhMZE4qN0UOeEG13K+HFT45nduVVM5GCm4kgttaGiVLRMJaStO8gXF6WWp72AAJk9LeYPD4+HiSsk0pMnaSyg0WIecpCG3r2NZt3O64z4wzmeremku7HihYgQKRwqB1pAfoFYHcJPvm5PTktEGVNhsmdg763hTtVa1vkIF/zaDIGbcUwYZYtRN2Sx7ekIao7s8YcYmHPuduOyu3pKqWTMNM5XWN219LUHb0n0bLDmLGNT5nxFuxXMNBUP1FSX6L2g+Z351vfO0cTaIDsNjayc5LXBG3+dCwvzWSpTWwDJQNq5H4aQqF2bE5+KrB2ekvo48UiSsrsVRPdGsf39b70XiqqtFI5D2Iuu7DM7jGAOv6P9J4yV4= sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get flow node instance by key

+ Get flow node instance by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key-5.api.mdx b/docs/apis-tools/operate-api/specifications/by-key-5.api.mdx index 1b457025295..c115fafa252 100644 --- a/docs/apis-tools/operate-api/specifications/by-key-5.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key-5.api.mdx @@ -5,52 +5,147 @@ description: "Get decision requirements by key" sidebar_label: "Get decision requirements by key" hide_title: true hide_table_of_contents: true -api: eJzlVt9v2zYQ/leIe9o61XLadCiEYUCKuoWXoQliD3sIjIKmzjYbiVTJkzNB0P8+HPUjdqx06ePQF1sk7767++6OxxpIbj0kt/Aelfbamhv8WmqHORrysIrAFugkaWvmKSSwri6x+vwGIiikkzkSOtauwcgcIYE7rCACbSCBQtIOIkjRK6cLRoAELrESdiPSzphwh9Yi6JYpJORKjMCrHeYSkhqoKhhfG8ItOohgY10uqd369RyaZsXqvrDGo2eNV9Mp/x3bX5RKoWdTyhpCQywiiyLTKgQZf/EsV59atusvqIgDd0wJ6daKTg9kPDltttBEgYfneM38nPI+HwdtOR452KPzuvX7mxZfv2Jph96WTuGnp+AIjTQ06gSfasp4a7RgmoZFzseon5u9zHQaUo6enk5B4ew6w/yX702FJ0mlfyYJOXovt+Pxa+NJGvUEOWHjW8TMnLNuYOL1KRMfrFvrNEVzzMGL+MX/P9zz03Bv2oQjp76tPGEsiY0tTfpjVMGbsX64uJ6Lg4AFBoUfgI8mAo+qdJqqMDrWKB26l+HKvF01UQ3K2juNYbV6PEE+Io2PD7GuRDt+cqSd5Wm1xcAHD6IE4v1ZnLo0ru+waoB9cPt+epUugwTqltMmieN6Zz01SV1YRyy8l07LddZSymdtPjeyzJjAzCqZhe3H7i53KPiA726efLRDwZlvrU+YO7ZxDPd2+nY6isSiT6A81MMDzo6oGMVphUeRwiDt87NguTboPidDjmWhLwPd3ei/up7dXCxnLxezxWJ+9al/BnR6TXSU5wGlczE4xOtWCHrpD32J/vH3MpSTNhsb1LuyugrPExTX5TrTikM5DdgKGaa+kIr0HoU0qVA2LzLkS6lwNhz29c1foofdWCdyazRZLuigSc6WXAk7a4mLvO1YqUIO20LioHwSx/f39xMl89KkcqJsziRkWqHxgceOtz+7neiRcmqVH7S1DevY4QYdGoVxB+TjowcAnE2mk2lbVZ5yaQ4MPaNzjogbckT4D8VFJrVh4OBl3XXVLezPWM/xTZ4wyCrq+uMW6notPf7lsqbh7a8lutDiD+0Umi/Vnr9TSDYy83jixXAhwk/dWyP9WfzHQ3LU875wTRU6Oit5Bd1jLfw2qyaCHcoUXXCtPblQCgs60Dl5MHLPDLfOx9kSIpAl8zNw+KiuA/qoP7+9CwJiae/Q/D54R7xk/5rmX5p7AyA= +api: eJzlVlFvGzcM/isCn9bu6nPadCjuLcDcIsvQBLGHPQTGIOtoW82ddJV4zoyD/ntB6ezY8aXNHoe+2CeJ/Eh+JEV1QHLlobiD31Fpr625xa+tdlijIQ/zDGyDTpK25rKEAhbbK9z+8x4yaKSTNRI61u7AyBqhgHvcQgbaQAGNpDVkUKJXTjeMAAVc4VbYpSh7Y8IdWsugX5ZQkGsxA6/WWEsoOqBtw/jaEK7QQQZL62pJaeu3cwhhzuq+scajZ4234zH/HduftkqhZ1PKGkJDLCKbptIqBpl/8SzXnVq2iy+oiAN3TAnpZEWXBzKenDYrCFnk4SVeMz+nvF8OgyaOBw426LxOfn/X4ru3LO3Q29Yp/PwcHKGRhgad4FNNFW8NFkwILHI+RP2l2chKlzHl6On5FDTOLiqsf/2vqfAkqfUvJKFG7+VqOH5tPEmjniEnbnyPmIlz1u2ZeHfKxEfrFros0Rxz8Dp//f8P9/w03NuUcOTUp8oTxpJY2taUP0cVvB/qh4ubS3EQsMCo8BPwETLwqFqnaRtHxwKlQ/cmXpl385B1oKy91xhX86cT5BPS8PgQi61I46dGWlueViuMfPAgKiDfnOWlK/PuHrcB2Ae32U2v1lVQQJc4DUWed2vrKRRdYx2x8EY6LRdVopTPUj6Xsq2YwMoqWcXtp+7O1ij4gO9unny0RsGZT9ZHzB3bOIb7MP4wHkRi0WdQHuvhEWdN1AziJOFBpDhId/mZslwKepeTfY5lo68i3f3ov76Z3F7MJm+mk+n08vrz7hnQ64XsKM97lN7F6BCvkxDspD/uSvSPv2exnLRZ2qjel9V1fJ6guGkXlVYcymnAVsg49YVUpDcopCmFsnVTIV9KjbPxcFff/CV2sEvrRG2NJssFHTXJ2ZYrYW0tcZGnjpUq5jAVEgflizx/eHgYKVm3ppQjZWsmodIKjY889rz92e9kT5RLq/xeW9u4zh0u0aFRmPdAPj96AMDZaDwap6ryVEtzYOgFnXNE3D5HhP9S3lRSGwaOXnZ9V93B5oz1HN/kBYPMs74/7qDrFtLjX64Kgbe/tuhiiz+2U2y+Unv+LqFYysrjiRf7CxF+6d8a5Svxg4fkoOe7wjXb2NFVyyvoH2vxN8xDBmuUJbroWjq5UAobOtA5eTByz+xvnU+TGWQgW+Znz+GTuo7og/50XZKY2Xs0IezdI16zgyF8A729BJY= sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision requirements by key

+ - + Get decision requirements by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key-6.api.mdx b/docs/apis-tools/operate-api/specifications/by-key-6.api.mdx index 57d1ad2a758..074e3af1866 100644 --- a/docs/apis-tools/operate-api/specifications/by-key-6.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key-6.api.mdx @@ -5,55 +5,150 @@ description: "Get decision definition by key" sidebar_label: "Get decision definition by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivEfdo6xXLarCiEYUCGuoWXoQlib/sQGANNnW02EqmSJ6eGoP8+HCm/xUrWfBz6xRbJe334HO8aILn0kN3Be1Taa2ve40IbTdoamCVgK3SSF+McMphvrnDzz1tIoJJOlkjoWLcBI0uEDO5xAwloAxlUklaQQI5eOV0Fcxlc4UbYhcg7VyLf+0rA4ZdaO8whI1djAl6tsJSQNUCbiq1rQ7hEBwksrCslxa23F9C2M1b3lTUePWu8Hg7579j7pFYKvYcElDWEhlhEVlWhVUgx/exZrjn1bOefURGn7RgQ0tGLzg9kPDltltAmAYVviZrRiUCM+w1FVHsO1ui8jrE+6+XN60MvtxHgEg35Jzz2iV69OJ1D7U9P5dAn/NeL8iI00lBvJnyqqeCtHl63LQtc9HFkbNay0LlgMqKnp7lSOTsvsPzppZzxJKn235hhid7LZT9+2niSRvUfxo3nYBk5Z90OiTenSHywbq7zHM0xBq/SV///dC9O072NF4589d7WTqEwlsTC1ib/Pljwc189XN6MxUHCAoPCd4BHm4BHVTtNm9Dh5igdurPwtt/N2qQBZe29xrCaPW50H5H6upyYb0TskSXSynJLXWJAg7tlBun6PN2qne3VfNrc46YFDsmttz23dgVk0ESI2yxNm5X11GZNZR2x8Fo6LedFRJjP4vUuZF0wnoVVsgjbj6OfrlDwAfcf7te0QsFEiN4HDCX7ODb3bvhu2GuJRZ+wsqfH3s6KqOq1E4V7LYUBYHtdE5aLSW+vaHflstJXAf9uYLm+Gd1eTkdnk9FkMr7+tB1eOr02Obr2nZUuxBAQr6MQbKU/bBn7+9/TwC5tFjaodyy7DkMVipt6XmjFqZwmbIUM04qQivQahTS5ULasCuQ3qnI2HG7pzl9ia3ZhnSit0WSZ30GTnK2ZCStriTkfC1iqcIeRSJyUz9L04eFhoGRZm1wOlC0ZhEIrND7g2OH2R7eTPFLOrfI7bW3DOnW4QIdGYdoZ8unREAPng+FgGFnlqZTmwNF/FtIRbLsbIvxKaVVIbdhsiLHpiuwO1uewHz8OywwSyNjqLOnK5Q6aZi49/umKtuXtLzW68ADsqyvUYq49f+eQLWTh8SSs3XMJP3TzTv6jeHYa7k1ky2KzCeVd1LyCbuIMv+2sTWCFMkcXAosnl0phRQc6J1MvF9DuTfo4mkICsma4dpA+Inmw3hvPL78FATG192h+3UVHvOT42vZf5I9HyQ== +api: eJzlVt1v2zYQ/1eIe9o6xXLarCj0FqBukWVogtjbHgJjoKmzzUYiVfLkzBD0vw9HSv6Ilax5HPpii+R9/vg73jVAcuUhu4ePqLTX1nzEpTaatDUwT8BW6CQvrnLIYLG9xu3f7yGBSjpZIqFj3QaMLBEyeMAtJKANZFBJWkMCOXrldBXMZXCNW2GXIu9ciXzvKwGH32rtMIeMXI0JeLXGUkLWAG0rtq4N4QodJLC0rpQUt95fQNvOWd1X1nj0rPF2POa/Y+/TWin0HhJQ1hAaYhFZVYVWIcX0q2e55tSzXXxFRZy2Y0BIRy86P5Dx5LRZQZsEFL4nakYnAnE1bCiiOnCwQed1jPVFL+/eHnq5iwCXaMg/43FI9PrV6Rxqf3kuhyHhP1+VF6GRhgYz4VNNBW8N8LptWeBiiCNXZiMLnQsmI3p6niuVs4sCy19eyxlPkmr/nRmW6L1cDeOnjSdp1PBh3HgJlolz1u2QeHeKxCfrFjrP0Rxj8CZ98/9P9+I03bt44chX723tFApjSSxtbfIfgwW/DtXD5e2VOEhYYFD4AfBoE/CoaqdpGzrcAqVDdxbe9vt5mzSgrH3QGFbzp43uM9JQlxOLrYg9skRaW26pKwxocLfMIN2cp73a2V7Np80DblvgkNym77m1KyCDJkLcZmnarK2nNmsq64iFN9JpuSgiwnwWr3cp64LxLKySRdh+Gv1sjYIPuP9wv6Y1CiZC9D5iKNnHsbkP4w/jQUss+oyVPT32dtZE1aCdKDxoKQwA/XVNWS4m3V/R7splpa8D/t3AcnM7ubucTc6mk+n06uZLP7x0em1ydO07K12IISBeRyHopT/1jP3tr1lglzZLG9Q7lt2EoQrFbb0otOJUThO2QoZpRUhFeoNCmlwoW1YF8htVORsOe7rzl+jNLq0TpTWaLPM7aJKzNTNhbS0x52MBSxXuMBKJk/JZmj4+Po6ULGuTy5GyJYNQaIXGBxw73H7vdpInyrlVfqetbVinDpfo0ChMO0M+PRpi4Hw0Ho0jqzyV0hw4+s9COoJtd0OE/1BaFVIbNhtibLoiu4fNOezHj8MygwQytjpPunK5h6ZZSI9/uKJteftbjS48APvqCrWYa8/fOWRLWXg8CWv3XMJP3byT/yxenIYHE+lZbLahvIuaV9BNnOG3nbcJrFHm6EJg8eRSKazoQOdk6uUC2r1JnyczSEDWDNcO0ickD9YH42maKDGzD2jadhce8ZoDbNt/AUyJST8= sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision definition by key

+ Get decision definition by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/by-key.api.mdx b/docs/apis-tools/operate-api/specifications/by-key.api.mdx index 1e50a6414fb..8c834bc2962 100644 --- a/docs/apis-tools/operate-api/specifications/by-key.api.mdx +++ b/docs/apis-tools/operate-api/specifications/by-key.api.mdx @@ -5,52 +5,147 @@ description: "Get variable by key" sidebar_label: "Get variable by key" hide_title: true hide_table_of_contents: true -api: eJzlVt1v2zYQ/1eIe9pa1XLabCiEYkAKuIWXYQlir30I/EBRZ4uNRKrkyakh6H8fjvpIHKtr+zj0xRZ5H7z73R1/bIDkzkNyCx+k0zItEDYR2AqdJG3NMoME0sMlHiCCSjpZIqFj/QaMLBESuAsybSCBSlIOEWToldMV20MCl3gQdiv2g/sIHH6utcMMEnI1RuBVjqWEpAE6VOxSG8IdOohga10pqdv6/RzadsPmvrLGo2eLl/M5/x0fuaqVQu8hAmUNoSFWkVVVaBWyij951mtOT7bpJ1TEuTrGgHR3Cuf4PeEFOz56aTxJo/Dyuw29stUPqHfgj6qenDY7FuxlUU9LyNVGSWLcR2lqbYHSBDEaaWiZTdiyVFPBW2OXtC1vn0/BvzR7WehMcJ3R09fLUDmbFlg+/9FyeJJU+28i9eol51Wi93I3DYnuyzSNV9j4LzAWzlk3IvHqFIl31qU6y9AcY/Asfvb/T/f8NN2bruDIpfe2dgqFsSS2tjbZz9EFv03Nw8X1UjxKWGAw+Anw4GsNVe00HQJjpCgduhfhNr3dtFEDyto7jWG1eUoc75FG1hDpQXREUyLllllphwECppwE4v1ZPOj6uLnDQwt8uNsPbFW7AhJoOjDbJI6b3Hpqk6ayjlh5NOfsWNYVcivrgpErrJJF2H4a5zpHwQK+kpnpKEfBJe9OnwVWsO6Ju9fz1/NJT6z6FS8PjfDgJyeqJv10ypOeAosOhVmxXpf0UIyxuLLSHfP3VH91vbi5WC9erBar1fLq74H2e7s2Oirw6KUPMQQUOCcowaD9bujNPz+uQx9ps7XBvO+nq/AYQXFdp4VWnMppwlbIQPlCKtJ7FNJkQtmyKpBvo56UxdDY/CUGt1vrRGmNJsudHCzJ2Zo7IbeWuLu7UZUq1LBrJE7KJ3F8f38/U7KsTSZnypYMQqEVGh9w7HH7q9+JnhhnVvnRWtuwjh1u0aFRGPeOfBx4HZ3vkj2bzWfzrqs8ldI8Omh6ZI6wGstC+IXiqpA6sH8IrOnH6Rb2Z0cTEUHCrjZRPxi30DSp9PiPK9qWtz/X6MJQP1iFqcu05+8Mkq0sPJ7EMl6B8MtN/yr8VZy+GCdDHprUHGB89gBE3WMt/LabNoIcZYYuRNNJLpTCih7ZnLwMeT7Ge+b9Yg0RyJqBeXg3Hfdw8D4Zz5u3QUGs7R2aP8boiJccX9v+C4wh7NA= +api: eJzlVk1z2zYQ/SuYPbUpI8qJm8nw5oOSUd2pPZbaHDw6gOBKQkwCDLCUq+Hwv3cWIGnLYtrk2MlFIrAf2H27i4cWSO48ZPfwl3Ra5iXCJgFbo5OkrVkWkEF+vMYjJFBLJyskdKzfgpEVQgYPQaYNZFBL2kMCBXrldM32kME1HoXdisPgPgGHXxrtsICMXIMJeLXHSkLWAh1rdqkN4Q4dJLC1rpIUt95dQtdt2NzX1nj0bPFmPue/0yNXjVLoPSSgrCE0xCqyrkutQlbpZ8967fnJNv+MijhXxxiQjqdwjt8SXrDjo5fGkzQKr7/Z0Ctbf4d6BH9U9eS02bHgIMtmWkKuMUoS4z5Kc2tLlCaI0UhDy2LClqWaSt4au6TrePtyCv6lOchSF4LrjJ6+Xoba2bzE6pfvLYcnSY3/T6TevuG8KvRe7qYh0X2ZpvEKG/8GxsI560Yk3p4j8cG6XBcFmlMMXqWv/v/pXp6nexcLjlx6bxunUBhLYmsbU/wYXfDr1Dxc3S7Fs4QFBoMfAA++1lA1TtMxMEaO0qF7HW7T+02XtKCsfdAYVpuXxPERaWQNkR9FJJoKaW+ZlXYYIGDKySA9XKSDrk/bBzx2wIe7w8BWjSshgzaC2WVp2u6tpy5ra+uIlUdzzo5lsZBb2ZSMXGmVLMP2yzjXexQs4CuZmY72KLjk8fRZYAXrXrh7P38/n/TEql/x8tQIT372RPWkn6g86Smw6FCYFevFpIdijMWVtY7M31P9ze3i7mq9eL1arFbLmz8G2u/tuuSkwKOXPsQQUOCcoASD9oehN3/7tA59pM3WBvO+n27CYwTFbZOXWnEq5wlbIQPlC6lIH1BIUwhlq7pEvo16UhZDY/OXGNxurROVNZosd3KwJGcb7oS9tcTdHUdVqlDD2EiclM/S9PHxcaZk1ZhCzpStGIRSKzQ+4Njj9nu/k7wwLqzyo7W2YZ063KJDozDtHfk08Do6H5O9mM1n89hVnippnh00PTInWI1lIfyb0rqUOrB/CKztx+keDhcnE5FAxq42ST8Y99C2ufT4pyu7jre/NOjCUD9ZhakrtOfvArKtLD2exTJegfDTXf8q/FmcvxgnQx6a1BxhfPYAJPGxFn67TZfAHmWBLkQTJVdKYU3PbM5ehjwf4z3zcbGGBGTDwDy9m057OHifjKdto8baPqDpujE84jUH2HX/AJki7kY= sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get variable by key

+ - + Get variable by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/delete.api.mdx b/docs/apis-tools/operate-api/specifications/delete.api.mdx index a187e6f28d3..cd579bacead 100644 --- a/docs/apis-tools/operate-api/specifications/delete.api.mdx +++ b/docs/apis-tools/operate-api/specifications/delete.api.mdx @@ -5,57 +5,142 @@ description: "Delete process instance and all dependant data by key" sidebar_label: "Delete process instance and all dependant data by key" hide_title: true hide_table_of_contents: true -api: eJzlVktv3DYQ/ivEnNpUXq0TtwiEooDbbAA3QW14t+jB2AOXml0xlkiFHK2zEPTfiyEleV/u61bkJJGc58dvZtgCyY2H7AHunFXo/Y3xJI1CWCZga3SStDU3OWSQY4mEkEAtnayQ0LFeC0ZWCBk84g4S0AYyqCUVkECOXjldswHI4APuhF2LOroRevCTgMPPjXaYQ0auwQS8KrCSkLVAu5pNa0O4QQcJrK2rJMWtH66g65as7mtrPHrWeD2d8ufQ9bxR7BMSUNYQGmIRWdelViG99JNnufbUs119QkWcs2MwSEcvFXovN7gn6Mlps4Eu6WHK/1n4CZCmkoV+KaTZ4JwkNR66jo+uzuVyY7ay1Llg0NDTyznVzq5KrL77t7n5GMLfhf/mNSf7V0CMN3zuMG6cHOwBMnPOuhGJN6dIvLdupfMczSEGr9JX//90r07TvY8Xjnz13jZOoTCWxNo2Jv86WPD9uXq4vrsRewkLDApfAR5dAh5V4zTtQhteoXToLrgNZw/LLmlBWfuoMayWx934XehSJ91YSJMLWZYixxpNLg2JXJIUq52I/b1CKuzRNKACMki3l2lv7WKw5tP2EXcdcKRuO8yLxpWQQRuR77I0bQvrqcva2jpi4a10Wq7KCDyfxVtfy6ZkmEurZBm2j5NaFCj4gCcSzxoqUDA/ovcJI8w+Ds29nb6dnrXEoi9YeWbNs52CqD5rJwqftRTm13CLc5aLSQ83NzJB1vpDwL8ftrd3s/vrxexiPpvPb25/GwZvr9clB2wYrfQhhoB4HYVgkH4/EPnXPxaBdNqsbVDvyXcb3gMo7ppVqRWncpqwFTIMWyEV6W0klLJVHYbiCd/4Twxm19aJyhpNlmkfNMnZhplQWEtcCrGupQp3GInESfksTZ+eniZKVo3J5UTZikEotULjA449bh/7neRIObfKj9rahnXqcI0OjcK0N+RTtspEjsleTqaTaWSVp0qaPUf/tb4O0BwvjvALpXUptWFvIfS2L7wH2F7GbnVYepBAxiaXSV9CD9C2K+nxd1d2HW9/btCFXvFccaE+c+35P4dsLUuPJzGNnRW+ue9fbt+Kl193Z1MYaG12od7LhleQhEdkfEp2yy6BAmWOLkQVT66Vwpr2dE5ecVxRY5N6N/s4W8wgAdkwViOeR8QPDs6G9OPPQUAs7COan8YAiZccYtf9CSey2/E= +api: eJzlVktv4zYQ/ivEnNqtYjm7abHQLeh6AXcXTRC76CHwgabGFjcSqSVHTg1B/70YUlL8Sl+3Yk8SyXl+/GaGLZDcesge4d5Zhd7PjSdpFMIqAVujk6StmeeQQY4lEkICtXSyQkLHei0YWSFk8IR7SEAbyKCWVEACOXrldM0GIINPuBd2I+roRujBTwIOvzbaYQ4ZuQYT8KrASkLWAu1rNq0N4RYdJLCxrpIUt366ga5bsbqvrfHoWePtdMqfY9eLRrFPSEBZQ2iIRWRdl1qF9NIvnuXac892/QUVcc6OwSAdvVTovdzigaAnp80WuqSHKf9n4SdAmkoW+rmQZosLktR46Do+urmUy9zsZKlzwaChp9dzqp1dl1j98G9z8zGEvwv/3VtO9q+AGG/40mHcODs4AGTmnHUjEu/Okfho3VrnOZpjDN6kb/7/6d6cp/sQLxz56r1tnEJhLImNbUz+bbDgx0v1cHs/FwcJCwwK3wAeXQIeVeM07UMbXqN06K64DWePqy5pQVn7pDGsVqfd+EPoUmfdWEiTC1mWIscaTS4NiVySFOu9iP29QirsyTSgAjJId9dpb+1qsObT9gn3HXCkbjfMi8aVkEEbke+yNG0L66nL2to6YuGddFquywg8n8Vb38imZJhLq2QZtk+TWhYo+IAnEs8aKlAwP6L3CSPMPo7NvZ++n160xKKvWHlhzYudgqi+aCcKX7QU5tdwiwuWi0kPNzcyQdb6U8C/H7Z397OH2+XsajFbLOZ3vw6Dt9frkiM2jFb6EENAvI5CMEh/HIj8y+/LQDptNjao9+S7C+8BFPfNutSKUzlP2AoZhq2QivQuEkrZqg5D8Yxv/CcGsxvrRGWNJsu0D5rkbMNMKKwlLoVY11KFO4xE4qR8lqbPz88TJavG5HKibMUglFqh8QHHHrfP/U5yopxb5UdtbcM6dbhBh0Zh2hvyKVtlIsdkryfTyTSyylMlzYGj/1pfR2iOF0f4B6V1KbVhbyH0ti+8R9hdx251XHqQQMYmV0lfQo/Qtmvp8TdXdh1vf23QhV7xUnGhPnPt+T+HbCNLj2cxjZ0VvnvoX27fi9dfdxdTGGht9qHey4ZXkIRHZHxKdqsugQJlji5EFU9ulcKaDnTOXnFcUWOT+jD7PFvOIAHZMFYjnifEDw4uhtS2UWJpn9B03Rgh8Zpj7Lo/ASPU3Wc= sidebar_class_name: "delete api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

- Delete process instance and all dependant data by key -

+ Delete process instance and all dependant data by key -## Request - -

Path Parameters

- -Success - -
Schema
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/get-statistics.api.mdx b/docs/apis-tools/operate-api/specifications/get-statistics.api.mdx index 51c027b1625..6900610f67b 100644 --- a/docs/apis-tools/operate-api/specifications/get-statistics.api.mdx +++ b/docs/apis-tools/operate-api/specifications/get-statistics.api.mdx @@ -5,57 +5,173 @@ description: "Get flow node statistic by process instance id" sidebar_label: "Get flow node statistic by process instance id" hide_title: true hide_table_of_contents: true -api: eJzlV0tv4zYQ/ivEnNqtYjm7abEQigIpkCzSLTZB7KKHwAeaGlvcSKSWHNk1BP33YqhH7EhBkdyKzSXmY17ffDMc1UBy6yF5gDtnFXp/YzxJoxBWEdgSnSRtzU0KCWyRFiRJe9LKQwSldLJAQsfiNRhZICTwiAeIQBtIoJSUQQQpeuV0yXoggc94EHYjytaa0L25CBx+q7TDFBJyFUbgVYaFhKQGOpSsWhvCLTqIYGNdIand+uUCmmbF4r60xqNniffzOf87Nb2oFNuciXukyhkv/BCO2FgnKEOx1Ts0I+8isXW2KjEV64PY5HYvjE2RQVDWEBpiY7Isc60CXvFXzxbrcQzSORkAIiz80b5df0VFjKpj1Em3cUhFeqfpwAkY7npy2mxHyC4zFDplcDmQwcsQ2j7TKgv7Dn2VkxfSoZDbrcOtJEyhiVpbOIn32BBZkrkwVbFGxyZb4QEwP3JjImsRKL6bY/pGo734a81qo3SKhvwb7Q7yA23+I0xblDnS2+Ps5V8XaBMBacrZ2nVu919sikcF3PBfBBdTlXJjdjLXqeCSRE8v87x0dp1j8dOLfH+B11x51TT8x1F8eM/wFei93OK4AkIqu/4xddhujA6OcLlyzjrokfgwRuLaurVOUzSnGLyL3/3/w70Yh3vfJhw59d5WTqEwlsTGVib9Pljw81Q9XN7diKOABQaB7wCPJgKPqnKaDuGRX6N06M74kU8eVk1Ug7L2UWNYrZ73sk9IR+/Q8NryI/r8hRWa+VUgZbabNcKEQRkkEO/O4+7+2dAA4/oRD03sjycSj27XjyOVyyGBuoW+SeK4zqynJqlL66iBCHbSabnOW+T5rE37RlY545xbJfOwPdWh+YAHnr4NM0Fa6zOGmG2cqvs4/zif1MRXX9DyRJsnPRlROamnvTypKYxHfRoXfK8Nuk/d03BS6s9hfOtmudu7q/vL5dXZ4mqxuLn90s91nVwTndBh0NK5GBzidXsJ+tvXPZP/+HsZWKfNxgbxjn23YepEcVetc604lHHAVsgwy/VzhzTp0Sv5nFz8S/Rq+ckurNFkmfdBkpytmAmZtdROVlzYUoUctkTioHwSx/v9fqZkUZlUzpQtGIRcKzQ+4Njh9me3Ez0TTq3yg7S2YR073KBDozDuFPmYtTKR22DPZ/PZvGWVp0KaI0OvLrATGIeMEf5DcZlLbdhM8Lnuiu8BdudtnzotP4ggaUf9owpcRV0hPUBdr6XHv1zeNLz9rUIXWsZT3YUqTbXn3ykkG5l7HDk4NFj44b77PPhRvPwJMRlPT25zCFWfV7yCKHyptN8rzaqJIEOZogtetSeXSmFJRzKjAZ/ramhZn66WEIGsGLUB2WfcD9on/fn193BBLO0jmt8G74iX7F/T/Au9Rrd6 +api: eJzlV0tv20YQ/iuLObUpLcpJWgS8+WAHborYsFz0YOiwWo7EjcldZncoVSD434NZPkyZNAr7VsQXax/z+uab2WENJHcekge4dVah99fGkzQKYR2BLdFJ0tZcp5DADmlFkrQnrTxEUEonCyR0LF6DkQVCAo94hAi0gQRKSRlEkKJXTpesBxL4gkdht6JsrQndm4vA4fdKO0whIVdhBF5lWEhIaqBjyaq1Idyhgwi21hWS2q0/PkLTrFncl9Z49Czxfrnkf6emV5Vimwtxh1Q544UfwhFb6wRlKHZ6j2biXSR2zlYlpmJzFNvcHoSxKTIIyhpCQ2xMlmWuVcAr/ubZYj2NQTonA0CEhR/t2803VMSoOkaddBuHVKT3mo6cgOGuJ6fNboLsfYZCpwwuBzJ4GUI7ZFplYd+hr3LyQjoUcrdzuJOEKTRRawtn8Z4aIksyF6YqNujYZCs8AOYnbsxkLQLFd3NM32i0F3+tWW2UTtGQf6PdQX6gzX+EaYsyR3p7nL386wJtIiBNOVu7yu3hq01xVMAN/0Xwca5Srs1e5joVXJLo6WWel85ucix+e5HvL/CaK6+ah38cxYf3DF+B3ssdTisgpLLrH3OH7cbkYITLpXPWQY/EhykSV9ZtdJqiOcXgXfzu/x/ux2m4d23CkVPvbeUUCmNJbG1l0p+DBb/P1cPF7bUYBSwwCPwEeDQReFSV03QMj/wGpUN3xo988rBuohqUtY8aw2r9vJd9Rhq9Q8Nry4/o8xdWaOZXgZTZbtYIEwZlkEC8P4+7+2dDA4zrRzw2sR9PJB7dvh9HKpdDAnULfZPEcZ1ZT01Sl9ZRAxHspdNyk7fI81mb9q2scsY5t0rmYXuuQ/MBDzx9G2aCtNYXDDHbOFX3aflpOauJr76g5Yk2T3oyonJWT3t5VlMYj/o0rvheG3SfuqfhpNRfwvjWzXI3t5d3F/eXZ6vL1er65ms/13VyTXRCh0FL52JwiNftJehvX/VM/vOf+8A6bbY2iHfsuwlTJ4rbapNrxaFMA7ZChlmunzukSUev5HNy8S/Rq+Unu7BGk2XeB0lytmImZNZSO1lxYUsVctgSiYPySRwfDoeFkkVlUrlQtmAQcq3Q+IBjh9tf3U70TDi1yg/S2oZ17HCLDo3CuFPkY9bKRG6DPV8sF8uWVZ4KaUaGXl1gJzAOGSP8l+Iyl9qwmeBz3RXfA+zP2z51Wn4QQdKO+qMKXEddIT1AXW+kx79d3jS8/b1CF1rGU92FKk21598pJFuZe5w4ODRY+OWu+zz4Vbz8CTEbT09ucwxVn1e8gih8qbTfK826iSBDmaILXrUnF0phSSOZyYDPdTW0rM+X9xCBrBi1Adln3A/aZ/2p6/bGvX1E0zSDe8RrdrBpfgCU8bjw sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

- Get flow node statistic by process instance id -

+ Get flow node statistic by process instance id -## Request - -

Path Parameters

- -Success. Returns statistics for the given process instance, grouped by flow nodes - -
Schema
  • Array [
  • ]
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/operate-public-api.info.mdx b/docs/apis-tools/operate-api/specifications/operate-public-api.info.mdx index 9ea6e3d454d..cabe55b339c 100644 --- a/docs/apis-tools/operate-api/specifications/operate-public-api.info.mdx +++ b/docs/apis-tools/operate-api/specifications/operate-public-api.info.mdx @@ -9,18 +9,26 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Operate Public API

+ To access active and completed process instances in Operate for monitoring and troubleshooting
-

- Authentication -

+
@@ -69,9 +77,7 @@ To access active and completed process instances in Operate for monitoring and t >

Contact

- - URL: https://www.camunda.com - + URL: [https://www.camunda.com](https://www.camunda.com)

License

diff --git a/docs/apis-tools/operate-api/specifications/search-1.api.mdx b/docs/apis-tools/operate-api/specifications/search-1.api.mdx index 57e0fc11820..ad8c58a2b39 100644 --- a/docs/apis-tools/operate-api/specifications/search-1.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-1.api.mdx @@ -5,59 +5,240 @@ description: "Search process instances" sidebar_label: "Search process instances" hide_title: true hide_table_of_contents: true -api: eJztWG1PIzcQ/ivWfOHuupDl7V6iqhIHQeJ6BUpS+gGiyvFOEh+79p7tBdIo/70ae5NssgsXpPZD2+MTsWfG42eeefFOwfGRhfYNXBot0NozZR1XAqEfgc7RcCe1OkugDRa5EeM/diECg18LtO6jTibQnkKCVhiZkyS0oevlWB7sMVkatBCB0MqhcqTD8zyVwltvfbGkOAUrxphx+s9NcoQ26MEXFA4iyA354iRa2h3K1KH5ttwdTipCUjkcoYEIhtpk3IWltwcw83rk7DUaK4Mvzyrt79WVenxU0bPOSDUiqUGeqTm2SaNEzg0q9/Pmznr501Q/nOsE5wHbXN86btwJd9joDarkyT3rGndIqciIREfHvbPrDkRwfPHL5edOr3NC/x+dH3c+d06gP4tAKiGTkgOllYHWKXJVgfQEh1JJ4sbmt3KouHLPQrxGcW8bhDSiSLl5tbb72huVLiVL68lBWMg/cUOihMw5Gq6SlhvDJxCBdJjZOplnpKiN21yjniaYNsOhTbLiSj2O3WOI4KTTPYb+rIJDlxyaVVd+LdBMGuDBR57laXDkKE3rZeIKXWGUZTxN67WCvUpwyIvUMePFWCqtYwQ5k5btxq8hgnueFhQB8ob8woQNJmxx6ebT6ifZoMqtQJVINSIjqzm7PKoMyM0CW1iXLJH1AM76Fde4SljOR5iwB+nGbM6eZi8z/sj2G3zlRCG2NZCja27KY7e86TucsLfvDg/3P3w4ONiNDw/fv4u/fTV2q3qajdAxN0am8NF5H5nQ+cQv+YszPWRbZOuaftktJpXTbKvC6q0guHOr6LbM5ijksKzuzI51kSYs406MvdGK4qroCtIeoP3opZCvZdsNrIAF0TpIPkanvqGUUQqoPR+cw7genYgN52YGE7baHAjCvZdRbdnk1pvT3qL6HMYvxmfm/6iF21wrGxJ0L44b+nghAmR/V9teL1svLGffu/n3bv4PdfOy1Yb69rIW7bTj6UaXqjhwhbZIna37QUIHTcl4wh1nUt3zVCZPZ2Ru9CDF7IeXZiYxobAbJkqG1vJRM6XmxbBxMyzUNiq4dIzRZgHDfh2GU20GMklQrWLwpvXm33/dg/p1z7Vjp7pQyX/uuodNJD+6PGMVOjP0Cv8Dtvs3giiMdBPfygfIDZpt3/Fu+rNoCkLrO4n+Vz/a/MGdoRtrGgpybT0Q3I2hDa373VYpvr0Qb4XBCcgXc4/GelcKk0IbpgHbWbvVmo61dbP2NNfGzfzAYiQflJM+7YW4+ukd2pBqwdNxOH3V7d4YGW0onvkRk0ZDYkA4fccX+vL9szT3Pn4fN1oi0SesLHmxtDN2Lm+0E4QbLc3CdBni1CW5cOl5bJZtI5fUjSKgq0EbLi47V0e9zna30+2eXZxTQ6HjSj2aKirxXlgpXfQO+cbqhWAufTqn6qffe55WlAZXyw8znfAAWx0l/QlxfUKqLfn5ZzkRrI09y43KtBM/O8vEK5NKddZI1pfKuWQ5fiynDGcKfGquiKtTQ3XM8aNyvP4wmPporg/PCyfWpmZyYqh9dMrsvfAfx5BdFoNUCmJKnU+acT9DMy6cvEf/vBCawkLvgPr7Tio2NzvUhmVaSafJIa/pjC4o0cZau+AkFUYufIqEPCXO2Har9fDwsCN4VqiE7widEQypFKis50NJy8/lSrSmnGhhF9pS+98tg0M0qAS2SkO2RVbv5wyC3Z14Jw5Ja13GVeWgZwrUCmAL6jt8dK085dKPkd67aVm7buB+FxYU2K7aKutXPyrL0A1MpwNu8TeTzma0/JW+VVANXVatUF9hjDwJrAgpAseh5Wz3yKHFq6z+/KHaHDSOhMDcPSvbrxTky4tujxKr/ISa6YR0DH+gz6v8AdpwC7dARPTg+ELj16eQcjUqfE+CYJeynxeEznIKXy0W/mbz6qQmFS9//OgFWE/fofoJovI2jn6G5+Jf7YeYrw== +api: eJztWEtz2zYQ/iuYvThJaYt+5aGba8szblPbtVT34Gg6ELiSkJAAA4C2VQ3/e2cBSqJE2pFn2kPb+GQBu4vFt98+wDk4PrHQvYNrowVae6Gs40ogDCPQORrupFYXCXTBIjdi+sc+RGDwa4HW/aiTGXTnkKAVRuYkCV3oezmWB3tMVgYtRCC0cqgc6fA8T6Xw1jufLSnOwYopZpz+c7McoQt69BmFgwhyQ744iZZ2xzJ1aL4t9wVnNSGpHE7QQARjbTLuwtLbIyi9Hjl7i8bK4MuzSocHTaUBn9T0rDNSTUhqlGdqgW3SKpFzg8r9vL2zXv481Q+XOsFFwLbXt44bd8YdtnqDKnlyz7rWHVIqMiLRyeng4rYHEZxe/XL9sTfondH/J5envY+9MxiWEUglZFJxoLIy0jpFrmqQnuFYKknc2P5WDhVX7lmINyjubYOQRhQpN682dl97o9KlZGkzOQgL+SduSZSQOSfjddJyY/gMIpAOM9skc0mK2rjtNZppgmk7HNoka64049g/hQjOev1TGJY1HPrkUFlf+bVAM2uBBx95lqfBkZM0bZaJG3SFUZbxNG3WCvYqwTEvUseMF2OptI4R5Exath+/hgjueVpQBMgb8gsTNpqx5aXbT2ueZIMqtwJVItWEjKzn7OqoKiB3S2xhU7JC1gNYDmuucZWwnE8wYQ/STdmCPe1eZvyRHbb4yolCbGckJ7fcVMfueNNfcMbevjs+Pvzw4ehoPz4+fv8u/vbV2Cc10GyCjrkpMoWPzvvIhM5nfslfnOkx2yFbt/TL7jCpnGY7NVbvBMG9T4puy2yOQo6r6s7sVBdpwjLuxNQbrSmui64h7QE6jF4K+Ua23cEaWBBtguRjdO4bShWlgNrzwTmOm9GJ2HhhZjRj682BIDx4GdVWTW6zOR0sq89x/GJ8Sv9HLdzmWtmQoAdx3NLHCxEg+7va9mbZemE5+97Nv3fzf6ibV6021LeXtWinHU+3ulTNgRu0Reps0w8SOmpLxjPuOJPqnqcyeTojc6NHKWY/vDQziQmF3TJRMrSWT9optSiGrZthobFRw6VnjDZLGA6bMJxrM5JJgmodgzedN//+6x41r3upHTvXhUr+c9c9biP5yfUFq9GZoVf4H7DdvxFEYaSb+VY+Qm7Q7PqOdzcsozkIrb9I9L+G0fYP7gzdVNNQkGvrgeBuCl3o3O93KvHdpXgnDE5Avph7NNa7UpgUujAP2JbdTmc+1daV3XmujSv9wGIkH1WTPu2FuPrpHbqQasHTaTh93e3BFBltKJ75EZNGQ2JAOH3PF/rq/bMy9z5+H7daItEnrKx4sbIzdS5vtROEWy2VYboMceqTXLj0IjartpFL6kYR0NWgC1fXvZuTQW+33+v3L64uqaHQcZUeTRW1eC+tVC56h3xj9UKwkD5fUPWn3weeVpQGN6sPM73wAFsfJf0JcXNCaiz5+Wc1EWyMPauN2rQTPzvLxGuTSn3WSDaXqrlkNX6spgxnCnxqrojrU0N9zPGjcrz5MJj7aG4Oz0snNqZmcmKsfXSq7L3yH8eQXRejVApiSpNPmnE/QzMunLxH/7wQmsJC74Dm+04qtjA71oZlWkmnySGv6YwuKNGmWrvgJBVGLnyKhDwlzthup/Pw8LAneFaohO8JnREMqRSorOdDRcuP1Uq0oZxoYZfaUvvfHYNjNKgEdipDtkNW7xcMgv29eC8OSWtdxlXtoGcK1BpgS+o7fHSdPOXSj5Heu3lVu+7gfh+WFNit26rq1zCqytAdzOcjbvE3k5YlLX+lbxVUQ1dVK9RXmCJPAitCisBpaDm7A3Jo+SprPn+oNgeNEyEwd8/KDmsF+fqqP6DEqj6hZjohHcMf6PMqf4AuEAk9ML7I+LU5pFxNCt+PINikzOcFIbOawNcLhb/VojKpWc3D+TxIDPQXVCUV83AVR7/DW/EvcbmZKQ== sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search process instances

+ Search process instances -## Request - -

Body

- -Search process instances - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/search-2.api.mdx b/docs/apis-tools/operate-api/specifications/search-2.api.mdx index 56feec86ac4..2f928d8f61c 100644 --- a/docs/apis-tools/operate-api/specifications/search-2.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-2.api.mdx @@ -5,59 +5,223 @@ description: "Search process definitions" sidebar_label: "Search process definitions" hide_title: true hide_table_of_contents: true -api: eJzlWN9v2zYQ/leIe8nWKf6RJm0qDAPcNAXaDU1We9tDEgy0dLbZUqRKUkk9wf/7cCQty7aaJsNetr5Z5N3x+N3dd0fX4PjcQnoFl0ZnaO0rnAklnNAKbhLQJRpOH29ySMEiN9nizyNIwOCnCq17qfMlpDXkaDMjSq+WwtjLMfzMi1KihQQyrRwqR6K8LKXIvNH+B0vyNdhsgQWnX25ZIqSgpx8wc5BAacgFJ9DS7kxIh+brch9x2RISyuEcDSQw06bgLiw9O4ZVAooX2BK1zgg1p41bNFYE7+418/SoJT3h805j07JQEV8CskPCoeLKdW7SrnCSlvZjtErAir/wgW6GAI5m2yByY/gSEhAOC7sPLjlgtXEP19gPG8rua2uTb7kSdxJAVRWUlaPxGSTw6nx8BjdtJMbk0Kq98muFZtkJUJOHaQ0jKffzdSQlK4MmE8o6rjK07LscZ7ySjhHATFg2HHwPCdxyWRHedPaYdvSMGXSVUZgzKaz7Yj3sH8FVHnW9Jpnyh520zonxPfHnxTA8wjxFjk2XzCd626o3ddUEB6JAjIgHfnWzPjSYion2sNOTcDQJo8qFmq+9CFe1EbquqyZf9c4nxI57JZ8/xr02MI0+M2gr6ewmEj12rdhEszk65hbIFH52QTTT5dIvefdJ44Bs/k5f9oAJ5TQ7aFXcQRDsXSvvsi0xE7PIhMwudCVzVnCXLbzRluK26D/CK0RzhwCu4IxLiTmLVQMJHB2dDJ+/eHE6fPrs9PnR6TAU3WtPu5t02kc5SkyXLDLhVu5t01/L/w2fN3Q7bBjtZNBxr11Tu+m68pxg0JZa2VDyR4NBR1pUWbzyv9SadqnwkRT5DXWs2E5CnTyuDTntuHwQTi0X3oeS7vKExI670uMVd5wJdculyL+cI6XRU4nFD4/NFeu4q+wDA1WgtZHZ9mKwZrPuAPmF+4Jzbow2DQxPO8pam6nIc1TbGDzpP/nvX/d4/7rvtGOvdaXy/911T7qSfHT5hrXSmaFX+Aay3U/CWWWEW/rmMkVu0Bx6Dr66WSU1ZFp/FOi/bpL7J4q8IRTqJgW6haZGVWrroeBuASn0b4f9qHDYUuiHfgzkjyFG9u5URkIKdcB3lfb79UJbt0rrUhu38v3TCD6NEy3thdj6aRVSkDrjchHO33Z9skBGG37m0TM/aFAWhNN7hGPZjJhrc6eD00GnJRL9gpVNbmzsLJwrO+0E4U5LqzC0hFiNSS5ceh2fTfMoxc9I3SO0R7i4PH8/mpwfjs/H4zcX76it0HFRjxpcK+aNleiid4i+gxCspV+v0/XtHxOfWlQK7zcv4fPw0NiebPwJg8ax5oXTtOvBdjPeSOz04M3GpvW2CiAMTYPdGa/2CO6OUY2pnfmJYJppj0ismgv/DwCyy2oqRUbR2Y+hZtxPU4xnTtyGaTrTBIXDvONdIhRbm51pwwqthNPkkNd0RleU3AutXXCSCIlnPi1DbVCcbNrv393d9TJeVCrnvUwXBIMUGSrrYxAR/yWuJDvKuc5soy20/+4bnKFBlWE/GrL9rdkKhr1BbxAKxbqCq9ZB9xLDFmRNwjn87Pql5MI/VL1/deSMK7gdBi7dZQ1Yx5j+oQnlfwV1PeUWfzNytaLlT/QaJv7asEXgNlggz0NmhNSEs0D3hxNyqRnO94dh4sWgMcoyLN29sjctKry8GE8oneN/RYXOScfwO/ofid9BCtdwDZSMZbhfWof1GiRX88r3Awh2qep4Rfg0GO4Uqb/ZmhXUsuXljy+9AJvoj6h+giTextFneDz8DaxJhiw= +api: eJzlWFFz2zYM/is8vGTrFMtOmzbVm5emd912TVZ720Oa29ESbLGlSJWkkno6/fcdSFmWbTVNdnvZ+maRAAh+AD6ArsHxlYXkGq6MTtHaV7gUSjihFdxEoEs0nD7eZJCARW7S/M8TiMDgpwqt+1Fna0hqyNCmRpReLYGZl2P4mRelRAsRpFo5VI5EeVlKkXqj8QdL8jXYNMeC0y+3LhES0IsPmDqIoDTkghNoaXcppEPzdbmPuO4JCeVwhQYiWGpTcBeWnj+DJgLFC+yJWmeEWtHGLRorgnf3mnl60pOe89WgsUVZqBZfAnJAwqHiyg1u0q5wkpYOY9REYMVf+EA3QwCny10QuTF8DREIh4U9BJccsNq4h2schg3l8LW1yXZcaXciQFUVlJXT2TlE8Opidg43fSRm5FDTX/m1QrMeBKjLw6SGqZSH+TqVkpVBkwllHVcpWvZdhkteSccIYCYsm4y/hwhuuawIbzp7Rjt6yQy6yijMmBTWfbEeDo/gKmt1vSaZ8oed9s5p43vqz2vD8AjzFDm2WDOf6H2r3tR1FxxoBdqIeOCbm82hwVSbaA87PQpHkzCqTKjVxotwVdtCN3TV6Kve+YTYc6/kq8e41wem02cGbSWd3UZixN4rNtdshY65HJnCzy6Iprpc+yXvPmkckc3f6cseMaGcZke9ijsKgqP3yrtsS0zFsmVCZnNdyYwV3KW5N9pT3BX9R3iFaO4RwDWccykxY23VQAQnJ6eTFy9fnk2ePj97cXI2CUX32tPuNp0OUW4lFmvWMuFO7u3SX8//LZ93dDvpGO10PHCvfVP76dp4TjBoS61sKPmT8XggLaq0vfK/1Jr2qfCRFPkNday2nYQ6eVwbctpx+SCcei68CyU95AmJPRtKj1fccSbULZci+3KOlEYvJBY/PDZXrOOusg8MVIHWtsx2EIMNmw0HyC/cF5wLY7TpYHg6UNbaLESWodrF4En85L9/3WeH132rHXutK5X97657OpTk06s3rJfODL3CN5DtfhJOKyPc2jeXBXKD5thz8PVNE9WQav1RoP+6ie6fKLKOUKibFOhyTY2q1NZDwV0OCcS3k7hVOO4pxKEfA/ljiJG9O5WRkEAd8G2SOK5zbV2T1KU2rvH90wi+aCda2gux9dMqJCB1ymUezt91fZ4jow0/8+ilHzQoC8LpI8Kx7EbMjbmz8dl40BKJfsHKNje2dnLnykE7QXjQUhOGlhCrGcmFS2/is20epfgZqXuE9giXVxfvpvOL49nFbPbm8i21FTqu1aMG14t5Z6V10TtE30EINtKvN+n60x9zn1pUCu+2L+GL8NDYnWz8CePOse6F07Xr8W4z3krs9eDtxrb19gogDE3j/Rmv9gjuj1Gdqb35iWBaao9IWzWX/h8AZFfVQoqUonMYQ824n6YYT524DdN0qgkKh9nAu0QotjG71IYVWgmnySGv6YyuKLlzrV1wkgiJpz4tQ21QnGwSx3d3d6OUF5XK+CjVBcEgRYrK+hi0iP/SrkR7yplObacttP+ODS7RoEoxbg3ZeGe2gsloPBqHQrGu4Kp30L3EsANZl3AOP7u4lFz4h6r3r2454xpuJ4FL91kDNjGmf2hC+V9DXS+4xd+MbBpa/kSvYeKvLVsEboMceRYyI6QmnAe6P56TS91wfjgMEy8GjWmaYunulb3pUeHV5WxO6dz+V1TojHQMv6P/kfgdJECJWIa7JXVYq0Fytap8L4BgkyqOV4RNh99egfpbbRhBrXse1nWQmOuPqBoi0XAVR9/h5fA3aASGpg== sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search process definitions

+ Search process definitions -## Request - -

Body

- -Search examples - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/search-3.api.mdx b/docs/apis-tools/operate-api/specifications/search-3.api.mdx index 2c30e8922de..674fc83cd5e 100644 --- a/docs/apis-tools/operate-api/specifications/search-3.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-3.api.mdx @@ -5,56 +5,282 @@ description: "Search incidents" sidebar_label: "Search incidents" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/ivEfXG7qbGc9xjDANdWOrWp7NlOWiwNDFqiY7aSqJJU0szwfx+OlGU5VpoG24d1qz9Z5PHuufcjF6DptYL2JfhpyCOWarhyQGRMUs1F6kfQBsWoDOeTPXBAss85U/qliO6gvYCIqVDyDCmhDSNDR3jBSIEDoUg18mwvgGZZzEPDtflR4YEFqHDOEor/9F3GoA1i+pGFGhzIJGLQnCncnfFYM/k43Sd2VyHiqWbXTIIDMyETqu3S4T4szbmQKdVjM55yxPTmqUf9VGmahuzbD1qSklRpydNrcICleYIeOA9GA6/rn/peDxw4D94E/XcBOOD3J287g4EfvJp4w2F/CA687r+cBP3J0BsPfW8EDnjvve752O8HkzN/NPYCb7i53+0HPd/sr1h478fDTnc8ueicnXvlardzdub1Jt6Z99YLxuXyefBbJ+iZHVyZeBdeMAYH3nqjUeeVNxn5f3gT733X83oGfMGm53X9UVXoegHFdjYAnfaHbydBfzw57Z8HPbhaOpAwpeh1jdGWDoSSmWAa86SeQGmqv2rvTnfsX3iohf9q2Bkb4ENv1D+7MH8HXtDzg1cGyEcxfYKfWUpTjamzhQp3uY5xqcw3hMr/ZI8y39s1pCbJOrPNfKBS0jtwgGuWqO08QblKSP3tJ7YzkMV1CjkgZLQBZdvMo67x/KgLV1UDjBDQsrrye87kXdUu7AtNstgi6MTxdskZMp3LVBEax+u6Q55FbEbzWBNptknMlSZoY8IVabnPd8CBGxrnaHOUb7mQXZeU1qgXk9AvhmolqcqocOKuixxRNzK9I6XZ6vmtIaN3WESQjKURT6/xdKMa440NWcaZl6VfNrOhdIq1+tKY/dTU0CeBsmWXRQYLurexQ07xMGkUmdkgIU0bmkwZyRWLyEzI4hShaWS0qsLequP1dWVZwVuy2cK7VshiM6SNusLecL7FvjtfRfpAYazvI7C7e9A6Ojk5bu0dHh+2Do+gTMAn+WxArxkCLfpavb8yem1dlCvUK5PshotcFcHPItJAyReomWoQoyF5ZtL/+Wb8VivLZVWDo6Pjg0oMWWsac2dFdX56JP1db5XiIzKTIlmrva3tv8yx92r4Zetw//DE3XePD/ZPTpwT1z1qnZzsHuwf7e/tHh9fLc0PRy+ViVTZYrjrujXzVx4i5H9u7LrfG57YM35MYz+mse9vGisS2laQp41YWmgafxOsiuQhU3msVQUA7u7XJXiPakp4ekNjHj2c5ZkU05glPz8129FDuXoUvh1DvxYLvMjF2s36tKsaxJNSyNIMezWNX8gpjyKWbtrgp+ZP37+6+9vqBkKTU5Gn0X9O3YO6IO8MfFIJZ8LMgf9BtJvLXZhLru/MNDFlVDL5wnTRy6uls4BQiE+cma8r5/HHl4TpucB5JBPKGIDqObShedNqlmRNO4sAypY3TCojOpcxtGFhbblsN5uLuVB62V5kQuqlGackp9PiZoZ71o/m1gVtiEVI47mVuglzPGcEN1KaMCJmRM8ZQY9b6Tumo5fT/ordsXvs1nJC0ge4rONgzWeudVbLxxLXclragc36ZYR0VumVL9b9IePYlBxA1aAN/YGHbezFyBthj8XOgeKKc0tnw78llwKiAYTflghW1Ker0Hz9bmzCCMN+uH6U8+yFeXPQNRLch6Yst36GclfBe28QKlNh3cE3e/96vWj5686+6ttutStXZwRzg3bvD8gL44L7Q3YpZjVed+y1Ce08E8akRYr1zWsmI4N8GvMQ3bsdBIJQMzwTGmp+w8ztIhRoS7yIFAYiq1zHf2TFFu+8iUi5FgjInNRS5JgdcyF0YSORahqauLbJhY5W7Wbz9vZ2J6RJnkZ0JxQJmiHmIUuVcWIRS2fFinPvcCRCVZ7mwnw3JZsxydKQNQtGqolcMbmtsq0dd8e1maZ0QtOKoJoqsmGoMk41+6KbWUx5iowMqkVRYC7hpmWifc2jKDJXTlErLmGxmFLFzmW8XOLyZ3z5wcK2Li226MGc0chGgY1j6No+8GKMQMqL3fY9BwumPdEJQ5bpr9JeVarloD/CYXpavHEnIsIzkt7i+ze9hTZ8gA+AgWeMYqqBWV9ATNPr3GaH5YspSnO0Smm5exltNFuVkPSugvKXl4aAjMUnlv4KTqGNxk/zPrD8C/QS51o= +api: eJztWN1z2jgQ/1c0+0J75waT7/BGwem5TQ0HJO1cJsMIWwS1tuVKctIc4//9ZiVjTHA/MncP17vyhKXV7m+/V1qBprcKutfgpyGPWKrhxgGRMUk1F6kfQRcUozJczg7AAck+5UzplyJ6gO4KIqZCyTOkhC5MDB3hJSMFDoQi1cizuwKaZTEPDdf2B4UHVqDCJUso/tMPGYMuiPkHFmpwIJOIQXOmcHfBY83kt+k+socaEU81u2USHFgImVBtl44PoTDnQqbUgC14yhHTm6ce9VOlaRqy7z9oSSpSpSVPb8EBluYJeuAymIy8vn/uewNw4DJ4EwzfBeCAP5y97Y1GfvBq5o3HwzE48Hr4chYMZ2NvOva9CTjgvff6l1N/GMwu/MnUC7zx9n5/GAx8s79m4b2fjnv96eyqd3HpVav93sWFN5h5F95bL5hWy5fBb71gYHZwZeZdecEUHHjrTSa9V95s4v/hzbz3fc8bGPAlm4HX9yd1oZsFFNvbAnQ+HL+dBcPp7Hx4GQzgpnAgYUrR2wajFQ6EkplgmvKkmUBpqr9q715/6l95qIX/atybGuBjbzK8uDJ/R14w8INXBsgHMX+Cn1lKU42ps4MKd7mOcanKN4TK/2TfZH6wb0hNkvUW2/lApaQP4ADXLFG7eYJylZD6+0/sZiCLmxRyQMhoC8qumSd94/lJH27qBpggoKK+8nvO5EPdLuwzTbLYIujF8W7JGTOdy1QRGsebukOeRWxB81gTabZJzJUmaGPCFem4z/fAgTsa52hzlG+5kH2XVNZoFpPQz4ZqLanOqHTivoscUTcyfyCV2Zr5bSCjd1hEkIylEU9v8XSrHuOtLVnGmdeVX7azoXKKtXphzH5uauiTQNmyyyKDBd3b2iPneJi0ysxskZCmLU3mjOSKRWQhZHmK0DQyWtVh79Tx5rpS1PBWbHbwbhSy2Axpq6mwt5zvse/eV5F+oTA29xHY3z/qnJydnXYOjk+PO8cnUCXgk3w2orcMgZZ9rdlfGb21LsoV6pVJdsdFrsrgZxFpoeQr1Ey1iNGQPDPp/3w7fuuV5bquwcnJ6VEthqw1jbmzsjo/PZL+rrcq8RFZSJFs1N7V9l/m2Ec1/LpzfHh85h66p0eHZ2fOmeuedM7O9o8OTw4P9k9Pbwrzw9FLZSJVthjuu27D/JWHCPmfG7se94Yn9oyf09jPaezHm8bKhLYV5Gkjlhaaxt8FqyZ5zFQea1UDgLuHTQk+oJoSnt7RmEdfzvJMinnMkl+fmu3ooVx9E74dQ78WC7zMxcbN5rSrG8STUsjKDAcNjV/IOY8ilm7b4Jf2Lz++uoe76gZCk3ORp9F/Tt2jpiDvjXxSC2fCzIH/QbSby12YS64fzDQxZ1Qy+cJ00eubwllBKMRHzszXjfPtx5eE6aXAeSQTyhiA6iV0oX3XaVdkbTuLAMqWd0wqIzqXMXRhZW1ZdNvt1VIoXXRXmZC6MOOU5HRe3sxwz/rR3LqgC7EIaby0UrdhTpeM4EZKE0bEguglI+hxK33PdPRq2l+zO3VP3UZOSPoFLps42PBZap018rHEjZwKO7BZv0yQziq99sWmP2Qcm5IDqBp0YTjysI29mHgT7LHYOVBcea5wtvxbcSkhGkD4bYlgTX2+Ds3X76YmjDDsx5tHOc9emLcHXSPB/dKU5TbPUO46eB8NQlUqbDr4du/frJctf9PZ133brXfl+oxgbtDu4wF5ZVzweMiuxKzH6569NqGdF8KYtEyxoXnNZGSUz2Meont3g0AQaoZnQkPN75i5XYQCbYkXkdJAZJ3r+I+s2eKdNxEp1wIBmZNaihyzYymELm0kUk1DE9c2udDRqttu39/f74U0ydOI7oUiQTPEPGSpMk4sY+miXHEeHY5EqKrTXJjvtmQLJlkasnbJSLWRKya3Vbaz5+65NtOUTmhaE9RQRbYMVcWpZp91O4spT5GRQbUqC8w13HVMtG94lEXmxilrxTWsVnOq2KWMiwKXP+HLDxa2TWmxRQ+WjEY2CmwcQ9/2gRdTBFJd7HbvOVgw7YleGLJMf5X2plYtR8MJDtPz8o07ERGekfQe37/pPXQBg84YxFQCs7aCmKa3uc0MyxPTk+Zokcpqj7LZaLUuH+lDDeFqZSmm4iNLC6y4VhWN3+ZxoPgLjDTn1A== sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search incidents

+ - + Search incidents -## Request + -

Body

+ -Search incidents - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error + -
Schema
+ diff --git a/docs/apis-tools/operate-api/specifications/search-4.api.mdx b/docs/apis-tools/operate-api/specifications/search-4.api.mdx index cac9c73f3f8..44f591cd6d8 100644 --- a/docs/apis-tools/operate-api/specifications/search-4.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-4.api.mdx @@ -5,59 +5,305 @@ description: "Search flownode-instances" sidebar_label: "Search flownode-instances" hide_title: true hide_table_of_contents: true -api: eJztWVtz4jYU/isavaQXb3CyZJMwnc444LR0WUOxSdpJGUbYIqhrJCrJyVKG/945krENOLtJZx962X1ZJB2d+/l0jrPGmtwr3LrD16l45CKhXa404THFYweLJZVEM8G7CW5hRYmM55MmdrCkf2RU6SuRrHBrjROqYsmWQIlbODR0aJYzfMVyjgo7OBZcU67hElkuUxYb9o3fFdxcYxXP6YLAL71aUtzCYvo7jTV28FKCMppRBaczlmoqP033nq4qRIxrek8ldvBMyAXRdutNE2/MvZgqtbX+7UsvduiMcQbGPP+q0kTqDtG0Qq+0ZPweTilPnjwD3wYQrOSjxwFZ1N9nPGYJ5fr5ulqSfVagZbaA9BkF4cBvd6+7fgc7eDDst/0wxA4OR1eTcuXf+EE02d0LI28YTcwJdnA3iPzhO7/T9SJ/0vai9o/1R9GPw/5tcXTVHwUdb/hrseEHneJ36A9vum1/EnnhW+zgod/2uzfFchT6w+3vd14w8nrbVf6f/0u7Nwrhxg9e5N96vxpVDvcG3tDr9fxeZcuae+WFfqeyG/o/j/yg7U+ue/1bkDrqRd1JNwgjD3av+h2ganu93sRrR92bbgTrq1HYDfwwnAxHvUL5sD3sDqJiBVZvzQreBv3bAI9tntXlURk8I8YHof13g54fmRiCs7uBB4txJWUqfKZCpJRwkx6UE65r0xFOmU5h63qbtluMAeXYn/STOfj61JAaYPFmu6VPpCQr7GCm6UIdQgLIV0Lq5984BBua1teZkMmOKoeODdvYwR0/bONx1REhKLSp7vycUbmq8w/9QBbL1Gripekh3A6pziRXiKRpgbmowFz0VUJnJEs1koYOpUxpBE5HTKET9+tj7OAHkmYQBFDIskOnLircUy9vQT4YqjwvVJVRHtVTFziCsWi6QoUf6/nV6A5xowkCesoTxu+BzVEOjEc78kyE74pgFehZBMlGYWPCcG2ej7+nk316aGJU2Rp/tGN8+TqVRaNlRjcV2YQnaJuWu7JL5Ur2yHnCF8UT8kwNnENPla9Qra8G5J6CqPwprffTktxbj2QKNFtK+sBEpvKcowk6ArE3oJ46QkZN9JUpw6+PUXsuhKKIcEQ/MKWBwXu6QjMpFiUnW/tUIS2Qliuk52wv46rgcHd6enZyfnl5cfL6zcX5+cVZJezWlSYAoPZnCH4ZHfJEcAppyZ5Zh375rHH0TBj3kPPu5E3zzaXbdC/OmpeXzqXrnp9cXp6eNc+br08vLsYb8w+aPLUUXFnoOXXdmk4vi6H3+Xx93T4ivxCpv7R7X9q9L+3eP7jdy3HLAt7LejgtNEmflb0VDYZUZalWNYoAVbMO0zpEE8T4A0lZ8jSwLaWYpnTx7UsBDmKTqU+aYfvdBVUqf6FqSjo3pe6wvnqrjvGlFLJww+uaLkTIKUsSynd98E3jm3+/uc1DcwOh0bXIePKfM/esLsm9QRdV0hlRc+F/kO1miowzyfTKNE9TSiSVr0zjcDfeOGscC/GeUbMaOy/4srWgei6gD1sKZTxB9By3cOPhpHFI37ANGQZt5AOVyiiTyRS38Np6d9NqNNZzofSmtV4KqTemL5SMTPNhEM5sZM18h1s4FTFJ51b8ruLRnCI44GRBkZghPacIcsBKPzaNTTGMbNlduBduLScgfYJLmRkln7nWy1o+lriW08Z2rTZSIdBZo7fRKV+OJYOuxsHcND+4P/CHXuS/Cv0w7PYDeFNAXH5v4+xEvOCSq2gUMk+dIcJb6uttsv50G5nEgkIYlt9AfTuj73bsRoJb32q6TzWS7k6bWH26k/2talN4uGt7wXJ/pwV0t0Wz18flnUPZIOxOHdV3v1J/dtZ396eMtQnh4ZSSK7Q7opganwkTkrxo++bjM0WDbJqyGNLjMIkEImYCQSTW7IGaMSsWEAuYxnIXV+Y3xtGW7UxItBCcaQEKmZtaigyqay6EtkoCHpLY1IUtTkgU1Wo0Hh8fj2OyyHhCjmOxADekLKZcmSTIc7GX7zh7lxMRq+I2E2bdkHRGJeUxbeSMVAO4AjhYY0+O3WPXVqrSC8Irgj6GSzseKxJe0w+6sUwJM+2cUW+dQ9YdfjjJE+mAWQ5bYydHnzu8Xk+JoiOZbjaw/Qd8xgLwLMHKAiueU5LYvLCVgdv2rXkVgUbFzHs4PgIo2xteHNOl/ijtuALEg34I88A0/yPFQiRwR5JH+AMGecQt/Bv+DUMqGu8YfDH7a5wSfp+ZxwhbvlD0JAP3lO3wLkYYy7agxFcVLb+7MgQoEu8p/x47uTUaluYjy+YvhYB+Tg== +api: eJztWd1z4jgS/1dUesnunic4GTJJeHPAuWWHMSw2yW2lKErYImjHllhJToaj+N+vWjK2AWcmuZqH+5h5GSS1+rt/6nY2WJNHhTsP+DYVz1wktM+VJjymeOpgsaKSaCZ4P8EdrCiR8XLWxg6W9K+cKn0jkjXubHBCVSzZCihxB4eGDi0Khu9YwVFhB8eCa8o1XCKrVcpiw771p4KbG6ziJc0I/NLrFcUdLOZ/0lhjB68kKKMZVXC6YKmm8tt0n+m6RsS4po9UYgcvhMyItlsf2nhr7sVUqZ31H996sUcXjDMw5vVXlSZS94imNXqlJeOPcEp58uIZ+DaAYCVfPQ5I1nyf8ZgllOvX62pJDlmBlnkG6TMJwpHf7d/2/R528Gg87PphiB0cTm5m1cq/84Notr8XRt44mpkT7OB+EPnjT36v70X+rOtF3V+bj6Jfx8P78uhmOAl63viPcsMPeuXv0B/f9bv+LPLCj9jBY7/r9+/K5ST0x7vfn7xg4g12q+I//x/dwSSEG3/3Iv/e+8Oocrw38sbeYOAPalvW3Bsv9Hu13dD/feIHXX92Oxjeg9TJIOrP+kEYebB7M+wBVdcbDGZeN+rf9SNY30zCfuCH4Ww8GZTKh91xfxSVK7B6Z1bwMRjeB3hq86wpj6rgGTE+CB1+Gg38yMQQnN0PPFhMaylT4zMXIqWEm/SgnHDdmI5wynQKW7e7tN1hDCjH/km/mYPvzw2pARZvsV/6REqyxg5mmmbqGBJAvhJSv/7GMdjQtLnOhEz2VDl2bNjFDu75YRdP644IQaFtfef3nMp1k3/oF5KtUquJl6bHcDumOpdcIZKmJeaiEnPRTwldkDzVSBo6lDKlETgdMYXO3J9PsYOfSJpDEEAhyw6du6h0T7O8jHwxVEVeqDqjIqrnLnAEY9F8jUo/NvNr0B3iRhME9JQnjD8Cm5MCGE/25JkIP5TBKtGzDJKNwtaE4dY8H/+eTvbpoYlRZWf8yZ7x1etUFY2WOd3WZBOeoF1a7suulKvYI+cFX5RPyCs1cI49Vb1Cjb4akUcKooqntNlPK/JoPZIr0Gwl6RMTuSpyjiboBMTegXrqBBk10U+mDH8+Rd2lEIoiwhH9wpQGBp/pGi2kyCpOtvapQlogLddIL9lBxtXB4eH8/OLs8vr66uz9h6vLy6uLWtitK00AQO3vEPwqOuSF4JTSkgOzjv3yXePomTAeIOfD2Yf2h2u37V5dtK+vnWvXvTy7vj6/aF+2359fXU235h80eWoluLLQc+66DZ1eHkPv8/36ukNEfiNS/2j3frR7P9q9/+B2r8AtC3hv6+G00CR9VfbWNBhTladaNSgCVO0mTOsRTRDjTyRlycvAtpJintLsb28FOIhNrr5phu13M6pU8UI1lHRhStNhc/XWHeNLKWTphvcNXYiQc5YklO/74JfWL//95raPzQ2ERrci58n/nLkXTUnujfqols6Imgv/B9lupsg4l0yvTfM0p0RS+c40Dg/TrbPBsRCfGTWrqfOGL1sZ1UsBfdhKKOMJope4g1tPZ61j+pZtyDBoI5+oVEaZXKa4gzfWu9tOq7VZCqW3nc1KSL01faFkZF4Mg3BmI2vmO9zBqYhJurTi9xWPlhTBAScZRWKB9JIiyAEr/dQ0NuUwsmN35V65jZyA9AUuVWZUfJZarxr5WOJGTlvbtdpIhUBnjd5Fp3o5Vgy6Ggdz0/zg4cgfe5H/LvTDsD8M4E0BccW9rbMX8ZJLoaJRyDx1hgjvqG93yfrbfWQSCwphXH0D9e2Mvt+xGwluc6vpvtRIunttYv3pTg636k3h8a7tBav9vRbQ3RXNQR9XdA5Vg7A/ddTf/Vr92VnfPZwyNiaEx1NKodD+iGJqfCFMSIqiHZqPzxSN8nnKYkiP4yQSiJgJBJFYsydqxqxYQCxgGitcXJvfGEc7tgshUSY40wIUMje1FDlU11IIbZUEPCSxqQtbnJAoqtNqPT8/n8Yky3lCTmORgRtSFlOuTBIUuTgodpyDy4mIVXmbCbNuSbqgkvKYtgpGqgVcARyssWen7qlrK1XpjPCaoK/h0p7HyoTX9IturVLCTDtn1NsUkPWAn86KRDpiVsDW1CnQ5wFvNnOi6ESm2y1s/wWfsQA8K7CywIqXlCQ2L2xl4K59a95FoFE58x6PjwDK9oYXx3Slv0o7rQHxaBjCPDAv/kiRiQTuSPIMf8Agz7iDIQ2NZwy2mL0NTgl/zM1DhC1PKHiSg2uqVngfH4xVO0Di65qGm42liMRnyreA4dYUDWvzhWX7L1jVfsg= sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search flownode-instances

+ Search flownode-instances -## Request + -

Body

+ -Search flownode-instances - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error + -
Schema
+ diff --git a/docs/apis-tools/operate-api/specifications/search-5.api.mdx b/docs/apis-tools/operate-api/specifications/search-5.api.mdx index 30256e1e35f..c854450ecb9 100644 --- a/docs/apis-tools/operate-api/specifications/search-5.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-5.api.mdx @@ -5,56 +5,227 @@ description: "Search decision requirements" sidebar_label: "Search decision requirements" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/ivEfcnWqZad1l0qDAPcNgWyDU0We9uHJBho6mxzlUiVpJx6hv77cKQsy7bcJsW+7OWbRN4dH97LcyetwfG5heQG3qCQVmp1jR9KaTBH5SzcRaALNNxJrS5SSMAiN2Lx+xAiMPihROte6XQFyRpStMLIgiQhgbGXY/iR50WGFiIQWjlUjkR5UWRSeKPxH5bk12DFAnNOT25VICSgp3+gcBBBYQiCk2hpdyYzh+bzcjJtyVhnpJpDFcF7XLXWpXI4RwMRzLTJuQtLL56TZNrhj4tuo4rn2LmxRGNluN8nT3x2StIGrS6NwHfHzDlUXLlOELQrXUZLnYGsIrDyT3wgkhDl0WzX09wYvoIIpMPcHkaAMFht3MM1DmOLWbeHtUl3oNQ7EaAqc8re0fg1RPDmfPwa7trOGBOgqr3yc4lmdcxHTb4maxhl2WFej7KMbTKDmZY2+yrFGS8zx8jPTFo26H8NESx5VpLbCcKYdvSMGXSlUZiyTFp3tHa6j+EqrfW9NpnzBw5bZ9WhHvoz64g88ggKJONWoEqlmrPpivkkb5/hDd80UYNaoA6Vj0h1t4EQjNYZ+HAsUQBCCrtIokc5IvosWp85e3ALPv8yuAd+20FLZrdoe7dqotkcHXMLZAo/Oi8QMaGLlV/zlyGFEzL+K73ZEyaV0+ykVagnQbB3q/wFbIFCzmqWZXahyyxlOXdi4Y22FHdFe1/kvhDsPeK4gQu11FIge1VaqdBatqk7aginp8PBty9fng2evTh7MRz2Q+G+9fy+zcHDANQS0xWr6XUrPF2xI7TdutS2gzT0PGjocdjvuOxRm/u5XnmmMWgLrWxgkdN+vyOHSiHQ/o1dcZ9gH0m8/zfL3UZQd7JQa4/rgE47nj3Iay0U12jLzNkjYEjyeVcaveGOM6mWPJPp8VwqjJ5mmH/z2JyyjrvSPjAcOVpb0+VBJKSyjitxJEx+4VMhOjdGm8YNzzoIQZupTFNUuz54Ej/551/3+eF132nH3upSpf+66w67knx0dcFa6czQK/wHst3P4aI00q18N5oiN2ieelK+uauiNQit30v0b3fRI8YUoBu4habeVmjrncHdAhKIl4M4NWkc+jgQAkO87AGUJoME1sGjVRLH64W2rkrWhTau8i3WSD6tx2faC9H0YzEkkGnBs0U4bxfsZIGMNqg30KRDEwrFPZzeI88VzRy7MXfWP+t3WiLRI1a22bC1s3Cu6LQThDstVWHYCdEZk1y49CYi245RyB+RWkZoe3B5dX49mpw/HZ+PxxeX76iX0HG1XhXtRLmxUkP0gOg9CMFG+u0mQX/4beKTiZL/evt5fh6+anaHH5m2v6P8ef3jjXwrWV+keW/adn+/KW9ltr24VQth4OrvD41r79r9EawxtTdykf9m2ruqLqBL/78C2VU5zaSgsB0GVzPuBzDGhZNL9AOk0OQjhykrjPabm0qmJ7YxO9OG5VpJpwmQ13RGl5T1C61dAEncxIXP11A0FECbxPH9/X1P8LxUKe8JnZMbMilQWR+c2rU/1SvRnnKqhW20pfbvscEZGlQC49qQjXeGKRj0+r1+qCDrcq5aB32GI3ac1uSiw48uLjIuFRn1CNc1fdzAckB6JoVNVOkPUmCCG1ivp9ziLyarKlr+QB/iRF5b4gjEBgvkaciFkJfwOnD90wlBaEb5w4mZSDFojITAwn1S9q7FgleX4wmVU/0vK9cp6Rh+T/+5+D0kcAu3QOnn3eFr3a+vIeNqXvpmAMEuFSAvyR+Nz/bq1d9sQxBq1UL53SsvwCb6ParvN3UJjl7DF8ZfAH7Cog== +api: eJztWEtz2zYQ/iuYvbhNGT0cK3V4UxJnxm0mdi21PTieDgSuJCQkwACgHJXD/95ZgKIoiUrsTC993Ehgd/FhH98uWYLjCwvxLbxGIa3U6gY/FdJghspZuItA52i4k1pdJhCDRW7E8o8RRGDwU4HWvdTJGuISErTCyJwkIYaJl2P4mWd5ihYiEFo5VI5EeZ6nUnij/Q+W5EuwYokZpye3zhFi0LMPKBxEkBuC4CRa2p3L1KH5upxMWjLWGakWUEXwEdetdakcLtBABHNtMu7C0vMzkkw6/HHZbVTxDDs3VmisDPf74onPTknaoNWFEfjumDmHiivXCYJ2pUtpqTOQVQRW/okPRBKiPJ7vepobw9cQgXSY2cMIEAarjXu4xmFsMe32sDbJDpR6JwJURUbZO568ggheX0xewV3bGRMCVLVXfinQrI/5qMnXuIRxmh7m9ThN2SYzmGlps+8SnPMidYz8zKRlw8H3EMGKpwW5nSBMaEfPmUFXGIUJS6V1R2un+xiuklrfa5M5f+CodVYd6pE/s47II4+gQDJuBapEqgWbrZlP8vYZ3vBtEzWoBepQ+YhUdxsIwWidgQ/HEgUgpLCLJHqUI6KvovWZswc354tvg3vgtx20ZHaLtvdeTTVboGNuiUzhZ+cFIiZ0vvZr/jKkcELGf6M3e8KkcpqdtAr1JAj23it/AZujkPOaZZld6iJNWMadWHqjLcVd0d43uS8Ee484buFSrbQUyF4WViq0lm3qjhrC6elo+OOLF+fDZ8/Pn49Gg1C4bzy/b3PwMAC1xGzNanrdCs/W7Ahtty617SANPQ8behwNOi571OZ+rleeaQzaXCsbWOR0MOjIoUIItH9jV9wn2EcS7//NcrcR1J0s1NrjOqDTjqcP8loLxQ3aInX2CBiSPOtKo9fccSbViqcyOZ5LudGzFLMfHptT1nFX2AeGI0Nra7o8iIRU1nEljoTJL3wpRBfGaNO44VkHIWgzk0mCatcHT/pP/vnXPTu87jvt2BtdqORfd91RV5KPry9ZK50ZeoX/QLb7OVwURrq170Yz5AbNU0/Kt3dVVILQ+qNE/3YXPWJMAbqBW2rqbbm23hncLSGG/mrYT0zSD30cCIEhXvYACpNCDGXwaBX3++VSW1fFZa6Nq3yLNZLP6vGZ9kI0/VgMMaRa8HQZztsFO10iow3qDTTp0IRCcQ+n98hzeTPHbsydD84HnZZI9IiVbTZs7SydyzvtBOFOS1UYdkJ0JiQXLr2JyLZj5PJnpJYR2h5cXV/cjKcXTycXk8nl1TvqJXRcrVdFO1FurNQQPSB6D0KwkX6zSdCffp/6ZKLkv9l+nl+Er5rd4Ucm7e8of97geCPfStYXad6btj3Yb8pbmW0vbtVCGLgG+0Nj6V27P4I1pvZGLvLfXHtX1QV05f9XILsuZqkUFLbD4GrG/QDGuHByhX6AFJp85DBhudF+c1PJ9MQ2ZufasEwr6TQB8prO6IKyfqm1CyCJm7jw+RqKhgJo437//v6+J3hWqIT3hM7IDakUqKwPTu3at/VKtKecaGEbban9e9/gHA0qgf3akO3vDFMw7A16g1BB1mVctQ76CkfsOK3JRYefXT9PuVRk1CMsa/q4hdWQ9EwCm6jSH6TABLdQljNu8VeTVhUtf6IPcSKvLXEEYoMl8iTkQshLeBW4/umUIDSj/OHETKQYNMZCYO6+KHvXYsHrq8mUyqn+l5XphHQMv6f/XPweYqDU867wde7XSki5WhS+EUCwScXHC/JF46+9WvW32pCDWrcQlmWQmOqPqKpqU5Tg6D18XvwFBsjDHA== sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search decision requirements

+ - + Search decision requirements -## Request - -

Body

- -Search examples - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/search-6.api.mdx b/docs/apis-tools/operate-api/specifications/search-6.api.mdx index eefeae0235d..ecbb9053d29 100644 --- a/docs/apis-tools/operate-api/specifications/search-6.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-6.api.mdx @@ -5,59 +5,317 @@ description: "Search decision instances" sidebar_label: "Search decision instances" hide_title: true hide_table_of_contents: true -api: eJztWW1PGzkQ/ivWfOGutySBFo5Gp5NSCFKuCDiStidBVJndCfF1Y29tL5CL8t9PY+9bNgsNbT/cC98Se94883jmcbIAy28MdC/hCENhhJIDaSyXIcI4AJWg5pYWI+iCQa7D6cd9CEDj5xSNfaOiOXQXEKEJtUhIErowdHIM7/ksidFAAKGSFqUlUZ4ksQid0fafhuQXYMIpzjh9svMEoQvq+k8MLQSQaArBCjS0OxGxRf1lORFVZIzVQt7AMoBPOK+sC2nxBjUEMFF6xq1f2n9FksZyi+s2AkCZzihZx73BSf8IAui/7528643c53enb0/PPpy6T8Pz/uHgeNA/gvEyALzlcerOfNRoeEXkmIs41c1SiVYhGnOEEyEFCb/d+EyZal7ezRWjHBjNWc23y5i+IHjKZ82HywXeozbCI+PR8F7uVrVGTvThkh31DwfDwdnpx1HvzUkfAjgZjPoXvZOP/T/OL/pD2qpVrqwo1VCjSWP7WO0wGsgktaYiw7XmcwhAWJyZrwaufChj5LdpZxmAFTampfq1diE6iSLqs9T+M8IOQKcxPgAftyUjvN8IF49kwB/Xi6Dk0jY6fMSA6xDiL9wQoL5t9iarresLKSb/Rmn79UWZCIybM6l0tBLK2lXpDQ8hgKP+8BDG1UQMKaBldeX3FPW8KT9F8+8uoBfH60OiF8csv7pMZJqG/RDhhKexZZRgJgzb6fwIJWLI95B21IRptKmWGLFYGPvgFGrwwWWUKTtVsuW87VUcZQXecw6zOjzFPtWOcROijIS8YddzttL+qo6c9cuiYFATzKrlirIc5/F4JxkINwws8FGRdHNYwZNSE2wcukNSLfaE33xF7A9mdCV0sl2G3rqSI8Vu0DI7RSbx3jqBgIUqmbs1dzJS2CIn7+mb2WJCWsW2Krd3ywu2rqQ7hUkwFJOMyzAzVWkcsRm34dQZrSiuira+KZceBrWucgkDeatEiOww5sYUriCA3d29nZ9fvz7Yebl/sL+31/E3+tgxqRKp65XIJCppzsZyqVTZG0TVQ5U8bW2k7xS9c6/zyKGdvTryl671aDSJksa3lt1OpwFEaUhM5/vxznrH/T7j8ZmOPtPRZzr6TEe/nY5mXNEPrqdxTKssjze6eZUILhz2TEMgJPWqqScfccuZkLc8FtHDjTnR6jrG2U9PbdDUIFOz4Q2doTEZ+Viras43Gjdt45WuJqavtdJFGl42TFWlr0UUoVzNwYv2i3//cV+tH/dUWXasUhn954671wTy3vmAVeDM0Cn8D9DuXrlhqoWdOzp3jVyj3nYM53K8DBYQKvVJoPs2DjYl/UDh26kiZpgo4zLB7RS60L7daefy24V825NioGj0LWrjgkl1DF1Y+Owuu+32YqqMXXYXidJ26XirFvw6e6zSnq+se4dCF2IV8njq3a8GPpoiow2aLPR8INpPGPDeW47mFG/H3NxB56DTaIlEH7BSIqO0M7U2abTjhRstLf3LwVdqSHL+0Hl1ysmRCGJk+dCEs/P+RW/U3x4WzESQu0xvGaxUvLCShegCou9eCHLp4xysv30YOWDRRbgof1nu+98QVl8UIqqyKeevUzDkkgjXKW6FgK0z23KzmdB2mulqZ5WMllaaOej6vqee6+sF4+zU+eQ6bcx54NoBS/p3Wc+arPnNCFBxx8dNbOypVkr2VFvxpKlDXkrCU2k8/nnYqT9xFw679QdjYbr2WCSATpTDYtatztx/GcjO0+tYhHQv1m+PYtw9HRkPrbhF99QNFYHQYsQyDFR+6RGS5WYnSrOZksIqCshpWq1SaitTpawPkgYBD11D8F2Jbojpttt3d3etkM9SGfFWqGaUhliEKI1Df5bpk2wlqClHKjSFtlDue1vjBDXKENuZIdN2XDeHFuy0Oq2Ob1HGzrisOHqsIa9krLjpFu9tO4m5kGTRhbfIevUl3O5UsL1dNZb163GQtd1LWCyuucF3Ol4uafkz/b5IU6Ps0n6iwBR55HHhmwAc+iG77S5Kica1dz9NI6/RC0NM7KOy48oEOj8bjqh3Zf95zVREOprfEbD5HXThCq6AoOiy4xqrW19AzOVN6qYweLvU7XhK6SlSWGuO7mR5N5bzSpS/vHECbKQ+ofw1b4Jg6av/neRvuEiA2w== +api: eJztWdtSGzkQ/RVVv7CbHWxDAkv85mBT5V0KWOwkW0VcKTHTxkrG0kTSAF6X/32rpbl5PBCT5GEvvNlS39R91H1kL8HyGwPdK+hjKIxQciiN5TJEmASgEtTc0mIEXTDIdTj7eAgBaPySorFvVLSA7hIiNKEWCUlCF0ZOjuE9nycxGgggVNKitCTKkyQWoTPa/mRIfgkmnOGc0ye7SBC6oK4/YWghgERTCFagod2piC3qr8uJqCJjrBbyBlYBfMZFZV1IizeoIYCp0nNu/dLhK5I0llvctBEAynROyTrpDU8HfQhg8K53+rY3dp/fnv1+dv7+zH0aXQyOhyfDQR8mqwDwlsepO3O/0fCayAkXcaqbpRKtQjSmj1MhBQn/vvWZMtW8vNsrRjkwmrOab5cxfUXwjM+bD5cLvENthEfGo+G93K9qjZ3owyXrD46Ho+H52cdx783pAAI4HY4Hl73Tj4M/Ly4HI9qqVa6sKNVQo0lj+1jtMBrKJLWmIsO15gsIQFicm28GrnwoY+S3aWcVgBU2pqX6tXYhOoki6vPU/jPCDkCnMT4AH7clI7zfChePZMAf14ug5NI2OnzEgOsQ4i/cEqC+bfam663rKykm/0Zp++1FmQqMmzOpdLQWysZV6Y2OIYD+YHQMk2oiRhTQqrryR4p60ZSfovl3l9CL480h0Ytjll9dJjJNw36KcMrT2DJKMBOG7XV+hhIx5HtEO2rKNNpUS4xYLIx9cAo1+OAyypSdKtly3g4qjrICHziHWR2eYp9qx7gJUUZC3rDrBVtrf1VHzvpVUTCoCWbVckVZTfJ4vJMMhFsGFvioSLo5rOBJqQm2Dt0hqRZ7wm++IfYHM7oWOtkuQ299kGPFbtAyO0Mm8d46gYCFKlm4NXcyUtghJ+/om9lhQlrFdiq3d8cLtj5IdwqTYCimGZdhZqbSOGJzbsOZM1pRXBdtfVcuPQxqXeUKhvJWiRDZccyNKVxBAPv7B3u/vn59tPfy8Ojw4KDjb/SJY1IlUjcrkUlU0pyN5VKpsjeMqocqedrGSN8reudB55FDO3t15K9c69FoEiWNby37nU4DiNKQmM6P4531jvtjxuMzHX2mo8909JmOfj8dzbiiH1xP45hWWR5vdfMqEVw67JmGQEjqVVNP7nPLmZC3PBbRw4050eo6xvkvT23Q1CBTs+UNnaMxGfnYqGrONxo3beOVriZmoLXSRRpeNkxVpa9FFKFcz8GL9ot//3FfbR73TFl2olIZ/eeOe9AE8t7FkFXgzNAp/A/Q7l65YaqFXTg6d41co951DOdqsgqWECr1WaD7Ngm2Jf1A4duZImaYKOMywe0MutC+3Wvn8ruFfNuTYqBo9C1q44JJdQxdWPrsrrrt9nKmjF11l4nSduV4qxb8Onus0p6vrHuHQhdiFfJ45t2vBz6eIaMNmiz0fCDaTxjw3luO5hRvx9zcUeeo02iJRB+wUiKjtDOzNmm044UbLa38y8FXakRy/tB5dcrJkQhiZPnQhPOLwWVvPNgdFcxEkLtMbxWsVbywkoXoAqLvXghy6ZMcrL+9Hztg0UW4LH9ZHvjfENZfFCKqsinnr1Mw5JII1yluhYBtMttys5nQdprpamedjJZWmjno5r6nnpvrBePs1PnkJm3MeeDGAUv6d1XPmqz5zQhQcccnTWzsqVZK9lRb8aSpQ15KwlNpPP552Kk/cZcOu/UHY2G69lgkgE6Vw2LWrc7dfxnILtLrWIR0LzZvj2LcPR0ZD624RffUDRWB0GLEMgxUfukRkuVmp0qzuZLCKgrIaVqtUmorM6WsD5IGAQ9dQ/BdiW6I6bbbd3d3rZDPUxnxVqjmlIZYhCiNQ3+W6dNsJagpRyo0hbZQ7ntb4xQ1yhDbmSHTdlw3hxbstTqtjm9Rxs65rDh6rCGvZay46RbvbTuJuZBk0YW3zHr1FdzuVbC9WzWW9etJkLXdK1gur7nBtzperWj5C/2+SFOj7NJ+osAMeeRx4ZsAHPshu+suSonGjXc/TSOv0QtDTOyjspPKBLo4H42pd2X/ec1VRDqa3xGw+R10gWDoMuOaqltbQszlTeomMHib1Ol4Sqkp0ldrjO5UeSeWi0qEy6WXGKvPKFervAOCpe/+R5K/AYP2gVU= sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search decision instances

+ Search decision instances -## Request + -

Body

+ -Search examples + -
    filter object
    evaluatedInputs object[]
  • Array [
  • ]
  • evaluatedOutputs object[]
  • Array [
  • ]
  • sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • evaluatedInputs object[]
  • Array [
  • ]
  • evaluatedOutputs object[]
  • Array [
  • ]
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ diff --git a/docs/apis-tools/operate-api/specifications/search-7.api.mdx b/docs/apis-tools/operate-api/specifications/search-7.api.mdx index 9a22cd167ee..a2db29c2fed 100644 --- a/docs/apis-tools/operate-api/specifications/search-7.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search-7.api.mdx @@ -5,59 +5,242 @@ description: "Search decision definitions" sidebar_label: "Search decision definitions" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/ivEecnWKb6kdZsKwwC3SYFsQ5LFXveQGAMtHVtsJVIlqaSe4P8+HFKWZVtO42Iv3fYmkefynfuRSrB8biC8hTOMhBFKnuFMSGGFkjAJQOWoOb1cxBCCQa6j5M9XEIDGTwUa+0bFCwhLiNFEWuSOLYSRo2P4mWd5igYCiJS0KC2R8jxPReSEdj8Yoi/BRAlmnJ7sIkcIQU0/YGQhgFwTBCvQ0O1MpBb1l+lE3KAxVgs5h2UAH3HROBfS4hw1BDBTOuPWH718QZRx5Y2LdkGSZ9h6cY/aCG/To1qenzS13OCnQmjMUFqzR2Mb6S8Hm9PkvtxnQxvx+4Pssii5tK2W0K2wKR21ZNwyACP+wieq8ek4nG2mBNeaLyAAYTEzu6lCCIzS9ukcu0mIaXuQlI43oFQ3AaAsMiqy4egtBHB2PnoLk6YrRgRo2Tz5rUC9aPdQXVZhCcM03S2/YZqyVRBZXPMa9l2MM16klpGTmTCs3/seArjnaUE+J/0julEzptEWWmLMUmHs3gpv1cJlXLE7ZpLm9A0aqqowD5zKKhqHaaAYMm4ilLGQczZdMFeUTRVO7m0dMKgIqii5YCwnKwReaJV8T4YSeBxEvwkkOMgNwRfBupzZQpvz+Veh3fHaBliSugbbuZNjxeZomU2QSfxsHUHAIpUv3JmzhRiOSPh7ejNHTEir2FGjQo88YedOOvwmx0jMqjnATKKKNGYZt1HihDYYN0k7X+U9H+qtjuFnXoxO4ZkwCQRwcjLov3r9+rT//OXpy8Gg58v0nRs767TbdXpFMV2wagKsiacL1pgmDfTrYVZPjX7dAAe9Fqs25Gyn8dL1D40mV9L47nDS67XkRxFFaP7BobzdNg9sp//P6m90VleD1Ff8YQPYKsvTJ/mjgeEGTZFa0wqF6F60ZfsZt5wJec9TEe9P+VyraYrZD4emvrHcFuaJns7QmKpj78RRSGO5jNov/cFj4TnXWunaDc9b+pPSUxHHKDd98Kz77Ns398WuuZfKsneqkPG/ztxBW5IPry9YI50ZOob/QLa7j4Co0MIu3KCcIteoj93suJ0sgxIipT4KdG+T4OmbEpABNlE0dXNlnC+4TSCE7n2/u+I4bnB0/W4BhEjTaHGACp1CCKX38DLsdstEGbsMy1xpu3TbgBZ8Wm3zdOej69Z0CCFVEU8TD2AT/DhBRhc03mj7oiWG8sBr75An83qxXok77Z32WiUR6R4p6+xYy0mszVvleOJWSUu/gPlojYjOG72K0Hp+5IKm5Wpyw9X1+c1wfH48Oh+NLq4uabKQuopvGWxEvZZSQXSA6N0TwYr63Sphf/5j7JKLiuFm/VPj3H9kbe5pIm5+1Dl9vc39Y31bga/f622jt3+XWFPvXSH2cF9uaXt0L+g1p36j8vzm2dtek0sXuO1dtFa1tYdSdGbKBaIq1yv3DwnZdTFNRURJsZs6inG3lTIeWXGPbnuOFEXAYsxyrdzlqm/QE1uJnSnNMiWFVQTIcVqtCqqpRCnrQVIn5JGrBl+SlB4m7HYfHh46Ec8KGfNOpDJyQyoilMaFvgrir9VJsMUcq8jU3EK5967GGWqUEXYrQaa7sW1Cv9Pr9Hx9Gptx2VD0eEfa8Fmd6BY/226ecuF+DjiAZdWsbuG+30iG401xVcOaBFXfuYWynHKDv+t0uaTjT/QPglrnuk35tgoJ8tjnhq8CeOsnzfGYMNXfOLufFdSSPccwijC3j9JOGk34+mo0puKt/jdmKiYezR/oXyR/gBDu4A4oHXNvX1j68xJSLueFG0Xg5VK584IcVDtxqzs4y1btSC4aKH984wjYWH1E+dOqC4ClV/8Z9jeJZlWE +api: eJztWEtz2zYQ/iuYvbhNaUl2osThTY2dGbcZ27XU9OBoOhC5kpCQAAOAdlQO/3tnAYoiJcqxMr2k7Y0E9vHte8kCLF8YCO/gHCNhhJLnOBdSWKEkTANQGWpOL5cxhGCQ62j55ysIQOPnHI39WcUrCAuI0URaZI4thLGjY/iFp1mCBgKIlLQoLZHyLEtE5IT2PxqiL8BES0w5PdlVhhCCmn3EyEIAmSYIVqCh27lILOqv04m4QWOsFnIBZQCfcNU4F9LiAjUEMFc65dYfvXxBlHHljctuQZKn2Hlxj9oIb9OjWp6fNrXc4udcaExRWrNHYxfprweb0+S+2mdDF/H7g+yyKLm0nZbQrbAJHXVkXBmAEX/hE9X4dBzN2ynBteYrCEBYTM1uqhACo7R9OsduEmLSHSSl4xaU6iYAlHlKRTYav4EAzi/Gb2DadMWYAJXNk99y1KtuD9VlFRYwSpLd8hslCVsHkcU1r2E/xDjneWIZOZkJw04GP0IA9zzJyeekf0w3as402lxLjFkijN1b4Z1auIwrdsdM0py+YUNVFeahU1lF4zANFEPGTYQyFnLBZivmirKpwsm9qwMGFUEVJReMcrpG4IVWyfdkKIHHQfRtIMFBbgi+CtblzBbajC++Ce2O11pgSeoGbO+DnCi2QMvsEpnEL9YRBCxS2cqdOVuI4YiEv6c3c8SEtIodNSr0yBP2PkiH32QYiXk1B5hZqjyJWcpttHRCG4xt0t43ec+Heqtj+JkXo1N4LswSAjg9HZ68ev367OT5y7OXw+HAl+lbN3Y2abfr9IpitmLVBNgQz1asMU0a6DfDrJ4aJ3UDHA46rGrJ2U7j0vUPjSZT0vjucDoYdORHHkVo/sGhvN02D2yn/8/q73RWV4PUV/xhA9gqy5Mn+aOB4RZNnljTCYXoXnRl+zm3nAl5zxMR70/5TKtZgulPh6a+sdzm5omeTtGYqmPvxFFIY7mMui/9wWPhudBa6doNzzv6k9IzEcco2z541n/2/Zv7YtfcK2XZW5XL+F9n7rAryUc3l6yRzgwdw38g291HQJRrYVduUM6Qa9THbnbcTcuggEipTwLd2zR4+qYEZIBdKpq6mTLOF9wuIYT+/Ul/zXHc4Oj73QIIkabR4gDlOoEQCu/hMuz3i6UytgyLTGlbum1ACz6rtnm689F1azqEkKiIJ0sPoA1+skRGFzTeaPuiJYbywGvvkSezerFeizsbnA06JRHpHimb7NjIWVqbdcrxxJ2SSr+A+WiNic4bvY7QZn5kgqblenLD9c3F7WhycTy+GI8vr69ospC6iq8MWlGvpVQQHSB690Swpn67Tthf/pi45KJiuN381LjwH1ntPU3EzY86p2/Q3j82txX4+r3eNgb7d4kN9d4VYg/31Za2R/eCQXPqNyrPb56D7TW5cIHb3kVrVVt7KEVnrlwgqnK9dv+QkN3ks0RElBS7qaMYd1sp45EV9+i250hRBCzGLNPKXa77Bj2xtdi50ixVUlhFgByn1SqnmloqZT1I6oQ8ctXgS5LSw4T9/sPDQy/iaS5j3otUSm5IRITSuNBXQXxXnQRbzLGKTM0tlHvva5yjRhlhvxJk+q1tE056g97A16exKZcNRY93pJbP6kS3+MX2s4QL93PAASyqZnUH9yeNZDhui6sa1jSo+s4dFMWMG/xdJ2VJx5/pHwS1zk2b8m0Vlshjnxu+CuCNnzTHE8JUf+PsflZQS/YcoyjCzD5KO2004Zvr8YSKt/rfmKqYeDR/oH+R/AFCoFTMvG1h4c8KSLhc5G4MgZdJpc5zck7twK3O4KxatyK5aiAsCk8xUZ9QluW6BYCld/8N9jfXGVX+ sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search decision definitions

+ Search decision definitions -## Request - -

Body

- -Search examples - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/search.api.mdx b/docs/apis-tools/operate-api/specifications/search.api.mdx index 24b38ff9331..eaf48900e25 100644 --- a/docs/apis-tools/operate-api/specifications/search.api.mdx +++ b/docs/apis-tools/operate-api/specifications/search.api.mdx @@ -5,56 +5,214 @@ description: "Search variables for process instances" sidebar_label: "Search variables for process instances" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/ivEeXHbqZGcppcYw4A0TYB0Q5PFWfeQ5oGWjm22FKmSlBNP0H8fDinLsq02CTAM2CVPEc+F5/KdC12B4zMLo2v4yI3gE4lwE4Eu0HAntDrLYAQWuUnnEIHBryVa91ZnSxhVkKFNjSiID0Yw9lxs0aixEEGqlUPliJcXhRSp1xl/tiRQgU3nmHP6zy0LhBHoyWdMHURQGLLACbREnQrp0NzP9wWXHSahHM7QQARTbXLuwtGrA6i9XIrWninruErx5wcL2lQXj2BXPMcOq3VGqBkRFlyW/RRnSpVyh1mHOtFaIleejIord5b1yBJVOElHbS7JZPEH3mvui33P6lN4NN2MNjeGLyEC4TC3u1mge6027uESu/lF2edQBNpkG6Y0lAhQlTmB9mh8DBG8Oxkfw003AGMyqO6e/FqiWXbjgnc8L2Sw4EjKXUBfoiuNsoxLuUY1e5LhlJfSMePJTArrGMWYCcuGyVNYJ5euHzfR71e9n3Q0dySbpO0npOLUw59xlbFVnB9i6K1wczbYRfqADQ6T5PXw8HD/5cHrg+Hw8NXAK8aMcZuiyoSascmSefB2bFqXYV/5wLZSaHFx3aYYGp1NXn36ap+4Cz6jzH7TN4V3ruPcVJt+3zY8GNB1gz325FgXS+YdYXrKBmTWR/qyA+Yto9PC4ELo0jKDtpTOPmV/i/NbVXcNNudSQrShcT9Jbmr/R03YFlrZANz9JOnpxGVKFv51DXi7jh9Z3//35d2+3OAjoPBxzdZpx+WDHO3cfBlA3TGAqAd98HnHHWdCLbgU2bcxVBg9kZj/8FgsWcddae81PwykHK3ls/6EiAYk/dnyB99LxYkx2rRheLEbhlNtJiLLUG3G4Fn87J/v7sGuux+0Y6e6VNm/zt2XfSA/ujhjHTgz9AL/AbT7NS8tjXBLP5wmyA2a575HX9/UUQWp1l8E+q+b6J4l3w/ipmuzlY00eXJ0c01Dr9DWh4W7OYwgXgzjVjhuHxYWzQKN9QaVRsIIqhDhehTH1VxbV4+qQhtX+5m8emGMKiBayK7fymAEUqdczsOtm8ZfzZERgbo/TXw3R0Y4CLfv+QHULlgrdW+SN0mvJmL9hpY1OtZ65s4VvXoCc6+mOqwHIVtj4gtOrzK0nhqFoOG3GmxwfnFyeXR18nx8Mh6fnX+geULXNXJ1tJH1VktjojfIjzfPBCvu0xVg3/9+5cFFxXC5fhKehIV6c1vyNyT9kz3pzu2kNb5d8pthvD7ozGBnSuxO3U41hN052V6sKh/M7Z2s1b21klLEptoHpymhc/8mRnZRTqRIKVG76dSM+9WL8dSJBfqdPdUUFdqud+qECcVWaqmQcq2E02SQl3RGl4TzudYuGEndiaceoaFMKGV2FMe3t7d7Kc9LlfG9VOcUBilSVNanownsL81JtCWc6dS20kL779jgFA2qFONGkY39goTGBmeHe8leEmrGupyrzkUP7hIb4Wtx6PDOxYXkwm9W3taqaSDXsBhutIBVlulXi9ALrqGqJtzib0bWNR1/pZcftbO1XGh1MEeeBWwEnMJx6P7Pr8iQNQB3dmdqk0HiKE2xcN/lvel0w4vz8RUVVPMLSq4zkjH8ln5d4bcwgk/wCQiOPii+2v15BZKrWenHAwS9VIK8pKisF9LNivWerVqEWnas/PGtZ2BX+guqnyBqvHH06V9k9Z/w5iYI +api: eJztWFtv2zYU/ivEeXHbqZGcppfoLUsTINvQZHHWPQR5oKVjmy1FqiTl1BP034dDyrJsq00CDAN2yVPEc+G5fOdC1+D43EJ6Cx+5EXwqEe4i0CUa7oRWFzmkYJGbbAERGPxSoXU/6nwFaQ052syIkvgghYnnYstWjYUIMq0cKke8vCylyLzO+JMlgRpstsCC039uVSKkoKefMHMQQWnIAifQEnUmpEPzMN9nXPWYhHI4RwMRzLQpuAtHb46g8XIZWnuhrOMqw58fLWgzXT6BXfECe6zWGaHmRFhyWQ1TnKlUxh3mPepUa4lceTIqrtxFPiBLVOEkHXW5JJPFH/igua8OPatP4clsO9rcGL6CCITDwu5nge612rjHS+znF+WQQxFok2+Z0lIiQFUVBNqTySlE8P5scgp3/QBMyKCmf/JrhWbVjwt+5UUpgwUnUu4D+hpdZZRlXMoNqtmzHGe8ko4ZT2ZSWMcoxkxYNk6ewya5dP2kjf6w6sOkp7kn2SbtMCEV5x7+jKucreP8GEPvhVuw0T7SR2x0nCRvx8fHh6+P3h6Nx8dvRl4x5ozbDFUu1JxNV8yDt2fTpgyHygd2lUKHi9suxdDqbPPq09f4xF3xOWX2m74p/Op6zs20GfZty4MRXTc6YM9Odbli3hGmZ2xEZn2kLzti3jI6LQ0uha4sM2gr6exz9rc4v1N1t2ALLiVEWxoPk+Su8X/UhG2plQ3APUySgU5cZWThX9eAd+v4ifX9f1/e78stPgIKn9ZsnXZcPsrR3s3XAdQ9A4h6NASf99xxJtSSS5F/G0Ol0VOJxQ9PxZJ13FX2QfPDQCrQWj4fTohoQTKcLX/wvVScGaNNF4ZX+2E412Yq8hzVdgxexC/++e4e7bv7QTt2riuV/+vcfT0E8pOrC9aDM0Mv8B9Au1/zssoIt/LDaYrcoHnpe/TtXRPVkGn9WaD/uoseWPL9IG67NlvbSJOnQLfQNPRKbX1YuFtACvFyHHfCcfewsGiWaKw3qDISUqhDhJs0juuFtq5J61Ib1/iZvH5hpDUQLWTXb2WQgtQZl4tw67bxNwtkRKDuTxPfLZARDsLtB34AdQvWWt275F0yqIlYv6Flg46NnoVz5aCewDyoqQnrQcjWhPiC0+sMbaZGKWj4rQcbXF6dXZ/cnL2cnE0mF5cfaJ7Qda1cE21lvdPSmugN8uPNM8Ga+3wN2J9+v/HgomK43jwJz8JCvb0t+RuS4cme9Od20hnfLfntMN4c9GawMxX2p26vGsLunOwuVrUP5u5O1uneWUkpYjPtg9OW0KV/EyO7qqZSZJSo/XRqxv3qxXjmxBL9zp5pigpt13t1woRia7VUSIVWwmkyyEs6oyvC+UJrF4yk7sQzj9BQJpQym8bx/f39QcaLSuX8INMFhUGKDJX16WgD+0t7Eu0I5zqznbTQ/js2OEODKsO4VWRjvyChscHZ8UFykISasa7gqnfRo7vEVvg6HDr86uJScuE3K29r3TaQW1iOt1rAOsv0q0XoBbdQ11Nu8Tcjm4aOv9DLj9rZRi60OlggzwM2Ak7hNHT/lzdkyAaAe7sztckgcZJlWLrv8t71uuHV5eSGCqr9BaXQOckYfk+/rvB7SIGg6APiK92f1SC5mld+NEDQSeXHK4rIZhndrlbv1bo9qFXPwroOHDf6M6qGOmpwxdG3f441fwLNHCaC sidebar_class_name: "post api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search variables for process instances

+ - + Search variables for process instances -## Request - -

Body

- -Search variables - -
    filter object
    sort object[]
  • Array [
  • ]
- -Success - -
Schema
    items object[]
  • Array [
  • ]
- -Data invalid - -
Schema
- -Forbidden - -
Schema
- -Not Found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx b/docs/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx index e8f3d08b782..0846d4b5238 100644 --- a/docs/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx +++ b/docs/apis-tools/operate-api/specifications/sequence-flows-by-key.api.mdx @@ -5,61 +5,133 @@ description: "Get sequence flows of process instance by key" sidebar_label: "Get sequence flows of process instance by key" hide_title: true hide_table_of_contents: true -api: eJzlVt1v2zYQ/1eIe9o6xnLabCiEYUAKOIXXYQmSFH0I/EBTZ5uNRCrkyZkh6H8fjpSc2Fax7XGoX2R+3O/ufvfFFkitA+QPcOOdxhDmNpCyGmEhwdXoFRln5wXkEPCpQavxqnTP4cPuE+5AQq28qpDQM0YLVlUIOTzGM2Mhh1rRBiQUGLQ3NYNBDp9wJ9xK1EmlMINOCR6fGuOxgJx8gxKC3mClIG+BdjVDG0u4Rg8SVs5XitLWLxfQdQsWD7WzAQNLvJ1O+XOo+q7RrBMkaGcJLfGVN9kb/pwoU96r6AlhFV7tB/LGrqHjn4SLMT1zu1WlKQQ7hIEO9am6Lo2O1Ga1d8sSq5++BpYbMcItv6JmgNpzQMgk7wIpasI/MvPuLXQSKgxBrXHEBQ5Tz/7YYdo4dVwCGSp5a+a98zAw8e6UiSvnl6Yo0P47zv9X7l6cunubAo4c+uAar1FYR2LlGlt8H1nw81g9XN7MxSuHBUaB74CPTkJA3XhDu9gil6g8+jNukfnDopMtaOceDcbV4rhTfkQSQ+MVK+68Y41TLHci9dwKaeO4W68xksPdN4dse571MmeDTMjaR9x12YB+FtGBrfXboZ83voQc2sR+l2dZu3GBurytnacOJGyVN2pZJvL5LEV+pZqSqS6dVmXcPnbsfoOCD3hisEu0QcE5krRPmGXWcQj3fvp+OorEV7+B8pI5LzgbonoUJ10eRYrzZYjkHd9LTg/RexkatUmzsR+G1zez28v72dnd7O5ufv3nMBh7uU4eZMQepTcxGsTrdAmG21dDMv/+5T4mnrErF8X7BLyOsxvFTbMsjWZXTh12QsVhKJQms0WhbCG0q+oSuX0dJxn/EwPsynlROWvIcepHSfKu4UzYOEdcDqm2lY4xTInEToU8y56fnydaVY0t1ES7ikkojUYbIo89b3/0O/JIuHA67KWNi+vM4wo9p3HWA4WMUTmRk7Pnk+lkmrIqUKXsK0X/tcYOWNwHjPAvyupSGctaosltX38PsD1PneqwAkFCniCPinAh+1p6gLZdqoCffdl1vP3UoI+N46X0YqEWJvD/AvKVKgOeGLlvs/DDbf/E+lF8+xk26tOQ33YXC79seAUyvvbSm69bdBI2qAr00ap0cqk11vRKhkc/V9O+WX2c3YME1TBZe0KPMj4Cjprw64d4Qdy7R7S/7Q0iXrJJXfc3GfC7mA== +api: eJzlVktv2zgQ/ivEnHa7jOW06aLQLQWcwtvFJohd7CHwgaZGNhuJVEjKWUPgfy+GlJzYVrG7x6K+yHzMNzPfvNiBFxsH+QPcWSPRubl2XmiJsOJgGrTCK6PnBeTg8KlFLfGmMs/u4/4z7oFDI6yo0aMljA60qBFyeIxnSkMOjfBb4FCgk1Y1BAY5fMY9MyVrkkqmBp0cLD61ymIBubctcnByi7WAvAO/bwhaaY8btMChNLYWPm39fgUhrEjcNUY7dCTxdjqlz7HqRStJJ3CQRnvUnq68yd7Q50yZsFZETzzW7tW+81bpDQT6cbga0zPXO1GpgpFD6PyxPtE0lZKR2qyxZl1h/dtXR3IjRpj1V5QE0FgKiFfJO+eFb92/MvPuLQQONTonNjjiAoWpZ3/sMG2cO87BK1/R1sxaY2Fg4t05EzfGrlVRoP5vnP9Q7l6du3ufAo4UemdaK5Fp41lpWl38HFnwfqweru/m7JXDDKPAT8BH4OBQtlb5fWyRaxQW7QW1yPxhFXgH0phHhXG1Ou2Un9CzofGykjrvWONk6z1LPbdGvzXUrTcYyaHum0O2u8x6mYtBxmXdI+5DNqBfRHQga+1u6OetrSCHLrEf8izrtsb5kHeNsT4Ah52wSqyrRD6dpciXoq2I6spIUcXtU8eWW2R0QBODXPJbZJQjSfuEWCYdx3Afph+mo0h09TsoL5nzgrP1vhnFSZdHkeJ8GSK5oHvJ6SF6L0OjUWk29sPw9m52f72cXSxmi8X89q9hMPZygR9lxAGlNzEaROt0CYbbN0My//H3Miae0qWJ4n0C3sbZjeyuXVdKkivnDhsm4jBkQnq1QyZ0waSpmwqpfZ0mGf1jA2xpLKuNVt5Q6kdJb01LmbA1xlM5pNoWMsYwJRI55fIse35+nkhRt7oQE2lqIqFSErWLPPa8/dnv8BPhwkh3kFYmrjOLJVpK46wHchmhUiInZy8n08k0ZZXztdCvFP3fGjti8RAwj//4rKmE0qQlmtz19fcAu8vUqY4rEDjkCfKkCFe8r6UH6Lq1cPjFViHQ9lOLNjaOl9KLhVooR/8LyEtROTwz8tBm4Zf7/on1K/v+M2zUpyG/9T4WftXSCnh87aU3X1gFDlsUBdpoVTq5lhIb/0qGRj9V06FZfZotgYNoiawDoScZHwFHTei6dGNpHlGHcLDI05psCuEb9aq9Dg== sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

- Get sequence flows of process instance by key -

+ Get sequence flows of process instance by key -## Request - -

Path Parameters

- -Success - -
Schema
  • Array [
  • - -string - -
  • ]
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/sidebar.js b/docs/apis-tools/operate-api/specifications/sidebar.js deleted file mode 100644 index 8c5076925df..00000000000 --- a/docs/apis-tools/operate-api/specifications/sidebar.js +++ /dev/null @@ -1,180 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/operate-public-api", - }, - { - type: "category", - label: "ProcessDefinition", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-2", - label: "Search process definitions", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-2", - label: "Get process definition by key", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/xml-by-key", - label: "Get process definition as XML by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "DecisionDefinition", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-7", - label: "Search decision definitions", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-6", - label: "Get decision definition by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "DecisionInstance", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-6", - label: "Search decision instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-id", - label: "Get decision instance by id", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "FlownodeInstance", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-4", - label: "Search flownode-instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-4", - label: "Get flow node instance by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Variable", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search", - label: "Search variables for process instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key", - label: "Get variable by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "ProcessInstance", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-1", - label: "Search process instances", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-1", - label: "Get process instance by key", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/delete", - label: "Delete process instance and all dependant data by key", - className: "api-method delete", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/get-statistics", - label: "Get flow node statistic by process instance id", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/sequence-flows-by-key", - label: "Get sequence flows of process instance by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "DecisionRequirements", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-5", - label: "Search decision requirements", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-5", - label: "Get decision requirements by key", - className: "api-method get", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/xml-by-key-1", - label: "Get decision requirements as XML by key", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Incident", - items: [ - { - type: "doc", - id: "apis-tools/operate-api/specifications/search-3", - label: "Search incidents", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/operate-api/specifications/by-key-3", - label: "Get incident by key", - className: "api-method get", - }, - ], - }, -]; diff --git a/docs/apis-tools/operate-api/specifications/sidebar.ts b/docs/apis-tools/operate-api/specifications/sidebar.ts new file mode 100644 index 00000000000..587d4bf4f2b --- /dev/null +++ b/docs/apis-tools/operate-api/specifications/sidebar.ts @@ -0,0 +1,186 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/operate-public-api", + }, + { + type: "category", + label: "ProcessDefinition", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-2", + label: "Search process definitions", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key-2", + label: "Get process definition by key", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/xml-by-key", + label: "Get process definition as XML by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "DecisionDefinition", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-7", + label: "Search decision definitions", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key-6", + label: "Get decision definition by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "DecisionInstance", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-6", + label: "Search decision instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-id", + label: "Get decision instance by id", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "FlownodeInstance", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-4", + label: "Search flownode-instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key-4", + label: "Get flow node instance by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Variable", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search", + label: "Search variables for process instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key", + label: "Get variable by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "ProcessInstance", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-1", + label: "Search process instances", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key-1", + label: "Get process instance by key", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/delete", + label: "Delete process instance and all dependant data by key", + className: "api-method delete", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/get-statistics", + label: "Get flow node statistic by process instance id", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/sequence-flows-by-key", + label: "Get sequence flows of process instance by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "DecisionRequirements", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-5", + label: "Search decision requirements", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key-5", + label: "Get decision requirements by key", + className: "api-method get", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/xml-by-key-1", + label: "Get decision requirements as XML by key", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Incident", + items: [ + { + type: "doc", + id: "apis-tools/operate-api/specifications/search-3", + label: "Search incidents", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/operate-api/specifications/by-key-3", + label: "Get incident by key", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx b/docs/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx index 6769dce1f10..52ab47f809c 100644 --- a/docs/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx +++ b/docs/apis-tools/operate-api/specifications/xml-by-key-1.api.mdx @@ -5,56 +5,131 @@ description: "Get decision requirements as XML by key" sidebar_label: "Get decision requirements as XML by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivEfVo71nLarCiEYUCKuUWWdgliFy0QGANNnW02EqmSlBND4H8vjpSUONbQfR36SeLLPXf33AuvBS82DvIb+BOlcsroa/zWKIsVau9gycHUaIVXRp8XkMN9Vb7dX+D+nxPgUAsrKvRoCaAFLSqEHG5xDxyUhhxq4bfAoUAnraoJBHK4wD0za1Z0+ph9rJBDtywg97ZBDk5usRKQt+D3NeEr7XGDFjisja2ET1uvTyGEJYm72miHjiReTqf0OdQ/b6RER6qk0R61j9h477P7qqT/I43OW6U3EEIIHE7HMM/1TpSqiL6g84fYoq5LJSOHWW3NqsTq16+O5EZ0mdVXlARQW2Leq+SJ88I37ocsvHoJgUOFzokNjnhAcXFeaDl+mDaO/ebglS9pa2atsQMTr46ZeGfsShUF6kMOnmfP///unh67e50CjhR6ZxorkWnj2do0uvg5suC3sXo4uzpnjxxmGAV+Aj4CB4eyscrvY09cobBoX1BPzG+WgbcgjblVGFfLp63xPfrxvsiEY18+fmCrPUvttUK/NdSQNxhpoUabQ7Y7yQpbZO0t7kNsZ2SO3fUdurEl5NAmekOeZe3WOB/ytjbWB+CwE1aJVZnYpbMU2rVoSuKyNFKUcfup5YstMjqgN4C6u98ioyRI2idEI+k4hHszfTMdRaKr/4LykBoPOFvv61GcdHkUKT4WfajmdC853YdnCLeo1UWkvHveLq9m12eL2Yv5bD4/v/y7f+o6ucAPQj6gdCZGg2idLkF/+12frX99XsTMUnptoniXYZfxFUZ21axKJcmVY4cNE/FlY0J6tUMmdMGkqeoSqT/V1sTDPtXpj/Wwa2NZZbTyhnI7SnprGsqErTGe8j0Vr5AxhimRyCmXZ9nd3d1EiqrRhZhIUxEJpZKoXeSx4+1Dt8OfCBdGukFambjOLK7RopaYdUAuI1RK5OTsyWQ6maascr4S+pGi/15EB/wNoYqjQF0KpQk/Gtt2BXYDO5p7Cku9PU8gVGVL3hXLDbTtSjj8ZMsQaPtbgzaW/kNtxUoslKP/AvK1KB0e2TI0SvilG8iKZ+wHk9Oo/X0W630s77KhFfA4paVZLSwDhy2KAm00LZ2cSYm1fyQzTEhUOEP7eT9bAAfREDsDg0+SO6KO2vH723iBLcwt6j8Gqzwtya4QvgP4oaIs +api: eJzlVm1v2zYQ/ivEfdo61nLabCj0LcPcIku3BLGHFgiMgabOFhuJVEnKiSHwvw9HSkoca+i+Dv0k8eWeu3vuhdeBFzsH+R38hlI5ZfQtfm2VxRq1d7DmYBq0wiujLwvI4bGufj1c4eHvM+DQCCtq9GgJoAMtaoQc7vEAHJSGHBrhS+BQoJNWNQQCOVzhgZktK3p9zD5XyKFfFpB72yIHJ0usBeQd+END+Ep73KEFDltja+HT1i/nEMKaxF1jtENHEm/mc/oc61+2UqIjVdJoj9pHbHz02WNd0f+JRuet0jsIIQQO51OYl3ovKlVEX9D5Y2zRNJWSkcOssWZTYf3TF0dyE7rM5gtKAmgsMe9V8sR54Vv3TRbevoHAoUbnxA4nPKC4OC+0nD5MG6d+c/DKV7S1sNbYkYm3p0y8N3ajigL1MQevslf/f3fPT929TQFHCr0zrZXItPFsa1pdfB9Z8PNUPVzcXLJnDjOMAt8BH4GDQ9la5Q+xJ25QWLSvqSfmd+vAO5DG3CuMq/XL1vgB/XRfZMKxz398ZJsDS+21Rl8aasg7jLRQo80h259lhS2y7h4PIbYzMsfuhw7d2gpy6BK9Ic+yrjTOh7xrjPUBOOyFVWJTJXbpLIV2K9qKuKyMFFXcfmn5qkRGB/QGUHf3JTJKgqR9RjSSjmO4d/N380kkuvovKE+p8YRTet9M4qTLk0jxsRhCtaR7yekhPGO4RaOuIuX983Z9s7i9WC1eLxfL5eX1n8NT18sFfhTyEaU3MRpE63QJhtvvh2z9/dMqZpbSWxPF+wy7jq8wspt2UylJrpw6bJiILxsT0qs9MqELJk3dVEj9qbEmHg6pTn9sgN0ay2qjlTeU21HSW9NSJpTGeMr3VLxCxhimRCKnXJ5lDw8PMynqVhdiJk1NJFRKonaRx563j/0OfyFcGOlGaWXiOrO4RYtaYtYDuYxQKZGTs2ez+Wyessr5Wuhniv57ER3xN4YqjgJNJZQm/Ghs1xfYHexp7iks9fY8gVCVrXlfLHfQdRvh8C9bhUDbX1u0sfSfaitWYqEc/ReQb0Xl8MSWsVHCD/1AVvzIvjE5Tdo/ZLE+xPKuWloBj1NamtXCOnAoURRoo2np5EJKbPwzmXFCosIZ28+HxQo4iJbYGRl8kdwRddKOrks3VuYedQijWZ7WZFgI/wC6/qOi sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get decision requirements as XML by key

+ - + Get decision requirements as XML by key -## Request - -

Path Parameters

- -Success - -
Schema
    - -string - -
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/operate-api/specifications/xml-by-key.api.mdx b/docs/apis-tools/operate-api/specifications/xml-by-key.api.mdx index c2c500718a5..a79a2c680b5 100644 --- a/docs/apis-tools/operate-api/specifications/xml-by-key.api.mdx +++ b/docs/apis-tools/operate-api/specifications/xml-by-key.api.mdx @@ -5,59 +5,131 @@ description: "Get process definition as XML by key" sidebar_label: "Get process definition as XML by key" hide_title: true hide_table_of_contents: true -api: eJzlVm1v2zYQ/ivEfdo6xnLabCiEYUCKuUXWbgliDxsQ+ANNnW02EqmSlBND4H8fjpTk2NZevg79JPHlnrt77o0teLFxkD/AnTUSnfsZ10orr4yGJQdToxW0uCkgh+eqfLf/iHvgUAsrKvRoSbYFLSqEHB7jmdKQQy38FjgU6KRVdcTL4SPumVmzOqlixUEXB4tfGmWxgNzbBjk4ucVKQN6C39cErrTHDVrgsDa2Ej5t/XAFISxJ3NVGO3Qk8Xo6pc+x8nkjSStwkEZ71D5i47PPnquS/s80Om+V3kAIIXC4GsO80TtRqoKR8ej8Mbao61LJSF9WW7MqsfrusyO5EV1m9RklAdSWSPcqeeK88I37VxbevIbAoULnxAZHPKCgOC+0HD9MG+d+c/DKl7Q1s9bYgYk350y8N3aligL1MQevslf/f3evzt29TwFHCr0zjZXItPFsbRpdfB1Z8P1YPVzf3bAXDjOMAl8BH4GDQ9lY5fexIa5QWLQX1BDzh2XgLUhjHhXG1fK0L35AP9IUmXDsz18/sdWepcZaod8aasQbjJxQi80h211mnfDFQdhl7SPuQ+xtZJvd9b26sSXk0CauQ55l7dY4H/K2NtYH4LATVolVmaimsxTntWhKIrY0UpRx+9SNxRYZHdA0oD7vt8goI5L2CXFKOo7h3k7fTkeR6OrfoBzy5ICz9b4exUmXR5Hi5OjjNqd7yek+VkPsRa3S3OsG3e3d7P56MbuYz+bzm9vf+qHXyQV+FP8BpTMxGkTrdAn62+/71P3lj0VMM6XXJop36XYbpzGyu2ZVKkmunDtsmIhjjgnp1Q6Z0AWTpqpLpGbVJ1mf9/THeti1sawyWnlDiR4lvTUNZcLWGE/JnypZyBjDlEjklMuz7OnpaSJF1ehCTKSpiIRSSdQu8tjx9qnb4SfChZFukFYmrjOLa7SoJWYdkMsIlRI5OXs5mU6mKaucr4R+oeg/VtQReUOc4qOgLoXSBB4tbbtqe4DdZWpHp/UGHPIESiW35F3lPEDbroTD320ZAm1/adDGpnAotFiWhXL0X0C+FqXDM9uGFgrf3HdPpW/ZPz2oRp3p81nvY6GXDa2Ax5dber+FZeCwRVGgjXalk2spsfYvZIaHE5XQ0Jg+zBbAQTRE1UDnSZpH1FE7fnwXL7CFeUT902CVpyXZFcJfhPioRg== +api: eJzlVt1v2zYQ/1eIe1o7xnLadCj0lmFukbVbgtjDCgR+oKmzzUYiVZJyYgj834cjJTm2tY/XoU8SP+53d7/7YgtebBzkD3BnjUTnfsG10soro2HJwdRoBS1uCsjhuSp/3n/CPXCohRUVerQk24IWFUIOj/FMacihFn4LHAp00qo64uXwCffMrFmdVLHioIuDxW+NslhA7m2DHJzcYiUgb8HvawJX2uMGLXBYG1sJn7Z+uoIQliTuaqMdOpJ4M53S51j5vJGkFThIoz1qH7Hx2WfPVUn/Zxqdt0pvIIQQOFyNYd7onShVwch4dP4YW9R1qWSkL6utWZVY/fjVkdyILrP6ipIAakuke5U8cV74xv0rC2/fQOBQoXNigyMeUFCcF1qOH6aNc785eOVL2ppZa+zAxNtzJj4Yu1JFgfqYg9fZ6/+/u1fn7t6ngCOF3pnGSmTaeLY2jS6+jyx4N1YP13c37IXDDKPAd8BH4OBQNlb5fWyIKxQW7QU1xPxhGXgL0phHhXG1PO2LH9GPNEUmHPvy22e22rPUWCv0W0ONeIORE2qxOWS7y6wTvjgIu6x9xH2IvY1ss7u+Vze2hBzaxHXIs6zdGudD3tbG+gAcdsIqsSoT1XSW4rwWTUnElkaKMm6furHYIqMDmgbU5/0WGWVE0j4hTknHMdz76fvpKBJd/RuUQ54ccLbe16M46fIoUpwcfdzmdC853cdqiL2oVZp73aC7vZvdXy9mF/PZfH5z+3s/9Dq5wI/iP6B0JkaDaJ0uQX/7Q5+6v/65iGmm9NpE8S7dbuM0RnbXrEolyZVzhw0TccwxIb3aIRO6YNJUdYnUrPok6/Oe/lgPuzaWVUYrbyjRo6S3pqFM2BrjKflTJQsZY5gSiZxyeZY9PT1NpKgaXYiJNBWRUCqJ2kUeO94+dzv8RLgw0g3SysR1ZnGNFrXErANyGaFSIidnLyfTyTRllfOV0C8U/ceKOiJviFN8FNSlUJrAo6VtV20PsLtM7ei03oBDnkCp5Ja8q5wHaNuVcPiHLUOg7W8N2tgUDoUWy7JQjv4LyNeidHhm29BC4Yf77qn0iv3Tg2rUmT6f9T4WetnQCnh8uaX3W1gGDlsUBdpoVzq5lhJr/0JmeDhRCQ2N6eNsARxEQ1QNdJ6keUQdtaNt042FeUQdwmCWpzUZFsJfTW+pvA== sidebar_class_name: "get api-method" info_path: docs/apis-tools/operate-api/specifications/operate-public-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get process definition as XML by key

+ Get process definition as XML by key -## Request - -

Path Parameters

- -Success - -
Schema
    - -string - -
- -Invalid request - -
Schema
- -Forbidden - -
Schema
- -Requested resource not found - -
Schema
- -API application error - -
Schema
+ + + + + + + diff --git a/docs/apis-tools/tasklist-api-rest/sidebar-schema.js b/docs/apis-tools/tasklist-api-rest/sidebar-schema.js index ebb41a15e74..ebfb2e5196e 100644 --- a/docs/apis-tools/tasklist-api-rest/sidebar-schema.js +++ b/docs/apis-tools/tasklist-api-rest/sidebar-schema.js @@ -5,7 +5,7 @@ module.exports = { "apis-tools/tasklist-api-rest/tasklist-api-rest-overview", "apis-tools/tasklist-api-rest/tasklist-api-rest-authentication", { - Specifications: require("./specifications/sidebar.js"), + Specifications: require("./specifications/sidebar"), }, ], }; diff --git a/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx index e15045dcb79..67c81fd2078 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx @@ -5,55 +5,290 @@ description: "Assign a task with `taskId` to `assignee` or the active user. Retu sidebar_label: "Assign a task" hide_title: true hide_table_of_contents: true -api: eJztWVlvGzkS/isFvkyCbUvOTHYxEPaA4ig7ymEbsrwBxjFiqlmSOGaTHZItRRD03xdFsltnbDk7+xY/tcW6u46P1Uvm+cSxzg0bcnfPbjMm0OVWll4azTqs65ycaODgubuHufRTuKPHvrgDb+COh3PEOzAW/BSB517OECqHtgUD9JXVLhwQV4tlzJRoOUnvC9ZhkT/ozljJLS/QoyWDlkzzAlmHRXUsY5IMKrmfsl0rh1OE/msw4y1NFr9U0qJgHW8rzJjLp1hw1lkyvyhJsvNW6glbrW4jMTr/yogFUWzL/zhFDZWTegKD3tUQupf9GIu3H4fAKz9F7WUevAJv7lHD2Chl5sSQBMPIiAWsPYSCL2AUAiXI2Nxoj9qTbl6WKklr/+HIgOW+7Wb0B+aegmYpol6iC7zpfex7uRuzDZ948CMYnsWXmKSs7QXp4PxiCCawcwVzYs+5UihASIu5VwsYW1MEAd3LfuuTptfiFs5jAXOpFGjjyWU+UkjJI9Bj7rcVNhK2LbI4Nha/ZZtGFI4kjvCTxq8UPUnmlNw5FCA1+Kl0ILXzXOfYYquMcXo/FzO0VgqMWV6k+Ke4jYxRyPXhwN1RSt016QZ+yj3FiCuLXCxqK0X9mpv/+YRL3YILcmouHTYiPumiciE+Y2mdh0qvebQAo9WCaPWuqGDfmFfKxzxfrXYNHqQMDAFzIeMoWFHOhgtmHVtjIa+sRe1jJbOMeekVhYVqNcYryWWrFem06EqjXUzDn09P96voQoOr8hydAxsaw5+a+VI8nvOUkJWWXyoEKahmxxLtdttYZanvHCOLKPfY6eE1jqWWdZd7TNS1QwsUV2piTQW8uvxwDqIRFGSX1lD8zr/LwsQcBOUWQ5hfc39sr5jzdSOHwI8CnlkkFQKo1864oowxY7gjb1q1kqEs8A7GEpV4HrWbolT4P+mPEh61oFG0Z8PxnTJkjUNLatpSkPT51IRqr0vRm/0cuPJH+RaaJJHujy8uLrRa1OMLdVXQoD4b9LrD3muWsbOLD5fve+m5e37Wex8e33T79HC7ytjY2OIdLh63YoBjtKhz3HQFiD34Qw/HZPKemDiVOQgslVmgiCKhH12lfyiONBhqiiw261Tci3BcKdWY8R+0TsbWkGyR2uME7ePGzCLrn2ZRNIj7aMPfXpKJ0r0xtugVIxQCxRHjpO/WijGx0X9RKb2GfyXjLEbLAu1DYUqFvm5CT0+BJGKj/zxcaHsqCSBuVFs676cR/P0G1UMc5COlv6Nxxx6Pmmt/TEpTfUZqSmbunMllaH0BAG5VvajwuH5GMkWFIKjsxwk513Xf5BSdnnhZYEx9AizX5fEKIsdJVT5FTc61kPTLv62pSrehiVvLFwcVNTwwCUx7qqTHwh3C3Rv6aAY+VR015SdpkzQNCOZxv91CmjDWTfbtxavPHy8G73oDlrHfe71Xvc/XV73B52H36l3orKWVxkp/4LIwDKM2nsZW08z3FtDhVE6mGG2ecVVFCLjxY83cgm7EQ4SXA/4jV39HHOFapAvYbLcRFlLLgjw5zVjBv8bnF6enG1jxr6cUkU1UN0gILgG6l4cwXFcDWmvCfaAGcfEu0AyN1D3TRfAZPct4nCZXHHfPW38f2fY/HxAYbpx8H1NngF9zLOPNIecOI/0372IB8BKGvvsG6Id/QIDzD6DR0pqRwuIvT0Wl5GrljhhWXQ3pKN4lLJYWHWofx8Nvw+ElRGGQG9GAhRi7Gnu34I2xgF855XkGL09PQWpBPqADDj+94gISav8pshLRy22ic+Phjam0aEgods6A0bsj75efqWcU6ByfHNGVuhAPooelNTMpgs6RlTiGDeJt9wK5ycONRIROW0+Bx3X2YnLVU+P6miC2saCMua9KeIatSSujBFVmAskTRzNioziCjKYqfnlKVVCLAmHQ6Z88TPksFnuJtpDOxRStL2JcGxrykSUgljT/f6Tlj7R8PC1fflezbkBMs9VL7XtMof6ReT8y7+HMC976qRFxNZtPwxrXT1mHtWcv2pRUrr2MubVqx07HMubQzuo1b2UV67BlTKBVp91eTo3zq86yNNavWMZm3ErCQCFr6CxmesIxTJmcq/DzIbRIB5tLEFrdRu3xXmLsjrhfT389PSiJSL8hZZ38azlT78vDl/1AfFBS2EQ7zKuILG+WLDfmXiLr3NxmbITcoj25p7vTze0m6RWJjPGpGdZAupR029q15CzQnYx4AEfbsEm6CDf5jEuV0CdcoRqffOCaT1BAripHW2zK/7SmJ2T8vn81PLnqXV31L87rhX0yaLVtf2NeClMISrgmByJWU7+pi+vtx2FIQeo3g/WuvhdLe3v1vU79b255w6aULBybYMwGDFbS+WbNv/8Gawpa/0AApifenFQuvsqNFkkz3PJSCrWA5uIBI1q500U23U+p3JXREycFptFPNUMFGJB+3YJ5HvI0FgsFzXXa7fl83sp5UWnBadVFQVYyR8Lwneb7yfv0S7bDLEzuGm5pwv9tW9+520mQa5PUWb10YbMXsWycL7je0LL1oWg3asv1FPk/fFFKmeTxq2+XiktNFgZfl6kX3ZDZcSvnWMY6zSel1JBus9RXbthySSVxbdVqRT9/qdAuYvnVbSjUpZCOngXrjLly+IC/zwbpM9RzOPyZ6qD5dfHqRWiAqqL/WMZC8dSfxFZ0EZ0iF2iDUfHwLKo+GZKINfPebn2V1RzdnK5TD9LebvT5y+7w7Deq0PStrDCCmCyf09aSz6Ol8UtR6EnhtyVTXE+qMBdZFEp//wXXQund +api: eJztWVlvGzkS/isFvkyCbUvOTHYxEPaA4ig7ymEbsrwBxjFiqlmSOGaTHZItRRD03xdFsltnbDk7+xY/tUXW2XV8Vb1knk8c69ywIXf37DZjAl1uZeml0azDus7JiQYOnrt7mEs/hTt67Is78AbueDhHvANjwU8ReO7lDKFyaFswQF9Z7cIBUbVYxkyJlhP3vmAdFumD7IyV3PICPVpSaMk0L5B1WBTHMiZJoZL7KdvVcjhF6L8GM96SZPFLJS0K1vG2woy5fIoFZ50l84uSODtvpZ6w1eo2XkbnXxmxoBvb/D9OUUPlpJ7AoHc1hO5lP/ri7cch8MpPUXuZB6vAm3vUMDZKmTkRJMYwMmIBawuh4AsYBUcJUjY32qP2JJuXpUrc2n84UmC5r7sZ/YG5J6dZ8qiX6AJteh/7Vu76bMMmHuwIimfxJSYua31BOji/GIIJ5FzBnMhzrhQKENJi7tUCxtYUgUH3st/6pOm1uIXzWMBcKgXaeDKZjxRS8Aj0mPttgQ2HbY0sjo3Fb+mmEYUjjiP8pPEreU+SOiV3DgVIDX4qHUjtPNc5ttgqY5zez8UMrZUCY5QXyf/JbyNjFHJ92HF3FFJ3TbiBn3JPPuLKIheLWktRv+bmfz7hUrfggoyaS4cNi0+6qFzwz1ha56HSaxotwGi1oLt6l1XQb8wr5WOcr1a7Cg9SBAaHuRBx5KzIZ8MEs/atsZBX1qL2MZNZxrz0itxCuRr9lfiy1YpkWnSl0S6G4c+np/tZdKHBVXmOzoENheFPjXwpHo95CshKyy8VghSUs2OJdrtsrLJUd47hRTf3yOnhNY6llnWVe4zVtUMb30H/9ToDXl1+OAfRMAq8S2vIf+ffpWEiDoxyi8HNr7k/tlbM+bqQQ6BHAc8skggBVGtnXFHEmDHcUZS0aiFDWeAdjCUq8TxKN0Wp8H+SHzk8qkEjaE+H4ytliBqHlsS0pSDu86kJ2V6nojf7MXDlj7ItFEm6ut++uLjQalG3L9RVQY36bNDrDnuvWcbOLj5cvu+l5+75We99eHzT7dPD7SpjY2OLd7h4XIsBjtGiznHTFCDyYA89HBPJe2xiV+YgsFRmgSKyhH40lf4hP1JjqG9ksVin5F6E40qpRo3/oHUyloaki9QeJ2gfV2YWSf80jaJC3Ecd/vaSVJTujbFFrxihECiOaCd9txaMiYz+i0LpNfwrKWcxahbuPuSmlOjrIvT0EEgsNurPw4m2J5IA4ka2pfN+asHfr1DdxEE+kvo7Enf08ai59seENOVnvE3BzJ0zuQylLwDArawXFR5Xz4inqBAEpf04Iec675uYotMTLwuMoU+A5bo8XkCkOKnKp4jJuRaSfvm3NVXpNiRxa/nioKCGBiaBaE+U9Fi4Q7h7Qx71wKeKo6L8JGmSugHBPO63S0jjxrrIvr149fnjxeBdb8Ay9nuv96r3+fqqN/g87F69C5W1tNJY6Q8MC8PQauNpLDVV3d9bQIdTOZli1HnGVRUh4MaPNXELuhEPEV4O+I9M/R0xjg2RpQvYbLcQFlLLgiw5zVjBv8bnF6enG1jxr6fkkU1UN0gILgG6l4cwXFcDWmvCPFCDuDgLNE0jVc80CD6jZxmPU+eK7e556+8j2/7nAwzDxMn3MXUG+DXHMk4OOXcY739zFguAlzD03TdAP/wDApx/AI2W1owUFn95KiolUyt3RLPqakhHcZawWFp0qH1sD78Nh5cQmUFuRAMWou9q7N2CN8YCfuUU5xm8PD0FqQXZgA44/PSKC0io/adISpdebl86Nx7emEqL5gr5zhkwerfl/fIz1YwCneOTI6pSF+JBtLC0ZiZFkDmyEsewcXnbvHDd5GEiEaHS1l3gcZm9GFx117i+JohtLChj7qsSnmFr0sooQJWZQLLEUY/YSI7Ao8mKX56SFSFPhUGnf/Iw5bOY7CXaQjoXQ7QexLg21ORTapt1//8Rlj/C8vGwfPldxboBMc1WL5XvMbn6R+T9iLyHIy9Y66dGxNVsPg1rXD9lHdaevWgHhNJexthatWOlYxlzaGf1mreyinXYMgbQqtNuL6fG+VVnWRrrVyxjM24lYaAQNXQWIz3hGKZMzlX4+RBapIPNJQitbqP0OJcYu8Pu19NfTw9yoqvf4LIO/jWfqffl4WE/XD7IKWyiHeZVRJY3S5Ybcy+RdW5uMzZCbtGe3NPsdHO7efWKWEb/1ARrIF1KmrZ2NTkL905GPICjbdgkXYSbfMalSugTrlCNTz5wzScoIFeVoy02xX9a0xMyft+/Gp5c9a6u+hfn9cI+KbTa1r9RL7kpOCWMyeESq2+/qZPr7cdhCEGqN4P1rr4XU3t79b0O/W9uecOmlDQcm6DMBgxW0vlmzb//BusbtP6BAExPvDmpXHyVGyWSerjlpRRqAc3gASNaudMgm+ZTSndl9MRJsYnqKQED0q9LMM9DnMZkIae5Trs9n89bOS8qLTitusjJSuZIGL7TfD95n37JdoiFyV1DLU34v23rmbudGLk2cZ3VSxc2exHTxvmC6w0pWx+Kdr22XHeR/8MXpRRJHr/6dqm41KRhsHWZatENqR23co5lrNN8UkoF6TZLdeWGLZeUEtdWrVb085cK7SKmX12GQl4K6ehZsM6YK4cP2PtskD5DPYfDn6kOql8nr16EAqgq+o9lLCRP/UlsRYPoFLlAG5SKh2dR9MmQWKyJ93brq6ym6OY0Tj1493ajzl92h2e/UYamb2WFEURk+Zy2lnweNY1fikJNCr8tmeJ6UoW+yCJT+vsvLsfqfQ== sidebar_class_name: "patch api-method" info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Assign a task

+ Assign a task with `taskId` to `assignee` or the active user. Returns the task. -## Request + -

Path Parameters

Body

+ -When using REST API with JWT authentication token following request body parameters may be used. + -
- -On success returned. - -
Schema
- -An error is returned when the task is not active (not in the CREATED state).
An error is returned when task was already assigned, except the case when JWT authentication token used and `allowOverrideAssignment = true`. - -
Schema
- -An error is returned when user doesn't have the permission to assign another user to this task. - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+An error is returned when task was already assigned, except the case when JWT authentication token used and `allowOverrideAssignment = true`.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "403": { + description: + "An error is returned when user doesn't have the permission to assign another user to this task.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +> diff --git a/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx index a2205914bde..a07699bbf0f 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx @@ -5,55 +5,297 @@ description: "Complete a task with `taskId` and optional `variables`. Returns th sidebar_label: "Complete a task" hide_title: true hide_table_of_contents: true -api: eJztWetPIzkS/1dK/jKga5LM7uxpFa3uFCDcZh6AkrAjLUKD064kXrrtHtudTC7K/74q2915cRC4+Th8odMu18u/erh6yRyfWNa+ZUNuH9hdwgTa1MjCSa1Ym53pvMjQIXBw3D7AXLop3NNjT9wDVwK0J+UZ3M+4kXyUob1vQB9daZQFN0W/scESpgs0nIh7grVZGjl7uQkruOE5OjSkzJIpniNrsyCIJUySMgV3U7ar4XCK0DsHPd6SZfBrKQ0K1namxITZdIo5Z+0lc4uCOFtnpJqw1eouEKN1p1osiCLVyqFy9MiLIpOpV7r5lyV5y31WevQXpo5sMGSik2hptXbHBik3hi/2TPijogSnoSwEdwjaABeCXni/i5LUrU2E6D3anzDpMLfPKxR8uuuBx/xJlJVHKzMabJWwGc/KA3l40j0m8HmKCmyBqRwvKouq1bAnAeneWEhNmUqekQdyLpXjUkGqlZXWoUoXAYnvB1eXYZeFI4tG8kz+1x8XjLXxzIOnvkFwigVbplPgFjJp3bFHMCpbGgQ35Q6CQRYMklDgBbnQSO4wWxDLnDuHosFWq4Q56TLcOL6eKkp3PrxiK1rd9kg/QCxqEZSf/T/HTiCvFKAQqgI1CiIdVoRsW2hlw/n/1GrRv23FrhR5JEVLNlPMknXJ94oBKQ4DS6nk1xJBClROjiWa7XheJa8Eb72dHs5xLJWsEtBzrG4sGiDPUnYZG517hqfXny5B1Iw878Jo8t/lqzSMmz2j1KB38zl3B3DykTTndgMdtB8FHBkkEQIoCc54hsqRuHuyplEJGcoc72EsMRPHQXqNrVfLjxh8ToNa0J4O3Fo5UXigH0uLhsQ0pSDu86kGaSHyCEG0i4GBO8g24m6dD8jdusLFlcoWVV1BVeZUPc/63c6we84Sdnb16fpjNz53Ls+6H/3jRadHD3erhFEa+YCL57Xo4xgNqhQ3TfFZyNtDD4cgeY9NKJccBBaZXqAILKEXTKUf5EelXU2RgJtKCzG4F365zLJajT/QWBlSQ9RFKocTNM8rMwtbv5tGQSHugg7/fEcqSnuhTd7NRygEbnpspHWGXO1p2bNrwRi3xYoirT+Gf0flDAbNPO1TboqBvk5CL4dAZLGRf54OtD2R1LNtRFtc7ynruErx9QrJyAHkM6G/I3FHH4eKK3cIpCk+AzWBmVurU+lTny+sW1EvSjwsnxFPUSL4Olx1D1Xc15ii1RMncwzQzzI9vykOFxB2nJTFS8SkXAlJb/5jdFk830+SoHoPTPymPVG7TWPdEG/Ioxr4UnGUlF8kTVI1yFE57rZTSO3GKsm+vzr98vmq/6HbZwn7s9s97X65GXT7X4adwQefWQsjtZFusd/mDH2pDash1dT1vQG0OJWTKZrYjlLn6rZfVpsb0An9EPWrWoWuEP5EHOGapfXd2W4izKWSOVnSSljOv4Xnt60W+XPMy8yx9i+tzcaSWPVjBxcbuneP9XAdBWiMNpRvqiYO5lSe66IRsydPnZwhHNGzDMuxcoVyd9z4bWSa/3qUoVxXQl/2iUeacUmxflQV3WMY4VgbPJBPpdZOyU5LYyhvEJae6EYLo0cZ5v94aVdKppb2gGLVURCXwu3AYGHQonKhPPw+HF5DYAapFnWzEGyueu8GXGgD+I0TzhN412qBVIJsQAsc3pxyAbFrfxO2EtG7baJL7eBCl0rUJHRzsRrCTWCz5P38E+WMHK3lkwOyUifeeYKFhdEzKbzMkZE4hg3ibfM8uU79UQmfaasq8LzMbgBFVTVubqjF1gYyrR/KAo6wMWkkBNBMTyBaYo+3b12eRx0VP+9HhY/GqQcqFGhyaX2f4TTwcN+pUXg0wGx8knPFJyh8UB//QN0P1D2PunevysV1j1LP0WIaHJOrfyDvB/KeRp631k21CCPRdOrHp27K2qw5e9skUNnmMmBr1awu5SxhFs2sGrCWJmNttgwQWrWbzeVUW7dqLwtt3Iol2+NLWgtYj40Ky3TKM//6sXaQFjanHJ3rHgTp4eKhzQ67X1u/th7lRKT/g8sa/ms+U+eKx2/znvhRTn4GbDEtQ+t4SxNg/SCRtW/vEjZCbtCcPNDl6PZuk3RALIN/qg3rTrmQdJ3aH6cT3cmIWxTASzeleVeIbkoCvp/kMy6z2F6Cr0yfYmVKs9LShJwiIA7IqfX92BsMTwbdwaB3dVmNyqNCq239a/Wim7xT/D3YE7GK+qIKr/efhx6ElHH66yl5NwT3zpR7PbavwyDOi+t2/86HzVh7VTa6XBrGQr87GNLJ7J9fRUHTHaARzOLE6ZPShoPcSJFU3Q0vpMgWUN8rYFRaqajix+snhXum1cRKEe4rPi/TNTY08lUK5qlHaQgVcpltN5vz+byR8rxUgtMki1ycyRSpRa9n7OxjfJPsbBY6tfVuqf3vpqmu1M3IyDb9rL2aqbDZ2xA01uVcbUjZ+Tiz67eNLxnf9TtOxJDDb65ZZFwq0s7buYx56JZUDgM3yxLWrj/j1MnoLok55ZYtlxQONyZbrej11xLNIoRepYiHlpCWngVrj3lm8Qlbj/rx488xPP5x6FEDqsBViw3csoT5wKk+RHkAT5ELNF6psHgWRJ8MicV6897gfJVUOzppioV7kvZuI8tfd4Znv1N0xi9UuRa0yfA5jST5PGgaTtDnI/9uyTKuJqWviiwwpb+/AePCssI= +api: eJztWetPIzkS/1dK/jKga5LM7uxpFa3uFCDcZh6AkrAjLUKD064kXrrtHtudTC7K/74q2915cRC4+Th8odMu18v1+Ll6yRyfWNa+ZUNuH9hdwgTa1MjCSa1Ym53pvMjQIXBw3D7AXLop3NNjT9wDVwK0J+UZ3M+4kXyUob1vQB9daZQFN0W/scESpgs0nIh7grVZGjl7uQkruOE5OjSkzJIpniNrsyCIJUySMgV3U7ar4XCK0DsHPd6SZfBrKQ0K1namxITZdIo5Z+0lc4uCOFtnpJqw1eouEKN1p1osiCLVyqFy9MiLIpOpV7r5lyV5y31WevQXpo5sMGSik2hptXbHBik3hi/2TPijogSnoSwEdwjaABeCXni/i5LUrU2E6D3anzDpMLfPKxR8uuuBx/xJlJVHKzMabJWwGc/KA3l40j0m8HmKCmyBqRwvKouq1bAnAeneWEhNmUqekQdyLpXjUkGqlZXWoUoXIRLfD64uwy4LRxaN5Jn8rz8uGGvjmQdPfYPgFAu2TKfALWTSumMfwahsaRDclDsIBlkwSEKBF+RCI7nDbEEsc+4cigZbrRLmpMtw4/h6qijd+fCKrWh12yP9EGJRi6D87P85dgrySgFKoSpRoyDSYUWRbQutbDj/n1ot+ret2JUij6RoyWbKWbIu+V45IMVhwVIq+bVEkAKVk2OJZjufV8krg7feTg/nOJZKVgXoOVY3Fk1weu8cxkbnnuHp9adLEDUjz7swmvx3+SoN42bPKDXo3XzO3QGcfCbNud2IDtqPAo4MkggBVARnPEPlSNw9xUmjEjKUOd7DWGImjoP0OrZeLT/G4HMa1IL2dODWyonCA/1YWjQkpikFcZ9PNUgLkUdIot0YGLiDbCPu1vmE3O0rXFypbFH1FVRlTt3zrN/tDLvnLGFnV5+uP3bjc+fyrPvRP150evRwt0oYlZEPuHheiz6O0aBKcdMUX4W8PfRwSCTvsQntkoPAItMLFIEl9IKp9IP8qLSrKRJwU2khJvfCL5dZVqvxBxorQ2mIukjlcILmeWVmYet30ygoxF3Q4Z/vSEVpL7TJu/kIhcBNj420zpCrPS17di0Y47bYUaT1x/DvqJzBoJmnfcpNMdHXRejlIRBZbNSfpxNtTyRhto1si+s9ZR1XKb5eIRk5gHwm9Xck7ujjUHHlDglpys9ATcHMrdWp9KXPN9atrBclHlbPiKcoEXwfrtBDlfd1TNHqiZM5htDPMj2/KQ4XEHaclMVLxKRcCUlv/mN0WTyPJ0lQvQcmftOeqF3QWAPiDXnUA18qjoryi6RJ6gY5Ksfddgmp3VgV2fdXp18+X/U/dPssYX92u6fdLzeDbv/LsDP44CtrYaQ20i32Yc7Qt9qwGkpNWfX3BtDiVE6maCIcJeTqtl9WmxvQCXiI8KpWARXCn4gjXLO0Hp3tFsJcKpmTJa2E5fxbeH7bapE/x7zMHGv/0toElpQy/YjgIqB79xiG6yhAY7ShelOBOJhTe66bRqyePHVyhnBEzzIsx84V2t1x47eRaf7rUYZy3Ql92yceacYl5fpR1XSPYYRjbfBAPpVaOy07LY2hukEOfQKNFkaPMsz/8VJUSqaW9oBm1VEQl8LtwGBh0KJyoT38PhxeQ2AGqRY1WAg2V9i7ARfaAH7jFOcJvGu1QCpBNqAFDm9OuYCI2t+ErUT0bpvoUju40KUSNQndXKyGcBPYbHk//0Q1I0dr+eSAqtSJd55gYWH0TAovc2QkjmGDeNs8T65Tf1TCV9qqCzwvsxuCouoaNzcEsbWBTOuHsoAjbEwaCQVopicQLbHH27cuz6POip/3s8ID+KkPVCjQ5NJ6nOE08HDfqaPwaIDZ+CTnik9Q+KQ+/hF1P6Lu+ah796paXGOUeo4Wy+CYXP0j8n5E3tOR5611Uy3CSDSd+vGpm7I2a87eNj0AaS5DbK2a1aWcJcyimVUD1tJkrM2WIYRW7WZzOdXWrdrLQhu3Ysn2+JLWQqxHoMIynfLMv34MDtLC5pSjc92DID1cPLTZYfdr69fWo5yI9H9wWYf/ms/UueLx27wnfpSTnwFbTMsAHW9pAqwfJLL27V3CRsgNmpMHuhzd3m2SDohl8E+1YY2UC0nXqf1xOtGdjLhFAbx0U5p3heymIuDxJJ9xmUV4Cb4zfYqdKc1KSxNyyoA4ICfo+7E3GJ4MuoNB7+qyGpVHhVbb+tfqRTd5p/h7sCdiFfVFlV7vPw99EFLF6a+n5N2Q3DtT7vXYvk6DOC+u4f6dT5ux9qpsoFwaxkK/OxjSyeyfX0VB0x2gEczixOmT0oaD3CiR1N0NL6TIFlDfK2BUWqmo48frJ6V7ptXESrEJ2ikBPZCvSjBPfZSGVCGX2XazOZ/PGynPSyU4TbLIxZlMkSB6PWNnH+ObZGez0Kmtd0vtfzdNdaVuRka26Wft1UyFzd6GpLEu52pDys7HmV2/bXzJ+K7fcWIMOfzmmkXGpSLtvJ3LWIduSeUwcLMsYe36M05djO6SWFNu2XJJ6XBjstWKXn8t0SxC6lWK+NAS0tKzYO0xzyw+YetRP378OYbHPw49akCVuGqxEbcsYT5xqg9RPoCnyAUar1RYPAuiT4bEYr15b3C+SqodnTTFwj1Je7dR5a87w7PfKTvjF6pcC9pk+JxGknweNA0n6OuRf7dkGVeT0ndFFpjS398lZ7Ni sidebar_class_name: "patch api-method" info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Complete a task

+ Complete a task with `taskId` and optional `variables`. Returns the task. -## Request + -

Path Parameters

Body

    variables object[]
    + -Variables to update or add to task during the task completion + -
  • Array [
  • ]
- -On success returned. - -
Schema
- -An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before.
An error is returned if the task is not assigned to the current user. - -
Schema
- -User has no permission to access the task (Self-managed only). - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+An error is returned if the task was not claimed (assigned) before.
An error is returned if the task is not assigned to the current user.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "403": { + description: + "User has no permission to access the task (Self-managed only).", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +>
diff --git a/docs/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx index 53e956d2823..5b6e974ad7e 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx @@ -12,33 +12,136 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get a form

+ - + Get the form details by `formId` and `processDefinitionKey` required query param. The `version` query param is optional and is used only for deployed forms (if empty, it retrieves the highest version). -## Request + -

Path Parameters

Query Parameters

+ -On success returned. + -
Schema
- -An error is returned when the form with the `formId` and `processDefinitionKey` is not found. - -
Schema
+ diff --git a/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx index ca8de33aad9..b259b270f30 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx @@ -5,44 +5,231 @@ description: "Get one task by id. Returns task or error when task does not exist sidebar_label: "Get a task" hide_title: true hide_table_of_contents: true -api: eJztWN1vGjkQ/1csv1yq2wBtc6eKlxNJSY82TSIgV6lR1Jj1wLrx2hvbC0GI//00tneBwCWk18c+Yez5+M3sfNkL6tjE0vY1HTJ7R28SysGmRhROaEXb9AM4ohUQx+wdGc2J4A3SB1caZcOeNgSM0YbMMlBhi2uwRGlH4EFY16AJ1QUYhhJ7nLbpBBwqO573OE1owQzLwYFBFAuqWA60TVGQPxaIomAuo4+hDTMgvfdEj4nLAkBUZeC+FAY4bTtTQkJtmkHOaHtB3bxAydYZoSZ0ubxBYltoZcHi+ZtWC382lVwoYss0BWuJ8WYDRy2pVg6UQ3pWFFKk3rrmd4tMi22levQdUofWGvSFE0Gl4NvAdplZKnFfAhEclBNjAWbT6mUS3baPLKTcYsfFexgLJaqv9JyoKwuG4GfEbzA2OvcCjy8/nxNeC/KyC6PRf+c/hDAye0GpAe/m98ztIekLxuOM2dpQ4vmBkwMDqIITDJUpk6AcqrtFaxqVkqHI4ZaMBUj+KmjXeSHhf+kPEp5FUCvawsCsFRMFe/qxtGBQTVNwlD7LNBGWRBmcOL0dAwO3l20o3SLpdvYxfqHkvMo+UGWOxeWk3+0Mu+9pQk8uPl+edeO6c37SPfPL004PFzfLhI61yT/B/HkUfRiDAZXCuikE2b09uNgnkrfEhKLCCIdC6jnwIJL0gqn4B/2IBa6iSIjLhCUxuef+uJSyhvEPGCtCaYhYhHIwAfM8mGlg/WmIAiDmAoY/jxCisKfa5N18BJzDusdGWktgagtlz64UQ2TDf0Epfoa/IjgDAZmnfcpNMdFXRejlIRBFrNWfpxNtS2WPb2RbPO8p65hK4ccBiSiBiGdS/5HGR3gcKKbcPiGN+RmoMZiZtToVvvTNhMs2s56XsF89Q5m8BMIx7cO3XuV9HVN4euhEDiH0pdSzq2J/BYHjsCxeoiZligvc+WB0Wdg1TcwYNt+pqOYhE8+0pUo4yO2usWFNH/bAl6rDovwibQK7QQ7KMbdZQmo3VkX248Xxty8X/U/dPk3o1273uPvtatDtfxt2Bp98ZS2M0Ea4+faYM/StNpyGUlP39wbBw0xMMgiYp0yW4FdrmxVzg3TCPDSSQLSSc2/qV4ARrERaNHmrEOZCiRwtaSU0Zw9h/brVQn+OWSkdbf/RQo844SSyoqh+nODocolHR62328Z5vRnzZagAkwvrK6rThIXJru4dBwOQ48OcKTYB7uG/emLaK4weSch/f+nUh52ztHs0g44i8Yi4jDlioDBgQbkA+e/h8JIEYSTVvG7GYR6vZtsGOcUZ/YFhHCXkqNUiQnG0ASxh5Ldjxkkf7kuw7rfAikRHm0Tn2pFTXSpekzDFidUEZ7zNlvL2DeZkDtayyR5Z3yHhIFhYGD0V3OscGQFjska8aZ4n12laGoMjOSZKrJrP6+x6CXVVvrrCEVYbIrW+KwtyAI1JIyFCEaknJFpisQavBZ+XUUfd0XbUdVREKlZXh3hJqsKtrsa34bpzW3XxMbr6V+T9irynI89b6zIdL9X+Mu0y2qbN6esmhpRtLkJkLWlCLZhpdcsujaRtughxs2w3m4tMW7dsLwptHBJPmRFYw32w4FkI8FiHqdQpk357V7fDg/VLXOeyR4L2MFdp80jcu9a71k5JSPofUlYxv5KTOVfsvqx44p2S/EOAhbQMnfF6QVOt7wTQ9vVNQkfADJjDO5z9rm/WSQcoMvinYlgNAoXAafExkhNPdzhiFjhhpcvwOh9SGjPft0s2ZULG7kl8O/oc21EqS4vPJBj28ZUEO/tZbzA8HHQHg97FefVeEgEtN/HX8KKbvFP8mO+JaEV9WuXUxy/DMIKosfbsa41XCutIvzsYoje3fV5R4IWT4K1wfuj0YWmD89dqGbZhwwrB5ZzUow4ZlVYobM1xIsa8lFpNrOBhhPIFFCfrMFtUtZKlPrJCeKOZtt1szmazRsryUnGGl2t0ixQp4NTQrh+czuJO8oiZ69TW3EL7/01TTfnNKMg2Ueq0uubR6esQ6NblTK1pwec05rE/dtliVet/0qNb/NgOHlyzkEwohOSNW8Q6cY04w8Xf0oS246PbTRIz/pouFhisV0Yul7h9X4KZh8SoCoTPGC4srjltj5m08IRpB/34PveK7H6/24m6Sis196VJlviPJtSHdfVWuMQRNwPGwXhQ4bCTplC4Nbat9zpM6rqMfuhiyP8LSZdGzQ== +api: eJztWN1vGjkQ/1csv1yq2wBtc6eKlxNpSI82TSIgV6lR1Jj1wLrx2hvbC0GI//00tneBwCWk18c+Yez5+M3sfNkL6tjE0vY1HTJ7R28SysGmRhROaEXb9AM4ohUQx+wdGc2J4A3SB1caZcOeNgSM0YbMMlBhi2uwRGlH4EFY16AJ1QUYhhJ7nLbpBBwqO573OE1owQzLwYFBFAuqWA60TVGQPxaIomAuo4+hDTMgvROix8RlASCqMnBfCgOctp0pIaE2zSBntL2gbl6gZOuMUBO6XN4gsS20smDx/E2rhT+bSi4UsWWagrXEeLOBo5ZUKwfKIT0rCilSb13zu0WmxbZSPfoOqUNrDfrCiaBS8G1gu8wslbgvgQgOyomxALNp9TKJbttHFlJusePiBMZCieorPSfqyoIJn7t3QsZG517g8eXnc8JrQV52YTT67/yHEEZmLyg14N18wtwekr5gPM6YrQ0lnh84OTCAKjjBUJkyCcqhulsMykalZChyuCVjAZK/Ctp1Xkj4X/qDhGcR1Iq2MDBrxUTBnn4sLRhU0xQcpc8yTYQlUQYnTm/HwMDtZRtKt0i6nX2MXyg5r7IPVJljcXnf73aG3ROa0PcXny/PunHdOX/fPfPL004PFzfLhI61yT/B/HkUfRiDAZXCuikE2b09uNgnkrfEhKLCCIdC6jnwIJL0gqn4B/2IBa6iSIjLhCUxuef+uJSyhvEPGCtCaYhYhHIwAfM8mGlg/WmIAiDmAoY/jxCisKfa5N18BJzDusdGWktgagtlz64UQ2TDf0Epfoa/IjgDAZmnfcpNMdFXRejlIRBFrNWfpxNtS2WPb2RbPO8p65hK4ccBiSiBiGdS/5HGR3gcKKbcPiGN+RmoMZiZtToVvvTNhMs2s56XsF89Q5m8BMIx7cO3XuV9HVN4euhEDiH0pdSzq2J/BYHjsCxeoiZligvc+WB0Wdg1TcwYNt+pqOYhE8+0pUo4yO2usWFNH/bAl6rDovwibQK7QQ7KMbdZQmo3VkX248Xxty8X/U/dPk3o1273uPvtatDtfxt2Bp98ZS2M0Ea4+faYM/StNpyGUlNW/b1B8DATkwwC5imTJfjV2mbF3CCdMA+NJBCt5Nyb+hVgBCuRFk3eKoS5UCJHS1oJzdlDWL9utdCfY1ZKR9t/tNAjTjiJrJgy/TjB0eUSj45ab7eN86NKxnwZKsDkwvqK6jRhYbKre8fBAOT4MGeKTYB7+K+emPYKo0cS8t9fOvVh5yztHs2go0g8Ii5jjhgoDFhQLkD+ezi8JEEYSTWvm3GYx6vZtkFOcUZ/YBhHCTlqtYhQHG0ASxj57Zhx0of7Eqz7LbAi0dEm0bl25FSXitckTHFiNcEZb7OlvH2DOZmDtWyyR9Z3SDgIFhZGTwX3OkdGwJisEW+a58l1mpbG4EiOiRKr5vM6u15CXZWvrnCE1YZIre/KghxAY9JIiFBE6gmJlliswWvB52XUUXe0HXUdFZGK1dUhXpKqcKur8W247txWXXyMrv4Veb8i7+nI89a6TMdLtb9Mu4y2aXP6uukLbXMRImtJE2rBTKtbdmkkbdNFiJtlu9lcZNq6ZXtRaOOQeMqMwBrugwXPQoDHOkylTpn027u6HR6sX+I6lz0StIe5SptH4t613rV2SkLS/5CyivmVnMy5YvdlxRPvlOQfAiykZeiM1wuaan0ngLavbxI6AmbAHN7h7Hd9s046QJHBPxXDahAoBE6Lj5G893SHI2aBE1a6DK/zIaUx8327ZFMmZOyexLejz7EdpbK0+EyCYR9fSbCzn/UGw8NBdzDoXZxX7yUR0HITfw0vusk7xY/5nohW1KdVTn38MgwjiBprz77WeKWwjvS7gyF6c9vnFQVeOAneCueHTh+WNjh/rZZhGzasEFzOST3qkFFphcLWHCdizEup1cQKvj5HYKb42aKqlSz1kRXCG8207WZzNps1UpaXijO8XKNbpEgBp4Z2/eB0FneSR8xcp7bmFtr/b5pqym9GQbaJUqfVNY9OX4dAty5nak0LPqcxj/2xyxarWv+THt3ix3bw4JqFZEIhJG/cItaJa8QZLv6WJrQdH91ukpjx13SxwGC9MnK5xO37Esw8JEZVIHzGcGFxzWl7zKSFJ0w76Mf3uVdk9/vdTtRVWqm5L02yxH80oT6sq7fCJY64GTAOxoMKh500hcKtsW2912FS12X0QxdD/l8Nj0dt sidebar_class_name: "get api-method" info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get a task

+ - + Get one task by id. Returns task or error when task does not exist. -## Request + -

Path Parameters

+ -On success returned. + -
Schema
- -User has no permission to access the task (Self-managed only). - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+ diff --git a/docs/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx index 72f7da281e4..2b79f248cbd 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx @@ -12,40 +12,111 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Get a variable

+ Get the variable details by variable id. -## Request + -

Path Parameters

+ -On success returned. + -
Schema
    draft object
    - -The draft value of the variable - -
- -An error is returned when the variable with the `variableId` is not found. - -
Schema
+ diff --git a/docs/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx index 27e5668f33d..93d64bbcecb 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx @@ -12,48 +12,177 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Save draft variables

+ This operation performs several actions:
  1. Validates the task and draft variables.
  2. Deletes existing draft variables for the task.
  3. Checks for new draft variables. If a new variable's `name` matches an existing one but the `value` differs, it is saved. In case of duplicate draft variable names, the last variable's value is kept.
NOTE:
  • Invoking this method successively will overwrite all existing draft variables. Only draft variables submitted in the most recent request body will be persisted. Therefore, ensure you include all necessary variables in each request to maintain the intended variable set.
  • The UI does not currently display the values for draft variables that are created via this endpoint.
-## Request - -

Path Parameters

Body

required
    variables object[]
    - -Variables to update or add to the task. - -
  • Array [
  • ]
- -On success returned. - -
Schema
    any
- -An error is returned when the task is not active (not in the `CREATED` state).
An error is returned if the task was not claimed (assigned) before, except the case when JWT authentication token used.
An error is returned if the task is not assigned to the current user, except the case when JWT authentication token used. - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
- -An error is returned if an unexpected error occurs while persisting draft task variables. - -
Schema
+ + + + + + +An error is returned if the task was not claimed (assigned) before, except the case when JWT authentication token used.
An error is returned if the task is not assigned to the current user, except the case when JWT authentication token used.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "500": { + description: + "An error is returned if an unexpected error occurs while persisting draft task variables.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +>
diff --git a/docs/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx index 2192123cf65..6ada10bf7e5 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx @@ -12,44 +12,183 @@ 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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search task variables

+ This method returns a list of task variables for the specified `taskId` and `variableName`.
If the request body is not provided or if the `variableNames` parameter in the request is empty, all variables associated with the task will be returned. -## Request + -

Path Parameters

Body

    includeVariables object[]
    + -An array of variable names that should be included in the response. + -
  • Array [
  • ]
- -On success returned. - -
Schema
  • Array [
  • draft object
    - -The draft value of the variable. - -
  • ]
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+ diff --git a/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx index e8e2b223ace..3c3e45e486a 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx @@ -5,72 +5,500 @@ description: "Returns the list of tasks that satisfy search request params.
sidebar_label: "Search tasks" hide_title: true hide_table_of_contents: true -api: eJztW21zGzcO/iuc/ZLkTpaU18vpcsnIsdyqTeOcpSQz9XhqaheS2HDJNcm1onr0328Acl/0ZslOLr2ZVJ+kXRIAQQB8AFDXkeMTG3XOoiG3n6LzRpSAjY3InNAq6kSn4HKjLHNTYFJYx/SYOW4/4RPumOVO2PGcWeAmnjIDlzlYxzJueGqbL0am9fJFLl++kOJlf8y4YpBmbs5GOpkzYVlm9JVIIGkwLmWgyw0wQ1whab5oSUGzT5ScM60A+V+ceXbdsQPTYLUfJ6Z3mXNZPDuEsTaw/CsMOb8oZNa0VMvS3Do2ApYZsKAcE6pYTpCilcuXUSPSGRiOU/pJ1Ik8EdSdjRpRmHCok3nUuY5irRwoh195lkkR07zW7xZVex3ZeAopx29unkHUifTod4hd1Igyg1ycAEvjHHdQG2adEWoSrW7VcAqMhtIeTcHrsxk1IlB5ilv8+rTXHfaOokb0+uSXd2964Xv37eveG/p63O3jl/NFI+LWiomCpMZ3pLUErtYYdw1U/Fgx8VVUUdlD+o9TjRZRzGZOVzSXSNkaLW4Mn29URDEaaQazQXITcQWqfEnKEQ5Su5929yW6WDQiFPwIxkKJwlZ2a4C7e97TDt/98paNpZ4xpROg5cdcJSLhDn4wOs92U/uBhJrgYBRXKFZS8E8t+XNznfZuBXcdk8AxGKwqIVC+keHeKv8yNov6wt5bMPvqLLdg1kjTw3WFId0v0ReSXV9HjdlXUNZOHqipzOgYrK0s9meY72Z6CmMwoGJAdw0kWFLSYPcNKJ5CwuAyF1dcYlzVY4bh8j85mHlzjW0/YWMBMnlAeg6v+8o6rmK4u0wiUNhbooJlKQ+JwycwEH/Uo5lQDiZg1qTAYdVZiRPZ/QTGPJeO/Zs9bT/ArR1rk3LnqTx+hBzGWko9e58dLUf8LQfD2Oh0t0IGjhvHaNMNVxPSSzj7kACaBb48cCIF5kViOndSYBgWilmIaTOfNp8VhnV6/Jo9fvz4n6jfsZClwfUHJ+z5s/ZDPIdUwk2ytMqSC67U6d2S91SyWW6n/xSpF2tOFyTTY5bkQAJZFKZ2HNaUrQ0SdsJJXDNu8bGQDgyqI8nhrz3/zvYcB3/gRvCR3APVdBWjF8h4TDRYLHluwTKbQSzGc6EmJMRVQRMFCUNREILj/bEP0Ai6cfAlRr0AuBHVyHm1iNlUxFOC5gUnhLFzT+hHPYMrxN8CUYtIM20cVw7nKe3A5wduKmwQAaVLIZ5yJWzKhCUiCVRwb6bNJwafY5lbcQVyzmbCTZkzuYq5g6RaVpMNkWwKXHkq1YL1mHEmuZmAYRZDMGYTSjsW6zTjTowkBLKVYA3GVUJ0uHOYn9Dac0ugNmUpR/VYDNxCMaF4HOeGULZhQiFdCa7SIw7ciCu3+DOeRvuhTxxZmG+xYjolr7jM96RBQ9eIsI9TUNusyM8J2xybPBZcooJSLpTjiCm0ssI6UHHYsp8GJ2/9LMvuWzCCS/EHpT6ln3i1fWZeKZbZHA3NQ7cHuB8MlM1NsCK/IMsMIFM0QqMzI7hDK/FO6yAhXfjsTO8B9oZBDG6E1YoVE4u9LyQtlUQW8jd2AZcXHUY5pK2lVnAZnRPsD56OgOJwXnk3vQPFlesnt/P1Ic1i/aO6O/vUzu9bmksnDoh4PC8cCxTyRR8vkjIdC3KjYP4Q9lug81Us6tn3v4iSGLNE2IIaug1l9+ACSp4obSC5Aani0q027larLg1j2SgJi/kAq42jR8Hl2Gh+C68jOptspNjP4NdCqyEeA40oNsBrP5eAWnV8Ix+hjXBzSqK1SfbJO/7GLrqD1xcd1rUxqESoSWFsRz16fgTFi5qI3cHrqBHhCG96KwgA9VPphvFiv2OvxPqxhMZ6gqIezv1uVRWVnZv23vro7Y2GccS6QpGlee5N1i02NcQE79NTncsECy6xztAICZfgrn7wo9AI1HItw4+h+JEbg9C9rDv5dSLODsecY94FfELdfddfFRJWSlmJMBA7Cii4tSVXJhJQzjvKaE6Pi7JVWFDD+5QB1LArKhe4FDRbsoFd7rFWwvp+9a4NBSFALdSrQN9uH3yh8DvcgcxADAn8aSr/fm2/0PyfafxCxTJP4A4ZSR72IxzWCMFDq6AEkQhe13YhcKTcLRzlmVYW2AxxDSFqOvgJ7JCKhx62g0wwLdEzG6pblHFJTP8oczDgjIArqM68KkXYBIX8lhS4pxBneaO/Labncsbn1ndfjnMpP6xg/K21eJpXGB1BplzKzbj/Fc2mmlTUGXNpoY5g+8vm4E0EQVEKynHPbjt++unk8LePJ6c/906jRvRrr3fY++39oHf627A7+JmgUYmTOterBbx8OXXVuaP6nA2WLwwrJjdZ1/dV0MQod0XY/ivACBiWZv08gjo3bhhcbizppUKJFNfTbkQp/+y/P2y3F41o4jZXAW+cctsZ8g4zbinWYh05noYmntdVvQJTbEIZekKfbwVKDmh4IBN5FoVrk7oftdvr236iMAukam3Z/kPcfcseWhGq9nRVsUdjBh01V+IyhyoMm/ohQR57N6cvp9++X1QaOOsfVacUtY6qEny9jP72ThKGyb7vEZKgo70akpSdzritTjGaD8m2KvwFrqZZz7Qu6t2AKie7M/9QrdklwVLytyTD/g1NshoLBtm0RILUZ9t7nKUNDL6g2XvXXm+FgHaf+au4StfglFBOexUuhYALD4N8VMEAreCzQ6iTGbgSOrfL0GgXTLHHwli3z1nIxpJPKIBNKaHjrgaoEEcY64rDvkB3/tBp+maMSW/fcio54PSSzj4OvUamf+QLmglkUs8RryJJ1vc7jj9wGVjeLEYUFRof4+iOhcqlLMX4AMYun9zbGlhrwlz5qV9NouX217Mnkd9bbdJeOoIk2evqQd9WjCFMC6U7YWkbXgXhDHjJaOxNavqmnVAfbzZ0QS/+t21QsSMCrnVBl+QpCpn7hamyurgVejc3d8BuoFl0XpYaL9sbT1vaqjcw8DMO8uw2bG57j4JK0Ku3F1ZZ3RAKb3kNYZmdT5xuwe3qTq2qgvg9W2/g0HWuKierStFCbThAmqup6cXyLTH2tmw48ZLqPcsSw8cu5D4hLNVzvCVGHp5e3CLL+2LouJTw/T/0gXwIJiQwLNpuewThIx0qHhd0oMOMKFxgY4gaRGQCtTYesTa1xPSVD3LV3D2uu7AwfnURZGcyhyZ7I1LhQmNY/OFXRxaxe2v/0uQOTa4ljRSUa+62ppBaExyHebcrHNqLWq8+FG+W3fPbFSGGlPn4tx7ylOkWtp+BTcVkCkWLEFfslh/euUSxO2mvVW2etlebjmsKo/T7yaaMu6sYGKOpjVfGRSq9pdq3XhWVQ0P6X7b9LOOpVpOvdQ8XQ/n6pdvtqX9m9EhC+ve7XKPN7R7Qt4ttfnrlzxQDQTzvmz8Oh++YJ8ZinZS27nVZFDqa7FgbBp85WmuDPWm3mVAJrgFrkOzeIU9YON7u+ak46MnyoLfasWOdq6Qcgq1xqxkm9pvuj6VgLZ/s5fX+hV9hKOggz5ERgFdEysHLy6PhOqZsyXfcC0y5x9Ueb2wFBn3/HusW2jCp9ac8Y/ehOWk20ASkxqsitBL7oLkUF4hGYdUpuKnGW9iZJoPJuJtGnah19bBFmWTLG1yEXQZzRRDp7DrKjYw60bU3m0Wn1bqeausWnWu8wbKIVoAOvvOuE1wukjrmcuo5rgcNfFE/obEL4Ll7KB8a4RW55+3n7Y2UcOgWKpXJV3SmzmWbywQ0eCOlxeIcdRPnPgie4ZV1/UlA1Dk7b0Qj4AbMwSdMN87O60MHSNLrp5hQQcJMYIKyKslrGncw4tgr4LmbIhryHu2vU8s541dcyBAo2QDk+OAXrvgEEoaXgjDyoNV7pBRhEH/THwwPBr3BoH/yFoEbMgoCLZblL8ULaiKl0FFMg6Ji9HHhUj99HJLhYZQ5ra7197xD167l1yot1Z15Z3KoF4sql6hdYz8rnp5vKv9VU1avfm97s0Jy5fLzhlkhbahP2pz9VnM3paK1t+UF2fZ60uVvLkaP2o+eHLSfHzx8Nnz4uPP0Saf9sPn4H09/jfz9wO3vl3PEr0Bt5f7dWdG4qdYTcGD1oLpehD0DdInapZ66Hv2Fl7Pypsn6hZJwN4SucXjfql26WCK14XLA+vuiab3tzcap6y2/DUrY0oryDaPzdTy2DLvqEAvbLO3QO2n7hkjbdznaoXXR9o3Isb8oWoM11FA87Q2GGMDWw1wxAqurzABP5gdOH+A9Lox3NfRApUieiUTOWSk4G+VWKCyQBPPGk1BqNbEiCTflfe9DKI/cisYEjymY+xMFI4vttFqz2awZ8zRXCcdKMlqaFDEgGit7g9Gb8KSxMjnRsS1nC02/W6ao5bQCIduifK8o5kVXD/3ZYl3KVY3LoNa4WVVa7e9Jf/3La+1fXuG0cPDZtTLJhUIF01ZdB5hxhlr3QcRGha+hU3nEcBZdX+Nh997IxQIfUzvbH6wFwKBjtRFNgVMoOLuO6KyKXvuNORiiEFUUWut/LRrFjG4cQ+ZuHHtew0vvTgZDPPLC/9RSneAcw2f4HzY+izoRxTpSGQ6gZ9eR5GqSE7yMPE38/BdLt5sy +api: eJztW21zGzcO/iscfklyJ0vKW5vqcsnIttyqTeOcJScz9XhqeheS2HDJNcm1onr032/Al93VmyU7ufRmUn2SdkkABAHwAUDdUMvGhnbO6JCZj/S8QVMwiea55UrSDj0BW2hpiJ0AEdxYokbEMvMRnzBLDLPcjGbEANPJhGi4KsBYkjPNMtN8ealbr14W4tVLwV/1R4RJAlluZ+RSpTPCDcm1uuYppA3ChAh0mQaiHVdImy9bgrvZx1LMiJKA/C/OPLvuyIJukNqPY927KpiIz/ZhpDQs/gpDzi+izMot1ZCsMJZcAsk1GJCWcBmXE6RoFeIVbVCVg2Y4pZ/SDvVEUHeGNmiYsK/SGe3c0ERJC9LiV5bngiduXusPg6q9oSaZQMbwm53lQDtUXf4BiaUNmmvkYjkYN84yC7Vhxmoux3R5q4YTIG6o26MJeH02aYOCLDLc4oOTXnfYO6QNenD867s3vfC9+/ag98Z9Per28cv5vEGZMXwsIa3xvVRKAJMrjLsaKn4kTnxNKyo7SP9hotAi4mxiVUVzgZSp0WJas9laRcTRSDOYDZIb82uQ5UunHG4hM7tpd1ei83mDouCHMOKSR1vZrgFmH3hP23/361syEmpKpErBLT9hMuUps/CjVkW+ndqPTqgxDkZxuSQlBf/UOH9urtLeruCuJQIYBoNlJQTKtzLcWeWfx2ZeX9ipAb2rzgoDeoW0e7iqMKT7OfpCsqvrqDH7AsraygM1lWuVgDGVxf4Cs+1MT2AEGmQC6K6BBElLGuShBskySAlcFfyaCYyrakQwXP6nAD1rrrDtp2TEQaSPnJ7D6740lskE7i8TDxR2liiyLOVx4rAxDPif9WjGpYUx6BUpcFh1VuJE8jCFESuEJf8mz9uPcGtHSmfMeipPnyCHkRJCTU/zw8WIv+FgGGmVbVfIwDJtidt0zeTY6SWcfUgAzQJf7lmeAfEiEVVYwTEMc0kMJG4znze/i4Z1cnRAnj59+gPqd8RFaXD9wTF58V37MZ5DMmU6XVhlyQVXatV2yXsyXS+3VX+J1PMVpwuSqRFJC3ACGRSmdhzWlK00ErbcClwzbvERFxY0qiMt4O89/8b2HAe/Z5qzS7EDqulK4l4g45GjQRLBCgOGmBwSPppxOXZCXEeaKEgYioI4ON4f+QCNoBsHX2HUC4AbUY2YVYuYTngycdA8ckIYO/OEflJTuEb8zRG18CxX2jJpcZ5UFnx+YCfcBBFQugySCZPcZIQbRySFCu5Nlf5I4FMiCsOvQczIlNsJsbqQCbOQVstqkiGSzYBJT6VasBoRRgTTY9DEYAjGbEIqSxKV5czySwGBbCVYgzCZOjrMWsxP3NoL40BtRjKG6jEYuLkkXLIkKbRD2ZpwiXQF2EqPOHAtrtzgz3ga7YY+cWQ037hid0peM1HsSMMNXSFCPkxAbrIiPydsc6KLhDOBCsoYl5YhplDScGNBJmHLfh4cv/WzDHloQHMm+J8u9Sn9xKvtE/FKMcQUaGgeuj3C/SAgTaGDFfkFGaIBmaIRapVrzixaiXdaC6nThc/O1A5gbxjEYJobJUmcGPc+SloqyVnIP8gFXF10iMshTS21git67mB/8HQEFPuzyrvdO5BM2n56N18fulmkf1h3Z5/a+X3LCmH5niOezKJjgUS+6OMxKVMJd24UzB/CfnN0vopFPfv+l6PERyTlJlJDt3HZPdiAksdSaUhvQaq4dKO0vdOqS8NYNEqHxXyAVdq6R8HlyOXsDl7n6Kyzkbifwa+5kkM8Bho00cBqPxeAWnV8Ix+uNLczl0Qrne6Sd/yDXHQHBxcd0jUJyJTLcTS2w557fgjxRU3E7uCANiiO8Ka3hABQP5VuCIv7nXgl1o8lNNZjFHV/5nerqqhs3bRT46O3NxrCEOty6SzNc2+SbtzUEBO8T09UIVIsuCQqRyN0uAR39b0fhUYgF2sZfoyLH4XWCN3LupNfJ+LscMxZ4l3AJ9Tdd/1lIWGplJVyDYl1AQW3tuRKeArSeke5nLnHsWwVFtTwPqUBNWxj5QKXgmbrbGCbe6yUsL5dvSvtghCgFupVoK+3D75Q+A3uQK4hgRT+MpV/u7YfNf9XGj+XiShSuEdGUoT9CIc1QvDQKihBJILXlV0IHF3uFo7yXEkDZIq4xiFqd/A7sONUPPSwHUSKaYmamlDdchmXwPTPZQ4arOZwDdWZV6UI66CQ35KIe6I4ixv9dTE9E1M2M777clQI8X4J42+sxbt50egcZCqEWI/7X7vZriZFOyMmDNQRbH/RHLyJICjKQFrm2W3GTz8f7//+4fjkl94JbdDfer393u+ng97J78Pu4BcHjUqc1LlZLuAVi6mrKmzYIG/5XJM4uUm6vq+CJuZyV4TtvwFchgJn2QK5fcPgam1JL+OSZ7iedoNm7JP//rjdnjfo2K6vAt465a4zxD1m3FGs+SpyPAlNPK+regUmbkIZekKfbwlKDtzwQIZ6FtG1nbqftNur234sMQt01dqy/Ye4+449tBiqdnRVvkNjBh21kPyqgCoM6/oh4Tz2fk5fTr97v+g0GjjpH1anlGsdVSX4ehn97b0kDJN93yMkQYc7NSRddjplpjrF3HxIN1XhL9B6mvVM66LeDahysnvzD9WabRIsJH8LMuze0HRWY0AjmxZPkfp0c4+ztIHBZzR779vrrRDQ9jN/GVepGpzi0iqvwoUQcOFhkI8qGKAlfLIIdXIN11wVZhEabYMp5ohrY3c5C8lIsLELYBOX0DFbA1SII7Sx8bCP6M4fOk3fjNHZ3VtOJQecXtLZxaFXyPQPfUEzhVyoGeJVJEn6fsfxBy4Dy5txRKzQ+Bjn7ljIQohSjPegzeLJvamBtSLMtZ/6xSRabH9994z6vVU662WXkKY7XT3om4oxhGmhdMeN24bXQTgNXjI39jY1fdVOqI83a7qgF//bNijfEgFXuqAL8sRC5m5hqqwuboTezfUdsFtoxs7LQuNlc+NpQ1v1FgZ+xl6R34XNXe9RuBL08u2FZVa3hMI7XkNYZOcTpztwu75XqyoSf2DqDRx3navKyapSNJdrDpDmcmp6sXhLjLwtG06spPrAkFSzkQ25TwhL9RxvgZGHpxd3yPI+GzouJHz/D30gH4IdEhjGttsOQfhQhYrHhTvQYeooXGBjyDWInAnU2niOta4lpq99kKvm7nDdhYTxy4twdiYKaJI3POM2NIb5n351ziK2b+3fmtyiyZWk0QXlmrutKKTWBMdh3u2iQ3tR69WH+GbRPb9eEWLoMh//1kOesp6A7WcgEz6eQGwR4ort4sN7lyi2J+21qs3z9nLTcUVhLv1+ti7j7koCWivXxivjoiu9Zcq3XqUrh4b0v2z7GcIyJcdf6h4uhvLVS7ebU/9cq0sB2T/vc422MDtA3y62+d0rf6ZoCOJ53/xpOHxHPDGSqLS0da/LWOhokiOlCXxiaK0N8qzdJlymuAasQZIH+ywl4Xh74KfioGeLg94qS45UIdNyCLbGjSKY2K+7P5aBMWy8k9f7F36FoaCDPC81B7wiUg5eXJ4brhKXLfmOe8SUO1zt8cYWMejpKdYtlCZCqY9FTh5Cc9xsoAkIhVdF3ErMo+ZCXHA0olVnYCcKb2HnyhlMzuyEdmjr+nHLeVXLGxzFLoO+dhDp7IYWWtAOvfFmM++0WjcTZey8c4M3WOZ0CejgO+86weWoUAkTE89xNWjgi/oJjV0Az91D+dAIr8i9aL9or6WEQzdQqUy+ojOxNl9fJnCD11Kaz89RN0nhg+AZXllXHznQztl5g14C06D3PmK6cXZeHzpAkl4/cUIFCXOOCcqyJAdu3N4lw14BK+wE0ZD3aH+dWswIu2ZchEBJBiBGe78yycaQErwUhJEHrd4jJYpB/E1/MNwb9AaD/vFbBG7IKAg0X5S/FC+oySnFHcVuEI2jj6JL/fxh6AwPo8xJda2/5x26di2/Vmmp7sxbXUC9WFS5RO0a+1l8er6u/FdNWb76venNEsmly89rZoW0oT5pffZbzV2Xitbelhdk26tJl7+5SJ+0nzzba3+/9+SH4ePnneePO09eNNvfP/6N+vuBm98v5ohfgNrS/buz2Lip1hNwYPWgul6EPQN0idqlnroe/YWXs/KmyeqFknA3xF3j8L5Vu3SxQGrN5YDV97FpvenN2qmrLb81StjQivINo/NVPLYIu+oQC9ss7dA7afuGSNt3OdqhddH2jciRvyhagzWuoXjSGwwxgK2GuTgCq6tEA0tne1bt4T0ujHc19OBKkSznqZiRUnByWRgusUASzBtPQqHk2PC0jtLwbHLILTYmWOKCuT9RMLKYTqs1nU6bCcsKmTKsJKOlCZ4AorGyN0jfhCeNpcmpSkw5myv3u6VjLacVCJmWy/diMY9eP/Zni7EZkzUug1rjZllptb8n/f0vr5V/eYXTwsIn28oF4xIV7LbqJsCMM9S6DyKGRl9Dp/KI4Yze3OBhd6rFfI6PXTvbH6wRYLhjtUEnwFwoOLuh7qyiB35j9oYoRBWFVvpf80ac0U0SyO2tY89reOnd8WCIR174n1qmUpyj2RT/w8amtENdrHMqwwHu2Q0VTI4LBy+pp4mf/wJ5MpxC sidebar_class_name: "post api-method" info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Search tasks

+ - + Returns the list of tasks that satisfy search request params.
  • If an empty body is provided, all tasks are returned.
  • Only one of `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` search options must be present in request.
-## Request + -

Body

    followUpDate object
    + -A range of due dates for the tasks to search for. +If defined, the query returns only tasks to which all clauses apply.
    However, it's important to note that this filtering mechanism is
    designed to work exclusively with truncated variables. This means
    variables of a larger size are not compatible with this filter, and
    attempts to use them may result in inaccurate or incomplete query results.", + items: { + type: "object", + properties: { + name: { + type: "string", + description: "The name of the variable.", + }, + value: { + type: "string", + description: + "The value of the variable. When specifying the variable value, it's crucial to maintain consistency with JSON values (serialization for the complex objects such as list) and ensure that strings remain appropriately formatted.", + }, + operator: { + type: "string", + description: + "The comparison operator to use for the variable.
    * `eq`: Equals", + enum: ["eq"], + }, + }, + title: "TaskByVariables", + }, + }, + tenantIds: { + type: "array", + description: + "An array of Tenant IDs to filter tasks. When multi-tenancy is
    enabled, tasks associated with the specified tenant IDs are returned;
    if disabled, this parameter is ignored.", + items: { type: "string" }, + }, + sort: { + type: "array", + description: + "An array of objects specifying the fields to sort the results by.", + items: { + type: "object", + properties: { + field: { + type: "string", + enum: [ + "completionTime", + "creationTime", + "followUpDate", + "dueDate", + "priority", + ], + }, + order: { + type: "string", + description: "* `ASC`: Ascending
    * `DESC`: Descending", + enum: ["ASC", "DESC"], + }, + }, + description: "Sort results by a specific field.", + title: "TaskOrderBy", + }, + }, + searchAfter: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + searchAfterOrEqual: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + searchBefore: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + searchBeforeOrEqual: { + type: "array", + description: + "Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
    It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.", + items: { type: "string" }, + }, + includeVariables: { + type: "array", + description: + "An array used to specify a list of variable names that should be included in the response when querying tasks.
    This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.", + items: { + type: "object", + properties: { + name: { + type: "string", + description: "The name of the variable.", + }, + alwaysReturnFullValue: { + type: "boolean", + description: + "Always return the full value of the variable?", + default: false, + }, + }, + title: "IncludeVariable", + }, + }, + implementation: { + type: "string", + enum: ["JOB_WORKER", "ZEEBE_USER_TASK"], + }, + priority: { + description: + "Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks.", + type: "object", + properties: { + eq: { type: "integer", minimum: 0, maximum: 100 }, + gte: { type: "integer", minimum: 0, maximum: 100 }, + gt: { type: "integer", minimum: 0, maximum: 100 }, + lt: { type: "integer", minimum: 0, maximum: 100 }, + lte: { type: "integer", minimum: 0, maximum: 100 }, + }, + }, + }, + description: "Request object to search tasks by provided params.", + title: "TaskSearchRequest", + }, + }, + }, + }} +>
    -
    dueDate object
    - -A range of due dates for the tasks to search for. - -
    taskVariables object[]
    - -An array of filter clauses specifying the variables to filter for.
    If defined, the query returns only tasks to which all clauses apply.
    However, it's important to note that this filtering mechanism is
    designed to work exclusively with truncated variables. This means
    variables of a larger size are not compatible with this filter, and
    attempts to use them may result in inaccurate or incomplete query results. - -
  • Array [
  • * `eq`: Equals","enum":["eq"]}}>
  • ]
  • enabled, tasks associated with the specified tenant IDs are returned;
    if disabled, this parameter is ignored.","items":{"type":"string"}}}>
    sort object[]
    - -An array of objects specifying the fields to sort the results by. - -
  • Array [
  • * `DESC`: Descending","enum":["ASC","DESC"]}}>
  • ]
  • It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.","items":{"type":"string"}}}>
    includeVariables object[]
    - -An array used to specify a list of variable names that should be included in the response when querying tasks.
    This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results. - -
  • Array [
  • ]
  • priority object
    - -Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks. - -
- -On success returned. - -
Schema
  • Array [
  • variables object[]
    - -An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`. - -
  • Array [
  • draft object
    - -The draft value of the variable. - -
  • ]
  • ]
- -An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request - -
Schema
+ diff --git a/docs/apis-tools/tasklist-api-rest/specifications/sidebar.js b/docs/apis-tools/tasklist-api-rest/specifications/sidebar.js deleted file mode 100644 index 8c3ec36257d..00000000000 --- a/docs/apis-tools/tasklist-api-rest/specifications/sidebar.js +++ /dev/null @@ -1,78 +0,0 @@ -module.exports = [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/tasklist-rest-api", - }, - { - type: "category", - label: "Form", - items: [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/get-form", - label: "Get a form", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Task", - items: [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/save-draft-task-variables", - label: "Save draft variables", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/search-task-variables", - label: "Search task variables", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/search-tasks", - label: "Search tasks", - className: "api-method post", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/unassign-task", - label: "Unassign a task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/complete-task", - label: "Complete a task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/assign-task", - label: "Assign a task", - className: "api-method patch", - }, - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/get-task-by-id", - label: "Get a task", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "Variables", - items: [ - { - type: "doc", - id: "apis-tools/tasklist-api-rest/specifications/get-variable-by-id", - label: "Get a variable", - className: "api-method get", - }, - ], - }, -]; diff --git a/docs/apis-tools/tasklist-api-rest/specifications/sidebar.ts b/docs/apis-tools/tasklist-api-rest/specifications/sidebar.ts new file mode 100644 index 00000000000..94424ac0984 --- /dev/null +++ b/docs/apis-tools/tasklist-api-rest/specifications/sidebar.ts @@ -0,0 +1,84 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/tasklist-rest-api", + }, + { + type: "category", + label: "Form", + items: [ + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/get-form", + label: "Get a form", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Task", + items: [ + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/save-draft-task-variables", + label: "Save draft variables", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/search-task-variables", + label: "Search task variables", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/search-tasks", + label: "Search tasks", + className: "api-method post", + }, + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/unassign-task", + label: "Unassign a task", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/complete-task", + label: "Complete a task", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/assign-task", + label: "Assign a task", + className: "api-method patch", + }, + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/get-task-by-id", + label: "Get a task", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Variables", + items: [ + { + type: "doc", + id: "apis-tools/tasklist-api-rest/specifications/get-variable-by-id", + label: "Get a variable", + className: "api-method get", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx b/docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx index a8d732b0d7d..50bd714d180 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/tasklist-rest-api.info.mdx @@ -9,16 +9,78 @@ custom_edit_url: null --- import ApiLogo from "@theme/ApiLogo"; +import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; -

Tasklist REST API

+ Tasklist is a ready-to-use API application to rapidly implement business processes alongside user tasks in Zeebe. -

Authentication

- -Cookie-based authentication is only available on Self-Managed clusters. - -
Security Scheme Type:apiKey
Header parameter name:TASKLIST-SESSION
Security Scheme Type:http
HTTP Authorization Scheme:bearer
Bearer format:JWT

License

License
+
+ + + + Cookie-based authentication is only available on Self-Managed clusters. +
+ + + + + + + + + + + +
Security Scheme Type:apiKey
Header parameter name:TASKLIST-SESSION
+
+
+ +
+ + + + + + + + + + + + + + + +
Security Scheme Type:http
HTTP Authorization Scheme:bearer
Bearer format:JWT
+
+
+
+
+
+

Contact

+ + URL: [https://www.camunda.com](https://www.camunda.com) +
+
+

License

+ License +
diff --git a/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx index 2e474e4b709..5b36891f33d 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx @@ -5,47 +5,231 @@ description: "Unassign a task with `taskId`. Returns the task." sidebar_label: "Unassign a task" hide_title: true hide_table_of_contents: true -api: eJztWG1vIjcQ/isjf7mcugGuTasKVa24HGm5lyQC0pMaRXdmPbC+eO2N7SWHEP+9Gnt3gUATcu3HfsKsZ5558bzZS+b5zLHuNRtzd8tuEibQpVYWXhrNuuxKc+fkTAMHz90t3EufwWdaDsTnFgzRl1Y78BmG/RZLmCnQcmIfCNZlZQUQ4BNWcMtz9GhJ5pJpniPrsojHEiZJZsF9xh4qMs4QBm/ATLdkWbwrpUXBut6WmDCXZphz1l0yvygI2Xkr9YytVjdE7AqjHTra/77ToZ9tIRcaXJmm6BzYYBkKkpIa7VF7oudFoWQazGt/ccS03BVqJl8w9WStJWd4GUVKsavYPjNLLe9KBClQezmVaLetXiWV2w7BIsoddlq8wanUsj6mp6CuHFqgI6QzmFqTB8DXlx/OQTRAAbuwhvx3/k0aVswBKLUY3PyG+wOQPmao4Z6vIxECPwo4skgiBFCozLlC7UncZ7KmVQsZyxw/w1SiEi+jdJMXCv+V/IjwpAaNoB0dYuLggX4sHVoS05aC0O8zA9JBhSHAm90YGPmDbCN0R6S72cfFhVaLOvtQlzmVktNhvzfuv2EJO734cPm+X61756f992F51hvQ4maVsKmx+TtcPK3FEKdoUae4aQoQe7CHFodE8g5MLCocBBbKLFBESBhEU+kP+VEb31Ak4DPpoEruRdgulWrU+BOtk7E0VLpI7XGG9mll5pH1P9MoKsR91OGnE1JRujNj834+QSFw02MTYxRyvaPlwK0FY8VG/6JQOobfKuUsRs0C7WNuqhJ9XYSeHwIVxEb9eTzRdkQOxFa2VfsD7TzXKX67QrJCAPlE6j+Q+EAfj5prf0hIU35Gagpm7pxJZSh9oVlvZb0o8bB6RpiiRBCU9vGs13nfxBTtHnuZYwx9pcz9VXG4gMhxXBbPEZNyLSR9+d2asnAbkri1fLFXUMMDs8C0I0p6zN2+sWFDHvXA54qjovwsaZK6QY7ac79dQho31kX27cXrTx8vhu/6Q5awv/r91/1PV6P+8NO4N3oXKmthpbHSL3bHnHFotXE3lpqmv7eANjM5yzDqPOeqxLDa+Fgzt6AX56GJQjBaLYKpfyFOcA3pyOSdQphLLXOypJOwnH+N61edDvlzykvlWffHDnnES6+IlaCG1QTHVivaOtk3w/U0oLXGUr2phzi4p/bcNI2qevLUyznCEa1l3K46V2x3L1u/TGz7172Act0JQ9snjFRxSbl+VDfdlzDBqbH4yAxZWDNRmH/33FmSFCzdAS2mp6HaAp9xDxYLiw61j0X9j/H4EiIYpEY0LT5aXE/MLTgzFvArp+hM4KTTAakF2YAOOLx4zQUM8a5E519EViI62SY6Nx7OTKlFQ8K1AGeAJsftRvXD95TpOTrHZwfUkh7EjWhhYc1ciiBzYiVOYYN427xAbtK0tJYGfUq/qhY/LbMfQ6Ku9VdXNBgbC8qY27KAI2zNWgmFlTIzqCxxVNk3QjpgNLF88k2x3NT4+lJWR/eUXP1/5P0feY9HXrDWZ0bEi3eahUu6z1iXteev2hRUrr2MsbVq17d5ljCHdl5f40urWJctYwituu32MjPOr7rLwli/YgmbcyupSYS4ob0Y61WhZ8qkXIXP+9opbWzeEnuXA4jS4+Bm7AO4nzs/d/YiEek/oKzDf42TeV/svw0F4r1I4aXBYVrG1nu9ZKkxtxJZ9/omYRPkFu3xLQ2X1zebpCOCjP6pGdaTRiFpHH2oyWmgO55whwJ46TN6L4jZTUUg9GM+51JV7RlGqKbHH7jmMxSQqtLROwxlQPUMQ6PD+8FofDzqj0aDi/P6QaZSaLWtf6Ne5abglHCPCESspj6r0+vtx3GccfTUBPaNzq6k8zDsj8bkzV2f1xR0owW6di6OvTkuXXT+RlmjQdzyQgq1gGaWgknppKbZvBq5KUWV0TMnRZzRQi2l0T0OL3XZ5GmIrBjeZKbrttv39/etlOelFpxu7+QWJVOksaTbvGi9r74kD5iFSV3DLU3437b1NaJdAbk2oc7reySbv4qB7nzO9YaUB69zD/22XNf+b3nIq47X41ffLhSXmpQI5iyrEnFNmsW3BMcS1m3e8Zo6cZNU6X7NlkuK1CurViv6fFeiXcSsqKtDSBchHa0F6065cviISUfD6vXvJex/HdxrQJ1TehHqkirpH0tYiOn6JXJFA3SGXKANSsXNXppi4TfYdl4DKaObcnrZG5/+wVarvwHbGGKv +api: eJztWG1v2zYQ/isHflmKKbbbZcNgDBvcxNnclySwnRVYELS0eLa4UKRKUk4Nw/99OFKS7dhLnG4f+0mUePfci+6NXDLPZ451b9iYuzt2mzCBLrWy8NJo1mXXmjsnZxo4eO7u4F76DD7RciA+tWCIvrTagc8w7LdYwkyBlhP7QLAuKyuAAJ+wglueo0dLMpdM8xxZl0U8ljBJMgvuM/ZQkXGGMDgDM92SZfFzKS0K1vW2xIS5NMOcs+6S+UVByM5bqWdstbolYlcY7dDR/qtOhx7bQi41uDJN0TmwwTIUJCU12qP2RM+LQsk0mNf+2xHTcleomfyNqSdrLTnDyyhSil3F9plZavm5RJACtZdTiXbb6lVSue0QLKLcYafFGU6llvVvegrq2qGNATA4g6k1eQB8ffX+AkQDFLALa8h/F1+lYcUcgFKLwc1n3B+A9CFDDfd8HYkQ+FHAkUUSIYBCZc4Vak/iPlFAtmohY5njJ5hKVOJFlG7yQuF/kh8RntSgEbSjQ0wcPNCPpUNLYtpSEPp9ZkA6qDAEeLMbAyN/kG2E7oh0N/u4uNRqUWcf6jKnUnI67PfG/TOWsNPL91fv+tW6d3HafxeW570BLW5XCZsam7/FxdNaDHGKFnWKm6YAsQd7aHFIJO/AxKLCQWChzAJFhIRBNJVeyI/a+IYiAZ9JB1VyL8J2qVSjxp9onYylodJFao8ztE8rM4+s/5tGUSHuow4/nZCK0p0bm/fzCQqBmx6bGKOQ6x0tB24tGCs2eotC6Tf8VilnMWoWaB9zU5Xo6yL0/BCoIDbqz+OJtiNyILayrdofaOe5TvHrFZIVAsgnUv+BxAf6eNRc+0NCmvIzUlMwc+dMKkPpC816K+tFiYfVM8IUJYKgtI//ep33TUzR7rGXOcbQV8rcXxeHC4gcx2XxHDEp10LSl9+tKQu3IYlbyxd7BTU8MAtMO6Kkx9ztGxs25FEPfK44KsrPkiapG+SoPffbJaRxY11k31y+/vjhcvi2P2QJ+6vff93/eD3qDz+Oe6O3obIWVhor/WJ3zBmHVht3Y6kp6/7eAtrM5CzDqPOcqxLDauNjzdyCXpyHJgrBaLUIpv6FOME1pCOTdwphLrXMyZJOwnL+Ja5fdjrkzykvlWfdHzvkES+9IlZKmWE1wbHVirZO9s1wPQ1orbFUb+ohDu6pPTdNo6qePPVyjnBEaxm3q84V292L1i8T2/51L6Bcd8LQ9gkjVVxSrh/VTfcFTHBqLD4yQxbWTBTm3z93liQFS3dAi+lpqLbAZ9yDxcKiQ+1jUf9jPL6CCAapEU2LjxbXE3MLzo0F/MIpOhM46XRAakE2oAMO373mAob4uUTnv4usRHSyTXRhPJybUouGhGsBzgBNjtuN6odXlOk5OsdnB9SSHsSNaGFhzVyKIHNiJU5hg3jbvEBu0rS0lgZ9Sr+qFj8tsx9Doq7119c0GBsLypi7soAjbM1aCYWVMjOoLHFU2TdCOmA0sXzyVbHc1Pj6UFZH95Rc/S3yvkXe45EXrPWZEfHgnWbhkO4z1mXt+ct2KODtZYytVbs+zbOEObTz+hhfWsW6bBlDaNVtt5eZcX7VXRbG+hVL2JxbSU0ixA3txVivCj1TJuUqfN7XTmlj85TYuxpAlB4HN2MfwP3c+bmzF4lI/wVlHf5rnMz7Yv9pKBDvRQo3DQ7TMrbemyVLjbmTyLo3twmbILdoj+9ouLy53SQdEWT0T82wnjQKSePoQ01OA93xhDsUwEuf0X1BzG4qAqEf8zmXqmrPMEI1PX7PNZ+hgFSVju5hKAOqaxgaHd4NRuPjUX80Glxe1BcylUKrbf0b9So3BaeEc0QgYjX1eZ1ebz6M44yjpyawb3R2JZ2HYX80Jm/u+rymoBMt0LFzcezNcemi8zfKGg3ilhdSqAU0sxRMSic1zebVyE0pqoyeOSk2BxVKmjC81GWTpyGyYniTma7bbt/f37dSnpdacDq9k1uUTJHGkm5zo/Wu+pI8YBYmdQ23NOG9betjRLsCcm1CndfnSDZ/GQPd+ZzrDSkPbuce+m25rv1fc5FX/V6PX3y7UFxqUiKYs6xKxA1pFu8SHEtYt7nHa+rEbVKl+w1bLilSr61arejz5xLtImZFXR1CugjpaC1Yd8qVw0dMOhpWt38vYP/t4F4D6pzSi1CXVElvLGEhpuubyBUN0BlygTYoFTd7aYqF32DbuQ2kjG7K6VVvfPoHW63+AdsQY08= sidebar_class_name: "patch api-method" info_path: docs/apis-tools/tasklist-api-rest/specifications/tasklist-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 ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -

Unassign a task

+ Unassign a task with `taskId`. Returns the task. -## Request + -

Path Parameters

+ -On success returned. + -
Schema
- -An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before. - -
Schema
- -An error is returned when the task with the `taskId` is not found. - -
Schema
+An error is returned if the task was not claimed (assigned) before.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + "404": { + description: + "An error is returned when the task with the `taskId` is not found.", + content: { + "application/problem+json": { + schema: { + type: "object", + properties: { + status: { + type: "integer", + description: + "An integer that represents the HTTP status code of the error response. For example, 400 indicates a 'Bad Request' error, 404 indicates a 'Not Found' error, and so on.", + format: "int32", + }, + message: { + type: "string", + description: + "A string that provides a brief description of the error that occurred.", + }, + instance: { + type: "string", + description: + "Error instance UUID for lookup (e.g., in log messages).", + }, + }, + title: "Error", + }, + }, + }, + }, + }} +>