Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update camunda REST API doc #4798

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,772 changes: 1,456 additions & 316 deletions api/camunda/camunda-openapi.yaml

Large diffs are not rendered by default.

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: eJztWFFv2zYQ/ivEPW2YYrld2mV6c9N0S9emQeJsD4kfTtLZYiuRKknFMQT99+FEyZYjp+uAPiaAEcs83nf33X2UTjU4XFmIbuFarhTmsAhAl2TQSa3OU4ggNhrTBK3rDAJIySZGlmwBEbzp161AYVubCQRg6GtF1r3R6Qaiur2UhlKInKkogEQrR8rxEpZlLpMWMPxs2WcNNsmoQP7mNiVBBDr+TImDAErD4TlJtrVr8S6wIL7aD2yekVBYkNBL4TLqYhNOi21KHGgHYJ2RagVNAPdoJMa5B8A0lewP88sBsM9hDNdBbD0IZFLeX3+6ED6BAWCXUROAI4XKMdmHUjh/2yfg7YTL0Am9VnaQ1YFEmmBA+u2QqUUATrqcjX1NtyW88kWDpvHbbamV9US8nE4Px9flvEa7z+sPrfBftDmMXin5tRqS1FeZSRrF1EFJ5WhFBgJYalOg8z+9Pv7vYnQl+H9wg4o8ybtnuiP++CmuS6PvZUqpSNGhkFYo7cQ95jL9BuOl0XFOxS9j5vcBZuLSW4qUHMq8a1nuYW8YUyqkErdX707F78evflv8lDlX2igM1+v1xCyTI0ql02aizSo0y4Q/bPfzRMwzMiQK3IiYxE5TYldrYUtK5FImLFDnc22DYRInd2oknMeN4lfrR6QPSlwZOTq8ZuLm6lzIlJSTy41UqzF0u2eJVc4+MNaVi+Ic1RfYlXMM+hjFVkWBZtN3zT5AE4B16KpBGk+06K8vR765Lf6czy+FdyESnZJYaiNcJm0PxEkUUsmiKiA6nk4DKPDBX72eThv2yRX/jkyUoIcyR9W21uN0pBKFNtT1T5uYVNahSn5UZbSRK/kYd7Inra6J3/qMekEdf/Pw6pS01JV6VtKzkp6V9KSSXh26Nc2UYJYN9yEZo43QSVIZQ6lYZzJv3SdkbY/dPRv6XnzW2rPWnrU21loTQEEu0zyDldq2rYMugwhCf9ey4fZhEwKwZO7J8CRXQ2VyiKD2kmmiMKwzbV0T1aU2rgnvuR57Uw4ve2n1LZPrBPPMw45LxwvD0eoUi0qlKE7E1dn1XPyBjta4aalkyH3XJ9OT6UGvbPqEx9nlufAZ+sYbHAa9W1b1Qbfe+HscN82CiUwqI93mmrd5emJCQ2ZWMfvbhujwWu987Y0g6L6869vk/T/zttJ8kF3thuKzByxKL8PhELvrs2GB9uaSwagq1VK3IXVdNE6OHZGxno3p5MW4Yy/PW+Eluigq1Z6+aiXW0mUCB2QleWUdkxRALhPiWSWqQfmYe7MPfkX87RHFiwkX2ndjf+iupMuqeJLoIkz8tu3/ONdxWKBUYQdhw9PZx5uLt7OjD+enZxfXZ0cvJtOJe3AtoSyKAtUgju081T3XPU623t1snnpt0RXX0YMLyxylYprbDOpOfv0obbnUWwEugk5Et1DXMVq6MXnT8M9fKzIbiG4Xu5LyVRNARpiSaRX7hedbOPXRHc05CDbPKw5mND43Qb9jliRUum/aLgbnyOWn6zmH3b2UKXTKewyu+YUNriGCO7gD4FdA7KFt/vb3GnJUqwpXbO/98t+/TxlJew==
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
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 @@ -41,7 +41,7 @@ The signal variables as a JSON object.

