1. Overview

This document provides information about the implementation of the GeoPlatform API. Please refer to the GeoPlatform Client API documentation for information on using the client libraries to interact with this API.

1.1. Version information

Version : 1.1.0

1.2. Contact information

Contact : GeoPlatform Service Desk
Contact Email : servicedesk@geoplatform.gov

1.3. License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : null

1.4. URI scheme

Host : ual.geoplatform.gov
BasePath : /api
Schemes : HTTPS

1.5. Tags

  • dataset

  • service

  • layer

  • map

  • gallery

  • community

  • recommender

  • agol

  • misc

2. Definitions

2.1. Address

address

Name Description Schema

country
optional

Country
Example : "United States"

string

locality
optional

City or locality
Example : "Anywhere"

string

region
optional

State or region
Example : "District of Columbia"

string

street
optional

Street address
Example : "123 Main St"

string

zip
optional

Zipcode
Example : "00000"

string

2.2. Agent

an person or organization

Name Description Schema

created
optional

milliseconds of creation date

number

description
optional

A brief description of this item

string

id
optional

the unique identifier of this item

string

label
optional

A display label for this item

string

modified
optional

milliseconds of last modified date

number

name
optional

Name of the item

string

uri
optional

unique, immutable URI of the item

string

2.3. Community

A Community Item, sub-class of #/definitions/Item

Polymorphism : Composition

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

attributions
optional

< string > array

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

The geographic extent of the item, in WGS84

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

modified
optional

Milliseconds timestamp of last modified date

number (long)

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

2.4. Concept

a concept

Name Description Schema

created
optional

milliseconds of creation date

number

description
optional

A brief description of this item

string

id
optional

the unique identifier of this item

string

label
optional

A display label for this item

string

modified
optional

milliseconds of last modified date

number

name
optional

Name of the item

string

scheme
optional

A Concept Scheme to which this Concept is associated

uri
optional

unique, immutable URI of the item

string

2.5. ConceptScheme

a concept scheme

Name Description Schema

created
optional

milliseconds of creation date

number

description
optional

A brief description of this item

string

id
optional

the unique identifier of this item

string

label
optional

A display label for this item

string

modified
optional

milliseconds of last modified date

number

name
optional

Name of the item

string

uri
optional

unique, immutable URI of the item

string

2.6. Dataset

an item, sub-class of #definitions/Item

Polymorphism : Composition

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

attributions
optional

< string > array

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

The geographic extent of the item, in WGS84

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

modified
optional

Milliseconds timestamp of last modified date

number (long)

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

services
optional

A set of Services which operate against this Dataset

< Service > array

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

2.7. Distribution

A distribution object which describes mechanisms for accessing data or services

Name Description Schema

byteSize
optional

The size of the distribution in bytes
Example : "The custom implementation of a OGC Web Map Service provided by Acme, Inc."

number

description
optional

A detailed description of the distribution
Example : "The custom implementation of a OGC Web Map Service provided by Acme, Inc."

string

download
optional

URL used to download a distribution such as a zip or xml file
Example : "http://www.geoplatform.gov/files/test.xml"

string

format
optional

The file format of the distribution

href
optional

URL used to access the distribution
Example : "http://www.geoplatform.gov"

string

mediaType
optional

The mime-type of the distribution

enum (image/png, image/jpeg, text/html, text/plain, text/xml, application/json, application/zip, other)

parameters
optional

A list of parameters used to access the distribution

role
optional

A role associated with the distribution to its parent GeoPlatform Item

title
optional

A clear, concise name for the distribution
Example : "My WMS Web Service"

string

type
optional

the type of this object, must be 'dcat:Distribution'

enum (dcat:Distribution)

format

Name Description Schema

label
optional

name of the file format
Example : "XML"

string

role

Name Description Schema

label
optional

name of the role

string

uri
optional

unique uri associated with the role

string

2.8. DistributionParameter

A distribution object which describes mechanisms for accessing data or services

Name Description Schema

defaultValue
optional

A default value to use if any
Example : "v1.0"

string

description
optional

A detailed description of the parameter
Example : "This parameter configures the version to request"

string

label
optional

A label for the parameter
Example : "Parameter One"

string

max
optional

A maximum bounds for numeric values
Example : 100.0

number

min
optional

A minimum bounds for numeric values
Example : 0.0

number

name
optional

The name used to represent the parameter in the distribution’s href value
Example : "paramOne"

string

type
optional

the type of parameter

enum (string, number)

values
optional

A list of values to pick from

< string > array

2.9. Error

Name Description Schema

error
optional

The type of error

string

message
optional

A message detailing the specifics of the error

string

status
optional

HTTP Status Code of the error

integer

2.10. Extent

the geographic extent of an object, in WGS84

Name Description Schema

maxx
optional

East Bounding Longitude
Minimum value : -180
Maximum value : 180
Example : -60.0

number (double)

maxy
optional

North Bounding Latitude
Minimum value : -90
Maximum value : 90
Example : 50.0

number (double)

minx
optional

West Bounding Longitude
Minimum value : -180
Maximum value : 180
Example : -120.0

number (double)

miny
optional

South Bounding Latitude
Minimum value : -90
Maximum value : 90
Example : 20.0

number (double)

2.11. FeatureStyle

feature layer style information

Name Description Schema

color
optional

rgb or hexidecimal color string

string

fillColor
optional

rgb or hexidecimal color string

string

fillOpacity
optional

decimal from 0 to 1

number

opacity
optional

decimal from 0 to 1

number

radius
optional

integer value starting at 1

number

shape
optional

the type of feature

enum (point, line, polygon, image)

weight
optional

integer value starting at 1

number

2.12. FetchRequest

set of identifiers to fetch at once

Type : < string > array

A Gallery Item, sub-class of #/definitions/Item

Polymorphism : Composition

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

attributions
optional

< string > array

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

The geographic extent of the item, in WGS84

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

items
required

The set of Items associated with this Gallery

< items > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

modified
optional

Milliseconds timestamp of last modified date

number (long)

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

Name Description Schema

assetId
optional

identifier of the item

string

assetType
optional

Item type

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, Gallery, org:Person, vcard:VCard, org:Organization, Community)

description
optional

brief description of the item

string

label
optional

title of the item

string

2.14. GazetteerResult

geocoded location information for specified request information

Name Description Schema

country
optional

Name of the country containing the location

string

countryCode
optional

Abbreviation for country name

string

label
optional

Display label of the location

string

latitude
optional

WGS84 Latitude of location

number

locality
optional

Name of the town/city of the location

string

longitude
optional

WGS84 Longitude of location

number

provider
optional

Geocoding service used to provide results

string

region
optional

Name of the state/region of the location

string

2.15. HarvestRequest

harvest request payload

Name Description Schema

serviceType
optional

name of service specification of service to harvest from

enum (Esri REST Map Service, OGC Web Map Service (WMS))

url
optional

url of service to harvest from

string

2.16. HarvestResponse

harvest response payload

Name Description Schema

errors
optional

list of errors encountered during harvest

< object > array

layers
optional

service layers information harvested

< Layer > array

service
optional

serviceType
optional

name of service specification of service to harvest from

enum (Esri REST Map Service, OGC Web Map Service (WMS))

url
optional

url of service harvested

string

2.17. Item

an item

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

attributions
optional

< string > array

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

The geographic extent of the item, in WGS84

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

modified
optional

Milliseconds timestamp of last modified date

number (long)

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

2.18. Layer

A layer item, sub-class of #/definitions/Item

Polymorphism : Composition

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

attributions
optional

< string > array

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

datasets
optional

A set of Datasets which back this Layer

< Dataset > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

The geographic extent of the item, in WGS84

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

legend
optional

