Get OligoDuplex by ID

GET

https://{tenant_name}.benchling.com/api/v3/oligo-duplex/:oligo_duplex_id

GET

/api/v3/oligo-duplex/:oligo_duplex_id

curl https://{tenant_name}.benchling.com/api/v3/oligo-duplex/oligo_duplex_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "canonicalHelm": "canonicalHelm",
  "conjugates": [
    {
      "__typename": "__typename",
      "connections": [
        {}
      ],
      "helmReference": "helmReference",
      "nucleotideType": "DNA",
      "polymerType": "polymerType",
      "residues": "residues"
    }
  ],
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "forwardOffset": 1,
  "forwardStrand": {
    "__typename": "__typename",
    "connections": [
      {}
    ],
    "entity": {
      "__typename": "__typename",
      "id": "id"
    },
    "helmReference": "helmReference",
    "nucleotideType": "DNA",
    "polymerType": "polymerType",
    "residues": "residues"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "originalHelm": "originalHelm",
  "outOfSync": true,
  "outOfSyncReason": "outOfSyncReason",
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "registrationOrigin": {
    "__typename": "__typename",
    "originEntry": {
      "__typename": "__typename",
      "id": "id"
    },
    "registeredAt": "registeredAt"
  },
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "reverseStrand": {
    "__typename": "__typename",
    "connections": [
      {}
    ],
    "entity": {
      "__typename": "__typename",
      "id": "id"
    },
    "helmReference": "helmReference",
    "nucleotideType": "DNA",
    "polymerType": "polymerType",
    "residues": "residues"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "structure": {
    "__typename": "__typename",
    "connections": [
      {}
    ],
    "resolvedAttachments": [
      {}
    ],
    "simplePolymers": [
      {}
    ]
  },
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single OligoDuplex by ID.

Authentication

AuthorizationBearer

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

Path parameters

oligo_duplex_idstringRequired

ID of the OligoDuplex.

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"

creatorobjectOptional

schemaFieldslist of objects or nullOptional

aliaseslist of strings or nullOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

canonicalHelmstringOptional

conjugateslist of objectsOptional

createdAtstringOptional

customFieldslist of objects or nullOptional

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

forwardOffsetinteger or nullOptional

forwardStrandobjectOptional

Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues and connections to other polymers. The entity field links to a corresponding DnaSequence, RnaSequence, DnaOligo, or RnaOligo. Used as the backbone component in OligoConjugate and as forward/reverse strands in OligoDuplex.

idstringOptional

modifiedAtstringOptional

namestringOptional

Name of the item.

originalHelmstring or nullOptional

outOfSyncbooleanOptional

outOfSyncReasonstring or nullOptional

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.

reverseStrandobjectOptional

schemaobjectOptional

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

structureobjectOptional

Contains the complete structural definition of an oligo duplex, including its forward and reverse strands, any conjugated molecules and peptides, and the connections between them.

For each simple polymer, restricted read access on the linked entity affects entity only; structural fields on that polymer are still populated for the containing duplex.

typedSchemaobjectOptional

Errors

400

Oligo Duplex Get Request Bad Request Error

403

Oligo Duplex Get Request Forbidden Error

404

Oligo Duplex Get Request Not Found Error

429

Oligo Duplex Get Request Too Many Requests Error

500

Oligo Duplex Get Request Internal Server Error