Skip to navigation

Get compound action

View as Markdown

Returns one compound action by its id. Secrets come back redacted.

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.

Response

The 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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error