BEbenchling
Test Order

Create TestOrder

Create a Test Order for a trial sample using a Test Definition in a published assay procedure. New Test Orders start with the PENDING or BLOCKED status when a discrepancy is detected on the sample or container.

Required fields

FieldDescription
testDefinitionIdTest Definition to perform.
sampleIdUnarchived trial sample entity.
procedureIdPublished assay procedure.

Constraints

  • The Procedure must be an ASSAY, have a published version, and include testDefinitionId in its published configuration.
  • testDefinitionId and containerId, when present, must reference unarchived objects.
  • If studyIds is provided, every Study must already be associated with sampleId.
  • When the Procedure configures allowed dilution factors for this Test Definition, dilutionFactor is required and must be one of them. Otherwise, omit it.

Optional references

  • containerId identifies the sample container.
  • studyIds associates the test order with existing studies.
post/api/v3/test-order

Request

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

Request body

containerIdstring nullable

Optional API ID of the container holding the sample. The container must not be archive and must contain the sample.

dilutionFactorinteger nullable

Optional positive dilution factor. When the selected procedure includes specifies allowed dilution factors for this Test Definition, this value is required and must be one of its configured allowed factors.

procedureIdstring required

The API ID of the assayprocedure to perform the test.

sampleIdstring required

The API ID of the trial sample entity to test. The sample must not be archived and must use a trial sample schema.

studyIdsstring[]

ID of the study to create the test order in, as a single-item list. The sample must be associated with the study, and the study's sample test plan must include the procedure for the sample's sample definition.

testDefinitionIdstring required

The API ID of the test definition to perform.

Response

Created

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