Get DnaOligo by ID

GET

https://{tenant_name}.benchling.com/api/v3/dna-oligo/:dna_oligo_id

GET

/api/v3/dna-oligo/:dna_oligo_id

curl https://{tenant_name}.benchling.com/api/v3/dna-oligo/dna_oligo_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",
  "canonicalHelm": "canonicalHelm",
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "modifiedNucleotides": "modifiedNucleotides",
  "name": "name",
  "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"
  },
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single DnaOligo by ID.

Authentication

AuthorizationBearer

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

Path parameters

dna_oligo_idstringRequired

ID of the DnaOligo.

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 Oligo.

archiveReasonstring or nullOptional

archivedbooleanOptional

basesstringOptional

Bases of the Oligo.

canonicalHelmstringOptional

Normalized HELM notation for this oligo.

createdAtstring or nullOptional

DateTime the Oligo was created.

customFieldslist of objects or nullOptional

Custom fields set on the Oligo.

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

Folder containing the oligo.

idstringOptional

ID of the Oligo.

modifiedAtstring or nullOptional

DateTime the Oligo was last modified.

modifiedNucleotidesstringOptionalformat: "uri"

Modifications applied to this oligo.

namestringOptional

Name of the item.

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.

typedSchemaobject or nullOptional

Errors

400

Dna Oligo Get Request Bad Request Error

403

Dna Oligo Get Request Forbidden Error

404

Dna Oligo Get Request Not Found Error

429

Dna Oligo Get Request Too Many Requests Error

500

Dna Oligo Get Request Internal Server Error