Opendatasoft · Schema

Dataset

Open DataDatasetsPublic DataODataRESTGovernmentCities

Properties

Name Type Description
_links array
dataset_id string
dataset_uid string
attachments array
has_records boolean
data_visible boolean
features array A map of available features for a dataset, with the fields they apply to.
metas object
fields array
View JSON Schema on GitHub

JSON Schema

dataset.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/opendatasoft/refs/heads/main/json-schema/dataset.json",
  "title": "Dataset",
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "_links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/links"
      }
    },
    "dataset_id": {
      "type": "string"
    },
    "dataset_uid": {
      "type": "string",
      "readOnly": true
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "mimetype": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        }
      }
    },
    "has_records": {
      "type": "boolean"
    },
    "data_visible": {
      "type": "boolean"
    },
    "features": {
      "type": "array",
      "description": "A map of available features for a dataset, with the fields they apply to.\n",
      "items": {
        "type": "string"
      }
    },
    "metas": {
      "type": "object"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "annotations": {
            "type": "object"
          },
          "description": {
            "type": "string",
            "nullable": true
          }
        }
      }
    }
  }
}