A legend for this Layer

modified
optional

Milliseconds timestamp of last modified date

number (long)

parentLayer
optional

A containing Layer for this Layer

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

services
optional

A set of Services which host this Layer

< Service > array

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

subLayers
optional

A set of contained Layers within this Layer

< Layer > array

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

2.19. LayerState

layer state information in the context of a parent container (ie, Map)

Name Description Schema

layer
optional

The Layer referenced by this layer state

layer_id
required

identifier of the associated layer

string

opacity
optional

Opacity value of the associated layer
Minimum value : 0
Maximum value : 1

number (double)

visibility
optional

Visible status of the associated layer

boolean

2.20. Legend

layer legend

Name Description Schema

description
optional

description of the layer legend

string

items
optional

< LegendItem > array

label
optional

label of the layer legend

string

2.21. LegendItem

layer legend item

Name Description Schema

contentData
optional

base64-encoded legend item data

string

description
optional

description of the layer legend item

string

height
optional

height of the legend item

number

mediaType
optional

media type of the legend item

enum (image/png, image/jpg, image/jpeg, application/svg+xml)

title
optional

label of the layer legend item

string

url
optional

URL to legend

string

values
optional

list of values

< string > array

width
optional

width of the legend item

number

2.22. Map

A Map Item, sub-class of #/definitions/Item

Polymorphism : Composition

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

attributions
optional

< string > array

baseLayer
optional

The base layer of the Map

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

The geographic extent of the item, in WGS84

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

landingPage
optional

A home page for the Map
Example : "http://www.google.com"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

layers
required

The set of overlay layers within the Map

< LayerState > array

modified
optional

Milliseconds timestamp of last modified date

number (long)

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

thumbnail
optional

A thumbnail depiction of the Map

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

2.23. Organization

an organization, sub-class of #/definitions/Agent

Polymorphism : Composition

Name Description Schema

created
optional

milliseconds of creation date

number

description
optional

A brief description of this item

string

id
optional

the unique identifier of this item

string

label
optional

A display label for this item

string

modified
optional

milliseconds of last modified date

number

name
optional

Name of the item

string

subOrganizationOf
optional

uri
optional

unique, immutable URI of the item

string

2.24. Person

a person, sub-class of #/definitions/Agent

Polymorphism : Composition

Name Description Schema

created
optional

milliseconds of creation date

number

description
optional

A brief description of this item

string

id
optional

the unique identifier of this item

string

label
optional

A display label for this item

string

modified
optional

milliseconds of last modified date

number

name
optional

Name of the item

string

uri
optional

unique, immutable URI of the item

string

2.25. SearchResults

Name Description Schema

facets
optional

The set of faceted (aggregation) information for the search results

< object > array

results
optional

The set of Items contained in the search results

< Item > array

totalResults
optional

integer

2.26. Service

A service item, sub-class of #/definitions/Item

Polymorphism : Composition

Name Description Schema

alternateTitles
optional

A list of alternate titles for this item

< string > array

api
optional

object

attributions
optional

< string > array

categories
optional

list of category concepts

< Concept > array

contacts
optional

list of contacts associated with this object

< VCard > array

contributors
optional

list of persons and/or organizations that have modified this object

< Agent > array

created
optional

Milliseconds timestamp of creation date

number (long)

createdBy
optional

The username of the GeoPlatform user who created this object

string

creators
optional

list of persons and/or organizations responsible for creating this object

< Agent > array

description
optional

A brief description of this item
Example : "A well though-out item with a rich description"

string

distributions
optional

A set of available distributions for the underlying data

extent
optional

href
required

URL of service endpoint
Example : "http://gis1.usgs.gov/arcgis/rest/services/NAT_Species_Amphibians/affsax/MapServer"

string

hrefTemplate
optional

custom URL template to use when communicating with the Service
Example : "http://a.tile.openstreetmap.org/{z}/{x}/{y}.png"

string

id
optional

The unique identifier of this item, generated by the system.
Example : "00715efcd9fa8b79ff752e1bc2a162aa"

string

identifiers
optional

list of third-party identifiers associated with this object

< string > array

keywords
optional

list of keywords

< string > array

label
required

A display label for this item
Example : "My New Item"

string

languages
optional

list of languages in which this object may be available

< object > array

lastModifiedBy
optional

The username of the GeoPlatform user who last modified this object

string

modified
optional

Milliseconds timestamp of last modified date

number (long)

publishers
optional

list of organizations responsible for publishing and maintaining this object

< Organization > array

related
optional

list of related resources

< Item > array

rights
optional

list of access rights for this object

< object > array

rightsHolders
optional

< object > array

serviceType
optional

The service standard supported by this Service

statistics
optional

performance statistics about this Service

object

status
optional

The status of this object in GP

enum (tested, superceded, valid, submitted, retired)

temporal
optional

The temporal extent of this object

object

themes
optional

list of theme concepts

< Concept > array

type
required

The type of item

enum (dcat:Dataset, regp:Service, Layer, Map, skos:Concept, skos:ConceptScheme, org:Organization, vcard:VCard, foaf:Person)

uri
required

A Unique, immutable URI of the item
Example : "http://www.geoplatform.gov/id/concept/3baa53b60803bb8938e81d19fa66589f"

string

2.27. ServiceType

A Service standard

Name Description Schema

_created
optional

creation timestamp

string (long)

description
optional

description of the service type

string

id
optional

identifier of this service type definition

string

label
optional

display label for the service type

string

modified
optional

last modification timestamp

string (long)

resourceType
optional

resource type identifier, must contain at least 'ServiceType'.
Example : [ "ServiceType" ]

< string > array

title
optional

name of the service type

string

type
optional

type of definition

enum (dct:Standard)

uri
optional

Unique GeoPlatform URI of this service type

string

2.28. Statistics

current performance statistics for an associated GeoPlatform Item

Name Description Schema

average_speed
optional

Minimum value : 0

number (double)

average_speed_7
optional

Minimum value : 0

number (double)

compliant
optional

boolean

days_in_service
optional

integer (int32)

days_online
optional

integer (int32)

numLikes
optional

number of user likes of the associated Item

integer (int32)

numViews
optional

number of user views of the associated Item

integer (int32)

online
optional

boolean

online_compliant_service_count
optional

integer (int32)

percent_uptime
optional

integer (int32)

percent_uptime_7
optional

integer (int32)

reliability
optional

integer (int32)

score
optional

integer (int32)

service_count
optional

integer (int32)

speed
optional

integer (int32)

timestamp
optional

integer (int64)

trend_7
optional

integer (int32)

2.29. Thumbnail

thumbnail information

Name Description Schema

contentData
optional

base64-encoded thumbnail image data

string

height
optional

Default : 112

integer (int32)

id
optional

identifier of the thumbnail

string

label
optional

display label of the thumbnail

string

mediaType
optional

enum (image/png, image/jpg, image/jpeg)

title
optional

title of the thumbnail

string

url
optional

URL to web-accessible external thumbnail image

string

width
optional

Default : 200

integer (int32)

2.30. URICheckResult

Existence check result containing URI used and the matching item’s identifier or null.

Name Description Schema

id
optional

Matching item identifier or null if not found

string

uri
optional

URI used to check

string

2.31. VCard

vcard of point of contact

Name Description Schema

address
optional

created
optional

milliseconds of creation date

number

email
optional

Contact email address

string

fullName
optional

Full name of the contact

string

id
optional

the unique identifier of this item

string

label
optional

A display label for this item

string

landingPage
optional

Contact home page

string

modified
optional

milliseconds of last modified date

number

orgName
optional

Name of the contact’s organization

string

positionTitle
optional

Name of the contact’s position within organization

string

status
optional

status of this object in GP

