DataFrame

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchling/main/json-schema/benchling-data-frame-schema.json",
  "title": "DataFrame",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/benchling-data-frames-api-openapi.yml#/components/schemas/DataFrame",
  "allOf": [
    {
      "$ref": "#/$defs/FileStatus"
    },
    {
      "$ref": "#/$defs/DataFrameManifest"
    },
    {
      "properties": {
        "columns": {
          "items": {
            "$ref": "#/$defs/DataFrameColumnMetadata"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "description": "The user-facing name for this DataFrame.",
          "type": "string"
        }
      },
      "type": "object"
    }
  ],
  "$defs": {
    "DataFrameColumnMetadata": {
      "properties": {
        "displayName": {
          "type": "string"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/DataFrameColumnTypeMetadata"
            }
          ]
        }
      },
      "type": "object"
    },
    "DataFrameColumnTypeMetadata": {
      "allOf": [
        {
          "$ref": "#/$defs/DataFrameColumnTypeNameEnum"
        },
        {
          "properties": {
            "isList": {
              "type": "boolean"
            },
            "isNullable": {
              "type": "boolean"
            },
            "target": {
              "description": "Only present if the column type is ObjectLink",
              "properties": {
                "baseTypeName": {
                  "type": "string"
                },
                "schemaId": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "type": "object"
            }
          },
          "required": [
            "isNullable",
            "isList"
          ],
          "type": "object"
        }
      ]
    },
    "DataFrameColumnTypeNameEnum": {
      "properties": {
        "name": {
          "enum": [
            "String",
            "Int",
            "Float",
            "JSON",
            "DateTime",
            "Date",
            "Boolean",
            "ObjectLink"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "DataFrameManifest": {
      "properties": {
        "manifest": {
          "items": {
            "description": "List of files composing a data frane, their names, and their corresponding URLs.",
            "properties": {
              "fileName": {
                "type": "string"
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "FileStatus": {
      "properties": {
        "errorMessage": {
          "type": [
            "string",
            "null"
          ]
        },
        "uploadStatus": {
          "enum": [
            "IN_PROGRESS",
            "SUCCEEDED",
            "FAILED_VALIDATION",
            "NOT_UPLOADED"
          ],
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}