Skip to main content

Resource Descriptor

Purpose

A resource descriptor is a data structure that defines the metadata of a single dataset resource. The list of resource descriptors is contained in the resources property of a dataset card. Each descriptor corresponds to a single resource item—such as a data file, data service, or external link—associated with the dataset.

A resource descriptor provides enough information for your application to identify, classify, and access the resource.

Structure

Each resource descriptor is a JSON object with the following properties.

PropertyDescription
nameHuman-readable label of the resource. May be a file name, format name, or service name.
formatCustom label describing the data format, if available.
mimetypeStandard MIME type describing the content type.
d_extFile extension commonly used for the resource type (e.g., .csv, .zip).
d_mimeMIME type that reflects the downloadable file's content, if available.
urlA fully qualified URL for accessing the resource.

Example

Below is an example resource descriptor for a CSV data file.

{
"name": "CSV",
"format": "CSV",
"mimetype": "text/csv",
"d_ext": ".csv",
"d_mime": "text/csv",
"url": "https://rigis-edc.opendata.arcgis.com/api/..."
}