Skip to main content
Version: 1.15

MICROSERVICE ACCESS INSTANCE (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Configuration for portal and instance admin GUI

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"

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

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

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

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

find

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

createNotVisibleToponym

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
feature
string
project
string
user
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

search

Authorizations:
REGARDS_OAUTH2
query Parameters
locale
string
Default: "en"
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
{
}