Skip to navigation
Benchling APIAa Sequence Schema

Remove a fieldset from the schema

Beta
Remove a fieldset from the schema

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.
fieldsetIdstringRequired
The API ID of the fieldset to remove from the schema. The fieldset must exist and be accessible.
schemaPrefixReplacementstringOptional
If and only if the fieldset being removed sets the schema's prefix, this field must be present to provide a replacement prefix. It is an error to supply this field if the fieldset being removed does not have a prefix.

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 Remove Fieldset Request Bad Request Error
403
Aa Sequence Schema Remove Fieldset Request Forbidden Error
404
Aa Sequence Schema Remove Fieldset Request Not Found Error
409
Aa Sequence Schema Remove Fieldset Request Conflict Error
429
Aa Sequence Schema Remove Fieldset Request Too Many Requests Error
500
Aa Sequence Schema Remove Fieldset Request Internal Server Error