Remove a fieldset from the schema

Beta

POST

https://{tenant_name}.benchling.com/api/v3/protein-schema/:protein_schema_id:remove-fieldset

POST

/api/v3/protein-schema/:protein_schema_id:remove-fieldset

curl -X POST https://{tenant_name}.benchling.com/api/v3/protein-schema/protein_schema_id:remove-fieldset \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "fieldsetId": "fieldsetId"
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "availableRegistrationNamingOptions": [
    "NEW_IDS"
  ],
  "chainLinkedSchemas": [
    {
      "__typename": "__typename",
      "label": "label",
      "schemaOrInterfaceId": "schemaOrInterfaceId"
    }
  ],
  "constraint": {
    "__typename": "__typename",
    "fieldDefinitionNames": [
      "fieldDefinitionNames"
    ],
    "hasUniqueResidues": true
  },
  "containableType": "NONE",
  "containerNameTemplate": {
    "__typename": "__typename",
    "parts": [
      {}
    ]
  },
  "createdAt": "createdAt",
  "description": "description",
  "domainLinkedSchemas": [
    {
      "__typename": "__typename",
      "domainType": "VL",
      "schemaOrInterfaceId": "schemaOrInterfaceId",
      "specificity": "specificity"
    }
  ],
  "fieldDefinitions": "fieldDefinitions",
  "fieldsets": "fieldsets",
  "format": {
    "__typename": "__typename",
    "id": "id"
  },
  "iconId": "ANTIBODY",
  "id": "id",
  "includeRegistryIdInChips": true,
  "itemIdPrefix": "itemIdPrefix",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "nameTemplate": {
    "__typename": "__typename",
    "parts": [
      {}
    ],
    "shouldOrderPartsBySequence": true
  },
  "organization": {
    "__typename": "__typename",
    "id": "id"
  },
  "systemCategories": [
    {
      "__typename": "__typename"
    }
  ],
  "systemName": "systemName",
  "useRegistryIdForItemDisplayLabel": true,
  "validationRules": "validationRules"
}

Remove a fieldset from the schema

Authentication

AuthorizationBearer

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

Path parameters

protein_schema_idstringRequired

ID of the ProteinSchema.

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

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

availableRegistrationNamingOptionslist of enumsOptional

chainLinkedSchemaslist of objectsOptional

Schema or interface links for each chain label in the protein format.

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

domainLinkedSchemaslist of objectsOptional

Schema or interface links for each domain type in the protein format.

fieldDefinitionsstringOptionalformat: "uri"

fieldsetsstringOptionalformat: "uri"

formatobjectOptional

The protein format that defines the structure (domains, chains, interactions) for entities of this schema.

iconIdenumOptional

Allowed values:

idstringOptional

includeRegistryIdInChipsbooleanOptional

itemIdPrefixstringOptional

modifiedAtstringOptional

namestringOptional

nameTemplateobject or nullOptional

A name template for entities.

organizationobjectOptional

systemCategorieslist of objectsOptional

systemNamestringOptional

useRegistryIdForItemDisplayLabelbooleanOptional

validationRulesstringOptionalformat: "uri"

Errors

400

Protein Schema Remove Fieldset Request Bad Request Error

403

Protein Schema Remove Fieldset Request Forbidden Error

404

Protein Schema Remove Fieldset Request Not Found Error

409

Protein Schema Remove Fieldset Request Conflict Error

429

Protein Schema Remove Fieldset Request Too Many Requests Error

500

Protein Schema Remove Fieldset Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors