TransformationImagesApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetApiV1TransformationsImages | GET /api/v1/transformations/images | List transformation images |
GetApiV1TransformationsImages¶
TransformationImagePage GetApiV1TransformationsImages(limit = 100, offset = 0)
List transformation images
Returns a paginated list of the transformation images available to run as jobs. Each entry includes the accepted input formats, the produced output formats, and default compute requirements (memory and volume size). Use the limit and offset query parameters to paginate through the results.
Example¶
library(odmApi)
# List transformation images
#
# 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)
api_instance <- TransformationImagesApi$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$GetApiV1TransformationsImages(limit = var_limit, offset = var_offsetdata_file = "result.txt")
result <- api_instance$GetApiV1TransformationsImages(limit = var_limit, offset = var_offset)
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] |
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 a page of transformation images. | - |
| 0 | Error | - |