BEbenchling
AA Sequence Schema

Remove a fieldset from the schema

Remove a fieldset from the schema

post/api/v3/aa-sequence-schema/{aa_sequence_schema_id}:remove-fieldset

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

aa_sequence_schema_idstring required

ID of the AaSequenceSchema.

Headers

EARLY-ACCESSstring

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

Request body

fieldsetIdstring required

The API ID of the fieldset to remove from the schema. The fieldset must exist and be accessible.

schemaPrefixReplacementstring

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

__typenamestring
archiveReasonstring nullable
archivedboolean
availableRegistrationNamingOptionsAaSequenceSchemaAvailableRegistrationNamingOptionsItems[]
containableType'NONE' | 'ENTITY' | 'BATCH'
createdAtstring datetime
descriptionstring
fieldDefinitionsstring uri

Field definitions configured on this schema.

fieldsetsstring uri
iconId'ANTIBODY' | 'BASIC_FOLDER_ITEM' | 'LINEAR' | 'PROTEIN'

Icon displayed in the UI for entities registered from this schema.

idstring
includeRegistryIdInChipsboolean
itemIdPrefixstring

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

modifiedAtstring datetime
namestring
showResiduesboolean

Controls whether amino acid residues are displayed in the UI.

systemNamestring
useRegistryIdForItemDisplayLabelboolean
validationRulesstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.