Skip to content

Commit

Permalink
Merge branch 'main' into 26700-document-spring-sdk-config-options
Browse files Browse the repository at this point in the history
  • Loading branch information
mesellings authored Jan 14, 2025
2 parents aca0441 + 4526f0f commit 9e9c114
Show file tree
Hide file tree
Showing 162 changed files with 2,425 additions and 2,834 deletions.
823 changes: 505 additions & 318 deletions api/camunda/camunda-openapi.yaml

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/tasklist/tasklist-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -725,7 +725,7 @@ components:
- JOB_WORKER
- ZEEBE_USER_TASK
priority:
description: Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks.
description: Rules to filter out tasks by their priority. Applicable only for job worker-based user tasks managed by Camunda.
type: object
properties:
eq:
Expand Down Expand Up @@ -859,7 +859,7 @@ components:
- JOB_WORKER
- ZEEBE_USER_TASK
priority:
description: The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks.
description: The priority of a user task. The higher the value the higher the priority. Applicable only for job worker-based user tasks managed by Camunda.
type: integer
minimum: 0
maximum: 100
Expand Down Expand Up @@ -957,7 +957,7 @@ components:
- JOB_WORKER
- ZEEBE_USER_TASK
priority:
description: The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks.
description: The priority of a user task. The higher the value the higher the priority. Applicable only for job worker-based user tasks managed by Camunda.
type: integer
minimum: 0
maximum: 100
Expand Down
18 changes: 13 additions & 5 deletions docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: camunda-api-rest-overview
title: "Overview"
description: "Interact with Camunda 8 clusters. Activate jobs and run user task state operations for Zeebe user tasks."
description: "Interact with Camunda 8 clusters. Activate jobs and run user task state operations for Camunda user tasks."
---

The Camunda 8 REST API is a REST API designed to interact with a Camunda 8 cluster.
Expand All @@ -10,15 +10,23 @@ The Camunda 8 REST API is a REST API designed to interact with a Camunda 8 clust
Ensure you [authenticate](./camunda-api-rest-authentication.md) before accessing the Camunda 8 REST API.
:::

:::note
The Camunda 8 REST API only supports user tasks managed by Camunda (formerly known as [Zeebe user tasks](/apis-tools/migration-manuals/migrate-to-camunda-user-tasks.md), which may still appear as such in your XML content).
:::

## Context paths

For SaaS: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v2/`, and for Self-Managed installations: `http://localhost:8080/v2/`.
### SaaS

:::note
Find your region and cluster ID under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Zeebe component.
:::
Example path: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v2/`

### Self-Managed

The context path should match the host and path defined in your Zeebe Gateway [configuration](/self-managed/setup/guides/ingress-setup.md). The path used here is the default.

Example path: `http://localhost:8080/v2/`

## API Explorer

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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: eJztWFFv2zYQ/ivEPW2YIrld2nV6c9N0S9emQeJuD6kfTtLZYiuRKknFMQz99+FE2ZYtJwuGFdiDAxixrNPdfffdR4q3AodzC/Et3Mi5wgKmAeiKDDqp1UUGMSRGY5aidZ1BABnZ1MiKLSCG1+v7VqCwrU0IARj6VpN1r3W2hHjVXkpDGcTO1BRAqpUj5fgWVlUh0zZg9MWyzxXYNKcS+ZtbVgQx6OQLpQ4CqAyn5yTZ1q6Nd4kl8dVuYpOchMKShJ4Jl1OXm3BabCBxol0A64xUc2gCuEMjMSl8AMwyyf6wuOoF9hiG4boQGw8CuSjvbj5eCg+gF7BD1ATgSKFyXOxDEC7erAF4O+FydEIvlO2hOgCkCXpFv+1XahqAk65gY8/phsJrTxo0jX/cVlpZX4jno9Hh/DrMC7S7df3XDGNRfJxBfLsf7DVaElv6xUwbMcjfZzws837jPF7zrtLb0q97h0s/QDos/IPl9ekxEmimh5v5D1oeTqpW8ltN3yOpunCtRZ+nO5WFKZa1yjDESoZfaWlDVZcJmZ+GHGZUGUrRbQV+ZPU7siqVozkZCGCmTYnO//Ty9ClpPo1pD/sA00de/x9qZZvTh9bkyug7mVEmMnQopBVKO3GHhcweWZkro5OCyoPq7gcYiytvKTJyKItua+O9zhsmlAmpxO312zPx6+mLX6Y/5M5VNo6ixWIRmll6Qpl02oTazCMzS/nDdj+GYpKTIVHiUiQktntvv5FsRamcyZQ3cuextslwCcPP6p97qb272it5T0m1kYOXnLH4dH0hZEbKydlSqvkwdPvMDJmdGDDRtYuTAtVX2JI5DLofxdZliWa57pndAE0A1qGrezAeWAl+fj7wzW3x+2RyJbwLkeqMWlG6XNp1IAZRSiXLuoT4dDQKoMR7f/VyNGrYJzP+BCRK0H1VoGpbax+OVKLUhrr+aYFJZR2q9L9iRhs5l/txwx1hdU38xiNaC+r00ZecTkkzXaujko5KOirpQSW9OLQ1jZXgKhvuQzJGG6HTtDaGMrHIZdG6T8nadezuDOl78ai1o9aOWhtqrQmgJJdrntVU2ratgy6HGCK/a9lo86oJAVgyd2Rs+8ZemwJiWHnJNHEUrXJtXROvKm1cE90xHzvTEL7tpbVumUKnWOQ+7JA6vtEfwZz5Y4Z4Ja7PbybiN3S0wGVbSg656/rV6NXooFc2fcDj+OpCeIS+8XqLwdotq/qgW2/8FMcNnwYspbWRbnnDj/nyJISGzLjm6m8aoovXeudrbwRB9+Xtuk3e/TVpmeaF7Ho7PDu/x7LyMuwPu7Z91idoZ5jUG2lJNdNtSl0XDcGxIzLWV2MUPht27NVFK7xUl2Wt2tVXzcVCulxgr1hpUVvHRQqgkCnxeTNegfI5r83e+zviTx9RPAuZaN+N60V3Ll1eJ2Gqy6g7nG7+J4VOohKliroQNjobf/h0+WZ88v7i7Pzy5vzkWTgK3b2farAoSlS9PDanqe69bh/sarvZPDTe7Mh1dO+iqkCpuMwtglUnv/XIzTLVGwFOg05Et7BaJWjpkymahn/+VpNZQnw73VLKV00AOWFGplXsVz5uwpnP7mTCSbB5UXMygzFbE6yfGKcpVe5R22lvHbn6eDPhtLvhbakzfsbggge7uIAYPsNnAB4Vs4e2+dvfV1Cgmtc4Z3vvl//+BshkxRc=
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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+NL2jqLoxG4SfvM5Sc+5NvX4pZ052zMByZUEGwRYALTM0fC/3yxAStSbnbS9b86MJxKJfcHu8yyg3QVzfGpZes0+6YzdRkxXaLgTWp0WLGW5LiuJDullxAq0uREVvWUpO+neAYc7ncFcuBm4GcJUPKCCijdS8yKC+UzkM+BS6rmFTp9QU7+UW6tzwR0WYNE8iBzBcXsf3ygWsYobXqJDQ+4tmOIlspTd6ew/2LCICfKh4m7GImbwj1oYLFjqTI2bjl7OEO6xAT3xRslZp3tXMGYRs/kMS87SBXNNRVaEcjhFwyI20abkLjz68ZC17W0wh9b9SxcNyaysT7i0GLFcK4fK0TteVVLkPqDjO0vuLLat6ewOc0dbNhR+J9DS2wduBM9k+MKLQpAWLs8Gi/Ztdyk63Oly95Qq2vameVVLSVJBb0sbtbV0uzxdX7rLhSDbB733ofAOcAsFZbYUCgvIGr9krs09mhguZ8LCpFZ52K5wDQgLeW0MKicbsHVVaUOqtJINSdcWjQcOSGEdKjS2g9BaPAtUgrK03E2mtUSutpB9qgrKGVqYz9DNSPnSP/Ba7PJJBCLGGPCR8izIv0KjVd854FVl9AOCcDF81AbwkVMMIuA7HIacK1LdDKMltKL48bA0a8Ci67hDIZJ8SumlBMRwqsLTpZW9eoQFg5VBi8qF6AcCuxl3w42SR0vo+IxR+GI4tsC77G5Z6ZgRbBBUsACuCr/MGzdYcqEs8NyJB4zhPU54LZ3HqWdPSNwWEnNtDHpE2F1wXM/fp4tfP0N4F8oSd86IrHY+b9zBHA257VVuAfBG3SgC8ERTzaJwD8QpKNlANoIVMYfr5kJKWiimShssUlL6D/jCrRVThfgFRhRCdGSbYCIKb0gBlpVr4MIZoaZepKjxPXffIhEcv6q+USznqhAFd/iT0XVln5Mk5K7LXVk0Xy9WGaGNcA0JlEKJsi4hiaDkj/7jQZJEUAR0wFFC8TsbaOuquba4HnVKNnwh+HyBBy5rBG1AlyLwRjjwwDcPaG8U5bxCY4mCxUrNdzZI7kLiZknp8znApPUR3cLkcbeyL4j+nNuF9C7fuzQuzyKK9siJErfMEHCLGoFWPGtqCJS/YC+oGdXV11ldx8vALjeGNzstEGhI71LUV1C7aUo4LO32RtqnnAhg/5NeTL3wX3CjJ8GzV4/Xr3a61MtvutARiqVJxDpGsZQotelCGzEnHH2lC+C5r+ong1q7c8Hm05PlAXAe6j9r2zZcHyqtbKDKq+QwHMKbe/A3Em4HVwRb5zlaO6mlbGKK22GSPCG7fvGkm17OldIuFOpOaQy/aIN07eBCWuAGu+qEBQjl5Xt3IdNFE9i/5yZXGZ1JLP+5faPbID2chZWd3f5Q8qcpLcyC9evzjyfw7vDoze33M+cqm47H8/k8NpN8hIVw2sTaTMdmktMfrfuBrkl0iJW8oW0ODqFVgQJbYS4mIve3BI+W4AwhLezv6QtoePtEXaiN2C50cHV+CqJA5cSk6W/6a6a9jK/sxLdM1y7NJFf3bAWrZ8sp2LosuVkif91AGzHruKvtnyXWvy8vzyCogFwXVORMuGB1htZYdpgMefZjklAd9xn/ip0of3nkivf3tOF2hIJyhVu/MaGs4yr/uzKjjZiKTbvxGsU7EL8POwrcPnySztuUJIYTJye6VkX8Qq0Xar1Qay+13n0TtYTtT7C50WrqY4urH8wvJ98LPV/o+ffR82jXZfRYAUXZEA7RGPrRmXsGFtQAlV493Wl7212j5IVrL1x74do+rrURK9HNNE0iKm09dKjhn7Lxnc7seBGGAe141YGkZj61d7qhQW0kS9kiMKdNx+PFTFvXpgvqILfjB0rLWpudXgeG9ciROudyFqxvZ5Be0GSi39kJL2tVcHgL5x8uLuEn7nDOw49YMrmu+m3yNtn9s14bt0fj8dkphB0G/A1qQq+WyL1TbVj8NYr9mMNiXlNz4YLEQngy5AbNcU1JWOKis+e1+7a6X8Si7sPHHi2ffr/0Cad6dr4aoXwIHevNicfa+KFv3Yce3EYzeNWEG6C/76KxV8mro1FyMEreXR4cpcmb9OBN/Pp18l+22f/as/KAVm72rK57S7c7WknDl6sGT+LxLNRE+9B1oN9OAiGSmpI+a0l8sE2ws1NfJ3JdlrXyh4Wa9q3Plb5c1tZRMiMmRY7K+gh3U7R+2c/hDfwWLMJBTIAMrOnPiKlwszqLc12O8yC2/D+TOhtTQ3/cmbDjk+Nfrj6/Px79fHry4fPFh9FBnMTuMbSMiMMlV0M/+vnC3faAcbE6F//vs8YOyQ4f3biSXCjilg/Dois51zR5tCxi6XICOag6t1FXOa7ZYpFxi1dGti09/qNG07D0+nZVaHxlKoSlz6uh4d69f3/ezRd/gOcnmTs30nc2VePLnazpG4vYPTariWp720ZshrxA4x0ML0+CG6NLUrES3hprtlEvcZznWLk9a9euNFRjlvX97NeLSyoZ3Uy11AXJGj6n8S6fs5TdsBtyWldL4vvnCya5mtZ86qfDXi/9+x+tfrdp
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand Down Expand Up @@ -42,9 +42,9 @@ The variables to complete the job with.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"additionalProperties":true,"description":"The variables to complete the job with.","type":"object","nullable":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>result</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The result of the completed job as determined by the worker.
The result of the completed job as determined by the worker. This functionality is currently supported only by user task listeners.