string

tel
optional

Contact telephone number

string

uri
optional

unique, immutable URI of the item

string

3. Resources

3.1. Dataset

3.1.1. Search Data.Gov

GET /ckan
3.1.1.1. Description

Search metadata in Data.Gov using CKAN API

3.1.1.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

metadata_type
optional

ckan key for type of metadata dataset

string

Query

organization
optional

ckan id of organizational owner of metadata records

string

Query

organization_type
optional

ckan organizational type

string

Query

page
optional

page of results to return

number (int32)

0

Query

progress
optional

ckan progress status key

string

Query

q
optional

free text to use in constraining results

string

Query

res_format
optional

ckan metadata format key

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

tags
optional

needs description

string

Query

vocab_category_all
optional

needs description

string

3.1.1.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.1.1.4. Produces
  • application/json

3.1.2. Create Dataset

POST /datasets
3.1.2.1. Description

Accepts a Dataset payload to be persisted and returns the persisted copy

3.1.2.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.1.2.3. Responses
HTTP Code Description Schema

201

on successful creation

default

when failed

3.1.2.4. Consumes
  • application/json

3.1.2.5. Produces
  • application/json

3.1.3. Search Datasets

GET /datasets
3.1.3.1. Description

Provides a list of datasets matching specified search criteria plus paging information

3.1.3.2. Parameters
Type Name Description Schema Default

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.1.3.3. Responses
HTTP Code Description Schema

200

a set of datasets as search results

default

when failed

3.1.3.4. Produces
  • application/json

3.1.4. Get Dataset by ID

GET /datasets/{id}
3.1.4.1. Description

Provides a copy of the requested Dataset

3.1.4.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the dataset to fetch

string

3.1.4.3. Responses
HTTP Code Description Schema

200

requested dataset

default

when failed

3.1.4.4. Produces
  • application/json

3.1.5. Update Dataset

PUT /datasets/{id}
3.1.5.1. Description

Updates datasets with specified identifier using specified changes

3.1.5.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the dataset to update

string

Body

body
optional

the updated version of the dataset

3.1.5.3. Responses
HTTP Code Description Schema

200

the updated dataset

default

when failed

3.1.5.4. Consumes
  • application/json

3.1.5.5. Produces
  • application/json

3.1.6. Deletes Dataset

DELETE /datasets/{id}
3.1.6.1. Description

Removes a Dataset from the GeoPlatform

3.1.6.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to delete

string

3.1.6.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.1.7. Add View

PUT /datasets/{id}/likes
3.1.7.1. Description

Increase the number of views for the item by one

3.1.7.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.1.7.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.1.7.4. Produces
  • application/json

3.1.8. List Dataset Services

GET /datasets/{id}/services
3.1.8.1. Description

Returns a list of services associated with the specified dataset

3.1.8.2. Parameters
Type Name Description Schema Default

Path

id
required

identifier of the dataset

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.1.8.3. Responses
HTTP Code Description Schema

200

list of associated services

default

when failed

3.1.8.4. Produces
  • application/json

3.1.9. Import

POST /import
3.1.9.1. Description

Submit metadata document or URL to metadata document for import

3.1.9.2. Parameters
Type Name Description Schema

FormData

file
optional

metadata file to upload, required if URL is not provided

file

FormData

format
optional

metadata format

string

FormData

overwrite
optional

flag indicating to overwrite existing objects' values if found

boolean

FormData

url
optional

url to metadata file to import, required if FILE is not provided

string

3.1.9.3. Responses
HTTP Code Description Schema

200

imported item

default

when failed

3.1.9.4. Consumes
  • multipart/form-data

3.1.9.5. Produces
  • application/json

3.1.10. Create Item

POST /items
3.1.10.1. Description

Submit a new GeoPlatform Item for persistence

3.1.10.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.1.10.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.1.10.4. Consumes
  • application/json

3.1.10.5. Produces
  • application/json

3.1.11. Search Items

GET /items
3.1.11.1. Description

Search all GeoPlatform Item types

3.1.11.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

type
optional

comma-separated list of GeoPlatform Item types to return in results

enum (dcat:Dataset, regp:Service, Layer, foaf:Person, org:Organization, Community, vcard:VCard, skos:Concept, skos:ConceptScheme)

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.1.11.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.1.11.4. Produces
  • application/json

3.1.12. Get Item by ID

GET /items/{id}
3.1.12.1. Description

Returns GeoPlatform Item with specified identifier

3.1.12.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.1.12.3. Responses
HTTP Code Description Schema

200

requested item

default

when failed

3.1.12.4. Produces
  • application/json

3.1.13. Update Item

PUT /items/{id}
3.1.13.1. Description

Updates items with specified identifier using specified changes

3.1.13.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

Body

body
optional

the updated version of the item

3.1.13.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.1.13.4. Consumes
  • application/json

3.1.13.5. Produces
  • application/json

3.1.14. Delete Item

DELETE /items/{id}
3.1.14.1. Description

Deletes item with specified identifier

3.1.14.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.1.14.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.1.15. Export Item

GET /items/{id}/export
3.1.15.1. Description

Returns item formatted in requested schema

3.1.15.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

Query

format
required

schema to use when exporting the item

enum (iso19139, iso19115, gpfm, kml, wmc, json)

3.1.15.3. Responses
HTTP Code Description Schema

200

requested item

No Content

default

when failed

3.1.15.4. Produces
  • application/xml

3.1.16. Add Like

PUT /items/{id}/likes
3.1.16.1. Description

Increase the number of likes for the item by one

3.1.16.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.1.16.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.1.16.4. Produces
  • application/json

3.1.17. Get Item Source Document

GET /items/{id}/source
3.1.17.1. Description

Returns XML source document for the item

3.1.17.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch the source for

string

3.1.17.3. Responses
HTTP Code Description Schema

200

requested item

No Content

default

when failed

3.1.17.4. Produces
  • application/xml

3.1.18. Get Item thumbnail

GET /items/{id}/thumbnail
3.1.18.1. Description

Returns item thumbnail image

3.1.18.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item thumbnail to fetch

string

3.1.18.3. Responses
HTTP Code Description Schema

200

requested item thumbnail image

string (binary)

default

when failed

3.1.18.4. Produces
  • image/png

3.1.19. Retrieve Item Version

GET /items/{id}/versions
3.1.19.1. Description

Returns a specific version of the specified GeoPlatform Item

3.1.19.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch version info for

string

Path

version
required

version of the item to fetch

string

3.1.19.3. Responses
HTTP Code Description Schema

200

requested item version info

default

when failed

3.1.19.4. Produces
  • application/json

3.1.20. Add View

PUT /items/{id}/views
3.1.20.1. Description

Increase the number of views for the item by one

3.1.20.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.1.20.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.1.20.4. Produces
  • application/json

3.1.21. Check Item Existence

POST /utils/exists
3.1.21.1. Description

Checks if a supplied GP Item already exists by URI

3.1.21.2. Parameters
Type Name Description Schema

Body

body
optional

URI or list of URIs to search for in the GeoPlatform

< string > array

3.1.21.3. Responses
HTTP Code Description Schema

200

returns array of results of specified uri checks

< URICheckResult > array

default

when failed

3.1.21.4. Consumes
  • application/json

3.1.21.5. Produces
  • application/json

3.2. Service

3.2.1. Search Data.Gov

GET /ckan
3.2.1.1. Description

Search metadata in Data.Gov using CKAN API

3.2.1.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

metadata_type
optional

ckan key for type of metadata dataset

string

Query

organization
optional

ckan id of organizational owner of metadata records

string

Query

organization_type
optional

ckan organizational type

string

Query

page
optional

page of results to return

number (int32)

0

Query

progress
optional

