Skip to main content
Version: 1.15

MICROSERVICE DAM (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Data management API

access-group-controller

Get groups of user

Return a page of groups of user

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)
public
boolean

Responses

createAccessGroup

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
id
integer <int64>
isInternal
boolean
isPublic
boolean
name
string

Responses

Request samples

Content type
application/json
{
}

deleteAccessGroup

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

retrieveAccessGroup

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

updateAccessGroup

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
id
integer <int64>
isInternal
boolean
isPublic
boolean
name
string

Responses

Request samples

Content type
application/json
{
}

access-right-controller

retrieveAccessRightsList

Authorizations:
REGARDS_OAUTH2
query Parameters
accessgroup
string
dataset
string
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

createAccessRight

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
required
object (AccessGroup)
object (Dataset)
object (PluginConfiguration)
required
object (Dataset)
fileAccessLevel
required
string
Enum: "NO_ACCESS" "INHERITED_ACCESS" "CUSTOM_ACCESS"
id
integer <int64>
identifiable
boolean
metadataAccessLevel
required
string
Enum: "NO_ACCESS" "RESTRICTED_ACCESS" "CUSTOM_ACCESS" "FULL_ACCESS"
required
object (QualityFilter)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

retrieveAccessRight_1

Authorizations:
REGARDS_OAUTH2
query Parameters
accessgroup
required
string
dataset
required
string

Responses

Response samples

Content type
application/json
{
}

isUserAutorisedToAccessDataset

Authorizations:
REGARDS_OAUTH2
query Parameters
dataset
required
string
user
required
string

Responses

Response samples

Content type
application/json
true

deleteAccessRight

Authorizations:
REGARDS_OAUTH2
path Parameters
accessright_id
required
integer <int64>

Responses

retrieveAccessRight

Authorizations:
REGARDS_OAUTH2
path Parameters
accessright_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

updateAccessRight

Authorizations:
REGARDS_OAUTH2
path Parameters
accessright_id
required
integer <int64>
Request Body schema: application/json
required
required
object (AccessGroup)
object (Dataset)
object (PluginConfiguration)
required
object (Dataset)
fileAccessLevel
required
string
Enum: "NO_ACCESS" "INHERITED_ACCESS" "CUSTOM_ACCESS"
id
integer <int64>
identifiable
boolean
metadataAccessLevel
required
string
Enum: "NO_ACCESS" "RESTRICTED_ACCESS" "CUSTOM_ACCESS" "FULL_ACCESS"
required
object (QualityFilter)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

collection-controller

Get collections

Return a page of collections

Authorizations:
REGARDS_OAUTH2
query Parameters
label
string
required
object (Pageable)

Responses

createCollection

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
creationDate
string <date-time>
docId
string
required
object (CollectionFeature)
object (MultimapDataTypeDataFile)
object (IGeometry)
groups
Array of strings unique
id
integer <int64>
ipId
string
label
string
last
boolean
lastUpdate
string <date-time>
required
object (Model)
mutableCopyOfPropertiesPaths
Array of strings unique
object (IGeometry)
Array of objects (IPropertyObject) unique
providerId
string
tags
Array of strings unique
type
string
version
integer <int32>
virtualId
string
object (IGeometry)

Responses

Request samples

Content type
application/json
{
}

deleteCollection

Authorizations:
REGARDS_OAUTH2
path Parameters
collection_id
required
integer <int64>

Responses

retrieveCollection

Authorizations:
REGARDS_OAUTH2
path Parameters
collection_id
required
integer <int64>

Responses

updateCollection

Authorizations:
REGARDS_OAUTH2
path Parameters
collection_id
required
integer <int64>
Request Body schema: application/json
required
creationDate
string <date-time>
docId
string
required
object (CollectionFeature)
object (MultimapDataTypeDataFile)
object (IGeometry)
groups
Array of strings unique
id
integer <int64>
ipId
string
label
string
last
boolean
lastUpdate
string <date-time>
required
object (Model)
mutableCopyOfPropertiesPaths
Array of strings unique
object (IGeometry)
Array of objects (IPropertyObject) unique
providerId
string
tags
Array of strings unique
type
string
version
integer <int32>
virtualId
string
object (IGeometry)

Responses

Request samples

Content type
application/json
{
}

associate_1

Authorizations:
REGARDS_OAUTH2
path Parameters
collection_id
required
integer <int64>
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
]

dissociate_1

Authorizations:
REGARDS_OAUTH2
path Parameters
collection_id
required
integer <int64>
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
]

db-connection-controller

getAllDBConnections

Authorizations:
REGARDS_OAUTH2

