ValidationSummaryAsCuratorApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetStudyValidationSummary | GET /api/v1/as-curator/integration/studies/{id}/validation-summary | Retrieve validation summary by querying study ID (accession) |
GetStudyValidationSummary¶
StudyValidationSummary GetStudyValidationSummary(id)
Retrieve validation summary by querying study ID (accession)
Example¶
library(odmApi)
# Retrieve validation summary by querying study ID (accession)
#
# prepare function argument(s)
var_id <- "id_example" # character | Unique identifier (accession) of the object.
api_instance <- ValidationSummaryAsCuratorApi$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$GetStudyValidationSummary(var_iddata_file = "result.txt")
result <- api_instance$GetStudyValidationSummary(var_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | character | Unique identifier (accession) of the object. |
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 | Study validation result. | - |
| 401 | User is not authenticated. Please supply a valid Access Token in the `Authorization` HTTP header (e.g. Authorization: bearer [token]) or Genestack API token in the `Genestack-API-Token` header (this token may be obtained from the Genestack UI Profile page). | - |
| 500 | An internal server error occurred. This indicates an unexpected failure in the Genestack system, please file a bug report to support@genestack.com, including the error details. | - |