Skip to navigation
Benchling APIStudy 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
descriptionstringRequired

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

idGenerationModeenumRequired

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.

Allowed values:
organizationIdstringRequired
The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.
studyTypeenumRequired
Type of studies created from this schema.
Allowed values:
entryTemplateIdslist of stringsOptional
Entry template IDs associated with this schema.
fieldDefinitionslist of objectsOptional
Field definitions for this schema.
isDesignApprovalRequiredbooleanOptional
Whether design approval is required for studies of this schema.
namestringOptional

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

prefixstringOptional
ID prefix for studies of this schema.
systemNamestringOptional

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.

displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstring or nullOptional
creatorobjectOptional
descriptionstringOptional
A description of this study schema for documentation purposes.
entryTemplatesstringOptionalformat: "uri"
fieldDefinitionsstringOptionalformat: "uri"
idstringOptional
idGenerationModeenumOptional
How Study IDs are assigned for studies of this schema.
Allowed values:
isDesignApprovalRequiredbooleanOptional
modifiedAtstring or nullOptional
namestringOptional
organizationobjectOptional
prefixstring or nullOptional
studyTypeenumOptional
Allowed values:

Errors

400
Study Schema Create Request Bad Request Error
403
Study Schema Create Request Forbidden Error
404
Study Schema Create Request Not Found Error
409
Study Schema Create Request Conflict Error
429
Study Schema Create Request Too Many Requests Error
500
Study Schema Create Request Internal Server Error