BEbenchling
Dataset

Get Dataset by ID

Get a single Dataset by ID.

get/api/v3/dataset/{dataset_id}

Request

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

Path parameters

dataset_idstring required

ID of the Dataset.

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.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
dataFrameIdstring nullable
displayIdstring nullable

A human-readable identifier for this dataset (e.g. "DATASET-1"). Automatically generated and unique within the tenant.

idstring
modifiedAtstring datetime
namestring nullable

Changes

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