Invoking workflow for a workflow definition

A custom workflow definition must be published before it can be assigned to a content type.

Workflow events can be invoked for a workflow definition using the following POST request.

POST /api/management/projects/{projectId}/workflow/definitions/{workflowDefinitionId}/workflow/events

Parameters

Name Parameter type Type Format Description
projectId path string The project identifier, e.g. "movieDb". Found in the project overview screen of the management console
workflowDefinitionId path string The workflow definition identifier.
trigger body object WorkflowTrigger Details to invoke the workflow event

Example

POST: /api/management/projects/movieDb/workflow/definitions/approvalWorkflow/workflow/events

{
    "version": "0.1",
    "event": "publish"
}

Response message

HTTP status code Reason Response model
200 Success Workflow Definition
401 Unauthorized Error
403 BadRequest Error
404 NotFound Error
409 NotLatestVersion Error
422 ValidationError Error
500 InternalServerError Error

Validations

Type Description
Project does not exist A project must exist to be able to publish a workflow definition.
Id missing The workflow definition id must be defined.
Workflow definition not found The workflow definition must exist in order to be deleted.
Version not latest Only the latest version of a workflow definition can be published.
Workflow definition already published The latest version of the workflow definition has already been published.

results matching ""

    No results matching ""