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:

Property

Description

$uri
string

The analysis/classification ID encoded as an addressable URI

created_at
date-time

Timestamp for when the analysis was created on the One Codex platform, encoded as a RFC 3339 timestamp

complete
boolean

If the classification is complete. Incomplete or pending analyses will show a icon in the One Codex web application.

success
boolean

true if the classification was successful.

error_msg
string

An error message if the classification failed. Should generally be "" or null if the analysis succeeded or is pending.

job
string

A reference to the versioned job underlying the classification, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}.

sample
string

A reference to the sample underlying the classification, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"}