Metadata resources provide a means for adding structured metadata to your samples. The Metadata resource include a number of default fields, and can also be extended with arbitrary custom metadata. Permissions on metadata follow the Samples they describe – i.e., the Metadata resource for a public sample will be publicly accessible. Here is an example metadata entry:


The metadata editing modal on the One Codex web application. Note that the Project is actually a property on the Sample resource.
Metadata include the following properties:
Property | Description |
---|---|
$uri | The metadata ID encoded as an addressable URI. Note that this is distinct from the sample ID (see |
name | An optional name for the sample name that will be used for display across One Codex (up to 255 characters). When missing, the sample's filename will be used. |
description | Free-form text description of the sample. |
location_lat | The latitude ( |
location_lon | The longitude ( |
location_string | A string describing the location. Currently, we do not attempt to automatically parse the lat/lon from these ( ). The One Codex web application does however set all 3 via a map. |
platform | An enum with the name of the sequencing platform. Currently, the following values are valid: |
library_type | An enum with the sample type. This is currently limited to the following values: |
sample_type | An enum with the sample type. This is currently limited to the following values: |
date_collected | Timestamp for when the sample was collected. |
date_sequenced | Timestamp for when the sample was sequenced. |
external_sample_id | An arbitrary external sample ID, e.g., an ID in a LIMS. Up to 60 characters. |
starred | Whether the sample has been starred by the user within the One Codex web application. |
custom | Arbitrary metadata is supported as part of a custom object.
|