Resource

A Resource is defined as:

An individual file or other form of data. Resources can be fully informationally equivalent, such as CSV and JSON serializations of the same data. Resources can also have different levels of fidelity, such as a CSV file and a graphical representation of the data within the file. Resources can also differ in other aspects, such as the temporal coverage of each resource.

Each dataset can have many associated resources.

Overview

            erDiagram
        Direction LR
        Resource {
            string id*
            string title*
            string description*
            string media_type
            string format
            object spatial
            object temporal
            string access_url
            string download_url
            object baseline_period
            object climate
        }

        Dataset ||--|{ Resource: "Includes"
    

Properties

Title

Description

Type

Format

Required

id

string

Required

Resource identifier

A locally unique identifier for this resource.

title

string

Required

Resource title

A title for this resource.

description

string

Required

Resource description

A description for this resource.

access_url

string

iri

Access Url

A web address that gives access to this resource, e.g. a webpage through which a user can request access by completing a form.

download_url

string

Download Url

The web address this resource can be downloaded from in the given .media_type or .format.

media_type

string

Media type

The IANA media type that describes the format of the resource, from the open media_type codelist. The codelist provides human-readable titles for the media types. This field should be used when the IANA media type of the resource is known. If the media type of the resource is not known, an alternative label or description for the format may be provided in .format.

format

string

Format

The format of the resource, if the IANA media type of the resource is not known. Otherwise, .media_type should be used instead. If the resource represents an API via which the dataset is available, .format should be set to “API”. For more information, see how to describe an API.

conforms_to

string

Conforms to

An established standard to which the described resource conforms, from the open conforms_to codelist. The codelist provides human-readable titles for the media types. If the standard is not covered by the codelist, use of an HTTP URI is recommended.

spatial

object

Spatial coverage

The geographical area covered by the resource. If specified using coordinates, the use of .bbox is recommended over .geometry or .centroid. For more information, refer to spatial and temporal properties.

See Spatial coverage

spatial_resolution

number

Spatial resolution

The minimum spatial separation resolvable in this resource, measured in meters. For more information, refer to spatial and temporal properties.

spatial_aggregation

string

Spatial aggregation

The fundamental spatial unit or geometric container used to organise, summarise, or ‘bin’ the data within this resource. This describes whether the data is unaggregated (e.g., individual building footprints or asset points), or aggregated into standardised administrative divisions (e.g., municipalities), hydrological units (e.g., catchments), or calculated geometric grids (e.g., hexagons or square gridcells).

coordinate_system

string

Coordinate reference system

An identifier string for the coordinate reference system (CRS) used in this resource. The CRS must be identified by a code issued by either EPSG or ESRI. The identifier string format is {authority}:{code}, e.g. EPSG:4326. https://epsg.io/ provides a searchable database of EPSG and ESRI coordinate system codes.

temporal

object

Temporal coverage

The period of time covered by this resource.

temporal/start

string

Start

The start of the period. A date (YYYY-MM-DD) is recommended. However, year-months (YYYY-MM) and years (YYYY) are supported.

temporal/end

string

End date

The end of the period. A date (YYYY-MM-DD) is recommended. However, year-months (YYYY-MM) and years (YYYY) are supported.

temporal/duration

string

duration

Duration

The duration of the period in ISO 8601 duration format, e.g. ‘P50Y’ for 50 years

temporal/central_year

integer

Central year

The central or representative year as a single point in time rather than a period (e.g., ‘2050’ representing the period 2040-2060). Use this instead of start/end when data represents conditions centered on a specific year.

temporal_resolution

string

duration

Temporal resolution

The minimum period of time resolvable in this resource, in ISO8601 duration format.

baseline_period

object

Baseline period

The baseline or reference period on which a forecast or projection is based.

baseline_period/start

string

Start

The start of the period. A date (YYYY-MM-DD) is recommended. However, year-months (YYYY-MM) and years (YYYY) are supported.

baseline_period/end

string

End date

The end of the period. A date (YYYY-MM-DD) is recommended. However, year-months (YYYY-MM) and years (YYYY) are supported.

baseline_period/duration

string

duration

Duration

The duration of the period in ISO 8601 duration format, e.g. ‘P50Y’ for 50 years

baseline_period/central_year

integer

Central year

The central or representative year as a single point in time rather than a period (e.g., ‘2050’ representing the period 2040-2060). Use this instead of start/end when data represents conditions centered on a specific year.

climate

object

Climate

Information about climate scenarios and models used to create the dataset.

climate/model

string

Climate model

The name or identifier of the climate model used to produce this resource

climate/scenario

string

Climate scenario

The climate scenario under which the data was produced, from the closed climate_scenario codelist.

climate/percentile

number

Percentile

The percentile of the climate model or model ensemble output represented in this resource, expressed as a number between 0 and 100. For example, 50 indicates the median (50th percentile) of the ensemble.

Spatial coverage

Title

Description

Type

Format

Required

scale

string

Spatial scale

The spatial scale of the geographical area, from the closed spatial scale codelist.

countries

array[string]

Countries

The countries covered by the geographical area, from the closed country codelist.

gazetteer_entries

array[Gazetteer entry]

Gazetteer entries

Entries from geographical indices or directories describing the geographical area. This field should be used to describe sub-national coverage. Use of ISO 3166-2 is recommended.

gazetteer_entries/0/id

string

Required

Gazetteer entry identifier

An identifier drawn from the gazetteer identified in .scheme.

gazetteer_entries/0/scheme

string

Scheme

The gazetteer from which the entry is drawn, from the open location gazetteers codelist.

gazetteer_entries/0/description

string

Description

A description for the gazetteer entry.

gazetteer_entries/0/uri

string

iri

Uniform resource locator

A URI for the gazetteer entry.

bbox

array[number]

Bounding box

A geographic bounding box delimiting the geographical area. This field is an array of numbers. It must contain exactly four numbers with the first two numbers being the longitude and latitude of the most southwesterly point and the second two numbers being the longitude and latitude of the most northeasterly point. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.

centroid

array[number]

Centroid

The coordinates of the centre of the geographical area. This field is an array of numbers. It must contain exactly two numbers with longitude (easting) first and latitude (northing) second. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.