BEbenchling
DNA Sequence

Get DnaSequence by ID

Get a single DnaSequence by ID.

get/api/v3/dna-sequence/{dna_sequence_id}

Request

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

Path parameters

dna_sequence_idstring required

ID of the DnaSequence.

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
aliasesstring[] nullable

Array of aliases

annotationsstring uri

Annotations on the DNA sequence, not including translations or primers. Annotations on parts are not included.

archiveReasonstring nullable
archivedboolean
basesstring

Bases of the forward strand of the DNA sequence.

createdAtstring datetime nullable
entityRegistryIdstring nullable

The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered.

idstring
isCircularboolean

Whether the DNA sequence is circular or linear.

modifiedAtstring datetime nullable
namestring

Name of the item.

nucleotideAlignmentsstring uri

Nucleotide alignments that use this sequence as the reference sequence. For template alignments, this is the template sequence; for consensus alignments, this is the derived consensus sequence.

partsstring uri

Part features linking regions of this sequence to other nucleotide sequences.

primersstring uri

Primer bind features on the DNA sequence. Primers on parts are not included.

startIndexinteger

Starting index for the sequence residues of linear DNA sequences. Implicitly 1 for other sequence types.

translationsstring uri

Translation annotations present on the DNA sequence. Translations may be one region or split across multiple regions. Translations on parts are not included.

authorsstring uri nullable

Changes

No recorded changes to this operation across all 1 revision of this API.