Benchling · Schema

ContainersArchive

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

Properties

Name Type Description
containerIds array Array of container IDs
reason string Reason that containers are being archived.
shouldRemoveBarcodes boolean Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.
View JSON Schema on GitHub

JSON Schema

ContainersArchive.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/ContainersArchive.json",
  "title": "ContainersArchive",
  "additionalProperties": false,
  "properties": {
    "containerIds": {
      "description": "Array of container IDs",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "reason": {
      "description": "Reason that containers are being archived.\n",
      "enum": [
        "Made in error",
        "Retired",
        "Expended",
        "Shipped",
        "Contaminated",
        "Expired",
        "Missing",
        "Other"
      ],
      "type": "string"
    },
    "shouldRemoveBarcodes": {
      "description": "Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.\n",
      "type": "boolean"
    }
  },
  "required": [
    "containerIds",
    "reason"
  ],
  "type": "object"
}