Skip to navigation
Benchling APINucleotide Alignment

Get NucleotideAlignment by ID

Get a single NucleotideAlignment by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

nucleotide_alignment_idstringRequired
ID of the NucleotideAlignment.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK
__typenamestringOptional
alignedNucleotideSequencesstringOptionalformat: "uri"

The individual sequence rows in the alignment, including the reference sequence and each aligned read or input sequence. Each row contains the gapped bases and trim boundaries that define the high-quality region used for alignment and pairwise identity calculations.

alignmentTypeenumOptional
The type of the Alignment, whether it is a consensus or template alignment.
Allowed values:
createdAtstringOptional
DateTime the Alignment was created.
idstringOptional
The ID of the Alignment.
modifiedAtstringOptional
DateTime the Alignment was last modified.
namestringOptional
The name of the Alignment.
referenceSequenceobjectOptional
The reference NucleotideSequence for the alignment. For template alignments, this is the template sequence that other sequences are compared against. For consensus alignments, this is the derived consensus sequence.

Errors

400
Nucleotide Alignment Get Request Bad Request Error
403
Nucleotide Alignment Get Request Forbidden Error
404
Nucleotide Alignment Get Request Not Found Error
429
Nucleotide Alignment Get Request Too Many Requests Error
500
Nucleotide Alignment Get Request Internal Server Error