Entity Schema

Get EntitySchema by ID

Get a single EntitySchema by ID.

get/api/v3/entity-schema/{entity_schema_id}

Request

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

Path parameters

entity_schema_idstring required

ID of the EntitySchema.

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

Reason the EntitySchema was archived

archivedboolean

If the EntitySchema is archived

availableRegistrationNamingOptionsEntitySchemaAvailableRegistrationNamingOptionsItems[]

Naming strategies allowed when registering entities of this schema

containableType'NONE' | 'ENTITY' | 'BATCH'
createdAtstring datetime nullable
descriptionstring
fieldDefinitionsstring uri
idstring
modifiedAtstring datetime

DateTime the Entity Schema was last modified

namestring
prefixstring
typestring
validationRulesstring uri

Changes

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