v3

OpenAPI 3.0.12026-07-311341,046757.3 KB

ApplicantWorkflowApiAgentResource

Publish or archive a workflow revision

Changes the status of a workflow revision. A draft can be published, a published revision can be archived, and an archived revision can be published again. Publishing requires the revision to have no error-level notices. Publishing also keeps a single live version per workflow: any previously published revision of the same workflow is archived automatically.

The test workflow is an exception: its revision status cannot be changed. It is never published or archived, since the system never selects it automatically and it is only ever started manually for testing.

put/resources/api/agent/applicantWorkflows/{id}/revisionStatus

Path parameters

idstring required

Id of the workflow revision whose status is being changed.

Request body

revisionStatusstring required

New status to apply to the revision.

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.