tridion-sites-extensions-api-docs

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

WorkflowService.forceFinishProcess() method

Force finishes a Workflow Process. This operation returns an instance of ‘ProcessHistory’ type.

Signature:

static forceFinishProcess({ escapedActivityOrProcessInstanceId, approvalStatusId, returnFullProcessHistory, }: {
        escapedActivityOrProcessInstanceId: string;
        approvalStatusId: string;
        returnFullProcessHistory?: boolean;
    }): CancelablePromise<ProcessHistory>;

Parameters

Parameter	Type	Description
{ escapedActivityOrProcessInstanceId, approvalStatusId, returnFullProcessHistory, }	{ escapedActivityOrProcessInstanceId: string; approvalStatusId: string; returnFullProcessHistory?: boolean; }

Returns:

CancelablePromise<ProcessHistory>

ProcessHistory The request was successful.

Exceptions

ApiError