Apache Oozie · JSON Structure

Apache Oozie Job List Structure

Paginated list of jobs.

Type: object Properties: 6
WorkflowHadoopOrchestrationSchedulingBig DataApacheJavaOpen Source

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

Properties

offset len total workflows coordinatorjobs bundlejobs

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-oozie/refs/heads/main/json-structure/apache-oozie-job-list-structure.json",
  "name": "JobList",
  "description": "Paginated list of jobs.",
  "type": "object",
  "properties": {
    "offset": {
      "type": "int32",
      "description": "Pagination offset (1-based).",
      "example": 1
    },
    "len": {
      "type": "int32",
      "description": "Maximum results requested.",
      "example": 50
    },
    "total": {
      "type": "int32",
      "description": "Total number of matching jobs.",
      "example": 100
    },
    "workflows": {
      "type": "array",
      "description": "List of workflow job entries.",
      "items": {
        "type": "object",
        "description": "Full information about a workflow, coordinator, or bundle job.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Job identifier.",
            "example": "0000001-200101120000000-oozie-admin-W"
          },
          "appName": {
            "type": "string",
            "description": "Application name from the workflow definition.",
            "example": "my-workflow"
          },
          "appPath": {
            "type": "string",
            "description": "HDFS path to the workflow application.",
            "example": "hdfs://localhost:8020/user/admin/workflow"
          },
          "status": {
            "type": "string",
            "description": "Current job status.",
            "example": "RUNNING"
          },
          "user": {
            "type": "string",
            "description": "User who submitted the job.",
            "example": "admin"
          },
          "group": {
            "type": "string",
            "description": "User group for the job.",
            "example": "users"
          },
          "startTime": {
            "type": "datetime",
            "description": "Job start timestamp.",
            "example": "2021-01-01T12:00:00.000Z"
          },
          "endTime": {
            "type": "datetime",
            "description": "Job end timestamp (null if still running)."
          },
          "lastModTime": {
            "type": "datetime",
            "description": "Last modification timestamp."
          },
          "createdTime": {
            "type": "datetime",
            "description": "Job creation timestamp."
          },
          "run": {
            "type": "int32",
            "description": "Run number for rerun tracking.",
            "example": 0
          },
          "actions": {
            "type": "array",
            "description": "List of actions within the job (workflow jobs only).",
            "items": {
              "type": "object",
              "description": "A single action within a workflow job.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Action identifier.",
                  "example": "0000001-200101120000000-oozie-admin-W@action1"
                },
                "name": {
                  "type": "string",
                  "description": "Action name as defined in the workflow.",
                  "example": "my-map-reduce"
                },
                "type": {
                  "type": "string",
                  "description": "Action type (map-reduce, pig, hive, etc.).",
                  "example": "map-reduce"
                },
                "status": {
                  "type": "string",
                  "description": "Current action status.",
                  "example": "OK"
                },
                "startTime": {
                  "type": "datetime",
                  "description": "Action start timestamp.",
                  "example": "2021-01-01T12:00:00.000Z"
                },
                "endTime": {
                  "type": "datetime",
                  "description": "Action end timestamp.",
                  "example": "2021-01-01T12:05:00.000Z"
                },
                "errorCode": {
                  "type": "string",
                  "description": "Error code if the action failed.",
                  "example": null
                },
                "errorMessage": {
                  "type": "string",
                  "description": "Error message if the action failed.",
                  "example": null
                }
              }
            }
          }
        }
      }
    },
    "coordinatorjobs": {
      "type": "array",
      "description": "List of coordinator job entries.",
      "items": {
        "type": "object",
        "description": "Full information about a workflow, coordinator, or bundle job.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Job identifier.",
            "example": "0000001-200101120000000-oozie-admin-W"
          },
          "appName": {
            "type": "string",
            "description": "Application name from the workflow definition.",
            "example": "my-workflow"
          },
          "appPath": {
            "type": "string",
            "description": "HDFS path to the workflow application.",
            "example": "hdfs://localhost:8020/user/admin/workflow"
          },
          "status": {
            "type": "string",
            "description": "Current job status.",
            "example": "RUNNING"
          },
          "user": {
            "type": "string",
            "description": "User who submitted the job.",
            "example": "admin"
          },
          "group": {
            "type": "string",
            "description": "User group for the job.",
            "example": "users"
          },
          "startTime": {
            "type": "datetime",
            "description": "Job start timestamp.",
            "example": "2021-01-01T12:00:00.000Z"
          },
          "endTime": {
            "type": "datetime",
            "description": "Job end timestamp (null if still running)."
          },
          "lastModTime": {
            "type": "datetime",
            "description": "Last modification timestamp."
          },
          "createdTime": {
            "type": "datetime",
            "description": "Job creation timestamp."
          },
          "run": {
            "type": "int32",
            "description": "Run number for rerun tracking.",
            "example": 0
          },
          "actions": {
            "type": "array",
            "description": "List of actions within the job (workflow jobs only).",
            "items": {
              "type": "object",
              "description": "A single action within a workflow job.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Action identifier.",
                  "example": "0000001-200101120000000-oozie-admin-W@action1"
                },
                "name": {
                  "type": "string",
                  "description": "Action name as defined in the workflow.",
                  "example": "my-map-reduce"
                },
                "type": {
                  "type": "string",
                  "description": "Action type (map-reduce, pig, hive, etc.).",
                  "example": "map-reduce"
                },
                "status": {
                  "type": "string",
                  "description": "Current action status.",
                  "example": "OK"
                },
                "startTime": {
                  "type": "datetime",
                  "description": "Action start timestamp.",
                  "example": "2021-01-01T12:00:00.000Z"
                },
                "endTime": {
                  "type": "datetime",
                  "description": "Action end timestamp.",
                  "example": "2021-01-01T12:05:00.000Z"
                },
                "errorCode": {
                  "type": "string",
                  "description": "Error code if the action failed.",
                  "example": null
                },
                "errorMessage": {
                  "type": "string",
                  "description": "Error message if the action failed.",
                  "example": null
                }
              }
            }
          }
        }
      }
    },
    "bundlejobs": {
      "type": "array",
      "description": "List of bundle job entries.",
      "items": {
        "type": "object",
        "description": "Full information about a workflow, coordinator, or bundle job.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Job identifier.",
            "example": "0000001-200101120000000-oozie-admin-W"
          },
          "appName": {
            "type": "string",
            "description": "Application name from the workflow definition.",
            "example": "my-workflow"
          },
          "appPath": {
            "type": "string",
            "description": "HDFS path to the workflow application.",
            "example": "hdfs://localhost:8020/user/admin/workflow"
          },
          "status": {
            "type": "string",
            "description": "Current job status.",
            "example": "RUNNING"
          },
          "user": {
            "type": "string",
            "description": "User who submitted the job.",
            "example": "admin"
          },
          "group": {
            "type": "string",
            "description": "User group for the job.",
            "example": "users"
          },
          "startTime": {
            "type": "datetime",
            "description": "Job start timestamp.",
            "example": "2021-01-01T12:00:00.000Z"
          },
          "endTime": {
            "type": "datetime",
            "description": "Job end timestamp (null if still running)."
          },
          "lastModTime": {
            "type": "datetime",
            "description": "Last modification timestamp."
          },
          "createdTime": {
            "type": "datetime",
            "description": "Job creation timestamp."
          },
          "run": {
            "type": "int32",
            "description": "Run number for rerun tracking.",
            "example": 0
          },
          "actions": {
            "type": "array",
            "description": "List of actions within the job (workflow jobs only).",
            "items": {
              "type": "object",
              "description": "A single action within a workflow job.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Action identifier.",
                  "example": "0000001-200101120000000-oozie-admin-W@action1"
                },
                "name": {
                  "type": "string",
                  "description": "Action name as defined in the workflow.",
                  "example": "my-map-reduce"
                },
                "type": {
                  "type": "string",
                  "description": "Action type (map-reduce, pig, hive, etc.).",
                  "example": "map-reduce"
                },
                "status": {
                  "type": "string",
                  "description": "Current action status.",
                  "example": "OK"
                },
                "startTime": {
                  "type": "datetime",
                  "description": "Action start timestamp.",
                  "example": "2021-01-01T12:00:00.000Z"
                },
                "endTime": {
                  "type": "datetime",
                  "description": "Action end timestamp.",
                  "example": "2021-01-01T12:05:00.000Z"
                },
                "errorCode": {
                  "type": "string",
                  "description": "Error code if the action failed.",
                  "example": null
                },
                "errorMessage": {
                  "type": "string",
                  "description": "Error message if the action failed.",
                  "example": null
                }
              }
            }
          }
        }
      }
    }
  }
}