Benchling · Schema

DatasetsArchive

The request body for archiving Datasets.

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

Properties

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

JSON Schema

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