Result Schema

Create ResultSchema

Create ResultSchema.

post/api/v3/result-schema

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Request body

namestring

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

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

systemNamestring

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

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
fieldDefinitionsstring uri

Defines the metadata fields for results belonging to this schema

idstring
modifiedAtstring datetime nullable

DateTime the Result Schema was last modified

namestring
systemNamestring

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

Changes

No recorded changes to this operation across all 1 revision of this API.