libica.openapi.libwes.WorkflowVersionsApi¶

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

Method	HTTP request	Description
create_workflow_version	POST /v1/workflows/{workflowId}/versions	Create a new workflow version
get_workflow_version	GET /v1/workflows/{workflowId}/versions/{versionName}	Get the details of a workflow version
launch_workflow_version	POST /v1/workflows/{workflowId}/versions/{versionName}:launch	Launch a workflow version
list_all_workflow_versions	GET /v1/workflows/versions	Get a list of all workflow versions
list_workflow_versions	GET /v1/workflows/{workflowId}/versions	Get a list of workflow versions
update_workflow_version	PATCH /v1/workflows/{workflowId}/versions/{versionName}	Update an existing workflow version

create_workflow_version¶

WorkflowVersion create_workflow_version(workflow_id, body=body)

Create a new workflow version

Creates a new workflow version with a given workflow 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.WorkflowVersionsApi(api_client)
    workflow_id = 'workflow_id_example' # str | ID of the workflow
body = libica.openapi.libwes.CreateWorkflowVersionRequest() # CreateWorkflowVersionRequest |  (optional)

    try:
        # Create a new workflow version
        api_response = api_instance.create_workflow_version(workflow_id, body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowVersionsApi->create_workflow_version: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
workflow_id	str	ID of the workflow
body	CreateWorkflowVersionRequest		[optional]

Return type¶

WorkflowVersion

Authorization¶

Bearer

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
201	Details of the created workflow version.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
409	A conflict was found. Ensure the workflow version name is unique.	-
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_version¶

WorkflowVersion get_workflow_version(workflow_id, version_name)

Get the details of a workflow version

Gets the details for a workflow version with a given workflow ID and version name.

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.WorkflowVersionsApi(api_client)
    workflow_id = 'workflow_id_example' # str | ID of the workflow
version_name = 'version_name_example' # str | Name of the workflow version

    try:
        # Get the details of a workflow version
        api_response = api_instance.get_workflow_version(workflow_id, version_name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowVersionsApi->get_workflow_version: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
workflow_id	str	ID of the workflow
version_name	str	Name of the workflow version

Return type¶

WorkflowVersion

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 version.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
404	The workflow ID or version name 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]

launch_workflow_version¶

WorkflowRun launch_workflow_version(workflow_id, version_name, include=include, body=body)

Launch a workflow version

Launches a workflow version with a given workflow ID and version name.

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.WorkflowVersionsApi(api_client)
    workflow_id = 'workflow_id_example' # str | ID of the workflow
version_name = 'version_name_example' # str | Name of the workflow version
include = ['include_example'] # list[str] | Comma-separated list of properties to include in the response (optional)
body = libica.openapi.libwes.LaunchWorkflowVersionRequest() # LaunchWorkflowVersionRequest |  (optional)

    try:
        # Launch a workflow version
        api_response = api_instance.launch_workflow_version(workflow_id, version_name, include=include, body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowVersionsApi->launch_workflow_version: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
workflow_id	str	ID of the workflow
version_name	str	Name of the workflow version
include	list[str]	Comma-separated list of properties to include in the response	[optional]
body	LaunchWorkflowVersionRequest		[optional]

Return type¶

WorkflowRun

Authorization¶

Bearer

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
201	Details of the created workflow run.	-
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]

list_all_workflow_versions¶

WorkflowVersionList list_all_workflow_versions(tenant_id=tenant_id, include=include, page_size=page_size, page_token=page_token, sort=sort)

Get a list of all workflow versions

Gets a list of workflow versions across all workflows.

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.WorkflowVersionsApi(api_client)
    tenant_id = 'tenant_id_example' # str | ID of the tenant (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 all workflow versions
        api_response = api_instance.list_all_workflow_versions(tenant_id=tenant_id, include=include, page_size=page_size, page_token=page_token, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowVersionsApi->list_all_workflow_versions: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
tenant_id	str	ID of the tenant	[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¶

WorkflowVersionList

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 versions across all workflows.	-
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]

list_workflow_versions¶

WorkflowVersionList list_workflow_versions(workflow_id, include=include, page_size=page_size, page_token=page_token, sort=sort)

Get a list of workflow versions

Gets a list of workflow versions with a given workflow 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.WorkflowVersionsApi(api_client)
    workflow_id = 'workflow_id_example' # str | ID of the workflow
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 versions
        api_response = api_instance.list_workflow_versions(workflow_id, include=include, page_size=page_size, page_token=page_token, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowVersionsApi->list_workflow_versions: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
workflow_id	str	ID of the workflow
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¶

WorkflowVersionList

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 versions that the user has access to.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
404	The workflow 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]

update_workflow_version¶

WorkflowVersion update_workflow_version(workflow_id, version_name, body=body)

Update an existing workflow version

Updates an existing workflow version. Note: The Version, Definition, and Status cannot be changed simultaneously. Only one of these can be changed per API call.

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.WorkflowVersionsApi(api_client)
    workflow_id = 'workflow_id_example' # str | ID of the workflow
version_name = 'version_name_example' # str | Name of the workflow version
body = libica.openapi.libwes.UpdateWorkflowVersionRequest() # UpdateWorkflowVersionRequest |  (optional)

    try:
        # Update an existing workflow version
        api_response = api_instance.update_workflow_version(workflow_id, version_name, body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowVersionsApi->update_workflow_version: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
workflow_id	str	ID of the workflow
version_name	str	Name of the workflow version
body	UpdateWorkflowVersionRequest		[optional]

Return type¶

WorkflowVersion

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 created workflow run.	-
400	Invalid request.	-
401	Unauthorized	-
403	Permission denied.	-
404	The workflow ID or version name was not found.	-
409	A conflict was found. Ensure the workflow version name is unique.	-
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]