Skip to main content
Version: 1.15

MICROSERVICE PROCESSING (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Processing API

p-batch-controller

createBatch

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

Content type
application/json
{
}

maintenance-controller

retrieveTenantsInMaintenance

Authorizations:
REGARDS_OAUTH2

Responses

unSetMaintenance

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

setMaintenance

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

module-manager-controller

exportConfiguration

Authorizations:
REGARDS_OAUTH2

Responses

importConfiguration

Authorizations:
REGARDS_OAUTH2
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

isConfigurationEnabled

Authorizations:
REGARDS_OAUTH2

Responses

isReady

Authorizations:
REGARDS_OAUTH2

Responses

isReadyEnabled

Authorizations:
REGARDS_OAUTH2

Responses

restart

Authorizations:
REGARDS_OAUTH2

Responses

isRestartEnabled

Authorizations:
REGARDS_OAUTH2

Responses

p-monitoring-controller

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

Content type
application/json
{
}

plugin-controller

getPlugins

Authorizations:
REGARDS_OAUTH2
query Parameters
pluginType
string

Responses

Response samples

Content type
application/json
[
]

emptyCache

Authorizations:
REGARDS_OAUTH2

Responses

Get plugin configurations

Return a list of plugin configurations for a specific type

Authorizations:
REGARDS_OAUTH2
query Parameters
pluginType
string

Responses

Response samples

Content type
application/json
[
]

getPluginConfigurationDirectAccess

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginMetaDataById

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginConfigurations

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
[
]

savePluginConfiguration

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

deletePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string

Responses

getPluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

updatePluginConfiguration

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

getPluginTypes

Authorizations:
REGARDS_OAUTH2
query Parameters
available
boolean

Responses

Response samples

Content type
application/json
[
]

p-process-controller

findAll_1

Authorizations:
REGARDS_OAUTH2

Responses

findByUuid

Authorizations:
REGARDS_OAUTH2
path Parameters
processBusinessId
required
string <uuid>

Responses

process-plugin-config-controller

findAll

Authorizations:
REGARDS_OAUTH2
query Parameters
processNameLike
string

Responses

create

Authorizations:
REGARDS_OAUTH2
Request Body schema:
required
object (PluginConfiguration)
object (Rights)

Responses

Request samples

Content type
{
}

delete

Authorizations:
REGARDS_OAUTH2
path Parameters
processBusinessId
required
string <uuid>

Responses

findByBusinessId

Authorizations:
REGARDS_OAUTH2
path Parameters
processBusinessId
required
string <uuid>

Responses

update

Authorizations:
REGARDS_OAUTH2
path Parameters
processBusinessId
required
string <uuid>
Request Body schema: application/json
required
object (PluginConfiguration)
object (Rights)

Responses

Request samples

Content type
application/json
{
}

attachRoleToProcess

Authorizations:
REGARDS_OAUTH2
path Parameters
processBusinessId
required
string <uuid>
query Parameters
userRole
required
string

Responses

process-plugin-dataset-controller

findProcessesByDatasets

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
]

findProcessesByDataset

Authorizations:
REGARDS_OAUTH2
path Parameters
datasetIpId
required
string

Responses

attachDatasetToProcesses

Authorizations:
REGARDS_OAUTH2
path Parameters
datasetIpId
required
string
Request Body schema: application/json
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
]

process-plugin-metadata-controller

listAllDetectedPlugins

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

jpa-multitenant-controller

getDataSourceStatus

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

testTenantConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses