# rxfoundry.clients.swifty_api.WorkflowApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **GET** /swifty/1/workflows/{workflow_uuid} | Gets the details for a workflow
[**get_workflows**](WorkflowApi.md#get_workflows) | **GET** /swifty/1/workflows | Get a list of workflows for the tenant


# **get_workflow_tasks**
> List[WorkflowTask] get_workflow_tasks(workflow_uuid, deep=deep)

Gets the details for a workflow

### Example

* Bearer (opaque) Authentication (opaque_token):

```python
import rxfoundry.clients.swifty_api
from rxfoundry.clients.swifty_api.models.workflow_task import WorkflowTask
from rxfoundry.clients.swifty_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_api.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (opaque): opaque_token
configuration = rxfoundry.clients.swifty_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rxfoundry.clients.swifty_api.WorkflowApi(api_client)
    workflow_uuid = 'workflow_uuid_example' # str | 
    deep = False # bool | Whether to return contained object for the workflow or just minimal information.  Defaults to false. (optional) (default to False)

    try:
        # Gets the details for a workflow
        api_response = api_instance.get_workflow_tasks(workflow_uuid, deep=deep)
        print("The response of WorkflowApi->get_workflow_tasks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowApi->get_workflow_tasks: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workflow_uuid** | **str**|  | 
 **deep** | **bool**| Whether to return contained object for the workflow or just minimal information.  Defaults to false. | [optional] [default to False]

### Return type

[**List[WorkflowTask]**](WorkflowTask.md)

### Authorization

[opaque_token](../README.md#opaque_token)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A list of tasks for the workflow |  -  |
**404** | Workflow not found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_workflows**
> List[Workflow] get_workflows(workflow_type=workflow_type, is_completed=is_completed, completed_with_errors=completed_with_errors, page=page, results_per_page=results_per_page)

Get a list of workflows for the tenant

### Example

* Bearer (opaque) Authentication (opaque_token):

```python
import rxfoundry.clients.swifty_api
from rxfoundry.clients.swifty_api.models.workflow import Workflow
from rxfoundry.clients.swifty_api.models.workflow_type import WorkflowType
from rxfoundry.clients.swifty_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_api.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (opaque): opaque_token
configuration = rxfoundry.clients.swifty_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rxfoundry.clients.swifty_api.WorkflowApi(api_client)
    workflow_type = rxfoundry.clients.swifty_api.WorkflowType() # WorkflowType |  (optional)
    is_completed = True # bool |  (optional)
    completed_with_errors = True # bool |  (optional)
    page = 1 # int |  (optional) (default to 1)
    results_per_page = 10 # int |  (optional) (default to 10)

    try:
        # Get a list of workflows for the tenant
        api_response = api_instance.get_workflows(workflow_type=workflow_type, is_completed=is_completed, completed_with_errors=completed_with_errors, page=page, results_per_page=results_per_page)
        print("The response of WorkflowApi->get_workflows:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowApi->get_workflows: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workflow_type** | [**WorkflowType**](.md)|  | [optional] 
 **is_completed** | **bool**|  | [optional] 
 **completed_with_errors** | **bool**|  | [optional] 
 **page** | **int**|  | [optional] [default to 1]
 **results_per_page** | **int**|  | [optional] [default to 10]

### Return type

[**List[Workflow]**](Workflow.md)

### Authorization

[opaque_token](../README.md#opaque_token)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A list of workflows |  * X-Total-Count - Total number of workflows available <br>  * X-Page - Current page number <br>  * X-Per-Page - Number of workflows per page <br>  * X-Total-Pages - Total number of pages available <br>  |
**404** | No workflows found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)