Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

This section provides a comprehensive overview of the URI namespaces used within the EMO-BON ecosystem.

URI Design Principles

EMO-BON URI patterns are designed for:

Overview - URI Path Patterns

Base URI: https://data.emobon.embrc.eu

Each URI is further extended with a path specific to the entity type:

Entity type/repository/path-to/file.extension#fragment-identifier
RO-Profiles
ro-profiles/{name}-profile/{version}
RO-Crates
governance-crate/governance-crate
observatory-crate/observatory-{obsid}-crate
analysis-results-crate/analysis-results-{cluster}-crate
sequencing-logistics-crate/sequencing-logistics-crate
Data Entities
Observatory/observatory-{obs_id}-crate/{env_package}/observatory/{obs_id}
Sampling event/observatory-{obs_id}-crate/{env_package}/sampling-event/{sampling_event}
Sample/observatory-{obs_id}-crate/{env_package}/sample/{source_mat_id}
Observation/observatory-{obs_id}-crate/{env_package}/observation/{source_mat_id}#{observedProperty}
Taxon summary/analysis-results-{cluster}-crate{source_mat_id}-ro-crate/taxonomy-summary-{geneticMarker}#{OTU-ID}
Functional annotation/analysis-results-{cluster}-crate{source_mat_id}-ro-crate/functional-annotation#{rowID}
batch/sequencing-logistics-crate/shipment/batch/{batchID}
sequence-run/sequencing-logistics-crate/shipment/batch/{batchID}#SequenceAnalysis

Detailed Specifications - URI Path Patterns

RO-Profiles

URI pattern: {base}/{name}-profile/{version}

ParameterDescriptionAllowed ValuesExample URI
{name}Name of the profileobservatory, sequencing, analysis-resultsobservatory
{version}Profile versionlatest or specific version (vM.m.p)latest, v1.0.0

Examples:

Governance Crate

URI: {base}/governance-crate

Example: https://data.emobon.embrc.eu/governance-crate/

Observatory Crate

URI pattern: {base}/observatory-{obsid}-crate

ParameterDescriptionAllowed ValuesExample(s)
{obsid}Unique observatory IDfree-text IDshcmr-1, BPNS

Example: https://data.emobon.embrc.eu/observatory-hcmr-1-crate

Analysis-Results Crate

URI pattern:

ParameterDescriptionAllowed ValuesExample
{cluster}Unique analysis cluster IDfree-text IDscluster-01

Example: https://data.emobon.embrc.eu/analysis-results-cluster-01-crate

Sequencing Logistics Crate

URI: {base}/sequencing-logistics-crate

Observatory

URI pattern: {base}/observatory-{obs_id}-crate/{env_package}/observatory/{obs_id}

ParameterDescriptionAllowed ValuesExample
{obs_id}Unique observatory IDfree-text IDshcmr-1, BPNS
{env_package}Environment packagewater / sediment / soilwater, sediment

Example: http://data.emobon.embrc.eu/observatory-hcmr-1-crate/water/observatory/HCMR-1

Sampling Event

URI pattern: {base}/observatory-{obs_id}-crate/{env_package}/sampling-event/{sampling_event}

ParameterDescriptionAllowed ValuesExample
{obs_id}Unique observatory IDfree-text IDshcmr-1, BPNS
{env_package}Environment packagewater, sedimentwater, sediment
{sampling_event}Unique sampling event IDfree-text IDsHCMR-1_Wa_221027

Example: http://data.emobon.embrc.eu/observatory-hcmr-1-crate/water/sampling-event/HCMR-1_Wa_221027

Sample

URI pattern: {base}/observatory-{obs_id}-crate/{env_package}/sample/{source_mat_id}

ParameterDescriptionAllowed ValuesExample
{obs_id}Unique observatory IDfree-text IDshcmr-1, BPNS
{env_package}Environment packagewater, sedimentwater, sediment
{source_mat_id}Unique sample IDfree-text IDsEMOBON_HCMR-1_Wa_1

Example: http://data.emobon.embrc.eu/observatory-hcmr-1-crate/water/sample/EMOBON_HCMR-1_Wa_1

Observation

URI pattern: {base}/observatory-{obs_id}-crate/{env_package}/observation/{source_mat_id}#{observedProperty}

ParameterDescriptionAllowed ValuesExample
{obs_id}Unique observatory IDfree-text IDshcmr-1, BPNS
{env_package}Environment packagewater, sedimentwater, sediment
{source_mat_id}Unique sample IDfree-text IDsEMOBON_HCMR-1_Wa_1
{observedProperty}Name of the observed propertytemperature, pHchlorophyll, sea_subsurf_salinity

Example: http://data.emobon.embrc.eu/observatory-hcmr-1-crate/water/observation/EMOBON_HCMR-1_Wa_1#chlorophyll

Taxononmy Annotation

URI pattern: {base}/analysis-results-{cluster}-crate/{source_mat_id}-ro-crate/taxonomy-summary/{geneticMarker}/{geneticMarker}-taxonomy-summary#{OTU-ID}

ParameterDescriptionAllowed ValuesExample
{cluster}Unique analysis cluster IDfree-text IDscluster-01
{source_mat_id}Unique sample IDfree-text IDsEMOBON_AAOT_Wa_42
{geneticMarker}Genetic marker used during analysisSLU / SSUSSU
{OTU-ID}OTU IDinteger IDs2157

Example: https://data.emobon.embrc.eu/analysis-results-cluster-01-crate/EMOBON_AAOT_Wa_42-ro-crate/taxonomy-summary/SSU/SSU-taxonomy-summary#2157

Functional Annotation

URI pattern: {base}/analysis-results-{cluster}-crate/{source_mat_id}-ro-crate/functional-annotation/functional-annotation#{rowID}

ParameterDescriptionAllowed ValuesExample
{cluster}Unique analysis cluster IDfree-text IDscluster-01
{source_mat_id}Unique sample IDfree-text IDsEMOBON_AAOT_Wa_42
{rowID}An identifier for the functional annotationrow index0055085

Example: https://data.emobon.embrc.eu/analysis-results-cluster-01-crate/EMOBON_AAOT_Wa_42-ro-crate/functional-annotation/functional-annotation#GO:0055085

Batch

URI pattern: {base}/sequencing-logistics-crate/shipment/batch/{batchID}

ParameterDescriptionAllowed Values
{batchID}Unique batch identifierfree-text IDs

Sequence Run

URI pattern: {base}/sequencing-logistics-crate/shipment/batch/{batchID}#SequenceAnalysis

ParameterDescriptionAllowed Values
{batchID}Batch ID for sequence runfree-text IDs