MICROSERVICE STORAGE (2.2.0)

Download OpenAPI specification:Download

License: GPL-3.0

Files storage management

cache-controller

getOccupation

Authorizations:

REGARDS_OAUTH2

Responses

file-download-controller

checkFileAvailability

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

checksums

Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"checksums": ["string"
]
}

downloadFile

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum

required

string

query Parameters

isContentInline

boolean

Responses

downloadFileWithToken

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum

required

string

query Parameters

isContentInline required	boolean
t required	string

Responses

file-reference-controller

export

Authorizations:

REGARDS_OAUTH2

Responses

store

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

Array

	Array of objects (FileStorageRequestDto) unique
groupId	string

Responses

Request samples

Payload

Content type

application/json

[{"files": [{"algorithm": "string",
"checksum": "string",
"fileName": "string",
"metaInfo": {"algorithm": "string",
"checksum": "string",
"fileName": "string",
"fileSize": 0,
"height": 0,
"mimeType": "string",
"type": "string",
"width": 0
},
"mimeType": "string",
"optionalSubDirectory": "string",
"originUrl": "string",
"owner": "string",
"reference": true,
"session": "string",
"sessionOwner": "string",
"storage": "string",
"subDirectory": "string",
"type": "string"
}
],
"groupId": "string"
}
]

getFileReferencesWithoutOwners

Authorizations:

REGARDS_OAUTH2

path Parameters

storage

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

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

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

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

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

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

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

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

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

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

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

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

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"
}
]
}
]

download-quota-controller

getQuotaLimits_1

Authorizations:

REGARDS_OAUTH2

Responses

getCurrentQuotas

Authorizations:

REGARDS_OAUTH2

Responses

getCurrentQuotas_1

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email

required

string

Responses

getCurrentQuotasList

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

getMaxQuota

Authorizations:

REGARDS_OAUTH2

Responses

getQuotaLimits_2

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email

required

string

Responses

upsertQuotaLimits

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email

required

string

Request Body schema: application/json
required

email	string
maxQuota	integer <int64>
rateLimit	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"maxQuota": 0,
"rateLimit": 0
}

getQuotaLimits

Authorizations:

REGARDS_OAUTH2

query Parameters

user_email

required

Array of strings

Responses

jpa-multitenant-controller

getDataSourceStatus

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

testTenantConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

file-requests-controller

stop

Authorizations:

REGARDS_OAUTH2

Responses

delete_1

Authorizations:

REGARDS_OAUTH2

path Parameters

storage required	string
type required	string Enum: "AVAILABILITY" "COPY" "DELETION" "REFERENCE" "STORAGE"

query Parameters

status

string

Enum: "TO_DO" "PENDING" "DELAYED" "ERROR"

Responses

search

Authorizations:

REGARDS_OAUTH2

path Parameters

storage required	string
type required	string Enum: "AVAILABILITY" "COPY" "DELETION" "REFERENCE" "STORAGE"

query Parameters

required	object (Pageable)
status	string Enum: "TO_DO" "PENDING" "DELAYED" "ERROR"

Responses

security-resources-controller

getAllResources

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"
}
]

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

Payload

Content type

application/json

{"defaultValue": { },
"description": "string",
"name": "string",
"value": { }
}

manager-controller

immediateShutdown

Authorizations:

REGARDS_OAUTH2

Responses

storage-location-controller

Get known storage locations

Return a list of known storage locations

Authorizations:

REGARDS_OAUTH2

Responses

configureLocation

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

allowsPhysicalDeletion	boolean
	object (StorageLocationConfigurationDto)
copyRunning	boolean
deletionRunning	boolean
name	string
nbDeletionError	integer <int64>
nbFilesStored	integer <int64>
nbFilesStoredWithPendingActionRemaining	integer <int64>
nbStorageError	integer <int64>
pendingActionRemaining	boolean
pendingActionRunning	boolean
storageRunning	boolean
totalStoredFilesSizeKo	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"allowsPhysicalDeletion": true,
"configuration": {"allocatedSizeInKo": 0,
"name": "string",
"pluginConfiguration": {"active": true,
"businessId": "string",
"iconUrl": "string",
"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"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"priority": 0,
"storageType": "ONLINE"
},
"copyRunning": true,
"deletionRunning": true,
"name": "string",
"nbDeletionError": 0,
"nbFilesStored": 0,
"nbFilesStoredWithPendingActionRemaining": 0,
"nbStorageError": 0,
"pendingActionRemaining": true,
"pendingActionRunning": true,
"storageRunning": true,
"totalStoredFilesSizeKo": 0
}

