# rxfoundry.clients.swifty_api.TaskApi All URIs are relative to */api* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_patient_task_statuses**](TaskApi.md#get_patient_task_statuses) | **GET** /swifty/1/tasks/patient_tasks/{patient_task_uuid}/statuses | Gets list of statuses for a patient task [**get_patient_tasks**](TaskApi.md#get_patient_tasks) | **GET** /swifty/1/tasks/patient_tasks | Get all patient tasks [**get_prescription_message_task_statuses**](TaskApi.md#get_prescription_message_task_statuses) | **GET** /swifty/1/tasks/prescription_message_tasks/{prescription_message_task_uuid}/statuses | Gets list of statuses for a prescription message task [**get_prescription_message_tasks**](TaskApi.md#get_prescription_message_tasks) | **GET** /swifty/1/tasks/prescription_message_tasks | Gets list of prescription message tasks [**get_prescription_task_statuses**](TaskApi.md#get_prescription_task_statuses) | **GET** /swifty/1/tasks/prescription_tasks/{prescription_task_uuid}/statuses | Gets list of statuses for a prescription task [**get_prescription_tasks**](TaskApi.md#get_prescription_tasks) | **GET** /swifty/1/tasks/prescription_tasks | Get all prescription tasks # **get_patient_task_statuses** > List[PatientTaskStatus] get_patient_task_statuses(patient_task_uuid) Gets list of statuses for a patient task Get a list of statuses for a patient task ### Example * Bearer (opaque) Authentication (opaque_token): ```python import rxfoundry.clients.swifty_api from rxfoundry.clients.swifty_api.models.patient_task_status import PatientTaskStatus 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.TaskApi(api_client) patient_task_uuid = 'patient_task_uuid_example' # str | try: # Gets list of statuses for a patient task api_response = api_instance.get_patient_task_statuses(patient_task_uuid) print("The response of TaskApi->get_patient_task_statuses:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskApi->get_patient_task_statuses: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **patient_task_uuid** | **str**| | ### Return type [**List[PatientTaskStatus]**](PatientTaskStatus.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 statuses for a patient task | - | **404** | Patient task 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_patient_tasks** > List[PatientTask] get_patient_tasks(task_type=task_type, is_completed=is_completed, manual_review_required=manual_review_required, page=page, results_per_page=results_per_page) Get all patient tasks ### Example * Bearer (opaque) Authentication (opaque_token): ```python import rxfoundry.clients.swifty_api from rxfoundry.clients.swifty_api.models.patient_task import PatientTask from rxfoundry.clients.swifty_api.models.patient_task_type import PatientTaskType 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.TaskApi(api_client) task_type = rxfoundry.clients.swifty_api.PatientTaskType() # PatientTaskType | (optional) is_completed = True # bool | (optional) manual_review_required = True # bool | (optional) page = 1 # int | (optional) (default to 1) results_per_page = 10 # int | (optional) (default to 10) try: # Get all patient tasks api_response = api_instance.get_patient_tasks(task_type=task_type, is_completed=is_completed, manual_review_required=manual_review_required, page=page, results_per_page=results_per_page) print("The response of TaskApi->get_patient_tasks:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskApi->get_patient_tasks: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_type** | [**PatientTaskType**](.md)| | [optional] **is_completed** | **bool**| | [optional] **manual_review_required** | **bool**| | [optional] **page** | **int**| | [optional] [default to 1] **results_per_page** | **int**| | [optional] [default to 10] ### Return type [**List[PatientTask]**](PatientTask.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 all patient tasks | * X-Total-Count - Total number of workflows available
* X-Page - Current page number
* X-Per-Page - Number of workflows per page
* X-Total-Pages - Total number of pages available
| **404** | No patient tasks 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_prescription_message_task_statuses** > List[PrescriptionMessageTaskStatus] get_prescription_message_task_statuses(prescription_message_task_uuid) Gets list of statuses for a prescription message task Get a list of statuses for a prescription message task ### Example * Bearer (opaque) Authentication (opaque_token): ```python import rxfoundry.clients.swifty_api from rxfoundry.clients.swifty_api.models.prescription_message_task_status import PrescriptionMessageTaskStatus 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.TaskApi(api_client) prescription_message_task_uuid = 'prescription_message_task_uuid_example' # str | try: # Gets list of statuses for a prescription message task api_response = api_instance.get_prescription_message_task_statuses(prescription_message_task_uuid) print("The response of TaskApi->get_prescription_message_task_statuses:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskApi->get_prescription_message_task_statuses: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **prescription_message_task_uuid** | **str**| | ### Return type [**List[PrescriptionMessageTaskStatus]**](PrescriptionMessageTaskStatus.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 statuses for a prescription message task | - | **404** | Prescription message task 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_prescription_message_tasks** > List[PrescriptionMessageTask] get_prescription_message_tasks(task_type=task_type, is_completed=is_completed, manual_review_required=manual_review_required, page=page, results_per_page=results_per_page) Gets list of prescription message tasks Get a list of prescription message tasks ### Example * Bearer (opaque) Authentication (opaque_token): ```python import rxfoundry.clients.swifty_api from rxfoundry.clients.swifty_api.models.prescription_message_task import PrescriptionMessageTask from rxfoundry.clients.swifty_api.models.prescription_message_task_type import PrescriptionMessageTaskType 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.TaskApi(api_client) task_type = rxfoundry.clients.swifty_api.PrescriptionMessageTaskType() # PrescriptionMessageTaskType | (optional) is_completed = True # bool | (optional) manual_review_required = True # bool | (optional) page = 1 # int | (optional) (default to 1) results_per_page = 10 # int | (optional) (default to 10) try: # Gets list of prescription message tasks api_response = api_instance.get_prescription_message_tasks(task_type=task_type, is_completed=is_completed, manual_review_required=manual_review_required, page=page, results_per_page=results_per_page) print("The response of TaskApi->get_prescription_message_tasks:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskApi->get_prescription_message_tasks: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_type** | [**PrescriptionMessageTaskType**](.md)| | [optional] **is_completed** | **bool**| | [optional] **manual_review_required** | **bool**| | [optional] **page** | **int**| | [optional] [default to 1] **results_per_page** | **int**| | [optional] [default to 10] ### Return type [**List[PrescriptionMessageTask]**](PrescriptionMessageTask.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 all prescription message tasks | * X-Total-Count - Total number of workflows available
* X-Page - Current page number
* X-Per-Page - Number of workflows per page
* X-Total-Pages - Total number of pages available
| **404** | No prescription messages 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_prescription_task_statuses** > List[PrescriptionTaskStatus] get_prescription_task_statuses(prescription_task_uuid) Gets list of statuses for a prescription task Get a list of statuses for a prescription task ### Example * Bearer (opaque) Authentication (opaque_token): ```python import rxfoundry.clients.swifty_api from rxfoundry.clients.swifty_api.models.prescription_task_status import PrescriptionTaskStatus 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.TaskApi(api_client) prescription_task_uuid = 'prescription_task_uuid_example' # str | try: # Gets list of statuses for a prescription task api_response = api_instance.get_prescription_task_statuses(prescription_task_uuid) print("The response of TaskApi->get_prescription_task_statuses:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskApi->get_prescription_task_statuses: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **prescription_task_uuid** | **str**| | ### Return type [**List[PrescriptionTaskStatus]**](PrescriptionTaskStatus.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 statuses for a prescription task | - | **404** | Prescription task 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_prescription_tasks** > List[PrescriptionTask] get_prescription_tasks(task_type=task_type, is_completed=is_completed, manual_review_required=manual_review_required, page=page, results_per_page=results_per_page) Get all prescription tasks ### Example * Bearer (opaque) Authentication (opaque_token): ```python import rxfoundry.clients.swifty_api from rxfoundry.clients.swifty_api.models.prescription_task import PrescriptionTask from rxfoundry.clients.swifty_api.models.prescription_task_type import PrescriptionTaskType 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.TaskApi(api_client) task_type = rxfoundry.clients.swifty_api.PrescriptionTaskType() # PrescriptionTaskType | (optional) is_completed = True # bool | (optional) manual_review_required = True # bool | (optional) page = 1 # int | (optional) (default to 1) results_per_page = 10 # int | (optional) (default to 10) try: # Get all prescription tasks api_response = api_instance.get_prescription_tasks(task_type=task_type, is_completed=is_completed, manual_review_required=manual_review_required, page=page, results_per_page=results_per_page) print("The response of TaskApi->get_prescription_tasks:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskApi->get_prescription_tasks: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_type** | [**PrescriptionTaskType**](.md)| | [optional] **is_completed** | **bool**| | [optional] **manual_review_required** | **bool**| | [optional] **page** | **int**| | [optional] [default to 1] **results_per_page** | **int**| | [optional] [default to 10] ### Return type [**List[PrescriptionTask]**](PrescriptionTask.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 all prescription tasks | * X-Total-Count - Total number of workflows available
* X-Page - Current page number
* X-Per-Page - Number of workflows per page
* X-Total-Pages - Total number of pages available
| **404** | No prescription tasks 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)