TransformationConfigurationsApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetApiV1TransformationsConfigurations | GET /api/v1/transformations/configurations | List transformation configurations |
| GetApiV1TransformationsConfigurationsById | GET /api/v1/transformations/configurations/{id} | Get a transformation configuration by id |
| GetApiV1TransformationsConfigurationsByIdVersions | GET /api/v1/transformations/configurations/{id}/versions | List all versions of a transformation configuration |
| GetApiV1TransformationsConfigurationsByIdVersionsByVersion | GET /api/v1/transformations/configurations/{id}/versions/{version} | Get a specific version of a transformation configuration |
| PostApiV1TransformationsConfigurations | POST /api/v1/transformations/configurations | Create a new transformation configuration |
| PostApiV1TransformationsConfigurationsByIdArchive | POST /api/v1/transformations/configurations/{id}/archive | Archive a transformation configuration |
| PutApiV1TransformationsConfigurationsById | PUT /api/v1/transformations/configurations/{id} | Create a new version of a transformation configuration |
GetApiV1TransformationsConfigurations¶
TransformationConfigurationPage GetApiV1TransformationsConfigurations(limit = 100, offset = 0, include_archived = var.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¶
library(odmApi)
# List transformation configurations
#
# prepare function argument(s)
var_limit <- 100 # integer | Maximum number of items to return per page. (Optional)
var_offset <- 0 # integer | Number of items to skip from the start of the list. Use with limit to paginate through results. (Optional)
var_include_archived <- "include_archived_example" # character | If `true`, archived configurations are included in the results. Defaults to `false`. (Optional)
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$GetApiV1TransformationsConfigurations(limit = var_limit, offset = var_offset, include_archived = var_include_archiveddata_file = "result.txt")
result <- api_instance$GetApiV1TransformationsConfigurations(limit = var_limit, offset = var_offset, include_archived = var_include_archived)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | integer | Maximum number of items to return per page. | [optional] [default to 100] |
| offset | integer | Number of items to skip from the start of the list. Use with limit to paginate through results. | [optional] [default to 0] |
| include_archived | character | 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 | - |
GetApiV1TransformationsConfigurationsById¶
TransformationConfiguration GetApiV1TransformationsConfigurationsById(id)
Get a transformation configuration by id
Returns the details of the latest version of a single transformation configuration, identified by its id.
Example¶
library(odmApi)
# Get a transformation configuration by id
#
# prepare function argument(s)
var_id <- 56 # integer | Unique numeric identifier of the transformation configuration.
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$GetApiV1TransformationsConfigurationsById(var_iddata_file = "result.txt")
result <- api_instance$GetApiV1TransformationsConfigurationsById(var_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | 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 | - |
GetApiV1TransformationsConfigurationsByIdVersions¶
TransformationConfigurationPage GetApiV1TransformationsConfigurationsByIdVersions(id, limit = 100, offset = 0)
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¶
library(odmApi)
# List all versions of a transformation configuration
#
# prepare function argument(s)
var_id <- 56 # integer | Unique numeric identifier of the transformation configuration.
var_limit <- 100 # integer | Maximum number of items to return per page. (Optional)
var_offset <- 0 # integer | Number of items to skip from the start of the list. Use with limit to paginate through results. (Optional)
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$GetApiV1TransformationsConfigurationsByIdVersions(var_id, limit = var_limit, offset = var_offsetdata_file = "result.txt")
result <- api_instance$GetApiV1TransformationsConfigurationsByIdVersions(var_id, limit = var_limit, offset = var_offset)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | Unique numeric identifier of the transformation configuration. | |
| limit | integer | Maximum number of items to return per page. | [optional] [default to 100] |
| offset | integer | 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 | - |
GetApiV1TransformationsConfigurationsByIdVersionsByVersion¶
TransformationConfiguration GetApiV1TransformationsConfigurationsByIdVersionsByVersion(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¶
library(odmApi)
# Get a specific version of a transformation configuration
#
# prepare function argument(s)
var_id <- 56 # integer | Unique numeric identifier of the transformation configuration.
var_version <- 56 # integer | Version number of the transformation configuration. When omitted, the latest version is used.
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$GetApiV1TransformationsConfigurationsByIdVersionsByVersion(var_id, var_versiondata_file = "result.txt")
result <- api_instance$GetApiV1TransformationsConfigurationsByIdVersionsByVersion(var_id, var_version)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | Unique numeric identifier of the transformation configuration. | |
| version | integer | 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 | - |
PostApiV1TransformationsConfigurations¶
TransformationConfigurationReference PostApiV1TransformationsConfigurations(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¶
library(odmApi)
# Create a new transformation configuration
#
# prepare function argument(s)
var_transformation_configuration_create_fields <- TransformationConfigurationCreateFields$new(c(key = TODO), "description_example", "name_example") # TransformationConfigurationCreateFields |
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$PostApiV1TransformationsConfigurations(var_transformation_configuration_create_fieldsdata_file = "result.txt")
result <- api_instance$PostApiV1TransformationsConfigurations(var_transformation_configuration_create_fields)
dput(result)
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 | - |
PostApiV1TransformationsConfigurationsByIdArchive¶
PostApiV1TransformationsConfigurationsByIdArchive(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¶
library(odmApi)
# Archive a transformation configuration
#
# prepare function argument(s)
var_id <- 56 # integer | Unique numeric identifier of the transformation configuration.
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
api_instance$PostApiV1TransformationsConfigurationsByIdArchive(var_id)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | 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 | - |
PutApiV1TransformationsConfigurationsById¶
TransformationConfigurationReference PutApiV1TransformationsConfigurationsById(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¶
library(odmApi)
# Create a new version of a transformation configuration
#
# prepare function argument(s)
var_id <- 56 # integer | Unique numeric identifier of the transformation configuration.
var_transformation_configuration_create_fields <- TransformationConfigurationCreateFields$new(c(key = TODO), "description_example", "name_example") # TransformationConfigurationCreateFields |
api_instance <- TransformationConfigurationsApi$new()
# Configure API key authorization: Access-token
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: Genestack-API-Token
# api_instance$api_client$api_keys["Genestack-API-Token"] <- Sys.getenv("API_KEY")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$PutApiV1TransformationsConfigurationsById(var_id, var_transformation_configuration_create_fieldsdata_file = "result.txt")
result <- api_instance$PutApiV1TransformationsConfigurationsById(var_id, var_transformation_configuration_create_fields)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | 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 | - |