v4

latestOpenAPI 3.0.12026-08-041341,046757.6 KB

ApplicantWorkflowApiAgentResource

Validate a workflow without saving

Checks a workflow definition and returns it with the notices list populated, without storing anything. Use it to preview the warnings and errors a definition would produce before you save or publish it. This is a read-only, dry-run operation.

post/resources/api/agent/applicantWorkflows/-/validate

Request body

name'default' | 'test' | 'actions' required

Workflow name shared by every revision of the same workflow.

Response

default response

clientIdstring

Identifier of the client that owns this workflow.

idstring

namestring

Workflow name shared by every revision of the same workflow.

revisioninteger

Revision number within the workflow; increases with each new revision.

revisionStatusstring

Current status of this revision.

titlestring

Display title of the workflow.