Apache Iceberg · JSON Structure

Rest Catalog Open Api Scan Report Structure

ScanReport schema from Apache Iceberg REST Catalog API

Type: object Properties: 8 Required: 7
ACIDAnalyticsApacheData LakeLakehouseOpen SourceTable Format

ScanReport is a JSON Structure definition published by Apache Iceberg, describing 8 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

table-name snapshot-id filter schema-id projected-field-ids projected-field-names metrics metadata

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-iceberg/refs/heads/main/json-structure/rest-catalog-open-api-scan-report-structure.json",
  "name": "ScanReport",
  "description": "ScanReport schema from Apache Iceberg REST Catalog API",
  "properties": {
    "table-name": {
      "type": "string"
    },
    "snapshot-id": {
      "type": "int64"
    },
    "filter": {
      "$ref": "#/components/schemas/Expression"
    },
    "schema-id": {
      "type": "integer"
    },
    "projected-field-ids": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "projected-field-names": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "metrics": {
      "$ref": "#/components/schemas/Metrics"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "table-name",
    "snapshot-id",
    "filter",
    "schema-id",
    "projected-field-ids",
    "projected-field-names",
    "metrics"
  ]
}