API Basics
JUMP TO
- Getting Started
- Authentication
- API Documentation
- CLI & Client Library (Python)
- Jupyter Notebooks
- Pagination
- Errors
Samples
Metadata & Tags
- The Metadata Resource
- The Tag Resource
- Retrieve All Metadataget
- Retrieve A Metadata Recordget
- Retrieve All Tagsget
- Retrieve A Tagget
- Updating Metadatapatch
Analyses
- The Analysis Resource
- Retrieve All Analysesget
- Retrieve An Analysisget
- Retrieve Analysis Resultsget
- Retrieve Analysis Filesget
- Retrieve Analysis Output File Detailsget
- The Classification Resource
- Retrieve All Classificationsget
- Retrieve A Classificationget
- Classification Resultsget
- Read-Level Resultsget
- The Panel Resource
- Retrieve A Panelget
- Retrieve All Panelsget
- Panel Resultsget
- The Alignment Resource
- Retrieve All Alignmentsget
- Retrieve An Alignmentget
Jobs
Documents
Webhooks & Events
Sequencing
The Panel Resource
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), and several additional routes that:
- Provide the sample-level panel results ( Experimental)
Property | Description |
---|---|
$uristring | The analysis ID encoded as an addressable URI |
created_atdate-time | Timestamp for when the analysis was created on the One Codex platform, encoded as a RFC 3339 timestamp |
updated_atdate-time | Timestamp for when the analysis was most recently updated on the One Codex platform, encoded as a RFC 3339 timestamp |
completeboolean | If the analysis is complete. Incomplete or pending analyses will show a icon in the One Codex web application. |
successboolean | true if the analysis was successful. |
error_msgstring | An error message if the analysis failed. Should generally be "" or null if the analysis succeeded or is pending. |
jobstring | A reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"} . |
job_argsobject | The arguments passed into this analysis (can be null ) |
samplestring | A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"} |