MICROSERVICE LTA MANAGER (2.0.0)

Download OpenAPI specification:Download

License: GPL-3.0

Lta Manager API

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

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

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

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.
originUrn	string or null [ 0 .. 255 ] characters Id of the product in the original catalog.
productId required	string [ 0 .. 255 ] characters Provider id of the OAIS product to generate.
	object or null Map of key/value properties.
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 manually define the destination location for files on archival system. 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": "lta-product-100-000001",
"datatype": "configured-datatype",
"files": [{"checksumMd5": "d326ed75d1e9c1109a9dbabf114f6b61",
"filename": "thumbnail.png",
"mimeType": "image/png",
"type": "THUMBNAIL",
"url": "file:/input/file-lta-100.png"
}
],
"geometry": {"coordinates": [[[51.57951867046327,
24.245497137951105
],
[51.757440626844186,
24.29407298430547
],
[51.79438927593287,
24.019826158132506
],
[52.57708051942561,
24.177439276622707
],
[53.404006788960146,
24.15131684009917
]
]
],
"type": "Polygon"
},
"originUrn": "origin-lta-product-id",
"productId": "lta-product-100",
"properties": {"creation_date": "2023-05-01T00:00:00Z",
"geolocalized": "invalidValueType",
"name": "lta-product-100"
},
"session": "lta-session-name",
"storePath": "/2024/1/15/lta-product-100",
"tags": ["lta",
"amqp"
]
}

Response samples

201

Content type

application/json

{"content": {"correlationId": "lta-product-100-000001",
"expires": "2025-05-01T00:00:00Z",
"message": "An error occurred while ...",
"productId": "lta-product-100",
"responseStatus": "GRANTED",
"session": "LTA-session"
},
"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.

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.
productId required	string [ 0 .. 255 ] characters Provider id of the OAIS product to generate.
	object or null Map of key/value properties.
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 manually define the destination location for files on archival system. 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": "lta-product-100-000001",
"datatype": "configured-datatype",
"files": [{"checksumMd5": "d326ed75d1e9c1109a9dbabf114f6b61",
"filename": "thumbnail.png",
"mimeType": "image/png",
"type": "THUMBNAIL",
"url": "file:/input/file-lta-100.png"
}
],
"geometry": {"coordinates": [[[51.57951867046327,
24.245497137951105
],
[51.757440626844186,
24.29407298430547
],
[51.79438927593287,
24.019826158132506
],
[52.57708051942561,
24.177439276622707
],
[53.404006788960146,
24.15131684009917
]
]
],
"type": "Polygon"
},
"originUrn": "origin-lta-product-id",
"productId": "lta-product-100",
"properties": {"creation_date": "2023-05-01T00:00:00Z",
"geolocalized": "invalidValueType",
"name": "lta-product-100"
},
"session": "lta-session-name",
"storePath": "/2024/1/15/lta-product-100",
"tags": ["lta",
"amqp"
]
}

Response samples

201

Content type

application/json

{"content": {"correlationId": "lta-product-100-000001",
"expires": "2025-05-01T00:00:00Z",
"message": "An error occurred while ...",
"productId": "lta-product-100",
"responseStatus": "GRANTED",
"session": "LTA-session"
},
"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

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

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",
"id": 0,
"message": "string",
"model": "string",
"owner": "string",
"product": {"correlationId": "lta-product-100-000001",
"datatype": "configured-datatype",
"files": [{"checksumMd5": "d326ed75d1e9c1109a9dbabf114f6b61",
"filename": "thumbnail.png",
"mimeType": "image/png",
"type": "THUMBNAIL",
"url": "file:/input/file-lta-100.png"
}
],
"geometry": {"coordinates": [[[51.57951867046327,
24.245497137951105
],
[51.757440626844186,
24.29407298430547
],
[51.79438927593287,
24.019826158132506
],
[52.57708051942561,
24.177439276622707
],
[53.404006788960146,
24.15131684009917
]
]
],
"type": "Polygon"
},
"originUrn": "origin-lta-product-id",
"productId": "lta-product-100",
"properties": {"creation_date": "2023-05-01T00:00:00Z",
"geolocalized": "invalidValueType",
"name": "lta-product-100"
},
"session": "lta-session-name",
"storePath": "/2024/1/15/lta-product-100",
"tags": ["lta",
"amqp"
]
},
"session": "string",
"status": "VALIDATED",
"statusDate": "2019-08-24T14:15:22Z",
"storePath": "string"
},
"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.

Authorizations:

REGARDS_OAUTH2

path Parameters

correlationId

required

string

Identifier of the submission request.

Responses

Response samples

200

Content type

application/json

{"content": {"correlationId": "lta-product-100-000001",
"expires": "2025-05-01T00:00:00Z",
"message": "An error occurred while ...",
"productId": "lta-product-100",
"responseStatus": "GRANTED",
"session": "LTA-session"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

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

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

Session controller

Calculate global state of a session

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

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

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

MICROSERVICE LTA MANAGER (2.0.0)

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

Deletion controller

Asynchronously delete a selection of submission request.

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Create controller

Register a submission request.

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Register a submission request with replacement if exists.

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Search controller

Search for submission requests with criteria

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve submission request status.

Authorizations:

path Parameters

Responses

Response samples

jpa-multitenant-controller

getDataSourceStatus

Authorizations:

path Parameters

Responses

Response samples

testTenantConnection

Authorizations:

path Parameters

Responses

Response samples

security-resources-controller

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