Skip to main content
Version: 1.15
API docs by Redocly

MICROSERVICE INGEST (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

Ingest API

aip-controller

Get AIPs

Return a page of AIPs matching criterias.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criterias.

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionEntityType)

Filter on types of entity

object (ValuesRestrictionAIPState)

Filter on state of aip

object (ValuesRestrictionString)

Filter on identifier of aip

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionDisseminationStatus)

Filter on status of the dissemination

last
boolean

Filter on last

object (DatesRangeRestriction)

Filter on range of date for creation date

originUrn
string
object (ValuesRestrictionString)

Filter on identifier of aip

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionString)

Filter on identifier of aip

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

retrieveAIPCategories

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionEntityType)

Filter on types of entity

object (ValuesRestrictionAIPState)

Filter on state of aip

object (ValuesRestrictionString)

Filter on identifier of aip

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionDisseminationStatus)

Filter on status of the dissemination

last
boolean

Filter on last

object (DatesRangeRestriction)

Filter on range of date for creation date

originUrn
string
object (ValuesRestrictionString)

Filter on identifier of aip

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionString)

Filter on identifier of aip

Responses

Request samples

Content type
application/json
{
}

delete_1

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionEntityType)

Filter on types of entity

object (ValuesRestrictionAIPState)

Filter on state of aip

object (ValuesRestrictionString)

Filter on identifier of aip

object (DatesRangeRestriction)

Filter on range of date for creation date

deletionMode
required
string
Enum: "BY_STATE" "IRREVOCABLY"
object (ValuesRestrictionDisseminationStatus)

Filter on status of the dissemination

last
boolean

Filter on last

object (DatesRangeRestriction)

Filter on range of date for creation date

originUrn
string
object (ValuesRestrictionString)

Filter on identifier of aip

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionString)

Filter on identifier of aip

Responses

Request samples

Content type
application/json
{
}

Create dissemination creator job

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criterias.

object (SearchAIPsParameters)
recipients
Array of strings unique

Responses

Request samples

Content type
application/json
{
}

retrieveAIPStorage

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionEntityType)

Filter on types of entity

object (ValuesRestrictionAIPState)

Filter on state of aip

object (ValuesRestrictionString)

Filter on identifier of aip

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionDisseminationStatus)

Filter on status of the dissemination

last
boolean

Filter on last

object (DatesRangeRestriction)

Filter on range of date for creation date

originUrn
string
object (ValuesRestrictionString)

Filter on identifier of aip

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionString)

Filter on identifier of aip

Responses

Request samples

Content type
application/json
{
}

retrieveAIPTags

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionEntityType)

Filter on types of entity

object (ValuesRestrictionAIPState)

Filter on state of aip

object (ValuesRestrictionString)

Filter on identifier of aip

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionDisseminationStatus)

Filter on status of the dissemination

last
boolean

Filter on last

object (DatesRangeRestriction)

Filter on range of date for creation date

originUrn
string
object (ValuesRestrictionString)

Filter on identifier of aip

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionString)

Filter on identifier of aip

Responses

Request samples

Content type
application/json
{
}

updateAips

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
addCategories
Array of strings
addTags
Array of strings
object (SearchAIPsParameters)
removeCategories
Array of strings
removeStorages
Array of strings
removeTags
Array of strings
Array of objects (DisseminationInfo)

Responses

Request samples

Content type
application/json
{
}

downloadAIP

Authorizations:
REGARDS_OAUTH2
path Parameters
aip_id
required
string
query Parameters
origin
string

Responses

dump-controller

resetLastDumpDate

Authorizations:
REGARDS_OAUTH2

Responses

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

plugin-controller

getPlugins

Authorizations:
REGARDS_OAUTH2
query Parameters
pluginType
string

Responses

Response samples

Content type
application/json
[
]

emptyCache

Authorizations:
REGARDS_OAUTH2

Responses

Get plugin configurations

Return a list of plugin configurations for a specific type

Authorizations:
REGARDS_OAUTH2
query Parameters
pluginType
string

Responses

Response samples

Content type
application/json
[
]

getPluginConfigurationDirectAccess

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginMetaDataById

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginConfigurations

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
[
]

savePluginConfiguration

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

deletePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string

Responses

getPluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

updatePluginConfiguration

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

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

getPluginTypes

Authorizations:
REGARDS_OAUTH2
query Parameters
available
boolean

Responses

Response samples

Content type
application/json
[
]

ingest-processing-chain-controller

