BEbenchling
Data Frame

Get DataFrame by ID

Get a single DataFrame by ID.

get/api/v3/data-frame/{data_frame_id}

Request

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

Path parameters

data_frame_idstring required

ID of the DataFrame.

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
createdAtstring datetime
errorMessagestring nullable
idstring
modifiedAtstring datetime
namestring
sizeinteger
uploadStatus'SUCCEEDED' | 'FAILED_VALIDATION' | 'IN_PROGRESS' | 'NOT_UPLOADED'

Changes

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