module:api/WorkflowTriggerApi

module:api/WorkflowTriggerApi

new module:api/WorkflowTriggerApi(apiClient)

Source:

Constructs a new WorkflowTriggerApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

triggerWorkflow(accountId, workflowDefinitionId, body, optsOrCallback, callback)

Source:

Creates a new workflow instance after authenticating with DS Account Server
Creates a new workflow instance after authenticating with DS Account Server

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
body module:model/TriggerPayload

JSON payload that will be passed to the triggered workflow
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
mtid String

Managed Token Id registered with DS Account Server
mtsec String

Managed Token Secret registered with DS Account Server
callback module:api/WorkflowTriggerApi~triggerWorkflowCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TriggerWorkflowViaPostResponse

Type Definitions

triggerWorkflowCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the triggerWorkflow operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TriggerWorkflowViaPostResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.