Data asset schema

A data asset is any data you publish on IXO and want others to find, use and credit: a set of claims, a model, a table of sensor readings. IXO describes data assets with structured metadata based on schema.org, so that other systems can read the description, find the asset and attribute it correctly.

Use this page when you write the metadata for a dataset. It lists the properties, which ones are required, how to describe a catalog and a download, and a complete example.

Kinds of data asset

Schema structure

Required properties

The description may include Markdown syntax with absolute URLs for images.

Recommended properties

Optional properties

Implementation guide

1. Define the basic metadata: create a unique identifier, set the name and description, add version information, and specify the creator.
2. Add context: set the temporal coverage, define the spatial scope, list the measured variables, and add relevant keywords.
3. Configure access: set the license terms, define the distribution method, specify the formats, and add download URLs.
4. Link related resources: add citations, link to catalogs, reference related datasets, and include documentation.

Data catalog integration

Catalog properties

{
  "@type": "DataCatalog",
  "name": "Impact Registry",
  "url": "https://registry.emerging.eco",
  "dataset": [{
    "@type": "Dataset",
    "name": "Clean Cooking Metrics",
    "includedInDataCatalog": {
      "@type": "DataCatalog",
      "name": "Impact Registry"
    }
  }]
}

Download options

{
  "@type": "Dataset",
  "distribution": {
    "@type": "DataDownload",
    "contentUrl": "https://data.emerging.eco/dataset.csv",
    "encodingFormat": "text/csv"
  }
}

Example implementation

Illustrative example. A dataset, and the catalog entry that lists it.

{
  "@context": "https://schema.org/",
  "@type": "Dataset",
  "name": "Clean Cooking Impact Metrics",
  "description": "Monthly measurements of clean cooking adoption...",
  "creator": {
    "@type": "Organisation",
    "@id": "https://ror.org/04wxnsj81",
    "name": "Impact Organisation"
  },
  "license": "https://creativecommons.org/licenses/by/4.0",
  "identifier": "https://doi.org/10.1234/example",
  "temporalCoverage": "2023-01-01/2023-12-31",
  "variableMeasured": [
    "Fuel consumption",
    "Emissions reduction",
    "Usage patterns"
  ]
}

{
  "@context": "https://schema.org/",
  "@type": "DataCatalog",
  "name": "Impact Registry",
  "dataset": {
    "@type": "Dataset",
    "name": "Clean Cooking Impact Metrics",
    "url": "https://registry.emerging.eco/datasets/123",
    "distribution": {
      "@type": "DataDownload",
      "contentUrl": "https://data.emerging.eco/123.csv",
      "encodingFormat": "text/csv"
    }
  }
}

Best practices

Resources