Skip to navigation
Benchling APICustom Entity Schema

Create CustomEntitySchema

Create CustomEntitySchema.

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.

itemIdPrefixstringRequired
organizationIdstringRequired
The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.
availableRegistrationNamingOptionslist of enumsOptional
constraintobjectOptional
fieldDefinitionslist of objectsOptional
fieldsetslist of stringsOptional
iconIdenumOptional
includeRegistryIdInChipsbooleanOptional
isContainablebooleanOptional
namestringOptional

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

systemCategorieslist of objectsOptional
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.

useRegistryIdForItemDisplayLabelbooleanOptional
displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
availableRegistrationNamingOptionslist of enumsOptional
constraintobject or nullOptional

Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see fieldDefinitionNames) or unique domain-specific properties (see TypeSpecificConstraint). The hasUniqueResidues field is a legacy indicator for sequence uniqueness.

containableTypeenumOptional
Allowed values:
containerNameTemplateobject or nullOptional
A name template for containers.
createdAtstring or nullOptional
descriptionstringOptional
fieldDefinitionsstringOptionalformat: "uri"
fieldsetsstringOptionalformat: "uri"
iconIdenumOptional
idstringOptional
includeRegistryIdInChipsbooleanOptional
itemIdPrefixstringOptional
modifiedAtstringOptional
namestringOptional
nameTemplateobject or nullOptional
A name template for entities.
organizationobjectOptional
systemCategorieslist of objectsOptional
systemNamestringOptional
useRegistryIdForItemDisplayLabelbooleanOptional
validationRulesstringOptionalformat: "uri"

Errors

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