Skip to main content
Version: 1.16
API docs by Redocly

MICROSERVICE ACCESS (1.16.1)

Download OpenAPI specification:Download

License: GPL-3.0

Configuration for project GUI

Registration controller

Request a new access

Request a new access, i.e. the creation of a new project user

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
accessGroups
Array of strings unique
email
required
string
firstName
string
lastName
string
maxQuota
integer <int64>
Array of objects (MetaData)
origin
string
originUrl
string
password
string
requestLink
string
roleName
string

Responses

Request samples

Content type
application/json
{
}

Request a new access

Request a new access, i.e. create a new project user with external authentication system

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
accessGroups
Array of strings unique
email
required
string
firstName
string
lastName
string
maxQuota
integer <int64>
Array of objects (MetaData)
origin
string
originUrl
string
password
string
requestLink
string
roleName
string

Responses

Request samples

Content type
application/json
{
}

Confirm the registration

Confirm the registration by email with the given token

Authorizations:
REGARDS_OAUTH2
path Parameters
token
required
string

Responses

removeAccessRequest

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

Accept the access request

Accept the access request with the given access identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

Activate an inactive user

Activate an inactive user with the given access identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

Deny the access request

Deny the access request with the given access identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

Deactivate an active user

Deactivate access for the given project user

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

Access settings controller

Retrieves the settings

Retrieves the settings managing the access requests

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

Update the settings

Update the setting managing the access requests

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
{
}

Response samples

Content type
application/json
{
}

IHM Module controller

Retrieve UI modules

Retrieve UI modules for a given application.

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
query Parameters
active
string
required
object (Pageable)
type
string

Responses

Response samples

Content type
application/json
{
}

Register an UI module

Save a new UI module for a given application

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
Request Body schema: application/json
required
active
required
boolean
applicationId
required
string
conf
string
container
required
string
description
required
string
id
integer <int64>
object (UIPage)
type
required
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete an UI module

Delete an UI module by its identifier for a given application

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
moduleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

Retrieve IHM module

Retrieve an UI module for a given application.

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
moduleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

Update a UI module

Update an UI module by its identifier for a given application

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
moduleId
required
integer <int64>
Request Body schema: application/json
required
active
required
boolean
applicationId
required
string
conf
string
container
required
string
description
required
string
id
integer <int64>
object (UIPage)
type
required
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

attribute-cache-refresh-controller

refreshAttributeCache

Authorizations:
REGARDS_OAUTH2

Responses

Access search controller

Search collections from catalogue

Perform an OpenSearch request on collections. Injects applicable UI Services and Catalog Services.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

Search for catalogue datasets using data objects criteria

Perform an joined OpenSearch request. The search will be performed on dataobjects attributes, but will return the associated datasets. Injects applicable UI Services and Catalog Services.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

Search products from catalogue

Perform an OpenSearch request on dataobjects. Only return required facets. Injects applicable UI Services and Catalog Services.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

Search datasets from catalogue

Perform an OpenSearch request on datasets. Injects applicable UI Services and Catalog Services.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

Search products, datasets and collections from catalogue

Perform an OpenSearch request on all indexed data, regardless of the type. The return objects can be any mix of collection, dataset, dataobject and document. Injects applicable UI Services and Catalog Services.

Authorizations:
REGARDS_OAUTH2

Responses

UI configuration controller

Get the UI configuration

Retrieve the UI configuration for the given application identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string

Responses

Response samples

Content type
application/json
{
}

Register a new UI configuration

Add a new UI configuration

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
Request Body schema: application/json
required
configuration
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update an UI configuration

Update an UI configuration

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
Request Body schema: application/json
required
configuration
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Search history controller

Retrieve search history page

Retrieve search history page using account email and module id

Authorizations:
REGARDS_OAUTH2
query Parameters
accountEmail
required
string
moduleId
required
integer <int64>
required
object (Pageable)

Responses

Create a search history element.

Create and save a search history from a search history dto, an account email and a module id

Authorizations:
REGARDS_OAUTH2
query Parameters
accountEmail
required
string
moduleId
required
integer <int64>
Request Body schema: application/json
required
configuration
required
string

Configuration of the search history element.

id
integer <int64>

Identifier to track the search history element.

name
required
string

Name of the search history element.

Responses

Request samples

Content type
application/json
{
}

