BEbenchling
Test Definition

Get TestDefinition by ID

Get a single TestDefinition by ID.

get/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.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

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

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.