WorkflowApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method	HTTP request	Description
getWorkflowAssignmentGroups	GET /workflow/assignment_groups	Retrieve a list of groups that workflow tasks can be assigned to
getWorkflowAssignmentUsers	GET /workflow/assignment_users	Retrieve a list of users that workflow tasks can be assigned to
getWorkflowMe	GET /workflow/me	Retrieve a user object for myself
getWorkflowTask	GET /workflow/tasks/{task_uuid}	Retrieve a workflow task
getWorkflowTaskAttachmentUploadUrl	GET /workflow/tasks/attachments/{extension}	Get a presigned workflow task attachment upload URL
getWorkflowTaskByObjectType	GET /workflow/tasks/by/{object_type}/{object_id}	Retrieve a workflow task by object type and id
getWorkflowTasks	POST /workflow/tasks/search	Search workflow tasks
insertWorkflowTask	POST /workflow/tasks	Insert a workflow task
updateWorkflowTask	PUT /workflow/tasks/{task_uuid}	Update a workflow task

getWorkflowAssignmentGroups

WorkflowGroupsResponse getWorkflowAssignmentGroups(limit, offset)

Retrieve a list of groups that workflow tasks can be assigned to

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

Integer limit = 100; // Integer | The maximum number of records to return on this one API call. (Max 200)
Integer offset = 0; // Integer | Pagination of the record set.  Offset is a zero based index.
try {
    WorkflowGroupsResponse result = apiInstance.getWorkflowAssignmentGroups(limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowAssignmentGroups");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer	The maximum number of records to return on this one API call. (Max 200)	[optional] [default to 100]
offset	Integer	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]

Return type

WorkflowGroupsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getWorkflowAssignmentUsers

WorkflowUsersResponse getWorkflowAssignmentUsers(limit, offset)

Retrieve a list of users that workflow tasks can be assigned to

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

Integer limit = 100; // Integer | The maximum number of records to return on this one API call. (Max 200)
Integer offset = 0; // Integer | Pagination of the record set.  Offset is a zero based index.
try {
    WorkflowUsersResponse result = apiInstance.getWorkflowAssignmentUsers(limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowAssignmentUsers");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer	The maximum number of records to return on this one API call. (Max 200)	[optional] [default to 100]
offset	Integer	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]

Return type

WorkflowUsersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getWorkflowMe

WorkflowUserResponse getWorkflowMe()

Retrieve a user object for myself

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

try {
    WorkflowUserResponse result = apiInstance.getWorkflowMe();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowMe");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

WorkflowUserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getWorkflowTask

WorkflowTaskResponse getWorkflowTask(taskUuid)

Retrieve a workflow task

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

String taskUuid = "taskUuid_example"; // String | 
try {
    WorkflowTaskResponse result = apiInstance.getWorkflowTask(taskUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowTask");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskUuid	String

Return type

WorkflowTaskResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getWorkflowTaskAttachmentUploadUrl

WorkflowAttachmentUploadUrlResponse getWorkflowTaskAttachmentUploadUrl(extension)

Get a presigned workflow task attachment upload URL

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

String extension = "extension_example"; // String | 
try {
    WorkflowAttachmentUploadUrlResponse result = apiInstance.getWorkflowTaskAttachmentUploadUrl(extension);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowTaskAttachmentUploadUrl");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
extension	String

Return type

WorkflowAttachmentUploadUrlResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getWorkflowTaskByObjectType

WorkflowTasksResponse getWorkflowTaskByObjectType(objectType, objectId)

Retrieve a workflow task by object type and id

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

String objectType = "objectType_example"; // String | 
String objectId = "objectId_example"; // String | 
try {
    WorkflowTasksResponse result = apiInstance.getWorkflowTaskByObjectType(objectType, objectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowTaskByObjectType");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
objectType	String
objectId	String

Return type

WorkflowTasksResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getWorkflowTasks

WorkflowTasksResponse getWorkflowTasks(workflowTasksQuery, limit, offset, sort)

Search workflow tasks

Retrieves a set of workflow tasks from the account based on a query object.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

WorkflowTasksRequest workflowTasksQuery = new WorkflowTasksRequest(); // WorkflowTasksRequest | Workflow tasks query
Integer limit = 100; // Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
Integer offset = 0; // Integer | Pagination of the record set.  Offset is a zero based index.
String sort = "sort_example"; // String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
try {
    WorkflowTasksResponse result = apiInstance.getWorkflowTasks(workflowTasksQuery, limit, offset, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#getWorkflowTasks");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workflowTasksQuery	WorkflowTasksRequest	Workflow tasks query
limit	Integer	The maximum number of records to return on this one API call. (Default 100, Max 500)	[optional] [default to 100]
offset	Integer	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
sort	String	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

WorkflowTasksResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

insertWorkflowTask

WorkflowTaskResponse insertWorkflowTask(workflowTask)

Insert a workflow task

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

WorkflowTask workflowTask = new WorkflowTask(); // WorkflowTask | workflow task
try {
    WorkflowTaskResponse result = apiInstance.insertWorkflowTask(workflowTask);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#insertWorkflowTask");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workflowTask	WorkflowTask	workflow task

Return type

WorkflowTaskResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

updateWorkflowTask

WorkflowTaskResponse updateWorkflowTask(taskUuid, workflowTask)

Update a workflow task

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.WorkflowApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
WorkflowApi apiInstance = new WorkflowApi(apiKey);

String taskUuid = "taskUuid_example"; // String | 
WorkflowTask workflowTask = new WorkflowTask(); // WorkflowTask | Workflow task
try {
    WorkflowTaskResponse result = apiInstance.updateWorkflowTask(taskUuid, workflowTask);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowApi#updateWorkflowTask");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskUuid	String
workflowTask	WorkflowTask	Workflow task

Return type

WorkflowTaskResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

WorkflowApi.md

Latest commit

History

WorkflowApi.md

File metadata and controls

WorkflowApi

getWorkflowAssignmentGroups

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkflowAssignmentUsers

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkflowMe

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkflowTask

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkflowTaskAttachmentUploadUrl

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkflowTaskByObjectType

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkflowTasks

Example

Parameters

Return type

Authorization

HTTP request headers

insertWorkflowTask

Example

Parameters

Return type

Authorization

HTTP request headers

updateWorkflowTask

Example

Parameters

Return type

Authorization

HTTP request headers