odm_api.TransformationJobsApi¶

All URIs are relative to http://localhost

Method	HTTP request	Description
delete_api_v1_transformations_jobs_by_id	DELETE /api/v1/transformations/jobs/{id}	Delete a transformation job by ID.
get_api_v1_transformations_jobs_by_id	GET /api/v1/transformations/jobs/{id}	Get details of a specific transformation job.
list_api_v1_transformations_jobs	GET /api/v1/transformations/jobs	List submitted transformation jobs.
post_api_v1_transformations_jobs	POST /api/v1/transformations/jobs	Submit a new transformation job with optional configuration and version.
post_api_v1_transformations_jobs_by_id_logs	POST /api/v1/transformations/jobs/{id}/logs	Retrieve logs for a transformation job.
post_api_v1_transformations_jobs_by_id_stop	POST /api/v1/transformations/jobs/{id}/stop	Stop a running transformation job.

delete_api_v1_transformations_jobs_by_id¶

delete_api_v1_transformations_jobs_by_id(id)

Delete a transformation job by ID.

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

    try:
        # Delete a transformation job by ID.
        api_instance.delete_api_v1_transformations_jobs_by_id(id)
    except Exception as e:
        print("Exception when calling TransformationJobsApi->delete_api_v1_transformations_jobs_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_jobs_by_id¶

TransformationJobFields get_api_v1_transformations_jobs_by_id(id)

Get details of a specific transformation job.

Example¶

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

import odm_api
from odm_api.models.transformation_job_fields import TransformationJobFields
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.TransformationJobsApi(api_client)
    id = 56 # int | 

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

Parameters¶

Name	Type	Description	Notes
id	int

Return type¶

TransformationJobFields

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_jobs¶

List[TransformationJob] list_api_v1_transformations_jobs()

List submitted transformation jobs.

Example¶

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

import odm_api
from odm_api.models.transformation_job import TransformationJob
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.TransformationJobsApi(api_client)

    try:
        # List submitted transformation jobs.
        api_response = api_instance.list_api_v1_transformations_jobs()
        print("The response of TransformationJobsApi->list_api_v1_transformations_jobs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationJobsApi->list_api_v1_transformations_jobs: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

List[TransformationJob]

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_jobs¶

TransformationJobId post_api_v1_transformations_jobs(transformation_job_create_fields)

Submit a new transformation job with optional configuration and version.

Example¶

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

import odm_api
from odm_api.models.transformation_job_create_fields import TransformationJobCreateFields
from odm_api.models.transformation_job_id import TransformationJobId
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.TransformationJobsApi(api_client)
    transformation_job_create_fields = odm_api.TransformationJobCreateFields() # TransformationJobCreateFields | 

    try:
        # Submit a new transformation job with optional configuration and version.
        api_response = api_instance.post_api_v1_transformations_jobs(transformation_job_create_fields)
        print("The response of TransformationJobsApi->post_api_v1_transformations_jobs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationJobsApi->post_api_v1_transformations_jobs: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
transformation_job_create_fields	TransformationJobCreateFields

Return type¶

TransformationJobId

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]

post_api_v1_transformations_jobs_by_id_logs¶

bytearray post_api_v1_transformations_jobs_by_id_logs(id, logs_payload)

Retrieve logs for a transformation job.

Example¶

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

import odm_api
from odm_api.models.logs_payload import LogsPayload
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.TransformationJobsApi(api_client)
    id = 56 # int | 
    logs_payload = odm_api.LogsPayload() # LogsPayload | 

    try:
        # Retrieve logs for a transformation job.
        api_response = api_instance.post_api_v1_transformations_jobs_by_id_logs(id, logs_payload)
        print("The response of TransformationJobsApi->post_api_v1_transformations_jobs_by_id_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationJobsApi->post_api_v1_transformations_jobs_by_id_logs: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	int
logs_payload	LogsPayload

Return type¶

bytearray

Authorization¶

Access-token, Genestack-API-Token

HTTP request headers¶

Content-Type: application/json
Accept: application/octet-stream, 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_jobs_by_id_stop¶

StopResponse post_api_v1_transformations_jobs_by_id_stop(id, stop_payload)

Stop a running transformation job.

Example¶

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

import odm_api
from odm_api.models.stop_payload import StopPayload
from odm_api.models.stop_response import StopResponse
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.TransformationJobsApi(api_client)
    id = 56 # int | 
    stop_payload = odm_api.StopPayload() # StopPayload | 

    try:
        # Stop a running transformation job.
        api_response = api_instance.post_api_v1_transformations_jobs_by_id_stop(id, stop_payload)
        print("The response of TransformationJobsApi->post_api_v1_transformations_jobs_by_id_stop:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransformationJobsApi->post_api_v1_transformations_jobs_by_id_stop: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
id	int
stop_payload	StopPayload

Return type¶

StopResponse

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]