libica.openapi.v2.WorkgroupApi

All URIs are relative to /ica/rest

Method	HTTP request	Description
get_workgroup	GET /api/workgroups/{workgroupId}	Retrieve a workgroup.
get_workgroups	GET /api/workgroups	Retrieve a list of workgroups.

get_workgroup

Workgroup get_workgroup(workgroup_id)

Retrieve a workgroup.

Example

• Api Key Authentication (ApiKeyAuth):
• Bearer (JWT) Authentication (JwtAuth):

import time
import libica.openapi.v2
from libica.openapi.v2.api import workgroup_api
from libica.openapi.v2.model.workgroup import Workgroup
from libica.openapi.v2.model.problem import Problem
from pprint import pprint
# Defining the host is optional and defaults to /ica/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.v2.Configuration(
    host = "/ica/rest"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v2.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with libica.openapi.v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = workgroup_api.WorkgroupApi(api_client)
    workgroup_id = "workgroupId_example" # str | The ID of the workgroup to retrieve

    # example passing only required values which don't have defaults set
    try:
        # Retrieve a workgroup.
        api_response = api_instance.get_workgroup(workgroup_id)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling WorkgroupApi->get_workgroup: %s\n" % e)

Parameters

Name	Type	Description	Notes
workgroup_id	str	The ID of the workgroup to retrieve

Return type

Workgroup

Authorization

ApiKeyAuth, JwtAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/problem+json, application/vnd.illumina.v3+json

HTTP response details

Status code	Description	Response headers
200	The workgroup is successfully retrieved.	-
0	A problem occurred.	-

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

get_workgroups

WorkgroupList get_workgroups()

Retrieve a list of workgroups.

Example

• Api Key Authentication (ApiKeyAuth):
• Bearer (JWT) Authentication (JwtAuth):

import time
import libica.openapi.v2
from libica.openapi.v2.api import workgroup_api
from libica.openapi.v2.model.workgroup_list import WorkgroupList
from libica.openapi.v2.model.problem import Problem
from pprint import pprint
# Defining the host is optional and defaults to /ica/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.v2.Configuration(
    host = "/ica/rest"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v2.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with libica.openapi.v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = workgroup_api.WorkgroupApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Retrieve a list of workgroups.
        api_response = api_instance.get_workgroups()
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling WorkgroupApi->get_workgroups: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

WorkgroupList

Authorization

ApiKeyAuth, JwtAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/problem+json, application/vnd.illumina.v3+json

HTTP response details

Status code	Description	Response headers
200	The list of workgroups is successfully retrieved.	-
0	A problem occurred.	-

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