hub-search (5.1.23)
Download OpenAPI specification:Download
Hub-Search is a powerful search solution designed to function as a Metadata Search Service for the Open Data Portal. This API facilitates the discovery and retrieval of metadata, making it easier for users to find datasets and resources. Hub-Search seamlessly integrates with Elastic Search to provide robust and precise search capabilities. Hub-Search API not only simplifies searching but also fosters transparency and knowledge sharing. It empowers users to easily discover valuable data resources, improving data accessibility and utilization. This introduction sets the stage for exploring the Hub-Search Open API. Detailed information on authentication, API endpoints, error handling, and practical examples can be found in the subsequent sections.
Search
To retrieve the data, send a GET request to the specified URL of the API endpoint with the resource path "/search" at the end of the URL. See the example here right. To obtain the desired result, use one or more of the parameters listed below. The parameters are pairs of names and their corresponding values, so-called name-value pairs. These are added to the URL with a "?" sign, the name and value are always separated using a '=' sign, the pairs are separated using a '&' sign. A syntactically correct request looks like the following example https://example.org/api/hub/search/search?q=cat&filter=dataset
query Parameters
| q | string The query |
| filter | string Deprecated Filter queries by document type |
| filters | Array of strings Filters queries by one or a combination of the current document types |
| facets | string Filter queries by facets (string as json, e.g. 'facets={"catalog":["catalog-x"]}') |
| page | integer >= 0 Default: 0 The page number of matching results |
| limit | integer [ 0 .. 1000 ] Default: 10 The maximum number of matching datasets per page |
| fields | Array of strings Filter queries by document fields (e.g. 'fields=title') |
| minDate | string <date-time> Filter queries by minimum Date |
| maxDate | string <date-time> Filter queries by maximum Date |
| boost | object Boost document fields (boost.field=1.0 or boost.field.subfield=1.0, e.g. boost.title=3.0) |
| globalAggregation | boolean Counting of facets globally or locally (default true) |
| facetOperator | string Enum: "AND" "OR" Filtering queries by facets are combined with "AND" or "OR" (default "OR") |
| facetGroupOperator | string Enum: "AND" "OR" Filtering queries by facetgroups are combined with "AND" or "OR" (default "AND") |
| bboxMinLon | number <float> [ -180 .. 180 ] Filter queries by bounding box minimum longitude |
| bboxMaxLon | number <float> [ -180 .. 180 ] Filter queries by bounding box maximum longitude |
| bboxMaxLat | number <float> [ -90 .. 90 ] Filter queries by bounding box maximum latitude |
| bboxMinLat | number <float> [ -90 .. 90 ] Filter queries by bounding box minimum latitude |
| sort | Array of strings Sorting of the search result (usage "field+asc" or "field+desc", default is desc) |
| filterDistributions | boolean If datasets are searched by facets distributions are returned filtered (default false) |
| aggregation | boolean Enables aggregation of facets (default true) |
| includes | Array of strings Descides which fields are included in the response (default all) |
| scroll | boolean Default: false Enable scroll and return a scroll id |
| minScoring | integer Filter by minimum quality measurement scoring value |
| maxScoring | integer Filter by maximum quality measurement scoring value |
| aggregationAllFields | boolean Default: true Aggregate all facets |
| aggregationFields | Array of strings Aggregate selected facets (ignored if aggregationAllFields is set true) |
| countryData | boolean If enabled only datasets from country catalogues are returned. If disabled only datasets from non-country catalogues are returned. If not specified (null), no filtering is performed. |
| showScore | boolean If enabled the score is returned for each result. Disabled as default. |
| vocabulary | Array of strings Filter by vocabulary id. Only effective when filter=vocabulary. |
| resource | Array of strings Filter by resource types. Only effective when "resource" is in "filters", for example, "filters=catalogue,resource" or "filters=resource". |
| dataServices | boolean Only show datasets which have a distribution with at least one access service (true). Default show all (false). |
| autocomplete | boolean Search with autocomplete style via title field. Default false. |
| superCatalogue | string Deprecated Deprecated. Please use "superCatalog" in the "facets" for filtering datasets or catalogues search result. |
| countOnly | boolean Default: false When set to true, the search result contains only the count of the search result. |
Responses
Response samples
- 200
- 400
- 500
{ }Search
To retrieve the data, send a POST request to the specified URL of the API endpoint with the resource path "/search" at the end of the URL. See the example here right. To obtain the desired result, use one or more of the parameters listed below. The parameters are pairs of names and their corresponding values, so-called name-value pairs. The request sent to the server with POST is stored in the request body according to Request Body Schema below. See the syntax of the request here on the right.
Request Body schema: application/jsonrequired
Query
| q | string The query |
| filter | string Filter queries by document type |
object Filter queries by facets (string as json, e.g. 'facets={"catalog":["catalog-x"]}') | |
| page | integer >= 0 The page number of matching results |
| limit | integer [ 0 .. 1000 ] The maximum number of matching datasets per page |
| fields | Array of strings Filter queries by document fields (e.g. 'fields=title') |
object | |
object Boost document fields | |
| globalAggregation | boolean Counting of facets globally or locally (default true) |
| facetOperator | string Enum: "AND" "OR" Filtering queries by facets are combined with "AND" or "OR" (default "OR") |
| facetGroupOperator | string Enum: "AND" "OR" Filtering queries by facetgroups are combined with "AND" or "OR" (default "AND") |
| sort | Array of strings Sorting of the search result (usage "field+asc" or "field+desc", default is desc) |
| filterDistributions | boolean If datasets are searched by facets distributions are returned filtered (default false) |
| aggregation | boolean Enables aggregation of facets (default true) |
| includes | Array of strings Descides which fields are included in the response (default all) |
| scroll | boolean Enables scroll and returns a scroll id (default true) |
| minScoring | integer Filter by minimum quality measurement scoring value |
| maxScoring | integer Filter by maximum quality measurement scoring value |
| aggregationAllFields | boolean Aggregate all facets (default true) |
| aggregationFields | Array of strings Aggregate selected facets (ignored if aggregationAllFields is set true) |
| countryData | boolean If enabled only datasets from country catalogues are returned. If disabled only datasets from non-country catalogues are returned. If not specified (null), no filtering is performed. |
Responses
Request samples
- Payload
{- "q": "string",
- "filter": "string",
- "facets": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "page": 0,
- "limit": 1000,
- "fields": [
- "string"
], - "searchParams": {
- "minDate": "2019-08-24T14:15:22Z",
- "maxDate": "2019-08-24T14:15:22Z",
- "boundingBox": {
- "minLon": -180,
- "maxLon": -180,
- "maxLat": -90,
- "minLat": -90
}, - "scoring": {
- "min": 0,
- "max": 0
}
}, - "boost": {
- "property1": 0.1,
- "property2": 0.1
}, - "globalAggregation": true,
- "facetOperator": "AND",
- "facetGroupOperator": "AND",
- "sort": [
- "string"
], - "filterDistributions": true,
- "aggregation": true,
- "includes": [
- "string"
], - "scroll": true,
- "minScoring": 0,
- "maxScoring": 0,
- "aggregationAllFields": true,
- "aggregationFields": [
- "string"
], - "countryData": true
}Response samples
- 200
- 400
- 500
{ }Scroll
Make a GET request to the specified URL of the API endpoint with the resource path "/scroll" at the end of the URL if you want to retrieve large number of results (or even all results) from a single search request. First you have to obtain the required parameter ScrollID (do so using method GET to the specified URL of the API endpoint with the resource path "search" at the end of the URL). Use SCROLL the same way you use cursor on a traditional database.
query Parameters
| scrollId required | string The scroll id |
Responses
Response samples
- 200
- 400
- 500
{ }Atom
Make a GET request to the specified URL of the API endpoint with the resource path "/{lang}/feeds/datasets.atom" at the end of the URL to get datasets' feeds in Atom format. Set the language element {lang} in the URL to preferred language (see path parameters here below, the languages abbreviation are made according to the standards). A syntactically correct request looks like the following example https://example.org/api/de/feeds/datasets.atom?q=hund
path Parameters
| lang required | string Enum: "bg" "es" "cs" "da" "et" "el" "en" "fr" "ga" "hr" "it" "lv" "lt" "hu" "mt" "nl" "pl" "pt" "ro" "sk" "sl" "fi" "sv" "no" "de" The feed is returned in the requested language |
query Parameters
| q | string The query |
| facets | string Filter queries by facets (string as json, e.g. 'facets={"catalog":["catalog-x"]}') |
| page | integer >= 0 The page number of matching results |
| limit | integer [ 1 .. 1000 ] The maximum number of matching datasets per page |
| fields | Array of strings Filter queries by document fields (e.g. 'fields=title') |
| minDate | string <date-time> Filter queries by minimum Date |
| maxDate | string <date-time> Filter queries by maximum Date |
| boost | object Boost document fields (boost.field=1.0 or boost.field.subfield=1.0, e.g. boost.title=3.0) |
| globalAggregation | boolean Counting of facets globally or locally (default true) |
| facetOperator | string Enum: "AND" "OR" Filtering queries by facets are combined with "AND" or "OR" (default "OR") |
| facetGroupOperator | string Enum: "AND" "OR" Filtering queries by facetgroups are combined with "AND" or "OR" (default "AND") |
| bboxMinLon | number <float> [ -180 .. 180 ] Filter queries by bounding box minimum longitude |
| bboxMaxLon | number <float> [ -180 .. 180 ] Filter queries by bounding box maximum longitude |
| bboxMaxLat | number <float> [ -90 .. 90 ] Filter queries by bounding box maximum latitude |
| bboxMinLat | number <float> [ -90 .. 90 ] Filter queries by bounding box minimum latitude |
| sort | Array of strings Sorting of the search result (usage "field+asc" or "field+desc", default is desc) |
| filterDistributions | boolean If datasets are searched by facets distributions are returned filtered (default false) |
| minScoring | integer Filter by minimum quality measurement scoring value |
| maxScoring | integer Filter by maximum quality measurement scoring value |
| countryData | boolean If enabled only datasets from country catalogues are returned. If disabled only datasets from non-country catalogues are returned. If not specified (null), no filtering is performed. |
| vocabulary | Array of strings Filter by vocabulary id. Only effective when filter=vocabulary. |
Responses
Response samples
- 200
- 400
- 500
{ }RSS
Make a GET request to the specified URL of the API endpoint with the resource path "/{lang}/feeds/datasets.rss" at the end of the URL to get datasets' feeds in RSS format. Set the language element {lang} in the URL to preferred language (see path parameters here below, the languages abbreviation are made according to the standards). A syntactically correct request looks like the following example https://example.org/api/de/feeds/datasets.rss?q=hund
path Parameters
| lang required | string Enum: "bg" "es" "cs" "da" "et" "el" "en" "fr" "ga" "hr" "it" "lv" "lt" "hu" "mt" "nl" "pl" "pt" "ro" "sk" "sl" "fi" "sv" "no" "de" The feed is returned in the requested language |
query Parameters
| q | string The query |
| facets | string Filter queries by facets (string as json, e.g. 'facets={"catalog":["catalog-x"]}') |
| page | integer >= 0 The page number of matching results |
| limit | integer [ 1 .. 1000 ] The maximum number of matching datasets per page |
| fields | Array of strings Filter queries by document fields (e.g. 'fields=title') |
| minDate | string <date-time> Filter queries by minimum Date |
| maxDate | string <date-time> Filter queries by maximum Date |
| boost | object Boost document fields (boost.field=1.0 or boost.field.subfield=1.0, e.g. boost.title=3.0) |
| globalAggregation | boolean Counting of facets globally or locally (default true) |
| facetOperator | string Enum: "AND" "OR" Filtering queries by facets are combined with "AND" or "OR" (default "OR") |
| facetGroupOperator | string Enum: "AND" "OR" Filtering queries by facetgroups are combined with "AND" or "OR" (default "AND") |
| bboxMinLon | number <float> [ -180 .. 180 ] Filter queries by bounding box minimum longitude |
| bboxMaxLon | number <float> [ -180 .. 180 ] Filter queries by bounding box maximum longitude |
| bboxMaxLat | number <float> [ -90 .. 90 ] Filter queries by bounding box maximum latitude |
| bboxMinLat | number <float> [ -90 .. 90 ] Filter queries by bounding box minimum latitude |
| sort | Array of strings Sorting of the search result (usage "field+asc" or "field+desc", default is desc) |
| filterDistributions | boolean If datasets are searched by facets distributions are returned filtered (default false) |
| minScoring | integer Filter by minimum quality measurement scoring value |
| maxScoring | integer Filter by maximum quality measurement scoring value |
| countryData | boolean If enabled only datasets from country catalogues are returned. If disabled only datasets from non-country catalogues are returned. If not specified (null), no filtering is performed. |
Responses
Response samples
- 200
- 400
- 500
{ }RSS for a single dataset
Make a GET request to the specified URL of the API endpoint with the resource path "{lang}/feeds/datasets/{id}.rss" to retrieve the RSS feed of a dataset with an exact ID. Set the language element {lang} in the URL to preferred language (see path parameters here below, the languages abbreviation are made according to the standards), set the unique identifier of the dataset as {id} element of the URL.
path Parameters
| lang required | string Enum: "bg" "es" "cs" "da" "et" "el" "en" "fr" "ga" "hr" "it" "lv" "lt" "hu" "mt" "nl" "pl" "pt" "ro" "sk" "sl" "fi" "sv" "no" "de" The feed is returned in the requested language |
| id required | string Id of the requested dataset |
Responses
Response samples
- 200
- 400
- 500
{ }List datasets
You can get a list of datasets of an exact catalogue making a GET request to the specified URL of the API endpoint with the resource path "/datasets" at the end of the URL and required query parameter 'catalogue'. The value of the query parameter is the unique ID of the catalog (you can get the IDs of all existing catalogs using the 'List Catalogues' operation). If successful, the response will contain an array with the IDs of all records in the catalog.
query Parameters
| catalogue required | string Catalogue to which the datasets belong. |
| alias | string Default: "read" Alias, default 'read' |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}
}Create a dataset
This function is reserved for internal use only and is not part of our public API offerings
Authorizations:
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| references | string |
Array of objects | |
object | |
| source | Array of strings |
| was_generated_by | Array of strings |
Array of objects | |
object | |
Array of objects | |
object | |
| identifier | Array of strings |
object | |
| num_series | integer |
Array of objects | |
object | |
Array of objects | |
Date (string) or DateTime (string) | |
Array of objects | |
| is_hvd | boolean |
| stat_unit_measure | Array of strings |
Array of objects | |
Array of objects | |
object | |
Date (string) or DateTime (string) | |
Date (string) or DateTime (string) | |
| is_version_of | Array of strings |
| dimension | Array of strings |
object | |
| spatial_resolution_in_meters | integer |
Array of objects | |
| has_version | Array of strings |
object | |
| is_referenced_by | Array of strings |
Array of objects | |
| temporal_resolution | string |
| resource | string |
Array of objects | |
object | |
Array of objects | |
Array of objects | |
| quality_process_uri | string |
object | |
object | |
Array of objects | |
object | |
Array of objects | |
object | |
| id | string |
| relation | Array of strings |
Array of objects | |
| sample | Array of strings |
Array of objects | |
Array of objects | |
| qualified_attribution | Array of strings |
| attribute | Array of strings |
| has_quality_annotation | Array of strings |
Array of objects | |
object | |
| version_info | string |
object | |
Array of objects | |
| applicable_legislation | Array of strings |
object | |
Array of objects | |
object | |
Array of objects | |
| spatial | Array of objects |
Responses
Request samples
- Payload
{- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}Response samples
- 201
- 400
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Get a dataset
You can get a dataset making GET request to the specified URL of the API endpoint with the resource path "datasets/{id}" at the end of the URL. Set the unique ID of the dataset as {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the requested dataset |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}
}Create or Update a dataset
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to create or update a dataset. As an authorized user, you make a PUT request to the specified URL of the API endpoint with the resource path "datasets/{id}" and specify the unique ID of the dataset as the {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the created or updated dataset |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| references | string |
Array of objects | |
object | |
| source | Array of strings |
| was_generated_by | Array of strings |
Array of objects | |
object | |
Array of objects | |
object | |
| identifier | Array of strings |
object | |
| num_series | integer |
Array of objects | |
object | |
Array of objects | |
Date (string) or DateTime (string) | |
Array of objects | |
| is_hvd | boolean |
| stat_unit_measure | Array of strings |
Array of objects | |
Array of objects | |
object | |
Date (string) or DateTime (string) | |
Date (string) or DateTime (string) | |
| is_version_of | Array of strings |
| dimension | Array of strings |
object | |
| spatial_resolution_in_meters | integer |
Array of objects | |
| has_version | Array of strings |
object | |
| is_referenced_by | Array of strings |
Array of objects | |
| temporal_resolution | string |
| resource | string |
Array of objects | |
object | |
Array of objects | |
Array of objects | |
| quality_process_uri | string |
object | |
object | |
Array of objects | |
object | |
Array of objects | |
object | |
| id | string |
| relation | Array of strings |
Array of objects | |
| sample | Array of strings |
Array of objects | |
Array of objects | |
| qualified_attribution | Array of strings |
| attribute | Array of strings |
| has_quality_annotation | Array of strings |
Array of objects | |
object | |
| version_info | string |
object | |
Array of objects | |
| applicable_legislation | Array of strings |
object | |
Array of objects | |
object | |
Array of objects | |
| spatial | Array of objects |
Responses
Request samples
- Payload
{- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}Response samples
- 200
- 201
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Modify a dataset
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to edit a dataset. As an authorized user, you make a PATCH request to the specified URL of the API endpoint adding the resource path "datasets/{id}" to the end of the URL. Specify the unique ID of the dataset as the {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the modified dataset |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| references | string |
Array of objects | |
object | |
| source | Array of strings |
| was_generated_by | Array of strings |
Array of objects | |
object | |
Array of objects | |
object | |
| identifier | Array of strings |
object | |
| num_series | integer |
Array of objects | |
object | |
Array of objects | |
Date (string) or DateTime (string) | |
Array of objects | |
| is_hvd | boolean |
| stat_unit_measure | Array of strings |
Array of objects | |
Array of objects | |
object | |
Date (string) or DateTime (string) | |
Date (string) or DateTime (string) | |
| is_version_of | Array of strings |
| dimension | Array of strings |
object | |
| spatial_resolution_in_meters | integer |
Array of objects | |
| has_version | Array of strings |
object | |
| is_referenced_by | Array of strings |
Array of objects | |
| temporal_resolution | string |
| resource | string |
Array of objects | |
object | |
Array of objects | |
Array of objects | |
| quality_process_uri | string |
object | |
object | |
Array of objects | |
object | |
Array of objects | |
object | |
| id | string |
| relation | Array of strings |
Array of objects | |
| sample | Array of strings |
Array of objects | |
Array of objects | |
| qualified_attribution | Array of strings |
| attribute | Array of strings |
| has_quality_annotation | Array of strings |
Array of objects | |
object | |
| version_info | string |
object | |
Array of objects | |
| applicable_legislation | Array of strings |
object | |
Array of objects | |
object | |
Array of objects | |
| spatial | Array of objects |
Responses
Request samples
- Payload
{- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Delete a dataset
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to delete a dataset. As an authorized user, you make a DELETE request to the specified URL of the API endpoint with the resource path "datasets/{id}" at the end of the URL and specify the unique ID of the dataset as the {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the requested dataset |
query Parameters
| synchronous | boolean Default: true If disbled the execution is asynchronous (response code 202) |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Get a specific dataset version Deprecated
Deprecated. Please use GET /datasets/{id}/revisions/{revisionId} instead.
path Parameters
| id required | string Id of the requested dataset |
| revision required | string Id of the requested dataset version |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}
}Create specific dataset revision
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create a dataset-revision, sending PUT request to the specified URL of the API endpoint with the resource path datasets/{id}/revisions/{revisionId} at the end of the URL. Set the unique ID of the dataset which owns the dataset-revision as {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the requested dataset |
| revisionId required | string Id of the requested dataset revision |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Responses
Response samples
- 201
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Get a specific dataset revision
When a dataset is updated, the current dataset is saved as a revision. To get a specific dataset's revision make GET request to the specified URL of the API endpoint with the resource path datasets/{id}/revisions/{revisionId} at the end of the URL. Set the unique ID of the dataset as {id} and revision ID as {revisionId} elements of the URL.
path Parameters
| id required | string Id of the requested dataset |
| revisionId required | string Id of the requested dataset revision |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}
}Delete a specific dataset version
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized to delete a dataset-revision. As an authorized user, you make a DELETE request to the specified URL of the API endpoint with the resource path datasets/{id}/revisions/{revisionId} at the end of the URL. Specify the unique ID of the dataset as the {id} and revision ID as {revisionId} elements of the URL.
Authorizations:
path Parameters
| id required | string Id of the requested dataset |
| revisionId required | string Id of the requested dataset revision |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Bulk-create/update of datasets
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create or update multiple datasets. Send PUT request to specified URL of the API endpoint with the resource path "/bulk/datasets". According to the Request Body Schema the required parameter is key - value pair with 'datasets' as key and an array of Datasets Objects as value. By creating Dataset Object, the ID can be freely chosen for every new dataset. The catalogue ID determines the catalogue to which the dataset is added. The dataset ID is scoped within the catalogue. If the combination of dataset ID and catalogue ID already exists, the dataset is updated. Otherwise, a new dataset is created. This operation is not atomic.
Authorizations:
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
required | Array of objects (Dataset) [ 1 .. 500 ] items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array ([ 1 .. 500 ] items)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
{- "datasets": [
- {
- "references": "string",
- "adms_identifier": [
- {
- "identifier": "string",
- "scheme": "string",
- "resource": "string"
}
], - "type": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "source": [
- "string"
], - "was_generated_by": [
- "string"
], - "temporal": [
- {
- "lte": "2019-08-24",
- "gte": "2019-08-24"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "distributions": [
- {
- "id": "string",
- "type": {
- "resource": "string",
- "label": "string"
}, - "status": {
- "resource": "string",
- "label": "string"
}, - "issued": "2019-08-24",
- "spatial_resolution_in_meters": 0,
- "byte_size": 0,
- "compress_format": {
- "resource": "string",
- "label": "string"
}, - "license_attribution_by_text": {
- "property1": "string",
- "property2": "string"
}, - "package_format": {
- "resource": "string",
- "label": "string"
}, - "access_url": [
- "string"
], - "media_type": "string",
- "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "access_service": [
- {
- "applicable_legislation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": null,
- "property2": null
}, - "description": {
- "property1": null,
- "property2": null
}, - "format": {
- "id": null,
- "label": null,
- "resource": null
}, - "resource": "string"
}
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": null,
- "property2": null
}, - "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "endpoint_url": [
- "string"
], - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- null
], - "organisation_name": "string",
- "resource": "string"
}
], - "rights": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "checksum": {
- "algorithm": "string",
- "checksum_value": "string"
}, - "license": {
- "resource": "string",
- "label": "string",
- "homepage": "string",
- "description": "string"
}, - "applicable_legislation": [
- "string"
], - "rights": {
- "resource": "string",
- "label": "string"
}, - "title": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "resource": "string",
- "label": "string"
}, - "temporal_resolution": "string",
- "has_policy": "string",
- "description": {
- "property1": "string",
- "property2": "string"
}, - "availability": {
- "resource": "string",
- "label": "string"
}, - "modified": "2019-08-24",
- "download_url": [
- "string"
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
]
}
], - "translation_meta": {
- "full_available_languages": [
- "string"
], - "details": {
- "property1": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}, - "property2": {
- "machine_translated": true,
- "original_language": "string",
- "issued": "2019-08-24",
- "received": "2019-08-24"
}
}, - "status": "string"
}, - "identifier": [
- "string"
], - "extended_metadata": {
- "is_used_by": [
- "string"
]
}, - "num_series": 0,
- "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
], - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "keywords": [
- {
- "id": "string",
- "label": "string",
- "language": "string"
}
], - "issued": "2019-08-24",
- "categories": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "is_hvd": true,
- "stat_unit_measure": [
- "string"
], - "political_geocoding_level_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "publisher": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "deadline": "2019-08-24",
- "modified": "2019-08-24",
- "is_version_of": [
- "string"
], - "dimension": [
- "string"
], - "availability": {
- "resource": "string",
- "label": "string"
}, - "spatial_resolution_in_meters": 0,
- "political_geocoding_uri": [
- {
- "resource": "string",
- "label": "string"
}
], - "has_version": [
- "string"
], - "access_right": {
- "resource": "string",
- "label": "string"
}, - "is_referenced_by": [
- "string"
], - "originator": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "temporal_resolution": "string",
- "resource": "string",
- "maintainer": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "description": {
- "property1": "string",
- "property2": "string"
}, - "contributor": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}
], - "provenance": [
- {
- "resource": "string",
- "label": "string"
}
], - "quality_process_uri": "string",
- "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "catalog_record": {
- "modified": "2019-08-24",
- "issued": "2019-08-24"
}, - "contributor_id": [
- {
- "resource": "string",
- "label": "string"
}
], - "accrual_periodicity": {
- "resource": "string",
- "label": "string"
}, - "subject": [
- {
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "quality_meas": {
- "scoring": 0
}, - "id": "string",
- "relation": [
- "string"
], - "page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "sample": [
- "string"
], - "hvd_category": [
- {
- "id": "string",
- "label": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
], - "conforms_to": [
- {
- "resource": "string",
- "label": "string"
}
], - "qualified_attribution": [
- "string"
], - "attribute": [
- "string"
], - "has_quality_annotation": [
- "string"
], - "landing_page": [
- {
- "title": {
- "property1": "string",
- "property2": "string"
}, - "description": {
- "property1": "string",
- "property2": "string"
}, - "format": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "resource": "string"
}
], - "version_notes": {
- "property1": "string",
- "property2": "string"
}, - "version_info": "string",
- "geocoding_description": {
- "property1": "string",
- "property2": "string"
}, - "qualified_relation": [
- {
- "relation": [
- "string"
], - "had_role": [
- "string"
]
}
], - "applicable_legislation": [
- "string"
], - "legal_basis": {
- "property1": "string",
- "property2": "string"
}, - "contact_point": [
- {
- "type": "string",
- "name": "string",
- "email": "string",
- "address": "string",
- "telephone": "string",
- "url": [
- "string"
], - "organisation_name": "string",
- "resource": "string"
}
], - "catalog": {
- "id": "string",
- "is_part_of": "string"
}, - "open_data_presence": [
- {
- "id": "string",
- "label": "string"
}
], - "spatial": [
- { }
]
}
]
}Response samples
- 200
- 400
- 500
{- "datasets": [
- {
- "success": true,
- "status": 0,
- "message": "string",
- "id": "string"
}
]
}List catalogues
You can get a list of catalogues making a GET request to specified URL of the API endpoint with the the resource path "catalogues" at the end. If successful, the response contains an array with IDs of all the catalogues.
query Parameters
| alias | string Default: "read" Alias, default 'read' |
Responses
Response samples
- 200
- 400
- 404
- 500
[- "string1",
- "string2",
- "string3"
]Create a catalogue
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation.
Authorizations:
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| is_open_data_presence | boolean |
object | |
| spatial | Array of objects |
| id | string |
Date (string) or DateTime (string) | |
| is_part_of | string |
object | |
| visualisation_data | string |
| catalogueLogo | Array of strings |
object | |
| catalogueProfile | Array of strings |
| theme_taxonomy | Array of strings |
object | |
Array of objects | |
| catalogueInterestingDatasets | Array of strings |
object | |
object | |
| visualisation_selection | Array of strings |
| catalog | Array of strings |
Date (string) or DateTime (string) | |
object | |
object | |
| catalogueBackground | Array of strings |
| catalogueFavIcon | Array of strings |
| homepage | string |
| has_part | Array of strings |
Array of objects |
Responses
Request samples
- Payload
{- "is_open_data_presence": true,
- "description": {
- "property1": "string",
- "property2": "string"
}, - "spatial": [
- { }
], - "id": "string",
- "modified": "2019-08-24",
- "is_part_of": "string",
- "availability": {
- "resource": "string",
- "label": "string"
}, - "visualisation_data": "string",
- "catalogueLogo": [
- "string"
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "catalogueProfile": [
- "string"
], - "theme_taxonomy": [
- "string"
], - "license": {
- "homepage": "string",
- "description": "string",
- "label": "string",
- "resource": "string"
}, - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "catalogueInterestingDatasets": [
- "string"
], - "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "publisher": {
- "address": {
- "postalCode": "string",
- "street": "string",
- "locality": "string"
}, - "homepage": "string",
- "name": "string",
- "email": "string"
}, - "visualisation_selection": [
- "string"
], - "catalog": [
- "string"
], - "issued": "2019-08-24",
- "rights": {
- "resource": "string",
- "label": "string"
}, - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "catalogueBackground": [
- "string"
], - "catalogueFavIcon": [
- "string"
], - "homepage": "string",
- "has_part": [
- "string"
], - "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
]
}Response samples
- 201
- 400
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Get a catalogue
You can get a catalogue making GET request to the specified URL of the API endpoint with the resource path "catalogues/{id}" at the end of the URL and set the unique ID of the catalogue as {id} element of the URL. If successful, the response contains the Catalogue object for a valid ID.
path Parameters
| id required | string Id of the requested catalogue |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "is_open_data_presence": true,
- "description": {
- "property1": "string",
- "property2": "string"
}, - "spatial": [
- { }
], - "id": "string",
- "modified": "2019-08-24",
- "is_part_of": "string",
- "availability": {
- "resource": "string",
- "label": "string"
}, - "visualisation_data": "string",
- "catalogueLogo": [
- "string"
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "catalogueProfile": [
- "string"
], - "theme_taxonomy": [
- "string"
], - "license": {
- "homepage": "string",
- "description": "string",
- "label": "string",
- "resource": "string"
}, - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "catalogueInterestingDatasets": [
- "string"
], - "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "publisher": {
- "address": {
- "postalCode": "string",
- "street": "string",
- "locality": "string"
}, - "homepage": "string",
- "name": "string",
- "email": "string"
}, - "visualisation_selection": [
- "string"
], - "catalog": [
- "string"
], - "issued": "2019-08-24",
- "rights": {
- "resource": "string",
- "label": "string"
}, - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "catalogueBackground": [
- "string"
], - "catalogueFavIcon": [
- "string"
], - "homepage": "string",
- "has_part": [
- "string"
], - "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
]
}
}Create or Update a catalogue
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create or update a catalogue, sending PUT request to the specified URL of the API endpoint with the resource path "catalogues/{id}" at the end of the URL, the ID can be freely chosen for every new catalogue. If the catalogue ID already exists, the catalogue with the indicated ID is updated.
Authorizations:
path Parameters
| id required | string Id of the created or updated catalogue |
query Parameters
| synchronous | boolean Default: true If disbled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| is_open_data_presence | boolean |
object | |
| spatial | Array of objects |
| id | string |
Date (string) or DateTime (string) | |
| is_part_of | string |
object | |
| visualisation_data | string |
| catalogueLogo | Array of strings |
object | |
| catalogueProfile | Array of strings |
| theme_taxonomy | Array of strings |
object | |
Array of objects | |
| catalogueInterestingDatasets | Array of strings |
object | |
object | |
| visualisation_selection | Array of strings |
| catalog | Array of strings |
Date (string) or DateTime (string) | |
object | |
object | |
| catalogueBackground | Array of strings |
| catalogueFavIcon | Array of strings |
| homepage | string |
| has_part | Array of strings |
Array of objects |
Responses
Request samples
- Payload
{- "is_open_data_presence": true,
- "description": {
- "property1": "string",
- "property2": "string"
}, - "spatial": [
- { }
], - "id": "string",
- "modified": "2019-08-24",
- "is_part_of": "string",
- "availability": {
- "resource": "string",
- "label": "string"
}, - "visualisation_data": "string",
- "catalogueLogo": [
- "string"
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "catalogueProfile": [
- "string"
], - "theme_taxonomy": [
- "string"
], - "license": {
- "homepage": "string",
- "description": "string",
- "label": "string",
- "resource": "string"
}, - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "catalogueInterestingDatasets": [
- "string"
], - "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "publisher": {
- "address": {
- "postalCode": "string",
- "street": "string",
- "locality": "string"
}, - "homepage": "string",
- "name": "string",
- "email": "string"
}, - "visualisation_selection": [
- "string"
], - "catalog": [
- "string"
], - "issued": "2019-08-24",
- "rights": {
- "resource": "string",
- "label": "string"
}, - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "catalogueBackground": [
- "string"
], - "catalogueFavIcon": [
- "string"
], - "homepage": "string",
- "has_part": [
- "string"
], - "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
]
}Response samples
- 200
- 201
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Modify a catalogue
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can modify a catalogue, sending PATCH request to the specified URL of the API endpoint with the resource path "catalogues/{id}" and specify the unique ID of the catalogue as the {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the modified catalogue |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| is_open_data_presence | boolean |
object | |
| spatial | Array of objects |
| id | string |
Date (string) or DateTime (string) | |
| is_part_of | string |
object | |
| visualisation_data | string |
| catalogueLogo | Array of strings |
object | |
| catalogueProfile | Array of strings |
| theme_taxonomy | Array of strings |
object | |
Array of objects | |
| catalogueInterestingDatasets | Array of strings |
object | |
object | |
| visualisation_selection | Array of strings |
| catalog | Array of strings |
Date (string) or DateTime (string) | |
object | |
object | |
| catalogueBackground | Array of strings |
| catalogueFavIcon | Array of strings |
| homepage | string |
| has_part | Array of strings |
Array of objects |
Responses
Request samples
- Payload
{- "is_open_data_presence": true,
- "description": {
- "property1": "string",
- "property2": "string"
}, - "spatial": [
- { }
], - "id": "string",
- "modified": "2019-08-24",
- "is_part_of": "string",
- "availability": {
- "resource": "string",
- "label": "string"
}, - "visualisation_data": "string",
- "catalogueLogo": [
- "string"
], - "title": {
- "property1": "string",
- "property2": "string"
}, - "catalogueProfile": [
- "string"
], - "theme_taxonomy": [
- "string"
], - "license": {
- "homepage": "string",
- "description": "string",
- "label": "string",
- "resource": "string"
}, - "language": [
- {
- "id": "string",
- "resource": "string",
- "label": "string"
}
], - "catalogueInterestingDatasets": [
- "string"
], - "country": {
- "id": "string",
- "label": "string",
- "resource": "string"
}, - "publisher": {
- "address": {
- "postalCode": "string",
- "street": "string",
- "locality": "string"
}, - "homepage": "string",
- "name": "string",
- "email": "string"
}, - "visualisation_selection": [
- "string"
], - "catalog": [
- "string"
], - "issued": "2019-08-24",
- "rights": {
- "resource": "string",
- "label": "string"
}, - "creator": {
- "type": "string",
- "name": "string",
- "email": "string",
- "homepage": "string",
- "resource": "string"
}, - "catalogueBackground": [
- "string"
], - "catalogueFavIcon": [
- "string"
], - "homepage": "string",
- "has_part": [
- "string"
], - "spatial_resource": [
- {
- "id": "string",
- "label": "string",
- "resource": "string"
}
]
}Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Delete a catalogue
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can delete a catalogue, sending DELETE request the specified URL of the API endpoint with the resource path "catalogues/{id}" at the end of the URL. Specify the unique ID of the catalogue as the {id} element of the URL.
Authorizations:
path Parameters
| id required | string Id of the requested catalogue |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Get list of indexed vocabularies
You can get a list of controlled vocabularies used by the portal sending a GET request to the specified URL of the API endpoint with the resource path "vocabularies" at the end of the URL. If successful, the response contains an array with IDs of all the vocabularies.
Responses
Response samples
- 200
- 400
- 404
- 500
{- "datasets": [
- {
- "success": true,
- "status": 0,
- "message": "string",
- "id": "string"
}
]
}Get a vocabulary
You can get a vocabulary, making GET request to the specified URL of the API endpoint with the resource path "vocabularies/{vocabulary}". Set the unique ID of the vocabulary as {vocabulary} element of the URL. If successful, the response contains the Vocabulary object for a valid ID.
path Parameters
| vocabulary required | string Id of the requested vocabulary |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "datasets": [
- {
- "success": true,
- "status": 0,
- "message": "string",
- "id": "string"
}
]
}Create or Update a vocabulary
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create or update a vocabulary, sending PUT request to the specified URL of the API endpoint with the resource path "vocabularies/{vocabulary}" at the end of the URL. Set the unique ID of the vocabulary as {vocabulary} element of the URL, if the vocabulary ID already exists, the vocabulary is updated.
Authorizations:
path Parameters
| vocabulary required | string Id of the created or updated vocabulary |
query Parameters
| synchronous | boolean Default: true If disbled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
required | Array of objects (Vocable) | ||||||
Array
| |||||||
Responses
Request samples
- Payload
{- "vocab": [
- {
- "id": "string",
- "title": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
]
}Response samples
- 200
- 201
- 400
- 404
- 500
{- "datasets": [
- {
- "success": true,
- "status": 0,
- "message": "string",
- "id": "string"
}
]
}Delete a vocabulary
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can delete a vocabulary by sending your DELETE request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabulary}". Set the {vocabulary} as the unique ID of the vocabulary you want to delete.
Authorizations:
path Parameters
| vocabulary required | string Id of the to be deleted vocabulary |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Create a vocable
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can add a term to a vocabulary sending a POST request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabulary}". Set the unique ID of the vocabulary as {vocabulary} element of the URL.
Authorizations:
path Parameters
| vocabulary required | string Vocabulary of the created vocable |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| id | string |
object | |
| resource | string |
Responses
Request samples
- Payload
{- "id": "string",
- "title": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}Response samples
- 201
- 400
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Get a vocable by URI
Returns a vocable for a given vocabulary based on the resource identifier aka URI of that vocable. For example http://www.opendefinition.org/licenses/cc-by.
path Parameters
| vocabulary required | string Vocabulary of the requested vocable |
query Parameters
| resource required | string URI of the requested vocable |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string",
- "title": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
}Get a vocable
You can get a vocable, making GET request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabulary}/{id}". Set the unique ID of the vocabulary as {vocabulary} element, set the unique ID of the vocable as {id} element of the URL. If successful, the response contains the Vocable object for a valid ID.
path Parameters
| vocabulary required | string Vocabulary of the requested vocable |
| id required | string Id of the requested vocable |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string",
- "title": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}
}Create or Update a vocable
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can create or update a vocable, sending PUT request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabulary}/{id}" at the end of the URL. Set the unique ID of the vocabulary as {vocabulary} element, set the unique ID of the vocable as {id} element of the URL, if the vocable ID already exists, the vocable is updated.
Authorizations:
path Parameters
| vocabulary required | string Vocabulary of the created or updated vocable |
| id required | string Id of the created or updated Vocable |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| id | string |
object | |
| resource | string |
Responses
Request samples
- Payload
{- "id": "string",
- "title": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}Response samples
- 200
- 201
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Modify a vocable
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can modify a vocable with an exact ID, sending PATCH request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabulary}/{id}". Set the unique ID of the vocabulary as {vocabulary} element, set the unique ID of the vocable you want to modify as {id} element of the URL.
Authorizations:
path Parameters
| vocabulary required | string Vocabulary of the modified vocable |
| id required | string Id of the modified vocable |
query Parameters
| synchronous | boolean Default: true If disabled the execution is asynchronous (response code 202) |
Request Body schema: application/jsonrequired
| id | string |
object | |
| resource | string |
Responses
Request samples
- Payload
{- "id": "string",
- "title": {
- "property1": "string",
- "property2": "string"
}, - "resource": "string"
}Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Delete a vocable
This function is reserved for internal use only and is not part of our public API offerings. You must be authorized for this operation. As an authorized user you can delete a vocable, sending DELETE request to the specified URL of the API endpoint with the resource path "/vocabularies/{vocabulary}/{id}" at the end of the URL. Set the unique ID of the vocabulary as {vocabulary} element, set the unique ID of the vocable you want to delete as {id} element of the URL.
Authorizations:
path Parameters
| vocabulary required | string Vocabulary of the deleted vocable |
| id required | string Id of the deleted vocabulary |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "success": true,
- "result": {
- "id": "string"
}
}Gazetteer
You can get a list of Gazetteer entries making a GET request to the specified URL of the API endpoint with the resource path "/gazetteer/autocomplete" with required parameter 'q'. The value of the parameter is any string (e.g. a place name). If successful, the response contains an array with gazetteer entries. Your query matches the values of the name-value pairs of the returned entries in whole words and/ or substrings.
query Parameters
| q | string The query string |
Responses
Response samples
- 200
- 400
- 500
{ }Package search
You can search for datasets (on CKAN data management versions datasets called "packages" ) satisfying a given search criteria, send a GET request to the specified URL of the API endpoint with the resource path "/ckan/package_search". To obtain the desired result, use one or more of the parameters listed below.
query Parameters
| q | string The query |
| fq | string Any filter queries to apply |
| sort | string Sorting of the search results |
| rows | integer The number of matching rows to return |
| start | integer The offset in the complete result for where the set of returned datasets should begin |
| facet | boolean Whether to enable faceted results |
| facet.mincount | integer The minimum counts for facet fields should be included in the results |
| facet.field | Array of strings The minimum counts for facet fields should be included in the results |
Responses
Response samples
- 200
- 400
- 500
{ }Package show
Get the metadata of a dataset (on CKAN data management versions datasets called "packages") making GET request to the specified URL of the API endpoint with the resource path "ckan/package_show" and with required parameter 'id'. The value of the parameter is the unique ID of the dataset. If successful, the response contains the metadata of the dataset and its resources.
query Parameters
| id required | string The id of the requested dataset |
Responses
Response samples
- 200
- 400
- 404
- 500
{ }