BEbenchling
Custom Entity Schema

Get CustomEntitySchema by ID

Get a single CustomEntitySchema by ID.

get/api/v3/custom-entity-schema/{custom_entity_schema_id}

Request

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

Path parameters

custom_entity_schema_idstring required

ID of the CustomEntitySchema.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__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.