Skip to navigation
Benchling APIData Frame

Get DataFrame by ID

Beta
Get a single DataFrame by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

data_frame_idstringRequired
ID of the DataFrame.

Headers

EARLY-ACCESSstringOptional

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

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

OK
__typenamestringOptional
columnslist of objectsOptional
createdAtstringOptional
creatorobjectOptional
datasetobject or nullOptional
errorMessagestring or nullOptional
idstringOptional
manifestlist of objectsOptional
modifiedAtstringOptional
namestringOptional
sizeintegerOptional
uploadStatusenumOptional
Allowed values:

Errors

400
Data Frame Get Request Bad Request Error
403
Data Frame Get Request Forbidden Error
404
Data Frame Get Request Not Found Error
429
Data Frame Get Request Too Many Requests Error
500
Data Frame Get Request Internal Server Error