• Create controller
  • postRegister a submission request.
  • postRegister a submission request with replacement if exists.
• Search controller
  • postSearch for submission requests with criteria
  • getRetrieve submission request status.
• Deletion controller
  • delAsynchronously delete a selection of submission request.
• Session controller
  • getCalculate global state of a session
  • getCalculate itemized state of a session
• 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

API docs by Redocly

MICROSERVICE LTA MANAGER (1.13.0)

Download OpenAPI specification:Download

License: GPL-3.0

Lta Manager API

Create controller

Register a submission request.

Generated server url

/api/v1/rs-lta-manager/products

Create and save a submission request from a submission request dto.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

Submission request dto to be processed.

correlationId required	string [ 0 .. 255 ] characters Identifier to track this request during the entire workflow. It must be unique.
datatype required	string [ 0 .. 255 ] characters Product datatype. Must be present in the lta-manager configuration.
required	Array of objects (ProductFileDto) >= 1 [ items >= 1 ] Files linked to the product. At least one is required.
	object or null (IGeometry) Product geometry in GeoJSON RFC 7946 Format.
originUrn	string or null [ 0 .. 255 ] characters Id of the product in the original catalog.
owner	string
productId required	string [ 0 .. 255 ] characters Provider id of the OAIS product to generate.
	object or null Map of key/value properties.
replaceMode	boolean Default: false If true, overrides the product if it already exists.
session	string or null [ 0 .. 128 ] characters Session to monitor the generation of the product. If not provided, a default session will be used.
storePath	string or null [ 0 .. 255 ] characters ^[\w\/\-_:]*$ Path to store the product. If null, the storePath will be built from the lta-manager configuration.
tags	Array of strings or null or null List of string tags.

Responses

Request samples

• Payload

Content type

application/json

{

• "correlationId": "string",
• "datatype": "string",
• "files": [

  • {

    • "checksumMd5": "string",
    • "filename": "string",
    • "mimeType": {

      • "charset": "string",
      • "concrete": true,
      • "parameters": {

        • "property1": "string",
        • "property2": "string"

        },
      • "subtype": "string",
      • "subtypeSuffix": "string",
      • "type": "string",
      • "wildcardSubtype": true,
      • "wildcardType": true

      },
    • "type": "ZIP",
    • "url": "string"

    }

  ],
• "geometry": {

  • "crs": "string",
  • "type": "string"

  },
• "productId": "string",
• "originUrn": "string",
• "owner": "string",
• "properties": {

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

  },
• "replaceMode": false,
• "session": "string",
• "storePath": "string",
• "tags": [

  • "string"

  ]

}

Response samples

• 201

Content type

application/json

