odm_api.CellIntegrationAsCuratorApi¶

All URIs are relative to http://localhost

Method	HTTP request	Description
create_cell_group_library_group_link_as_curator	POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/library/group/{targetId}	Create links between cells and libraries
create_cell_group_preparation_group_link_as_curator	POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/preparation/group/{targetId}	Create links between cells and preparations
create_cell_group_sample_group_link_as_curator	POST /api/v1/as-curator/integration/link/cell/group/{sourceId}/to/sample/group/{targetId}	Create links between cells and samples

create_cell_group_library_group_link_as_curator¶

create_cell_group_library_group_link_as_curator(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¶

Api Key Authentication (Access-token):
Api Key Authentication (Genestack-API-Token):

import odm_api
from odm_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = odm_api.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Access-token
configuration.api_key['Access-token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Access-token'] = 'Bearer'

# Configure API key authorization: Genestack-API-Token
configuration.api_key['Genestack-API-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Genestack-API-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with odm_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = odm_api.CellIntegrationAsCuratorApi(api_client)
    source_id = 'source_id_example' # str | The ID (accession) of the cell group object
    target_id = 'target_id_example' # str | The ID (accession) of the library group object

    try:
        # Create links between cells and libraries
        api_instance.create_cell_group_library_group_link_as_curator(source_id, target_id)
    except Exception as e:
        print("Exception when calling CellIntegrationAsCuratorApi->create_cell_group_library_group_link_as_curator: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
source_id	str	The ID (accession) of the cell group object
target_id	str	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.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_cell_group_preparation_group_link_as_curator¶

create_cell_group_preparation_group_link_as_curator(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¶

Api Key Authentication (Access-token):
Api Key Authentication (Genestack-API-Token):

import odm_api
from odm_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = odm_api.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Access-token
configuration.api_key['Access-token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Access-token'] = 'Bearer'

# Configure API key authorization: Genestack-API-Token
configuration.api_key['Genestack-API-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Genestack-API-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with odm_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = odm_api.CellIntegrationAsCuratorApi(api_client)
    source_id = 'source_id_example' # str | The ID (accession) of the cell group object
    target_id = 'target_id_example' # str | The ID (accession) of the preparation group object

    try:
        # Create links between cells and preparations
        api_instance.create_cell_group_preparation_group_link_as_curator(source_id, target_id)
    except Exception as e:
        print("Exception when calling CellIntegrationAsCuratorApi->create_cell_group_preparation_group_link_as_curator: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
source_id	str	The ID (accession) of the cell group object
target_id	str	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.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_cell_group_sample_group_link_as_curator¶

create_cell_group_sample_group_link_as_curator(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¶

Api Key Authentication (Access-token):
Api Key Authentication (Genestack-API-Token):

import odm_api
from odm_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = odm_api.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Access-token
configuration.api_key['Access-token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Access-token'] = 'Bearer'

# Configure API key authorization: Genestack-API-Token
configuration.api_key['Genestack-API-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Genestack-API-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with odm_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = odm_api.CellIntegrationAsCuratorApi(api_client)
    source_id = 'source_id_example' # str | The ID (accession) of the cell group object
    target_id = 'target_id_example' # str | The ID (accession) of the sample group object

    try:
        # Create links between cells and samples
        api_instance.create_cell_group_sample_group_link_as_curator(source_id, target_id)
    except Exception as e:
        print("Exception when calling CellIntegrationAsCuratorApi->create_cell_group_sample_group_link_as_curator: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
source_id	str	The ID (accession) of the cell group object
target_id	str	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.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]