Skip to main content
Version: 1.14

MICROSERVICE CATALOG (1.14.1)

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

access-right-controller

hasAccess

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
]

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
[
]

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

Content type
application/json
[
]

getPluginConfigurationDirectAccess

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginMetaDataById

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginConfigurations

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
[
]

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

getPluginTypes

Authorizations:
REGARDS_OAUTH2
query Parameters
available
boolean

Responses

Response samples

Content type
application/json
[
]

jpa-multitenant-controller

getDataSourceStatus

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

testTenantConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

Response samples

Content type
application/json
{