Mixture Schema

Create MixtureSchema

Create MixtureSchema.

post/api/v3/mixture-schema

Request

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

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

allowMeasuredIngredientsboolean required

Whether this mixture schema allows recording measured values for ingredients. When enabled, users can track actual measured amounts in addition to target amounts.

availableRegistrationNamingOptionsCreateMixtureSchemaInputAvailableRegistrationNamingOptionsItems[]
componentLotStorageEnabledboolean

Whether mixture ingredients can specify their component lot as a container and/or entity from inventory. Only applicable when allowMeasuredIngredients is true. Will be null when allowMeasuredIngredients is false.

componentLotTextEnabledboolean

Whether mixture ingredients can specify their component lot as a text value. Only applicable when allowMeasuredIngredients is true. Will be null when allowMeasuredIngredients is false.

descriptionstring required

A human-readable description of the schema. At most 1000 characters.

displayNamestring

Deprecated. Use name instead.

fieldsetsstring[]
iconId'BASIC_FOLDER_ITEM' | 'MIXTURE' | 'MORTAR_PESTLE' | 'POWDER' | 'POWDER_BEAKER' | 'RECIPE' | 'SOLUTION'
includeRegistryIdInChipsboolean
isContainableboolean
itemIdPrefixstring required
namestring

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

systemNamestring

The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization.

useRegistryIdForItemDisplayLabelboolean

Response

Created

__typenamestring
allowMeasuredIngredientsboolean

Whether this mixture schema allows recording measured values for ingredients. When enabled, users can track actual measured amounts in addition to target amounts.

archiveReasonstring nullable
archivedboolean
availableRegistrationNamingOptionsMixtureSchemaAvailableRegistrationNamingOptionsItems[]
componentLotStorageEnabledboolean nullable

Whether mixture ingredients can specify their component lot as a container and/or entity from inventory. Only applicable when allowMeasuredIngredients is true. Will be null when allowMeasuredIngredients is false.

componentLotTextEnabledboolean nullable

Whether mixture ingredients can specify their component lot as a text value. Only applicable when allowMeasuredIngredients is true. Will be null when allowMeasuredIngredients is false.

containableType'NONE' | 'ENTITY' | 'BATCH'
createdAtstring datetime nullable
descriptionstring
fieldDefinitionsstring uri
fieldsetsstring uri
iconId'BASIC_FOLDER_ITEM' | 'MIXTURE' | 'MORTAR_PESTLE' | 'POWDER' | 'POWDER_BEAKER' | 'RECIPE' | 'SOLUTION'
idstring
includeRegistryIdInChipsboolean
itemIdPrefixstring
modifiedAtstring datetime
namestring
systemNamestring
useRegistryIdForItemDisplayLabelboolean
validationRulesstring uri

Changes

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