Skip to main content
The Analysis resource represents a reproducible analysis of an underlying sample using a strictly versioned analysis job.

​
Analysis types

The One Codex platform supports several types of analyses including metagenomic (or taxonomic) classification, in silico panels, and alignments. Additional analysis types are planned and will be added to the v1 API over time. All user-viewable analyses are available via the /api/v1/analyses route, while the /api/v1/classifications, /api/v1/panels, and /api/v1/alignments routes provide listings of a subset of the same analyses with the relevant type. These specific resources provide more detailed information and additional routes, but represent the same underlying execution of a job against a sample.

​
Analysis resource properties

The below table summarizes all of the properties for the Analysis resource, with the JSON schema type of each property listed below in italics.
​
$uri
string
required
read-only
Pattern: ^/api/v1/analyses/[a-f0-9]{16}$
Example:

"/api/v1/analyses/0d77065796f8d173"

​
analysis_type
enum<string>
required
Available options:
classification,
panel,
alignment,
control,
report,
functional,
workflow,
mlst,
assembly_run
​
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"}.

​
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.