BEbenchling
Study 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 can be changed only when warehouse table-name changes are enabled for the caller; otherwise, a request that changes it fails with a validation error. Supplying the schema's exact current systemName always succeeds.
patch/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.

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

descriptionstring

Updated description. When provided, must be at most 1000 characters.

displayNamestring

Deprecated. Use name instead.

entryTemplateIdsstring[]

Replacement entry template IDs for this schema.

idGenerationMode'AUTO_GENERATED_FROM_PREFIX' | 'MANUAL'

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.

isDesignApprovalRequiredboolean

Updated design approval requirement.

namestring

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

prefixstring

Updated ID prefix for this schema.

systemNamestring

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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.

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.