</div><SchemaItem collapsible={false} name={"denied"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a Task Listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false.\n","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>corrections</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
</div><SchemaItem collapsible={false} name={"denied"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a user task listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false.\n","nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>corrections</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

JSON object with attributes that were corrected by the worker.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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/isEP22YIrtt2nX65qbp5r6kRuJsH5J8oKSTxYYiVb7YMQz99+FEyZYtO02xASswFygcmcc73t3znE+8FbVsZmh0Qz+BMWwG9C6gqgTNLFdynNKIJkprEMxCKxHQFEyieYkiNKITFwtucjCEkcLLECZTst5oCLfEKsKIcfF6Z3grx9laiCtJuCHGJQkYkzmBexZcCKLBOi2JzYFkXBtLSq1QhnBpLJMJkHtY1sut8bXhlCy4zcNbOe2sckOksiR2WQYa0vBWXhuo95fekbUkyLRUXNZnNyDTdsEQmzNLEiZJDF1FNKAavjow9o1KlzRa1Y9cQ0ojqx0ENFHSgrS4xMpS8KT2fPDFYCRX1CQ5FAz/sssSaERV/AUSSwNaasyK5WBwVbIC8HM7EV0vUYIwQ1LIuISUcB/BN5NPF20A6/M2dozVXM5oFdBOQj7Acr+RbtIw+Crrxr+nFQGTMScsjSiamDPNWSy8K4ddWIuhH++vPl+QVCWuwPAFlKUpxz1MTDqR8UHejZ10QqAiv14F1IJk0iK6d+2jG36VZEqTRc6TfAtb3LQwgXSPozum0Ba3+Njy62wTuksPFVpVKKfBlEoaH5Tnw+HjseGmi3KriJJAlCaF0tAjiKHfAbzDNjuZ7thuVgNM0gKEwM9vcJXbW9nnKO0njgnxOaPRze6p3jBTe9nkvU7Vvvj6iIZ7NG/T6TAephs8jN8e9r5PpG9k3p8M/aDV3e5xGqUH6fdoIvZxusnCuEnCUxQfSN8jZfb7Y4AVAYW6gJzLNExY4WTKQlby8B6WJpSuiEH/8sOAlXyAJWHWah476+uTdAVonpA5Ew6Mh3MKpYYEtx2qTEeA/xOAc2lhBpoGNFO6YNZ/9er0P4D84aM8KU5Po4EP/Y9Dg2PN/r/WbBQ7PdSjlFrNeQopSZllbbs9Z4Knh/uQUqtYQPFNbI/IxEuSFCzjgnh0+E4XBWPf695cvjsjv52+/PXup9za0kSDwWKxCHWWnEDKrdKh0rOBzhL8j3I/h2SagwZSsCV29Zv+sgtaU0LCM55gx2W9q/VhMIj76bAD2np11Wsb10XDad57vxqR68sx4SlIy7Mll7O+6a0Wm8XK2SgWTN7TTTr7RnetGFcUTK/RtG2gCqixzLqOGweK3ovnPd2Iij+m0wnxKkiiUqgLgM2xn/aG0ImCS164gkanw2FAC/bgn14NhxXqxIw/wRNJ4KEUTPoXlB13uPRNstdWO9Yy5V/KjNJ8xnfthlvUakD81nvU8ulFH+/vlI55moKs4Umat8uWVEwItYA0PPLqyKsjrw7y6rSP9wuFL/hOHn+SjtQ5UucQdV7ua/FGkmCUNeIQtFaaqCRxWmNLmXOxvn5qbTe/WR6LR64duXbkWp9rVUALsLnCgUupTA0dZnMa0UE7dBh0bt1pQA3oOWhTv2k7LWhEV541VTQYrHJlbBWtSqVtNZhjSrYu3XHZs6tFjVAJE7m33M8eLtQThcarM381QV6Ty/OrKfmdWViwZR1NNLmt+vXw9XCvVhQ9oHE0GRPvocdepx60apHYe9V64acorvA93kDiNLfLK9zmwxMD06BHDhOwxkRjr9aOz16IBs0f71qkvP9rWicba9nlZhp0/sCK0jPRT282INsduWxWuknbmlt0Lgq4zFR9zAZcfYdREWjjIzQMn/WBPBnXfExUUThZF2U5qy8ICOsEMBHOWAxcQAVPAO+tNt60Yh/9CvnTWyTPQky+R2hbi2fc5i4OE1UMmkuu9WcsVDwoGJeDxoQZnI0+XV+8HZ18HJ+dX1ydnzwLh6F98FfHyJWCye452huOzuXKlrerzY/QcXTZHV02OLfwYAelYFwiuurErZpidNNec5lt1OLQ2JeUG7paxczAtRZVhV9/daCXNLq524AZn6qA5sBS0HX9uq9Rf+bTcjLFc6C4cHie3riqCtodoySB0j4qe9cprJPPV1PkazObLVSKezRb4NyWLWhEb+ktpTgARw11Kai/X1HB5MwhmCLq9eK/vwFEPvYN
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand All @@ -31,6 +31,8 @@ import TabItem from "@theme/TabItem";

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.
The message is not buffered.
Use the publish message endpoint to send messages that can be buffered.

## Request

Expand Down
Loading

0 comments on commit 9e9c114

Please sign in to comment.