The signal was broadcast.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"signalKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The unique ID of the signal that was broadcast.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The tenant ID of the signal that was broadcast.","type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"signalKey\": 0,\n \"tenantId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The tenant ID of the signal that was broadcast.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"signalKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The unique ID of the signal that was broadcast.","type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"signalKey\": \"string\",\n \"tenantId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/vnd.camunda.api.keys.number+json"} value={"application/vnd.camunda.api.keys.number+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The tenant ID of the signal that was broadcast.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"signalKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The unique ID of the signal that was broadcast.","type":"integer","format":"int64"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"signalKey\": 0,\n \"tenantId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/vnd.camunda.api.keys.string+json"} value={"application/vnd.camunda.api.keys.string+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The tenant ID of the signal that was broadcast.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"signalKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The unique ID of the signal that was broadcast.","type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"signalKey\": \"string\",\n \"tenantId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The provided data is not valid.

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: eJztWE1z2zYQ/Ss7uDSZ0pSSOmnCm+o4rdMk9dhKe3B8WJIrETYJMABomaPhf+8sQOrTTtKZ9CbPaCwSwH6+t6TeUjicW5FciXc6FdeR0DUZdFKrs1wkItNVXZIjXoxETjYzsuZVkYiTfg0QbnQKC+kKcAXBXN6RghrbUmMewaKQWQFYlnphobcn1dxvRWt1JtFRDpbMncwIHNrb+LMSkajRYEWODIe3FAorEom40emf1IpISI6hRleISBj60khDuUicaWg30GlBcEst6Jl3ysE6PYRCsYiEzQqqUCRL4dqavUjlaE5GRGKmTYUu3Hp5LLruOrgj637Tectn1t5nWFqKRKaVI+V4Deu6lJkv6OjGcjjLfW86vaHMccqGy+8kWV69QyMxLcMF5rlkK1ieb2x6LN3V0c1MV9lzqzjtXfeqKUs+Fex2nKhtSvdQpNtbHwohnB2KPsSQ+wDQQs6draSiHNLWb1loc0sm3itDTkpycVdBpFqXhGoPkGcq51KThUVBriCzYRa8Fbu6E4GMKQa65/ZIV7aQa7LqJwdY10bfEUgXw1ttgO6RQ48AYYr2Ft5L60iRgQwVW20385NaccboYcyJWXI92qWFWYlzbgiXLIYzFe6uHDxqR1owVBuypFyoV6CcK9Bt5sgRrZrta8yVi2FiAft+7HnpsRx8cHMpB1S53+adG6pQKguYOXlHMbyhGTal88jyeA9s3cFOFwknHV/yYLkIONq5e7KK4iIEIbquC6irtbKh+8/HxwEEu/jyQEa7gSzbZBlZO2vKso1FF4nj8fgrZ7fnFQ+IDJXSDtINuMbwQRtitKIsLaAhYHjInHKQyp8fwoVU520oxiMDoDY6Lan6eX8QbIc4gfOws/cLgXahpbwxDd6vLt6ewOvjF79ePymcq20yGi0Wi9jMsiPKpdMm1mY+MrOMP7zvaQzTggxBhS2nuR4qsOYc2JoyOZOZh2rhE/bBMP1Cfl+fW2F1RVfrjFTzzVHaGLlH3gl8ujgDmZNyctYOD4gt1/6MB59IBKa6cUlaoroVa1jtO931YpuqQrN6GGw76CJhHbrGfvNR8MvzPdsMrD+m03MIJiDTOcFMm8Dy3hEnUUklq6YSyfF4HIkK78PVy/G4Y5vc8e/IRPnhhQqHYbGZjlRQrXHrE5PKOlTZj+qMNnIud/3GWxTvQfwmZBS4ffxVOu9TkhnOnJzpRuXxgVoHah2o9Si1Xv8nakk7PMEWRqu5ry1B1hhDypXt4cl3oOeBnj+Oni8eehmdKOAqG8YhGaMN6MwzMOffzaU3z++0g+/+bf3AtQPXDlx7jGtdJCpyhWYBq9bWQ4d1okSMbnRqR8ugIXWj9c9g1oDI3A1aU2NKkYhlYE6XjEbLQlvXJctaG9eN7rgtW+oMLweGDcgpdYZlEbzvd5AXWNAaMjvBqlE5wiu4OL2cwu/oaIHhRyy73Db9avxq/KBV3vqIxcn5GYQMA/42ZsJglsn9oNmw+XsMe3XMUtYY6dpLPhbKkxIaMpOGm7DCRe/PW/eyjt8kov7L2wEt7/6Z+obzPLtYK2+nQTbZFcq2VKtBOhokCalm2kfQY2c/F24sGRuSH8fP9nF6fubplumqapSfuWoeXq9wozZZ2VgX1KxSZqSsD7TXMIdt78MK/B08wrOY+xrAN4zauXRFk8aZrkZZOLb6n5Y6HbE4M+pd2NHJ5MOnj28mR+/PTk4/Xp4ePYvHsbsPygtToUK1GcegFd3sy7vL9ePlf1d6e0A4unejukSpGKK+DMueuVes+1oRiWSl/26Q9zrqCXgllssULX0yZdfx7S8NmVYkV9drvnqC59Ly97Vk+2juTy56dfcpfFtHfjCR/iaq1k+NsuErEYlbatd6dnfdRaIgzMn4AMPiSQjjaMom1of3ROUuGk5Msoxq98jerTcDpupqTJ7/dTll5vWKdqVzPmtwweI6LkQiPovPHLT2JfKk9veXokQ1b3DutXlvl//+BdIObqg=
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
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 @@ -44,7 +44,23 @@ The variables to complete the job with.

The result of the completed job as determined by the worker.

</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></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
</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"}}>

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.

</div><SchemaItem collapsible={false} name={"assignee"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Assignee of the task.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"dueDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The due date of the task.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"followUpDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The follow-up date of the task.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"candidateUsers"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The list of candidate users of the task.","items":{"type":"string"},"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"candidateGroups"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The list of candidate groups of the task.","items":{"type":"string"},"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 100`"} schema={{"type":"integer","format":"int32","description":"The priority of the task.","minimum":0,"maximum":100,"nullable":true}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The job was completed successfully.

Expand Down
Loading
Loading