Skip to main content
Version: 1.14
API docs by Redocly

MICROSERVICE FEM (1.14.1)

Download OpenAPI specification:Download

License: GPL-3.0

Feature management API

feature-entity-controller

Get features

Return a page of features matching criteria.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criteria.

disseminationPending
boolean

Filter on dissemination pending

object (ValuesRestrictionLong)

Filter on feature id

object (DatesRangeRestriction)

Filter on range of date for last update

model
string

Filter on model

object (ValuesRestrictionString)

Filter on provider id

session
string

Filter on session that emitted the request

source
string

Filter on source

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete features according to search parameters

Delete features according to search parameters

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criteria.

disseminationPending
boolean

Filter on dissemination pending

object (ValuesRestrictionLong)

Filter on feature id

object (DatesRangeRestriction)

Filter on range of date for last update

model
string

Filter on model

object (ValuesRestrictionString)

Filter on provider id

session
string

Filter on session that emitted the request

source
string

Filter on source

Responses

Request samples

Content type
application/json
{
}

Notify features to given recipients according to search parameters

Notify features to given recipients according to search parameters

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criteria with the recipients of direct notification.

disseminationPending
boolean

Filter on dissemination pending

object (ValuesRestrictionLong)

Filter on feature id

object (DatesRangeRestriction)

Filter on range of date for last update

model
string

Filter on model

object (ValuesRestrictionString)

Filter on provider id

session
string

Filter on session that emitted the request

source
string

Filter on source

Responses

Request samples

Content type
application/json
{
}

Retrieve one feature by its urn

Retrieve one feature by its urn

Authorizations:
REGARDS_OAUTH2
path Parameters
urn
required
string

URN of the feature

Responses

Response samples

Content type
application/json
{
}

dump-controller

resetLastDumpDate

Authorizations:
REGARDS_OAUTH2

Responses

feature-controller

Publish urns collection to delete and return urns of granted and denied requests

Publish urns collection to delete and return urns of granted and denied requests

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/geo+json
required
featuresUrns
Array of strings unique
priority
string
Enum: "HIGH" "NORMAL" "LOW"

Responses

Request samples

Content type
application/geo+json
{
}

Publish a feature collection to update and return urns of granted and denied requests

Publish a feature collection to update and return urns of granted and denied requests

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/geo+json
required
bbox
Array of numbers <double> [ items <double > ]
crs
string
Array of objects (Feature)
object (FeatureMetadata)
requestOwner
required
string
type
required
string

Responses

Request samples

Content type
application/geo+json
{
}

Publish a new feature and return the request id

Publish a new feature and return the request id

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/geo+json
required
bbox
Array of numbers <double> [ items <double > ]
crs
string
Array of objects (Feature)
object (FeatureCreationSessionMetadata)
requestOwner
required
string
type
required
string

Responses

Request samples

Content type
application/geo+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
{
}

feature-request-controller

Delete feature requests by selection

Delete feature requests by selection. Synchronous process, so the number of request handled is limited. Information about number of requests handled is returned in the response.

Authorizations:
REGARDS_OAUTH2
path Parameters
type
required
string
Enum: "COPY" "UPDATE" "NOTIFICATION" "CREATION" "DELETION" "SAVE_METADATA"

Type of requests to search for

Request Body schema: application/json
required

Set of search criterias.

object (DatesRangeRestriction)

Filter on range of date for last update

object (ValuesRestrictionString)

Filter on provider id

object (ValuesRestrictionLong)

Filter on feature id

session
string

Filter on session that emitted the request

source
string

Filter on source

object (ValuesRestrictionRequestState)

Filter on request states

object (ValuesRestrictionFeatureRequestStep)

Filter on request step

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retry feature requests by selection

Retry feature requests by selection. Synchronous process, so the number of request handled is limited. Information about number of requests handled is returned in the response.")

Authorizations:
REGARDS_OAUTH2
path Parameters
type
required
string
Enum: "COPY" "UPDATE" "NOTIFICATION" "CREATION" "DELETION" "SAVE_METADATA"

Type of requests to search for

Request Body schema: application/json
required

Set of search criterias.

object (DatesRangeRestriction)

Filter on range of date for last update

object (ValuesRestrictionString)

Filter on provider id

object (ValuesRestrictionLong)

Filter on feature id

session
string

Filter on session that emitted the request

source
string

Filter on source

object (ValuesRestrictionRequestState)

Filter on request states

object (ValuesRestrictionFeatureRequestStep)

Filter on request step

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get feature requests

Return a page of feature requests according criterias

Authorizations:
REGARDS_OAUTH2
path Parameters
type
required
string
Enum: "COPY" "UPDATE" "NOTIFICATION" "CREATION" "DELETION" "SAVE_METADATA"

Type of feature requests to search for

query Parameters
required
object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criterias.

object (DatesRangeRestriction)

Filter on range of date for last update

object (ValuesRestrictionString)

Filter on provider id

object (ValuesRestrictionLong)

Filter on feature id

session
string

Filter on session that emitted the request

source
string

Filter on source

object (ValuesRestrictionRequestState)

Filter on request states

object (ValuesRestrictionFeatureRequestStep)

Filter on request step

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

dynamic-tenant-setting-controller

retrieveAll

Authorizations:
REGARDS_OAUTH2
query Parameters
names
Array of strings unique

Responses

reset

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

update

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
defaultValue
object
description
string
name
string
value
object

Responses

Request samples

Content type
application/json
{
}

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses