BEbenchling
mixtures

Create a mixture

Create a mixture. To create a new child mixture (eg. a prep) from a parent mixture (eg. a recipe), set the parent mixture field and specify the desired final state for your ingredients. Benchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned ingredients[i].hasParent attribute.

post/mixtures

Request

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

Request body

aliasesstring[]

Aliases to add to the mixture

amountstring

The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).

authorIdsstring[]

IDs of users to set as the mixture's authors.

customFieldsCustomFields
entityRegistryIdstring

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

fieldsFields
folderIdstring

ID of the folder containing the entity. Can be left empty when registryId is present.

namestring
schemaIdstring
units'nL' | 'uL' | 'mL' | 'L' | 'g' | 'kg' | 'mg' | 'ug' | 'Units'
namingStrategy'NEW_IDS' | 'IDS_FROM_NAMES' | 'DELETE_NAMES' | 'SET_FROM_NAME_PARTS' | 'REPLACE_NAMES_FROM_PARTS' | 'KEEP_NAMES' | 'REPLACE_ID_AND_NAME_FROM_PARTS'

Specifies the behavior for automatically generated names when registering an entity.

  • NEW_IDS: Generate new registry IDs
  • IDS_FROM_NAMES: Generate registry IDs based on entity names
  • DELETE_NAMES: Generate new registry IDs and replace name with registry ID
  • SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias
  • REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template
  • KEEP_NAMES: Keep existing entity names as registry IDs
  • REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
registryIdstring

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the /registries endpoint

Required in order for entities to be created directly in the registry.

Response

Created

aliasesstring[]
allowMeasuredIngredientsboolean

Derived from the mixture's schema.

amountstring

The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with units. Supports scientific notation (1.23e4).

apiURLstring uri

The canonical url of the Mixture in the API.

createdAtstring date-time
customFieldsCustomFields
entityRegistryIdstring nullable
fieldsFields
folderIdstring nullable
idstring
modifiedAtstring date-time
namestring
registryIdstring nullable
units'nL' | 'uL' | 'mL' | 'L' | 'g' | 'kg' | 'mg' | 'ug' | 'Units'
webURLstring

Changes

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