• IHM Module controller
  • getRetrieve UI modules
  • postRegister an UI module
  • delDelete an UI module
  • getRetrieve IHM module
  • putUpdate a UI module
• UI configuration controller
  • getGet the UI configuration
  • postRegister a new UI configuration
  • putUpdate an UI configuration
• Search history controller
  • getRetrieve search history page
  • postCreate a search history element.
  • delDelete a search history element.
  • putUpdate a search history element.
• UI layout controller
  • getGet an UI layout configuration
  • putUpdate an UI layout configuration
• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• security-resources-controller
  • getgetAllResources
• manager-controller
  • postimmediateShutdown
• Theme controller
  • getGet HMI themes
  • postRegister UI theme
  • delDelete UI theme
  • getGet an UI theme
  • putUpdate UI theme
• Toponyms controller
  • getGet all toponyms
  • postRegister a toponym
  • getSearch toponyms
  • getGet toponym

API docs by Redocly

MICROSERVICE ACCESS INSTANCE (2.2.0)

Download OpenAPI specification:Download

License: GPL-3.0

Configuration for portal and instance admin GUI

IHM Module controller

Retrieve UI modules

Generated server url

/api/v1/rs-access-instance/applications/{applicationId}/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

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

      • "active": true,
      • "applicationId": "string",
      • "conf": "string",
      • "container": "string",
      • "description": "string",
      • "id": 0,
      • "page": {

        • "customIconURL": "string",
        • "home": true,
        • "iconType": "string",
        • "title": "string"

        },
      • "type": "string"

      },
    • "links": [

      • {

        • "deprecation": "string",
        • "href": "string",
        • "hreflang": "string",
        • "media": "string",
        • "name": "string",
        • "profile": "string",
        • "rel": "string",
        • "title": "string",
        • "type": "string"

        }

      ]

    }

  ],
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

Register an UI module

Generated server url

/api/v1/rs-access-instance/applications/{applicationId}/modules

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

• Payload

Content type

application/json

