Skip to content

libica.openapi.libwes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The libica.openapi.libwes package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build date: 2024-07-26T11:42:23.608026+10:00[Australia/Melbourne]
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.15
  • six >= 1.10
  • certifi
  • python-dateutil

Getting Started

In your own code, to use this library to connect and interact with libica.openapi.libwes, you can run the following:

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)

Documentation for API Endpoints

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

Class Method HTTP request Description
WorkflowRunsApi abort_workflow_run PUT /v1/workflows/runs/{runId}:abort Abort a workflow run
WorkflowRunsApi get_workflow_run GET /v1/workflows/runs/{runId} Get the details of a workflow run
WorkflowRunsApi list_workflow_run_history GET /v1/workflows/runs/{runId}/history Get a list of workflow run history events
WorkflowRunsApi list_workflow_runs GET /v1/workflows/runs Get a list of workflow runs
WorkflowSignalsApi fail_signal PATCH /v1/workflows/signals/{signalId}:fail Fail a workflow signal
WorkflowSignalsApi get_signal GET /v1/workflows/signals/{signalId} Get the details of a workflow signal
WorkflowSignalsApi list_signals GET /v1/workflows/signals Get a list of workflow signals
WorkflowSignalsApi succeed_signal PATCH /v1/workflows/signals/{signalId}:succeed Succeed a workflow signal
WorkflowVersionsApi create_workflow_version POST /v1/workflows/{workflowId}/versions Create a new workflow version
WorkflowVersionsApi get_workflow_version GET /v1/workflows/{workflowId}/versions/{versionName} Get the details of a workflow version
WorkflowVersionsApi launch_workflow_version POST /v1/workflows/{workflowId}/versions/{versionName}:launch Launch a workflow version
WorkflowVersionsApi list_all_workflow_versions GET /v1/workflows/versions Get a list of all workflow versions
WorkflowVersionsApi list_workflow_versions GET /v1/workflows/{workflowId}/versions Get a list of workflow versions
WorkflowVersionsApi update_workflow_version PATCH /v1/workflows/{workflowId}/versions/{versionName} Update an existing workflow version
WorkflowsApi create_workflow POST /v1/workflows Create a workflow
WorkflowsApi get_workflow GET /v1/workflows/{workflowId} Get the details of a workflow
WorkflowsApi list_workflows GET /v1/workflows Get a list of workflows
WorkflowsApi update_workflow PATCH /v1/workflows/{workflowId} Update an existing workflow

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author