module:api/WorkflowManagementApi

module:api/WorkflowManagementApi

new module:api/WorkflowManagementApi(apiClient)

Source:

Constructs a new WorkflowManagementApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Methods

createWorkflowDefinition(accountId, body, callback)

Source:

Creates a new workflow definition.
Creates a new workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
body module:model/CreateOrUpdateWorkflowDefinitionRequestBody

Request Body to create a new workflow definition.
callback module:api/WorkflowManagementApi~createWorkflowDefinitionCallback

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

deleteWorkflowDefinition(accountId, workflowDefinitionId, callback)

Source:

Deletes a workflow definition.
Deletes a workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
callback module:api/WorkflowManagementApi~deleteWorkflowDefinitionCallback

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

getWorkflowDefinition(accountId, workflowDefinitionId, optsOrCallback, callback)

Source:

Get Workflow Definition
Returns a workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
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
lastDeployedId String

deployed workflow definition metadata object id
callback module:api/WorkflowManagementApi~getWorkflowDefinitionCallback

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

getWorkflowDefinitionConfigInstances(accountId, workflowDefinitionId, callback)

Source:

Gets configuration instances
Returns a list of configuration instances for a workflow definition

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
callback module:api/WorkflowManagementApi~getWorkflowDefinitionConfigInstancesCallback

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

getWorkflowDefinitions(accountId, optsOrCallback, callback)

Source:

Get Workflow Definitions metadata
Returns a list of workflow definitions' metadata.

Parameters:
Name Type Description
accountId String

Account ID
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
status module:model/String

workflow definition metadata status
callback module:api/WorkflowManagementApi~getWorkflowDefinitionsCallback

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

publishOrUnPublishWorkflowDefinition(accountId, workflowDefinitionId, body, callback)

Source:

Publishes or unpublishes a workflow definition.
Publishes or unpublishes a workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
body module:model/DeployRequest

Request Body to publish or unpublish a workflow definition.
callback module:api/WorkflowManagementApi~publishOrUnPublishWorkflowDefinitionCallback

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

updateWorkflowDefinition(accountId, workflowDefinitionId, body, callback)

Source:

Updates a workflow definition.
Updates a workflow definition.

Parameters:
Name Type Description
accountId String

Account ID
workflowDefinitionId String

Workflow Definition ID
body module:model/CreateOrUpdateWorkflowDefinitionRequestBody

Request Body to update a workflow definition.
callback module:api/WorkflowManagementApi~updateWorkflowDefinitionCallback

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

Type Definitions

createWorkflowDefinitionCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

deleteWorkflowDefinitionCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

getWorkflowDefinitionCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

getWorkflowDefinitionConfigInstancesCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

getWorkflowDefinitionsCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

publishOrUnPublishWorkflowDefinitionCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

updateWorkflowDefinitionCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.