{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Data Frames API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Data Frames",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a data frame.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/data-frames",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a data frame.\n\nData frames can be created from `.csv` files, and only 1 `.csv` file can currently be uploaded.\n\nA successful data frame upload requires 3 calls in serial:\n1. [Create a data frame](#/Data%20Frames/createDataFrame), this endpoint, specifying the files to upload. This\n   returns a `manifest` containing S3 `PUT` URLs corresponding to the files that will be uploaded for\n   the 2nd call and a data frame ID for the 3rd call.\n2. Upload the data frame `.csv` content to S3. Add `x-a"
        },
        {
          "info": {
            "name": "Get a data frame",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/data-frames/:data_frame_id",
            "params": [
              {
                "name": "data_frame_id",
                "value": "",
                "type": "path",
                "description": "The ID of the data frame"
              },
              {
                "name": "returning",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, [click here](https://docs.benchling.com/docs/getting-started-1#returning-query-parameter)."
              },
              {
                "name": "rowDataFormat",
                "value": "",
                "type": "query",
                "description": "The format of the row data, either `csv` or `parquet`. Default is `csv`."
              }
            ]
          },
          "docs": "Get a data frame and URLs to download its data.\n\nIf the data frame has `SUCCEEDED` status, the `manifest` field in the response will contain URLs to each\npart of a data frame that can be downloaded and the names of the files.\n\nIf the data frame has `NOT_UPLOADED` status, the `manifest` field in the response will contain S3 `PUT` URLs\nto upload data frame `.csv` files. See [Create a data frame](#/Data%20Frames/createDataFrames) for documentation of\nthe full upload flow.\n\nIf the data frame has `FA"
        },
        {
          "info": {
            "name": "Update a data frame",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/data-frames/:data_frame_id",
            "params": [
              {
                "name": "data_frame_id",
                "value": "",
                "type": "path",
                "description": "The ID of the data frame"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a data frame.\n\nAfter uploading a `.csv` data drame file to S3, call this endpoint to mark the upload status as `IN_PROGRESS`\nto launch a [long-running task](#/Tasks/getTask) to validate and transform the raw `.csv` file into a\ndata frame. Once complete, the data frame's status will either be updated to `SUCCEEDED` or `FAILED_VALIDATION`.\n\nFor more details on how we process and validate data frames, [click here](https://docs.benchling.com/docs/datasets-ingestion-reference).\n\nSee [Create a "
        }
      ]
    }
  ],
  "bundled": true
}