• p-batch-controller
  • postcreateBatch
• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• p-monitoring-controller
  • postexecutions
• plugin-controller
  • getgetPlugins
  • delemptyCache
  • getGet plugin configurations
  • getgetPluginConfigurationDirectAccess
  • getgetPluginMetaDataById
  • getgetPluginConfigurations
  • postsavePluginConfiguration
  • deldeletePluginConfiguration
  • getgetPluginConfiguration
  • putupdatePluginConfiguration
  • getgetPluginTypes
• p-process-controller
  • getfindAll_1
  • getfindByUuid
• process-plugin-config-controller
  • getfindAll
  • postcreate
  • deldelete
  • getfindByBusinessId
  • putupdate
  • putattachRoleToProcess
• process-plugin-dataset-controller
  • postfindProcessesByDatasets
  • getfindProcessesByDataset
  • putattachDatasetToProcesses
• process-plugin-metadata-controller
  • getlistAllDetectedPlugins
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• security-resources-controller
  • getgetAllResources
• manager-controller
  • postimmediateShutdown

API docs by Redocly

MICROSERVICE PROCESSING (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Processing API

p-batch-controller

createBatch

Generated server url

/api/v1/rs-processing/batch

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

correlationId	string
	object
	object
processBusinessId	string <uuid>
tenant	string
user	string
userRole	string

Responses

Request samples

• Payload

Content type

application/json

{

• "correlationId": "string",
• "filesetsByDataset": {

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

  },
• "parameters": {

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

  },
• "processBusinessId": "f2660539-8277-4c23-b670-4eb877b20724",
• "tenant": "string",
• "user": "string",
• "userRole": "string"

}

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-processing/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-processing/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-processing/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-processing/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-processing/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

p-monitoring-controller

executions

Generated server url

/api/v1/rs-processing/monitoring/executions

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable) Sorting and page configuration
tenant required	string

Request Body schema: application/json

required

	object (DatesRangeRestriction) Filter on creation date
processBusinessId	string Filter on id of business process
	object (ValuesRestrictionExecutionStatus) Filter on status of execution
	object (ValuesRestrictionString) Filter on email of user

Responses

Request samples

• Payload

Content type

application/json

{

• "creationDate": {

  • "after": "2020-12-31T00:00:00Z",
  • "before": "2020-12-31T00:00:00Z"

  },
• "processBusinessId": "string",
• "status": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "SUCCESS"

    ]

  },
• "userEmail": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "string"

    ]

  }

}

plugin-controller

getPlugins

Generated server url

/api/v1/rs-processing/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-processing/plugins/cache

Authorizations:

REGARDS_OAUTH2

Responses

Get plugin configurations

Generated server url

/api/v1/rs-processing/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-processing/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-processing/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-processing/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-processing/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-processing/plugins/{pluginId}/config/{configBusinessId}

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Responses

getPluginConfiguration

Generated server url

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

      }

    ]

  }

]

p-process-controller

findAll_1

Generated server url

/api/v1/rs-processing/process

Authorizations:

REGARDS_OAUTH2

Responses

findByUuid

Generated server url

/api/v1/rs-processing/process/`{processBusinessId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

processBusinessId required

string <uuid>

Responses

process-plugin-config-controller

findAll

Generated server url

/api/v1/rs-processing/processplugins/config

Authorizations:

REGARDS_OAUTH2

query Parameters

processNameLike

string

Responses

create

Generated server url

/api/v1/rs-processing/processplugins/config

Authorizations:

REGARDS_OAUTH2

Request Body schema:

application/jsonapplication/json;charset=UTF-8application/json

required

	object (PluginConfiguration)
	object (Rights)

Responses

Request samples

• Payload

Content type

application/jsonapplication/json;charset=UTF-8application/json

{

• "pluginConfiguration": {

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

  },
• "rights": {

  • "datasets": [

    • { }

    ],
  • "linkedToAllDatasets": true,
  • "role": "string"

  }

}

delete

Generated server url

/api/v1/rs-processing/processplugins/config/`{processBusinessId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

processBusinessId required

string <uuid>

Responses

findByBusinessId

Generated server url

/api/v1/rs-processing/processplugins/config/`{processBusinessId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

processBusinessId required

string <uuid>

Responses

update

Generated server url

/api/v1/rs-processing/processplugins/config/`{processBusinessId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

processBusinessId required

string <uuid>

Request Body schema: application/json

required

	object (PluginConfiguration)
	object (Rights)

Responses

Request samples

• Payload

Content type

application/json

{

• "pluginConfiguration": {

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

  },
• "rights": {

  • "datasets": [

    • { }

    ],
  • "linkedToAllDatasets": true,
  • "role": "string"

  }

}

attachRoleToProcess

Generated server url

/api/v1/rs-processing/processplugins/config/`{processBusinessId}`/userRole

Authorizations:

REGARDS_OAUTH2

path Parameters

processBusinessId required

string <uuid>

query Parameters

userRole required

string

Responses

process-plugin-dataset-controller

findProcessesByDatasets

Generated server url

/api/v1/rs-processing/processplugins/fordatasets

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

Array

string

Responses

Request samples

• Payload

Content type

application/json

[

• "string"

]

findProcessesByDataset

Generated server url

/api/v1/rs-processing/processplugins/linkprocessdataset/`{datasetIpId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetIpId required

string

Responses

attachDatasetToProcesses

Generated server url

/api/v1/rs-processing/processplugins/linkprocessdataset/`{datasetIpId}`

Authorizations:

REGARDS_OAUTH2

path Parameters

datasetIpId required

string

Request Body schema: application/json

Array

string <uuid>

Responses

Request samples

• Payload

Content type

application/json

[

• "497f6eca-6276-4993-bfeb-53cbbbba6f08"

]

process-plugin-metadata-controller

listAllDetectedPlugins

Generated server url

/api/v1/rs-processing/processplugins/metadata

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

• 200

Content type

application/json

[

• {

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

  }

]

jpa-multitenant-controller

getDataSourceStatus

Generated server url

/api/v1/rs-processing/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-processing/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": { }

  }

}

security-resources-controller

getAllResources

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses