Benchling · Schema

EntitySchema

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks
View JSON Schema on GitHub

JSON Schema

EntitySchema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/EntitySchema.json",
  "title": "EntitySchema",
  "allOf": [
    {
      "$ref": "#/components/schemas/RegistrySchema"
    },
    {
      "properties": {
        "constraint": {
          "nullable": true,
          "properties": {
            "fieldDefinitionNames": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "hasUniqueResidues": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "containableType": {
          "enum": [
            "NONE",
            "ENTITY",
            "BATCH"
          ],
          "type": "string"
        },
        "containerNameTemplateParts": {
          "items": {
            "$ref": "#/components/schemas/NameTemplatePart"
          },
          "nullable": true,
          "type": "array"
        },
        "modifiedAt": {
          "description": "DateTime the Entity Schema was last modified",
          "example": "2017-04-18T05:55:48.685345+00:00",
          "format": "date-time",
          "type": "string"
        },
        "nameTemplateParts": {
          "items": {
            "$ref": "#/components/schemas/NameTemplatePart"
          },
          "nullable": true,
          "type": "array"
        },
        "type": {
          "enum": [
            "custom_entity",
            "dna_sequence",
            "rna_sequence",
            "aa_sequence",
            "mixture",
            "dna_oligo",
            "rna_oligo",
            "molecule"
          ],
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    }
  ]
}