BEbenchling
DNA Oligo

Update DnaOligo

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)
patch/api/v3/dna-oligo/{dna_oligo_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

dna_oligo_idstring required

ID of the DnaOligo.

Request body

aliasesstring[]

Array of aliases

allowCustomFieldDeletionboolean

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.

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

authorIdsstring[]
basesstring

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

customFieldsobject

Custom fields set on the Oligo.

customNotationstring

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.

customNotationIdstring

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

entityRegistryIdstring

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.

folderIdstring
helmstring

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

namestring

Name of the item.

namingStrategy'NEW_IDS' | 'IDS_FROM_NAMES' | 'DELETE_NAMES' | 'SET_FROM_NAME_PARTS' | 'REPLACE_NAMES_FROM_PARTS' | 'KEEP_NAMES' | 'REPLACE_ID_AND_NAME_FROM_PARTS'

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

registryIdstring nullable

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.

schemaFieldsobject
schemaIdstring

Response

OK

__typenamestring
aliasesstring[] nullable

Array of aliases

annotationsstring uri

Annotations on the Oligo.

archiveReasonstring nullable
archivedboolean
basesstring

Bases of the Oligo.

canonicalHelmstring

Normalized HELM notation for this oligo.

createdAtstring datetime nullable

DateTime the Oligo was created.

entityRegistryIdstring nullable

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.

idstring

ID of the Oligo.

modifiedAtstring datetime nullable

DateTime the Oligo was last modified.

modifiedNucleotidesstring uri

Modifications applied to this oligo.

namestring

Name of the item.

authorsstring uri nullable

Changes

No recorded changes to this operation across all 1 revision of this API.