Benchling · Schema

Field

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

Properties

Name	Type	Description
displayValue	string
isMulti	boolean
textValue	string
type	object
value	object	For single link fields, use the id of the item you want to link (eg. "seq_jdf8BV24"). For multi-link fields, use an array of ids of the items you want to link (eg. ["seq_jdf8BV24"])

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/Field.json",
  "title": "Field",
  "properties": {
    "displayValue": {
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "isMulti": {
      "readOnly": true,
      "type": "boolean"
    },
    "textValue": {
      "example": "Amp",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FieldType"
        }
      ],
      "readOnly": true
    },
    "value": {
      "description": "For single link fields, use the id of the item you want to link (eg. \"seq_jdf8BV24\").\nFor multi-link fields, use an array of ids of the items you want to link (eg. [\"seq_jdf8BV24\"])\n",
      "nullable": true,
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "object"
        },
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      ]
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}