Update DnaSequenceSchema
Update a DNA sequence schema. Only supplied fields change.
Naming and identifiers
- Schema
name(display name) uniqueness within the organization is case-sensitive. systemNamemust be unique within the organization across all schema families (warehouse SQL identifiers share one namespace per organization).itemIdPrefixvalidation rules are described on that field.
Archiving
- When archiving,
archiveReasonmust be one of the archive purposes allowed for this schema type. Allowed values are not a fixed OpenAPI enum; they depend on tenant configuration and how the schema is classified in the archive system.
Constraints
- Configuring a constraint requires a registry with strict validation enabled.
Sub-resource listings
GET …/field-definitions/items,GET …/fieldsets/items, andGET …/validation-rules/itemsreturn unpaginated lists.pageSizeand unknown query parameters are ignored.
Responses
- OpenAPI documents
409 Conflicton many operations, but these endpoints do not return409.
Name templates
nameTemplateis accepted on update only (not on create). When settingnameTemplate,shouldOrderPartsBySequenceis required. For amino acid sequence schemas,shouldOrderPartsBySequencemust befalse.
Validation rules
- Manage validation rules with
:create-validation-rule,:update-validation-rule, and thevalidation-rules/itemslisting.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
Why it is being archived. Required when archived is true, and not allowed when unarchiving.
Set to true to archive or false to unarchive it. Archiving requires archiveReason.
Updated uniqueness constraint configured directly on this schema. Replaces the entire constraint object: omitting fieldDefinitionNames clears field-based uniqueness, and omitting uniqueResidues clears residue-based uniqueness. Set to null to clear a directly configured constraint. Schemas that inherit a constraint from an applied fieldset cannot clear uniqueness via this field; manage inherited constraints on the fieldset instead. Omit to leave the existing directly configured constraint unchanged. Requires a registry with strict validation enabled when setting a non-null constraint.
Updated icon displayed in the UI for entities registered from this schema. Optional; when omitted, the existing value is unchanged.
Prefix used for registry IDs (entityRegistryId) of entities registered from this schema.
Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.
Replaces all existing entity name template parts. Legacy datetimeFormat configurations are not preserved. Updating the name template does not automatically modify availableRegistrationNamingOptions — update that field separately if needed.
Reason for change applied to the entire request. Only relevant to tenants with Data Modifications enabled, where it may be required to update or delete items and is validated against the tenant’s configured reasons. Tenants without Data Modifications enabled can omit it; if supplied, it is not validated.
Updated setting for whether DNA residues are displayed in the UI. Optional; when omitted, the existing value is unchanged.
Updated SQL identifier for the warehouse table name. When provided, 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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema’s exact current system name always succeeds.
Response
Prefix used for registry IDs (entityRegistryId) of entities registered from this schema.