Responses

createDBConnection

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
{
}

deleteDBConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
plgBusinessId
required
string

Responses

getDBConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
plgBusinessId
required
string

Responses

testDBConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
plgBusinessId
required
string

Responses

updateDBConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
plgBusinessId
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
{
}

getTables

Authorizations:
REGARDS_OAUTH2
path Parameters
plgBusinessId
required
string

Responses

getColumns

Authorizations:
REGARDS_OAUTH2
path Parameters
plgBusinessId
required
string
tableName
required
string

Responses

crawler-controller

Get crawler datasources

Return a list of crawler datasources

Authorizations:
REGARDS_OAUTH2

Responses

deleteDatasourceIngestion

Authorizations:
REGARDS_OAUTH2
path Parameters
ingestion_id
required
string

Responses

scheduleNowDatasourceIngestion

Authorizations:
REGARDS_OAUTH2
path Parameters
ingestion_id
required
string

Responses

dataset-controller

Get datasets

Return a page of datasets always sorted by their label

Authorizations:
REGARDS_OAUTH2
query Parameters
label
string
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

createDataset

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
creationDate
string <date-time>
dataModel
string
docId
string
required
object (DatasetFeature)
object (MultimapDataTypeDataFile)
object (IGeometry)
groups
Array of strings unique
id
integer <int64>
ipId
string
label
string
last
boolean
lastUpdate
string <date-time>
licence
string
object (DatasetMetadata)
required
object (Model)
mutableCopyOfPropertiesPaths
Array of strings unique
object (IGeometry)
openSearchSubsettingClause
string
object (PluginConfiguration)
Array of objects (IPropertyObject) unique
providerId
string
object (ICriterion)
tags
Array of strings unique
type
string
object (ICriterion)
version
integer <int32>
virtualId
string
object (IGeometry)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

retrieveAttributes

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)
Request Body schema: application/json
required
datasetIds
Array of strings unique
modelNames
Array of strings unique

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

retrieveDataAttributes

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)
Request Body schema: application/json
required
datasetIds
Array of strings unique
modelNames
Array of strings unique

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

retrieveDataset_1

Authorizations:
REGARDS_OAUTH2
path Parameters
dataset_ipId
required
string

Responses

Response samples

Content type
application/json
{
}

validateSubSettingClause

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

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

getModelAttrAssocsForDataInDataset

Authorizations:
REGARDS_OAUTH2
query Parameters
datasetUrn
required
string

Responses

Response samples

Content type
application/json
[
]

deleteDataset

Authorizations:
REGARDS_OAUTH2
path Parameters
dataset_id
required
integer <int64>

Responses

retrieveDataset

Authorizations:
REGARDS_OAUTH2
path Parameters
dataset_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
}

updateDataset

Authorizations:
REGARDS_OAUTH2
path Parameters
dataset_id
required
integer <int64>
Request Body schema: application/json
required
creationDate
string <date-time>
dataModel
string
docId
string
required
object (DatasetFeature)
object (MultimapDataTypeDataFile)
object (IGeometry)
groups
Array of strings unique
id
integer <int64>
ipId
string
label
string
last
boolean
lastUpdate
string <date-time>
licence
string
object (DatasetMetadata)
required
object (Model)
mutableCopyOfPropertiesPaths
Array of strings unique
object (IGeometry)
openSearchSubsettingClause
string
object (PluginConfiguration)
Array of objects (IPropertyObject) unique
providerId
string
object (ICriterion)
tags
Array of strings unique
type
string
object (ICriterion)
version
integer <int32>
virtualId
string
object (IGeometry)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

associate

Authorizations:
REGARDS_OAUTH2
path Parameters
dataset_id
required
integer <int64>
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
]

dissociate

Authorizations:
REGARDS_OAUTH2
path Parameters
dataset_id
required
integer <int64>
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
]

dataset-with-access-right-controller

retrieveDatasets_1

Authorizations:
REGARDS_OAUTH2
path Parameters
accessGroupName
required
string
query Parameters
datasetLabel
string
required
object (Pageable)

Responses

data-source-controller

Get IDataSourcePlugin plugin configurations

Return a list of plugin configurations of type IDataSourcePlugin

Authorizations:
REGARDS_OAUTH2

Responses

createDataSource

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
{
}

deleteDataSource

Authorizations:
REGARDS_OAUTH2
path Parameters
businessId
required
string

Responses

getDataSource

Authorizations:
REGARDS_OAUTH2
path Parameters
businessId
required
string

Responses

updateDataSource

Authorizations:
REGARDS_OAUTH2
path Parameters
businessId
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
{
}

