Skip to navigation

Create compound action

View as Markdown

Creates a compound action and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this compound action refers to must already exist.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
signatureobjectRequired
The compound action's callable contract. Its name is the key other compound actions call it by, and must be unique. Required.
versionobjectRequired
Document version. On update, send back the num from your last read.
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 created compound action
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
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error