Delete a search history element.

Delete search history element using its id.

Authorizations:
REGARDS_OAUTH2
path Parameters
searchHistoryId
required
integer <int64>

Responses

Update a search history element.

Update search history element using its id.

Authorizations:
REGARDS_OAUTH2
path Parameters
searchHistoryId
required
integer <int64>
Request Body schema: application/json
required

Search history config to be processed

string

Responses

Request samples

Content type
application/json
"string"

UI layout controller

Get an UI layout configuration

Retrieve UI layout configuration for the given application identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string

Responses

Response samples

Content type
application/json
{
}

Update an UI layout configuration

Update the UI layout configuration for the given application identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string
Request Body schema: application/json
required
applicationId
required
string
id
integer <int64>
layout
required
string

Responses

Request samples

Content type
application/json
{
}

Response 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

Storage download quota controller

getQuotaLimits

Authorizations:
REGARDS_OAUTH2

Responses

getCurrentQuotas

Authorizations:
REGARDS_OAUTH2

Responses

getQuotaLimits_1

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string

Responses

upsertQuotaLimits

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string
Request Body schema: application/json
required
email
string
maxQuota
integer <int64>
rateLimit
integer <int64>

Responses

Request samples

Content type
application/json
{
}

Recipient controller

List all recipient

List all recipient if missing parameter, or only recipients enabling the direct notification or only them not enabling the direct notification

Authorizations:
REGARDS_OAUTH2
query Parameters
directNotificationEnabled
boolean

Recipient enable or not the direct notification

Responses

jpa-multitenant-controller

getDataSourceStatus

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json
{
}

testTenantConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

ui-plugin-service-controller

retrieveServices

Authorizations:
REGARDS_OAUTH2
query Parameters
dataset_id
string

Responses

services-aggregator-controller

retrieveServices_1

Authorizations:
REGARDS_OAUTH2
query Parameters
applicationModes
Array of strings
Items Enum: "ONE" "MANY"
datasetIpIds
Array of strings

Responses

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses

Theme controller

Get HMI themes

Return a page of HMI themes

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

Register UI theme

Save a new UI theme

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
active
boolean
configuration
required
string
id
integer <int64>
name
required
string
visible
boolean

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete UI theme

Delete an UI theme by its identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
themeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

Get an UI theme

Retrieve an UI theme by its identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
themeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

Update UI theme

Update an UI theme

Authorizations:
REGARDS_OAUTH2
path Parameters
themeId
required
integer <int64>
Request Body schema: application/json
required
active
boolean
configuration
required
string
id
integer <int64>
name
required
string
visible
boolean

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Toponyms controller

Register a toponym

Endpoint to add a not visible toponym.

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

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Search toponyms

Search for toponyms. Geometries are not retrieved and list content is limited to 100 entities.

Authorizations:
REGARDS_OAUTH2
query Parameters
locale
string
partialLabel
string

Responses

Response samples

Content type
application/json
[
]

Get toponym

Retrieve one toponym by its identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
businessId
required
string
query Parameters
simplified
boolean

Responses

Response samples

Content type
application/json
{
}

ui-plugin-configuration-controller

retrievePluginConfigurations

Authorizations:
REGARDS_OAUTH2
query Parameters
isActive
boolean
isLinkedToAllEntities
boolean
required
object (Pageable)
type
string
Enum: "CRITERIA" "SERVICE"

Responses

createPluginConfiguration

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
active
required
boolean
conf
string
id
integer <int64>
label
required
string
linkedToAllEntities
required
boolean
required
object (UIPluginDefinition)

Responses

Request samples

Content type
application/json
{
}

deletePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginConfId
required
integer <int64>

Responses

retrievePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginConfId
required
integer <int64>

Responses

updatePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginConfId
required
integer <int64>
Request Body schema: application/json
required
active
required
boolean
conf
string
id
integer <int64>
label
required
string
linkedToAllEntities
required
boolean
required
object (UIPluginDefinition)

Responses

Request samples

Content type
application/json
{
}

retrievePluginConfigurationsByPlugin

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
integer <int64>
query Parameters
isActive
boolean
isLinkedToAllEntities
boolean
required
object (Pageable)

Responses

ui-plugin-definition-controller

Get UI Plugin definitions

