rxfoundry.clients.swifty_api.WorkflowApi

All URIs are relative to /api

Method	HTTP request	Description
get_workflow_tasks	GET /swifty/1/workflows/{workflow_uuid}	Gets the details for a workflow
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):

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]

Authorization

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] [Back to Model list] [Back to README]

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