kenfigure

Kenfigure™: a YAML spec to define Benchling configurations

---

Project maintained by kennovation1 Hosted on GitHub Pages — Theme by mattgraham

Kenfigure Schema

Kenfigure™: a YAML spec to define Benchling configurations. © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.

Properties

• Metadata (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
  • Organization (string, required): Organization handle. Must match pattern: ^[a-z_][a-z0-9_]{0,32}$ (Test).
  • Description (string): Description of the environment and model.
  • Model version (string): Semantic version for the model (e.g., 1.2.3). Must match pattern: ^[0-9]+\.[0-9]+\.[0-9]+$ (Test).
  • Created (string, format: date-time): Datetime the model was created.
  • Modified (string, format: date-time): Datetime the model was last modified.
  • Schema version (string, required): Semantic version of the KBConfig JSON schema (e.g., 1.0.0). Must match pattern: ^[0-9]+\.[0-9]+\.[0-9]+$ (Test).
• Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Can contain additional properties.
  • Additional properties (object)
    • X (integer, required): X location coordinate.
    • Y (integer, required): Y location coordinate.
• Dropdowns (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Dropdown and its options.
    • Name (string, required): Dropdown name.
    • Description (string): Documentation description for the dropdown (not saved to Benchling).
    • Alphabetize (boolean): Alphabetize upon deployment if true.
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Options (array): Dropdown values list (may be empty). Length must be at least 0. Items must be unique.
      • Items (string)
    • API ID (string): API ID for the entity created during an export operation. This is ignored for import operations.
• Entity_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the entity schema. Some attributes only apply to certain schema types.
    • Name (string, required): Entity schema name.
    • Warehouse name (string): DEPRECATED - Use ‘System name’ instead. Internal system name. Default will be an automatic conversion of Name to a Benchlinng/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the entity schema. This is not saved to Benchling.
    • Notify (string): Causes the supplied message to be printed to the output during an import operation. Use this to tell the user to take some manual action such as configuring an embedded dashboard or setting permissions.
    • Entity type (string, required): Must match one of the Benchling-defined types. Must be one of: ["Custom Entity", "DNA Sequence", "DNA Oligo", "RNA Oligo", "RNA Sequence", "AA Sequence", "Molecule", "Entry", "Mixture"].
    • Icon (string): Icon for the schema. Matches benchling names without any translation. Must be one of: ["antibody", "bacteria", "basic_folder_item", "box", "cell-line", "compound", "entry", "fridge", "linear", "material", "mixture", "mouse", "oligo", "oligo-v2", "plate", "primer_pair", "protein", "rna_sequence", "sample-slide", "sequence", "small-molecule", "small-molecule-beaker", "vial", "chromatography", "human"].
    • Prefix (string, required): The registry ID prefix. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • RegID display (boolean): Use Registry ID as display label when true.
    • RegID chips (boolean): Include Registry ID in chips when true.
    • Show bases (boolean): Show bases in expanded view.
    • Containable type (string, required): Entity can be transferred into containers when set to ‘Entity’. Must be one of: ["None", "Entity"].
    • Naming options (array, required): Available registration naming options. Length must be at least 1. Items must be unique.
      • Items (string): Valid enum values include symbolic names and full text versions. Must be one of: ["NEW_IDS", "Generate new registry IDs", "IDS_FROM_NAMES", "Generate registry IDs based on entity names", "DELETE_NAMES", "Generate new registry IDs and replace name with registry ID", "SET_FROM_NAME_PARTS", "Generate new registry IDs, rename according to name template, and keep old name as alias", "REPLACE_NAMES_FROM_PARTS", "Generate new registry IDs, and replace name according to name template", "KEEP_NAMES", "Keep existing entity names as registry IDs", "REPLACE_ID_AND_NAME_FROM_PARTS", "Generate registry IDs and names according to name template"].
    • Name template (array): Naming template. Length must be at least 0.
      • Items (object): Name template components.
        • Type (string, required): The type of name component. Must be one of: ["Registry ID number", "Creation year", "Creation date", "Project", "Text", "Separator", "Field", "Parent lot number", "Registry ID of field"].
        • Definition (string): Depending on Type will be text, a field name, or may be omitted if N/A.
    • Constraint (array): List of fields to define constraint. Maybe empty. May contain special built-in field descriptions. Length must be at least 0. Items must be unique.
      • Items
        • Any of
          • string: Must be one of: ["Bases (ignore case)", "Canonical SMILES", "Amino acids (exact match)", "Amino acids (ignore case)"].
          • string
    • Access type (string): The registered objects of this schema will have permissions that are either Registry-based (default) or Project-based. Must be one of: ["Registry-based", "Project-based"].
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fieldsets (array): Fieldsets that the entity implements. Length must be at least 0. Items must be unique.
      • Items (string): A list of zero or more Fieldset names.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings.
        • Warehouse name (string): DEPRECATED - Use ‘System name’ instead. Internal system name. Default will be an automatic conversion of Name to a Benchlinng/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Required (boolean): Field is required when true.
        • Parent link (boolean): Entity reference is a parent link when true.
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Category", "Part", "Inventory", "ft_translation_link", "ft_assay_result_link", "ft_assay_run_link", "Batch", "Transcription"].
        • Definition: Name of target object if Type is a one of the link types.
          • Any of
            • string: Must be one of: ["Any Entity", "Custom Entity", "AA Sequence", "DNA Sequence", "Molecule", "Mixture"].
            • string
        • Computed (object): Describes the computed field. Only present for computed fields.
          • Formula name (string): Name of formula using native Benchling tokens for now. Must be one of: ["UNSUPPORTED_FORMULA", "sum_floats", "string_length", "dna_sequence_gc_percent", "set_union_file_link", "set_union_selector", "join_string", "multiply_with_exponents", "molecule_molecular_weight", "chemical_formula_with_salts", "standard_molecular_weight_with_salts", "subtract_dates", "mod_aware_molecular_weight", "render_molecule_from_smiles", "identity_fn", "aggregate_bioentity_link_unsorted_with_duplicates", "aggregate_dropdown_unsorted_with_duplicates", "aggregate_text_unsorted_with_duplicates"].
          • Path (array): List of entities to get to the final entity or field. TODO-Can this just be a list. Will type ever not be Field? Length must be at least 0.
            • Items (object)
              • Type (string, required): Type of path component. Only Field is valid for now. Must be one of: ["Field"].
              • Definition (string): Name for the given type. Usually a field name.
          • Property (object): The final value to return/compute at the end of the Path.
            • Type (string, required): The type of property. Normally Field, but use BASES to access the built-in Bases field. Must be one of: ["Field", "BASES"].
            • Definition (string): The name of the field if type is Field.
    • API ID (string): API ID for the entity schema created during an export operation. This is ignored for import operations.
• Fieldset_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the fieldset schema. Some attributes only apply to certain schema types.
    • Name (string, required): Fieldset schema name.
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the fieldset schema. This is not saved to Benchling.
    • Notify (string): Causes the supplied message to be printed to the output during an import operation. Use this to tell the user to take some manual action such as setting permissions.
    • Entity type (string): Must match one of the Benchling-defined types. May be ‘None’ to enable attaching to any type of entity schema. Must be one of: ["None", "Custom Entity", "DNA Sequence", "DNA Oligo", "RNA Oligo", "RNA Sequence", "AA Sequence", "Molecule", "Mixture"].
    • Category (boolean): If true (default), this fieldset will appear as a navigation category for end users, and an option for field definitions.
    • Prefix (string): The registry ID prefix. If specified, will override the prefix for all attached entity schemas. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • Naming options (array): Available registration naming options. If specified, will override the naming options for all attached entity schemas. Length must be at least 0. Items must be unique.
      • Items (string): Valid enum values include symbolic names and full text versions. Must be one of: ["NEW_IDS", "Generate new registry IDs", "IDS_FROM_NAMES", "Generate registry IDs based on entity names", "DELETE_NAMES", "Generate new registry IDs and replace name with registry ID", "SET_FROM_NAME_PARTS", "Generate new registry IDs, rename according to name template, and keep old name as alias", "REPLACE_NAMES_FROM_PARTS", "Generate new registry IDs, and replace name according to name template", "KEEP_NAMES", "Keep existing entity names as registry IDs", "REPLACE_ID_AND_NAME_FROM_PARTS", "Generate registry IDs and names according to name template"].
    • Name template (array): Naming template. Length must be at least 0.
      • Items (object): Name template components.
        • Type (string, required): The type of name component. Must be one of: ["Registry ID number", "Creation year", "Creation date", "Project", "Text", "Separator", "Field", "Parent lot number", "Registry ID of field"].
        • Definition (string): Depending on Type will be text, a field name, or may be omitted if N/A.
    • Constraint (array): List of fields to define constraint. Maybe empty. May contain special built-in field descriptions. If specified, will override the constraint for all attached entity schemas. Length must be at least 0. Items must be unique.
      • Items
        • Any of
          • string: Must be one of: ["Bases (ignore case)", "Canonical SMILES", "Amino acids (exact match)", "Amino acids (ignore case)"].
          • string
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Required (boolean): Field is required when true.
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Part", "Inventory", "ft_translation_link", "ft_assay_result_link", "ft_assay_run_link"].
        • Definition: Name of target object if Type is a one of the link types.
          • Any of
            • string: Must be one of: ["Any Entity", "Custom Entity", "AA Sequence", "DNA Sequence", "Molecule", "Mixture"].
            • string
        • Computed (object): Describes the computed field. Only present for computed fields.
          • Formula name (string): Name of formula using native Benchling tokens for now. Must be one of: ["UNSUPPORTED_FORMULA", "sum_floats", "string_length", "dna_sequence_gc_percent", "set_union_file_link", "set_union_selector", "join_string", "multiply_with_exponents", "mod_aware_molecular_weight", "render_molecule_from_smiles", "identity_fn", "aggregate_bioentity_link_unsorted_with_duplicates", "aggregate_dropdown_unsorted_with_duplicates", "aggregate_text_unsorted_with_duplicates"].
          • Path (array): List of entities to get to the final entity or field. TODO-Can this just be a list. Will type ever not be Field? Length must be at least 0.
            • Items (object)
              • Type (string, required): Type of path component. Only Field is valid for now. Must be one of: ["Field"].
              • Definition (string): Name for the given type. Usually a field name.
          • Property (object): The final value to return/compute at the end of the Path.
            • Type (string, required): The type of property. Normally Field, but use BASES to access the built-in Bases field. Must be one of: ["Field", "BASES"].
            • Definition (string): The name of the field if type is Field.
    • API ID (string): API ID for the entity schema created during an export operation. This is ignored for import operations.
• Study_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the study schema.
    • Name (string, required): Study schema name.
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the study schema. This is not saved to Benchling.
    • Prefix (string, required): The ID prefix for a study schema. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • Name template (array): Naming template. Length must be at least 0.
      • Items (object): Name template components.
        • Type (string, required): The type of name component. Must be one of: ["Registry ID number", "Creation year", "Creation date", "Project", "Text", "Separator", "Field", "Registry ID of field"].
        • Definition (string): Depending on Type will be text, a field name, or may be omitted if N/A.
    • Entry templates (array): List entry templates that are applicable to the study schema. Maybe empty. Length must be at least 0. Items must be unique.
      • Items (string)
    • Approval required (boolean): Require approval of Design before proceeding to Execution.
    • Study type (string): Must match one of the Benchling-defined types. Must be one of: ["CUSTOM"].
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings. Not currently supported by Benchling.
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Required (boolean): Field is required when true.
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entity", "JSON", "Boolean"].
        • Definition (string): Name of target object if Type is a one of the link types.
        • Computed field (string): Describes the computed field. Only present for computed fields.
    • API ID (string): API ID for the study schema created during an export operation. This is ignored for import operations.
• Container_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the container schema.
    • Name (string, required): Container schema name.
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the container schema. This is not saved to Benchling.
    • Notify (string): Causes the supplied message to be printed to the output during an import operation. Use this to tell the user to take some manual action.
    • Prefix (string, required): The registry ID prefix. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings.
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Category", "Inventory"].
        • Definition: Name of target object if Type is a one of the link types.
          • Any of
            • string: Must be one of: ["Any Entity", "Custom Entity", "AA Sequence", "DNA Sequence", "Molecule", "Mixture", "Any inventory"].
            • string
    • API ID (string): API ID for the entity schema created during an export operation. This is ignored for import operations.
• Box_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the box schema.
    • Name (string, required): Box schema name.
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the box schema. This is not saved to Benchling.
    • Notify (string): Causes the supplied message to be printed to the output during an import operation. Use this to tell the user to take some manual action such as creating certain standard boxes.
    • Prefix (string, required): The registry ID prefix. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • Height (integer, required): Height of the box (number of rows). Minimum: 1.
    • Width (integer, required): Width of the box (number of columns). Minimum: 1.
    • Container schema (string): Container schema for each slot in the box. May be omitted.
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings.
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Category", "Inventory"].
        • Definition: Name of target object if Type is a one of the link types.
          • Any of
            • string: Must be one of: ["Any Entity", "Custom Entity", "AA Sequence", "DNA Sequence", "Molecule", "Mixture", "Any inventory"].
            • string
    • API ID (string): API ID for the entity schema created during an export operation. This is ignored for import operations.
• Plate_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the plate schema.
    • Name (string, required): Plate schema name.
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the plate schema. This is not saved to Benchling.
    • Notify (string): Causes the supplied message to be printed to the output during an import operation. Use this to tell the user to take some manual action.
    • Prefix (string, required): The registry ID prefix. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • Size (string, required): Number of wells in the plate and its geometry (rows x columns). Rows are lettered A-Z and columns are numbered 1-N. Must be one of: ["384 (16 x 24)", "96 (8 x 12)", "48 (6 x 8)", "24 (4 x 6)", "12 (3 x 4)", "6 (2 x 3)"].
    • Type (string, required): Type of plate (fixed well or matrix). Must be one of: ["Well plate", "Matrix plate"].
    • Container schema (string): Container schema for each well in the plate. May be omitted.
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings.
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Category", "Inventory"].
        • Definition: Name of target object if Type is a one of the link types.
          • Any of
            • string: Must be one of: ["Any Entity", "Custom Entity", "AA Sequence", "DNA Sequence", "Molecule", "Mixture", "Any inventory"].
            • string
    • API ID (string): API ID for the entity schema created during an export operation. This is ignored for import operations.
• Location_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the location schema.
    • Name (string, required): Location schema name.
    • System name (string): Internal system name. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the location schema. This is not saved to Benchling.
    • Notify (string): Causes the supplied message to be printed to the output during an import operation. Use this to tell the user to take some manual action.
    • Prefix (string, required): The registry ID prefix. Must match pattern: ^[a-zA-Z0-9_.-]*[a-zA-Z_.-]?$ (Test).
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings.
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Category", "Inventory"].
        • Definition: Name of target object if Type is a one of the link types.
          • Any of
            • string: Must be one of: ["Any Entity", "Custom Entity", "AA Sequence", "DNA Sequence", "Molecule", "Mixture", "Any inventory"].
            • string
    • API ID (string): API ID for the entity schema created during an export operation. This is ignored for import operations.
• Result_schemas (array): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Length must be at least 0. Items must be unique.
  • Items (object): Complete description of the result schema.
    • Name (string, required): Result schema name.
    • Warehouse name (string): DEPRECATED - Use ‘System name’ instead. Internal system name. Default will be an automatic conversion of Name to a Benchlinng/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
    • Description (string): Documentation for the entity. This is not saved to Benchling.
    • Diagram (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited.
      • Group (string): The layout group name.
      • Color (string): Object color. Will override default if specified. May be a hex web color (e.g., ‘#0000FF’ for blue) or certain well-known names are recognized.
      • X (integer): X location coordinate.
      • Y (integer): Y location coordinate.
    • Fields (array): Metadata fields. Length must be at least 0. Items must be unique.
      • Items (object): Metadata field definitions.
        • Name (string, required): Field name.
        • Description (string): Documentation for the field. This is not saved to Benchling.
        • Tool tip (string): Field tool tip appears on hover on column headings.
        • Warehouse name (string): DEPRECATED - Use ‘System name’ instead. Internal system name. Default will be an automatic conversion of Name to a Benchlinng/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • System name (string): Internal system name for the field. Default will be an automatic conversion of Name to a Benchling/PostgreSQL compatible name. Must match pattern: ^[a-z_][a-z0-9_]{0,62}$ (Test).
        • Required (boolean): Field is required when true.
        • Multi-select (boolean): Field is a multi-select field when true.
        • Type (string, required): Data type for the field. Must be one of: ["Date", "Datetime", "Decimal", "Integer", "Long text", "Dropdown", "Text", "Attachment", "Entry", "Entity", "Category", "Part", "Inventory", "JSON", "Boolean", "ft_assay_result_link", "Run"].
        • Definition (string): Name of target object if Type is a one of the link types. May optionally point to a dropdown if type is Integer or Decimal.
        • Snapshot (object): Describes the snapshot computation if this is a snapshot computed field.
          • Formula: Name of formula using native Benchling tokens for now. TODO-For now, leave the items for arguments unspecified until this matures more. Add filters and other features. Must be one of: ["UNSUPPORTED_FORMULA", "identity_fn"].
          • Arguments (object, required): Formula arguments. These are dependent on the particular formula.
            • Steps (array): Lookup steps. Currently supports a list of 2 field values. First must be an entity field in the current schema. Second must be a field on the schema pointed to by step 1. Length must be equal to 2.
              • Items (string)
    • API ID (string): API ID for the entity created during an export operation. This is ignored for import operations.
• Feature_flags (object): © 2025 Go2 Software LLC. Licensed under the Open Data Commons Attribution License (ODC-By). ‘Kenfigure’ is a trademark of Go2 Software LLC. Unauthorized use is prohibited. Can contain additional properties.
  • Additional properties (object): Can contain additional properties.
    • Additional properties (object): Cannot contain additional properties.
      • Current ([‘string’, ‘boolean’], required)
      • Default ([‘string’, ‘boolean’], required)
      • Description ([‘string’, ‘boolean’], required)
      • Planned ([‘string’, ‘boolean’])