BEbenchling
Test Definition

Create TestDefinition

Create a Test Definition that can be referenced by Test Orders and assay workflows.

Required fields

FieldDescription
nameDisplay name. Names are trimmed and must be unique within organizationId.
organizationIdOwning organization. Use GET /benchling/organization/items to find organization IDs.
resultSchemaIdResult schema that defines the measurements captured by this test. Use GET /benchling/result-schema/items to find result schema IDs.
descriptionHuman-readable description. Empty strings are allowed.

Notes

  • The creator is set automatically from the authenticated user or app.
  • The caller must have admin access to the organization and read access to the result schema.
  • name and description must each be at most 255 characters.
post/api/v3/test-definition

Request

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

Headers

EARLY-ACCESSstring

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

Request body

descriptionstring required

Human-readable description for the test definition. Empty strings are allowed; values must be at most 255 characters.

namestring required

Display name for the test definition. Must be non-empty after trimming whitespace and unique within the organization.

organizationIdstring required

The API ID of the organization that owns the test definition.

resultSchemaIdstring required

The API ID of the result schema that defines the shape of results captured for this test.

Response

Created

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime

Timestamp of when the test definition was created.

descriptionstring

The description of the test definition. Empty strings are allowed.

idstring

The ID of the test definition.

modifiedAtstring datetime

Timestamp of when the test definition was last modified.

namestring

The name of the test definition.

Changes

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