Skip to navigation
Benchling APIStudy Schema

Update StudySchema

Update a study schema. Only the supplied fields are changed; studyType cannot be changed after creation.

ID generation

  • Changing idGenerationMode or prefix affects only studies created after this update; existing study IDs do not change.
  • When changing to AUTO_GENERATED_FROM_PREFIX, provide a non-empty, unique prefix. Numbering continues from the highest existing study ID that uses the prefix.
  • When changing to MANUAL, the prefix is cleared.

Restrictions

  • When provided, entryTemplateIds replaces all existing entry-template associations. It 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.
  • systemName is updated only when warehouse table-name changes are enabled for the caller; otherwise, a supplied value is ignored.

Authentication

AuthorizationBearer

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

Path parameters

study_schema_idstringRequired
ID of the StudySchema.

Request

This endpoint expects an object.
archiveReasonstringOptional
archivedbooleanOptional
descriptionstringOptional
Updated description. When provided, must be at most 1000 characters.
entryTemplateIdslist of stringsOptional
Replacement entry template IDs for this schema.
idGenerationModeenumOptional

Updated study ID generation mode. Changing this setting only affects studies created from now on; existing studies keep their IDs. When switching to AUTO_GENERATED_FROM_PREFIX, numbering continues from the highest existing ID that uses the prefix. When switching to MANUAL, the prefix is automatically cleared if no prefix value is provided.

Allowed values:
isDesignApprovalRequiredbooleanOptional
Updated design approval requirement.
namestringOptional

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

prefixstringOptional
Updated ID prefix for this schema.
systemNamestringOptional

Updated SQL identifier for the warehouse table name. When provided, 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

OK
__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 Update Request Bad Request Error
403
Study Schema Update Request Forbidden Error
404
Study Schema Update Request Not Found Error
409
Study Schema Update Request Conflict Error
429
Study Schema Update Request Too Many Requests Error
500
Study Schema Update Request Internal Server Error