{
"$uri": "/api/v1/analyses/0d77065796f8d173",
"analysis_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"job": {
"__DOLLAR_REF__": "/api/v1/jobs/a1b2c3d4e5f67890"
},
"sample": {
"__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
},
"complete": false,
"error_msg": "<string>",
"job_args": {},
"success": false,
"updated_at": "2023-11-07T05:31:56Z"
}Analyses
The Analysis Resource
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.Pattern:
^/api/v1/analyses/[a-f0-9]{16}$Example:
"/api/v1/analyses/0d77065796f8d173"
A reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}.
Show child attributes
Show child attributes
A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"}.
Show child attributes
Show child attributes
The error message from the analysis, if it failed.
Maximum string length:
255The arguments passed into this analysis (can be null).
⌘I