odm_api.TransformationImagesApi¶

All URIs are relative to http://localhost

Method	HTTP request	Description
get_api_v1_transformations_images	GET /api/v1/transformations/images	List transformation images

get_api_v1_transformations_images¶

TransformationImagePage get_api_v1_transformations_images(limit=limit, offset=offset)

List transformation images

Returns a paginated list of the transformation images available to run as jobs. Each entry includes the accepted input formats, the produced output formats, and default compute requirements (memory and volume size). Use the limit and offset query parameters to paginate through the results.

Example¶

Api Key Authentication (Access-token):
Api Key Authentication (Genestack-API-Token):

import odm_api
from odm_api.models.transformation_image_page import TransformationImagePage
from odm_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = odm_api.Configuration(
    host = "http://localhost"
)

# 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: Access-token
configuration.api_key['Access-token'] = os.environ["API_KEY"]

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

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

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

# Enter a context with an instance of the API client
with odm_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = odm_api.TransformationImagesApi(api_client)
    limit = 100 # int | Maximum number of items to return per page. (optional) (default to 100)
    offset = 0 # int | Number of items to skip from the start of the list. Use with limit to paginate through results. (optional) (default to 0)

    try:
        # List transformation images
        api_response = api_instance.get_api_v1_transformations_images(limit=limit, offset=offset)
        print("The response of TransformationImagesApi->get_api_v1_transformations_images:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationImagesApi->get_api_v1_transformations_images: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
limit	int	Maximum number of items to return per page.	[optional] [default to 100]
offset	int	Number of items to skip from the start of the list. Use with limit to paginate through results.	[optional] [default to 0]

Return type¶

TransformationImagePage

Authorization¶

Access-token, Genestack-API-Token

HTTP request headers¶

Content-Type: Not defined
Accept: application/json, application/problem+json

HTTP response details¶

Status code	Description	Response headers
200	The request was successful. The returned value is a page of transformation images.	-
0	Error	-

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