TransformationJobsApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| DeleteApiV1TransformationsJobsById | DELETE /api/v1/transformations/jobs/{id} | Delete a transformation job by ID. |
| GetApiV1TransformationsJobsById | GET /api/v1/transformations/jobs/{id} | Get details of a specific transformation job. |
| ListApiV1TransformationsJobs | GET /api/v1/transformations/jobs | List submitted transformation jobs. |
| PostApiV1TransformationsJobs | POST /api/v1/transformations/jobs | Submit a new transformation job with optional configuration and version. |
| PostApiV1TransformationsJobsByIdLogs | POST /api/v1/transformations/jobs/{id}/logs | Retrieve logs for a transformation job. |
| PostApiV1TransformationsJobsByIdStop | POST /api/v1/transformations/jobs/{id}/stop | Stop a running transformation job. |
DeleteApiV1TransformationsJobsById¶
DeleteApiV1TransformationsJobsById(id)
Delete a transformation job by ID.
Example¶
library(odmApi)
# Delete a transformation job by ID.
#
# prepare function argument(s)
var_id <- 56 # integer |
api_instance <- TransformationJobsApi$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$DeleteApiV1TransformationsJobsById(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 | - |
GetApiV1TransformationsJobsById¶
TransformationJobFields GetApiV1TransformationsJobsById(id)
Get details of a specific transformation job.
Example¶
library(odmApi)
# Get details of a specific transformation job.
#
# prepare function argument(s)
var_id <- 56 # integer |
api_instance <- TransformationJobsApi$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$GetApiV1TransformationsJobsById(var_iddata_file = "result.txt")
result <- api_instance$GetApiV1TransformationsJobsById(var_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer |
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 | OK | - |
| 0 | Error | - |
ListApiV1TransformationsJobs¶
array[TransformationJob] ListApiV1TransformationsJobs()
List submitted transformation jobs.
Example¶
library(odmApi)
# List submitted transformation jobs.
#
api_instance <- TransformationJobsApi$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$ListApiV1TransformationsJobs(data_file = "result.txt")
result <- api_instance$ListApiV1TransformationsJobs()
dput(result)
Parameters¶
This endpoint does not need any parameter.
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 | OK | - |
| 0 | Error | - |
PostApiV1TransformationsJobs¶
TransformationJobId PostApiV1TransformationsJobs(transformation_job_create_fields)
Submit a new transformation job with optional configuration and version.
Example¶
library(odmApi)
# Submit a new transformation job with optional configuration and version.
#
# prepare function argument(s)
var_transformation_job_create_fields <- TransformationJobCreateFields$new(TransformationImageReference$new("name_example", "version_example"), c("input_accessions_example"), "$schema_example", 123, "dry_run_example", "memory_size_example", "volume_size_example") # TransformationJobCreateFields |
api_instance <- TransformationJobsApi$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$PostApiV1TransformationsJobs(var_transformation_job_create_fieldsdata_file = "result.txt")
result <- api_instance$PostApiV1TransformationsJobs(var_transformation_job_create_fields)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| transformation_job_create_fields | TransformationJobCreateFields |
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 | - |
PostApiV1TransformationsJobsByIdLogs¶
data.frame PostApiV1TransformationsJobsByIdLogs(id, logs_payload)
Retrieve logs for a transformation job.
Example¶
library(odmApi)
# Retrieve logs for a transformation job.
#
# prepare function argument(s)
var_id <- 56 # integer |
var_logs_payload <- LogsPayload$new("$schema_example", 123) # LogsPayload |
api_instance <- TransformationJobsApi$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$PostApiV1TransformationsJobsByIdLogs(var_id, var_logs_payloaddata_file = "result.txt")
result <- api_instance$PostApiV1TransformationsJobsByIdLogs(var_id, var_logs_payload)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | ||
| logs_payload | LogsPayload |
Return type¶
data.frame
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 | - |
PostApiV1TransformationsJobsByIdStop¶
StopResponse PostApiV1TransformationsJobsByIdStop(id, stop_payload)
Stop a running transformation job.
Example¶
library(odmApi)
# Stop a running transformation job.
#
# prepare function argument(s)
var_id <- 56 # integer |
var_stop_payload <- StopPayload$new("$schema_example", TransformationJobStopSignal$new()) # StopPayload |
api_instance <- TransformationJobsApi$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$PostApiV1TransformationsJobsByIdStop(var_id, var_stop_payloaddata_file = "result.txt")
result <- api_instance$PostApiV1TransformationsJobsByIdStop(var_id, var_stop_payload)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | ||
| stop_payload | StopPayload |
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 | - |