Get a DNA sequence

GET

https://{tenant_name}.benchling.com/api/v2/dna-sequences/:dna_sequence_id

GET

/api/v2/dna-sequences/:dna_sequence_id

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

{
  "aliases": [
    "string"
  ],
  "annotations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "end": 1,
      "start": 1,
      "strand": 1,
      "type": "string"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/dna-sequences/seq_asQya4lk",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "bases": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "dnaAlignmentIds": [
    "string"
  ],
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "id": "string",
  "isCircular": true,
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "parts": [
    {
      "end": 1,
      "sequenceId": "seq_VfVOART1",
      "start": 1,
      "strand": 1
    }
  ],
  "primers": [
    {
      "bases": "string",
      "bindPosition": 1,
      "color": "string",
      "end": 1,
      "name": "string",
      "oligoId": "string",
      "overhangLength": 1,
      "start": 1,
      "strand": 1
    }
  ],
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "transcriptions": [
    {
      "end": 1,
      "sequenceId": "seq_VfVOART1",
      "start": 1,
      "strand": 1
    }
  ],
  "translations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "aminoAcids": "string",
      "coerceStartCodonToMethionine": false,
      "end": 1,
      "geneticCode": "STANDARD",
      "regions": [
        {
          "end": 1,
          "start": 1
        }
      ],
      "start": 1,
      "strand": 1
    }
  ],
  "url": "string",
  "webURL": "string"
}

Get a DNA sequence

Authentication

AuthorizationBearer

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

Path parameters

dna_sequence_idstringRequired

Query parameters

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Note: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: “annotations.id” will return the same as “annotations”.

Response

aliaseslist of stringsOptional

annotationslist of objectsOptional

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the DNA Sequence in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

basesstringOptional

createdAtdatetimeOptionalRead-only

creatorobjectOptional

customFieldsmap from strings to objectsOptional

dnaAlignmentIdslist of stringsOptional

API IDs of Nucleotide Alignments involving the RNA sequence

entityRegistryIdstring or nullOptional

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

idstringOptional

isCircularbooleanOptional

lengthintegerOptional

modifiedAtdatetimeOptionalRead-only

namestringOptional

partslist of objectsOptional

primerslist of objectsOptional

registrationOriginobject or nullOptional

registryIdstring or nullOptional

schemaobject or nullOptional

transcriptionslist of objectsOptional

translationslist of objectsOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-only

Errors

400

Bad Request Error