Benchling · Schema

IngredientWriteParams

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Properties

Name	Type	Description
amount	string	The amount value of this ingredient in its mixture, in string format (to preserve full precision). Pair with `units`. Supports scientific notation (1.23e4). One ingredient on this mixture can have an
catalogIdentifier	string
componentEntityId	string	The entity that uniquely identifies this component.
componentLotContainerId	string	The container representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in "inventory" format.
componentLotEntityId	string	The entity representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in "inventory" format.
componentLotText	string	Text representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in "text" format.
notes	string
units	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/IngredientWriteParams.json",
  "title": "IngredientWriteParams",
  "properties": {
    "amount": {
      "description": "The amount value of this ingredient in its mixture, in string format (to preserve full precision). Pair with `units`. Supports scientific notation (1.23e4). One ingredient on this mixture can have an amount value of `\"QS\"`.\n",
      "example": "12",
      "nullable": true,
      "type": "string"
    },
    "catalogIdentifier": {
      "example": "DION_004",
      "nullable": true,
      "type": "string"
    },
    "componentEntityId": {
      "description": "The entity that uniquely identifies this component.",
      "example": "bfi_37hdg8",
      "type": "string"
    },
    "componentLotContainerId": {
      "description": "The container representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in \"inventory\" format.",
      "example": "cnt_12345",
      "nullable": true,
      "type": "string"
    },
    "componentLotEntityId": {
      "description": "The entity representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in \"inventory\" format.",
      "example": "bfi_12345",
      "nullable": true,
      "type": "string"
    },
    "componentLotText": {
      "description": "Text representing the component lot for this ingredient. This is only writable if the mixture schema supports component lots in \"text\" format.",
      "example": "DION_004-source_001",
      "nullable": true,
      "type": "string"
    },
    "notes": {
      "nullable": true,
      "type": "string"
    },
    "units": {
      "$ref": "#/components/schemas/IngredientMeasurementUnits"
    }
  },
  "required": [
    "componentEntityId",
    "catalogIdentifier",
    "amount",
    "units",
    "componentLotText",
    "componentLotEntityId",
    "componentLotContainerId",
    "notes"
  ],
  "type": "object"
}