module:api/WorkflowInstanceManagementApi

module:api/WorkflowInstanceManagementApi

new module:api/WorkflowInstanceManagementApi(apiClient)

Source:

Constructs a new WorkflowInstanceManagementApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Methods

cancelWorkflowInstance(accountId, instanceId, callback)

Source:

Cancels a running workflow instance.
Cancels a running workflow instance.

Parameters:
Name Type Description
accountId String

Account ID
instanceId String

DS Workflow Instance Id (dacId)
callback module:api/WorkflowInstanceManagementApi~cancelWorkflowInstanceCallback

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

getWorkflowHistory(accountId, instanceId, callback)

Source:

Get List of Step Histories
Returns a list of step history for a workflow instance

Parameters:
Name Type Description
accountId String

Account ID
instanceId String

DS Workflow Instance Id (dacId)
callback module:api/WorkflowInstanceManagementApi~getWorkflowHistoryCallback

The callback function, accepting three arguments: error, data, response
data is of type: href="module:model/WorkflowStepHistory">module:model/WorkflowStepHistory

getWorkflowInstance(accountId, workflowDefinitionId, instanceId, callback)

Source:

Get Workflow Instance Details
Returns the details for a specific instance for a deployed workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
instanceId String

DS Workflow Instance Id (dacId)
callback module:api/WorkflowInstanceManagementApi~getWorkflowInstanceCallback

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

getWorkflowInstances(accountId, workflowDefinitionId, callback)

Source:

Get List of Workflow Instances
Returns the list of instances for a deployed workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
callback module:api/WorkflowInstanceManagementApi~getWorkflowInstancesCallback

The callback function, accepting three arguments: error, data, response
data is of type: href="module:model/WorkflowInstance">module:model/WorkflowInstance

Type Definitions

cancelWorkflowInstanceCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

getWorkflowHistoryCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

Error message, if any.
data Array:.<module:model/WorkflowStepHistory:>

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.

getWorkflowInstanceCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

getWorkflowInstancesCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

Error message, if any.
data Array:.<module:model/WorkflowInstance:>

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.