FilesIntegrationAsCuratorApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetFilesByStudyAsCurator | GET /api/v1/as-curator/integration/link/files/by/study/{id} | Retrieve file's metadata by study ID |
GetFilesByStudyAsCurator¶
array[object] GetFilesByStudyAsCurator(id, include_contents = FALSE)
Retrieve file's metadata by study ID
Example¶
library(odmApi)
# Retrieve file's metadata by study ID
#
# prepare function argument(s)
var_id <- "id_example" # character | Unique identifier (accession) of the object.
var_include_contents <- FALSE # character | Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response. (Optional)
api_instance <- FilesIntegrationAsCuratorApi$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$GetFilesByStudyAsCurator(var_id, include_contents = var_include_contentsdata_file = "result.txt")
result <- api_instance$GetFilesByStudyAsCurator(var_id, include_contents = var_include_contents)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | character | Unique identifier (accession) of the object. | |
| include_contents | character | Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response. | [optional] [default to FALSE] |
Return type¶
array[object]
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: application/json, text/tab-separated-values
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | The request was successful. The returned value is a list of objects. | - |
| 400 | Invalid data in the request. See the error message for details. | - |
| 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). | - |
| 404 | Object with provided accession could not be found in ODM. | - |
| 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. | - |