{

• "content": {

  • "correlationId": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "productId": "string",
  • "responseStatus": "GRANTED",
  • "session": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Register a submission request with replacement if exists.

Generated server url

/api/v1/rs-lta-manager/products/replace

Create and save a submission request from a submission request dto. If the product already exists, it will be overridden

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

Submission request dto to be processed.

correlationId required	string [ 0 .. 255 ] characters Identifier to track this request during the entire workflow. It must be unique.
datatype required	string [ 0 .. 255 ] characters Product datatype. Must be present in the lta-manager configuration.
required	Array of objects (ProductFileDto) >= 1 [ items >= 1 ] Files linked to the product. At least one is required.
	object or null (IGeometry) Product geometry in GeoJSON RFC 7946 Format.
originUrn	string or null [ 0 .. 255 ] characters Id of the product in the original catalog.
owner	string
productId required	string [ 0 .. 255 ] characters Provider id of the OAIS product to generate.
	object or null Map of key/value properties.
replaceMode	boolean Default: false If true, overrides the product if it already exists.
session	string or null [ 0 .. 128 ] characters Session to monitor the generation of the product. If not provided, a default session will be used.
storePath	string or null [ 0 .. 255 ] characters ^[\w\/\-_:]*$ Path to store the product. If null, the storePath will be built from the lta-manager configuration.
tags	Array of strings or null or null List of string tags.

Responses

Request samples

• Payload

Content type

application/json

{

• "correlationId": "string",
• "datatype": "string",
• "files": [

  • {

    • "checksumMd5": "string",
    • "filename": "string",
    • "mimeType": {

      • "charset": "string",
      • "concrete": true,
      • "parameters": {

        • "property1": "string",
        • "property2": "string"

        },
      • "subtype": "string",
      • "subtypeSuffix": "string",
      • "type": "string",
      • "wildcardSubtype": true,
      • "wildcardType": true

      },
    • "type": "ZIP",
    • "url": "string"

    }

  ],
• "geometry": {

  • "crs": "string",
  • "type": "string"

  },
• "productId": "string",
• "originUrn": "string",
• "owner": "string",
• "properties": {

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

  },
• "replaceMode": false,
• "session": "string",
• "storePath": "string",
• "tags": [

  • "string"

  ]

}

Response samples

• 201

Content type

application/json

{

• "content": {

  • "correlationId": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "productId": "string",
  • "responseStatus": "GRANTED",
  • "session": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Search controller

Search for submission requests with criteria

Generated server url

/api/v1/rs-lta-manager/products/search

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

Set of search criterion.

	object or null (DatesRangeRestriction) Submission request last update date.
datatype	string or null Product datatype.
	object or null (ValuesRestrictionLong) Restricted ids (INCLUDED or EXCLUDED).
owner	string or null Request sender.
session	string or null Submission request session
	object or null (DatesRangeRestriction) Submission request last update date.
	object or null (ValuesRestrictionSubmissionRequestState) Included submission request states (only INCLUDED MODE is accepted).

Responses

Request samples

• Payload

Content type

application/json

{

• "creationDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "datatype": "string",
• "idsRestriction": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "owner": "string",
• "session": "string",
• "statusDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "statusesRestriction": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "VALIDATED"

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

      • "correlationId": "string",
      • "creationDate": "2019-08-24T14:15:22Z",
      • "message": "string",
      • "model": "string",
      • "owner": "string",
      • "product": {

        • "correlationId": "string",
        • "datatype": "string",
        • "files": [

          • {

            • "checksumMd5": "string",
            • "filename": "string",
            • "mimeType": {

              • "charset": "string",
              • "concrete": true,
              • "parameters": {

                • "property1": "string",
                • "property2": "string"

                },
              • "subtype": "string",
              • "subtypeSuffix": "string",
              • "type": "string",
              • "wildcardSubtype": true,
              • "wildcardType": true

              },
            • "type": "ZIP",
            • "url": "string"

            }

          ],
        • "geometry": {

          • "type": "string"

          },
        • "productId": "string",
        • "originUrn": "string",
        • "owner": "string",
        • "properties": {

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

          },
        • "replaceMode": false,
        • "session": "string",
        • "storePath": "string",
        • "tags": [

          • "string"

          ]

        },
      • "session": "string",
      • "status": "VALIDATED",
      • "statusDate": "2019-08-24T14:15:22Z",
      • "storePath": {

        • "absolute": true,
        • "fileName": {

          • "absolute": true,
          • "fileSystem": {

            • "fileStores": { },
            • "open": true,
            • "readOnly": true,
            • "rootDirectories": { },
            • "separator": "string",
            • "userPrincipalLookupService": { }

            },
          • "nameCount": 0

          },
        • "fileSystem": {

          • "fileStores": { },
          • "open": true,
          • "readOnly": true,
          • "rootDirectories": { },
          • "separator": "string",
          • "userPrincipalLookupService": { }

          },
        • "nameCount": 0,
        • "parent": {

          • "absolute": true,
          • "fileSystem": {

            • "fileStores": { },
            • "open": true,
            • "readOnly": true,
            • "rootDirectories": { },
            • "separator": "string",
            • "userPrincipalLookupService": { }

            },
          • "nameCount": 0

          },
        • "root": {

          • "absolute": true,
          • "fileSystem": {

            • "fileStores": { },
            • "open": true,
            • "readOnly": true,
            • "rootDirectories": { },
            • "separator": "string",
            • "userPrincipalLookupService": { }

            },
          • "nameCount": 0

          }

        }

      },
    • "links": [

      • {

        • "deprecation": "string",
        • "href": "string",
        • "hreflang": "string",
        • "media": "string",
        • "name": "string",
        • "profile": "string",
        • "rel": "string",
        • "title": "string",
        • "type": "string"

        }

      ]

    }

  ],
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

Retrieve submission request status.

Generated server url

/api/v1/rs-lta-manager/products/`{correlationId}`/info

Authorizations:

REGARDS_OAUTH2

path Parameters

correlationId required

string Identifier of the submission request.

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "correlationId": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "productId": "string",
  • "responseStatus": "GRANTED",
  • "session": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

Deletion controller

Asynchronously delete a selection of submission request.

Generated server url

/api/v1/rs-lta-manager/products

Find and delete submission requests from criterias defined in request body.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

Set of search criterion.

	object or null (DatesRangeRestriction) Submission request last update date.
datatype	string or null Product datatype.
	object or null (ValuesRestrictionLong) Restricted ids (INCLUDED or EXCLUDED).
owner	string or null Request sender.
session	string or null Submission request session
	object or null (DatesRangeRestriction) Submission request last update date.
	object or null (ValuesRestrictionSubmissionRequestState) Included submission request states (only INCLUDED MODE is accepted).

Responses

Request samples

• Payload

Content type

application/json

{

• "creationDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "datatype": "string",
• "idsRestriction": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "owner": "string",
• "session": "string",
• "statusDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "statusesRestriction": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "VALIDATED"

    ]

  }

}

Session controller

Calculate global state of a session

Generated server url

/api/v1/rs-lta-manager/sessions/{session}/info

Authorizations:

REGARDS_OAUTH2

path Parameters

session required

string

Responses

Response samples

• 200
• 404

Content type

application/json

{

• "status": "RUNNING"

}

Calculate itemized state of a session

Generated server url

/api/v1/rs-lta-manager/sessions/{session}/info/details

Authorizations:

REGARDS_OAUTH2

path Parameters

session required

string

query Parameters

required

object (Pageable)

Responses

Response samples

• 200
• 404

Content type

application/json

{

• "content": [

  • { }

  ],
• "globalStatus": "RUNNING",
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-lta-manager/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-lta-manager/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-lta-manager/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-lta-manager/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-lta-manager/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-lta-manager/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-lta-manager/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-lta-manager/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-lta-manager/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-lta-manager/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

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

  }

}

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-lta-manager/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-lta-manager/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-lta-manager/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-lta-manager/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-lta-manager/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses