BEbenchling
Nucleotide Alignment

Get NucleotideAlignment by ID

Get a single NucleotideAlignment by ID.

get/api/v3/nucleotide-alignment/{nucleotide_alignment_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

nucleotide_alignment_idstring required

ID of the NucleotideAlignment.

Query parameters

returningstring[]

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

omitstring[]

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

Response

OK

__typenamestring
alignedNucleotideSequencesstring 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.

alignmentType'TEMPLATE' | 'CONSENSUS'

The type of the Alignment, whether it is a consensus or template alignment.

createdAtstring datetime

DateTime the Alignment was created.

idstring

The ID of the Alignment.

modifiedAtstring datetime

DateTime the Alignment was last modified.

namestring

The name of the Alignment.

Changes

No recorded changes to this operation across all 2 revisions of this API.