attachment-controller

removeFile

Authorizations:
REGARDS_OAUTH2
path Parameters
checksum
required
string
urn
required
string

Responses

getFile

Authorizations:
REGARDS_OAUTH2
path Parameters
checksum
required
string
urn
required
string
query Parameters
isContentInline
boolean
origin
string

Responses

attachFiles

Authorizations:
REGARDS_OAUTH2
path Parameters
dataType
required
string
Enum: "RAWDATA" "QUICKLOOK_SD" "QUICKLOOK_MD" "QUICKLOOK_HD" "DOCUMENT" "THUMBNAIL" "OTHER" "AIP" "DESCRIPTION"
urn
required
string
Request Body schema: application/json
file
Array of strings <binary> [ items <binary > ]
Array of objects (DataFileReference)

Responses

Request samples

Content type
application/json
{
}

index-controller

recreateIndex

Authorizations:
REGARDS_OAUTH2

Responses

updateCollections

Authorizations:
REGARDS_OAUTH2

Responses

updateDatasets

Authorizations:
REGARDS_OAUTH2

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

model-controller

Get models

Return a model list

Authorizations:
REGARDS_OAUTH2
query Parameters
type
string
Enum: "COLLECTION" "DATA" "DATASET"

Responses

createModel

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
description
string
id
integer <int64>
identifiable
boolean
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
type
required
string
Enum: "COLLECTION" "DATA" "DATASET"
version
string

Responses

Request samples

Content type
application/json
{
}

importModel

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

Responses

deleteModel

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string

Responses

getModel

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string

Responses

updateModel

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string
Request Body schema: application/json
required
description
string
id
integer <int64>
identifiable
boolean
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
type
required
string
Enum: "COLLECTION" "DATA" "DATASET"
version
string

Responses

Request samples

Content type
application/json
{
}

duplicateModel

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string
Request Body schema: application/json
required
description
string
id
integer <int64>
identifiable
boolean
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
type
required
string
Enum: "COLLECTION" "DATA" "DATASET"
version
string

Responses

Request samples

Content type
application/json
{
}

exportModel

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string

Responses

model-attr-assoc-controller

Models and attrs links by type

Endpoint enabling retrieval of all links between models and attribute for a given type of entity

Authorizations:
REGARDS_OAUTH2
query Parameters
type
string
Enum: "COLLECTION" "DATA" "DATASET"

Filter using entity type

Responses

Available plugin conf by attr type

Endpoint enabling retrieval, for every attribute type, compatible plugin configurations and plugin metadata

Authorizations:
REGARDS_OAUTH2

Responses

Get model attr assocs

Return all model attribute associations matching provided criteria.

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string

Filter using model name

Responses

Bind attr to model

Bind an attribute to a model.

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string

Filter using model name

Request Body schema: application/json
required
required
object (AttributeModel)
object (PluginConfiguration)
id
integer <int64>
identifiable
boolean
mode
string
Enum: "GIVEN" "COMPUTED"
object (Model)
pos
integer <int32>

Responses

Request samples

Content type
application/json
{
}

Bind fragment

Bind fragment attributes to a model.

Authorizations:
REGARDS_OAUTH2
path Parameters
modelName
required
string

Model receiving the fragment

Request Body schema: application/json
required
defaultFragment
boolean
description
string
id
integer <int64>
identifiable
boolean
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
version
string [ 0 .. 16 ] characters
virtual
boolean

Responses

Request samples

Content type
application/json
{
}

Unbind fragment

Unbind fragment attributes from a model.

Authorizations:
REGARDS_OAUTH2
path Parameters
fragmentId
required
integer <int64>

Fragment id to unbind

modelName
required
string

Filter using model name

Responses

Unbind attribute

Unbind an attribute from a model.

Authorizations:
REGARDS_OAUTH2
path Parameters
attributeId
required
integer <int64>

Attribute id to unbind

modelName
required
string

Model that loose one attribute

Responses

Get model attr assoc

Return a model attribute association matching criteria.

Authorizations:
REGARDS_OAUTH2
path Parameters
attributeId
required
integer <int64>

Filter using attribute id

modelName
required
string

Filter using model name

Responses

Update model attr assoc

Update a model attribute association matching provided model name and attribute id.

Authorizations:
REGARDS_OAUTH2
path Parameters
attributeId
required
integer <int64>

Filter using attribute id

modelName
required
string

Filter using model name

Request Body schema: application/json
required
required
object (AttributeModel)
object (PluginConfiguration)
id
integer <int64>
identifiable
boolean
mode
string
Enum: "GIVEN" "COMPUTED"
object (Model)
pos
integer <int32>

Responses

Request samples

Content type
application/json
{
}

attribute-model-controller

Get attribute models

Return a list of attribute models

Authorizations:
REGARDS_OAUTH2
query Parameters
fragmentName
string
modelNames
Array of strings unique
noLink
boolean
type
string
Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"

Responses

addAttribute

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
alterable
boolean
arraysize
integer <int32>
booleanAttribute
boolean
description
string
dynamic
boolean
esMapping
string
object (Fragment)

Fragment to add to the model

fullJsonPath
string
fullName
string
group
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
id
integer <int64>
identifiable
boolean
indexed
boolean
internal
boolean
jsonPath
string
jsonPropertyPath
string
label
required
string [ 0 .. 255 ] characters
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
optional
boolean
precision
integer <int32>
Array of objects (AttributeProperty)
object (AbstractRestriction)
restrictionType
string
Enum: "NO_RESTRICTION" "PATTERN" "ENUMERATION" "DATE_ISO8601" "INTEGER_RANGE" "LONG_RANGE" "DOUBLE_RANGE" "URL" "GEOMETRY" "JSON_SCHEMA"
textAttribute
boolean
type
required
string
Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"
unit
string
virtual
boolean

Responses

Request samples

Content type
application/json
{
}

getModelsAttributes

Authorizations:
REGARDS_OAUTH2
path Parameters
modelType
required
string
Enum: "COLLECTION" "DATA" "DATASET"

Responses

getRestrictions

Authorizations:
REGARDS_OAUTH2
query Parameters
type
required
string
Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"

Responses

getPropertyTypes

Authorizations:
REGARDS_OAUTH2

Responses

deleteAttribute

Authorizations:
REGARDS_OAUTH2
path Parameters
attributeId
required
integer <int64>

Responses

getAttribute

Authorizations:
REGARDS_OAUTH2
path Parameters
attributeId
required
integer <int64>

Responses

updateAttribute

Authorizations:
REGARDS_OAUTH2
path Parameters
attributeId
required
integer <int64>
Request Body schema: application/json
required
alterable
boolean
arraysize
integer <int32>
booleanAttribute
boolean
description
string
dynamic
boolean
esMapping
string
object (Fragment)

Fragment to add to the model

fullJsonPath
string
fullName
string
group
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
id
integer <int64>
identifiable
boolean
indexed
boolean
internal
boolean
jsonPath
string
jsonPropertyPath
string
label
required
string [ 0 .. 255 ] characters
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
optional
boolean
precision
integer <int32>
Array of objects (AttributeProperty)
object (AbstractRestriction)
restrictionType
string
Enum: "NO_RESTRICTION" "PATTERN" "ENUMERATION" "DATE_ISO8601" "INTEGER_RANGE" "LONG_RANGE" "DOUBLE_RANGE" "URL" "GEOMETRY" "JSON_SCHEMA"
textAttribute
boolean
type
required
string
Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"
unit
string
virtual
boolean

Responses

Request samples

Content type
application/json
{
}

fragment-controller

Get fragments

Return a list of fragments

Authorizations:
REGARDS_OAUTH2

Responses

addFragment

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
defaultFragment
boolean
description
string
id
integer <int64>
identifiable
boolean
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
version
string [ 0 .. 16 ] characters
virtual
boolean

Responses

Request samples

Content type
application/json
{
}

importFragment

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

Responses

deleteFragment

Authorizations:
REGARDS_OAUTH2
path Parameters
fragmentId
required
integer <int64>

Responses

getFragment

Authorizations:
REGARDS_OAUTH2
path Parameters
fragmentId
required
integer <int64>

Responses

updateFragment

Authorizations:
REGARDS_OAUTH2
path Parameters
fragmentId
required
integer <int64>
Request Body schema: application/json
required
defaultFragment
boolean
description
string
id
integer <int64>
identifiable
boolean
name
required
string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
version
string [ 0 .. 16 ] characters
virtual
boolean

Responses

Request samples

Content type
application/json
{
}

exportFragment

Authorizations:
REGARDS_OAUTH2
path Parameters
fragmentId
required
integer <int64>

Responses

opensearch-controller

retrieveDescriptor

Authorizations:
REGARDS_OAUTH2
query Parameters
url
required
string

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

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

dynamic-tenant-setting-controller

retrieveAll

Authorizations:
REGARDS_OAUTH2
query Parameters
names
Array of strings unique

Responses

reset

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

update

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
defaultValue
object
description
string
name
string
value
object

Responses

Request samples

Content type
application/json
{
}

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses