Skip to navigation

Update compound action

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, null clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, workflow_steps and resolver_methods are replaced whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the compound action, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
signatureobjectOptional
The compound action's callable contract. Its name is the key other compound actions call it by, and must be unique. Required.
workflow_stepsobjectOptional

Step tree in compound action syntax, as JSON. Do not send together with workflow_steps_yaml. An update that includes it replaces the whole tree.

workflow_steps_yamlstringOptional

The same step tree as YAML text, as written in the Tool Studio editor. Write-only; never returned. Do not send together with workflow_steps. Up to 1 MB.

Response

The updated compound action, at its new version
idstringOptionalRead-only
Unique identifier of the compound action, assigned by the server.
signatureobjectOptional
The compound action's callable contract. Its name is the key other compound actions call it by, and must be unique. Required.
workflow_stepsobjectOptional

Step tree in compound action syntax, as JSON. Do not send together with workflow_steps_yaml. An update that includes it replaces the whole tree.

workflow_steps_yamlstringOptional

The same step tree as YAML text, as written in the Tool Studio editor. Write-only; never returned. Do not send together with workflow_steps. Up to 1 MB.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error