Benchling · Schema

DatasetCreate

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

Properties

Name Type Description
customFields object Custom field values to set on the file
dataFrameId string ID of the data frame that
folderId string ID of the folder that contains the file
name string Display name for the file
study_ids array The study IDs that the dataset is associated with. If provided, the dataset will be associated with the provided studies. If not provided, the dataset will not be associated with any studies.
View JSON Schema on GitHub

JSON Schema

DatasetCreate.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/DatasetCreate.json",
  "title": "DatasetCreate",
  "properties": {
    "customFields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomFields"
        }
      ],
      "description": "Custom field values to set on the file"
    },
    "dataFrameId": {
      "description": "ID of the data frame that",
      "example": "dset_LlDFupKyErxx",
      "nullable": false,
      "type": "string"
    },
    "folderId": {
      "description": "ID of the folder that contains the file",
      "example": "lib_bf0636",
      "nullable": false,
      "type": "string"
    },
    "name": {
      "description": "Display name for the file",
      "example": "IC50 Chart",
      "nullable": false,
      "type": "string"
    },
    "study_ids": {
      "description": "The study IDs that the dataset is associated with. If provided, the dataset will be associated with the provided studies. If not provided, the dataset will not be associated with any studies.\n",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "type": "array"
    }
  },
  "type": "object"
}