libica.openapi.libwes.WorkflowRunsApi¶

All URIs are relative to https://aps2.platform.illumina.com

Method	HTTP request	Description
abort_workflow_run	PUT /v1/workflows/runs/{runId}:abort	Abort a workflow run
get_workflow_run	GET /v1/workflows/runs/{runId}	Get the details of a workflow run
list_workflow_run_history	GET /v1/workflows/runs/{runId}/history	Get a list of workflow run history events
list_workflow_runs	GET /v1/workflows/runs	Get a list of workflow runs

abort_workflow_run¶

WorkflowRun abort_workflow_run(run_id, include=include, body=body)

Abort a workflow run

Aborts the workflow run with a given ID.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libwes
from libica.openapi.libwes.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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 API key authorization: Bearer
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libwes.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libwes.WorkflowRunsApi(api_client)
    run_id = 'run_id_example' # str | ID of the workflow run
include = ['include_example'] # list[str] | Comma-separated list of properties to include in the response (optional)
body = libica.openapi.libwes.AbortWorkflowRunRequest() # AbortWorkflowRunRequest |  (optional)

    try:
        # Abort a workflow run
        api_response = api_instance.abort_workflow_run(run_id, include=include, body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowRunsApi->abort_workflow_run: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
run_id	str	ID of the workflow run
include	list[str]	Comma-separated list of properties to include in the response	[optional]
body	AbortWorkflowRunRequest		[optional]

Return type¶

WorkflowRun

Authorization¶

Bearer

HTTP request headers¶

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Details of the aborted workflow run.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
404	The workflow run with the specified ID was not found.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_workflow_run¶

WorkflowRun get_workflow_run(run_id, include=include)

Get the details of a workflow run

Gets the details of a workflow run with a given ID.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libwes
from libica.openapi.libwes.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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 API key authorization: Bearer
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libwes.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libwes.WorkflowRunsApi(api_client)
    run_id = 'run_id_example' # str | ID of the workflow run
include = ['include_example'] # list[str] | Comma-separated list of properties to include in the response (optional)

    try:
        # Get the details of a workflow run
        api_response = api_instance.get_workflow_run(run_id, include=include)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowRunsApi->get_workflow_run: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
run_id	str	ID of the workflow run
include	list[str]	Comma-separated list of properties to include in the response	[optional]

Return type¶

WorkflowRun

Authorization¶

Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Details of the workflow run.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
404	The workflow run with the specified ID was not found.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_workflow_run_history¶

WorkflowRunHistoryEventList list_workflow_run_history(run_id, sort=sort, include=include, page_size=page_size, page_token=page_token)

Get a list of workflow run history events

Gets a list of history events for a workflow run with a given ID.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libwes
from libica.openapi.libwes.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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 API key authorization: Bearer
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libwes.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libwes.WorkflowRunsApi(api_client)
    run_id = 'run_id_example' # str | ID of the workflow run
sort = 'eventId asc' # str |  (optional) (default to 'eventId asc')
include = ['include_example'] # list[str] | Comma-separated list of properties to include in the response (optional)
page_size = 10 # int | Number of items to include in a page. Value must be an integer between 1 and 1000. Only one of pageSize or pageToken can be specified. (optional) (default to 10)
page_token = 'page_token_example' # str | Page offset descriptor. Valid page tokens are included in the response. Only one of pageSize or pageToken can be specified. (optional)

    try:
        # Get a list of workflow run history events
        api_response = api_instance.list_workflow_run_history(run_id, sort=sort, include=include, page_size=page_size, page_token=page_token)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowRunsApi->list_workflow_run_history: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
run_id	str	ID of the workflow run
sort	str		[optional] [default to 'eventId asc']
include	list[str]	Comma-separated list of properties to include in the response	[optional]
page_size	int	Number of items to include in a page. Value must be an integer between 1 and 1000. Only one of pageSize or pageToken can be specified.	[optional] [default to 10]
page_token	str	Page offset descriptor. Valid page tokens are included in the response. Only one of pageSize or pageToken can be specified.	[optional]

Return type¶

WorkflowRunHistoryEventList

Authorization¶

Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Paged list of workflow run history events.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
404	The workflow run with the specified ID was not found.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_workflow_runs¶

WorkflowRunList list_workflow_runs(status=status, tenant_id=tenant_id, name=name, include=include, page_size=page_size, page_token=page_token, sort=sort)

Get a list of workflow runs

Gets a list of workflow runs.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libwes
from libica.openapi.libwes.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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 API key authorization: Bearer
configuration = libica.openapi.libwes.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libwes.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libwes.WorkflowRunsApi(api_client)
    status = ['status_example'] # list[str] |  (optional)
tenant_id = 'tenant_id_example' # str | ID of the tenant (optional)
name = 'name_example' # str |  (optional)
include = ['include_example'] # list[str] | Comma-separated list of properties to include in the response (optional)
page_size = 10 # int | Number of items to include in a page. Value must be an integer between 1 and 1000. Only one of pageSize or pageToken can be specified. (optional) (default to 10)
page_token = 'page_token_example' # str | Page offset descriptor. Valid page tokens are included in the response. Only one of pageSize or pageToken can be specified. (optional)
sort = 'timeCreated asc' # str | Specifies the order to include list items as \"_{fieldName}_ [asc|desc]\". The second field is optional and specifies the sort direction (\"asc\" for ascending or \"desc\" for descending). (optional) (default to 'timeCreated asc')

    try:
        # Get a list of workflow runs
        api_response = api_instance.list_workflow_runs(status=status, tenant_id=tenant_id, name=name, include=include, page_size=page_size, page_token=page_token, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowRunsApi->list_workflow_runs: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
status	list[str]		[optional]
tenant_id	str	ID of the tenant	[optional]
name	str		[optional]
include	list[str]	Comma-separated list of properties to include in the response	[optional]
page_size	int	Number of items to include in a page. Value must be an integer between 1 and 1000. Only one of pageSize or pageToken can be specified.	[optional] [default to 10]
page_token	str	Page offset descriptor. Valid page tokens are included in the response. Only one of pageSize or pageToken can be specified.	[optional]
sort	str	Specifies the order to include list items as \"{fieldName} [asc	desc]\". The second field is optional and specifies the sort direction (\"asc\" for ascending or \"desc\" for descending).

Return type¶

WorkflowRunList

Authorization¶

Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Paged list of workflow runs that the user has access to.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]