Update DnaOligo | Benchling Documentation

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/dna-oligo/dna_oligo_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "annotations": [
    {
      "end": 7,
      "name": "Updated binding site",
      "start": 1,
      "type": "primer_bind",
      "color": "#00FF00"
    }
  ],
  "bases": "GATTACA",
  "name": "Updated forward primer"
}'

{
  "__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"
  }
}

Update a DNA Oligo. The id path parameter identifies the Oligo to update.

Sequence specification

To replace the sequence, provide exactly one of the following. Omit all sequence fields to keep the existing sequence.

bases — plain nucleotide sequence
helm — HELM notation (requires the modified nucleotides feature to be enabled)
customNotation with customNotationId — vendor-specific notation (requires custom syntaxes to be enabled; both fields must be set together)

Authentication

AuthorizationBearer

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

Path parameters

dna_oligo_idstringRequired

ID of the DnaOligo.

Request

This endpoint expects an object.

aliaseslist of stringsOptional

Array of aliases

allowCustomFieldDeletionbooleanOptional

When true, custom fields present on the entity but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.

annotationslist of objectsOptional

Annotations on the Oligo.

archiveReasonstringOptional

archivedbooleanOptional

authorIdslist of stringsOptional

basesstringOptional

Bases of the Oligo. Mutually exclusive with helm and customNotation.

customFieldsmap from strings to objectsOptional

Custom fields set on the Oligo.

customNotationstringOptional

Sequence in a vendor-specific custom notation syntax. Requires custom syntaxes to be enabled. When customNotation is set, customNotationId is required. Mutually exclusive with bases and helm.

customNotationIdstringOptional

ID of the custom notation syntax used to interpret customNotation. When customNotation is set, customNotationId is required; omit both when using bases or helm.

entityRegistryIdstringOptional

Registry ID to assign to the entity. When registering, specifying this value sets the registry ID of the entity. When already registered, specifying this value updates the entity’s registry ID. If set, naming_strategy must be unspecified.

folderIdstringOptional

helmstringOptional

HELM notation for the oligo sequence and chemical modifications. Requires the modified nucleotides feature to be enabled. Mutually exclusive with bases and customNotation.

namestringOptional

Name of the item.

namingStrategyenumOptional

Strategy to use for labeling the item in the registry if registering. If one is specified, the entity_registry_id must be unspecified.

registryIdstring or nullOptional

A not null value means the entity should be registered. A null value means it should be unregistered. If not null, the value must match the registry of the item's schema.

schemaFieldsmap from strings to objectsOptional

schemaIdstringOptional

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 Update Request Bad Request Error

403

Dna Oligo Update Request Forbidden Error

404

Dna Oligo Update Request Not Found Error

409

Dna Oligo Update Request Conflict Error

429

Dna Oligo Update Request Too Many Requests Error

500

Dna Oligo Update Request Internal Server Error