OpenAPI Swagger-UI

To access online microservice OpenAPI UI, go to https://HOST/swagger-ui/index.html

• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• security-resources-controller
  • getgetAllResources
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown

API docs by Redocly

MICROSERVICE DELIVERY (2.0.0)

Download OpenAPI specification:Download

License: GPL-3.0

Delivery API

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-delivery/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-delivery/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-delivery/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-delivery/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-delivery/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-delivery/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-delivery/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-delivery/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-delivery/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-delivery/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

/api/v1/rs-delivery/regards/{tenant}/datasource/status

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

testTenantConnection

Generated server url

/api/v1/rs-delivery/regards/{tenant}/datasource/test

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-delivery/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"

  }

]

dynamic-tenant-setting-controller

retrieveAll

Generated server url

/api/v1/rs-delivery/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-delivery/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-delivery/settings/{name}

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

• Payload

Content type

application/json

{

• "defaultValue": { },
• "description": "string",
• "name": "string",
• "value": { }

}

manager-controller

immediateShutdown

Generated server url

/api/v1/rs-delivery/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses