Apache Iceberg · JSON Structure

Rest Catalog Open Api Scan Tasks Structure

Scan and planning tasks for server-side scan planning - `plan-tasks` contains opaque units of planning work - `file-scan-tasks` contains a partial or complete list of table scan tasks - `delete-files` contains delete files referenced by file scan tasks Each plan task must be passed to the fetchScanTasks endpoint to fetch the file scan tasks for the plan task. The list of delete files must contain all delete files referenced by the file scan tasks.

Type: object Properties: 3
ACIDAnalyticsApacheData LakeLakehouseOpen SourceTable Format

ScanTasks is a JSON Structure definition published by Apache Iceberg, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

delete-files file-scan-tasks plan-tasks

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-tasks-structure.json",
  "name": "ScanTasks",
  "description": "Scan and planning tasks for server-side scan planning\n\n- `plan-tasks` contains opaque units of planning work\n- `file-scan-tasks` contains a partial or complete list of table scan tasks\n- `delete-files` contains delete files referenced by file scan tasks\n\nEach plan task must be passed to the fetchScanTasks endpoint to fetch the file scan tasks for the plan task.\n\nThe list of delete files must contain all delete files referenced by the file scan tasks.\n",
  "properties": {
    "delete-files": {
      "type": "array",
      "description": "Delete files referenced by file scan tasks",
      "items": {
        "$ref": "#/components/schemas/DeleteFile"
      }
    },
    "file-scan-tasks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FileScanTask"
      }
    },
    "plan-tasks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PlanTask"
      }
    }
  }
}