odm_api.TransformationConfigurationsApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| get_api_v1_transformations_configurations | GET /api/v1/transformations/configurations | List transformation configurations |
| get_api_v1_transformations_configurations_by_id | GET /api/v1/transformations/configurations/{id} | Get a transformation configuration by id |
| get_api_v1_transformations_configurations_by_id_versions | GET /api/v1/transformations/configurations/{id}/versions | List all versions of a transformation configuration |
| get_api_v1_transformations_configurations_by_id_versions_by_version | GET /api/v1/transformations/configurations/{id}/versions/{version} | Get a specific version of a transformation configuration |
| post_api_v1_transformations_configurations | POST /api/v1/transformations/configurations | Create a new transformation configuration |
| post_api_v1_transformations_configurations_by_id_archive | POST /api/v1/transformations/configurations/{id}/archive | Archive a transformation configuration |
| put_api_v1_transformations_configurations_by_id | PUT /api/v1/transformations/configurations/{id} | Create a new version of a transformation configuration |
get_api_v1_transformations_configurations¶
TransformationConfigurationPage get_api_v1_transformations_configurations(limit=limit, offset=offset, include_archived=include_archived)
List transformation configurations
Returns a paginated list of transformation configurations. Only the latest version of each configuration is included. Use limit and offset to paginate through results.
Example¶
- Api Key Authentication (Access-token):
- Api Key Authentication (Genestack-API-Token):
import odm_api
from odm_api.models.transformation_configuration_page import TransformationConfigurationPage
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)
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)
include_archived = True # bool | If `true`, archived configurations are included in the results. Defaults to `false`. (optional)
try:
# List transformation configurations
api_response = api_instance.get_api_v1_transformations_configurations(limit=limit, offset=offset, include_archived=include_archived)
print("The response of TransformationConfigurationsApi->get_api_v1_transformations_configurations:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TransformationConfigurationsApi->get_api_v1_transformations_configurations: %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] |
| include_archived | bool | If `true`, archived configurations are included in the results. Defaults to `false`. | [optional] |
Return type¶
TransformationConfigurationPage
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 configurations. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_api_v1_transformations_configurations_by_id¶
TransformationConfiguration get_api_v1_transformations_configurations_by_id(id)
Get a transformation configuration by id
Returns the details of the latest version of a single transformation configuration, identified by its id.
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)
id = 56 # int | Unique numeric identifier of the transformation configuration.
try:
# Get a transformation configuration by id
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 | Unique numeric identifier of the transformation configuration. |
Return type¶
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 the transformation configuration. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_api_v1_transformations_configurations_by_id_versions¶
TransformationConfigurationPage get_api_v1_transformations_configurations_by_id_versions(id, limit=limit, offset=offset)
List all versions of a transformation configuration
Returns a paginated list of all available versions of a transformation configuration, identified by its id. The list is ordered by version number. 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_configuration_page import TransformationConfigurationPage
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 | Unique numeric identifier of the transformation configuration.
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 all versions of a transformation configuration
api_response = api_instance.get_api_v1_transformations_configurations_by_id_versions(id, limit=limit, offset=offset)
print("The response of TransformationConfigurationsApi->get_api_v1_transformations_configurations_by_id_versions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TransformationConfigurationsApi->get_api_v1_transformations_configurations_by_id_versions: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Unique numeric identifier of the transformation configuration. | |
| 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¶
TransformationConfigurationPage
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 configuration versions. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_api_v1_transformations_configurations_by_id_versions_by_version¶
TransformationConfiguration get_api_v1_transformations_configurations_by_id_versions_by_version(id, version)
Get a specific version of a transformation configuration
Returns the details of a specified version of a transformation configuration, identified by its id and version number.
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)
id = 56 # int | Unique numeric identifier of the transformation configuration.
version = 56 # int | Version number of the transformation configuration. When omitted, the latest version is used.
try:
# Get a specific version of a transformation configuration
api_response = api_instance.get_api_v1_transformations_configurations_by_id_versions_by_version(id, version)
print("The response of TransformationConfigurationsApi->get_api_v1_transformations_configurations_by_id_versions_by_version:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TransformationConfigurationsApi->get_api_v1_transformations_configurations_by_id_versions_by_version: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Unique numeric identifier of the transformation configuration. | |
| version | int | Version number of the transformation configuration. When omitted, the latest version is used. |
Return type¶
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 the requested configuration version. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
post_api_v1_transformations_configurations¶
TransformationConfigurationReference post_api_v1_transformations_configurations(transformation_configuration_create_fields)
Create a new transformation configuration
Creates a new transformation configuration at version 1. The required data field provides transformation image-specific settings. Returns a reference id and version for the newly created configuration.
Example¶
- Api Key Authentication (Access-token):
- Api Key Authentication (Genestack-API-Token):
import odm_api
from odm_api.models.transformation_configuration_create_fields import TransformationConfigurationCreateFields
from odm_api.models.transformation_configuration_reference import TransformationConfigurationReference
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_create_fields = odm_api.TransformationConfigurationCreateFields() # TransformationConfigurationCreateFields |
try:
# Create a new transformation configuration
api_response = api_instance.post_api_v1_transformations_configurations(transformation_configuration_create_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_create_fields | TransformationConfigurationCreateFields |
Return type¶
TransformationConfigurationReference
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 | The configuration was created successfully. The returned value references the new configuration. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
post_api_v1_transformations_configurations_by_id_archive¶
post_api_v1_transformations_configurations_by_id_archive(id)
Archive a transformation configuration
Archives an existing transformation configuration, identified by its id, including all of its versions. Archived configurations are excluded from the default listing but remain accessible by id and can still be referenced when submitting new transformation jobs. Archived configurations cannot be updated. This operation cannot be undone.
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 | Unique numeric identifier of the transformation configuration.
try:
# Archive a transformation configuration
api_instance.post_api_v1_transformations_configurations_by_id_archive(id)
except Exception as e:
print("Exception when calling TransformationConfigurationsApi->post_api_v1_transformations_configurations_by_id_archive: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Unique numeric identifier of the transformation configuration. |
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 | The transformation configuration and all of its versions were archived successfully. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
put_api_v1_transformations_configurations_by_id¶
TransformationConfigurationReference put_api_v1_transformations_configurations_by_id(id, transformation_configuration_create_fields)
Create a new version of a transformation configuration
Creates a new version of an existing transformation configuration, identified by its id. The required data field provides transformation image-specific settings. Returns a reference id and version for the newly created version. Previous versions are preserved and remain retrievable.
Example¶
- Api Key Authentication (Access-token):
- Api Key Authentication (Genestack-API-Token):
import odm_api
from odm_api.models.transformation_configuration_create_fields import TransformationConfigurationCreateFields
from odm_api.models.transformation_configuration_reference import TransformationConfigurationReference
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 | Unique numeric identifier of the transformation configuration.
transformation_configuration_create_fields = odm_api.TransformationConfigurationCreateFields() # TransformationConfigurationCreateFields |
try:
# Create a new version of a transformation configuration
api_response = api_instance.put_api_v1_transformations_configurations_by_id(id, transformation_configuration_create_fields)
print("The response of TransformationConfigurationsApi->put_api_v1_transformations_configurations_by_id:\n")
pprint(api_response)
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 | Unique numeric identifier of the transformation configuration. | |
| transformation_configuration_create_fields | TransformationConfigurationCreateFields |
Return type¶
TransformationConfigurationReference
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 | A new version of the configuration was created successfully. The returned value references the new version. | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]