Workflow

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. Links included in this response include: * *`apiture:workflowDefinitions`* - links to the collection of workflow definitions * *`apiture:workflows`* - links to the collection of workflows * *`apiture:taskDefinitions`* - links to the collection of workflow task definitions * *`apiture:tasks`* - links to the collection of workflow tasks


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/"
import { APIApi } from "@apiture/workflow-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Workflow.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/apiDoc"
import { APIApi } from "@apiture/workflow-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Workflow.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


Task

cancelTask

Cancel a workflow task

Change the `state` of a workflow to `canceled`. This is allowed if the state is `running` or `paused`. There is no request body on this operation; the task is passed as a query parameter, `?task=`. This operation is invoked from the `apiture:cancel` link on a task; the link is present if the operation is allowed. This operation may also affect the state of the workflow in which the task instance resides. This operation is not allowed on a task definition.


/canceledTasks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/canceledTasks?task="
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.cancelTask()
var task = task_example; // {String} A server-supplied value which identifies the task instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.cancelTask(task, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
task*
String
A server-supplied value which identifies the task instance.
Required

Responses


createTask

Create a new task

Create a new task in the tasks collection.


/tasks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/tasks?definition="
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.createTask()
var createTask = ; // {CreateTask} 
var opts = {
  'definition': definition_example // {String} A server-supplied value which identifies the task definition instance from which this new task will be created. The request body is ignored when this parameter is used.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.createTask(createTask, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createTask *

The data necessary to create a new task.

Query parameters
Name Description
definition
String
A server-supplied value which identifies the task definition instance from which this new task will be created. The request body is ignored when this parameter is used.

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteTask

Delete this task resource

Delete this task resource and any resources that are owned by it.


/tasks/{taskId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.deleteTask()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
taskApi.deleteTask(taskId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


failTask

Stop a workflow task and mark it as failed

Change the `state` of a workflow to `failed`. This is allowed if the state is `running` or `paused`. There is no request body on this operation; the task is passed as a query parameter, `?task=`. This operation is invoked from the `apiture:fail` link on a task; the link is present if the operation is allowed. This operation may also affect the state of the workflow in which the task instance resides. This operation is not allowed on a task definition.


/failedTasks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/failedTasks?task="
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.failTask()
var task = task_example; // {String} A server-supplied value which identifies the task instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.failTask(task, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
task*
String
A server-supplied value which identifies the task instance.
Required

Responses


getTask

Fetch a representation of this task

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this task resource.


/tasks/{taskId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.getTask()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.getTask(taskId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


getTaskValue

Fetch a single runtime value associated with this task

Fetch a single runtime value associated with this task. This provides convenient access to the map of `values` of the task, including the inputs and outputs. This map does **not** include the tasks and their values, or values from nested workflows; it only contains values defined in the task's `schema`. To update a specific value, use `PUT /tasks/{taskId}/values/{valueName}` (operation `updateTaskValue`).


/tasks/{taskId}/values/{valueName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}/values/{valueName}"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.getTaskValue()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.
var valueName = valueName_example; // {String} The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.getTaskValue(taskId, valueName, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required
valueName*
String
The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


getTaskValues

Fetch the runtime values associated with this task

Fetch the runtime values associated with this task. This provides convenient access to the map of `values` of the task, including the inputs and outputs. Use the `PUT /tasks/{taskId}/values` operation to update the values, or to update a specific value, use `PUT /tasks/{taskId}/values/{valueName}`.


/tasks/{taskId}/values

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}/values"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.getTaskValues()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.getTaskValues(taskId, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


getTasks

Return a collection of tasks

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of tasks. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/tasks

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/tasks?start=&limit=&sortBy=&filter=&q=&state=&name=&domain=&type=&label="
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.getTasks()
var opts = {
  'start': 789, // {Long} The zero-based index of the first task item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of task representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': state_example, // {String} Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'domain': domain_example, // {String} Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items  whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.getTasks(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first task item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of task representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
String
Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
domain
String
Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


pauseTask

Pause a workflow task

Change the `state` of a workflow to `paused`. This is allowed if the state is `running`. There is no request body on this operation; the task is passed as a query parameter, `?task=`. This operation is invoked from the `apiture:pause` link on a task; the link is present if the operation is allowed. This operation may also affect the state of the workflow in which the task instance resides. This operation is not allowed on a task definition.


/pausedTasks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/pausedTasks?task="
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.pauseTask()
var task = task_example; // {String} A server-supplied value which identifies the task instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.pauseTask(task, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
task*
String
A server-supplied value which identifies the task instance.
Required

Responses


startTask

Start, restart, or resume a workflow task

Change the `state` of a workflow to `running`. This is allowed if the state is `paused`. If the task is restartable, this is also allowed if the state is `failed`, `completed`, or `canceled`. There is no request body on this operation; the task is passed as a query parameter, `?task=`. This operation is invoked from the `apiture:start` link on a task; the link is present if the operation is allowed. This operation may also affect the state of the workflow in which the task instance resides. This operation is not allowed on a task definition.


/runningTasks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/runningTasks?task="
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.startTask()
var task = task_example; // {String} A server-supplied value which identifies the task instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.startTask(task, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
task*
String
A server-supplied value which identifies the task instance.
Required

Responses


updateTask

Update this task

Perform a complete replacement of this task.


/tasks/{taskId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.updateTask()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.
var updateTask = ; // {UpdateTask} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.updateTask(taskId, updateTask, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateTask *

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


updateTaskValue

Update the runtime values associated with this task

Update a single runtime value associated with this task. This provides convenient access to individual `values` of the task as defined in the task's `schema`. The request body must conform to the task's schema for the named `{valueName}`. This operation is idempotent. To update a specific value, use `PUT /workflows/{workflowId}/values/{valueName}`.


/tasks/{taskId}/values/{valueName}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}/values/{valueName}"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.updateTaskValue()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.
var valueName = valueName_example; // {String} The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
var requestBody = ; // {map[String, attributeValue]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.updateTaskValue(taskId, valueName, requestBody, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required
valueName*
String
The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.

updateTaskValues

Update the runtime values associated with this task

Update the runtime values associated with this task. This provides convenient access to the map of `values` of the task, including the inputs and outputs. This map only contains values defined in the task's `schema`. The request body must include _all_ values obtained from the `GET` operation, and the values must conform to the task's schema. This operation is idempotent. To update a specific value, use `PUT /tasks/{taskId}/values/{valueName}` (operation `updateTaskValue`).


/tasks/{taskId}/values

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/tasks/{taskId}/values"
import { TaskApi } from "@apiture/workflow-client-sdk";

const taskApi = new TaskApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskApi.setApiKey(apiKey);


var api = new Workflow.TaskApi.updateTaskValues()
var taskId = taskId_example; // {String} The unique identifier of this task. This is an opaque string.
var requestBody = ; // {map[String, attributeValue]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskApi.updateTaskValues(taskId, requestBody, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskId*
String
The unique identifier of this task. This is an opaque string.
Required
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


TaskDefinition

createTaskDefinition

Create a new task definition

Create a new task definition in the task definitions collection. The `state` of the new task will be set to `definition`.


/taskDefinitions

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.createTaskDefinition()
var createTask = ; // {CreateTask} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.createTaskDefinition(createTask, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createTask *

The data necessary to create a new task definition.

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


createTaskDefinitionRevision

Create a new task definition revision

Create a new immutable revision of this workflow task definition. The revision is a snapshot of the content of the definition. This operation has no request body. The response body is the representation of the new _revision_. This operation is ignored if the task definition has not changed since the last time the revision was created. Creating a revision does not alter the entity tag of the task definition.


/taskDefinitions/{taskDefinitionId}/revisions

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}/revisions"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.createTaskDefinitionRevision()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.createTaskDefinitionRevision(taskDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag for the revision. This entity tag may be passed as the `If-Not-Match` on a `GET` request for the revision location. (This is _not_ the entity tag of the mutable definition resource.)
Location String uri The URI of the new revision. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteTaskDefinition

Delete this task definition resource

Delete this task definition resource and any resources that are owned by it. The task definition may not be deleted if it or any of its revisions are in use by any tasks or workflows. Deleting a task definition also deletes all revisions.


/taskDefinitions/{taskDefinitionId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.deleteTaskDefinition()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
taskDefinitionApi.deleteTaskDefinition(taskDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getTaskDefinition

Fetch a representation of this task definition

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this task definition resource. This resource is referred to as the `revisionless` task definition, in contrast to the explicit revision at `/taskDefinitions/{taskDefinitionId}/revisions/{revisionId}`.


/taskDefinitions/{taskDefinitionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.getTaskDefinition()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.getTaskDefinition(taskDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


getTaskDefinitionRevision

Fetch a representation of an immutable revision of this workflow task

Return an immutable [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this revision of this workflow task resource. The revision may also have `prev` and `next` links to previous and/or next revisions, if they exist.


/taskDefinitions/{taskDefinitionId}/revisions/{revisionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}/revisions/{revisionId}"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.getTaskDefinitionRevision()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var revisionId = revisionId_example; // {String} The identifier for a revision of this resource. Revision identifiers use [RFC 3339](https://tools.ietf.org/html/rfc3339) format: `YYYY-MM-DDThh:mm:ss.sssZ`.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.getTaskDefinitionRevision(taskDefinitionId, revisionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
revisionId*
String
The identifier for a revision of this resource. Revision identifiers use [RFC 3339](https://tools.ietf.org/html/rfc3339) format: `YYYY-MM-DDThh:mm:ss.sssZ`.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow task resource.


getTaskDefinitionRevisions

Return a collection of workflow task definition revisions

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of workflow task revisions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. The revisions collection shows the modification history of the workflow task definition. Revisions are immutable.


/taskDefinitions/{taskDefinitionId}/revisions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}/revisions?start=&limit=&sortBy=&filter=&q="
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.getTaskDefinitionRevisions()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var opts = {
  'start': 789, // {Long} The zero-based index of the first workflow task revision item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of workflow task representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.getTaskDefinitionRevisions(taskDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
Query parameters
Name Description
start
Long (int64)
The zero-based index of the first workflow task revision item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of workflow task representations to return in this page.
sortBy
String
Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


getTaskDefinitions

Return a collection of task definitions

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of task definitions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/taskDefinitions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions?start=&limit=&sortBy=&filter=&q=&state=&name=&domain=&type=&label="
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.getTaskDefinitions()
var opts = {
  'start': 789, // {Long} The zero-based index of the first task definition item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of task definition representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': state_example, // {String} Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'domain': domain_example, // {String} Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items  whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.getTaskDefinitions(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first task definition item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of task definition representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
String
Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
domain
String
Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchTaskDefinition

Update this task definition

Perform a partial update of this task definition. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/taskDefinitions/{taskDefinitionId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.patchTaskDefinition()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var updateTask = ; // {UpdateTask} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.patchTaskDefinition(taskDefinitionId, updateTask, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateTask *

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


updateTaskDefinition

Update this task definition

Perform a complete replacement of this task definition.


/taskDefinitions/{taskDefinitionId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/taskDefinitions/{taskDefinitionId}"
import { TaskDefinitionApi } from "@apiture/workflow-client-sdk";

const taskDefinitionApi = new TaskDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
taskDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
taskDefinitionApi.setApiKey(apiKey);


var api = new Workflow.TaskDefinitionApi.updateTaskDefinition()
var taskDefinitionId = taskDefinitionId_example; // {String} The unique identifier of this task definition. This is an opaque string.
var updateTask = ; // {UpdateTask} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
taskDefinitionApi.updateTaskDefinition(taskDefinitionId, updateTask, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
taskDefinitionId*
String
The unique identifier of this task definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateTask *

Responses

Name Type Format Description
ETag String If supplied, the `ETag` (entity tag) response header should be in an `If-Match` request header of *`PUT`* or *`PATCH`* operations that update the resource.


Workflow

cancelWorkflow

Cancel a workflow

Change the `state` of a workflow to `canceled`. This is allowed if the state is `running` or `paused`. There is no request body on this operation; the task is passed as a query parameter, `?workflow=`. This operation is invoked from the `apiture:cancel` link on a workflow; the link is present if the operation is allowed. This operation will also cancel all `running` or `paused` tasks in the workflow. This operation is not allowed on a workflow definition.


/canceledWorkflows

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/canceledWorkflows?workflow="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.cancelWorkflow()
var workflow = workflow_example; // {String} A server-supplied value which identifies the workflow instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.cancelWorkflow(workflow, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
workflow*
String
A server-supplied value which identifies the workflow instance.
Required

Responses


createWorkflow

Create a new workflow

Create a new workflow instance from a workflow definition. The workflow is started automatically upon creation; and initial tasks (those with no input dependencies) will be started. Thus, the state of the new workflow may be `running` or `blocked` depending on the initial tasks.


/workflows

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/workflows?definition="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.createWorkflow()
var createWorkflow = ; // {CreateWorkflow} 
var opts = {
  'definition': definition_example // {String} A server-supplied value which identifies the workflow definition instance from which this new workflow will be created. The request body is ignored when this parameter is used.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.createWorkflow(createWorkflow, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createWorkflow *

The data necessary to create a new workflow.

Query parameters
Name Description
definition
String
A server-supplied value which identifies the workflow definition instance from which this new workflow will be created. The request body is ignored when this parameter is used.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteWorkflow

Delete this workflow resource

Delete this workflow resource and any resources that are owned by it.


/workflows/{workflowId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}"
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.deleteWorkflow()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
workflowApi.deleteWorkflow(workflowId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


failWorkflow

Stop a workflow and mark it as failed

Change the `state` of a workflow to `failed`. This is allowed if the state is `running` or `paused`. There is no request body on this operation; the task is passed as a query parameter, `?workflow=`. This operation is invoked from the `apiture:fail` link on a workflow; the link is present if the operation is allowed. This operation may also affect the state of the workflow in which the task instance resides. This operation is not allowed on a workflow definition.


/failedWorkflows

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/failedWorkflows?workflow="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.failWorkflow()
var workflow = workflow_example; // {String} A server-supplied value which identifies the workflow instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.failWorkflow(workflow, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
workflow*
String
A server-supplied value which identifies the workflow instance.
Required

Responses


getVisibleTasks

Fetch an ordered representation of the visible tasks within this workflow

Return a collection of visible tasks for the given workflow. The result reflects the nested structure of the workflow and any tasks that are embedded inside nested workflows.


/workflows/{workflowId}/visibleTasks

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}/visibleTasks"
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.getVisibleTasks()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.getVisibleTasks(workflowId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow resource.


getWorkflow

Fetch a representation of this workflow

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this workflow resource.


/workflows/{workflowId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}?embed="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.getWorkflow()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example, // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
  'embed': embed_example // {String} The resources to embed within the `_embedded` object.  This is a comma separated list which can include any of the following options:
  * *`tasks`* - A list of summary tasks specific to this workflow
    instance.
  * *`nextInteractiveTask`* - The next visible and running task within
    this workflow instance.

`tasks` will be embedded by default even if no `embed` query parameters are specified.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.getWorkflow(workflowId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
embed
String
The resources to embed within the `_embedded` object. This is a comma separated list which can include any of the following options: * *`tasks`* - A list of summary tasks specific to this workflow instance. * *`nextInteractiveTask`* - The next visible and running task within this workflow instance. `tasks` will be embedded by default even if no `embed` query parameters are specified.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow resource.


getWorkflowValue

Fetch a single runtime value associated with this workflow

Fetch a single runtime value associated with this workflow. This provides convenient access to the map of `values` of the workflow, including the inputs and outputs. This map does **not** include the tasks and their values, or values from nested workflows; it only contains values defined in the workflow's `schema`. To update a specific value, use `PUT /workflows/{workflowId}/values/{valueName}` (operation `updateWorkflowValue`).


/workflows/{workflowId}/values/{valueName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}/values/{valueName}"
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.getWorkflowValue()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.
var valueName = valueName_example; // {String} The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.getWorkflowValue(workflowId, valueName, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required
valueName*
String
The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow resource.


getWorkflowValues

Fetch the runtime values associated with this workflow

Fetch the runtime values associated with this workflow. This provides convenient access to the map of `values` of the workflow, including the inputs and outputs. This map does **not** include the tasks and their values, or values from nested workflows; it only contains values defined in the workflow's `schema`. Use the `PUT /workflows/{workflowId}/values` operation to update the values, or to update a specific value, use `PUT /workflows/{workflowId}/values/{valueName}`.


/workflows/{workflowId}/values

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}/values"
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.getWorkflowValues()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.getWorkflowValues(workflowId, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow resource.


getWorkflows

Return a collection of workflows

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of workflows. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/workflows

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflows?start=&limit=&sortBy=&filter=&q=&state=&name=&domain=&type=&label="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.getWorkflows()
var opts = {
  'start': 789, // {Long} The zero-based index of the first workflow item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of workflow representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': state_example, // {String} Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'domain': domain_example, // {String} Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items  whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.getWorkflows(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first workflow item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of workflow representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
String
Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
domain
String
Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


pauseWorkflow

Pause a workflow

Change the `state` of a workflow to `paused`. This is allowed if the state is `running`. There is no request body on this operation; the task is passed as a query parameter, `?workflow=`. This operation is invoked from the `apiture:pause` link on a workflow; the link is present if the operation is allowed. This operation will also pause all `running` tasks in the workflow. This operation is not allowed on a workflow definition.


/pausedWorkflows

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/pausedWorkflows?workflow="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.pauseWorkflow()
var workflow = workflow_example; // {String} A server-supplied value which identifies the workflow instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.pauseWorkflow(workflow, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
workflow*
String
A server-supplied value which identifies the workflow instance.
Required

Responses


startWorkflow

Start, restart, or resume a workflow

Change the `state` of a workflow to `running`. This is allowed if the state is `paused`. If the workflow is restartable, this is also allowed if the state is `failed`, `completed`, or `canceled`. There is no request body on this operation; the task is passed as a query parameter, `?workflow=`. This operation is invoked from the `apiture:start` link on a workflow; the link is present if the operation is allowed. This operation is not allowed on a workflow definition.


/runningWorkflows

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/runningWorkflows?workflow="
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.startWorkflow()
var workflow = workflow_example; // {String} A server-supplied value which identifies the workflow instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.startWorkflow(workflow, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
workflow*
String
A server-supplied value which identifies the workflow instance.
Required

Responses


updateWorkflowValue

Update a single runtime value associated with this workflow

Update a single runtime value associated with this workflow. This provides convenient access to individual `values` of the workflow as defined in the workflow's `schema`. The request body must conform to the workflow's schema for the named `{valueName}`. This operation is idempotent.


/workflows/{workflowId}/values/{valueName}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}/values/{valueName}"
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.updateWorkflowValue()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.
var valueName = valueName_example; // {String} The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
var requestBody = ; // {map[String, attributeValue]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.updateWorkflowValue(workflowId, valueName, requestBody, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required
valueName*
String
The unique identifier of a value in a workflow item. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow resource.

updateWorkflowValues

Update the runtime values associated with this workflow

Update the runtime values associated with this workflow. This provides convenient access to the map of `values` of the workflow, including the inputs and outputs. This map does **not** include the tasks and their values, or values from nested workflows; it only contains values defined in the workflow's `schema`. This operation is idempotent. The request body must include _all_ values obtained from the `GET` operation, and the values must conform to the workflow's schema. To update a specific value, use `PUT /workflows/{workflowId}/values/{valueName}`.


/workflows/{workflowId}/values

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/workflows/{workflowId}/values"
import { WorkflowApi } from "@apiture/workflow-client-sdk";

const workflowApi = new WorkflowApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowApi.setApiKey(apiKey);


var api = new Workflow.WorkflowApi.updateWorkflowValues()
var workflowId = workflowId_example; // {String} The unique identifier of this workflow. This is an opaque string.
var requestBody = ; // {map[String, attributeValue]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowApi.updateWorkflowValues(workflowId, requestBody, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowId*
String
The unique identifier of this workflow. This is an opaque string.
Required
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow resource.


WorkflowDefinition

createWorkflowDefinition

Create a new workflow definition

Create a new workflow definition in the workflow definitions collection.


/workflowDefinitions

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions"
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.createWorkflowDefinition()
var createWorkflow = ; // {CreateWorkflow} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.createWorkflowDefinition(createWorkflow, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createWorkflow *

A workflow definition. The `state` must be `definition`.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


createWorkflowDefinitionRevision

Create a new workflow definition revision

Create a new immutable revision of this workflow definition. The revision is a snapshot of the content of the definition. This operation has no request body. The response body is the representation of the new _revision_. It is recommended to update the workflow definition's `revisionLabel` _before_ calling this operation. This operation is ignored (it returns 204 No Content) if the workflow definition has not changed since the last time the revision was created. Creating a revision does not alter the entity tag of the workflow definition.


/workflowDefinitions/{workflowDefinitionId}/revisions

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}/revisions?revisionPolicy="
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.createWorkflowDefinitionRevision()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example, // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
  'revisionPolicy': revisionPolicy_example // {String} The `revisionPolicy` property determines how task definitions reference by this workflow definition are processed when creating a workflow definition revision.
If `revisionPolicy` is `none`, then the task definitions referenced by this workflow definition are copied directly to the new workflow definition revision. With this policy, when instantiating a new workflow _`W`_ from the new workflow definitions revision, _`W`_ will use the _revisionless_ task definitions, unless the workflow definition already specifies an explicit task definition revisionless.

If `revisionPolicy` is `taskRevisions` (the default), then the new revision will explicitly link to (and optionally create) the latest _revisions_ of any task definitions embedded within  this workflow definition, even if the workflow definition refers to revisionless task definitions.  This effectively "snapshots" both the workflow definition and the task definitions in one operation. For example, if the workflow embeds task definitions `A` and `B` and `C` such that:

  * A is already a reference to a specific revision `2018-10-10T10:10:10.10Z`
  * B refers to a revisionless task definition _and_ `B` has _not_ been modified since the last revision `2018-10-20T20:20:20.000Z` was created;
  * `C` refers to a revisionless task definition but `C` _has_ been modified since its last revision was created;

then creating new workflow definition revision with `?taskRevisions=true` will first create a task definition revision for `C` (`2018-10-30T13:30:30.300Z`) and the new workflow definition revision will embed the existing revision `2018-10-10T10:10:10.10Z` of `A`, the existing revision `2018-10-20T20:20:20.000Z` of `B`, and the new revision `2018-10-30T13:30:30.300Z` of `C`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.createWorkflowDefinitionRevision(workflowDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
revisionPolicy
String
The `revisionPolicy` property determines how task definitions reference by this workflow definition are processed when creating a workflow definition revision. If `revisionPolicy` is `none`, then the task definitions referenced by this workflow definition are copied directly to the new workflow definition revision. With this policy, when instantiating a new workflow _`W`_ from the new workflow definitions revision, _`W`_ will use the _revisionless_ task definitions, unless the workflow definition already specifies an explicit task definition revisionless. If `revisionPolicy` is `taskRevisions` (the default), then the new revision will explicitly link to (and optionally create) the latest _revisions_ of any task definitions embedded within this workflow definition, even if the workflow definition refers to revisionless task definitions. This effectively "snapshots" both the workflow definition and the task definitions in one operation. For example, if the workflow embeds task definitions `A` and `B` and `C` such that: * A is already a reference to a specific revision `2018-10-10T10:10:10.10Z` * B refers to a revisionless task definition _and_ `B` has _not_ been modified since the last revision `2018-10-20T20:20:20.000Z` was created; * `C` refers to a revisionless task definition but `C` _has_ been modified since its last revision was created; then creating new workflow definition revision with `?taskRevisions=true` will first create a task definition revision for `C` (`2018-10-30T13:30:30.300Z`) and the new workflow definition revision will embed the existing revision `2018-10-10T10:10:10.10Z` of `A`, the existing revision `2018-10-20T20:20:20.000Z` of `B`, and the new revision `2018-10-30T13:30:30.300Z` of `C`.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag for the revision. This entity tag may be passed as the `If-Not-Match` on a `GET` request for the revision location. (This is _not_ the entity tag of the mutable definition resource.)
Location String uri The URI of the new revision. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteWorkflowDefinition

Delete this workflow definition resource

Delete this workflow definition resource. The workflow definition may not be deleted if it or any of its revisions are in use by any tasks. Deleting a workflow definition also deletes all of its revisions.


/workflowDefinitions/{workflowDefinitionId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}"
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.deleteWorkflowDefinition()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
workflowDefinitionApi.deleteWorkflowDefinition(workflowDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getWorkflowDefinition

Fetch a representation of this workflow definition

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this workflow definition resource. This resource is referred to as the `revisionless` workflow definition, in contrast to the explicit revision at `/workflowDefinitions/{workflowDefinitionId}/revisions/{revisionId}`.


/workflowDefinitions/{workflowDefinitionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}"
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.getWorkflowDefinition()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.getWorkflowDefinition(workflowDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow definition resource.


getWorkflowDefinitionRevision

Fetch a representation of an immutable revision of this workflow definition

Return an immutable [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this revision of this workflow definition resource. The revision may also have `prev` and `next` links to previous and/or next revisions, if they exist.


/workflowDefinitions/{workflowDefinitionId}/revisions/{revisionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}/revisions/{revisionId}"
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.getWorkflowDefinitionRevision()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var revisionId = revisionId_example; // {String} The identifier for a revision of this resource. Revision identifiers use [RFC 3339](https://tools.ietf.org/html/rfc3339) format: `YYYY-MM-DDThh:mm:ss.sssZ`.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.getWorkflowDefinitionRevision(workflowDefinitionId, revisionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
revisionId*
String
The identifier for a revision of this resource. Revision identifiers use [RFC 3339](https://tools.ietf.org/html/rfc3339) format: `YYYY-MM-DDThh:mm:ss.sssZ`.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow definition resource.


getWorkflowDefinitionRevisions

Return a collection of workflow definition revisions

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of workflow definition revisions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/workflowDefinitions/{workflowDefinitionId}/revisions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}/revisions?start=&limit=&sortBy=&filter=&q="
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.getWorkflowDefinitionRevisions()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var opts = {
  'start': 789, // {Long} The zero-based index of the first workflow definition revision item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of workflow definition representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.getWorkflowDefinitionRevisions(workflowDefinitionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
Query parameters
Name Description
start
Long (int64)
The zero-based index of the first workflow definition revision item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of workflow definition representations to return in this page.
sortBy
String
Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


getWorkflowDefinitions

Return a collection of workflow definitions

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of workflow definitions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/workflowDefinitions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions?start=&limit=&sortBy=&filter=&q=&state=&name=&domain=&type=&label="
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.getWorkflowDefinitions()
var opts = {
  'start': 789, // {Long} The zero-based index of the first workflow definition item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of workflow definition representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': state_example, // {String} Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'domain': domain_example, // {String} Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items  whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.getWorkflowDefinitions(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first workflow definition item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of workflow definition representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
String
Subset the collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
domain
String
Subset the collection to those with this `domain` value. Use `|` to separate multiple values. For example, `?domain=http://api.apiture.com/acctApps` matches only items whose domain is `http://api.apiture.com/acctApps`; `?domain=http://api.apiture.com/acctApps|http:/api.apiture.com/domains/tasks/forms` will match items whose domain is `http://api.apiture.com/acctApps` or `http:/api.apiture.com/domains/tasks/forms`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose type is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=Email%20Verification` matches only items whose label is `Email Verification`; `?label=Email%20Verification|Account%20Verification` will match items whose label is `Email Verification` or `Account Verification`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchWorkflowDefinition

Update this workflow definition

Perform a partial update of this workflow definition. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/workflowDefinitions/{workflowDefinitionId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}"
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.patchWorkflowDefinition()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var updateWorkflow = ; // {UpdateWorkflow} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.patchWorkflowDefinition(workflowDefinitionId, updateWorkflow, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateWorkflow *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow definition resource.


updateWorkflowDefinition

Update this workflow definition

Perform a complete replacement of this workflow definition.


/workflowDefinitions/{workflowDefinitionId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///workflow/workflowDefinitions/{workflowDefinitionId}"
import { WorkflowDefinitionApi } from "@apiture/workflow-client-sdk";

const workflowDefinitionApi = new WorkflowDefinitionApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
workflowDefinitionApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
workflowDefinitionApi.setApiKey(apiKey);


var api = new Workflow.WorkflowDefinitionApi.updateWorkflowDefinition()
var workflowDefinitionId = workflowDefinitionId_example; // {String} The unique identifier of this workflow definition. This is an opaque string.
var updateWorkflow = ; // {UpdateWorkflow} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
workflowDefinitionApi.updateWorkflowDefinition(workflowDefinitionId, updateWorkflow, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
workflowDefinitionId*
String
The unique identifier of this workflow definition. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateWorkflow *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this workflow definition resource.