Skip to main content

Constructor

Parameters

HttpClient
required
ModusConfig
required

Returns

ManagementWorkflowsResource

Properties

ManagementWorkflowsOperations
required

Methods

acceptOwnershipTransfer()

Accept a pending workflow ownership transfer.

Parameters

string | number
required

Returns

Promise<object>

cancelOwnershipTransfer()

Cancel a pending workflow ownership transfer.

Parameters

string | number
required

Returns

Promise<object>

create()

Create a new workflow in the organization.

Parameters

CreateWorkflowOptions
required

Returns

Promise<object> The created workflow (draft).

delete()

Delete a workflow.

Parameters

string | number
required
Workflow id.

Returns

Promise<void> Resolves when the workflow is deleted.

deploy()

Publish the current draft of a workflow.

Parameters

string | number
required
Workflow id.

Returns

Promise<object> The published workflow.

get()

Retrieve a workflow with full configuration.

Parameters

string | number
required
Workflow id.
{ view: VariationView }

Returns

Promise<object> The workflow.

interfaces()

Interfaces attached to a workflow.

Parameters

string | number
required
Workflow id.

Returns

WorkflowInterfacesResource An interfaces resource scoped to the workflow.

list()

List workflows in the organization.

Parameters

Returns

Promise<Page<object>> A page of workflows.

requestOwnershipTransfer()

Start transferring ownership of a workflow to another organization member.

Parameters

string | number
required
Workflow id.
{ newOwnerUserId: string }
required

Returns

Promise<object> The workflow with a pending ownership transfer.

restore()

Restore a previously deleted workflow.

Parameters

string | number
required
Workflow id.

Returns

Promise<object> The restored workflow.

toggle()

Enable or disable a workflow without deleting it.

Parameters

string | number
required
Workflow id.
{ active: boolean }
required

Returns

Promise<object> The updated workflow.

update()

Update a workflow’s configuration. Only the fields you pass are changed. To clear a field, name it in updateMask and leave its argument unset.

Parameters

string | number
required
Workflow id.
UpdateWorkflowOptions

Returns

Promise<object> The updated workflow.