MICROSERVICE CATALOG (1.13.0)

Download OpenAPI specification:Download

License: GPL-3.0

Search API

complex-search-controller

searchDataObjects

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

dataTypes	Array of strings Items Enum: "RAWDATA" "QUICKLOOK_SD" "QUICKLOOK_MD" "QUICKLOOK_HD" "DOCUMENT" "THUMBNAIL" "OTHER" "AIP" "DESCRIPTION"
page	integer <int32>
	Array of objects (SearchRequest) [ 0 .. 100 ] items
size	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"dataTypes": ["RAWDATA"
],
"page": 0,
"requests": [{"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}
],
"size": 0
}

searchDataobjectsAttributes

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

datasetUrn	string
engineType required	string
entityIdsToExclude	Array of strings [ 0 .. 1000 ] items
entityIdsToInclude	Array of strings [ 0 .. 1000 ] items
searchDateLimit	string <date-time>
	object

Responses

Request samples

Payload

Content type

application/json

{"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}

computeDatasetsSummary

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

dataTypes	Array of strings Items Enum: "RAWDATA" "QUICKLOOK_SD" "QUICKLOOK_MD" "QUICKLOOK_HD" "DOCUMENT" "THUMBNAIL" "OTHER" "AIP" "DESCRIPTION"
page	integer <int32>
	Array of objects (SearchRequest) [ 0 .. 100 ] items
size	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"dataTypes": ["RAWDATA"
],
"page": 0,
"requests": [{"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}
],
"size": 0
}

catalog-download-controller

downloadFile

Authorizations:

REGARDS_OAUTH2

path Parameters

aip_id required	string
checksum required	string

query Parameters

acceptLicense	boolean Default: false
isContentInline	boolean

Responses

testProductAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

aip_id required	string
checksum required	string

Responses

downloadDamFile

Authorizations:

REGARDS_OAUTH2

path Parameters

aip_id required	string
checksum required	string

query Parameters

isContentInline	boolean
origin	string

Responses

search-engine-controller

searchAllCollections

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchCollectionPropertyValues

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
propertyName required	string

query Parameters

maxCount required	integer <int32>
required	object (MultiValueMapStringString)

Responses

searchAllCollectionsExtra

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
extra required	string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

getCollection

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
urn required	string

Responses

searchDataobjectsReturnDatasets

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchAllDataobjects

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchDataobjectsAttributes_1

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

required

object (MultiValueMapStringString)

Responses

searchDataobjectPropertiesBounds

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

properties required	Array of strings
required	object (MultiValueMapStringString)

Responses

searchDataobjectPropertyValues

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
propertyName required	string

query Parameters

maxCount required	integer <int32>
required	object (MultiValueMapStringString)

Responses

searchAllDataobjectsExtra

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
extra required	string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

getDataobject

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
urn required	string

Responses

searchAllDatasets

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchDatasetPropertyValues

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
propertyName required	string

query Parameters

maxCount required	integer <int32>
required	object (MultiValueMapStringString)

Responses

searchAllDatasetsExtra

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
extra required	string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchSingleDataset

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetUrn required	string
engineType required	string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchDataobjectPropertyValuesOnDataset

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetUrn required	string
engineType required	string
propertyName required	string

query Parameters

maxCount required	integer <int32>
required	object (MultiValueMapStringString)

Responses

searchSingleDatasetExtra

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetUrn required	string
engineType required	string
extra required	string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

getDataset

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
urn required	string

Responses

searchAll

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType

required

string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

searchAllExtra

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
extra required	string

query Parameters

required	object (Pageable)
required	object (MultiValueMapStringString)

Responses

getEntity

Authorizations:

REGARDS_OAUTH2

path Parameters

engineType required	string
urn required	string

Responses

search-engine-configuration-controller

Get engine configurations

Return a page of engine configurations

Authorizations:

REGARDS_OAUTH2

query Parameters

engineType	string
required	object (Pageable)

Responses

createConf

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

required	object (PluginConfiguration)
	object (Dataset)
datasetUrn	string
id	integer <int64>
label required	string

Responses

Request samples

Payload

Content type

application/json

{"configuration": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "string",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
},
"datasetUrn": "string",
"id": 0,
"label": "string"
}

deleteConf

Authorizations:

REGARDS_OAUTH2

path Parameters

confId

required

integer <int64>

Responses

retrieveConf

Authorizations:

REGARDS_OAUTH2

path Parameters

confId

required

integer <int64>

Responses

updateConf

Authorizations:

