tridion-sites-extensions-api-docs

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

WorkflowService class

Signature:

export declare class WorkflowService

Methods

Method	Modifiers	Description
finishActivity({ escapedActivityInstanceId, activityFinishRequestModel, })	static	Finishes a Workflow activity. This operation returns an instance of ‘FinishActivityResult’ type.
forceFinishProcess({ escapedActivityOrProcessInstanceId, approvalStatusId, returnFullProcessHistory, })	static	Force finishes a Workflow Process. This operation returns an instance of ‘ProcessHistory’ type.
getApprovalStatuses({ details, })	static	Gets all Approval Statuses This operation returns an instance of ‘ApprovalStatus’ type.
getProcessDefinitions({ escapedPublicationId, })	static	Gets a list of Process Definitions for a specific context Repository. This operation returns an instance of ‘ProcessDefinition’ type, as implemented by one of the following:<ul class="model-list"><li>TridionProcessDefinition</li></ul>
getWorkflowScriptTypes()	static	Gets all workflow script types This operation returns an instance of ‘WorkflowScriptType’ type.
listActivityInstances({ forAllUsers, ownerId, assigneeId, activityStates, processDefinitionId, })	static	Gets a list of Activity Instances. This operation returns an instance of ‘ActivityInstance’ type.
reAssignActivity({ escapedActivityInstanceId, newAssigneeId, })	static	Reassigns a Workflow Activity to another User or Group. This operation returns an instance of ‘ActivityInstance’ type.
restartActivity({ escapedActivityInstanceId, })	static	Restarts an automated Activity Instance which is in Failed state. This operation returns an instance of ‘ActivityInstance’ type.
startActivity({ escapedActivityInstanceId, })	static	Starts a Workflow activity. This operation returns an instance of ‘ActivityInstance’ type.
startWorkflow({ escapedPublicationId, requestModel, })	static	Starts the Workflow process for a Publication. This operation returns an instance of ‘ProcessInstance’ type.