BEbenchling
Protein Schema

Get ProteinSchema by ID

Get a single ProteinSchema by ID.

get/api/v3/protein-schema/{protein_schema_id}

Request

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

Path parameters

protein_schema_idstring required

ID of the ProteinSchema.

Query parameters

returningstring[]

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

omitstring[]

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

Headers

EARLY-ACCESSstring

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

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
availableRegistrationNamingOptionsProteinSchemaAvailableRegistrationNamingOptionsItems[]
containableType'NONE' | 'ENTITY' | 'BATCH'
createdAtstring datetime nullable
descriptionstring
fieldDefinitionsstring uri
fieldsetsstring uri
iconId'ANTIBODY' | 'BASIC_FOLDER_ITEM'
idstring
includeRegistryIdInChipsboolean
itemIdPrefixstring
modifiedAtstring datetime
namestring
systemNamestring
useRegistryIdForItemDisplayLabelboolean
validationRulesstring uri

Changes

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