REGARDS_OAUTH2

path Parameters

confId

required

integer <int64>

Request Body schema: application/json
required

required	object (PluginConfiguration)
	object (Dataset)
datasetUrn	string
id	integer <int64>
label required	string

Responses

Request samples

Payload

Content type

application/json

{"configuration": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "string",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
},
"datasetUrn": "string",
"id": 0,
"label": "string"
}

access-right-controller

hasAccess

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

hasAccess_1

Authorizations:

REGARDS_OAUTH2

path Parameters

urn

required

string

Responses

fem-driver-controller

Schedule FEM Feature deletion

Schedule feature deletion on FEM microserice for each catalog entity matching given search request

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

datasetUrn	string
engineType required	string
entityIdsToExclude	Array of strings [ 0 .. 1000 ] items
entityIdsToInclude	Array of strings [ 0 .. 1000 ] items
searchDateLimit	string <date-time>
	object

Responses

Request samples

Payload

Content type

application/json

{"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}

Schedule FEM Feature notification

Schedule feature notification on FEM microserice for each catalog entity matching given search request

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

recipients	Array of strings unique List of recipient(business identifiers) for direct notification
	object (SearchRequest) Contain feature seach request

Responses

Request samples

Payload

Content type

application/json

{"recipients": ["string"
],
"searchRequest": {"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}
}

Schedule FEM Feature updates

Schedule feature updates on FEM microserice for each catalog entity matching given search request

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

	object (FeatureProperties)
	object (SearchRequest) Contain feature seach request

Responses

Request samples

Payload

Content type

application/json

{"feature": {"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
]
},
"searchRequest": {"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}
}

link-plugins-datasets-controller

retrieveLink

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetId

required

string

Responses

updateLink

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetId

required

string

Request Body schema: application/json
required

datasetId required	string
	Array of objects (PluginConfiguration) unique

Responses

Request samples

Payload

Content type

application/json

{"datasetId": "string",
"services": [{"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}
]
}

maintenance-controller

retrieveTenantsInMaintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

setMaintenance

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

module-manager-controller

exportConfiguration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

isConfigurationEnabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Authorizations:

REGARDS_OAUTH2

Responses

plugin-controller

getPlugins

Authorizations:

REGARDS_OAUTH2

query Parameters

pluginType

string

Responses

Response samples

200

Content type

application/json

[{"content": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

emptyCache

Authorizations:

REGARDS_OAUTH2

Responses

Get plugin configurations

Return a list of plugin configurations for a specific type

Authorizations:

REGARDS_OAUTH2

query Parameters

pluginType

string

Responses

Response samples

200

Content type

application/json

[{"content": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

getPluginConfigurationDirectAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId

required

string

Responses

Response samples

200

Content type

application/json

{"content": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

getPluginMetaDataById

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginId

required

string

Responses

Response samples

200

Content type

application/json

{"content": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

getPluginConfigurations

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginId

required

string

Responses

Response samples

200

Content type

application/json

[{"content": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

savePluginConfiguration

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

active	boolean
businessId	string[0-9a-zA-Z_-]*
iconUrl	string <url>
id	integer <int64>
identifiable	boolean
interfaceNames	Array of strings unique
isActive	boolean
label required	string
	object (PluginMetaData)
	object (PluginMetaData)
	Array of objects (IPluginParam) unique
pluginClassName	string
pluginId	string
priorityOrder required	integer <int32>
version	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}

Response samples

200

Content type

application/json

{"content": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

deletePluginConfiguration

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Responses

getPluginConfiguration

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Responses

Response samples

200

Content type

application/json

{"content": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

updatePluginConfiguration

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Request Body schema: application/json
required

active	boolean
businessId	string[0-9a-zA-Z_-]*
iconUrl	string <url>
id	integer <int64>
identifiable	boolean
interfaceNames	Array of strings unique
isActive	boolean
label required	string
	object (PluginMetaData)
	object (PluginMetaData)
	Array of objects (IPluginParam) unique
pluginClassName	string
pluginId	string
priorityOrder required	integer <int32>
version	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"licence": "string",
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"sensitive": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}

Response samples

200

Content type

application/json

{"content": {"active": true,
"businessId": "string",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["string"
],
"license": "string",
"markdown": "string",
"owner": "string",
"parameters": [{"defaultValue": "string",
"description": "string",
"keyLabel": "string",
"label": "string",
"markdown": "string",
"name": "string",
"optional": true,
"parameterizedSubTypes": ["STRING"
],
"pluginType": "string",
"sensible": true,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

getPluginTypes

Authorizations:

REGARDS_OAUTH2

query Parameters

available

boolean

Responses

Response samples

200

Content type

application/json

[{"content": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

jpa-multitenant-controller

getDataSourceStatus

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json;charset=UTF-8

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

testTenantConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json;charset=UTF-8

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

security-resources-controller

getAllResources

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

200

Content type

application/json

[{"autorizedRoles": [{"authority": "string",
"authorizedIpAdresses": ["string"
],
"roleName": "string"
}
],
"controllerSimpleName": "string",
"fullPath": "string",
"method": "GET",
"resourceAccess": { },
"resourceMappingId": "string"
}
]

catalog-services-controller

retrieveServices

Authorizations:

REGARDS_OAUTH2

query Parameters

applicationModes	Array of strings Items Enum: "ONE" "MANY"
datasetIpIds	Array of strings

Responses

applyService

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginConfigurationBusinessId

required

string

Request Body schema: application/json
required

	object
entityType	string Enum: "COLLECTION" "DATA" "DATASET"
	object (SearchRequest) Contain feature seach request

Responses

Request samples

Payload

Content type

application/json

{"dynamicParameters": {"property1": "string",
"property2": "string"
},
"entityType": "COLLECTION",
"searchRequest": {"datasetUrn": "string",
"engineType": "string",
"entityIdsToExclude": ["string"
],
"entityIdsToInclude": ["string"
],
"searchDateLimit": "2019-08-24T14:15:22Z",
"searchParameters": {"all": {"property1": "string",
"property2": "string"
},
"empty": true,
"property1": ["string"
],
"property2": ["string"
]
}
}
}

manager-controller

immediateShutdown

Authorizations:

REGARDS_OAUTH2

Responses

core-controller

landing page

Returns the root STAC Catalog or STAC Collection that is the entry point for users to browse with STAC Browser or for search engines to crawl. This can either return a single STAC Collection or more commonly a STAC catalog.

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

200

Content type

application/json

{"conformsTo": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"description": "string",
"id": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"title": "string"
}

ogc-features-controller

the feature collections in the dataset

A body of Feature Collections that belong or are used together with additional links. Request may not return the full set of metadata per Feature Collection.

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

200

Content type

application/json

{"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"description": "string",
"extent": {"spatial": {"bbox": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"temporal": {"interval": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "2019-08-24T14:15:22Z",
"_2": "2019-08-24T14:15:22Z"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"id": "string",
"keywords": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"license": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"providers": { },
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"summaries": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "COLLECTION"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

describe the feature collection with id `collectionId`

A single Feature Collection for the given if collectionId. Request this endpoint to get a full list of metadata for the Feature Collection.

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

Responses

Response samples

200
404

Content type

application/json

{"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"description": "string",
"extent": {"spatial": {"bbox": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"temporal": {"interval": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "2019-08-24T14:15:22Z",
"_2": "2019-08-24T14:15:22Z"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"id": "string",
"keywords": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"license": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"providers": { },
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"summaries": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "COLLECTION"
}

fetch features

Fetch features of the feature collection with id collectionId.

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

query Parameters

	object (BBox)
datetime	string
limit	integer <int32>
page	integer <int32> Default: 1

Responses

Response samples

200
404

Content type

application/json

{"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"features": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"centroid": {"lattitude": 0.1,
"longitude": 0.1
},
"collection": "string",
"geometry": {"type": "string"
},
"id": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"properties": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE_COLLECTION"
}

fetch a single feature

Fetch the feature with id featureId in the feature collection with id collectionId.

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId required	string
itemId required	string

Responses

Response samples

200
404

Content type

application/json

{"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"centroid": {"lattitude": 0.1,
"longitude": 0.1
},
"collection": "string",
"geometry": {"type": "string"
},
"id": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"properties": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE"
}

collection-search-controller

Search collection with simple filtering

Retrieve collection matching filters. Intended as a shorthand API for simple queries.

Authorizations:

REGARDS_OAUTH2

query Parameters

	object (BBox)
	object (ListString)
datetime	string
fields	string
	object (ListString)
	object (BBox)
	object (ListString)
item_datetime	string
	object (ListString)
item_query	string
limit	integer <int32> Default: 10
page	integer <int32> Default: 1
query	string
sortBy	string

Responses

Response samples

200

Content type

application/json

{"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"description": "string",
"extent": {"spatial": {"bbox": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"temporal": {"interval": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "2019-08-24T14:15:22Z",
"_2": "2019-08-24T14:15:22Z"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"id": "string",
"keywords": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"license": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"providers": { },
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"summaries": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "COLLECTION"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string"
}

Search collections with complex filtering using both collection and item query parameters

Retrieve collections matching filters. Full-featured query API.

Authorizations:

REGARDS_OAUTH2

query Parameters

page	integer <int32> Default: 1

Request Body schema: application/json
required

	object (BBox)
	object (ListString)
	object (DateInterval)
	object (Fields)
	object (ListString)
	object (IGeometry)
	object (CollectionItemSearchBody)
limit	integer <int32>
page	integer <int32>
	object (MapStringQueryObject)
	object (ListSortBy)

Responses

Request samples

Payload

Content type

application/json

{"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"fields": {"excludes": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"includes": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"crs": "string",
"type": "string"
},
"item": {"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"crs": "string",
"type": "string"
},
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"limit": 0,
"page": 0,
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"sortBy": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"direction": "ASC",
"field": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

Response samples

200

Content type

application/json

{"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"description": "string",
"extent": {"spatial": {"bbox": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"temporal": {"interval": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "2019-08-24T14:15:22Z",
"_2": "2019-08-24T14:15:22Z"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"id": "string",
"keywords": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"license": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"providers": { },
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"summaries": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "COLLECTION"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string"
}

continue to next/previous search collection page

Pagination for search in STAC is done through links, this endpoint provides the way to reuse the same search parameters but skip to an offset of results.

Authorizations:

REGARDS_OAUTH2

query Parameters

collectionBody required	string
page	integer <int32> Default: 1

Responses

Response samples

200

Content type

application/json

{"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"description": "string",
"extent": {"spatial": {"bbox": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"temporal": {"interval": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "2019-08-24T14:15:22Z",
"_2": "2019-08-24T14:15:22Z"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"id": "string",
"keywords": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"license": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"providers": { },
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"summaries": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "COLLECTION"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string"
}

Return the collections timeline

Search the timeline for each collection located in the request

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

appendAuthParameters	boolean
	object (ListCollectionFilters)
from	string
mode	string Enum: "BINARY" "BINARY_MAP" "HISTOGRAM" "HISTOGRAM_MAP"
to	string

Responses

Request samples

Payload

Content type

application/json

{"appendAuthParameters": true,
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"collectionId": "string",
"correlationId": "string",
"filters": {"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"crs": "string",
"type": "string"
},
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"from": "string",
"mode": "BINARY",
"to": "string"
}

Response samples

200

Content type

application/json

{"appendAuthParameters": true,
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"collectionId": "string",
"correlationId": "string",
"filters": {"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"type": "string"
},
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

conformance-controller

information about specifications that this API conforms to

A list of all conformance classes specified in a standard that the server conforms to.

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

200

Content type

application/json

{"conformsTo": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

collection-download-controller

Download script for downloading all collection items

Authorizations:

REGARDS_OAUTH2

query Parameters

filename	string Default: "regards.py"
tinyurl required	string

Responses

Download all collections as zip at once

Prepare NGINX mod_zip descriptor file to download all items of all collections at once

Authorizations:

REGARDS_OAUTH2

query Parameters

filename	string Default: "regards.zip"
tinyurl required	string

Responses

Compute information for downloading a set of collections as zip at once or one by one

For each collection and its item query parameters, a download link, the forecast download size and item number are given plus a link to download all at once

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

appendAuthParameters	boolean
	object (ListCollectionFilters)

Responses

Request samples

Payload

Content type

application/json

{"appendAuthParameters": true,
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"collectionId": "string",
"correlationId": "string",
"filters": {"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"crs": "string",
"type": "string"
},
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

Response samples

200

Content type

application/json

{"appendAuthParameters": true,
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"collectionId": "string",
"correlationId": "string",
"filters": {"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"type": "string"
},
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

Download all collections as zip at once

(Stream) Prepare NGINX mod_zip descriptor file to download all items of all collections at once

Authorizations:

REGARDS_OAUTH2

query Parameters

filename	string Default: "regards.zip"
tinyurl required	string

Responses

Download a collection sample as zip

Prepare NGINX mod_zip descriptor file to download first item of the collection

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

query Parameters

filename	string Default: "regards.zip"
tinyurl required	string

Responses

Download a collection sample as zip

(Stream) Prepare NGINX mod_zip descriptor file to download first item of the collection

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

query Parameters

filename	string Default: "regards.zip"
tinyurl required	string

Responses

Download script for downloading all items of a single collection

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

query Parameters

filename	string Default: "regards.py"
tinyurl required	string

Responses

Download a single collection as zip

Prepare NGINX mod_zip descriptor file to download all items of a single collection

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

query Parameters

filename	string Default: "regards.zip"
tinyurl required	string

Responses

Download a single collection as zip

(Stream) Prepare NGINX mod_zip descriptor file to download all items of a single collection

Authorizations:

REGARDS_OAUTH2

path Parameters

collectionId

required

string

query Parameters

filename	string Default: "regards.zip"
tinyurl required	string

Responses

item-search-controller

search with simple filtering

Retrieve Items matching filters. Intended as a shorthand API for simple queries.

Authorizations:

REGARDS_OAUTH2

query Parameters

	object (BBox)
	object (ListString)
datetime	string
fields	string
	object (ListString)
limit	integer <int32> Default: 10
page	integer <int32> Default: 1
query	string
sortBy	string

Responses

Response samples

200

Content type

application/json

{"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"features": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"centroid": {"lattitude": 0.1,
"longitude": 0.1
},
"collection": "string",
"geometry": {"type": "string"
},
"id": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"properties": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE_COLLECTION"
}

search with complex filtering

Retrieve Items matching filters. Full-featured query API.

Authorizations:

REGARDS_OAUTH2

query Parameters

page	integer <int32> Default: 1

Request Body schema: application/json
required

	object (BBox)
	object (ListString)
	object (DateInterval)
	object (Fields)
	object (ListString)
	object (IGeometry)
limit	integer <int32>
page	integer <int32>
	object (MapStringQueryObject)
	object (ListSortBy)

Responses

Request samples

Payload

Content type

application/json

{"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"fields": {"excludes": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"includes": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"ids": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {"crs": "string",
"type": "string"
},
"limit": 0,
"page": 0,
"query": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"sortBy": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"direction": "ASC",
"field": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}

Response samples

200

Content type

application/json

{"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"features": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"centroid": {"lattitude": 0.1,
"longitude": 0.1
},
"collection": "string",
"geometry": {"type": "string"
},
"id": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"properties": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE_COLLECTION"
}

continue to next/previous search page

Pagination for search in STAC is done through links, this endpoint provides the way to reuse the same search parameters but skip to an offset of results.

Authorizations:

REGARDS_OAUTH2

query Parameters

itemBody required	string
page	integer <int32> Default: 1

Responses

Response samples

200

Content type

application/json

{"context": {"limit": 0,
"matched": 0,
"returned": 0
},
"features": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"assets": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": {"description": "string",
"href": "http://example.com",
"roles": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"title": "string",
"type": "string"
}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"bbox": {"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"centroid": {"lattitude": 0.1,
"longitude": 0.1
},
"collection": "string",
"geometry": {"type": "string"
},
"id": "string",
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"properties": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"_1": "string",
"_2": { }
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"links": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacExtensions": {"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"stacVersion": "string",
"type": "FEATURE_COLLECTION"
}

search-validation-controller

Validate Geometry search parameter

Validate that the given WKT Geometry is valid.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

wktString

required

string

Responses

Request samples

Payload

Content type

application/json

{"wktString": "string"
}

MICROSERVICE CATALOG (1.13.0)

complex-search-controller

searchDataObjects

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

searchDataobjectsAttributes

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

computeDatasetsSummary

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

catalog-download-controller

downloadFile

Authorizations:

path Parameters

query Parameters

Responses

testProductAccess

Authorizations:

path Parameters

Responses

downloadDamFile

Authorizations:

path Parameters

query Parameters

Responses

search-engine-controller

searchAllCollections

Authorizations:

path Parameters

query Parameters

Responses

searchCollectionPropertyValues

Authorizations:

path Parameters

query Parameters

Responses

searchAllCollectionsExtra

Authorizations:

path Parameters

query Parameters

Responses

getCollection

Authorizations:

path Parameters

Responses

searchDataobjectsReturnDatasets

Authorizations:

path Parameters

query Parameters

Responses

searchAllDataobjects

Authorizations:

path Parameters

query Parameters

Responses

searchDataobjectsAttributes_1

Authorizations:

path Parameters

query Parameters

Responses

searchDataobjectPropertiesBounds

Authorizations:

path Parameters

query Parameters

Responses

searchDataobjectPropertyValues

Authorizations:

path Parameters

query Parameters

Responses

searchAllDataobjectsExtra

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required