CellIntegrationAsCuratorApi¶
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| CreateCellGroupLibraryGroupLinkAsCurator | POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/library/group/{targetId} | Create links between cells and libraries |
| CreateCellGroupPreparationGroupLinkAsCurator | POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/preparation/group/{targetId} | Create links between cells and preparations |
| CreateCellGroupSampleGroupLinkAsCurator | POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/sample/group/{targetId} | Create links between cells and samples |
CreateCellGroupLibraryGroupLinkAsCurator¶
CreateCellGroupLibraryGroupLinkAsCurator(source_id, target_id)
Create links between cells and libraries
Create links between cells and libraries. Cell objects of the same group can be linked to library objects from multiple library groups, but only within the same study.
Example¶
library(odmApi)
# Create links between cells and libraries
#
# prepare function argument(s)
var_source_id <- "source_id_example" # character | The ID (accession) of the cell group object
var_target_id <- "target_id_example" # character | The ID (accession) of the library group object
api_instance <- CellIntegrationAsCuratorApi$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$CreateCellGroupLibraryGroupLinkAsCurator(var_source_id, var_target_id)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| source_id | character | The ID (accession) of the cell group object | |
| target_id | character | The ID (accession) of the library group object |
Return type¶
void (empty response body)
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: Not defined
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | Cell objects have been partially linked to libraries. | - |
| 204 | Cell objects have been fully linked to libraries. | - |
| 400 | Sample group, cell group or libraries to the link were not found. | - |
| 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. | - |
CreateCellGroupPreparationGroupLinkAsCurator¶
CreateCellGroupPreparationGroupLinkAsCurator(source_id, target_id)
Create links between cells and preparations
Create links between cells and preparations. Cell objects of the same group can be linked to preparation objects from multiple preparation groups, but only within the same study.
Example¶
library(odmApi)
# Create links between cells and preparations
#
# prepare function argument(s)
var_source_id <- "source_id_example" # character | The ID (accession) of the cell group object
var_target_id <- "target_id_example" # character | The ID (accession) of the preparation group object
api_instance <- CellIntegrationAsCuratorApi$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$CreateCellGroupPreparationGroupLinkAsCurator(var_source_id, var_target_id)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| source_id | character | The ID (accession) of the cell group object | |
| target_id | character | The ID (accession) of the preparation group object |
Return type¶
void (empty response body)
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: Not defined
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | Cell objects have been partially linked to preparations. | - |
| 204 | Cell objects have been fully linked to preparations. | - |
| 400 | Sample group, cell group or preparations to the link were not found. | - |
| 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. | - |
CreateCellGroupSampleGroupLinkAsCurator¶
CreateCellGroupSampleGroupLinkAsCurator(source_id, target_id)
Create links between cells and samples
Create links between cells and samples. Cell objects of the same group can be linked to sample objects from multiple sample groups, but only within the same study.
Example¶
library(odmApi)
# Create links between cells and samples
#
# prepare function argument(s)
var_source_id <- "source_id_example" # character | The ID (accession) of the cell group object
var_target_id <- "target_id_example" # character | The ID (accession) of the sample group object
api_instance <- CellIntegrationAsCuratorApi$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$CreateCellGroupSampleGroupLinkAsCurator(var_source_id, var_target_id)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| source_id | character | The ID (accession) of the cell group object | |
| target_id | character | The ID (accession) of the sample group object |
Return type¶
void (empty response body)
Authorization¶
Access-token, Genestack-API-Token
HTTP request headers¶
- Content-Type: Not defined
- Accept: Not defined
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | Cell objects have been partially linked to samples. | - |
| 204 | Cell objects have been fully linked to samples. | - |
| 400 | Sample group, cell group or samples to the link were not found. | - |
| 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. | - |