Mixture Schema

Update MixtureSchema

Update MixtureSchema.

patch/api/v3/mixture-schema/{mixture_schema_id}

Request

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

Path parameters

mixture_schema_idstring required

ID of the MixtureSchema.

Headers

EARLY-ACCESSstring

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

Request body

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

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.

availableRegistrationNamingOptionsUpdateMixtureSchemaInputAvailableRegistrationNamingOptionsItems[]
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.

descriptionstring

Updated description. When provided, must be at most 1000 characters.

displayNamestring

Deprecated. Use name instead.

iconId'BASIC_FOLDER_ITEM' | 'MIXTURE' | 'MORTAR_PESTLE' | 'POWDER' | 'POWDER_BEAKER' | 'RECIPE' | 'SOLUTION'
includeRegistryIdInChipsboolean
isContainableboolean
itemIdPrefixstring
namestring

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

systemNamestring

Updated SQL identifier for the warehouse table name. When provided, 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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.

useRegistryIdForItemDisplayLabelboolean

Response

OK

__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 2 revisions of this API.