Benchling · Schema

Location

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 this location. Null if *totalCapacity* is not set.
barcode string
createdAt string
creator object
fields object
id string
modifiedAt string
name string
occupiedCapacity integer The number of plates, boxes, and containers currently in this location. Null if *totalCapacity* is not set.
parentStorageId string
schema object
totalCapacity integer The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.
webURL string
View JSON Schema on GitHub

JSON Schema

Location.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/Location.json",
  "title": "Location",
  "properties": {
    "archiveRecord": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArchiveRecord"
        }
      ],
      "nullable": true
    },
    "availableCapacity": {
      "description": "The number of available positions in this location. Null if *totalCapacity* is not set.\n",
      "nullable": true,
      "readOnly": true,
      "type": "integer"
    },
    "barcode": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "creator": {
      "$ref": "#/components/schemas/UserSummary"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "id": {
      "type": "string"
    },
    "modifiedAt": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "occupiedCapacity": {
      "description": "The number of plates, boxes, and containers currently in this location. Null if *totalCapacity* is not set.\n",
      "nullable": true,
      "readOnly": true,
      "type": "integer"
    },
    "parentStorageId": {
      "nullable": true,
      "type": "string"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SchemaSummary"
        }
      ],
      "nullable": true
    },
    "totalCapacity": {
      "description": "The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.\n",
      "nullable": true,
      "readOnly": true,
      "type": "integer"
    },
    "webURL": {
      "type": "string"
    }
  }
}