Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

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
Pattern: ^/api/v1/panels\/[^/]+$
Example:

"/api/v1/panels/a1b2c3d4e5f67890"

​
complete
boolean
default:false
​
created_at
string<date-time>

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

​
error_msg
string | null
Maximum string 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