File

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchling/main/json-schema/benchling-file-schema.json",
  "title": "File",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/benchling-files-api-openapi.yml#/components/schemas/File",
  "allOf": [
    {
      "$ref": "#/$defs/FileStatus"
    },
    {
      "properties": {
        "archiveRecord": {
          "allOf": [
            {
              "$ref": "#/$defs/ArchiveRecord"
            }
          ],
          "description": "ArchiveRecord Resource if the file is archived. This is null if the file is not archived.\n"
        },
        "createdAt": {
          "description": "Date and time the file was created",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "creator": {
          "allOf": [
            {
              "$ref": "#/$defs/UserSummary"
            },
            {
              "description": "UserSummary of the user who created the file"
            },
            {
              "readOnly": true
            }
          ]
        },
        "customFields": {
          "allOf": [
            {
              "$ref": "#/$defs/CustomFields"
            }
          ],
          "description": "Custom field values of the file"
        },
        "displayId": {
          "description": "User-friendly ID of the file",
          "readOnly": true,
          "type": "string"
        },
        "filename": {
          "type": "string"
        },
        "folderId": {
          "description": "ID of the folder that contains the file",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "modifiedAt": {
          "description": "Date and time the file was last modified",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  ],
  "$defs": {
    "ArchiveRecord": {
      "properties": {
        "reason": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "CustomField": {
      "properties": {
        "value": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "CustomFields": {
      "additionalProperties": {
        "$ref": "#/$defs/CustomField"
      },
      "type": "object"
    },
    "FileStatus": {
      "properties": {
        "errorMessage": {
          "type": [
            "string",
            "null"
          ]
        },
        "uploadStatus": {
          "enum": [
            "IN_PROGRESS",
            "SUCCEEDED",
            "FAILED_VALIDATION",
            "NOT_UPLOADED"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "PartySummary": {
      "properties": {
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "UserSummary": {
      "allOf": [
        {
          "$ref": "#/$defs/PartySummary"
        },
        {}
      ]
    }
  }
}