ckan progress status key

string

Query

q
optional

free text to use in constraining results

string

Query

res_format
optional

ckan metadata format key

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

tags
optional

needs description

string

Query

vocab_category_all
optional

needs description

string

3.2.1.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.2.1.4. Produces
  • application/json

3.2.2. List Dataset Services

GET /datasets/{id}/services
3.2.2.1. Description

Returns a list of services associated with the specified dataset

3.2.2.2. Parameters
Type Name Description Schema Default

Path

id
required

identifier of the dataset

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.2.2.3. Responses
HTTP Code Description Schema

200

list of associated services

default

when failed

3.2.2.4. Produces
  • application/json

3.2.3. Harvest Service

POST /harvest
3.2.3.1. Description

Harvest service and contained layers' info

3.2.3.2. Parameters
Type Name Description Schema

Body

body
optional

info about the item(s) being harvested

3.2.3.3. Responses
HTTP Code Description Schema

200

a set of harvested items as results

default

when failed

3.2.3.4. Consumes
  • application/json

3.2.3.5. Produces
  • application/json

3.2.4. Create Item

POST /items
3.2.4.1. Description

Submit a new GeoPlatform Item for persistence

3.2.4.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.2.4.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.2.4.4. Consumes
  • application/json

3.2.4.5. Produces
  • application/json

3.2.5. Search Items

GET /items
3.2.5.1. Description

Search all GeoPlatform Item types

3.2.5.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

type
optional

comma-separated list of GeoPlatform Item types to return in results

enum (dcat:Dataset, regp:Service, Layer, foaf:Person, org:Organization, Community, vcard:VCard, skos:Concept, skos:ConceptScheme)

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.2.5.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.2.5.4. Produces
  • application/json

3.2.6. Get Item by ID

GET /items/{id}
3.2.6.1. Description

Returns GeoPlatform Item with specified identifier

3.2.6.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.2.6.3. Responses
HTTP Code Description Schema

200

requested item

default

when failed

3.2.6.4. Produces
  • application/json

3.2.7. Update Item

PUT /items/{id}
3.2.7.1. Description

Updates items with specified identifier using specified changes

3.2.7.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

Body

body
optional

the updated version of the item

3.2.7.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.2.7.4. Consumes
  • application/json

3.2.7.5. Produces
  • application/json

3.2.8. Delete Item

DELETE /items/{id}
3.2.8.1. Description

Deletes item with specified identifier

3.2.8.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.2.8.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.2.9. Export Item

GET /items/{id}/export
3.2.9.1. Description

Returns item formatted in requested schema

3.2.9.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

Query

format
required

schema to use when exporting the item

enum (iso19139, iso19115, gpfm, kml, wmc, json)

3.2.9.3. Responses
HTTP Code Description Schema

200

requested item

No Content

default

when failed

3.2.9.4. Produces
  • application/xml

3.2.10. Add Like

PUT /items/{id}/likes
3.2.10.1. Description

Increase the number of likes for the item by one

3.2.10.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.2.10.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.2.10.4. Produces
  • application/json

3.2.11. Get Item thumbnail

GET /items/{id}/thumbnail
3.2.11.1. Description

Returns item thumbnail image

3.2.11.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item thumbnail to fetch

string

3.2.11.3. Responses
HTTP Code Description Schema

200

requested item thumbnail image

string (binary)

default

when failed

3.2.11.4. Produces
  • image/png

3.2.12. Retrieve Item Version

GET /items/{id}/versions
3.2.12.1. Description

Returns a specific version of the specified GeoPlatform Item

3.2.12.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch version info for

string

Path

version
required

version of the item to fetch

string

3.2.12.3. Responses
HTTP Code Description Schema

200

requested item version info

default

when failed

3.2.12.4. Produces
  • application/json

3.2.13. Add View

PUT /items/{id}/views
3.2.13.1. Description

Increase the number of views for the item by one

3.2.13.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.2.13.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.2.13.4. Produces
  • application/json

3.2.14. Create a new Service

POST /services
3.2.14.1. Description

Accepts a Service payload to persist and returns the persisted copy

3.2.14.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.2.14.3. Responses
HTTP Code Description Schema

201

on successful creation

default

when failed

3.2.14.4. Consumes
  • application/json

3.2.14.5. Produces
  • application/json

3.2.15. List Services

GET /services
3.2.15.1. Description

Searches Services and returns results and paging information

3.2.15.2. Parameters
Type Name Description Schema Default

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.2.15.3. Responses
HTTP Code Description Schema

200

a set of services as search results

default

when failed

3.2.15.4. Produces
  • application/json

3.2.16. Returns service info

POST /services/about
3.2.16.1. Description

Extracts service information from the web accessible server that has not been persisted in the GeoPlatform

3.2.16.2. Parameters
Type Name Description Schema

Body

body
required

harvest payload

3.2.16.3. Responses
HTTP Code Description Schema

200

service info

default

when failed

3.2.16.4. Produces
  • application/json

3.2.17. Returns service info

GET /services/about
3.2.17.1. Description

Extracts service information from the web accessible server that has not been persisted in the GeoPlatform

3.2.17.2. Parameters
Type Name Description Schema

Query

serviceType
required

type of service

string

Query

url
required

URL of service to describe

string

3.2.17.3. Responses
HTTP Code Description Schema

200

service info

default

when failed

3.2.17.4. Produces
  • application/json

3.2.18. Import Service

POST /services/import
3.2.18.1. Description

Extracts service and layer information from web-accessible server and persists as Service and Layers in the GeoPlatform

3.2.18.2. Parameters
Type Name Description Schema

Body

body
required

harvest payload

3.2.18.3. Responses
HTTP Code Description Schema

200

service info

default

when failed

3.2.18.4. Produces
  • application/json

3.2.19. Get Service

GET /services/{id}
3.2.19.1. Description

Returns service with specified identifier

3.2.19.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to fetch

string

3.2.19.3. Responses
HTTP Code Description Schema

200

requested service

default

when failed

3.2.19.4. Produces
  • application/json

3.2.20. Update Service

PUT /services/{id}
3.2.20.1. Description

Updates services with specified identifier using specified changes

3.2.20.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to update

string

Body

body
optional

the updated version of the service

3.2.20.3. Responses
HTTP Code Description Schema

200

the updated service

default

when failed

3.2.20.4. Consumes
  • application/json

3.2.20.5. Produces
  • application/json

3.2.21. Delete Service

DELETE /services/{id}
3.2.21.1. Description

Deletes service with specified identifier

3.2.21.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.2.21.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.2.22. Returns service info

GET /services/{id}/about
3.2.22.1. Description

Extracts service information from the web accessible server associated with a persisted GeoPlatform Service

3.2.22.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to extract from

string

3.2.22.3. Responses
HTTP Code Description Schema

200

service info

default

when failed

3.2.22.4. Produces
  • application/json

3.2.23. Harvest Service Info

GET /services/{id}/harvest
3.2.23.1. Description

Extracts service and layer information from the web-accessible server associated with a persisted service and updates the Service.

3.2.23.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to harvest

string

3.2.23.3. Responses
HTTP Code Description Schema

200

layer information

< Layer > array

default

when failed

3.2.23.4. Produces
  • application/json

3.2.24. Service History

GET /services/{id}/history
3.2.24.1. Description

Fetch historical statistics for a service

3.2.24.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service

string

3.2.24.3. Responses
HTTP Code Description Schema

200

service history

No Content

default

when failed

3.2.24.4. Produces
  • application/json

3.2.25. List Service Layers

GET /services/{id}/layers
3.2.25.1. Description

Returns list of layers hosted by specified service

3.2.25.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to harvest

string

Query

flatten
optional

