v4

latestOpenAPI 3.0.12026-08-041341,046757.6 KB

ApplicantWorkflowApiAgentResource

Get a workflow revision by id

Returns a single workflow revision by its id. The id identifies one specific revision, not the workflow name as a whole — different revisions of the same workflow have different ids.

get/resources/api/agent/applicantWorkflows/{id}

Path parameters

idstring required

Id of the workflow revision, as returned by the list endpoint.

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.