Molecule

Update Molecule

Update Molecule.

patch/api/v3/molecule/{molecule_id}

Request

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

Path parameters

molecule_idstring required

ID of the Molecule.

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[]
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
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
canonicalSmilesstring nullable

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

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

idstring
modifiedAtstring datetime nullable
namestring nullable

Name of the item.

originalSmilesstring nullable

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

smilesWithCounterpartsstring nullable

The full chemical structure in SMILES format, including salt and solvate counterparts as dot-disconnected fragments (each repeated according to its ratio). When a compound has no counterparts, this equals canonicalSmiles. Null if the full structure couldn't be calculated.

authorsstring uri nullable

Changes

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