Return a page of UI Plugin definitions

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)
type
string
Enum: "CRITERIA" "SERVICE"

Responses

Response samples

Content type
application/json
{
}

savePlugin

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
applicationModes
required
Array of strings unique
Items Enum: "ONE" "MANY"
entityTypes
required
Array of strings unique
Items Enum: "COLLECTION" "DATA" "DATASET"
iconUrl
string
id
integer <int64>
name
required
string
roleName
string
sourcePath
required
string
type
required
string
Enum: "CRITERIA" "SERVICE"

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

deletePlugin

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

retrievePlugin

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

updatePlugin

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
integer <int64>
Request Body schema: application/json
required
applicationModes
required
Array of strings unique
Items Enum: "ONE" "MANY"
entityTypes
required
Array of strings unique
Items Enum: "COLLECTION" "DATA" "DATASET"
iconUrl
string
id
integer <int64>
name
required
string
roleName
string
sourcePath
required
string
type
required
string
Enum: "CRITERIA" "SERVICE"

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Project users controller

Create a project user

Create a project user by bypassing the registration process (Administrator feature)

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
accessGroups
Array of strings unique
email
string
firstName
string
lastName
string
maxQuota
integer <int64>
Array of objects (MetaData)
originUrl
string
password
string
Array of objects (ResourcesAccess)
rateLimit
integer <int64>
requestLink
string
roleName
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Valid a user creation

Send a new verification email for a user creation

Authorizations:
REGARDS_OAUTH2
path Parameters
email
required
string

Responses

Get the project user

Retrieve the project user metadata by its emaila

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string

Responses

Response samples

Content type
application/json
{
}

Check the role of user

Check if the user with the given email has administrator role

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string

Responses

Response samples

Content type
application/json
true

Get the current project user metadata

Retrieve the current authenticated project user metadata

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
{
}

Update the current project user

Update the currently authenticated project user

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
accessGroups
Array of strings unique
email
string
firstName
string
id
integer <int64>
lastName
string
maxQuota
integer <int64>
Array of objects (MetaData)
Array of objects (ResourcesAccess)
rateLimit
integer <int64>
object (Role)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get a list of users

Retrieve a page containing a list of users with a pending access request

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

Get the list of project users

Retrieve a page containing the list of project users with the specified role name or a parent role

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)
role_name
required
string

Responses

Response samples

Content type
application/json
{
}

Get the list of project users

Retrieve a page of project users with the specified role identifier or a parent role

Authorizations:
REGARDS_OAUTH2
path Parameters
role_id
required
integer <int64>
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

Get users of the project

Return a page of users of the project matching criterias.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criterias.

object (ValuesRestrictionString)

Filter on access groups

object (DatesRangeRestriction)

Filter on last connection date

email
string

Filter on user email

firstName
string

Filter on user firstName

object (DatesRangeRestriction)

Filter on last connection date

lastName
string

Filter on user lastname

object (ValuesRestrictionString)

Filter on access groups

quotaWarningCount
integer <int64>

Filter on quota warning count

object (ValuesRestrictionString)

Filter on access groups

object (ValuesRestrictionUserStatus)

Filter on status

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete the project user

Delete the project user with the given identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
user_id
required
integer <int64>

Responses

Get a project user

Retrieve the project user metadata by its identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
user_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

Update the project user

Update the project user with the given identifier

Authorizations:
REGARDS_OAUTH2
path Parameters
user_id
required
integer <int64>
Request Body schema: application/json
required
accessGroups
Array of strings unique
email
string
firstName
string
id
integer <int64>
lastName
string
maxQuota
integer <int64>
Array of objects (MetaData)
Array of objects (ResourcesAccess)
rateLimit
integer <int64>
object (Role)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

User resource controller

removeProjectUserResources

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string

Responses

retrieveProjectUserResources

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string
query Parameters
borrowedRoleName
string

Responses

updateProjectUserResources

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string
Request Body schema: application/json
required
Array
controllerSimpleName
required
string
defaultRole
required
string
Enum: "INSTANCE_ADMIN" "PROJECT_ADMIN" "EXPLOIT" "ADMIN" "REGISTERED_USER" "PUBLIC"
description
string
id
integer <int64>
identifiable
boolean
microservice
required
string
resource
required
string
verb
required
string
Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Content type
application/json
[
]