BEbenchling
Oligo Duplex

Update OligoDuplex

Update an oligo duplex.

To update the duplex structure, provide componentMapping, connections, and forwardOffset together. To update only non-structural properties, omit all three fields. When archiving, archived must be true and archiveReason is required. When unarchiving, archived must be false and archiveReason must be omitted.

patch/api/v3/oligo-duplex/{oligo_duplex_id}

Request

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

Path parameters

oligo_duplex_idstring required

ID of the OligoDuplex.

Request body

aliasesstring[]
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[]
componentMappingobject

Mapping from schema component names to entity names. To update the duplex structure, provide componentMapping, connections, and forwardOffset together.

connectionsstring

Connection definitions for the duplex structure. To update the duplex structure, provide componentMapping, connections, and forwardOffset together.

customFieldsobject
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
forwardOffsetinteger

Offset of the forward strand relative to the reverse strand, in residues. For example, -2 means the forward strand begins 2 positions before the reverse strand. To update the duplex structure, provide componentMapping, connections, and forwardOffset together.

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
archiveReasonstring nullable
archivedboolean
canonicalHelmstring
createdAtstring datetime
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.

forwardOffsetinteger nullable
idstring
modifiedAtstring datetime
namestring

Name of the item.

originalHelmstring nullable
outOfSyncboolean
outOfSyncReasonstring nullable
authorsstring uri nullable

Changes

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