How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchling Test Definition API

A Test Definition is a configuration object that specifies a type of test or assay that can beordered against samples. Each Test Definition is associated with a `ResultSchema` that definesthe structure of measurement data captured when the test is performed. Test Definitions serveas templates—when a test needs to be performed on a sample, a `TestOrder` is created referencingthe appropriate Test Definition. Test Definitions are used within clinical and preclinical studyworkflows (see `StudySampleTestPlan`) and can be linked to `Procedure` assays for execution.Belongs to an `Organization` and can be archived when no longer needed.

Benchling Test Definition API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include TestDefinition. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.

This API exposes 8 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, /api/v3.

8 operations 7 paths 12 schemas 2 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{tenant}.benchling.com/api/v2
Authentication
HTTP Basic, HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

Benchling Test Definition API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicApiKeyAuth). It accepts HTTP basic authentication (basicClientIdSecretAuth). It supports OAuth 2.0 (oAuth) using the clientCredentials flow. By default, every request must be authenticated.

  • basicApiKeyAuth — Use issued API key for standard access to the API
  • basicClientIdSecretAuth — Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
  • oAuth — OAuth2 Client Credentials flow intended for service access

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 2 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

TestDefinition 8

A Test Definition is a configuration object that specifies a type of test or assay that can be ordered against samples. Each Test Definition is associated with a ResultSchema that…

POST
/test-definition
Create TestDefinition
TestDefinition.Create 1 param body → 201400403404429500
GET
/test-definition/items
List TestDefinition items
TestDefinition.List 20 params → 200400403404429500
GET
/test-definition/{test_definition_id}
Get TestDefinition by ID
TestDefinition.Get 4 params → 200400403404429500
PATCH
/test-definition/{test_definition_id}
Update TestDefinition
TestDefinition.Update 2 params body → 200400403404429500
POST
/test-definition:batch-create
Batch create TestDefinition
TestDefinition.BatchCreate 1 param body → 201400403404429500
PATCH
/test-definition:batch-update
Batch update TestDefinition
TestDefinition.BatchUpdate 1 param body → 200400403404429500
POST
/test-definition:bulk-create
Bulk create TestDefinition
TestDefinition.BulkCreate 1 param body → 202400403404429500
PATCH
/test-definition:bulk-update
Bulk update TestDefinition
TestDefinition.BulkUpdate 1 param body → 202400403404429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are TestDefinition (13 properties), UpdateTestDefinitionInputWithPathParams (7 properties), UpdateTestDefinitionInput (6 properties), InternalServerError (6 properties). Each schema is shown below with its type and property counts.

CreateTestDefinitionInput
object
4 properties 4 required
UpdateTestDefinitionInputWithPathParams
object
7 properties 1 required
UpdateTestDefinitionInput
object
6 properties
InternalServerError
object
6 properties 5 required
ResultSchemaRef
object
2 properties
AsyncTaskLink
object
2 properties
BulkImport
object
1 property 1 required
PrincipalRef
object
2 properties
OrganizationRef
object
2 properties
TestDefinitionPaginatedList
object
2 properties
TestDefinition
object
A Test Definition is a configuration object that specifies a type of test or assay that can be ordered against samples. Each Test Definition is associated with…
13 properties
GeneralError
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-testdefinition-api-openapi.yml Raw ↑

Other APIs Benchling publishes across the network.

Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
Where this information came from

This is an independent, third-party profile of Benchling Test Definition API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.