--- title: "Create DnaSequenceSchema" method: POST path: "/api/v3/dna-sequence-schema" tags: ["DNA Sequence Schema"] --- # Create DnaSequenceSchema `POST /api/v3/dna-sequence-schema` ## Request - Base URL: `https://{tenant_name}.benchling.com` - URL: `https://{tenant_name}.benchling.com/api/v3/dna-sequence-schema` - Auth: HTTP bearer Create DnaSequenceSchema. ## Headers - `EARLY-ACCESS` string ## Request body - CreateDnaSequenceSchemaInput - `availableRegistrationNamingOptions` CreateDnaSequenceSchemaInputAvailableRegistrationNamingOptionsItems[]: Naming strategies allowed when registering entities of this schema. Optional; when omitted, defaults to the organization's enabled labeling strategies, then fieldset configuration is applied. - `constraint` CreateSequenceSchemaConstraintInput - `fieldDefinitionNames` string[]: Display names of schema fields whose values are included in the composite uniqueness key together with any configured residue uniqueness (`uniqueResidues`). Required when configuring field-based uniqueness. - `uniqueResidues` 'IGNORE_CASE': When specified, includes the entity's nucleotide residues (case-insensitive) in the composite uniqueness key together with any configured field values (`fieldDefinitionNames`). For nucleotide sequence and oligo schemas, the only supported value is `IGNORE_CASE`. - `description` string, required: A human-readable description of the schema. At most 1000 characters. - `displayName` string: Deprecated. Use name instead. - `fieldDefinitions` CreateDnaSequenceSchemaInputFieldDefinitionsItems[]: Optional field definitions to create on the schema. Each field definition's display name and system name must be unique within the set, and the total number of link fields must not exceed the configured limit. Omit to create the schema with no custom fields beyond fieldsets. Also supports `CreateDnaPartLinkFieldDefinitionInput`, `CreateTranscriptionLinkFieldDefinitionInput`, and `CreateTranslationLinkFieldDefinitionInput`. - union - CreateBooleanFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'BOOLEAN', required - CreateDateFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DATE', required - CreateDateTimeFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DATE_TIME', required - CreateDecimalFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `displayPrecision` integer: The number of decimal places to display (0 to 10). - `isRequired` boolean, required: When true, a value must be provided for this field. - `legalTextDropdownId` string: The API ID of the legal text dropdown associated with this field definition. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `numericMax` number, double: The maximum allowed value, inclusive. - `numericMin` number, double: The minimum allowed value, inclusive. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DECIMAL', required - `unitId` string: The API ID of the unit to associate with this field. - CreateIntegerFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `numericMax` number, double: The maximum allowed value, inclusive. - `numericMin` number, double: The minimum allowed value, inclusive. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'INTEGER', required - `unitId` string: The API ID of the unit to associate with this field. - CreateLongTextFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'LONG_TEXT', required - CreateTextFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'TEXT', required - CreateAaSequenceLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'AA_SEQUENCE_LINK', required - CreateProteinLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'PROTEIN_LINK', required - CreateRequestLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'REQUEST_LINK', required - CreateResultLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'RESULT_LINK', required - CreateRunLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'RUN_LINK', required - CreateAttachmentLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'ATTACHMENT_LINK', required - CreateCustomEntityLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'CUSTOM_ENTITY_LINK', required - CreateDnaOligoLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DNA_OLIGO_LINK', required - CreateDnaSequenceLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DNA_SEQUENCE_LINK', required - CreateDropdownLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `dropdownId` string, required: The API ID of the Dropdown that defines the available options. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DROPDOWN', required - CreateAnyEntityLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'ENTITY_LINK', required - CreateEntryLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'ENTRY_LINK', required - CreateEquipmentLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'EQUIPMENT_LINK', required - CreateFieldsetLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'FIELDSET_LINK', required - CreateMixtureLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'MIXTURE_LINK', required - CreateMoleculeLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'MOLECULE_LINK', required - CreateOligoConjugateLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'OLIGO_CONJUGATE_LINK', required - CreateOligoDuplexLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'OLIGO_DUPLEX_LINK', required - CreateRnaSequenceLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'RNA_SEQUENCE_LINK', required - CreateRnaOligoLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'RNA_OLIGO_LINK', required - CreateStorableLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, nullable, required: The API ID of the schema to constrain links to, or null to allow links to any item of the linked type. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'STORAGE_LINK', required - CreateSystemCategoryLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'SYSTEM_CATEGORY_LINK', required - CreateDnaPartLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: Whether this is a parent-child relationship. Always false for part link types. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'DNA_PART_LINK', required - CreateTranscriptionLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: Whether this is a parent-child relationship. Always false for transcription link types. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'TRANSCRIPTION_LINK', required - CreateTranslationLinkFieldDefinitionInput - `description` string: An optional user-provided description of this field definition. - `isMulti` boolean, required: When true, multiple linked values are allowed. - `isParent` boolean: Whether this is a parent-child relationship. Always false for translation link types. - `isRequired` boolean, required: When true, a value must be provided for this field. - `linkDefinitionId` string, required: The API ID of the schema/interface that linked items must belong to. - `name` string, required: The user-facing display name of this field definition. Must be unique within the schema. - `systemName` string, required: The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `type` 'TRANSLATION_LINK', required - `fieldsets` string[]: API IDs of fieldsets to apply to the schema at creation. Optional. Fieldset-provided fields and configuration are merged into the schema. - `iconId` 'BASIC_FOLDER_ITEM' | 'LINEAR' | 'OLIGO_V2' | 'PLASMID' | 'PRIMER_PAIR' | 'RNA_SEQUENCE' | 'SEQUENCE': Icon displayed in the UI for entities registered from this schema. Optional; when omitted, defaults to SEQUENCE. - `includeRegistryIdInChips` boolean: Whether registry IDs appear in UI chips for entities of this schema. Optional; when omitted, defaults to false. - `isContainable` boolean: Whether entities of this schema can be placed in inventory containers. Optional; when omitted, defaults to false. - `itemIdPrefix` string, required: Prefix used for registry IDs (`entityRegistryId`) of entities registered from this schema. Required when no prefix-providing fieldset is applied in `fieldsets`. When set directly, must be unique within the organization after normalization. An applied fieldset that provides a prefix takes precedence and this value is not used for prefix-uniqueness validation. - `name` string: The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization. - `organizationId` string, required: The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller. - `showResidues` boolean, required: Whether DNA residues are displayed in the UI for entities registered from this schema. - `systemCategories` SystemCategoryConfigurationInputBase[]: Configuration for non-exclusive static schema interfaces (system categories) implemented by this schema. Optional; when omitted, no system categories are configured. - union - object: ssi_aachain variant - `systemCategoryId` 'ssi_aachain', required: Discriminator value: ssi_aachain - object: ssi_aadomain variant - `systemCategoryId` 'ssi_aadomain', required: Discriminator value: ssi_aadomain - object: ssi_aapair variant - `systemCategoryId` 'ssi_aapair', required: Discriminator value: ssi_aapair - object: ssi_aasubelement variant - `systemCategoryId` 'ssi_aasubelement', required: Discriminator value: ssi_aasubelement - object: ssi_antigen variant - `systemCategoryId` 'ssi_antigen', required: Discriminator value: ssi_antigen - object: ssi_dnachain variant - `systemCategoryId` 'ssi_dnachain', required: Discriminator value: ssi_dnachain - object: ssi_dnadomain variant - `systemCategoryId` 'ssi_dnadomain', required: Discriminator value: ssi_dnadomain - object: ssi_dnapair variant - `systemCategoryId` 'ssi_dnapair', required: Discriminator value: ssi_dnapair - object: ssi_dnasubelement variant - `systemCategoryId` 'ssi_dnasubelement', required: Discriminator value: ssi_dnasubelement - object: ssi_expirationtracking variant - `systemCategoryId` 'ssi_expirationtracking', required: Discriminator value: ssi_expirationtracking - object: ssi_freezethawtracking variant - `systemCategoryId` 'ssi_freezethawtracking', required: Discriminator value: ssi_freezethawtracking - `limit` integer - `systemName` string: 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. - `useRegistryIdForItemDisplayLabel` boolean: Whether the registry ID is used as the display label for registered entities. Optional; when omitted, defaults to false. ## Response `201` Created - DnaSequenceSchema: Defines the structure, field definitions, and configuration options for DNA sequences. - `__typename` string - `archiveReason` string, nullable - `archived` boolean - `availableRegistrationNamingOptions` DnaSequenceSchemaAvailableRegistrationNamingOptionsItems[] - `constraint` Constraint: Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see `fieldDefinitionNames`) or unique domain-specific properties (see `TypeSpecificConstraint`). The hasUniqueResidues field is a legacy indicator for sequence uniqueness. - `__typename` string - `fieldDefinitionNames` string[], nullable - `hasUniqueResidues` boolean, nullable - `containableType` 'NONE' | 'ENTITY' | 'BATCH' - `containerNameTemplate` ContainerNameTemplate: A name template for containers. - `__typename` string - `parts` ContainerNameTemplatePart[] - `__typename` string - `configuration` union: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration - object: Configuration for a schema field name template part. - `__typename` string, required - `field` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - object: Configuration for a literal text name template part. - `__typename` string, required - `text` string - `type` 'BARCODE' | 'BARCODE_NUMBER' | 'CHILD_ENTITY_LOT_NUMBER' | 'CONCENTRATION_UNITS' | 'CONCENTRATION_VALUE' | 'CONTAINED_ENTITY_NAME' | 'CONTAINER_CREATED_AT_DATE' | 'CONTAINER_CREATED_AT_YEAR' | 'FIELD' | 'FILL_DATE' | 'FILL_YEAR' | 'HOISTED_FIELD' | 'LINKED_BIOENTITY_REGISTRY_IDENTIFIER' | 'PARENT_STORABLE_BARCODE' | 'PARENT_STORABLE_NAME' | 'POSITION' | 'PROJECT' | 'QUANTITY_UNITS' | 'QUANTITY_VALUE' | 'REGISTRY_IDENTIFIER_NUMBER' | 'REGISTRY_IDENTIFIER_NUMBER_BASE_26' | 'RESTRICTION_STATUS' | 'SAMPLE_LOT_NUMBER' | 'SEPARATOR' | 'TEXT' - `createdAt` string, datetime - `description` string - `fieldDefinitions` string, uri: Field definitions configured on this schema. - `fieldsets` string, uri - `iconId` 'BASIC_FOLDER_ITEM' | 'LINEAR' | 'OLIGO_V2' | 'PLASMID' | 'PRIMER_PAIR' | 'RNA_SEQUENCE' | 'SEQUENCE': Icon displayed in the UI for entities registered from this schema. - `id` string - `includeRegistryIdInChips` boolean - `itemIdPrefix` string: Prefix used for registry IDs (`entityRegistryId`) of entities registered from this schema. - `modifiedAt` string, datetime - `name` string - `nameTemplate` EntityNameTemplate: A name template for entities. - `__typename` string - `parts` EntityNameTemplatePart[] - `__typename` string - `configuration` union: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration, ProteinChainNameTemplatePartConfiguration, ProteinDomainNameTemplatePartConfiguration - object: Configuration for a schema field name template part. - `__typename` string, required - `field` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - object: Configuration for a protein chain name template part. - `__typename` string, required - `proteinChain` ProteinFormatChain: A chain in a protein format, representing the slot where a polypeptide chain can be used in an entity of this format. Chains are uniquely identified by their label in the format. Chains can have multiplicity, meaning there are multiple physical instances of the same chain in a protein of this format. - `__typename` string - `chainPositions` ProteinFormatChainPosition[]: A list of all the chain positions of this chain in the format. - … - `domains` ProteinFormatDomain[]: The domains that compose this chain. - … - `label` string: A human-readable label for the chain, such as 'Heavy' or 'Light 1'. Chains are labeled with an index only when multiple distinct chains of the same type exist. These labels are unique among distinct chains in a format. - `type` 'HEAVY' | 'LIGHT' | 'NONE' | 'ALPHA' | 'BETA' | 'JOINING': The type of the chain. - object: Configuration for a protein domain name template part. - `__typename` string, required - `proteinDomain` ProteinFormatDomain: A domain in a protein format, representing the slot where an amino acid sequence can be used in an entity of this format. Domains are uniquely identified by their label in the format. - `__typename` string - `domainPositions` ProteinFormatDomainPosition[]: A list of all the domain positions of this domain in the format. - … - `label` string: A human-readable label for the domain, uniquely identifying the domain within the format. - `optional` boolean: Whether this domain is optional in the format. If true, entities of this format may not have this domain. - `type` 'VL' | 'CL' | 'VH' | 'VHH' | 'CH1' | 'CH2' | 'CH3' | 'CH4' | 'J' | 'H' | 'L' | 'VA' | 'CA' | 'VB' | 'CB' | 'VG' | 'CG' | 'VD' | 'CD' | 'F' | 'ELEMENT': The type of the domain (e.g., VH, VL, CH1). - object: Configuration for a literal text name template part. - `__typename` string, required - `text` string - `type` 'CHILD_ENTITY_LOT_NUMBER' | 'COMPLEX_POLYMER_COMPONENT' | 'CREATED_AT_DATE' | 'CREATED_AT_YEAR' | 'FIELD' | 'HOISTED_FIELD' | 'LINKED_BIOENTITY_REGISTRY_IDENTIFIER' | 'PROJECT' | 'PROTEIN_CHAIN' | 'PROTEIN_DOMAIN' | 'REGISTRY_IDENTIFIER_NUMBER' | 'REGISTRY_IDENTIFIER_NUMBER_BASE_26' | 'SALT_CODES' | 'SEPARATOR' | 'TEXT' - `shouldOrderPartsBySequence` boolean - `organization` OrganizationRef - `__typename` string - `id` string, api_id - `showResidues` boolean: Controls whether DNA residues are displayed in the UI. - `systemCategories` SystemCategoryConfiguration[] - union - object: Default configuration for system categories that require no additional configuration. - `__typename` 'BaseSystemCategoryConfiguration', required: Discriminator value: BaseSystemCategoryConfiguration - `systemCategory` SystemCategoryRef - `__typename` string - `id` string, api_id - object: Configuration that can be set on entity schemas, which enables enabling freeze/thaw cycle tracking. When enabled, containers holding entities of the schema automatically display a "Freeze/thaw count" system field that tracks how many times the sample has been frozen and thawed. The optional limit field specifies the maximum number of freeze/thaw cycles permitted before the sample is considered unfit for use; exceeding this limit can trigger warnings in inventory workflows. Once enabled on a schema, freeze/thaw tracking cannot be disabled. This feature is commonly used for biologics, enzymes, and other temperature-sensitive samples where repeated freeze/thaw cycles can degrade sample quality. - `__typename` 'FreezeThawTrackingConfiguration', required: Discriminator value: FreezeThawTrackingConfiguration - `limit` integer, nullable: Max number of freeze/thaw cycles a container containing an entity of this schema is permitted to undergo while still being considered fit for use. - `systemCategory` SystemCategoryRef - `__typename` string - `id` string, api_id - `systemName` string - `useRegistryIdForItemDisplayLabel` boolean - `validationRules` string, uri ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `409`: Conflict - `429`: Too Many Requests - `500`: Internal Server Error --- [API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)