BEbenchling
Oligo Duplex

Create OligoDuplex

Create an oligo duplex. Provide componentMapping, connections, and forwardOffset together.

post/api/v3/oligo-duplex

Request

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

Request body

aliasesstring[]
authorIdsstring[]
componentMappingobject required

Mapping from schema component names to entity names.

connectionsstring required

Connection definitions for the duplex structure, as pipe-delimited entries. Each entry is sourceLabel,targetLabel for a shorthand covalent bond between two small molecules, or sourceLabel,targetLabel,residueIndex:rGroupOrPair-residueIndex:rGroupOrPair for a HELM-style attachment. Labels refer to component names from componentMapping, suffixed with (N) to disambiguate repeated entities (e.g. molecule(2)). For example: oligoName,moleculeName,1:R1-?:?|moleculeName,molecule2Name.

customFieldsobject
entityRegistryIdstring

Registry ID to assign to the entity. If one is specified, the labeling_strategy must be unspecified.

folderIdstring required
forwardOffsetinteger required

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.

namestring required

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 one is specified, the entity_registry_id must be unspecified.

registryIdstring nullable

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

schemaFieldsobject
schemaIdstring required

The ID of the schema to use for the oligo duplex.

Response

Created

__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.