Skip to main content
Version: 1.13.0
API docs by Redocly

MICROSERVICE ACCESS (1.13.0)

Download OpenAPI specification:Download

License: GPL-3.0

Configuration for project GUI

registration-controller

requestAccess

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

requestExternalAccess

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

verifyEmail

Authorizations:
REGARDS_OAUTH2
path Parameters
token
required
string

Responses

removeAccessRequest

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

acceptAccessRequest

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

activeAccess

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

denyAccessRequest

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

inactiveAccess

Authorizations:
REGARDS_OAUTH2
path Parameters
access_id
required
integer <int64>

Responses

access-settings-controller

retrieveAccessSettings

Authorizations:
REGARDS_OAUTH2

Responses

updateAccessSettings

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

module-controller

retrieveModules

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

Responses

Response samples

Content type
application/json
{
}

saveModule

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

deleteModule

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

Responses

Response samples

Content type
application/json
{
}

retrieveModule

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

Responses

Response samples

Content type
application/json
{
}

updateModule

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

searchCollections

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

searchDataobjectsReturnDatasets

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

searchDataobjects

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

searchDatasets

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (MultiValueMapStringString)

Responses

searchAll

Authorizations:
REGARDS_OAUTH2

Responses

ui-configuration-controller

retrieveConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string

Responses

Response samples

Content type
application/json
{
}

addConfiguration

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

updateConfiguration

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

ui-layout-controller

retrieveUILayout

Authorizations:
REGARDS_OAUTH2
path Parameters
applicationId
required
string

Responses

Response samples

Content type
application/json
{
}

updateUILayout

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-dto-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;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
[
]

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

saveTheme

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

deleteTheme

Authorizations:
REGARDS_OAUTH2
path Parameters
themeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

retrieveTheme

Authorizations:
REGARDS_OAUTH2
path Parameters
themeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

updateTheme

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

createNotVisibleToponym

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

Authorizations:
REGARDS_OAUTH2
query Parameters
locale
string
partialLabel
string

Responses

Response samples

Content type
application/json
[
]

get

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

createUser

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

sendVerificationEmail

Authorizations:
REGARDS_OAUTH2
path Parameters
email
required
string

Responses

retrieveProjectUserByEmail

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string

Responses

isAdmin

Authorizations:
REGARDS_OAUTH2
path Parameters
user_email
required
string

Responses

retrieveCurrentProjectUser

Authorizations:
REGARDS_OAUTH2

Responses

updateCurrentProjectUser

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

retrieveAccessRequestList

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

retrieveRoleProjectUsersList

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

Responses

retrieveRoleProjectUserList

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

Responses

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

removeProjectUser

Authorizations:
REGARDS_OAUTH2
path Parameters
user_id
required
integer <int64>

Responses

retrieveProjectUser

Authorizations:
REGARDS_OAUTH2
path Parameters
user_id
required
integer <int64>

Responses

updateProjectUser

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

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
[
]