Skip to navigation

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.
  • systemName must be unique within the organization across all schema families (warehouse SQL identifiers share one namespace per organization).
  • itemIdPrefix validation rules are described on that field.

Archiving

  • When archiving, archiveReason must 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, and GET …/validation-rules/items return unpaginated lists. pageSize and unknown query parameters are ignored.

Responses

  • OpenAPI documents 409 Conflict on many operations, but these endpoints do not return 409.

Name templates

  • nameTemplate is accepted on update only (not on create). When setting nameTemplate, shouldOrderPartsBySequence is required. For amino acid sequence schemas, shouldOrderPartsBySequence must be false.

Validation rules

  • Manage validation rules with :create-validation-rule, :update-validation-rule, and the validation-rules/items listing.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

dna_sequence_schema_idstringRequired
ID of the DnaSequenceSchema.

Request

This endpoint expects an object.
archiveReasonstringOptional

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedbooleanOptional

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

availableRegistrationNamingOptionslist of enumsOptional
constraintobject or nullOptional

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.

containerNameTemplateobject or nullOptional
Replaces all existing container name template parts. Legacy datetimeFormat configurations are not preserved.
descriptionstringOptional
Updated description. When provided, must be at most 1000 characters.
iconIdenumOptional

Updated icon displayed in the UI for entities registered from this schema. Optional; when omitted, the existing value is unchanged.

includeRegistryIdInChipsbooleanOptional
isContainablebooleanOptional
itemIdPrefixstringOptional

Prefix used for registry IDs (entityRegistryId) of entities registered from this schema.

namestringOptional

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

nameTemplateobject or nullOptional

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.

reasonForChangeobjectOptional

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.

showResiduesbooleanOptional

Updated setting for whether DNA residues are displayed in the UI. Optional; when omitted, the existing value is unchanged.

systemCategorieslist of objectsOptional
systemNamestringOptional

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.

useRegistryIdForItemDisplayLabelbooleanOptional
displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
availableRegistrationNamingOptionslist of enumsOptional
constraintobject or nullOptional
Uniqueness constraint applied to entities registered from this schema. Null when no uniqueness constraint is configured.
containableTypeenumOptional
Allowed values:
containerNameTemplateobject or nullOptional
A name template for containers.
createdAtstringOptionalformat: "datetime"
descriptionstringOptional
fieldDefinitionsstringOptionalformat: "uri"
Field definitions configured on this schema.
fieldsetsstringOptionalformat: "uri"
iconIdenumOptional
Icon displayed in the UI for entities registered from this schema.
idstringOptional
includeRegistryIdInChipsbooleanOptional
itemIdPrefixstringOptional

Prefix used for registry IDs (entityRegistryId) of entities registered from this schema.

modifiedAtstringOptionalformat: "datetime"
namestringOptional
nameTemplateobject or nullOptional
A name template for entities.
organizationobjectOptional
showResiduesbooleanOptional
Controls whether DNA residues are displayed in the UI.
systemCategorieslist of objectsOptional
systemNamestringOptional
useRegistryIdForItemDisplayLabelbooleanOptional
validationRulesstringOptionalformat: "uri"

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error