Create DataFrame

POST

https://{tenant_name}.benchling.com/api/v3/data-frame

POST

/api/v3/data-frame

curl -X POST https://{tenant_name}.benchling.com/api/v3/data-frame \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "name",
  "scratchFileId": null
}'

{
  "__typename": "__typename",
  "columns": [
    {
      "__typename": "__typename",
      "displayName": "displayName",
      "systemName": "systemName",
      "type": {
        "key": "value"
      }
    }
  ],
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "dataset": {
    "__typename": "__typename",
    "id": "id"
  },
  "errorMessage": "errorMessage",
  "id": "id",
  "manifest": [
    {
      "__typename": "__typename",
      "fileName": "fileName",
      "url": "url"
    }
  ],
  "modifiedAt": "modifiedAt",
  "name": "name",
  "size": 1,
  "uploadStatus": "SUCCEEDED"
}

Create DataFrame.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

scratchFileIdstring or nullRequired

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

delimiterstringOptional=1 character

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

localestringOptional

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

Response

Created

__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 Create Request Bad Request Error

403

Data Frame Create Request Forbidden Error

404

Data Frame Create Request Not Found Error

409

Data Frame Create Request Conflict Error

429

Data Frame Create Request Too Many Requests Error

500

Data Frame Create Request Internal Server Error