Benchling · Schema

Well

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

Properties

Name	Type	Description
archiveRecord	object
barcode	string	Barcode of the well
checkoutRecord	object
contents	array	Array of well contents, each with an entity and concentration
createdAt	string	DateTime the well was created
creator	object
fields	object
id	string	ID of the well
modifiedAt	string	DateTime the well was last modified
name	string	Name of the well, defaults to barcode if name is not provided.
parentStorageId	string	ID of containing parent inventory, a plate well with a coordinate (e.g. plt_2bAks9dx:a2).
parentStorageSchema	object
projectId	string	ID of the project if set
quantity	object
resourceType	string
restrictedSampleParties	array	Not applicable for well plate wells.
restrictionStatus	object	Not applicable for well plate wells.
role	object	Not applicable for matrix plate wells.
sampleOwners	array	Not applicable for well plate wells.
schema	object
volume	object
webURL	string

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/Well.json",
  "title": "Well",
  "additionalProperties": false,
  "properties": {
    "archiveRecord": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArchiveRecord"
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "barcode": {
      "description": "Barcode of the well",
      "type": "string"
    },
    "checkoutRecord": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckoutRecord"
        }
      ],
      "readOnly": true
    },
    "contents": {
      "description": "Array of well contents, each with an entity and concentration",
      "items": {
        "$ref": "#/components/schemas/ContainerContent"
      },
      "type": "array"
    },
    "createdAt": {
      "description": "DateTime the well was created",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creator": {
      "$ref": "#/components/schemas/UserSummary"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "id": {
      "description": "ID of the well",
      "readOnly": true,
      "type": "string"
    },
    "modifiedAt": {
      "description": "DateTime the well was last modified",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "Name of the well, defaults to barcode if name is not provided.",
      "type": "string"
    },
    "parentStorageId": {
      "description": "ID of containing parent inventory, a plate well with a coordinate (e.g. plt_2bAks9dx:a2).",
      "nullable": true,
      "type": "string"
    },
    "parentStorageSchema": {
      "$ref": "#/components/schemas/SchemaSummary"
    },
    "projectId": {
      "description": "ID of the project if set",
      "nullable": true,
      "type": "string"
    },
    "quantity": {
      "$ref": "#/components/schemas/ContainerQuantity"
    },
    "resourceType": {
      "enum": [
        "container"
      ],
      "type": "string"
    },
    "restrictedSampleParties": {
      "description": "Not applicable for well plate wells.",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/UserSummary"
          },
          {
            "$ref": "#/components/schemas/TeamSummary"
          }
        ]
      },
      "type": "array"
    },
    "restrictionStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SampleRestrictionStatus"
        }
      ],
      "description": "Not applicable for well plate wells."
    },
    "role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExperimentalWellRole"
        }
      ],
      "description": "Not applicable for matrix plate wells.",
      "nullable": true
    },
    "sampleOwners": {
      "description": "Not applicable for well plate wells.",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/UserSummary"
          },
          {
            "$ref": "#/components/schemas/TeamSummary"
          }
        ]
      },
      "type": "array"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SchemaSummary"
        }
      ],
      "nullable": true
    },
    "volume": {
      "$ref": "#/components/schemas/DeprecatedContainerVolumeForResponse"
    },
    "webURL": {
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}