Skip to main content
Version: 1.15
API docs by Redocly

MICROSERVICE LTA MANAGER (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Lta Manager API

Create controller

Register a submission request.

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.

originRequestAppId
string

Origin request app_id in amqp message (header property of amqp message)

originRequestPriority
integer <int32>

Origin request priority in amqp message (header property of amqp message

originUrn
string or null [ 0 .. 255 ] characters

Id of the product in the original catalog.

owner
string

Owner of submission request

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Register a submission request with replacement if exists.

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.

originRequestAppId
string

Origin request app_id in amqp message (header property of amqp message)

originRequestPriority
integer <int32>

Origin request priority in amqp message (header property of amqp message

originUrn
string or null [ 0 .. 255 ] characters

Id of the product in the original catalog.

owner
string

Owner of submission request

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Search controller

Search for submission requests with criteria

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Sorting and page configuration

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retrieve submission request status.

Authorizations:
REGARDS_OAUTH2
path Parameters
correlationId
required
string

Identifier of the submission request.

Responses

Response samples

Content type
application/json
{
}

Deletion controller

Asynchronously delete a selection of submission request.

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

Content type
application/json
{
}

Session controller

Calculate global state of a session

Authorizations:
REGARDS_OAUTH2
path Parameters
session
required
string

Responses

Response samples

Content type
application/json
{
}

Calculate itemized state of a session

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

Responses

Response samples

Content type
application/json
{
}

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

jpa-multitenant-controller

getDataSourceStatus

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

testTenantConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

dynamic-tenant-setting-controller

retrieveAll

Authorizations:
REGARDS_OAUTH2
query Parameters
names
Array of strings unique

Responses

reset

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

update

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

Responses

Request samples

Content type
application/json
{
}

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses