BEbenchling
DNA Sequence

Update DnaSequence

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

Updating bases

When replacing bases, include every sequence feature collection that already exists on the sequence: annotations, translations, primers, and parts. Provide the updated values or an empty array ([]) to clear a collection. Omitting a key that has existing data returns 400.

patch/api/v3/dna-sequence/{dna_sequence_id}

Request

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

Path parameters

dna_sequence_idstring required

ID of the DnaSequence.

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 forward strand of the DNA sequence.

customFieldsobject

Custom fields set on the DNA sequence.

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
isCircularboolean

Whether the sequence forms a closed loop, with the last base connecting back to the first.

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 DNA sequence, not including translations or primers. Annotations on parts are not included.

archiveReasonstring nullable
archivedboolean
basesstring

Bases of the forward strand of the DNA sequence.

createdAtstring datetime nullable
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
isCircularboolean

Whether the DNA sequence is circular or linear.

modifiedAtstring datetime nullable
namestring

Name of the item.

nucleotideAlignmentsstring uri

Nucleotide alignments that use this sequence as the reference sequence. For template alignments, this is the template sequence; for consensus alignments, this is the derived consensus sequence.

partsstring uri

Part features linking regions of this sequence to other nucleotide sequences.

primersstring uri

Primer bind features on the DNA sequence. Primers on parts are not included.

startIndexinteger

Starting index for the sequence residues of linear DNA sequences. Implicitly 1 for other sequence types.

translationsstring uri

Translation annotations present on the DNA sequence. Translations may be one region or split across multiple regions. Translations on parts are not included.

authorsstring uri nullable

Changes

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