Version: 1.13.0

MICROSERVICE INGEST (1.13.0)

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
last	boolean Filter on last
	object (DatesRangeRestriction) Filter on range of date for last update
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

Payload

Content type

application/json

{"aipIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"aipIpTypes": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["COLLECTION"
]
},
"aipStates": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["GENERATED"
]
},
"categories": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"last": true,
"lastUpdate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"originUrn": "string",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"session": "Today_Mission1",
"sessionOwner": "string",
"storages": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"tags": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
}
}

Response samples

Content type

application/json

{"content": [{"content": {"aip": {"bbox": [0.1
],
"crs": "string",
"geometry": {"type": "string"
},
"history": [{"comment": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"ipType": "COLLECTION",
"lastEvent": {"comment": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string"
},
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"sipId": "string",
"sipIdUrn": "string",
"submissionEvent": {"comment": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string"
},
"tags": ["string"
],
"type": "string",
"version": 0
},
"aipId": "string",
"aipIdUrn": "string",
"categories": ["string"
],
"creationDate": "2019-08-24T14:15:22Z",
"id": 0,
"ipType": "COLLECTION",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"originUrn": "string",
"providerId": "string",
"session": "string",
"sessionOwner": "string",
"state": "GENERATED",
"storages": ["string"
],
"tags": ["string"
],
"version": 1
},
"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
}
}

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
last	boolean Filter on last
	object (DatesRangeRestriction) Filter on range of date for last update
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

Payload

Content type

application/json

{"aipIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"aipIpTypes": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["COLLECTION"
]
},
"aipStates": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["GENERATED"
]
},
"categories": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"last": true,
"lastUpdate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"originUrn": "string",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"session": "Today_Mission1",
"sessionOwner": "string",
"storages": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"tags": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
}
}

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
deletionMode required	string Enum: "BY_STATE" "IRREVOCABLY"
last	boolean Filter on last
	object (DatesRangeRestriction) Filter on range of date for last update
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

Payload

Content type

application/json

{"aipIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"aipIpTypes": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["COLLECTION"
]
},
"aipStates": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["GENERATED"
]
},
"categories": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"deletionMode": "BY_STATE",
"last": true,
"lastUpdate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"originUrn": "string",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"session": "Today_Mission1",
"sessionOwner": "string",
"storages": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"tags": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
}
}

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
last	boolean Filter on last
	object (DatesRangeRestriction) Filter on range of date for last update
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

Payload

Content type

application/json

{"aipIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"aipIpTypes": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["COLLECTION"
]
},
"aipStates": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["GENERATED"
]
},
"categories": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"last": true,
"lastUpdate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"originUrn": "string",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"session": "Today_Mission1",
"sessionOwner": "string",
"storages": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"tags": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
}
}

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
last	boolean Filter on last
	object (DatesRangeRestriction) Filter on range of date for last update
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

Payload

Content type

application/json

{"aipIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"aipIpTypes": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["COLLECTION"
]
},
"aipStates": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["GENERATED"
]
},
"categories": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"last": true,
"lastUpdate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"originUrn": "string",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"session": "Today_Mission1",
"sessionOwner": "string",
"storages": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"tags": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
}
}

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

Responses

Request samples

Payload

Content type

application/json

{"addCategories": ["string"
],
"addTags": ["string"
],
"criteria": {"aipIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"aipIpTypes": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["COLLECTION"
]
},
"aipStates": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["GENERATED"
]
},
"categories": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"last": true,
"lastUpdate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"originUrn": "string",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"session": "Today_Mission1",
"sessionOwner": "string",
"storages": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"tags": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
}
},
"removeCategories": ["string"
],
"removeStorages": ["string"
],
"removeTags": ["string"
]
}

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