optional flag to remove layer heirarchy

boolean

Query

service
optional

optional flag to include service in each layer

boolean

3.2.25.3. Responses
HTTP Code Description Schema

200

service layers

default

when failed

3.2.25.4. Produces
  • application/json

3.2.26. Add View

PUT /services/{id}/likes
3.2.26.1. Description

Increase the number of views for the item by one

3.2.26.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.2.26.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.2.26.4. Produces
  • application/json

3.2.27. Returns service ngp identifer for linking statistics

GET /services/{id}/ngpid
3.2.27.1. Description

Returns ngp id of service and auto creates one if none present

3.2.27.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service

string

3.2.27.3. Responses
HTTP Code Description Schema

200

service info

default

when failed

Response 200

Name Description Schema

ngpid
optional

the identifier associated with the service’s statistics

string

3.2.27.4. Produces
  • application/json

3.2.28. Proxy OGC Service Capabilities

GET /services/{id}/proxy/capabilities
3.2.28.1. Description

Fetches and returns OGC Service Capabilities documents without processing

3.2.28.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service

string

3.2.28.3. Responses
HTTP Code Description Schema

200

service capabilities document

No Content

default

when failed

3.2.28.4. Produces
  • application/xml

3.2.29. Get Service statistics

GET /services/{id}/statistics
3.2.29.1. Description

Retrieve statistics for a service

3.2.29.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to fetch statistics for

string

3.2.29.3. Responses
HTTP Code Description Schema

200

service statistics

default

when failed

3.2.29.4. Produces
  • application/json

3.2.30. Live Test Service

GET /services/{id}/test
3.2.30.1. Description

Initiate a live test using Service Checker

3.2.30.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the service to test

string

3.2.30.3. Responses
HTTP Code Description Schema

200

service statistics

default

when failed

3.2.30.4. Produces
  • application/json

3.2.31. Check Item Existence

POST /utils/exists
3.2.31.1. Description

Checks if a supplied GP Item already exists by URI

3.2.31.2. Parameters
Type Name Description Schema

Body

body
optional

URI or list of URIs to search for in the GeoPlatform

< string > array

3.2.31.3. Responses
HTTP Code Description Schema

200

returns array of results of specified uri checks

< URICheckResult > array

default

when failed

3.2.31.4. Consumes
  • application/json

3.2.31.5. Produces
  • application/json

3.3. Layer

3.3.1. Search Data.Gov

GET /ckan
3.3.1.1. Description

Search metadata in Data.Gov using CKAN API

3.3.1.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

metadata_type
optional

ckan key for type of metadata dataset

string

Query

organization
optional

ckan id of organizational owner of metadata records

string

Query

organization_type
optional

ckan organizational type

string

Query

page
optional

page of results to return

number (int32)

0

Query

progress
optional

ckan progress status key

string

Query

q
optional

free text to use in constraining results

string

Query

res_format
optional

ckan metadata format key

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

tags
optional

needs description

string

Query

vocab_category_all
optional

needs description

string

3.3.1.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.3.1.4. Produces
  • application/json

3.3.2. Create Item

POST /items
3.3.2.1. Description

Submit a new GeoPlatform Item for persistence

3.3.2.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.3.2.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.3.2.4. Consumes
  • application/json

3.3.2.5. Produces
  • application/json

3.3.3. Search Items

GET /items
3.3.3.1. Description

Search all GeoPlatform Item types

3.3.3.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

type
optional

comma-separated list of GeoPlatform Item types to return in results

enum (dcat:Dataset, regp:Service, Layer, foaf:Person, org:Organization, Community, vcard:VCard, skos:Concept, skos:ConceptScheme)

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.3.3.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.3.3.4. Produces
  • application/json

3.3.4. Get Item by ID

GET /items/{id}
3.3.4.1. Description

Returns GeoPlatform Item with specified identifier

3.3.4.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.3.4.3. Responses
HTTP Code Description Schema

200

requested item

default

when failed

3.3.4.4. Produces
  • application/json

3.3.5. Update Item

PUT /items/{id}
3.3.5.1. Description

Updates items with specified identifier using specified changes

3.3.5.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

Body

body
optional

the updated version of the item

3.3.5.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.3.5.4. Consumes
  • application/json

3.3.5.5. Produces
  • application/json

3.3.6. Delete Item

DELETE /items/{id}
3.3.6.1. Description

Deletes item with specified identifier

3.3.6.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.3.6.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.3.7. Export Item

GET /items/{id}/export
3.3.7.1. Description

Returns item formatted in requested schema

3.3.7.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

Query

format
required

schema to use when exporting the item

enum (iso19139, iso19115, gpfm, kml, wmc, json)

3.3.7.3. Responses
HTTP Code Description Schema

200

requested item

No Content

default

when failed

3.3.7.4. Produces
  • application/xml

3.3.8. Add Like

PUT /items/{id}/likes
3.3.8.1. Description

Increase the number of likes for the item by one

3.3.8.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.3.8.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.3.8.4. Produces
  • application/json

3.3.9. Get Item thumbnail

GET /items/{id}/thumbnail
3.3.9.1. Description

Returns item thumbnail image

3.3.9.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item thumbnail to fetch

string

3.3.9.3. Responses
HTTP Code Description Schema

200

requested item thumbnail image

string (binary)

default

when failed

3.3.9.4. Produces
  • image/png

3.3.10. Retrieve Item Version

GET /items/{id}/versions
3.3.10.1. Description

Returns a specific version of the specified GeoPlatform Item

3.3.10.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch version info for

string

Path

version
required

version of the item to fetch

string

3.3.10.3. Responses
HTTP Code Description Schema

200

requested item version info

default

when failed

3.3.10.4. Produces
  • application/json

3.3.11. Add View

PUT /items/{id}/views
3.3.11.1. Description

Increase the number of views for the item by one

3.3.11.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.3.11.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.3.11.4. Produces
  • application/json

3.3.12. Create a new Layer

POST /layers
3.3.12.1. Description

Accepts a Layer payload to persist and returns persisted copy

3.3.12.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.3.12.3. Responses
HTTP Code Description Schema

201

on successful creation

default

when failed

3.3.12.4. Consumes
  • application/json

3.3.12.5. Produces
  • application/json

3.3.13. List Layers

GET /layers
3.3.13.1. Description

Provides a list of layers and paging information based upon specified query constraints

3.3.13.2. Parameters
Type Name Description Schema Default

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.3.13.3. Responses
HTTP Code Description Schema

200

a set of layers as search results

default

when failed

3.3.13.4. Produces
  • application/json

3.3.14. Get specific Layer

GET /layers/{id}
3.3.14.1. Description

Returns layer with specified identifier

3.3.14.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the layer to fetch

string

3.3.14.3. Responses
HTTP Code Description Schema

200

requested layer

default

when failed

3.3.14.4. Produces
  • application/json

3.3.15. Update Layer

PUT /layers/{id}
3.3.15.1. Description

Updates layers with specified identifier using specified changes

3.3.15.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the layer to update

string

Body

body
optional

the updated version of the layer

3.3.15.3. Responses
HTTP Code Description Schema

200

the updated layer

default

when failed

3.3.15.4. Consumes
  • application/json

3.3.15.5. Produces
  • application/json

3.3.16. Delete Layer

DELETE /layers/{id}
3.3.16.1. Description

Deletes layer with specified identifier

3.3.16.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.3.16.3. Responses
HTTP Code Description Schema

204

empty response

No Content

400

when failed

default

when failed

3.3.17. Get Layer Feature Info

GET /layers/{id}/feature
3.3.17.1. Description

Returns feature information for a layer

3.3.17.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the layer to fetch features for

string

3.3.17.3. Responses
HTTP Code Description Schema

