Skip to main content
Version: 1.15

MICROSERVICE DATAPROVIDER (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Data Provider API

acquisition-file-controller

search_2

Authorizations:
REGARDS_OAUTH2
query Parameters
chainId
integer <int64>
filePath
string
from
string <date-time>
required
object (Pageable)
productId
integer <int64>
state
Array of strings
Items Enum: "IN_PROGRESS" "VALID" "INVALID" "ACQUIRED" "SUPERSEDED" "SUPERSEDED_AFTER_ERROR" "ERROR"

Responses

monitoring-controller

Get acquisition processing chain monitors

Return a page of acquisition processing chain monitors

Authorizations:
REGARDS_OAUTH2
query Parameters
label
string
mode
string
Enum: "MANUAL" "AUTO"
required
object (Pageable)
running
boolean

Responses

acquisition-processing-chain-controller

retrieveAll

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

updateChainsStateAndMode

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
active
boolean
chainIds
Array of integers <int64> [ items <int64 > ]
mode
string
Enum: "MANUAL" "AUTO"
updateType
string
Enum: "ONLY_ACTIVITY" "ONLY_MODE" "ALL"

Responses

Request samples

Content type
application/json
{
}

create

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
active
required
boolean
categories
required
Array of strings unique
required
Array of objects (AcquisitionFileInfo) [ 1 .. 2147483647 ] items unique
required
object (PluginConfiguration)
id
integer <int64>
ingestChain
required
string
label
required
string
lastActivationDate
string <date-time>
locked
boolean
mode
required
string
Enum: "MANUAL" "AUTO"
periodicity
string0 .*
object (PluginConfiguration)
required
object (PluginConfiguration)
productsStored
required
boolean
referenceLocation
string
required
Array of objects (StorageMetadataProvider)
required
object (PluginConfiguration)
versioningMode
string
Enum: "IGNORE" "INC_VERSION" "MANUAL" "REPLACE"

Responses

Request samples

Content type
application/json
{
}

deleteProducts

Authorizations:
REGARDS_OAUTH2
query Parameters
chainName
required
string
session
string

Responses

relaunchErrors

Authorizations:
REGARDS_OAUTH2
query Parameters
chainName
required
string
session
required
string

Responses

delete

Authorizations:
REGARDS_OAUTH2
path Parameters
chainId
required
integer <int64>

Responses

get_1

Authorizations:
REGARDS_OAUTH2
path Parameters
chainId
required
integer <int64>

Responses

updateStateAndMode

Authorizations:
REGARDS_OAUTH2
path Parameters
chainId
required
integer <int64>
Request Body schema: application/json
required
active
boolean
mode
string
Enum: "MANUAL" "AUTO"
updateType
string
Enum: "ONLY_ACTIVITY" "ONLY_MODE" "ALL"

Responses

Request samples

Content type
application/json
{
}

update

Authorizations:
REGARDS_OAUTH2
path Parameters
chainId
required
integer <int64>
Request Body schema: application/json
required
active
required
boolean
categories
required
Array of strings unique
required
Array of objects (AcquisitionFileInfo) [ 1 .. 2147483647 ] items unique
required
object (PluginConfiguration)
id
integer <int64>
ingestChain
required
string
label
required
string
lastActivationDate
string <date-time>
locked
boolean
mode
required
string
Enum: "MANUAL" "AUTO"
periodicity
string0 .*
object (PluginConfiguration)
required
object (PluginConfiguration)
productsStored
required
boolean
referenceLocation
string
required
Array of objects (StorageMetadataProvider)
required
object (PluginConfiguration)
versioningMode
string
Enum: "IGNORE" "INC_VERSION" "MANUAL" "REPLACE"

Responses

Request samples

Content type
application/json
{
}

startManualChain

Authorizations:
REGARDS_OAUTH2
path Parameters
chainId
required
integer <int64>
query Parameters
session
string

Responses

stopChain

Authorizations:
REGARDS_OAUTH2
path Parameters
chainId
required
integer <int64>

Responses

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

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
[
]

product-controller

search

Authorizations:
REGARDS_OAUTH2
query Parameters
chainId
integer <int64>
from
string <date-time>
nosession
boolean
required
object (Pageable)
productName
string
session
string
sipState
Array of strings
state
Array of strings
Items Enum: "ACQUIRING" "COMPLETED" "FINISHED" "INVALID" "UPDATED" "CANCELED"

Responses

get

Authorizations:
REGARDS_OAUTH2
path Parameters
productId
required
integer <int64>

Responses

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