Benchling · Schema

ContainerWriteBase

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

Properties

Name Type Description
fields object
name string
parentStorageId string ID of containing parent inventory, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).
restrictedSamplePartyIds array IDs of users or teams who have access to use a restricted container. Well plate wells and unrestricted containers do not have restricted sample parties.
restrictionStatus object Either RESTRICTED or UNRESTRICTED. This only applies to stand-alone containers (Plate wells are always set to NOT_APPLICABLE).
sampleOwnerIds array IDs of users or teams who are sample owners for the container. Well plate wells do not have sample owners.
View JSON Schema on GitHub

JSON Schema

ContainerWriteBase.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/ContainerWriteBase.json",
  "title": "ContainerWriteBase",
  "properties": {
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "name": {
      "type": "string"
    },
    "parentStorageId": {
      "description": "ID of containing parent inventory, can also specify a coordinate for plates and boxes (e.g. plt_2bAks9dx:a2).",
      "type": "string"
    },
    "restrictedSamplePartyIds": {
      "description": "IDs of users or teams who have access to use a restricted container. Well plate wells and unrestricted containers do not have restricted sample parties.\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "restrictionStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SampleRestrictionStatus"
        }
      ],
      "description": "Either RESTRICTED or UNRESTRICTED. This only applies to stand-alone containers (Plate wells are always set to NOT_APPLICABLE).\n"
    },
    "sampleOwnerIds": {
      "description": "IDs of users or teams who are sample owners for the container. Well plate wells do not have sample owners.\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  }
}