• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• security-resources-controller
  • getgetAllResources
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown
• storage-location-controller
  • getGet known storage locations
  • postCreate a new storage location
  • getManually run storage location monitoring
  • postForce running of periodic tasks
  • postRetry file requests in error state for a source and session
  • delDelete a storage location
  • getRetrieve a storage location by name
  • putUpdate a storage location configuration
  • delDelete all files in a storage location
  • getRetry file requests in error state
  • delDelete storage requests

API docs by Redocly

MICROSERVICE FILE CATALOG (2.4.0)

Download OpenAPI specification:Download

License: GPL-3.0

File Catalog API

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-file-catalog/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-file-catalog/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-file-catalog/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-file-catalog/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-file-catalog/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-file-catalog/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-file-catalog/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-file-catalog/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-file-catalog/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-file-catalog/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

/api/v1/rs-file-catalog/regards/{tenant}/datasource/status

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

testTenantConnection

Generated server url

/api/v1/rs-file-catalog/regards/{tenant}/datasource/test

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-file-catalog/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-file-catalog/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-file-catalog/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-file-catalog/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-file-catalog/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses

storage-location-controller

Get known storage locations

Generated server url

/api/v1/rs-file-catalog/storages

Return a list of known storage locations

Authorizations:

REGARDS_OAUTH2

Responses

Create a new storage location

Generated server url

/api/v1/rs-file-catalog/storages

Create a new storage location by specifying its name. Returns the created storage location.

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

}

Manually run storage location monitoring

Generated server url

/api/v1/rs-file-catalog/storages/monitoring/run

Run monitoring for storage locations to compute the number of files and space occupation. Optionally reset the monitoring.

Authorizations:

REGARDS_OAUTH2

query Parameters

reset

boolean

Responses

Force running of periodic tasks

Generated server url

/api/v1/rs-file-catalog/storages/periodic-actions/run

Trigger the execution of periodic tasks on all storage locations.

Authorizations:

REGARDS_OAUTH2

Responses

Retry file requests in error state for a source and session

Generated server url

/api/v1/rs-file-catalog/storages/retry

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 a storage location

Generated server url

/api/v1/rs-file-catalog/storages/{id}

Delete a storage location and its configuration by specifying its name.

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses

Retrieve a storage location by name

Generated server url

/api/v1/rs-file-catalog/storages/{id}

Fetch a storage location's details by specifying its name.

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

Responses

Update a storage location configuration

Generated server url

/api/v1/rs-file-catalog/storages/{id}

Update the configuration of a storage location by providing its details.

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

}

Delete all files in a storage location

Generated server url

/api/v1/rs-file-catalog/storages/{id}/files

Delete all files referenced in the specified storage location. Optionally, use force delete to unreference files even if physical deletion fails.

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

string

query Parameters

force

boolean

Responses

Retry file requests in error state

Generated server url

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

Retry all file requests that are in an error state for the specified storage location and request type.

Authorizations:

REGARDS_OAUTH2

path Parameters

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

Responses

Delete storage requests

Generated server url

/api/v1/rs-file-catalog/storages/{id}/requests/{type}

Delete requests of a storage location based on its name, request type, and optionally the request status.

Authorizations:

REGARDS_OAUTH2

path Parameters

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

query Parameters

status

string Enum: "GRANTED" "TO_HANDLE" "HANDLED" "DELAYED" "PENDING_ARCHIVE" "TO_DELETE" "ERROR"

Responses