Skip to main content
An Alignment is an analysis providing sensitive local alignment of a WGS samples against a specific reference genome sample. It has the same properties as an analyses, but lacks the analysis_type field and also includes a tax_id field indicating the taxonmic ID of the genome against which the alignment was performed. At this time, there are no v1 API routes for accessing the alignment statistics (e.g., percent identity, coverage, and depth), but alignments can be viewed on the One Codex platform directly. Here’s an example public alignment and a list of all alignments for that sample:
​
$uri
string
required
read-only
Pattern: ^/api/v1/alignments/[a-f0-9]{16}$
Example:

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