odm_api.TransformationImagesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
list_api_v1_transformations_images	GET /api/v1/transformations/images	List available transformation images with their metadata.

list_api_v1_transformations_images

List[TransformationImage] list_api_v1_transformations_images()

List available transformation images with their metadata.

Example

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

import odm_api
from odm_api.models.transformation_image import TransformationImage
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)

    try:
        # List available transformation images with their metadata.
        api_response = api_instance.list_api_v1_transformations_images()
        print("The response of TransformationImagesApi->list_api_v1_transformations_images:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationImagesApi->list_api_v1_transformations_images: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[TransformationImage]

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	OK	-
0	Error	-

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