• cache-controller
  • getgetOccupation
• file-reference-controller
  • getexport
  • poststore
  • getdownloadFile_1
  • getdownloadFileWithToken_1
  • postgetFileReferencesWithoutOwners
• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• plugin-controller
  • getgetPlugins
  • delemptyCache
  • getGet plugin configurations
  • getgetPluginConfigurationDirectAccess
  • getgetPluginMetaDataById
  • getgetPluginConfigurations
  • postsavePluginConfiguration
  • deldeletePluginConfiguration
  • getgetPluginConfiguration
  • putupdatePluginConfiguration
  • getgetPluginTypes
• download-quota-controller
  • getgetQuotaLimits_1
  • getgetCurrentQuotas
  • getgetCurrentQuotas_1
  • postgetCurrentQuotasList
  • getgetMaxQuota
  • getgetQuotaLimits_2
  • putupsertQuotaLimits
  • getgetQuotaLimits
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• file-requests-controller
  • getstop
  • deldelete_1
  • getsearch
• file-download-controller
  • postcheckFileAvailability
  • getdownloadFile
  • getdownloadFileWithToken
• s-3-glacier-mock-controller
  • getrestore
  • getsetExpired
  • gettoT3
• security-resources-controller
  • getgetAllResources
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown
• storage-location-controller
  • getGet known storage locations
  • postconfigureLocation
  • postcopyFiles
  • getrunMonitoring
  • postrunPeriodicTasks
  • getretryErrorsBySourceAndSession
  • deldelete
  • getretrieve_1
  • putupdateLocationConfiguration
  • putdecreaseStorageLocationPriority
  • deldeleteFiles
  • getretryErrors
  • deldeleteRequests
  • putincreaseStorageLocationPriority

API docs by Redocly

MICROSERVICE STORAGE (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Files storage management

cache-controller

getOccupation

Generated server url

/api/v1/rs-storage/cache

Authorizations:

REGARDS_OAUTH2

Responses

file-reference-controller

export

Generated server url

/api/v1/rs-storage/files/csv

Authorizations:

REGARDS_OAUTH2

Responses

store

Generated server url

/api/v1/rs-storage/files/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",
      • "session": "string",
      • "sessionOwner": "string",
      • "storage": "string",
      • "subDirectory": "string",
      • "type": "string"

      }

    ],
  • "groupId": "string"

  }

]

downloadFile_1

Generated server url

/api/v1/rs-storage/files/{checksum}/download

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum required

string

query Parameters

isContentInline

boolean

Responses

downloadFileWithToken_1

Generated server url

/api/v1/rs-storage/files/{checksum}/download/token

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum required

string

query Parameters

isContentInline required	boolean
t required	string

Responses

getFileReferencesWithoutOwners

Generated server url

/api/v1/rs-storage/files/{storage}/locations

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

Generated server url

/api/v1/rs-storage/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-storage/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-storage/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-storage/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-storage/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

plugin-controller

getPlugins

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

Get plugin configurations

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId required	string
pluginId required	string

Responses

getPluginConfiguration

Generated server url

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

      }

    ]

  }

]

download-quota-controller

getQuotaLimits_1

Generated server url

/api/v1/rs-storage/quota

Authorizations:

REGARDS_OAUTH2

Responses

getCurrentQuotas

Generated server url

/api/v1/rs-storage/quota/current

Authorizations:

REGARDS_OAUTH2

Responses

getCurrentQuotas_1

Generated server url

/api/v1/rs-storage/quota/current/{user_email}

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email required

string

Responses

getCurrentQuotasList

Generated server url

/api/v1/rs-storage/quota/currents

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

Array

string

Responses

Request samples

• Payload

Content type

application/json

[

• "string"

]

getMaxQuota

Generated server url

/api/v1/rs-storage/quota/max

Authorizations:

REGARDS_OAUTH2

Responses

getQuotaLimits_2

Generated server url

/api/v1/rs-storage/quota/{user_email}

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email required

