Set Workflow Template

Store a workflow contract template, replacing any template already stored under the same
identifier and version.

The request body is the workflow template document itself; its id, version, and
description fields become the stored template's identity and listing text, so the stored
record can never disagree with the document it holds. The document is validated against the
workflow engine's schema before it is stored, so a template that could never execute is
rejected up front rather than at contract execution time.

operator_selectable is catalog metadata supplied as a query parameter and stored in its own
column rather than in the workflow document.

What is stored is the validated document re-serialized, not the raw request body. The workflow
engine ignores any field it does not model, so persisting the raw body would return fields on
retrieval that were never validated and would never take effect.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Whether operators may choose the template directly; defaults to true

Body Params
Responses

400

Possible reasons:

  • invalid template: {err}
  • template must declare a description
  • template version '{template.version}' is not a valid semantic version

The query string is missing a required parameter, or a parameter could not be parsed into its expected type.

401

Not authenticated

422

The request body is valid JSON but does not match the expected schema.

500

Possible reasons:

  • database error
  • failed to serialize workflow template
  • failed to store workflow template
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json