# UltracartClient::WorkflowApi

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

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_workflow_assignment_groups**](WorkflowApi.md#get_workflow_assignment_groups) | **GET** /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to |
| [**get_workflow_assignment_users**](WorkflowApi.md#get_workflow_assignment_users) | **GET** /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to |
| [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task |
| [**get_workflow_task_attachment_upload_url**](WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL |
| [**get_workflow_task_by_object_type**](WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id |
| [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks |
| [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task |
| [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task |


## get_workflow_assignment_groups

> <WorkflowGroupsResponse> get_workflow_assignment_groups(opts)

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

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

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
  _offset: 56 # Integer | Pagination of the record set.  Offset is a zero based index.
}

begin
  # Retrieve a list of groups that workflow tasks can be assigned to
  result = api_instance.get_workflow_assignment_groups(opts)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_assignment_groups: #{e}"
end
```

#### Using the get_workflow_assignment_groups_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowGroupsResponse>, Integer, Hash)> get_workflow_assignment_groups_with_http_info(opts)

```ruby
begin
  # Retrieve a list of groups that workflow tasks can be assigned to
  data, status_code, headers = api_instance.get_workflow_assignment_groups_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowGroupsResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_assignment_groups_with_http_info: #{e}"
end
```

### 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**](WorkflowGroupsResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_workflow_assignment_users

> <WorkflowUsersResponse> get_workflow_assignment_users(opts)

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

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

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
  _offset: 56 # Integer | Pagination of the record set.  Offset is a zero based index.
}

begin
  # Retrieve a list of users that workflow tasks can be assigned to
  result = api_instance.get_workflow_assignment_users(opts)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_assignment_users: #{e}"
end
```

#### Using the get_workflow_assignment_users_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowUsersResponse>, Integer, Hash)> get_workflow_assignment_users_with_http_info(opts)

```ruby
begin
  # Retrieve a list of users that workflow tasks can be assigned to
  data, status_code, headers = api_instance.get_workflow_assignment_users_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowUsersResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_assignment_users_with_http_info: #{e}"
end
```

### 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**](WorkflowUsersResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_workflow_task

> <WorkflowTaskResponse> get_workflow_task(task_uuid)

Retrieve a workflow task

Retrieve a workflow task 

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
task_uuid = 'task_uuid_example' # String | 

begin
  # Retrieve a workflow task
  result = api_instance.get_workflow_task(task_uuid)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_task: #{e}"
end
```

#### Using the get_workflow_task_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowTaskResponse>, Integer, Hash)> get_workflow_task_with_http_info(task_uuid)

```ruby
begin
  # Retrieve a workflow task
  data, status_code, headers = api_instance.get_workflow_task_with_http_info(task_uuid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowTaskResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_task_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **task_uuid** | **String** |  |  |

### Return type

[**WorkflowTaskResponse**](WorkflowTaskResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_workflow_task_attachment_upload_url

> <WorkflowAttachmentUploadUrlResponse> get_workflow_task_attachment_upload_url(extension)

Get a presigned workflow task attachment upload URL

Get a presigned workflow task attachment upload URL 

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
extension = 'extension_example' # String | 

begin
  # Get a presigned workflow task attachment upload URL
  result = api_instance.get_workflow_task_attachment_upload_url(extension)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url: #{e}"
end
```

#### Using the get_workflow_task_attachment_upload_url_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowAttachmentUploadUrlResponse>, Integer, Hash)> get_workflow_task_attachment_upload_url_with_http_info(extension)

```ruby
begin
  # Get a presigned workflow task attachment upload URL
  data, status_code, headers = api_instance.get_workflow_task_attachment_upload_url_with_http_info(extension)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowAttachmentUploadUrlResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_task_attachment_upload_url_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **extension** | **String** |  |  |

### Return type

[**WorkflowAttachmentUploadUrlResponse**](WorkflowAttachmentUploadUrlResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_workflow_task_by_object_type

> <WorkflowTasksResponse> get_workflow_task_by_object_type(object_type, object_id)

Retrieve a workflow task by object type and id

Retrieve a workflow task by object type and id 

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
object_type = 'object_type_example' # String | 
object_id = 'object_id_example' # String | 

begin
  # Retrieve a workflow task by object type and id
  result = api_instance.get_workflow_task_by_object_type(object_type, object_id)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_task_by_object_type: #{e}"
end
```

#### Using the get_workflow_task_by_object_type_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_task_by_object_type_with_http_info(object_type, object_id)

```ruby
begin
  # Retrieve a workflow task by object type and id
  data, status_code, headers = api_instance.get_workflow_task_by_object_type_with_http_info(object_type, object_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowTasksResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_task_by_object_type_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **object_type** | **String** |  |  |
| **object_id** | **String** |  |  |

### Return type

[**WorkflowTasksResponse**](WorkflowTasksResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_workflow_tasks

> <WorkflowTasksResponse> get_workflow_tasks(workflow_tasks_query, opts)

Search workflow tasks

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

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
workflow_tasks_query = UltracartClient::WorkflowTasksRequest.new # WorkflowTasksRequest | Workflow tasks query
opts = {
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
  _offset: 56, # Integer | Pagination of the record set.  Offset is a zero based index.
  _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.
}

begin
  # Search workflow tasks
  result = api_instance.get_workflow_tasks(workflow_tasks_query, opts)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_tasks: #{e}"
end
```

#### Using the get_workflow_tasks_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowTasksResponse>, Integer, Hash)> get_workflow_tasks_with_http_info(workflow_tasks_query, opts)

```ruby
begin
  # Search workflow tasks
  data, status_code, headers = api_instance.get_workflow_tasks_with_http_info(workflow_tasks_query, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowTasksResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->get_workflow_tasks_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **workflow_tasks_query** | [**WorkflowTasksRequest**](WorkflowTasksRequest.md) | 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**](WorkflowTasksResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

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


## insert_workflow_task

> <WorkflowTaskResponse> insert_workflow_task(workflow_task)

Insert a workflow task

Insert a workflow task 

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | workflow task

begin
  # Insert a workflow task
  result = api_instance.insert_workflow_task(workflow_task)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->insert_workflow_task: #{e}"
end
```

#### Using the insert_workflow_task_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowTaskResponse>, Integer, Hash)> insert_workflow_task_with_http_info(workflow_task)

```ruby
begin
  # Insert a workflow task
  data, status_code, headers = api_instance.insert_workflow_task_with_http_info(workflow_task)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowTaskResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->insert_workflow_task_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | workflow task |  |

### Return type

[**WorkflowTaskResponse**](WorkflowTaskResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

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


## update_workflow_task

> <WorkflowTaskResponse> update_workflow_task(task_uuid, workflow_task)

Update a workflow task

Update a workflow task 

### Examples

```ruby
require 'time'
require 'ultracart_api'
require 'json'
require 'yaml'
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb

# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
# As such, this might not be the best way to use this object.
# Please see https://github.com/UltraCart/sdk_samples for working examples.

api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
task_uuid = 'task_uuid_example' # String | 
workflow_task = UltracartClient::WorkflowTask.new # WorkflowTask | Workflow task

begin
  # Update a workflow task
  result = api_instance.update_workflow_task(task_uuid, workflow_task)
  p result
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->update_workflow_task: #{e}"
end
```

#### Using the update_workflow_task_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<WorkflowTaskResponse>, Integer, Hash)> update_workflow_task_with_http_info(task_uuid, workflow_task)

```ruby
begin
  # Update a workflow task
  data, status_code, headers = api_instance.update_workflow_task_with_http_info(task_uuid, workflow_task)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WorkflowTaskResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling WorkflowApi->update_workflow_task_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **task_uuid** | **String** |  |  |
| **workflow_task** | [**WorkflowTask**](WorkflowTask.md) | Workflow task |  |

### Return type

[**WorkflowTaskResponse**](WorkflowTaskResponse.md)

### Authorization

[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)

### HTTP request headers

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