copyFiles

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

	object (FileLocationDto)
	object (FileLocationDto)
types	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"from": {"fileArchiveStatus": "STORED",
"pendingActionRemaining": true,
"storage": "string",
"url": "string"
},
"to": {"fileArchiveStatus": "STORED",
"pendingActionRemaining": true,
"storage": "string",
"url": "string"
},
"types": ["string"
]
}

runMonitoring

Authorizations:

REGARDS_OAUTH2

query Parameters

reset

boolean

Responses

runPeriodicTasks

Authorizations:

REGARDS_OAUTH2

Responses

Retry file requests in error state for a source and session

Retry all file requests that are in an error state for the specified source and session.

Authorizations:

REGARDS_OAUTH2

query Parameters

session required	string Session name to retry
source required	string Source name to retry

Responses

delete

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

string

Responses

retrieve_1

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

string

Responses

updateLocationConfiguration

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

string

Request Body schema: application/json
required

allowsPhysicalDeletion	boolean
	object (StorageLocationConfigurationDto)
copyRunning	boolean
deletionRunning	boolean
name	string
nbDeletionError	integer <int64>
nbFilesStored	integer <int64>
nbFilesStoredWithPendingActionRemaining	integer <int64>
nbStorageError	integer <int64>
pendingActionRemaining	boolean
pendingActionRunning	boolean
storageRunning	boolean
totalStoredFilesSizeKo	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"allowsPhysicalDeletion": true,
"configuration": {"allocatedSizeInKo": 0,
"name": "string",
"pluginConfiguration": {"active": true,
"businessId": "string",
"iconUrl": "string",
"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"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"priority": 0,
"storageType": "ONLINE"
},
"copyRunning": true,
"deletionRunning": true,
"name": "string",
"nbDeletionError": 0,
"nbFilesStored": 0,
"nbFilesStoredWithPendingActionRemaining": 0,
"nbStorageError": 0,
"pendingActionRemaining": true,
"pendingActionRunning": true,
"storageRunning": true,
"totalStoredFilesSizeKo": 0
}

decreaseStorageLocationPriority

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

string

Responses

deleteFiles

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

string

query Parameters

force

boolean

Responses

retryErrors

Authorizations:

REGARDS_OAUTH2

path Parameters

id required	string
type required	string Enum: "AVAILABILITY" "COPY" "DELETION" "REFERENCE" "STORAGE"

Responses

deleteRequests

Authorizations:

REGARDS_OAUTH2

path Parameters

id required	string
type required	string Enum: "AVAILABILITY" "COPY" "DELETION" "REFERENCE" "STORAGE"

query Parameters

status

string

Enum: "TO_DO" "PENDING" "DELAYED" "ERROR"

Responses

increaseStorageLocationPriority

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

string

MICROSERVICE STORAGE (2.2.0)

cache-controller

getOccupation

Authorizations:

Responses

file-download-controller

checkFileAvailability

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

downloadFile

Authorizations:

path Parameters

query Parameters

Responses

downloadFileWithToken

Authorizations:

path Parameters

query Parameters

Responses

file-reference-controller

export

Authorizations:

Responses

store

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

getFileReferencesWithoutOwners

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

maintenance-controller

retrieveTenantsInMaintenance

Authorizations:

Responses

unSetMaintenance

Authorizations:

path Parameters

Responses

setMaintenance

Authorizations:

path Parameters

Responses

module-manager-controller

exportConfiguration

Authorizations:

Responses

importConfiguration

Authorizations:

Request Body schema: multipart/form-data

Responses

isConfigurationEnabled

Authorizations:

Responses

isReady

Authorizations:

Responses

isReadyEnabled

Authorizations:

Responses

restart

Authorizations:

Responses

isRestartEnabled

Authorizations:

Responses

plugin-controller

getPlugins

Authorizations:

query Parameters

Responses

Response samples

emptyCache

Authorizations:

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required