Benchling · Schema

FoldersArchive

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

Properties

Name Type Description
folderIds array A list of folder IDs to archive.
reason string The reason for archiving the provided folders. Accepted reasons may differ based on tenant configuration.
View JSON Schema on GitHub

JSON Schema

FoldersArchive.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/FoldersArchive.json",
  "title": "FoldersArchive",
  "additionalProperties": false,
  "properties": {
    "folderIds": {
      "description": "A list of folder IDs to archive.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "reason": {
      "description": "The reason for archiving the provided folders. Accepted reasons may differ based on tenant configuration.\n",
      "enum": [
        "Made in error",
        "Retired",
        "Other"
      ],
      "type": "string"
    }
  },
  "required": [
    "reason",
    "folderIds"
  ],
  "type": "object"
}