Get ingest processing chains

Return a page of ingest processing chains

Authorizations:
REGARDS_OAUTH2
query Parameters
name
string
required
object (Pageable)
required
object (PagedResourcesAssemblerIngestProcessingChain)

Responses

create

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
object (PluginConfiguration)
Array of objects (PluginConfiguration)
description
string
required
object (PluginConfiguration)
id
integer <int64>
name
required
string [ 3 .. 50 ] characters [0-9a-zA-Z_]*
object (PluginConfiguration)
object (PluginConfiguration)
object (PluginConfiguration)
required
object (PluginConfiguration)

Responses

Request samples

Content type
application/json
{
}

createByFile

Authorizations:
REGARDS_OAUTH2
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

delete_2

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

get

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

update_1

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
object (PluginConfiguration)
Array of objects (PluginConfiguration)
description
string
required
object (PluginConfiguration)
id
integer <int64>
name
required
string [ 3 .. 50 ] characters [0-9a-zA-Z_]*
object (PluginConfiguration)
object (PluginConfiguration)
object (PluginConfiguration)
required
object (PluginConfiguration)

Responses

Request samples

Content type
application/json
{
}

export

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

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

request-controller

Get requests

Return a page of requests matching criteria

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criteria.

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionIngestErrorType)

List of request error type keys

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionLong)

Filter on request id

object (ValuesRestrictionInternalRequestState)

List of internal request states

object (ValuesRestrictionRequestTypeEnum)

List of request type

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

Responses

Request samples

Content type
application/json
{
}

Abort all running requests

Abort all running requests

Authorizations:
REGARDS_OAUTH2

Responses

Delete selected requests

Delete all requests matching given search criteria

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criteria to find requests to delete

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionIngestErrorType)

List of request error type keys

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionLong)

Filter on request id

object (ValuesRestrictionInternalRequestState)

List of internal request states

object (ValuesRestrictionRequestTypeEnum)

List of request type

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

Responses

Request samples

Content type
application/json
{
}

Retry selected requests

Retry all requests matching given search criteria

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criteria to find requests to retry

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionIngestErrorType)

List of request error type keys

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionLong)

Filter on request id

object (ValuesRestrictionInternalRequestState)

List of internal request states

object (ValuesRestrictionRequestTypeEnum)

List of request type

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

Responses

Request samples

Content type
application/json
{
}

Choose versioning mode

Apply given versioning mode to all requests matching given search criteria

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criteria to find requests to update with new versioning mode

object (DatesRangeRestriction)

Filter on range of date for creation date

object (ValuesRestrictionIngestErrorType)

List of request error type keys

object (DatesRangeRestriction)

Filter on range of date for creation date

newVersioningMode
string
Enum: "IGNORE" "INC_VERSION" "MANUAL" "REPLACE"
object (ValuesRestrictionString)

Filter on identifier of aip

object (ValuesRestrictionLong)

Filter on request id

object (ValuesRestrictionInternalRequestState)

List of internal request states

object (ValuesRestrictionRequestTypeEnum)

List of request type

session
string

Filter on session that emitted the request

sessionOwner
string

Filter on owner of session that emitted the request

Responses

Request samples

Content type
application/json
{
}

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

sip-controller

ingest

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/geo+json
required
bbox
Array of numbers <double> [ items <double > ]
crs
string
Array of objects (SIPDto)
required
object (IngestMetadataDto)
type
required
string

Responses

Request samples

Content type
application/geo+json
{
}

ingestFile

Authorizations:
REGARDS_OAUTH2
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

launchSipDeletionJob

Authorizations:
REGARDS_OAUTH2

Responses

Search for SIP entities

Search for SIP entities with search parameters.

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (PagedResourcesAssemblerSIPEntity)
Request Body schema: application/json
required

Search criterion.

categories
Array of strings unique

Filter on categories

from
string <date-time>

Filter on range of date for last update

ipType
string
Enum: "COLLECTION" "DATA" "DATASET"

Filter on type of SIP

processing
string

Filter on processing chain

providerIds
Array of strings unique

Filter on provider ids

session
required
string

Filter on session that emitted the request

sessionOwner
required
string

Filter on owner of session that emitted the request

states
Array of strings
Items Enum: "INGESTED" "STORED" "DELETED"

Filter on given states of SIP

tags
Array of strings

Filter on tags

Responses

Request samples

Content type
application/json
{
}

getSipEntity

Authorizations:
REGARDS_OAUTH2
path Parameters
sipId
required
string

Responses