BEbenchling
Custom Entity Schema

Create CustomEntitySchema

Create CustomEntitySchema.

post/api/v3/custom-entity-schema

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Request body

availableRegistrationNamingOptionsCreateCustomEntitySchemaInputAvailableRegistrationNamingOptionsItems[]
descriptionstring required

A human-readable description of the schema. At most 1000 characters.

displayNamestring

Deprecated. Use name instead.

fieldsetsstring[]
iconId'ANTIBODY' | 'ARROW_ZIG_ZAG_DOWN' | 'ARROW_ZIG_ZAG_RIGHT' | 'ASSEMBLY' | 'BACTERIA' | 'BASIC_FOLDER_ITEM' | 'BEAKER' | 'BOX_ARROW_RIGHT' | 'BROKEN_COLUMNS_IN_BRACKET' | 'BUILDING_PLUS' | 'CELL_LINE' | 'CHEMICAL_COMPOUND' | 'CHEMICAL_CONCATENATION' | 'CHEMICAL_HOMOLOGY' | 'CHEMICAL_LADDER' | 'CHROMATOGRAPHY' | 'CIRCLE_WITH_THICK_SEGMENT' | 'CLIPBOARD_IN_BRACKETS' | 'COMPOUND' | 'DOCK_BOTTOM' | 'FILE_BAR_CHART' | 'FILE_IN_BRACKETS' | 'FILL_GRID' | 'FLASK' | 'FLASK_RECEIPT' | 'FLOWCHART' | 'GRID_DOTS' | 'HUMAN' | 'INSTRUMENT' | 'LIGHTBULB_IN_BRACKETS' | 'LINEAR' | 'LIST_ASTERISK' | 'LIST_CHECK_XMARK' | 'MATERIAL' | 'MICROSCOPE' | 'MIXTURE' | 'MOLECULE_TO_BACKBONE' | 'MOLECULE_TO_MOLECULE' | 'MORTAR_PESTLE' | 'MOUSE' | 'NETWORK_WIRED' | 'NODES_CONVERGE' | 'OCHEM_MOLECULE' | 'OCHEM_MOLECULE_BEAKER' | 'OLIGO' | 'OLIGO_ALT' | 'OLIGO_V2' | 'PART' | 'PETRI' | 'PLANT' | 'PLASMID' | 'POWDER' | 'POWDER_BEAKER' | 'PRIMER_PAIR' | 'PROCESS' | 'PROTEIN' | 'PROTEIN_ALT' | 'PROTEIN_MAGNIFYING_GLASS' | 'REACTION_VESSEL' | 'RECEIPT_FLASK' | 'RECIPE' | 'REQUEST_TEMPLATE' | 'RNA' | 'RNA_SEQUENCE' | 'SAMPLE_SLIDE' | 'SEQUENCE' | 'SMALL_MOLECULE' | 'SMALL_MOLECULE_BEAKER' | 'SOLUTION' | 'SQUARE_BRACKET_CHECK_EQUALS' | 'TABLE_LIST_ALT' | 'TEMPLATE' | 'TUBE_EMPTY' | 'VIAL' | 'WELL_PLATE' | 'WORKFLOW' | 'WORKSHEET' | 'WORM'
includeRegistryIdInChipsboolean
isContainableboolean
itemIdPrefixstring required
namestring

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

systemNamestring

The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization.

useRegistryIdForItemDisplayLabelboolean

Response

Created

__typenamestring
archiveReasonstring nullable
archivedboolean
availableRegistrationNamingOptionsCustomEntitySchemaAvailableRegistrationNamingOptionsItems[]
containableType'NONE' | 'ENTITY' | 'BATCH'
createdAtstring datetime nullable
descriptionstring
fieldDefinitionsstring uri
fieldsetsstring uri
iconId'ANTIBODY' | 'ARROW_ZIG_ZAG_DOWN' | 'ARROW_ZIG_ZAG_RIGHT' | 'ASSEMBLY' | 'BACTERIA' | 'BASIC_FOLDER_ITEM' | 'BEAKER' | 'BOX_ARROW_RIGHT' | 'BROKEN_COLUMNS_IN_BRACKET' | 'BUILDING_PLUS' | 'CELL_LINE' | 'CHEMICAL_COMPOUND' | 'CHEMICAL_CONCATENATION' | 'CHEMICAL_HOMOLOGY' | 'CHEMICAL_LADDER' | 'CHROMATOGRAPHY' | 'CIRCLE_WITH_THICK_SEGMENT' | 'CLIPBOARD_IN_BRACKETS' | 'COMPOUND' | 'DOCK_BOTTOM' | 'FILE_BAR_CHART' | 'FILE_IN_BRACKETS' | 'FILL_GRID' | 'FLASK' | 'FLASK_RECEIPT' | 'FLOWCHART' | 'GRID_DOTS' | 'HUMAN' | 'INSTRUMENT' | 'LIGHTBULB_IN_BRACKETS' | 'LINEAR' | 'LIST_ASTERISK' | 'LIST_CHECK_XMARK' | 'MATERIAL' | 'MICROSCOPE' | 'MIXTURE' | 'MOLECULE_TO_BACKBONE' | 'MOLECULE_TO_MOLECULE' | 'MORTAR_PESTLE' | 'MOUSE' | 'NETWORK_WIRED' | 'NODES_CONVERGE' | 'OCHEM_MOLECULE' | 'OCHEM_MOLECULE_BEAKER' | 'OLIGO' | 'OLIGO_ALT' | 'OLIGO_V2' | 'PART' | 'PETRI' | 'PLANT' | 'PLASMID' | 'POWDER' | 'POWDER_BEAKER' | 'PRIMER_PAIR' | 'PROCESS' | 'PROTEIN' | 'PROTEIN_ALT' | 'PROTEIN_MAGNIFYING_GLASS' | 'REACTION_VESSEL' | 'RECEIPT_FLASK' | 'RECIPE' | 'REQUEST_TEMPLATE' | 'RNA' | 'RNA_SEQUENCE' | 'SAMPLE_SLIDE' | 'SEQUENCE' | 'SMALL_MOLECULE' | 'SMALL_MOLECULE_BEAKER' | 'SOLUTION' | 'SQUARE_BRACKET_CHECK_EQUALS' | 'TABLE_LIST_ALT' | 'TEMPLATE' | 'TUBE_EMPTY' | 'VIAL' | 'WELL_PLATE' | 'WORKFLOW' | 'WORKSHEET' | 'WORM'
idstring
includeRegistryIdInChipsboolean
itemIdPrefixstring
modifiedAtstring datetime
namestring
systemNamestring
useRegistryIdForItemDisplayLabelboolean
validationRulesstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.