Skip to main content
The Panel is an analysis providing results for a set of marker sequences, which can range from very short sequences (e.g., 30-50 bases) to complete genes. These marker sequences are typically either predictive of function (e.g., antimicrobial resistance, virulence) or useful for typing (e.g., indicative of serotype or strain information). A panel has the same properties as an analyses (less the analysis_type field), as well as route for panel-specific results.
$uri
string
required
read-only
Pattern: ^/api/v1/panels/[a-f0-9]{16}$
Example:

"/api/v1/panels/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"}.

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.