Benchling · Schema

FilesArchive

The request body for archiving Files.

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

Properties

Name Type Description
fileIds array
reason string The reason for archiving the provided Files. Accepted reasons may differ based on tenant configuration.
View JSON Schema on GitHub

JSON Schema

FilesArchive.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/FilesArchive.json",
  "title": "FilesArchive",
  "additionalProperties": false,
  "description": "The request body for archiving Files.\n",
  "properties": {
    "fileIds": {
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "type": "array"
    },
    "reason": {
      "description": "The reason for archiving the provided Files. Accepted reasons may differ based on tenant configuration.\n",
      "enum": [
        "Made in error",
        "Archived",
        "Other"
      ],
      "type": "string"
    }
  },
  "required": [
    "reason",
    "fileIds"
  ],
  "type": "object"
}