SenNet Dataset schema

Overview:

This page describes the Dataset attributes available for querying via the SenNet parameterized search endpoint. Full Dataset schema information can be found at the SenNet Search API documentation page at the bottom of the page in the Schemas section under the Dataset section.

Description:

A query string is built by combining schema elements documented below with matching values. Each “term” of the query is combined using the & character, and the entire query is attached to the base URL after a ? character, per web standards.

Query terms may be composited from attributes deeper in the schema type of an attribute. The parameter names can be top level attributes from any of the entities or they can be nested attributes, for example /param-search/datasets?dataset_type=RNAseq queries the top level Dataset attribute dataset_type, whereas /param-search/datasets?ingest_metadata.metadata.is_targeted=Yes queries the is_targeted attribute that is nested under ingest_metadata.metadata.

This example finds all Datasets of type RNAseq where specific molecules are not targeted for detection use this query:

 GET https://search.api.sennetconsortium.org/param-search/datasets?dataset_type=RNAseq&ingest_metadata.metadata.is_targeted=No

Dataset Attributes

Attribute Type Description
uuid string The SenNet unique identifier, intended for internal software use only. This is a 32 digit hexadecimal uuid e.g. 461bbfdc353a2673e381f632510b0f17
sennet_id string A SenNet Consortium wide unique identifier randomly generated in the format SNT###.ABCD.### for every entity.
registered_doi string The doi of a the registered entity. e.g. 10.35079/hbm289.pcbm.487. This is set during the publication process and currently available for certain Collections and Datasets.
doi_url string The url from the doi registry for this entity. e.g. https://doi.org/10.35079/hbm289.pcbm.487
contains_human_genetic_sequences boolean True if the data contains any human genetic sequence information. Can only be set at CREATE/POST time
group_name string The displayname of globus group which the user who created this entity is a member of
data_access_level string from data_access_level attribute values One of the values: public, consortium.
status string string from status attribute values One of: NewProcessing, QA Published Error Hold Invalid
antibodies array of Antibody Schema A list of antibodies used in the assay that created the dataset
ingest_metadata.metadata JSON-encoded string for a supported assay type schema The assay level metadata submitted by data providers with data. Provided as json. Metadata schemas per dataset_type are linked from the dataset type allowable values section.
dataset_type string dataset type allowable values The type of data contained in the dataset (as derived from a specific assay type
source Source Object The source from which the tissue was taken for the assay. The sub-attributes under source are specified in the Source Schema
origin_samples Sample Object Array The organ from which the tissue was taken for the assay. The sub-attributes under origin_sampless are specified in the Sample Schema. This is modeled as an array because it is possible for data to be derived from multiple organs, but currently SenNet only has data derived from a single organ.

data_access_level attribute values

The data_access_level of the Dataset Schema is one of the values following enumerated values:

status attribute values

The status attribute of the Dataset Schema is one of the values following enumerated values:

dataset_type allowable values

The dataset_type attribute of the Dataset Schema is a value from the current, authoritative list of dataset types. The valid dataset types, as of, 8/26/2024 are listed below. Additionally, linked next to the dataset types are the metadata schema pages for each dataset type. The metadata attributes listed for each dataset type are accessible below the Dataset.ingest_metadata.metadata attribute (e.g. Dataset.ingest_metadata.metadata.preparation_instrument_model.