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
Example:

"/api/v1/classifications/a1b2c3d4e5f67890"

complete
boolean
default:false
created_at
string

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

error_msg
string | null
Maximum length: 255
job
object

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
object

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

success
boolean
default:false