Get DnaSequence by ID

GET

https://{tenant_name}.benchling.com/api/v3/dna-sequence/:dna_sequence_id

GET

/api/v3/dna-sequence/:dna_sequence_id

curl https://{tenant_name}.benchling.com/api/v3/dna-sequence/dna_sequence_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "annotations": "annotations",
  "archiveReason": "archiveReason",
  "archived": true,
  "bases": "bases",
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "isCircular": true,
  "modifiedAt": "modifiedAt",
  "name": "name",
  "nucleotideAlignments": "nucleotideAlignments",
  "parts": "parts",
  "primers": "primers",
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "registrationOrigin": {
    "__typename": "__typename",
    "originEntry": {
      "__typename": "__typename",
      "id": "id"
    },
    "registeredAt": "registeredAt"
  },
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "startIndex": 1,
  "translations": "translations",
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single DnaSequence by ID.

Authentication

AuthorizationBearer

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

Path parameters

dna_sequence_idstringRequired

ID of the DnaSequence.

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

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

aliaseslist of strings or nullOptional

Array of aliases

annotationsstringOptionalformat: "uri"

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

archiveReasonstring or nullOptional

archivedbooleanOptional

basesstringOptional

Bases of the forward strand of the DNA sequence.

createdAtstring or nullOptional

customFieldslist of objectsOptional

Custom fields set on the DNA sequence.

entityRegistryIdstring or nullOptional

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.

folderobject or nullOptional

idstringOptional

isCircularbooleanOptional

Whether the DNA sequence is circular or linear.

modifiedAtstring or nullOptional

namestringOptional

Name of the item.

nucleotideAlignmentsstringOptionalformat: "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.

partsstringOptionalformat: "uri"

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

primersstringOptionalformat: "uri"

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

projectobject or nullOptional

registrationOriginobject or nullOptional

Provenance of this item’s registration — where and when it was registered. Null if unregistered.

registryobject or nullOptional

The Registry this item belongs to, if registered. Null if unregistered.

schemaobject or nullOptional

Use typedSchema instead, which returns the per-type schema.

startIndexintegerOptional

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

translationsstringOptionalformat: "uri"

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

typedSchemaobject or nullOptional

Errors

400

Dna Sequence Get Request Bad Request Error

403

Dna Sequence Get Request Forbidden Error

404

Dna Sequence Get Request Not Found Error

429

Dna Sequence Get Request Too Many Requests Error

500

Dna Sequence Get Request Internal Server Error