{

• "active": true,
• "applicationId": "string",
• "conf": "string",
• "container": "string",
• "description": "string",
• "id": 0,
• "page": {

  • "customIconURL": "string",
  • "home": true,
  • "iconType": "string",
  • "title": "string"

  },
• "type": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "applicationId": "string",
  • "conf": "string",
  • "container": "string",
  • "description": "string",
  • "id": 0,
  • "page": {

    • "customIconURL": "string",
    • "home": true,
    • "iconType": "string",
    • "title": "string"

    },
  • "type": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Delete an UI module

Generated server url

/api/v1/rs-access-instance/applications/{applicationId}/modules/{moduleId}

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

• 200

Content type

application/json

{

• "content": { },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Retrieve IHM module

Generated server url

/api/v1/rs-access-instance/applications/{applicationId}/modules/{moduleId}

Retrieve an UI module for a given application.

Authorizations:

REGARDS_OAUTH2

path Parameters

applicationId required	string
moduleId required	integer <int64>

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "applicationId": "string",
  • "conf": "string",
  • "container": "string",
  • "description": "string",
  • "id": 0,
  • "page": {

    • "customIconURL": "string",
    • "home": true,
    • "iconType": "string",
    • "title": "string"

    },
  • "type": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Update a UI module

Generated server url

/api/v1/rs-access-instance/applications/{applicationId}/modules/{moduleId}

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

• Payload

Content type

application/json

{

• "active": true,
• "applicationId": "string",
• "conf": "string",
• "container": "string",
• "description": "string",
• "id": 0,
• "page": {

  • "customIconURL": "string",
  • "home": true,
  • "iconType": "string",
  • "title": "string"

  },
• "type": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "applicationId": "string",
  • "conf": "string",
  • "container": "string",
  • "description": "string",
  • "id": 0,
  • "page": {

    • "customIconURL": "string",
    • "home": true,
    • "iconType": "string",
    • "title": "string"

    },
  • "type": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

UI configuration controller

Get the UI configuration

Generated server url

/api/v1/rs-access-instance/configuration/{applicationId}

Retrieve the UI configuration for the given application identifier

Authorizations:

REGARDS_OAUTH2

path Parameters

applicationId required

string

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "configuration": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Register a new UI configuration

Generated server url

/api/v1/rs-access-instance/configuration/{applicationId}

Add a new UI configuration

Authorizations:

REGARDS_OAUTH2

path Parameters

applicationId required

string

Request Body schema: application/json

required

configuration

string

Responses

Request samples

• Payload

Content type

application/json

{

• "configuration": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "configuration": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Update an UI configuration

Generated server url

/api/v1/rs-access-instance/configuration/{applicationId}

Update an UI configuration

Authorizations:

REGARDS_OAUTH2

path Parameters

applicationId required

string

Request Body schema: application/json

required

configuration

string

Responses

Request samples

• Payload

Content type

application/json

{

• "configuration": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "configuration": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Search history controller

Retrieve search history page

Generated server url

/api/v1/rs-access-instance/history

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.

Generated server url

/api/v1/rs-access-instance/history

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

• Payload

Content type

application/json

{

• "configuration": "string",
• "id": 0,
• "name": "string"

}

Delete a search history element.

Generated server url

/api/v1/rs-access-instance/history/{searchHistoryId}

Delete search history element using its id.

Authorizations:

REGARDS_OAUTH2

path Parameters

searchHistoryId required

integer <int64>

Responses

Update a search history element.

Generated server url

/api/v1/rs-access-instance/history/{searchHistoryId}

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

• Payload

Content type

application/json

"string"

UI layout controller

Get an UI layout configuration

Generated server url

/api/v1/rs-access-instance/layouts/{applicationId}

Retrieve UI layout configuration for the given application identifier

Authorizations:

REGARDS_OAUTH2

path Parameters

applicationId required

string

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "applicationId": "string",
  • "id": 0,
  • "layout": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Update an UI layout configuration

Generated server url

/api/v1/rs-access-instance/layouts/{applicationId}

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

• Payload

Content type

application/json

{

• "applicationId": "string",
• "id": 0,
• "layout": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "applicationId": "string",
  • "id": 0,
  • "layout": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-access-instance/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-access-instance/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-access-instance/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-access-instance/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-access-instance/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-access-instance/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-access-instance/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-access-instance/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-access-instance/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-access-instance/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-access-instance/security/resources

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "autorizedRoles": [

    • {

      • "authority": "string",
      • "authorizedIpAdresses": [

        • "string"

        ],
      • "roleName": "string"

      }

    ],
  • "controllerSimpleName": "string",
  • "fullPath": "string",
  • "method": "GET",
  • "resourceAccess": { },
  • "resourceMappingId": "string"

  }

]

manager-controller

immediateShutdown

Generated server url

/api/v1/rs-access-instance/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses

Theme controller

Get HMI themes

Generated server url

/api/v1/rs-access-instance/themes

Return a page of HMI themes

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

Response samples

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

      • "active": true,
      • "configuration": "string",
      • "id": 0,
      • "name": "string",
      • "visible": true

      },
    • "links": [

      • {

        • "deprecation": "string",
        • "href": "string",
        • "hreflang": "string",
        • "media": "string",
        • "name": "string",
        • "profile": "string",
        • "rel": "string",
        • "title": "string",
        • "type": "string"

        }

      ]

    }

  ],
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

Register UI theme

Generated server url

/api/v1/rs-access-instance/themes

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

• Payload

Content type

application/json

{

• "active": true,
• "configuration": "string",
• "id": 0,
• "name": "string",
• "visible": true

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "configuration": "string",
  • "id": 0,
  • "name": "string",
  • "visible": true

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Delete UI theme

Generated server url

/api/v1/rs-access-instance/themes/{themeId}

Delete an UI theme by its identifier

Authorizations:

REGARDS_OAUTH2

path Parameters

themeId required

integer <int64>

Responses

Response samples

• 200

Content type

application/json

{

• "content": { },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Get an UI theme

Generated server url

/api/v1/rs-access-instance/themes/{themeId}

Retrieve an UI theme by its identifier

Authorizations:

REGARDS_OAUTH2

path Parameters

themeId required

integer <int64>

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "configuration": "string",
  • "id": 0,
  • "name": "string",
  • "visible": true

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Update UI theme

Generated server url

/api/v1/rs-access-instance/themes/{themeId}

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

• Payload

Content type

application/json

{

• "active": true,
• "configuration": "string",
• "id": 0,
• "name": "string",
• "visible": true

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "configuration": "string",
  • "id": 0,
  • "name": "string",
  • "visible": true

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Toponyms controller

Get all toponyms

Generated server url

/api/v1/rs-access-instance/toponyms

Retrieve a page containing all toponyms

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

Response samples

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

      • "boundingBox": "string",
      • "businessId": "string",
      • "copyright": "string",
      • "description": "string",
      • "geometry": {

        • "type": "Unlocated"

        },
      • "labelEn": "string",
      • "labelFr": "string",
      • "toponymMetadata": {

        • "author": "string",
        • "creationDate": "2019-08-24T14:15:22Z",
        • "expirationDate": "2019-08-24T14:15:22Z",
        • "project": "string"

        },
      • "visible": true

      },
    • "links": [

      • {

        • "deprecation": "string",
        • "href": "string",
        • "hreflang": "string",
        • "media": "string",
        • "name": "string",
        • "profile": "string",
        • "rel": "string",
        • "title": "string",
        • "type": "string"

        }

      ]

    }

  ],
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

Register a toponym

Generated server url

/api/v1/rs-access-instance/toponyms

Add a not visible toponym.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

feature	string
project	string
user	string

Responses

Request samples

• Payload

Content type

application/json

{

• "feature": "string",
• "project": "string",
• "user": "string"

}

Response samples

• 201

Content type

application/json

{

• "content": {

  • "boundingBox": "string",
  • "businessId": "string",
  • "copyright": "string",
  • "description": "string",
  • "geometry": {

    • "type": "Unlocated"

    },
  • "labelEn": "string",
  • "labelFr": "string",
  • "toponymMetadata": {

    • "author": "string",
    • "creationDate": "2019-08-24T14:15:22Z",
    • "expirationDate": "2019-08-24T14:15:22Z",
    • "project": "string"

    },
  • "visible": true

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Search toponyms

Generated server url

/api/v1/rs-access-instance/toponyms/search

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

Authorizations:

REGARDS_OAUTH2

query Parameters

locale	string Default: "en"
partialLabel	string

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "content": {

    • "boundingBox": "string",
    • "businessId": "string",
    • "copyright": "string",
    • "description": "string",
    • "geometry": {

      • "type": "Unlocated"

      },
    • "labelEn": "string",
    • "labelFr": "string",
    • "toponymMetadata": {

      • "author": "string",
      • "creationDate": "2019-08-24T14:15:22Z",
      • "expirationDate": "2019-08-24T14:15:22Z",
      • "project": "string"

      },
    • "visible": true

    },
  • "links": [

    • {

      • "deprecation": "string",
      • "href": "string",
      • "hreflang": "string",
      • "media": "string",
      • "name": "string",
      • "profile": "string",
      • "rel": "string",
      • "title": "string",
      • "type": "string"

      }

    ]

  }

]

Get toponym

Generated server url

/api/v1/rs-access-instance/toponyms/{businessId}

Retrieve one toponym by its identifier

Authorizations:

REGARDS_OAUTH2

path Parameters

businessId required

string

query Parameters

simplified

boolean

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "boundingBox": "string",
  • "businessId": "string",
  • "copyright": "string",
  • "description": "string",
  • "geometry": {

    • "type": "Unlocated"

    },
  • "labelEn": "string",
  • "labelFr": "string",
  • "toponymMetadata": {

    • "author": "string",
    • "creationDate": "2019-08-24T14:15:22Z",
    • "expirationDate": "2019-08-24T14:15:22Z",
    • "project": "string"

    },
  • "visible": true

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}