• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• plugin-controller
  • getgetPlugins
  • delemptyCache
  • getGet plugin configurations
  • getgetPluginConfigurationDirectAccess
  • getgetPluginMetaDataById
  • getgetPluginConfigurations
  • postsavePluginConfiguration
  • deldeletePluginConfiguration
  • getgetPluginConfiguration
  • putupdatePluginConfiguration
  • getgetPluginTypes
• recipient-controller
  • getList all recipient
  • postCreate a recipient
  • putUpdate a recipient
  • delDelete a recipient
• recipient-dto-controller
  • getList all recipient
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• rule-controller
  • getList all rules
  • postCreate a rule
  • putUpdate a rule
  • delDelete a rule
• security-resources-controller
  • getgetAllResources
• manager-controller
  • postimmediateShutdown

API docs by Redocly

MICROSERVICE NOTIFIER (1.14.1)

Download OpenAPI specification:Download

License: GPL-3.0

Notification management API

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-notifier/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-notifier/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-notifier/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-notifier/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-notifier/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

plugin-controller

getPlugins

Generated server url

/api/v1/rs-notifier/plugins

Authorizations:

REGARDS_OAUTH2

query Parameters

pluginType

string

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "content": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "links": [

    • {

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

      }

    ]

  }

]

emptyCache

Generated server url

/api/v1/rs-notifier/plugins/cache

Authorizations:

REGARDS_OAUTH2

Responses

Get plugin configurations

Generated server url

/api/v1/rs-notifier/plugins/configs

Return a list of plugin configurations for a specific type

Authorizations:

REGARDS_OAUTH2

query Parameters

pluginType

string

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "content": {

    • "active": true,
    • "businessId": "string",
    • "iconUrl": "string",
    • "id": 0,
    • "identifiable": true,
    • "interfaceNames": [

      • "string"

      ],
    • "label": "string",
    • "metaData": {

      • "author": "string",
      • "contact": "string",
      • "description": "string",
      • "interfaceNames": [

        • "string"

        ],
      • "license": "string",
      • "markdown": "string",
      • "owner": "string",
      • "parameters": [

        • {

          • "defaultValue": "string",
          • "description": "string",
          • "keyLabel": "string",
          • "label": "string",
          • "markdown": "string",
          • "name": "string",
          • "optional": true,
          • "parameterizedSubTypes": [

            • "STRING"

            ],
          • "pluginType": "string",
          • "sensible": true,
          • "type": "STRING",
          • "unconfigurable": true,
          • "userMarkdown": "string"

          }

        ],
      • "pluginClassName": "string",
      • "pluginId": "string",
      • "url": "string",
      • "userMarkdown": "string",
      • "version": "string"

      },
    • "metaDataAndPluginId": {

      • "author": "string",
      • "contact": "string",
      • "description": "string",
      • "interfaceNames": [

        • "string"

        ],
      • "license": "string",
      • "markdown": "string",
      • "owner": "string",
      • "parameters": [

        • {

          • "defaultValue": "string",
          • "description": "string",
          • "keyLabel": "string",
          • "label": "string",
          • "markdown": "string",
          • "name": "string",
          • "optional": true,
          • "parameterizedSubTypes": [

            • "STRING"

            ],
          • "pluginType": "string",
          • "sensible": true,
          • "type": "STRING",
          • "unconfigurable": true,
          • "userMarkdown": "string"

          }

        ],
      • "pluginClassName": "string",
      • "pluginId": "string",
      • "url": "string",
      • "userMarkdown": "string",
      • "version": "string"

      },
    • "parameters": [

      • {

        • "dynamic": true,
        • "name": "string",
        • "type": "STRING",
        • "value": { }

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "priorityOrder": 0,
    • "version": "string"

    },
  • "links": [

    • {

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

      }

    ]

  }

]

getPluginConfigurationDirectAccess

Generated server url

/api/v1/rs-notifier/plugins/configs/{configBusinessId}

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required

string

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "businessId": "string",
  • "iconUrl": "string",
  • "id": 0,
  • "identifiable": true,
  • "interfaceNames": [

    • "string"

    ],
  • "label": "string",
  • "metaData": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "metaDataAndPluginId": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "parameters": [

    • {

      • "dynamic": true,
      • "name": "string",
      • "type": "STRING",
      • "value": { }

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "priorityOrder": 0,
  • "version": "string"

  },
• "links": [

  • {

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

    }

  ]

}

getPluginMetaDataById

Generated server url

/api/v1/rs-notifier/plugins/{pluginId}

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginId required

string

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "links": [

  • {

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

    }

  ]

}

getPluginConfigurations

Generated server url

/api/v1/rs-notifier/plugins/{pluginId}/config

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginId required

string

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "content": {

    • "active": true,
    • "businessId": "string",
    • "iconUrl": "string",
    • "id": 0,
    • "identifiable": true,
    • "interfaceNames": [

      • "string"

      ],
    • "label": "string",
    • "metaData": {

      • "author": "string",
      • "contact": "string",
      • "description": "string",
      • "interfaceNames": [

        • "string"

        ],
      • "license": "string",
      • "markdown": "string",
      • "owner": "string",
      • "parameters": [

        • {

          • "defaultValue": "string",
          • "description": "string",
          • "keyLabel": "string",
          • "label": "string",
          • "markdown": "string",
          • "name": "string",
          • "optional": true,
          • "parameterizedSubTypes": [

            • "STRING"

            ],
          • "pluginType": "string",
          • "sensible": true,
          • "type": "STRING",
          • "unconfigurable": true,
          • "userMarkdown": "string"

          }

        ],
      • "pluginClassName": "string",
      • "pluginId": "string",
      • "url": "string",
      • "userMarkdown": "string",
      • "version": "string"

      },
    • "metaDataAndPluginId": {

      • "author": "string",
      • "contact": "string",
      • "description": "string",
      • "interfaceNames": [

        • "string"

        ],
      • "license": "string",
      • "markdown": "string",
      • "owner": "string",
      • "parameters": [

        • {

          • "defaultValue": "string",
          • "description": "string",
          • "keyLabel": "string",
          • "label": "string",
          • "markdown": "string",
          • "name": "string",
          • "optional": true,
          • "parameterizedSubTypes": [

            • "STRING"

            ],
          • "pluginType": "string",
          • "sensible": true,
          • "type": "STRING",
          • "unconfigurable": true,
          • "userMarkdown": "string"

          }

        ],
      • "pluginClassName": "string",
      • "pluginId": "string",
      • "url": "string",
      • "userMarkdown": "string",
      • "version": "string"

      },
    • "parameters": [

      • {

        • "dynamic": true,
        • "name": "string",
        • "type": "STRING",
        • "value": { }

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "priorityOrder": 0,
    • "version": "string"

    },
  • "links": [

    • {

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

      }

    ]

  }

]

savePluginConfiguration

Generated server url

/api/v1/rs-notifier/plugins/{pluginId}/config

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

active	boolean
businessId	string[0-9a-zA-Z_-]*
iconUrl	string <url>
id	integer <int64>
identifiable	boolean
interfaceNames	Array of strings unique
isActive	boolean
label required	string
	object (PluginMetaData)
	object (PluginMetaData)
	Array of objects (IPluginParam) unique
pluginClassName	string
pluginId	string
priorityOrder required	integer <int32>
version	string

Responses

Request samples

• Payload

Content type

application/json

{

• "active": true,
• "businessId": "string",
• "iconUrl": "string",
• "id": 0,
• "identifiable": true,
• "interfaceNames": [

  • "string"

  ],
• "isActive": true,
• "label": "string",
• "metaData": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "metaDataAndPluginId": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "parameters": [

  • {

    • "dynamic": true,
    • "name": "string",
    • "type": "STRING",
    • "value": { }

    }

  ],
• "pluginClassName": "string",
• "pluginId": "string",
• "priorityOrder": 0,
• "version": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "businessId": "string",
  • "iconUrl": "string",
  • "id": 0,
  • "identifiable": true,
  • "interfaceNames": [

    • "string"

    ],
  • "label": "string",
  • "metaData": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "metaDataAndPluginId": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "parameters": [

    • {

      • "dynamic": true,
      • "name": "string",
      • "type": "STRING",
      • "value": { }

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "priorityOrder": 0,
  • "version": "string"

  },
• "links": [

  • {

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

    }

  ]

}

deletePluginConfiguration

Generated server url

/api/v1/rs-notifier/plugins/{pluginId}/config/{configBusinessId}

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Responses

getPluginConfiguration

Generated server url

/api/v1/rs-notifier/plugins/{pluginId}/config/{configBusinessId}

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "businessId": "string",
  • "iconUrl": "string",
  • "id": 0,
  • "identifiable": true,
  • "interfaceNames": [

    • "string"

    ],
  • "label": "string",
  • "metaData": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "metaDataAndPluginId": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "parameters": [

    • {

      • "dynamic": true,
      • "name": "string",
      • "type": "STRING",
      • "value": { }

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "priorityOrder": 0,
  • "version": "string"

  },
• "links": [

  • {

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

    }

  ]

}

updatePluginConfiguration

Generated server url

/api/v1/rs-notifier/plugins/{pluginId}/config/{configBusinessId}

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Request Body schema: application/json

required

active	boolean
businessId	string[0-9a-zA-Z_-]*
iconUrl	string <url>
id	integer <int64>
identifiable	boolean
interfaceNames	Array of strings unique
isActive	boolean
label required	string
	object (PluginMetaData)
	object (PluginMetaData)
	Array of objects (IPluginParam) unique
pluginClassName	string
pluginId	string
priorityOrder required	integer <int32>
version	string

Responses

Request samples

• Payload

Content type

application/json

{

• "active": true,
• "businessId": "string",
• "iconUrl": "string",
• "id": 0,
• "identifiable": true,
• "interfaceNames": [

  • "string"

  ],
• "isActive": true,
• "label": "string",
• "metaData": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "metaDataAndPluginId": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "parameters": [

  • {

    • "dynamic": true,
    • "name": "string",
    • "type": "STRING",
    • "value": { }

    }

  ],
• "pluginClassName": "string",
• "pluginId": "string",
• "priorityOrder": 0,
• "version": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "active": true,
  • "businessId": "string",
  • "iconUrl": "string",
  • "id": 0,
  • "identifiable": true,
  • "interfaceNames": [

    • "string"

    ],
  • "label": "string",
  • "metaData": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "metaDataAndPluginId": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "parameters": [

    • {

      • "dynamic": true,
      • "name": "string",
      • "type": "STRING",
      • "value": { }

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "priorityOrder": 0,
  • "version": "string"

  },
• "links": [

  • {

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

    }

  ]

}

getPluginTypes

Generated server url

/api/v1/rs-notifier/plugintypes

Authorizations:

REGARDS_OAUTH2

query Parameters

available

boolean

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "content": "string",
  • "links": [

    • {

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

      }

    ]

  }

]

recipient-controller

List all recipient Deprecated

Generated server url

/api/v1/rs-notifier/recipient

List all recipient

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable) Request page

Responses

Create a recipient

Generated server url

/api/v1/rs-notifier/recipient

Create a recipient

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

active	boolean
businessId	string[0-9a-zA-Z_-]*
iconUrl	string <url>
id	integer <int64>
identifiable	boolean
interfaceNames	Array of strings unique
isActive	boolean
label required	string
	object (PluginMetaData)
	object (PluginMetaData)
	Array of objects (IPluginParam) unique
pluginClassName	string
pluginId	string
priorityOrder required	integer <int32>
version	string

Responses

Request samples

• Payload

Content type

application/json

{

• "active": true,
• "businessId": "string",
• "iconUrl": "string",
• "id": 0,
• "identifiable": true,
• "interfaceNames": [

  • "string"

  ],
• "isActive": true,
• "label": "string",
• "metaData": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "metaDataAndPluginId": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "parameters": [

  • {

    • "dynamic": true,
    • "name": "string",
    • "type": "STRING",
    • "value": { }

    }

  ],
• "pluginClassName": "string",
• "pluginId": "string",
• "priorityOrder": 0,
• "version": "string"

}

Update a recipient

Generated server url

/api/v1/rs-notifier/recipient

Update a recipient

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

active	boolean
businessId	string[0-9a-zA-Z_-]*
iconUrl	string <url>
id	integer <int64>
identifiable	boolean
interfaceNames	Array of strings unique
isActive	boolean
label required	string
	object (PluginMetaData)
	object (PluginMetaData)
	Array of objects (IPluginParam) unique
pluginClassName	string
pluginId	string
priorityOrder required	integer <int32>
version	string

Responses

Request samples

• Payload

Content type

application/json

