BEbenchling
Entry Schema

Get EntrySchema by ID

Get a single EntrySchema by ID.

get/api/v3/entry-schema/{entry_schema_id}

Request

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

Path parameters

entry_schema_idstring required

ID of the EntrySchema.

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
createdAtstring datetime nullable
descriptionstring
fieldDefinitionsstring uri
iconIdstring

Use typedIconId instead, which provides enum validation.

idstring
itemIdPrefixstring
modifiedAtstring datetime
namestring
systemNamestring
typedIconId'ENTRY'

Changes

No recorded changes to this operation across all 2 revisions of this API.