Skip to navigation
Benchling APIAa Sequence Schema

Update AaSequenceSchema

Beta
Update AaSequenceSchema.

Authentication

AuthorizationBearer

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

Path parameters

aa_sequence_schema_idstringRequired
ID of the AaSequenceSchema.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
archiveReasonstringOptional
archivedbooleanOptional
availableRegistrationNamingOptionslist of enumsOptional
constraintobject or nullOptional
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
Allowed values:
includeRegistryIdInChipsbooleanOptional
isContainablebooleanOptional
itemIdPrefixstringOptional
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.

showResiduesbooleanOptional
Controls whether amino acid residues are displayed in the UI.
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.

useRegistryIdForItemDisplayLabelbooleanOptional
displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
availableRegistrationNamingOptionslist of enumsOptional
constraintobject or nullOptional

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.

containableTypeenumOptional
Allowed values:
containerNameTemplateobject or nullOptional
A name template for containers.
createdAtstring or nullOptional
descriptionstringOptional
fieldDefinitionsstringOptionalformat: "uri"

The field definitions configured on this schema. Supported types include:

  • Legacy: BaseFieldDefinition, SchemaLinkFieldDefinition

  • Primitive: TextFieldDefinition, LongTextFieldDefinition, IntegerFieldDefinition, DecimalFieldDefinition, BooleanFieldDefinition, DateFieldDefinition, DateTimeFieldDefinition

  • Dropdown: DropdownLinkFieldDefinition

  • Attachment: AttachmentLinkFieldDefinition

  • Entity links: AnyEntityLinkFieldDefinition, CustomEntityLinkFieldDefinition, AaSequenceLinkFieldDefinition, DnaSequenceLinkFieldDefinition, MixtureLinkFieldDefinition, MoleculeLinkFieldDefinition, ProteinLinkFieldDefinition, OligoConjugateLinkFieldDefinition, OligoDuplexLinkFieldDefinition, DnaOligoLinkFieldDefinition, RnaOligoLinkFieldDefinition

  • Storage: StorableLinkFieldDefinition

  • Assay links: RequestLinkFieldDefinition, ResultLinkFieldDefinition, RunLinkFieldDefinition

  • Part links: AaPartLinkFieldDefinition

JsonFieldDefinition is not supported.

fieldsetsstringOptionalformat: "uri"
iconIdenumOptional
Allowed values:
idstringOptional
includeRegistryIdInChipsbooleanOptional
itemIdPrefixstringOptional
modifiedAtstringOptional
namestringOptional
nameTemplateobject or nullOptional
A name template for entities.
organizationobjectOptional
showResiduesbooleanOptional
Controls whether amino acid residues are displayed in the UI.
systemCategorieslist of objectsOptional
systemNamestringOptional
useRegistryIdForItemDisplayLabelbooleanOptional
validationRulesstringOptionalformat: "uri"

Errors

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