JobOperationsApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| Info | GET /api/v1/jobs/{jobExecId}/info | get information about one particular job execution |
| Output | GET /api/v1/jobs/{jobExecId}/output | retrieve job output (result) |
| Restart | PUT /api/v1/jobs/{jobExecId}/restart | restart stopped (failed) job |
| Stop | PUT /api/v1/jobs/{jobExecId}/stop | stop running job |
Info¶
Info Info(job_exec_id)
get information about one particular job execution
Example¶
library(odmApi)
# get information about one particular job execution
#
# prepare function argument(s)
var_job_exec_id <- 56 # integer |
api_instance <- JobOperationsApi$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$Info(var_job_exec_iddata_file = "result.txt")
result <- api_instance$Info(var_job_exec_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| job_exec_id | integer |
Return type¶
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |
Output¶
Output Output(job_exec_id)
retrieve job output (result)
Example¶
library(odmApi)
# retrieve job output (result)
#
# prepare function argument(s)
var_job_exec_id <- 56 # integer |
api_instance <- JobOperationsApi$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$Output(var_job_exec_iddata_file = "result.txt")
result <- api_instance$Output(var_job_exec_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| job_exec_id | integer |
Return type¶
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |
Restart¶
Info Restart(job_exec_id)
restart stopped (failed) job
Example¶
library(odmApi)
# restart stopped (failed) job
#
# prepare function argument(s)
var_job_exec_id <- 56 # integer |
api_instance <- JobOperationsApi$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$Restart(var_job_exec_iddata_file = "result.txt")
result <- api_instance$Restart(var_job_exec_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| job_exec_id | integer |
Return type¶
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |
Stop¶
Info Stop(job_exec_id)
stop running job
Example¶
library(odmApi)
# stop running job
#
# prepare function argument(s)
var_job_exec_id <- 56 # integer |
api_instance <- JobOperationsApi$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$Stop(var_job_exec_iddata_file = "result.txt")
result <- api_instance$Stop(var_job_exec_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| job_exec_id | integer |
Return type¶
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |