Skip to navigation

Update Molecule

Update Molecule.

Authentication

AuthorizationBearer

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

Path parameters

molecule_idstringRequired
ID of the Molecule.

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
chemicalStructureobjectOptional
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"
creatorobject or nullOptional
schemaFieldslist of objects or nullOptional
aliaseslist of strings or nullOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
canonicalSmilesstring or nullOptional

The canonicalized chemical structure in SMILES format. E.g., Nc1nc(=O)n([H:1])cc1C1CC1

createdAtstring or nullOptional
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
modifiedAtstring or nullOptional
namestring or nullOptional
Name of the item.
originalSmilesstring or nullOptional

The original chemical structure in SMILES format. Null if the user did not originally provide SMILES. E.g., Nc1nc(=O)n([H:1])cc1C1CC1

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.

smilesWithCounterpartsstring or nullOptional

The full chemical structure in SMILES format, including salt and solvent counterparts as dot-disconnected fragments (each repeated according to its ratio). When a compound has no counterparts, this equals canonicalSmiles.

typedSchemaobject or nullOptional

Errors

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