BEbenchling
Run Schema

Get RunSchema by ID

Get a single RunSchema by ID.

get/api/v3/run-schema/{run_schema_id}

Request

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

Path parameters

run_schema_idstring required

ID of the RunSchema.

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
allowCreateRunFromNotebookboolean nullable

Whether new runs belonging to this schema can be created from the notebook

allowInsertRunFromInboxboolean nullable

Whether runs belonging to this schema can be inserted in the notebook from the Run Inbox

archiveReasonstring nullable

If the Run is archived, reason for archiving

archivedboolean

Whether the Run is archived

automationInputFileConfigsstring uri

Configurations for automation input generators on this run

automationOutputFileConfigsstring uri

Configurations for automation output processors on this run

createdAtstring datetime nullable
fieldDefinitionsstring uri

Defines the metadata fields for runs belonging to this schema

idstring
modifiedAtstring datetime nullable

DateTime the Run Schema was last modified

namestring

Name of the Run Schema

shouldRecordEquipmentboolean

Whether runs belonging to this schema should record equipment or not

systemNamestring nullable

Name for this schema in the Data Platform. For example, the name of the warehouse table is derived from the systemName.

Changes

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