TransformationConfigurationsApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| DeleteApiV1TransformationsConfigurationsById | DELETE /api/v1/transformations/configurations/{id} | Delete an existing transformation configuration. |
| GetApiV1TransformationsConfigurationsById | GET /api/v1/transformations/configurations/{id} | Get details of a specific transformation configuration. |
| ListApiV1TransformationsConfigurations | GET /api/v1/transformations/configurations | List available transformation configurations. |
| PostApiV1TransformationsConfigurations | POST /api/v1/transformations/configurations | Create a new transformation configuration. |
| PutApiV1TransformationsConfigurationsById | PUT /api/v1/transformations/configurations/{id} | Update an existing transformation configuration. |
DeleteApiV1TransformationsConfigurationsById¶
DeleteApiV1TransformationsConfigurationsById(id)
Delete an existing transformation configuration.
Example¶
library(odmApi)
# Delete an existing transformation configuration.
#
# prepare function argument(s)
var_id <- 56 # integer |
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$DeleteApiV1TransformationsConfigurationsById(var_id)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer |
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 | - |
GetApiV1TransformationsConfigurationsById¶
TransformationConfigurationFields GetApiV1TransformationsConfigurationsById(id)
Get details of a specific transformation configuration.
Example¶
library(odmApi)
# Get details of a specific transformation configuration.
#
# prepare function argument(s)
var_id <- 56 # integer |
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 |
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 | - |
ListApiV1TransformationsConfigurations¶
array[TransformationConfiguration] ListApiV1TransformationsConfigurations()
List available transformation configurations.
Example¶
library(odmApi)
# List available transformation configurations.
#
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$ListApiV1TransformationsConfigurations(data_file = "result.txt")
result <- api_instance$ListApiV1TransformationsConfigurations()
dput(result)
Parameters¶
This endpoint does not need any parameter.
Return type¶
array[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 | - |
PostApiV1TransformationsConfigurations¶
TransformationConfigurationId PostApiV1TransformationsConfigurations(transformation_configuration_fields)
Create a new transformation configuration.
Example¶
library(odmApi)
# Create a new transformation configuration.
#
# prepare function argument(s)
var_transformation_configuration_fields <- TransformationConfigurationFields$new(c(key = TODO), "$schema_example", "description_example", "name_example") # TransformationConfigurationFields |
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_fieldsdata_file = "result.txt")
result <- api_instance$PostApiV1TransformationsConfigurations(var_transformation_configuration_fields)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| transformation_configuration_fields | TransformationConfigurationFields |
Return type¶
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 | - |
PutApiV1TransformationsConfigurationsById¶
PutApiV1TransformationsConfigurationsById(id, transformation_configuration_fields)
Update an existing transformation configuration.
Example¶
library(odmApi)
# Update an existing transformation configuration.
#
# prepare function argument(s)
var_id <- 56 # integer |
var_transformation_configuration_fields <- TransformationConfigurationFields$new(c(key = TODO), "$schema_example", "description_example", "name_example") # TransformationConfigurationFields |
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$PutApiV1TransformationsConfigurationsById(var_id, var_transformation_configuration_fields)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | ||
| 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 | - |