Benchling · Schema

MixtureUpdate

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

Properties

Name	Type	Description
aliases	array	Aliases to add to the mixture
amount	string	The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with `units`. Supports scientific notation (1.23e4).
authorIds	array	IDs of users to set as the mixture's authors.
customFields	object	Custom fields to add to the mixture. Every field should have its name as a key, mapping to an object with information about the value of the field.
entityRegistryId	string
fields	object	Schema fields to set on the mixture. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.
folderId	string	ID of the folder that the entity is moved into
ingredients	array	Desired final state for the ingredients on this mixture. Each ingredient you specify will be matched with the existing ingredients on the mixture based on the component entity, and Benchling will crea
name	string
schemaId	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/MixtureUpdate.json",
  "title": "MixtureUpdate",
  "additionalProperties": false,
  "properties": {
    "aliases": {
      "description": "Aliases to add to the mixture",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "amount": {
      "description": "The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with `units`. Supports scientific notation (1.23e4).",
      "example": "123",
      "type": "string"
    },
    "authorIds": {
      "description": "IDs of users to set as the mixture's authors.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "customFields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomFields"
        }
      ],
      "description": "Custom fields to add to the mixture. Every field should have its name as a key, mapping to an object with information about the value of the field.\n"
    },
    "entityRegistryId": {
      "example": "RCP001",
      "type": "string"
    },
    "fields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Fields"
        }
      ],
      "description": "Schema fields to set on the mixture. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.\nIf you are setting the parent mixture field here, you must also specify `ingredients`\n"
    },
    "folderId": {
      "description": "ID of the folder that the entity is moved into",
      "type": "string"
    },
    "ingredients": {
      "description": "Desired final state for the ingredients on this mixture.\nEach ingredient you specify will be matched with the existing ingredients on the mixture based on the component entity, and Benchling will create, update, or delete this mixture's ingredients so that the final state of this mixture's ingredients matches your request.\nBenchling 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.\n",
      "items": {
        "$ref": "#/components/schemas/IngredientWriteParams"
      },
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "schemaId": {
      "type": "string"
    },
    "units": {
      "$ref": "#/components/schemas/MixtureMeasurementUnits"
    }
  },
  "type": "object"
}