PartnerDatasetRpt

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/entur/main/json-schema/entur-partner-dataset-rpt-schema.json",
  "title": "PartnerDatasetRpt",
  "description": "Metadata for a Dataset. A Dataset is a batch of data that contributes to a Data Product. The Dataset may be downloaded as a formatted Report via this API, or via BigQuery depending on Dataset Type.",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/entur-clearing-reports-openapi.yml#/components/schemas/PartnerDatasetRpt",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "ID of this dataset."
    },
    "dataProductVersion": {
      "type": "integer",
      "format": "int64",
      "description": "Id of the specific version of the data product template used."
    },
    "dataProductCode": {
      "type": "string",
      "description": "The data product code, this may be contributed to by several template versions over time."
    },
    "orderDate": {
      "type": "string",
      "format": "date",
      "description": "The System Date for the dataset creation."
    },
    "orderBy": {
      "type": "string",
      "description": "Created by user or system."
    },
    "datasetType": {
      "type": "string",
      "description": "Classification of the dataset. PARQUET sets can be formatted and downloaded on demand. BIGQUERY can not be downloaded, only accessed via BigQuery. LEGACY reports (CSV, XLSX) are preformatted."
    },
    "datasetName": {
      "type": "string",
      "description": "Userfriendly name of the dataset, typically used as the filename when downloaded."
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Current status of the dataset: 0=Ordered, 1=COMPLETED, 2=Failed, 4=On Demand (DEPRECATED), 3=Cancelled, 9=Processing."
    },
    "rows": {
      "type": "integer",
      "format": "int32",
      "description": "Number of rows in the dataset when COMPLETED. Not available for legacy reports."
    },
    "bqProject": {
      "type": "string",
      "description": "Destination BigQuery project when dataset is of type BIGQUERY."
    },
    "chartOfAccountsRef": {
      "type": "string",
      "description": "The Chart of Accounts this dataset is derived from, if defined."
    },
    "ownerOrgRef": {
      "type": "string",
      "description": "Organisation owning the dataset with self-service access."
    },
    "copyOrgRefs": {
      "type": "array",
      "description": "Recipients of the dataset with self-service and M2M access.",
      "items": {
        "type": "string"
      }
    },
    "acctMonthId": {
      "type": "integer",
      "format": "int64",
      "description": "Clearing system Accounting Month ID used by this dataset."
    },
    "glBatchId": {
      "type": "integer",
      "format": "int64",
      "description": "GL Batch ID potentially used by this dataset."
    },
    "apBatchId": {
      "type": "integer",
      "format": "int64",
      "description": "AP Batch ID potentially used by this dataset."
    },
    "arBatchId": {
      "type": "integer",
      "format": "int64",
      "description": "AR Batch ID potentially used by this dataset."
    },
    "inBatchId": {
      "type": "integer",
      "format": "int64",
      "description": "IN Batch ID potentially used by this dataset."
    },
    "agreementId": {
      "type": "integer",
      "format": "int64",
      "description": "Clearing system Agreement ID potentially used by this dataset."
    }
  }
}