CellsAsUserApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetCellByIdAsUser | GET /api/v1/as-user/cells/{id} | Retrieve a cell by ID |
| GetCellsByGroupAsUser | GET /api/v1/as-user/cells/by/group/{id} | Retrieve cells from a given group |
GetCellByIdAsUser¶
object GetCellByIdAsUser(id)
Retrieve a cell by ID
Example¶
library(odmApi)
# Retrieve a cell by ID
#
# prepare function argument(s)
var_id <- "id_example" # character | Unique cell identifier. Consists of a cell group accession and a cell barcode, separated by a hyphen, e.g. `GSF123456-AAACCTGAGCGCTCCA-1`.
api_instance <- CellsAsUserApi$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$GetCellByIdAsUser(var_iddata_file = "result.txt")
result <- api_instance$GetCellByIdAsUser(var_id)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | character | Unique cell identifier. Consists of a cell group accession and a cell barcode, separated by a hyphen, e.g. `GSF123456-AAACCTGAGCGCTCCA-1`. |
Return type¶
object
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 | The request was successful. The returned value is the object. | - |
| 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 ID 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. | - |
GetCellsByGroupAsUser¶
CellListResponse GetCellsByGroupAsUser(id, page_limit = var.page_limit, cursor = var.cursor)
Retrieve cells from a given group
Paging For performance reasons this endpoint returns results in \"pages\" of limited size together with a cursor tag. To retrieve the next page of results please supply this cursor tag to resume the query from your previous result and get the next page. If there are no more results you will just retrieve an empty result.¶
Example¶
library(odmApi)
# Retrieve cells from a given group
#
# prepare function argument(s)
var_id <- "id_example" # character | Unique identifier (accession) of the cell group.
var_page_limit <- 56 # integer | Maximum number of results to return per page (see Paging above). This value must be between 0 and 10000 (inclusive). The default is 2000. (Optional)
var_cursor <- "cursor_example" # character | The page tag to resume results from (see Paging above). Cell ID is currently used as a cursor. (Optional)
api_instance <- CellsAsUserApi$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$GetCellsByGroupAsUser(var_id, page_limit = var_page_limit, cursor = var_cursordata_file = "result.txt")
result <- api_instance$GetCellsByGroupAsUser(var_id, page_limit = var_page_limit, cursor = var_cursor)
dput(result)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| id | character | Unique identifier (accession) of the cell group. | |
| page_limit | integer | Maximum number of results to return per page (see Paging above). This value must be between 0 and 10000 (inclusive). The default is 2000. | [optional] |
| cursor | character | The page tag to resume results from (see Paging above). Cell ID is currently used as a cursor. | [optional] |
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 | The request was successful. The returned value is a list of objects. | - |
| 400 | Cell data cannot be retrieved. | - |
| 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 | No object exists with the given ID. | - |
| 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. | - |