Skip to navigation
Benchling APIOligo Conjugate

Update OligoConjugate

Update an oligo conjugate.

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

oligo_conjugate_idstringRequired
ID of the OligoConjugate.

Request

This endpoint expects an object.
aliaseslist of stringsOptional
allowCustomFieldDeletionbooleanOptional
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.
archiveReasonstringOptional
archivedbooleanOptional
authorIdslist of stringsOptional
componentMappingmap from strings to stringsOptional
Mapping from schema component names to entity names. To update the connections, provide componentMapping and connections together.
connectionsstringOptional
Connection definitions for the complex polymer structure. To update the connections, provide componentMapping and connections together.
customFieldsmap from strings to objectsOptional
entityRegistryIdstringOptional

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.

folderIdstringOptional
namestringOptional
Name of the item.
namingStrategyenumOptional

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

registryIdstring or nullOptional
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.
schemaFieldsmap from strings to objectsOptional
schemaIdstringOptional

Response

OK
__typenamestringOptional
authorsstring or nullOptionalformat: "uri"
creatorobjectOptional
schemaFieldslist of objects or nullOptional
aliaseslist of strings or nullOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
backboneobjectOptional

Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues and connections to other polymers. The entity field links to a corresponding DnaSequence, RnaSequence, DnaOligo, or RnaOligo. Used as the backbone component in OligoConjugate and as forward/reverse strands in OligoDuplex.

canonicalHelmstringOptional
conjugateslist of objectsOptional
createdAtstringOptional
customFieldslist of objects or nullOptional
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
idstringOptional
modifiedAtstringOptional
namestringOptional
Name of the item.
originalHelmstring or nullOptional
outOfSyncbooleanOptional
outOfSyncReasonstring or nullOptional
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.
schemaobjectOptional

Use typedSchema instead, which returns the per-type schema.

structureobjectOptional

Contains the complete structural definition of an oligo conjugate, including its oligonucleotide backbone, conjugated molecules and peptides, and the connections between them.

For each simple polymer, restricted read access on the linked entity affects entity only; structural fields on that polymer are still populated for the containing conjugate.

typedSchemaobjectOptional

Errors

400
Oligo Conjugate Update Request Bad Request Error
403
Oligo Conjugate Update Request Forbidden Error
404
Oligo Conjugate Update Request Not Found Error
409
Oligo Conjugate Update Request Conflict Error
429
Oligo Conjugate Update Request Too Many Requests Error
500
Oligo Conjugate Update Request Internal Server Error