BEbenchling
Data Frame

Create DataFrame

Create DataFrame.

post/api/v3/data-frame

Request

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

Request body

delimiterstring

Single-character delimiter used when parsing the file. Defaults to a tab for .tsv files and ',' otherwise.

localestring

Locale used for number parsing, such as decimal and thousands separators (e.g. 'en-US'). Defaults to 'en-US' if not specified.

namestring required
scratchFileIdstring nullable required

ID of ScratchFile containing the raw file from which to create the DataFrame. Only files with a .csv or .tsv extension are supported.

Response

Created

__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.