Benchling · Example Payload

Getdataframe Response 200

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Getdataframe Response 200 is an example object payload from Benchling, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodstatuscontentTypeexample

Example Payload

{
  "operationId": "getDataFrame",
  "path": "/data-frames/{data_frame_id}",
  "method": "get",
  "status": "200",
  "contentType": "application/json",
  "example": {
    "1 Succeeded": {
      "description": "A Data Frame that was created successfully. `manifest` contains URLs that can be used to download the data.",
      "value": {
        "columns": [
          {
            "displayName": "Name",
            "systemName": "name",
            "type": {
              "isList": false,
              "isNullable": false,
              "name": "String"
            }
          }
        ],
        "errorMessage": null,
        "id": "dset_LlDFupKyErxx",
        "manifest": [
          {
            "fileName": "09-14-2022_011620_PM_well_plate-part-00000.csv",
            "url": "https://benchling-location.s3.amazonaws.com/deploys/location/data_frames/.../09-14-2022_011620_PM_well_plate-part-00000.csv?..."
          }
        ],
        "name": "09-14-2022 01:16:20 PM well plate",
        "uploadStatus": "SUCCEEDED"
      }
    },
    "2 Failed Validation": {
      "description": "A Data Frame that failed validation.",
      "value": {
        "errorMessage": "Invalid CSV File.",
        "id": "dset_LlDFupKyErxx",
        "manifest": [
          {
            "fileName": "09-14-2022_011620_PM_well_plate-part-00000.csv",
            "url": null
          }
        ],
        "name": "09-14-2022 01:16:20 PM well plate",
        "uploadStatus": "FAILED_VALIDATION"
      }
    },
    "3 In Progress": {
      "description": "A Data Frame still being processed.",
      "value": {
        "errorMessage": null,
        "id": "dset_LlDFupKyErxx",
        "manifest": [
          {
            "fileName": "09-14-2022_011620_PM_well_plate-part-00000.csv",
            "url": null
          }
        ],
        "name": "09-14-2022 01:16:20 PM well plate",
        "uploadStatus": "IN_PROGRESS"
      }
    },
    "4 Not Uploaded": {
      "description": "An empty Data Frame. Files can be uploaded by using the provided manifest URLs.",
      "value": {
        "errorMessage": null,
        "id": "dset_LlDFupKyErxx",
        "manifest": [
          {
            "fileName": "09-14-2022_011620_PM_well_plate-part-00000.csv",
            "url": "https://benchling-location.s3.amazonaws.com/deploys/location/data_frames/source_files/.../09-14-2022_011620_PM_well_plate-part-00000.csv?..."
          }
        ],
        "name": "09-14-2022 01:16:20 PM well plate",
        "uploadStatus": "NOT_UPLOADED"
      }
    }
  }
}