[{"content": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

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

[{"content": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

getPluginConfigurationDirectAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

configBusinessId

required

string

Responses

Response samples

Content type

application/json

{"content": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

getPluginMetaDataById

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginId

required

string

Responses

Response samples

Content type

application/json

{"content": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

getPluginConfigurations

Authorizations:

REGARDS_OAUTH2

path Parameters

pluginId

required

string

Responses

Response samples

Content type

application/json

[{"content": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

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

Payload

Content type

application/json

{"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}

Response samples

Content type

application/json

{"content": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

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

{"content": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

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

Payload

Content type

application/json

{"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}

Response samples

Content type

application/json

{"content": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"label": "string",
"metaData": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"metaDataAndPluginId": {"author": "string",
"contact": "string",
"description": "string",
"interfaceNames": ["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,
"type": "STRING",
"unconfigurable": true,
"userMarkdown": "string"
}
],
"pluginClassName": "string",
"pluginId": "string",
"url": "string",
"userMarkdown": "string",
"version": "string"
},
"parameters": [{"dynamic": true,
"name": "string",
"type": "STRING",
"value": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

getPluginTypes

Authorizations:

REGARDS_OAUTH2

query Parameters

available

boolean

Responses

Response samples

Content type

application/json

[{"content": "string",
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

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

Payload

Content type

application/json

{"aipStorageMetadataPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"chainPlugins": [{"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}
],
"description": "string",
"generationPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"id": 0,
"name": "",
"postProcessingPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"preProcessingPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"tagPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"validationPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}
}

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

Payload

Content type

application/json

{"aipStorageMetadataPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"chainPlugins": [{"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}
],
"description": "string",
"generationPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"id": 0,
"name": "",
"postProcessingPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"preProcessingPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"tagPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
},
"validationPlugin": {"active": true,
"businessId": "",
"iconUrl": "string",
"id": 0,
"identifiable": true,
"interfaceNames": ["string"
],
"isActive": true,
"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"
},
"metaDataAndPluginId": {"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": { }
}
],
"pluginClassName": "string",
"pluginId": "string",
"priorityOrder": 0,
"version": "string"
}
}

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

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

testTenantConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

Content type

application/json;charset=UTF-8

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

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 last update
	object (ValuesRestrictionIngestErrorType) List of request error type keys
	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

Payload

Content type

application/json

{"creationDate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"errorTypes": "INITIAL|INITIAL_SIP_ALREADY_EXISTS|GENERATION|UPDATE|DELETE",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"requestIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": [0
]
},
"requestStates": "TO_SCHEDULE|CREATED|WAITING_VERSIONING_MODE|BLOCKED|RUNNING|ERROR|ABORTED|IGNORED",
"requestTypes": "INGEST|UPDATE|AIP_UPDATES_CREATOR|AIP_SAVE_METADATA|AIP_POST_PROCESS|OAIS_DELETION|ABORTED|OAIS_DELETION_CREATOR",
"session": "Today_Mission1",
"sessionOwner": "string"
}

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 last update
	object (ValuesRestrictionIngestErrorType) List of request error type keys
	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

Payload

Content type

application/json

{"creationDate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"errorTypes": "INITIAL|INITIAL_SIP_ALREADY_EXISTS|GENERATION|UPDATE|DELETE",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"requestIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": [0
]
},
"requestStates": "TO_SCHEDULE|CREATED|WAITING_VERSIONING_MODE|BLOCKED|RUNNING|ERROR|ABORTED|IGNORED",
"requestTypes": "INGEST|UPDATE|AIP_UPDATES_CREATOR|AIP_SAVE_METADATA|AIP_POST_PROCESS|OAIS_DELETION|ABORTED|OAIS_DELETION_CREATOR",
"session": "Today_Mission1",
"sessionOwner": "string"
}

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 last update
	object (ValuesRestrictionIngestErrorType) List of request error type keys
	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

Payload

Content type

application/json

{"creationDate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"errorTypes": "INITIAL|INITIAL_SIP_ALREADY_EXISTS|GENERATION|UPDATE|DELETE",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"requestIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": [0
]
},
"requestStates": "TO_SCHEDULE|CREATED|WAITING_VERSIONING_MODE|BLOCKED|RUNNING|ERROR|ABORTED|IGNORED",
"requestTypes": "INGEST|UPDATE|AIP_UPDATES_CREATOR|AIP_SAVE_METADATA|AIP_POST_PROCESS|OAIS_DELETION|ABORTED|OAIS_DELETION_CREATOR",
"session": "Today_Mission1",
"sessionOwner": "string"
}

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 last update
	object (ValuesRestrictionIngestErrorType) List of request error type keys
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

Payload

Content type

application/json

{"creationDate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"errorTypes": "INITIAL|INITIAL_SIP_ALREADY_EXISTS|GENERATION|UPDATE|DELETE",
"newVersioningMode": "IGNORE",
"providerIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"requestIds": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": [0
]
},
"requestStates": "TO_SCHEDULE|CREATED|WAITING_VERSIONING_MODE|BLOCKED|RUNNING|ERROR|ABORTED|IGNORED",
"requestTypes": "INGEST|UPDATE|AIP_UPDATES_CREATOR|AIP_SAVE_METADATA|AIP_POST_PROCESS|OAIS_DELETION|ABORTED|OAIS_DELETION_CREATOR",
"session": "Today_Mission1",
"sessionOwner": "string"
}

security-resources-controller

getAllResources

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

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

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

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 (SIP)
required	object (IngestMetadataDto)
type required	string

Responses

Request samples

Payload

Content type

application/geo+json

{"bbox": [0.1
],
"crs": "string",
"features": [{"bbox": [0.1
],
"crs": "string",
"geometry": {"crs": "string",
"type": "string"
},
"history": [{"comment": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"ipType": "COLLECTION",
"lastEvent": {"comment": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string"
},
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"ref": {"algorithm": "string",
"checksum": "string",
"url": "string"
},
"submissionEvent": {"comment": "string",
"date": "2019-08-24T14:15:22Z",
"type": "string"
},
"tags": ["string"
],
"type": "string"
}
],
"metadata": {"categories": ["string"
],
"ingestChain": "string",
"model": "string",
"session": "string",
"sessionOwner": "string",
"storages": [{"pluginBusinessId": "string",
"size": {"max": 0,
"min": 0
},
"storePath": "string",
"targetTypes": ["RAWDATA"
]
}
],
"submissionDate": "2019-08-24T14:15:22Z",
"versioningMode": "IGNORE"
},
"type": "string"
}

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

Payload

Content type

application/json

{"categories": ["string"
],
"from": "2019-08-24T14:15:22Z",
"ipType": "COLLECTION",
"processing": "string",
"providerIds": ["string"
],
"session": "string",
"sessionOwner": "string",
"states": "INGESTED|STORED|DELETED",
"tags": ["string"
]
}

getSipEntity

Authorizations:

REGARDS_OAUTH2

path Parameters

sipId

required

string

MICROSERVICE INGEST (1.13.0)

aip-controller

Get AIPs

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

retrieveAIPCategories

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

delete_1

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

retrieveAIPStorage

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

retrieveAIPTags

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

updateAips

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

downloadAIP

Authorizations:

path Parameters

query Parameters

Responses

dump-controller

resetLastDumpDate

Authorizations:

Responses

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

plugin-controller

getPlugins

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

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required