Benchling · Schema

Box

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

Properties

Name	Type	Description
archiveRecord	object
availableCapacity	integer	The number of available positions in the box.
barcode	string
createdAt	string
creator	object
emptyContainers	integer	The number of containers in the box that have no contents.
emptyPositions	integer	The number of empty positions for adding additional containers in the box.
fields	object
filledPositions	integer	The number of containers currently in the box.
id	string
modifiedAt	string
name	string
occupiedCapacity	integer	The number of containers currently in the box.
parentStorageId	string
projectId	string
schema	object
size	integer	The size of the box (i.e. how many containers it can store).
totalCapacity	integer	The total capacity of the box (i.e. how many containers it can store).
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/Box.json",
  "title": "Box",
  "properties": {
    "archiveRecord": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArchiveRecord"
        }
      ],
      "nullable": true
    },
    "availableCapacity": {
      "description": "The number of available positions in the box.",
      "readOnly": true,
      "type": "integer"
    },
    "barcode": {
      "nullable": true,
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creator": {
      "$ref": "#/components/schemas/UserSummary"
    },
    "emptyContainers": {
      "description": "The number of containers in the box that have no contents.",
      "readOnly": true,
      "type": "integer"
    },
    "emptyPositions": {
      "description": "The number of empty positions for adding additional containers in the box.",
      "readOnly": true,
      "type": "integer"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "filledPositions": {
      "description": "The number of containers currently in the box.",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "occupiedCapacity": {
      "description": "The number of containers currently in the box.",
      "readOnly": true,
      "type": "integer"
    },
    "parentStorageId": {
      "nullable": true,
      "type": "string"
    },
    "projectId": {
      "nullable": true,
      "type": "string"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SchemaSummary"
        }
      ],
      "nullable": true,
      "title": "SchemaProperty"
    },
    "size": {
      "description": "The size of the box (i.e. how many containers it can store).",
      "readOnly": true,
      "type": "integer"
    },
    "totalCapacity": {
      "description": "The total capacity of the box (i.e. how many containers it can store).",
      "readOnly": true,
      "type": "integer"
    },
    "webURL": {
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}