BEbenchling
Test Order

Update TestOrder

Update an existing Test Order.

Available updates

  • containerId: Set a container, omit the field to leave it unchanged, or provide null to remove the association.
  • status: Transitions must follow the Test Order lifecycle: PENDING → IN_PROGRESS, CANCELLED, or BLOCKED; IN_PROGRESS → COMPLETED or INVALID; and BLOCKED → PENDING or CANCELLED.
patch/api/v3/test-order/{test_order_id}

Request

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

Path parameters

test_order_idstring required

ID of the TestOrder.

Request body

containerIdstring nullable

Omit to leave unchanged, or provide null to remove the container association.

status'PENDING' | 'BLOCKED' | 'IN_PROGRESS' | 'CANCELLED' | 'INVALID' | 'COMPLETED'

Status changes must follow the permitted Test Order lifecycle transitions.

Response

OK

__typenamestring
analysisCommentstring nullable

Additional comments provided for a test order with a status of blocked, invalid, or canceled.

createdAtstring datetime

Timestamp of when the test order was created.

dilutionFactorinteger nullable

The dilution factor of the test order.

idstring

The ID of the test order.

modifiedAtstring datetime

Timestamp of when the test order was last modified.

namestring

The name of the test order.

status'PENDING' | 'BLOCKED' | 'IN_PROGRESS' | 'CANCELLED' | 'INVALID' | 'COMPLETED'

The status of the test order.

Changes

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