PATCH
/
api
/
v1
/
metadata
/
{id}
{
  "$uri": "/api/v1/metadata/a1b2c3d4e5f67890",
  "custom": {},
  "date_collected": "2023-11-07T05:31:56Z",
  "date_sequenced": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "external_sample_id": "a1b2c3d4e5f67890",
  "library_type": "WGS",
  "location_lat": 0,
  "location_lon": 0,
  "location_string": "<string>",
  "name": "<string>",
  "platform": "454 sequencing",
  "sample": {
    "$ref": "/api/v1/samples/a1b2c3d4e5f67890"
  },
  "sample_type": "Isolate",
  "starred": false,
  "updated_at": "2023-11-07T05:31:56Z"
}

Update the metadata record accompanying a sample. Users may only update the metadata for samples they own, or which are part of shared projects in which they have the relevant metadata editing permissions.

Path Parameters

​
id
string
required

Body

application/json
​
custom
object

Arbitrary metadata is supported as part of a custom object. custom has two constraints: (1) it must have a depth of one (i.e., no nested records); and (2) only strings, numbers, boolean, and null values are supported as values. Example: {"lab_tech": "Linus Pauling", "amplicon_scheme": "V3-V4"}

​
date_collected
string | null

Timestamp for when the sample was collected.

​
date_sequenced
string | null

Timestamp for when the sample was sequenced.

​
description
string | null
​
external_sample_id
string | null

An arbitrary external sample ID, e.g., an ID in a LIMS. Up to 60 characters.

Maximum length: 60
​
library_type
enum<string> | null

An enum with the sample library type.

Available options:
WGS,
Targeted/16S,
Other
​
location_lat
number | null

The latitude (-90.0-90.0) of the sample location. By convention, we recommend using this for the location in which the physical specimen was collected.

Required range: -90 <= x <= 90
​
location_lon
number | null

The longitude (-180.0-180.0) of the sample location.

Required range: -180 <= x <= 180
​
location_string
string | null
Maximum length: 255
​
name
string | null
Maximum length: 255
​
platform
enum<string> | null

A enum with the name of the sequencing platform.

Available options:
454 sequencing,
454 GS FLX,
454 GS FLX Titanium,
Illumina,
Illumina Genome Analyzer II,
Illumina HiSeq,
Illumina HiSeq 1500,
Illumina HiSeq 2000,
Illumina HiSeq 2500,
Illumina HiSeq 3000,
Illumina HiSeq 4000,
Illumina HiSeq X,
Illumina iSeq 100,
Illumina MiniSeq,
Illumina MiSeq,
Illumina NextSeq,
Illumina NextSeq 500,
Illumina NextSeq 550,
Illumina NovaSeq,
Illumina NovaSeq 5000,
Illumina NovaSeq 6000,
BGISEQ,
BGISEQ 50,
Element,
Element AVITI,
Ion,
Ion S5,
Ion S5 XL,
Ion PGM,
Ion Proton,
Ion Torrent,
Oxford Nanopore,
Oxford Nanopore GridION X5,
Oxford Nanopore MinION,
Oxford Nanopore PromethION,
PacBio,
PacBio RS II,
PacBio Sequel,
PacBio Sequel II System,
PacBio Revio,
PacBio Onso,
SOLiD,
Solexa Genome Analyzer,
Sanger,
Other
​
sample
object

The sample the metadata belongs to.

​
sample_type
enum<string> | null

An enum with the sample type.

Available options:
Isolate,
Metagenomic,
Other
​
starred
boolean
default:false

Whether the sample has been starred by the user within the One Codex web application.

Response

200 - application/json
Successful operation
​
$uri
string
Example:

"/api/v1/metadata/a1b2c3d4e5f67890"

​
custom
object

Arbitrary metadata is supported as part of a custom object. custom has two constraints: (1) it must have a depth of one (i.e., no nested records); and (2) only strings, numbers, boolean, and null values are supported as values. Example: {"lab_tech": "Linus Pauling", "amplicon_scheme": "V3-V4"}

​
date_collected
string | null

Timestamp for when the sample was collected.

​
date_sequenced
string | null

Timestamp for when the sample was sequenced.

​
description
string | null
​
external_sample_id
string | null

An arbitrary external sample ID, e.g., an ID in a LIMS. Up to 60 characters.

Maximum length: 60
Example:

"a1b2c3d4e5f67890"

​
library_type
enum<string> | null

An enum with the sample library type.

Available options:
WGS,
Targeted/16S,
Other
​
location_lat
number | null

The latitude (-90.0-90.0) of the sample location. By convention, we recommend using this for the location in which the physical specimen was collected.

Required range: -90 <= x <= 90
​
location_lon
number | null

The longitude (-180.0-180.0) of the sample location.

Required range: -180 <= x <= 180
​
location_string
string | null
Maximum length: 255
​
name
string | null
Maximum length: 255
​
platform
enum<string> | null

A enum with the name of the sequencing platform.

Available options:
454 sequencing,
454 GS FLX,
454 GS FLX Titanium,
Illumina,
Illumina Genome Analyzer II,
Illumina HiSeq,
Illumina HiSeq 1500,
Illumina HiSeq 2000,
Illumina HiSeq 2500,
Illumina HiSeq 3000,
Illumina HiSeq 4000,
Illumina HiSeq X,
Illumina iSeq 100,
Illumina MiniSeq,
Illumina MiSeq,
Illumina NextSeq,
Illumina NextSeq 500,
Illumina NextSeq 550,
Illumina NovaSeq,
Illumina NovaSeq 5000,
Illumina NovaSeq 6000,
BGISEQ,
BGISEQ 50,
Element,
Element AVITI,
Ion,
Ion S5,
Ion S5 XL,
Ion PGM,
Ion Proton,
Ion Torrent,
Oxford Nanopore,
Oxford Nanopore GridION X5,
Oxford Nanopore MinION,
Oxford Nanopore PromethION,
PacBio,
PacBio RS II,
PacBio Sequel,
PacBio Sequel II System,
PacBio Revio,
PacBio Onso,
SOLiD,
Solexa Genome Analyzer,
Sanger,
Other
​
sample
object

The sample the metadata belongs to.

​
sample_type
enum<string> | null

An enum with the sample type.

Available options:
Isolate,
Metagenomic,
Other
​
starred
boolean
default:false

Whether the sample has been starred by the user within the One Codex web application.

​
updated_at
string

Timestamp for when the object was last updated, encoded as a RFC 3339 timestamp.