string

Responses

upsertQuotaLimits

Generated server url

/api/v1/rs-storage/quota/{user_email}

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

Generated server url

/api/v1/rs-storage/quotas

Authorizations:

REGARDS_OAUTH2

query Parameters

user_email required

Array of strings

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

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

  }

}

file-requests-controller

stop

Generated server url

/api/v1/rs-storage/requests/stop

Authorizations:

REGARDS_OAUTH2

Responses

delete_1

Generated server url

/api/v1/rs-storage/requests/{storage}/{type}

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

Generated server url

/api/v1/rs-storage/requests/{storage}/{type}

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

file-download-controller

checkFileAvailability

Generated server url

/api/v1/rs-storage/resources/availability/status

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

Generated server url

/api/v1/rs-storage/resources/{checksum}/download

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum required

string

query Parameters

isContentInline

boolean

Responses

downloadFileWithToken

Generated server url

/api/v1/rs-storage/resources/{checksum}/download/token

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum required

string

query Parameters

isContentInline required	boolean
t required	string

Responses

s-3-glacier-mock-controller

restore

Generated server url

/api/v1/rs-storage/s3-plugin-mock/file/{namePattern}/restore

Authorizations:

REGARDS_OAUTH2

path Parameters

namePattern required

string

Responses

setExpired

Generated server url

/api/v1/rs-storage/s3-plugin-mock/file/{namePattern}/setExpired

Authorizations:

REGARDS_OAUTH2

path Parameters

namePattern required

string

Responses

toT3

Generated server url

/api/v1/rs-storage/s3-plugin-mock/file/{namePattern}/toT3

Authorizations:

REGARDS_OAUTH2

path Parameters

namePattern required

string

Responses

security-resources-controller

getAllResources

Generated server url

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

  }

]

dynamic-tenant-setting-controller

retrieveAll

Generated server url

/api/v1/rs-storage/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-storage/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-storage/settings/{name}

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

Generated server url

/api/v1/rs-storage/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses

storage-location-controller

Get known storage locations

Generated server url

/api/v1/rs-storage/storages

Return a list of known storage locations

Authorizations:

REGARDS_OAUTH2

Responses

configureLocation

Generated server url

/api/v1/rs-storage/storages

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

Generated server url

/api/v1/rs-storage/storages/files/copy

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": {

  • "pendingActionRemaining": true,
  • "storage": "string",
  • "url": "string"

  },
• "to": {

  • "pendingActionRemaining": true,
  • "storage": "string",
  • "url": "string"

  },
• "types": [

  • "string"

  ]

}

runMonitoring

Generated server url

/api/v1/rs-storage/storages/monitoring/run

Authorizations:

REGARDS_OAUTH2

query Parameters

reset

boolean

Responses

runPeriodicTasks

Generated server url

/api/v1/rs-storage/storages/periodic-actions/run

Authorizations:

REGARDS_OAUTH2

Responses

retryErrorsBySourceAndSession

Generated server url

/api/v1/rs-storage/storages/retry/{source}/{session}

Authorizations:

REGARDS_OAUTH2

path Parameters

session required	string
source required	string

Responses

delete

Generated server url

/api/v1/rs-storage/storages/{id}

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses

retrieve_1

Generated server url

/api/v1/rs-storage/storages/{id}

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses

updateLocationConfiguration

Generated server url

/api/v1/rs-storage/storages/{id}

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

Generated server url

/api/v1/rs-storage/storages/{id}/down

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses

deleteFiles

Generated server url

/api/v1/rs-storage/storages/{id}/files

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

query Parameters

force

boolean

Responses

retryErrors

Generated server url

/api/v1/rs-storage/storages/{id}/files/retry/{type}

Authorizations:

REGARDS_OAUTH2

path Parameters

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

Responses

deleteRequests

Generated server url

/api/v1/rs-storage/storages/{id}/requests/{type}

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

Generated server url

/api/v1/rs-storage/storages/{id}/up

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses