Skip to navigation
Benchling APIResult Schema

Create ResultSchema

Beta
Create ResultSchema.

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.
organizationIdstringRequired
The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.
fieldDefinitionslist of objectsOptional
Defines the metadata fields for results belonging to 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.

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.

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstring or nullOptional
fieldDefinitionsstringOptionalformat: "uri"
Defines the metadata fields for results belonging to this schema
idstringOptional
modifiedAtstring or nullOptional
DateTime the Result Schema was last modified
namestringOptional
organizationobject or nullOptional
The organization that owns the schema
systemNamestringOptional

The unique, machine-readable identifier for warehouse and API access.

Errors

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