Skip to main content
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 includes routes for retrieving the sample-level JSON classification results as well as read-level results.
$uri
string
required
read-only
Pattern: ^/api/v1/classifications/[a-f0-9]{16}$
Example:

"/api/v1/classifications/0d77065796f8d173"

created_at
string<date-time>
required

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

job
jobs · object
required

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

results_uri
string | null
required

URI for direct download of results

sample
samples · object
required

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

complete
boolean
default:false
error_msg
string | null

The error message from the analysis, if it failed.

Maximum string length: 255
job_args
Job Args · object

The arguments passed into this analysis (can be null).

success
boolean
default:false
updated_at
string<date-time> | null

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