200

requested layer feature

No Content

default

when failed

3.3.17.4. Produces
  • application/json

3.3.18. Add View

PUT /layers/{id}/likes
3.3.18.1. Description

Increase the number of views for the item by one

3.3.18.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.3.18.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.3.18.4. Produces
  • application/json

3.3.19. Get ESRI-based Layer style information

GET /layers/{id}/style
3.3.19.1. Description

Returns layer style information (for ESRI layers)

3.3.19.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the layer to fetch style info about

string

3.3.19.3. Responses
HTTP Code Description Schema

200

requested layer

default

when failed

3.3.19.4. Produces
  • application/json

3.3.20. Check Item Existence

POST /utils/exists
3.3.20.1. Description

Checks if a supplied GP Item already exists by URI

3.3.20.2. Parameters
Type Name Description Schema

Body

body
optional

URI or list of URIs to search for in the GeoPlatform

< string > array

3.3.20.3. Responses
HTTP Code Description Schema

200

returns array of results of specified uri checks

< URICheckResult > array

default

when failed

3.3.20.4. Consumes
  • application/json

3.3.20.5. Produces
  • application/json

3.4. Map

3.4.1. Search Data.Gov

GET /ckan
3.4.1.1. Description

Search metadata in Data.Gov using CKAN API

3.4.1.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

metadata_type
optional

ckan key for type of metadata dataset

string

Query

organization
optional

ckan id of organizational owner of metadata records

string

Query

organization_type
optional

ckan organizational type

string

Query

page
optional

page of results to return

number (int32)

0

Query

progress
optional

ckan progress status key

string

Query

q
optional

free text to use in constraining results

string

Query

res_format
optional

ckan metadata format key

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

tags
optional

needs description

string

Query

vocab_category_all
optional

needs description

string

3.4.1.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.4.1.4. Produces
  • application/json

3.4.2. Create Item

POST /items
3.4.2.1. Description

Submit a new GeoPlatform Item for persistence

3.4.2.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.4.2.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.4.2.4. Consumes
  • application/json

3.4.2.5. Produces
  • application/json

3.4.3. Search Items

GET /items
3.4.3.1. Description

Search all GeoPlatform Item types

3.4.3.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

type
optional

comma-separated list of GeoPlatform Item types to return in results

enum (dcat:Dataset, regp:Service, Layer, foaf:Person, org:Organization, Community, vcard:VCard, skos:Concept, skos:ConceptScheme)

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.4.3.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.4.3.4. Produces
  • application/json

3.4.4. Get Item by ID

GET /items/{id}
3.4.4.1. Description

Returns GeoPlatform Item with specified identifier

3.4.4.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.4.4.3. Responses
HTTP Code Description Schema

200

requested item

default

when failed

3.4.4.4. Produces
  • application/json

3.4.5. Update Item

PUT /items/{id}
3.4.5.1. Description

Updates items with specified identifier using specified changes

3.4.5.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

Body

body
optional

the updated version of the item

3.4.5.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.4.5.4. Consumes
  • application/json

3.4.5.5. Produces
  • application/json

3.4.6. Delete Item

DELETE /items/{id}
3.4.6.1. Description

Deletes item with specified identifier

3.4.6.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.4.6.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.4.7. Export Item

GET /items/{id}/export
3.4.7.1. Description

Returns item formatted in requested schema

3.4.7.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

Query

format
required

schema to use when exporting the item

enum (iso19139, iso19115, gpfm, kml, wmc, json)

3.4.7.3. Responses
HTTP Code Description Schema

200

requested item

No Content

default

when failed

3.4.7.4. Produces
  • application/xml

3.4.8. Add Like

PUT /items/{id}/likes
3.4.8.1. Description

Increase the number of likes for the item by one

3.4.8.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.4.8.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.4.8.4. Produces
  • application/json

3.4.9. Get Item thumbnail

GET /items/{id}/thumbnail
3.4.9.1. Description

Returns item thumbnail image

3.4.9.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item thumbnail to fetch

string

3.4.9.3. Responses
HTTP Code Description Schema

200

requested item thumbnail image

string (binary)

default

when failed

3.4.9.4. Produces
  • image/png

3.4.10. Retrieve Item Version

GET /items/{id}/versions
3.4.10.1. Description

Returns a specific version of the specified GeoPlatform Item

3.4.10.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch version info for

string

Path

version
required

version of the item to fetch

string

3.4.10.3. Responses
HTTP Code Description Schema

200

requested item version info

default

when failed

3.4.10.4. Produces
  • application/json

3.4.11. Add View

PUT /items/{id}/views
3.4.11.1. Description

Increase the number of views for the item by one

3.4.11.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.4.11.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.4.11.4. Produces
  • application/json

3.4.12. Create a new Map

POST /maps
3.4.12.1. Description

Accepts a Map payload to persist and returns persisted copy

3.4.12.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

Map

3.4.12.3. Responses
HTTP Code Description Schema

201

the newly created item

Map

default

when failed

3.4.12.4. Consumes
  • application/json

3.4.12.5. Produces
  • application/json

3.4.13. List Maps

GET /maps
3.4.13.1. Description

Returns maps and paging information using specified query constraints

3.4.13.2. Parameters
Type Name Description Schema Default

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.4.13.3. Responses
HTTP Code Description Schema

200

a set of maps as search results

default

when failed

3.4.13.4. Produces
  • application/json

3.4.14. Get Map

GET /maps/{id}
3.4.14.1. Description

Returns map with specified identifier

3.4.14.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map to fetch

string

3.4.14.3. Responses
HTTP Code Description Schema

200

requested map

Map

default

when failed

3.4.14.4. Produces
  • application/json

3.4.15. Update Map

PUT /maps/{id}
3.4.15.1. Description

Updates maps with specified identifier using specified changes

3.4.15.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map to update

string

Body

body
optional

the updated version of the map

Map

3.4.15.3. Responses
HTTP Code Description Schema

200

the updated map

Map

default

when failed

3.4.15.4. Consumes
  • application/json

3.4.15.5. Produces
  • application/json

3.4.16. Delete Map

DELETE /maps/{id}
3.4.16.1. Description

Deletes map with specified identifier

3.4.16.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.4.16.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.4.17. Export Map as specified format

GET /maps/{id}/export
3.4.17.1. Description

returns the Map formatted as the requested output format

3.4.17.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map thumbnail to fetch

string

Query

format
required

identifier of format to export map into

enum (kml, wmc)

3.4.17.3. Responses
HTTP Code Description Schema

200

requested map in requested format

No Content

default

when failed

3.4.17.4. Produces
  • application/xml

3.4.18. Add View

PUT /maps/{id}/likes
3.4.18.1. Description

Increase the number of views for the item by one

3.4.18.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.4.18.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.4.18.4. Produces
  • application/json

3.4.19. Creates map thumbnail

POST /maps/{id}/thumbnail
3.4.19.1. Description

Creates a thumbnail for the specified Map

3.4.19.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map

string

3.4.19.3. Responses
HTTP Code Description Schema

200

the updated map thumbnail

string (binary)

default

when failed

3.4.19.4. Produces
  • image/png

3.4.20. Get Map thumbnail

GET /maps/{id}/thumbnail
3.4.20.1. Description

Returns map thumbnail image

3.4.20.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map thumbnail to fetch

string

3.4.20.3. Responses
HTTP Code Description Schema

200

requested map thumbnail image

string (binary)

default

when failed

3.4.20.4. Produces
  • image/png

3.4.21. Updates Map thumbnail

PUT /maps/{id}/thumbnail
3.4.21.1. Description

Recreates and stores the thumbnail for the specified Map

3.4.21.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map

string

