Skip to content

libica.openapi.v3.JobApi

All URIs are relative to /ica/rest

Method HTTP request Description
get_job GET /api/jobs/{jobId} Retrieve a job.
get_jobs GET /api/jobs Retrieve a list of jobs.

get_job

Job get_job(job_id)

Retrieve a job.

Example

  • Bearer (JWT) Authentication (JwtAuth):
  • Api Key Authentication (ApiKeyAuth):
import libica.openapi.v3
from libica.openapi.v3.models.job import Job
from libica.openapi.v3.rest import ApiException
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.v3.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 Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v3.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with libica.openapi.v3.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.v3.JobApi(api_client)
    job_id = 'job_id_example' # str | The ID of the job.

    try:
        # Retrieve a job.
        api_response = api_instance.get_job(job_id)
        print("The response of JobApi->get_job:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobApi->get_job: %s\n" % e)

Parameters

Name Type Description Notes
job_id str The ID of the job.

Return type

Job

Authorization

JwtAuth, ApiKeyAuth

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 job is successfully retrieved. -
0 A problem occurred. -

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

get_jobs

JobPagedList get_jobs(status=status, page_offset=page_offset, page_token=page_token, page_size=page_size, sort=sort)

Retrieve a list of jobs.

Example

  • Bearer (JWT) Authentication (JwtAuth):
  • Api Key Authentication (ApiKeyAuth):
import libica.openapi.v3
from libica.openapi.v3.models.job_paged_list import JobPagedList
from libica.openapi.v3.rest import ApiException
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.v3.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 Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v3.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with libica.openapi.v3.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.v3.JobApi(api_client)
    status = ['status_example'] # List[str] | The statuses to filter on. (optional)
    page_offset = 'page_offset_example' # str | [only use with offset-based paging]<br>The amount of rows to skip in the result. Ideally this is a multiple of the size parameter. Offset-based pagination has a result limit of 200K rows and does not guarantee unique results across pages (optional)
    page_token = 'page_token_example' # str | [only use with cursor-based paging]<br>The cursor to get subsequent results. The value to use is returned in the result when using cursor-based pagination. Cursor-based pagination guarantees complete and unique results across all pages. (optional)
    page_size = 'page_size_example' # str | [can be used with both offset- and cursor-based paging]<br>The amount of rows to return. Use in combination with the offset (when using offset-based pagination) or cursor (when using cursor-based pagination) parameter to get subsequent results (optional)
    sort = 'sort_example' # str | [only use with offset-based paging]<br>Which field to order the results by. The default order is ascending, suffix with ' desc' to sort descending (suffix ' asc' also works for ascending). Multiple values should be separated with commas. An example: \"?sort=sortAttribute1, sortAttribute2 desc\"  The attributes for which sorting is supported: - timeCreated - timeStarted - timeFinished (optional)

    try:
        # Retrieve a list of jobs.
        api_response = api_instance.get_jobs(status=status, page_offset=page_offset, page_token=page_token, page_size=page_size, sort=sort)
        print("The response of JobApi->get_jobs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobApi->get_jobs: %s\n" % e)

Parameters

Name Type Description Notes
status List[str] The statuses to filter on. [optional]
page_offset str [only use with offset-based paging]<br>The amount of rows to skip in the result. Ideally this is a multiple of the size parameter. Offset-based pagination has a result limit of 200K rows and does not guarantee unique results across pages [optional]
page_token str [only use with cursor-based paging]<br>The cursor to get subsequent results. The value to use is returned in the result when using cursor-based pagination. Cursor-based pagination guarantees complete and unique results across all pages. [optional]
page_size str [can be used with both offset- and cursor-based paging]<br>The amount of rows to return. Use in combination with the offset (when using offset-based pagination) or cursor (when using cursor-based pagination) parameter to get subsequent results [optional]
sort str [only use with offset-based paging]<br>Which field to order the results by. The default order is ascending, suffix with ' desc' to sort descending (suffix ' asc' also works for ascending). Multiple values should be separated with commas. An example: \"?sort=sortAttribute1, sortAttribute2 desc\" The attributes for which sorting is supported: - timeCreated - timeStarted - timeFinished [optional]

Return type

JobPagedList

Authorization

JwtAuth, ApiKeyAuth

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 jobs is successfully retrieved. -
0 A problem occurred. -

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