Get ProteinSchema by ID

Beta

GET

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

GET

/api/v3/protein-schema/:protein_schema_id

curl https://{tenant_name}.benchling.com/api/v3/protein-schema/protein_schema_id \
     -H "Authorization: Bearer <token>"

{
  "__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"
}

Get a single ProteinSchema by ID.

Authentication

AuthorizationBearer

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

Path parameters

protein_schema_idstringRequired

ID of the ProteinSchema.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

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 Get Request Bad Request Error

403

Protein Schema Get Request Forbidden Error

404

Protein Schema Get Request Not Found Error

429

Protein Schema Get Request Too Many Requests Error

500

Protein Schema Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors