BEbenchling
Study Schema

Get StudySchema by ID

Get a single StudySchema by ID.

get/api/v3/study-schema/{study_schema_id}

Request

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

Path parameters

study_schema_idstring required

ID of the StudySchema.

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.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
descriptionstring

A description of this study schema for documentation purposes.

entryTemplatesstring uri
fieldDefinitionsstring uri
idstring
idGenerationMode'AUTO_GENERATED_FROM_PREFIX' | 'MANUAL'

How Study IDs are assigned for studies of this schema.

isDesignApprovalRequiredboolean
modifiedAtstring datetime nullable
namestring
prefixstring nullable
studyType'CUSTOM' | 'PROCESS_DEVELOPMENT' | 'ASSAY_DEVELOPMENT' | 'CLINICAL' | 'PRECLINICAL'

Changes

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