BEbenchling
AA Sequence Schema

Get AaSequenceSchema by ID

Get a single AaSequenceSchema by ID.

get/api/v3/aa-sequence-schema/{aa_sequence_schema_id}

Request

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

Path parameters

aa_sequence_schema_idstring required

ID of the AaSequenceSchema.

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
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.