Samples

Metadata & Tags

Analyses

Jobs

Documents

Webhooks & Events

Sequencing

The Classification Resource

The Classification is an analysis providing metagenomic classification results for a sample. It has the same properties as an analyses (less the analysis_type field), and several additional routes that:

PropertyDescription
$uristringThe analysis ID encoded as an addressable URI
created_atdate-timeTimestamp for when the analysis was created on the One Codex platform, encoded as a RFC 3339 timestamp
updated_atdate-timeTimestamp for when the analysis was most recently updated on the One Codex platform, encoded as a RFC 3339 timestamp
completebooleanIf the analysis is complete. Incomplete or pending analyses will show a icon in the One Codex web application.
successbooleantrue if the analysis was successful.
error_msgstringAn error message if the analysis failed. Should generally be "" or null if the analysis succeeded or is pending.
jobstringA reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}.
job_argsobjectThe arguments passed into this analysis (can be null)
samplestringA reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"}