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 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 |
| updated_at date-time | Timestamp for when the analysis was most recently updated on the One Codex platform, encoded as a RFC 3339 timestamp |
| complete boolean | If the analysis is complete. Incomplete or pending analyses will show a icon in the One Codex web application. |
| success boolean | true if the analysis was successful. |
| error_msg string | An error message if the analysis failed. Should generally be "" or null if the analysis succeeded or is pending. |
| job string | A reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}. |
| job_args object | The arguments passed into this analysis (can be null) |
| sample string | A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"} |