Skip to navigation
Benchling APIEntry Schema

Create EntrySchema

Beta
Create EntrySchema.

Authentication

AuthorizationBearer

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

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

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.
fieldDefinitionslist of objectsOptional
namestringOptional

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

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
descriptionstringOptional
fieldDefinitionsstringOptionalformat: "uri"
idstringOptional
itemIdPrefixstringOptional
modifiedAtstringOptional
namestringOptional
organizationobjectOptional
systemNamestringOptional
typedIconIdenumOptional
Allowed values:
iconIdstringOptionalDeprecated
Use typedIconId instead, which provides enum validation.

Errors

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