BEbenchling
Study Schema

Create StudySchema

Create a study schema.

ID generation

  • For AUTO_GENERATED_FROM_PREFIX, provide a non-empty, unique prefix. New studies receive IDs generated from that prefix.
  • For MANUAL, omit prefix or provide an empty value. Callers must provide IDs when creating studies with this schema.

Study-type restrictions

  • entryTemplateIds associates entry templates with the schema and is supported only for CUSTOM study schemas. Provide at most 50 IDs.
  • isDesignApprovalRequired is supported for CUSTOM schemas and, when design review is enabled for the tenant, for CLINICAL and PRECLINICAL schemas. It is not supported for PROCESS_DEVELOPMENT or ASSAY_DEVELOPMENT schemas.
post/api/v3/study-schema

Request

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

Request body

descriptionstring required

A human-readable description of the schema. At most 1000 characters.

displayNamestring

Deprecated. Use name instead.

entryTemplateIdsstring[]

Entry template IDs associated with this schema.

idGenerationMode'AUTO_GENERATED_FROM_PREFIX' | 'MANUAL' required

How study IDs are assigned for studies created from this schema. AUTO_GENERATED_FROM_PREFIX requires a non-empty prefix and does not accept a caller-provided ID. MANUAL requires an empty prefix. A study ID may be provided at creation, and if omitted the server generates one.

isDesignApprovalRequiredboolean

Whether design approval is required for studies of this schema.

namestring

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

prefixstring

ID prefix for studies of this schema.

studyType'CUSTOM' | 'PROCESS_DEVELOPMENT' | 'ASSAY_DEVELOPMENT' | 'CLINICAL' | 'PRECLINICAL' required

Type of studies created from this schema.

systemNamestring

The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization.

Response

Created

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