BEbenchling
Test Definition

Update TestDefinition

Update an existing Test Definition.

Updatable fields

FieldDescription
nameNew display name. Names are trimmed and must be unique within the organization.
organizationIdNew owning organization. Use GET /benchling/organization/items to find organization IDs.
resultSchemaIdNew result schema. Use GET /benchling/result-schema/items to find result schema IDs.
descriptionNew description. Empty strings are allowed.
archived, archiveReason, archiveUserIdArchive or unarchive the test definition.

Constraints

  • The caller must have read access to the result schema.
  • Moving the Test Definition to a different organization requires admin access to the target organization. Re-specifying the current organization only requires read access to it.
  • resultSchemaId cannot be changed after any Test Orders exist for the Test Definition.
  • Archiving fails if the Test Definition has pending, in-progress, or blocked Test Orders.
  • Archiving also fails while the Test Definition is associated with an unarchived assay.
  • archiveSubtreeId and legacyArchiveRecordId are legacy archival fields and should normally be omitted.
patch/api/v3/test-definition/{test_definition_id}

Request

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

Path parameters

test_definition_idstring required

ID of the TestDefinition.

Headers

EARLY-ACCESSstring

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

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

descriptionstring

Updated human-readable description. Empty strings are allowed; values must be at most 255 characters.

namestring

Updated display name. When provided, it is trimmed and must be non-empty and unique within the organization.

organizationIdstring

Updated owning organization. Moving to a different organization requires admin access to that organization.

resultSchemaIdstring

Updated result schema. Cannot be changed after test orders have been created for this test definition.

Response

OK

__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.