{

• "active": true,
• "businessId": "string",
• "iconUrl": "string",
• "id": 0,
• "identifiable": true,
• "interfaceNames": [

  • "string"

  ],
• "isActive": true,
• "label": "string",
• "metaData": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "metaDataAndPluginId": {

  • "author": "string",
  • "contact": "string",
  • "description": "string",
  • "interfaceNames": [

    • "string"

    ],
  • "licence": "string",
  • "license": "string",
  • "markdown": "string",
  • "owner": "string",
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "keyLabel": "string",
      • "label": "string",
      • "markdown": "string",
      • "name": "string",
      • "optional": true,
      • "parameterizedSubTypes": [

        • "STRING"

        ],
      • "pluginType": "string",
      • "sensible": true,
      • "sensitive": true,
      • "type": "STRING",
      • "unconfigurable": true,
      • "userMarkdown": "string"

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "url": "string",
  • "userMarkdown": "string",
  • "version": "string"

  },
• "parameters": [

  • {

    • "dynamic": true,
    • "name": "string",
    • "type": "STRING",
    • "value": { }

    }

  ],
• "pluginClassName": "string",
• "pluginId": "string",
• "priorityOrder": 0,
• "version": "string"

}

Delete a recipient

Generated server url

/api/v1/rs-notifier/recipient/{id}

Delete a recipient

Authorizations:

REGARDS_OAUTH2

path Parameters

businessId required

string Recipient to delete id

Responses

recipient-dto-controller

List all recipient

Generated server url

/api/v1/rs-notifier/recipients

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

Response samples

• 200

Content type

application/json

[

• {

  • "businessId": "string",
  • "description": "string",
  • "recipientLabel": "string"

  }

]

jpa-multitenant-controller

getDataSourceStatus

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json;charset=UTF-8

{

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

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

  }

}

testTenantConnection

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json;charset=UTF-8

{

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

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

  }

}

rule-controller

List all rules

Generated server url

/api/v1/rs-notifier/rule

List all Rules

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable) Wanted page

Responses

Create a rule

Generated server url

/api/v1/rs-notifier/rule

Create a Rule

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

id	string
recipientsBusinessIds	Array of strings
	object (PluginConfiguration) Recipient to create

Responses

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "recipientsBusinessIds": [

  • "string"

  ],
• "rulePluginConfiguration": {

  • "active": true,
  • "businessId": "string",
  • "iconUrl": "string",
  • "id": 0,
  • "identifiable": true,
  • "interfaceNames": [

    • "string"

    ],
  • "isActive": true,
  • "label": "string",
  • "metaData": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "licence": "string",
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "sensitive": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "metaDataAndPluginId": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "licence": "string",
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "sensitive": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "parameters": [

    • {

      • "dynamic": true,
      • "name": "string",
      • "type": "STRING",
      • "value": { }

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "priorityOrder": 0,
  • "version": "string"

  }

}

Update a rule

Generated server url

/api/v1/rs-notifier/rule

Update a Rule

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

id	string
recipientsBusinessIds	Array of strings
	object (PluginConfiguration) Recipient to create

Responses

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "recipientsBusinessIds": [

  • "string"

  ],
• "rulePluginConfiguration": {

  • "active": true,
  • "businessId": "string",
  • "iconUrl": "string",
  • "id": 0,
  • "identifiable": true,
  • "interfaceNames": [

    • "string"

    ],
  • "isActive": true,
  • "label": "string",
  • "metaData": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "licence": "string",
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "sensitive": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "metaDataAndPluginId": {

    • "author": "string",
    • "contact": "string",
    • "description": "string",
    • "interfaceNames": [

      • "string"

      ],
    • "licence": "string",
    • "license": "string",
    • "markdown": "string",
    • "owner": "string",
    • "parameters": [

      • {

        • "defaultValue": "string",
        • "description": "string",
        • "keyLabel": "string",
        • "label": "string",
        • "markdown": "string",
        • "name": "string",
        • "optional": true,
        • "parameterizedSubTypes": [

          • "STRING"

          ],
        • "pluginType": "string",
        • "sensible": true,
        • "sensitive": true,
        • "type": "STRING",
        • "unconfigurable": true,
        • "userMarkdown": "string"

        }

      ],
    • "pluginClassName": "string",
    • "pluginId": "string",
    • "url": "string",
    • "userMarkdown": "string",
    • "version": "string"

    },
  • "parameters": [

    • {

      • "dynamic": true,
      • "name": "string",
      • "type": "STRING",
      • "value": { }

      }

    ],
  • "pluginClassName": "string",
  • "pluginId": "string",
  • "priorityOrder": 0,
  • "version": "string"

  }

}

Delete a rule

Generated server url

/api/v1/rs-notifier/rule/{id}

Delete a rule

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-notifier/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-notifier/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses