Skip to navigation
Benchling APIDna Oligo

Create DnaOligo

Create a DNA Oligo in a folder. name and folderId are required.

Sequence specification

Provide exactly one of the following:

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

Request

This endpoint expects an object.
folderIdstringRequired
namestringRequired
Name of the item.
aliaseslist of stringsOptional
Array of aliases
annotationslist of objectsOptional
Annotations on the Oligo.
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. If one is specified, the labeling_strategy must be unspecified.

helmstringOptional

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

namingStrategyenumOptional

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

registryIdstring or nullOptional
A not null value means the entity should be registered. If not null, the value must match the registry of the item's schema.
schemaFieldsmap from strings to objectsOptional
schemaIdstringOptional

Response

Created
__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 Create Request Bad Request Error
403
Dna Oligo Create Request Forbidden Error
404
Dna Oligo Create Request Not Found Error
409
Dna Oligo Create Request Conflict Error
429
Dna Oligo Create Request Too Many Requests Error
500
Dna Oligo Create Request Internal Server Error