3.4.21.3. Responses
HTTP Code Description Schema

200

the updated map thumbnail image

string (binary)

default

when failed

3.4.21.4. Produces
  • image/png

3.4.22. Check Item Existence

POST /utils/exists
3.4.22.1. Description

Checks if a supplied GP Item already exists by URI

3.4.22.2. Parameters
Type Name Description Schema

Body

body
optional

URI or list of URIs to search for in the GeoPlatform

< string > array

3.4.22.3. Responses
HTTP Code Description Schema

200

returns array of results of specified uri checks

< URICheckResult > array

default

when failed

3.4.22.4. Consumes
  • application/json

3.4.22.5. Produces
  • application/json

3.5.1. Search Data.Gov

GET /ckan
3.5.1.1. Description

Search metadata in Data.Gov using CKAN API

3.5.1.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

metadata_type
optional

ckan key for type of metadata dataset

string

Query

organization
optional

ckan id of organizational owner of metadata records

string

Query

organization_type
optional

ckan organizational type

string

Query

page
optional

page of results to return

number (int32)

0

Query

progress
optional

ckan progress status key

string

Query

q
optional

free text to use in constraining results

string

Query

res_format
optional

ckan metadata format key

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

tags
optional

needs description

string

Query

vocab_category_all
optional

needs description

string

3.5.1.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.5.1.4. Produces
  • application/json

POST /galleries
3.5.2.1. Description

Creates new galleries

3.5.2.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.5.2.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.5.2.4. Consumes
  • application/json

3.5.2.5. Produces
  • application/json

3.5.3. Search Galleries

GET /galleries
3.5.3.1. Description

Returns galleries

3.5.3.2. Parameters
Type Name Description Schema Default

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.5.3.3. Responses
HTTP Code Description Schema

200

a set of galleries as search results

default

when failed

3.5.3.4. Produces
  • application/json

GET /galleries/{id}
3.5.4.1. Description

Returns map with specified identifier

3.5.4.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map to fetch

string

3.5.4.3. Responses
HTTP Code Description Schema

200

requested gallery

default

when failed

3.5.4.4. Produces
  • application/json

PUT /galleries/{id}
3.5.5.1. Description

Updates galleries with specified identifier using specified changes

3.5.5.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the gallery to update

string

Body

body
optional

the updated version of the gallery

3.5.5.3. Responses
HTTP Code Description Schema

200

the updated gallery

default

when failed

3.5.5.4. Consumes
  • application/json

3.5.5.5. Produces
  • application/json

DELETE /galleries/{id}
3.5.6.1. Description

Deletes gallery with specified identifier

3.5.6.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.5.6.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

POST /galleries/{id}/items
3.5.7.1. Description

Accepts an item to be added to the specified Gallery

3.5.7.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the gallery to update

string

Body

body
optional

the item to add to the gallery

3.5.7.3. Responses
HTTP Code Description Schema

200

the updated gallery

default

when failed

3.5.7.4. Consumes
  • application/json

3.5.7.5. Produces
  • application/json

DELETE /galleries/{id}/items/{itemId}
3.5.8.1. Description

Removes a specified item from the specified Gallery

3.5.8.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the gallery

string

Path

itemId
required

identifier of the item within the gallery

string

3.5.8.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.5.9. Add View

PUT /galleries/{id}/likes
3.5.9.1. Description

Increase the number of views for the item by one

3.5.9.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.5.9.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.5.9.4. Produces
  • application/json

3.5.10. Create Item

POST /items
3.5.10.1. Description

Submit a new GeoPlatform Item for persistence

3.5.10.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.5.10.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.5.10.4. Consumes
  • application/json

3.5.10.5. Produces
  • application/json

3.5.11. Search Items

GET /items
3.5.11.1. Description

Search all GeoPlatform Item types

3.5.11.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

type
optional

comma-separated list of GeoPlatform Item types to return in results

enum (dcat:Dataset, regp:Service, Layer, foaf:Person, org:Organization, Community, vcard:VCard, skos:Concept, skos:ConceptScheme)

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.5.11.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.5.11.4. Produces
  • application/json

3.5.12. Get Item by ID

GET /items/{id}
3.5.12.1. Description

Returns GeoPlatform Item with specified identifier

3.5.12.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.5.12.3. Responses
HTTP Code Description Schema

200

requested item

default

when failed

3.5.12.4. Produces
  • application/json

3.5.13. Update Item

PUT /items/{id}
3.5.13.1. Description

Updates items with specified identifier using specified changes

3.5.13.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

Body

body
optional

the updated version of the item

3.5.13.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.5.13.4. Consumes
  • application/json

3.5.13.5. Produces
  • application/json

3.5.14. Delete Item

DELETE /items/{id}
3.5.14.1. Description

Deletes item with specified identifier

3.5.14.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.5.14.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.5.15. Export Item

GET /items/{id}/export
3.5.15.1. Description

Returns item formatted in requested schema

3.5.15.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

Query

format
required

schema to use when exporting the item

enum (iso19139, iso19115, gpfm, kml, wmc, json)

3.5.15.3. Responses
HTTP Code Description Schema

200

requested item

No Content

default

when failed

3.5.15.4. Produces
  • application/xml

3.5.16. Add Like

PUT /items/{id}/likes
3.5.16.1. Description

Increase the number of likes for the item by one

3.5.16.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.5.16.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.5.16.4. Produces
  • application/json

3.5.17. Get Item thumbnail

GET /items/{id}/thumbnail
3.5.17.1. Description

Returns item thumbnail image

3.5.17.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item thumbnail to fetch

string

3.5.17.3. Responses
HTTP Code Description Schema

200

requested item thumbnail image

string (binary)

default

when failed

3.5.17.4. Produces
  • image/png

3.5.18. Retrieve Item Version

GET /items/{id}/versions
3.5.18.1. Description

Returns a specific version of the specified GeoPlatform Item

3.5.18.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch version info for

string

Path

version
required

version of the item to fetch

string

3.5.18.3. Responses
HTTP Code Description Schema

200

requested item version info

default

when failed

3.5.18.4. Produces
  • application/json

3.5.19. Add View

PUT /items/{id}/views
3.5.19.1. Description

Increase the number of views for the item by one

3.5.19.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.5.19.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.5.19.4. Produces
  • application/json

3.5.20. Check Item Existence

POST /utils/exists
3.5.20.1. Description

Checks if a supplied GP Item already exists by URI

3.5.20.2. Parameters
Type Name Description Schema

Body

body
optional

URI or list of URIs to search for in the GeoPlatform

< string > array

3.5.20.3. Responses
HTTP Code Description Schema

200

returns array of results of specified uri checks

< URICheckResult > array

default

when failed

3.5.20.4. Consumes
  • application/json

3.5.20.5. Produces
  • application/json

3.6. Community

3.6.1. Search Data.Gov

GET /ckan
3.6.1.1. Description

Search metadata in Data.Gov using CKAN API

3.6.1.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

metadata_type
optional

ckan key for type of metadata dataset

string

Query

organization
optional

ckan id of organizational owner of metadata records

string

Query

organization_type
optional

ckan organizational type

string

Query

page
optional

page of results to return

number (int32)

0

Query

progress
optional

ckan progress status key

string

Query

q
optional

free text to use in constraining results

string

Query

res_format
optional

ckan metadata format key

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

tags
optional

needs description

string

Query

vocab_category_all
optional

needs description

string

3.6.1.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed

3.6.1.4. Produces
  • application/json

3.6.2. Create a Community

POST /communities
3.6.2.1. Description

Creates new communities

3.6.2.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.6.2.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.6.2.4. Consumes
  • application/json

3.6.2.5. Produces
  • application/json

3.6.3. Search Communities

