• module-controller
  • getretrieveModules
  • postsaveModule
  • deldeleteModule
  • getretrieveModule
  • putupdateModule
• ui-configuration-controller
  • getretrieveConfiguration
  • postaddConfiguration
  • putupdateConfiguration
• ui-layout-controller
  • getretrieveUILayout
  • putupdateUILayout
• 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
  • postsaveTheme
  • deldeleteTheme
  • getretrieveTheme
  • putupdateTheme
• toponyms-controller
  • getfind
  • postcreateNotVisibleToponym
  • getsearch
  • getget

API docs by Redocly

MICROSERVICE ACCESS INSTANCE (1.14.1)

Download OpenAPI specification:Download

License: GPL-3.0

Configuration for portal and instance admin GUI

module-controller

retrieveModules

Generated server url

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

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

  }

}

saveModule

Generated server url

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

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"

    }

  ]

}

deleteModule

Generated server url

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

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"

    }

  ]

}

retrieveModule

Generated server url

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

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"

    }

  ]

}

updateModule

Generated server url

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

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

retrieveConfiguration

Generated server url

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

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"

    }

  ]

}

addConfiguration

Generated server url

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

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"

    }

  ]

}

updateConfiguration

Generated server url

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

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"

    }

  ]

}

ui-layout-controller

retrieveUILayout

Generated server url

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

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"

    }

  ]

}

updateUILayout

Generated server url

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

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

  }

}

saveTheme

Generated server url

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

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"

    }

  ]

}

deleteTheme

Generated server url

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

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"

    }

  ]

}

retrieveTheme

Generated server url

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

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"

    }

  ]

}

updateTheme

Generated server url

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

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

find

Generated server url

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

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

Response samples

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

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

        • "type": "string"

        },
      • "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

  }

}

createNotVisibleToponym

Generated server url

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

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

• 200

Content type

application/json

{

• "content": {

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

    • "type": "string"

    },
  • "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

Generated server url

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

Authorizations:

REGARDS_OAUTH2

query Parameters

locale	string Default: "en"
partialLabel	string

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "content": {

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

      • "type": "string"

      },
    • "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

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

businessId required

string

query Parameters

simplified

boolean

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

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

    • "type": "string"

    },
  • "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"

    }

  ]

}