tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > WorkflowService > startWorkflow

WorkflowService.startWorkflow() method

Starts the Workflow process for a Publication. This operation returns an instance of ‘ProcessInstance’ type.

Signature:

static startWorkflow({ escapedPublicationId, requestModel, }: {
        escapedPublicationId: string;
        requestModel: StartWorkflowInstruction;
    }): CancelablePromise<ProcessInstance>;

Parameters

Parameter	Type	Description
{ escapedPublicationId, requestModel, }	{ escapedPublicationId: string; requestModel: StartWorkflowInstruction; }

Returns:

CancelablePromise<ProcessInstance>

ProcessInstance The request has completed and has resulted in one or more new resources being created.

Exceptions

ApiError