GET /communities
3.6.3.1. Description

Returns communities matching any query constraints specified

3.6.3.2. Parameters
Type Name Description Schema Default

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

extent
optional

Constrain results to only Items with geographic extends which intersect this bbox in form of 'west,south,east,north'

string

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.6.3.3. Responses
HTTP Code Description Schema

200

a set of communities as search results

default

when failed

3.6.3.4. Produces
  • application/json

3.6.4. Fetch Community

GET /communities/{id}
3.6.4.1. Description

Returns map with specified identifier

3.6.4.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the map to fetch

string

3.6.4.3. Responses
HTTP Code Description Schema

200

requested community

default

when failed

3.6.4.4. Produces
  • application/json

3.6.5. Update a Community

PUT /communities/{id}
3.6.5.1. Description

Updates communities with specified identifier using specified changes

3.6.5.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the community to update

string

Body

body
optional

the updated version of the community

3.6.5.3. Responses
HTTP Code Description Schema

200

the updated community

default

when failed

3.6.5.4. Consumes
  • application/json

3.6.5.5. Produces
  • application/json

3.6.6. Delete a Community

DELETE /communities/{id}
3.6.6.1. Description

Deletes community with specified identifier

3.6.6.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to fetch

string

3.6.6.3. Responses
HTTP Code Description Schema

204

empty response

No Content

default

when failed

3.6.7. Gets items in community

GET /communities/{id}/items
3.6.7.1. Description

Returns the list of items associated with the community

3.6.7.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the community

string

3.6.7.3. Responses
HTTP Code Description Schema

200

the list of community items

default

when failed

3.6.7.4. Produces
  • application/json

3.6.8. Add View

PUT /communities/{id}/likes
3.6.8.1. Description

Increase the number of views for the item by one

3.6.8.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.6.8.3. Responses
HTTP Code Description Schema

200

the updated item

default

when failed

3.6.8.4. Produces
  • application/json

3.6.9. Provision Site

POST /communities/{id}/provision
3.6.9.1. Description

Provision a community site

3.6.9.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

Body

port
required

the desired http port

string

Body

sitename
required

the desired site name to provision

string

3.6.9.3. Responses
HTTP Code Description Schema

200

the updated community object linked to the site

default

when failed to provision or failed to link site to object

3.6.9.4. Consumes
  • application/json

3.6.9.5. Produces
  • application/json

3.6.10. Check Site Provisioning

GET /communities/{id}/provision
3.6.10.1. Description

Query if a given community has a site provisioned

3.6.10.2. Parameters
Type Name Description Schema

Path

id
required

identifier of the item to update

string

3.6.10.3. Responses
HTTP Code Description Schema

200

the site information is provisioned or empty if not

No Content

default

when failed

3.6.10.4. Produces
  • application/json

3.6.11. Create Item

POST /items
3.6.11.1. Description

Submit a new GeoPlatform Item for persistence

3.6.11.2. Parameters
Type Name Description Schema

Body

body
optional

the item to be created

3.6.11.3. Responses
HTTP Code Description Schema

201

the newly created item

default

when failed

3.6.11.4. Consumes
  • application/json

3.6.11.5. Produces
  • application/json

3.6.12. Search Items

GET /items
3.6.12.1. Description

Search all GeoPlatform Item types

3.6.12.2. Parameters
Type Name Description Schema Default

Query

bbox
optional

WGS84 bounding box to constrain results, in form of <west>,<south>,<east>,<north>

string

Query

contributor.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

createdBy
optional

Constrain results to only Items created by the specified GeoPlatform user

string

Query

creator.id
optional

Constrain results to only Items referencing the Person with this identifier

string

Query

dataset
optional

Constrain results to only Items that 'operatesOn' the GeoPlatform Dataset with this identifier

string

Query

endDate
optional

Constrain results to only Items with temporal ranges containing end date equal to this value

number (int64)

Query

endDate.max
optional

Constrain results to only Items with temporal ranges containing end date before the supplied date

number (int64)

Query

endDate.min
optional

Constrain results to only Items with temporal ranges containing end date after the supplied date

number (int64)

Query

fields
optional

comma-separated list of properties to return for each result. see Item definition for list of properties

string

Query

galleryItem
optional

Constrain results to only Galleries containing the item with specified ID

string

Query

href
optional

Constrain results to only Services with this service url

string

Query

includeFacet
optional

comma-separated list of facet names to return aggregation counts about

enum (types, themes, publishers, serviceTypes, schemes)

Query

keywords
optional

Constrain results to only Items with the specified keyword(s)

string

Query

landingPage
optional

Constrain results to only Items with the specified landing page

string

Query

lastModifiedBy
optional

Constrain results to only Items last modified by the specified GeoPlatform user

string

Query

layerType
optional

Constrain results to only Layers of the specified layer type

enum (RasterLayer, FeatureLayer)

Query

mapLayer
optional

Constrain results to only Maps containing the layer with specified ID

string

Query

modified
optional

Constrain results to only Items with modification dates equal to this value

number (int64)

Query

modified.max
optional

Constrain results to only Items modified before the supplied date

number (int64)

Query

modified.min
optional

Constrain results to only Items modified after the supplied date

number (int64)

Query

page
optional

page of results to return

number (int32)

0

Query

parentLayer
optional

Constrain results to only Layers with a parent layer with the specified ID

string

Query

publisher.id
optional

Constrain results to only Items referencing Organizations with this identifier

string

Query

publisher.label
optional

Constrain results to only Items referencing Organizations with this label

string

Query

publisher.uri
optional

Constrain results to only Items referencing Organizations with this URI

string

Query

q
optional

free text to use in constraining results

string

Query

resourceType
optional

Constrain results to only Items with this resource type associated

Query

scheme.id
optional

Constrain results to only Concepts associated with the ConceptScheme with this identifier

string

Query

scheme.label
optional

Constrain results to only Concepts associated with the ConceptScheme with this label

string

Query

scheme.uri
optional

Constrain results to only Concepts associated with the ConceptScheme with this URI

string

Query

service
optional

constrain results to only Items 'servicedBy' the GeoPlatform Service with this identifier

string

Query

serviceType.id
optional

Constrain results to only Services with service type with this identifier

string

Query

serviceType.label
optional

Constrain results to only Services with service type with this label

string

Query

serviceType.uri
optional

Constrain results to only Services with service type with this URI

string

Query

size
optional

number of results to return per page

number (int32)

10

Query

sort
optional

field and direction to use when ordering results

enum (label,asc, label,desc, modified,asc, modified,desc, created,asc, created,desc, relevance,desc)

Query

startDate
optional

Constrain results to only Items with temporal ranges containing start date equal to this value

number (int64)

Query

startDate.max
optional

Constrain results to only Items with temporal ranges containing start date before the supplied date

number (int64)

Query

startDate.min
optional

Constrain results to only Items with temporal ranges containing start date after the supplied date

number (int64)

Query

subLayer
optional

Constrain results to only Layers with a child layer with the specified ID

string

Query

theme.id
optional

Constrain results to only Items referencing the Concept with this identifier

string

Query

theme.label
optional

Constrain results to only Items referencing the Concept with this label

string

Query

theme.uri
optional

Constrain results to only Items referencing the Concept with this URI

string

Query

type
optional

comma-separated list of GeoPlatform Item types to return in results

enum (dcat:Dataset, regp:Service, Layer, foaf:Person, org:Organization, Community, vcard:VCard, skos:Concept, skos:ConceptScheme)

Query

uri
optional

Find Item with specified URI

string

Query

visibility
optional

Constrain results to only Items with the specified visibility value

enum (public, private)

3.6.12.3. Responses
HTTP Code Description Schema

200

a set of items as search results

default

when failed