odm_api.TransformationConfigurationsApi¶

All URIs are relative to http://localhost

Method	HTTP request	Description
delete_api_v1_transformations_configurations_by_id	DELETE /api/v1/transformations/configurations/{id}	Delete an existing transformation configuration.
get_api_v1_transformations_configurations_by_id	GET /api/v1/transformations/configurations/{id}	Get details of a specific transformation configuration.
list_api_v1_transformations_configurations	GET /api/v1/transformations/configurations	List available transformation configurations.
post_api_v1_transformations_configurations	POST /api/v1/transformations/configurations	Create a new transformation configuration.
put_api_v1_transformations_configurations_by_id	PUT /api/v1/transformations/configurations/{id}	Update an existing transformation configuration.

delete_api_v1_transformations_configurations_by_id¶

delete_api_v1_transformations_configurations_by_id(id)

Delete an existing transformation configuration.

Example¶

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

import odm_api
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.TransformationConfigurationsApi(api_client)
    id = 56 # int | 

    try:
        # Delete an existing transformation configuration.
        api_instance.delete_api_v1_transformations_configurations_by_id(id)
    except Exception as e:
        print("Exception when calling TransformationConfigurationsApi->delete_api_v1_transformations_configurations_by_id: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	int

Return type¶

void (empty response body)

Authorization¶

Access-token, Genestack-API-Token

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
204	No Content	-
0	Error	-

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

get_api_v1_transformations_configurations_by_id¶

TransformationConfigurationFields get_api_v1_transformations_configurations_by_id(id)

Get details of a specific transformation configuration.

Example¶

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

import odm_api
from odm_api.models.transformation_configuration_fields import TransformationConfigurationFields
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.TransformationConfigurationsApi(api_client)
    id = 56 # int | 

    try:
        # Get details of a specific transformation configuration.
        api_response = api_instance.get_api_v1_transformations_configurations_by_id(id)
        print("The response of TransformationConfigurationsApi->get_api_v1_transformations_configurations_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationConfigurationsApi->get_api_v1_transformations_configurations_by_id: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	int

Return type¶

TransformationConfigurationFields

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]

list_api_v1_transformations_configurations¶

List[TransformationConfiguration] list_api_v1_transformations_configurations()

List available transformation configurations.

Example¶

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

import odm_api
from odm_api.models.transformation_configuration import TransformationConfiguration
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.TransformationConfigurationsApi(api_client)

    try:
        # List available transformation configurations.
        api_response = api_instance.list_api_v1_transformations_configurations()
        print("The response of TransformationConfigurationsApi->list_api_v1_transformations_configurations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationConfigurationsApi->list_api_v1_transformations_configurations: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

List[TransformationConfiguration]

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]

post_api_v1_transformations_configurations¶

TransformationConfigurationId post_api_v1_transformations_configurations(transformation_configuration_fields)

Create a new transformation configuration.

Example¶

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

import odm_api
from odm_api.models.transformation_configuration_fields import TransformationConfigurationFields
from odm_api.models.transformation_configuration_id import TransformationConfigurationId
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.TransformationConfigurationsApi(api_client)
    transformation_configuration_fields = odm_api.TransformationConfigurationFields() # TransformationConfigurationFields | 

    try:
        # Create a new transformation configuration.
        api_response = api_instance.post_api_v1_transformations_configurations(transformation_configuration_fields)
        print("The response of TransformationConfigurationsApi->post_api_v1_transformations_configurations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationConfigurationsApi->post_api_v1_transformations_configurations: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
transformation_configuration_fields	TransformationConfigurationFields

Return type¶

TransformationConfigurationId

Authorization¶

Access-token, Genestack-API-Token

HTTP request headers¶

Content-Type: application/json
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]

put_api_v1_transformations_configurations_by_id¶

put_api_v1_transformations_configurations_by_id(id, transformation_configuration_fields)

Update an existing transformation configuration.

Example¶

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

import odm_api
from odm_api.models.transformation_configuration_fields import TransformationConfigurationFields
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.TransformationConfigurationsApi(api_client)
    id = 56 # int | 
    transformation_configuration_fields = odm_api.TransformationConfigurationFields() # TransformationConfigurationFields | 

    try:
        # Update an existing transformation configuration.
        api_instance.put_api_v1_transformations_configurations_by_id(id, transformation_configuration_fields)
    except Exception as e:
        print("Exception when calling TransformationConfigurationsApi->put_api_v1_transformations_configurations_by_id: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	int
transformation_configuration_fields	TransformationConfigurationFields

Return type¶

void (empty response body)

Authorization¶

Access-token, Genestack-API-Token

HTTP request headers¶

Content-Type: application/json
Accept: application/problem+json

HTTP response details¶

Status code	Description	Response headers
204	No Content	-
0	Error	-

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