Version: 1.15

MICROSERVICE DAM (1.15.0)

Download OpenAPI specification:Download

License: GPL-3.0

Data management API

access-group-controller

Get groups of user

Return a page of groups of user

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
public	boolean

Responses

createAccessGroup

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

id	integer <int64>
isInternal	boolean
isPublic	boolean
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"isInternal": true,
"isPublic": true,
"name": "string"
}

deleteAccessGroup

Authorizations:

REGARDS_OAUTH2

path Parameters

name

required

string

Responses

retrieveAccessGroup

Authorizations:

REGARDS_OAUTH2

path Parameters

name

required

string

Responses

updateAccessGroup

Authorizations:

REGARDS_OAUTH2

path Parameters

name

required

string

Request Body schema: application/json
required

id	integer <int64>
isInternal	boolean
isPublic	boolean
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"isInternal": true,
"isPublic": true,
"name": "string"
}

access-right-controller

retrieveAccessRightsList

Authorizations:

REGARDS_OAUTH2

query Parameters

accessgroup	string
dataset	string
required	object (Pageable)

Responses

Response samples

Content type

application/json

{"content": [{"content": {"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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": [null
],
"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": [null
],
"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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": [null
],
"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": [null
],
"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
},
"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
}
}

createAccessRight

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

required	object (AccessGroup)
	object (Dataset)
	object (PluginConfiguration)
required	object (Dataset)
fileAccessLevel required	string Enum: "NO_ACCESS" "INHERITED_ACCESS" "CUSTOM_ACCESS"
id	integer <int64>
identifiable	boolean
metadataAccessLevel required	string Enum: "NO_ACCESS" "RESTRICTED_ACCESS" "CUSTOM_ACCESS" "FULL_ACCESS"
required	object (QualityFilter)

Responses

Request samples

Payload

Content type

application/json

{"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
}

Response samples

Content type

application/json

{"content": {"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

retrieveAccessRight_1

Authorizations:

REGARDS_OAUTH2

query Parameters

accessgroup required	string
dataset required	string

Responses

Response samples

Content type

application/json

{"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
}

isUserAutorisedToAccessDataset

Authorizations:

REGARDS_OAUTH2

query Parameters

dataset required	string
user required	string

Responses

Response samples

Content type

application/json

true

deleteAccessRight

Authorizations:

REGARDS_OAUTH2

path Parameters

accessright_id

required

integer <int64>

Responses

retrieveAccessRight

Authorizations:

REGARDS_OAUTH2

path Parameters

accessright_id

required

integer <int64>

Responses

Response samples

Content type

application/json

{"content": {"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

updateAccessRight

Authorizations:

REGARDS_OAUTH2

path Parameters

accessright_id

required

integer <int64>

Request Body schema: application/json
required

required	object (AccessGroup)
	object (Dataset)
	object (PluginConfiguration)
required	object (Dataset)
fileAccessLevel required	string Enum: "NO_ACCESS" "INHERITED_ACCESS" "CUSTOM_ACCESS"
id	integer <int64>
identifiable	boolean
metadataAccessLevel required	string Enum: "NO_ACCESS" "RESTRICTED_ACCESS" "CUSTOM_ACCESS" "FULL_ACCESS"
required	object (QualityFilter)

Responses

Request samples

Payload

Content type

application/json

{"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
}

Response samples

Content type

application/json

{"content": {"accessGroup": {"id": 0,
"identifiable": true,
"isInternal": true,
"isPublic": true,
"name": "a"
},
"constrained": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"dataAccessPlugin": {"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"
},
"dataset": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"fileAccessLevel": "NO_ACCESS",
"id": 0,
"identifiable": true,
"metadataAccessLevel": "NO_ACCESS",
"qualityFilter": {"maxScore": 10,
"minScore": 10,
"qualityLevel": "ACCEPTED"
}
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

collection-controller

Get collections

Return a page of collections

Authorizations:

REGARDS_OAUTH2

query Parameters

label	string
required	object (Pageable)

Responses

createCollection

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

creationDate	string <date-time>
docId	string
required	object (CollectionFeature)
	object (MultimapDataTypeDataFile)
	object (IGeometry)
groups	Array of strings unique
id	integer <int64>
ipId	string
label	string
last	boolean
lastUpdate	string <date-time>
required	object (Model)
mutableCopyOfPropertiesPaths	Array of strings unique
	object (IGeometry)
	Array of objects (IPropertyObject) unique
providerId	string
tags	Array of strings unique
type	string
version	integer <int32>
virtualId	string
	object (IGeometry)

Responses

Request samples

Payload

Content type

application/json

{"creationDate": "2019-08-24T14:15:22Z",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
}

deleteCollection

Authorizations:

REGARDS_OAUTH2

path Parameters

collection_id

required

integer <int64>

Responses

retrieveCollection

Authorizations:

REGARDS_OAUTH2

path Parameters

collection_id

required

integer <int64>

Responses

updateCollection

Authorizations:

REGARDS_OAUTH2

path Parameters

collection_id

required

integer <int64>

Request Body schema: application/json
required

creationDate	string <date-time>
docId	string
required	object (CollectionFeature)
	object (MultimapDataTypeDataFile)
	object (IGeometry)
groups	Array of strings unique
id	integer <int64>
ipId	string
label	string
last	boolean
lastUpdate	string <date-time>
required	object (Model)
mutableCopyOfPropertiesPaths	Array of strings unique
	object (IGeometry)
	Array of objects (IPropertyObject) unique
providerId	string
tags	Array of strings unique
type	string
version	integer <int32>
virtualId	string
	object (IGeometry)

Responses

Request samples

Payload

Content type

application/json

{"creationDate": "2019-08-24T14:15:22Z",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
}

associate_1

Authorizations:

REGARDS_OAUTH2

path Parameters

collection_id

required

integer <int64>

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

dissociate_1

Authorizations:

REGARDS_OAUTH2

path Parameters

collection_id

required

integer <int64>

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

db-connection-controller

getAllDBConnections

Authorizations:

REGARDS_OAUTH2

Responses

createDBConnection

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

deleteDBConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

plgBusinessId

required

string

Responses

getDBConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

plgBusinessId

required

string

Responses

testDBConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

plgBusinessId

required

string

Responses

updateDBConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

plgBusinessId

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

getTables

Authorizations:

REGARDS_OAUTH2

path Parameters

plgBusinessId

required

string

Responses

getColumns

Authorizations:

REGARDS_OAUTH2

path Parameters

plgBusinessId required	string
tableName required	string

Responses

crawler-controller

Get crawler datasources

Return a list of crawler datasources

Authorizations:

REGARDS_OAUTH2

Responses

deleteDatasourceIngestion

Authorizations:

REGARDS_OAUTH2

path Parameters

ingestion_id

required

string

Responses

scheduleNowDatasourceIngestion

Authorizations:

REGARDS_OAUTH2

path Parameters

ingestion_id

required

string

Responses

dataset-controller

Get datasets

Return a page of datasets always sorted by their label

Authorizations:

REGARDS_OAUTH2

query Parameters

label	string
required	object (Pageable)

Responses

Response samples

Content type

application/json

{"content": [{"content": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "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
}
}

createDataset

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

creationDate	string <date-time>
dataModel	string
docId	string
required	object (DatasetFeature)
	object (MultimapDataTypeDataFile)
	object (IGeometry)
groups	Array of strings unique
id	integer <int64>
ipId	string
label	string
last	boolean
lastUpdate	string <date-time>
licence	string
	object (DatasetMetadata)
required	object (Model)
mutableCopyOfPropertiesPaths	Array of strings unique
	object (IGeometry)
openSearchSubsettingClause	string
	object (PluginConfiguration)
	Array of objects (IPropertyObject) unique
providerId	string
	object (ICriterion)
tags	Array of strings unique
type	string
	object (ICriterion)
version	integer <int32>
virtualId	string
	object (IGeometry)

Responses

Request samples

Payload

Content type

application/json

{"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
}

Response samples

Content type

application/json

{"content": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

retrieveAttributes

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Request Body schema: application/json
required

datasetIds	Array of strings unique
modelNames	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"datasetIds": ["string"
],
"modelNames": ["string"
]
}

Response samples

Content type

application/json

{"content": [{"content": {"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
},
"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
}
}

retrieveDataAttributes

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Request Body schema: application/json
required

datasetIds	Array of strings unique
modelNames	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"datasetIds": ["string"
],
"modelNames": ["string"
]
}

Response samples

Content type

application/json

{"content": [{"content": {"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
},
"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
}
}

retrieveDataset_1

Authorizations:

REGARDS_OAUTH2

path Parameters

dataset_ipId

required

string

Responses

Response samples

Content type

application/json

{"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
}

validateSubSettingClause

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

query

string

Responses

Request samples

Payload

Content type

application/json

{"query": "string"
}

Response samples

Content type

application/json

{"validity": true
}

getModelAttrAssocsForDataInDataset

Authorizations:

REGARDS_OAUTH2

query Parameters

datasetUrn

required

string

Responses

Response samples

Content type

application/json

[{"attribute": {"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
},
"computationConf": {"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"
},
"id": 0,
"identifiable": true,
"mode": "GIVEN",
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"pos": 0
}
]

deleteDataset

Authorizations:

REGARDS_OAUTH2

path Parameters

dataset_id

required

integer <int64>

Responses

retrieveDataset

Authorizations:

REGARDS_OAUTH2

path Parameters

dataset_id

required

integer <int64>

Responses

Response samples

Content type

application/json

{"content": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

updateDataset

Authorizations:

REGARDS_OAUTH2

path Parameters

dataset_id

required

integer <int64>

Request Body schema: application/json
required

creationDate	string <date-time>
dataModel	string
docId	string
required	object (DatasetFeature)
	object (MultimapDataTypeDataFile)
	object (IGeometry)
groups	Array of strings unique
id	integer <int64>
ipId	string
label	string
last	boolean
lastUpdate	string <date-time>
licence	string
	object (DatasetMetadata)
required	object (Model)
mutableCopyOfPropertiesPaths	Array of strings unique
	object (IGeometry)
openSearchSubsettingClause	string
	object (PluginConfiguration)
	Array of objects (IPropertyObject) unique
providerId	string
	object (ICriterion)
tags	Array of strings unique
type	string
	object (ICriterion)
version	integer <int32>
virtualId	string
	object (IGeometry)

Responses

Request samples

Payload

Content type

application/json

{"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"crs": "string",
"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"crs": "string",
"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"crs": "string",
"type": "string"
}
}

Response samples

Content type

application/json

{"content": {"creationDate": "2019-08-24T14:15:22Z",
"dataModel": "string",
"docId": "string",
"feature": {"bbox": [0.1
],
"crs": "string",
"dataObjectsAccessGranted": true,
"dataObjectsFilesAccessGranted": true,
"entityType": "COLLECTION",
"files": {"empty": true
},
"geometry": {"type": "string"
},
"id": "string",
"label": "string",
"last": true,
"licence": "string",
"model": "string",
"normalizedGeometry": {"type": "string"
},
"providerId": "string",
"tags": ["string"
],
"type": "string",
"version": 0,
"virtualId": "string"
},
"files": {"empty": true
},
"geometry": {"type": "string"
},
"groups": ["string"
],
"id": 0,
"ipId": "string",
"label": "string",
"last": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"licence": "string",
"metadata": {"dataObjectsGroups": {"property1": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
},
"property2": {"dataFileAccess": true,
"dataObjectAccess": true,
"dataObjectAccessFilterPluginBusinessId": "string",
"datasetAccess": true,
"groupName": "string",
"metaDataObjectAccessFilterPluginBusinessId": "string"
}
}
},
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"mutableCopyOfPropertiesPaths": ["string"
],
"normalizedGeometry": {"type": "string"
},
"openSearchSubsettingClause": "string",
"plgConfDataSource": {"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"
},
"properties": [{"name": "string",
"type": "STRING",
"value": { }
}
],
"providerId": "string",
"subsettingClause": {"empty": true
},
"tags": ["string"
],
"type": "string",
"userSubsettingClause": {"empty": true
},
"version": 0,
"virtualId": "string",
"wgs84": {"type": "string"
}
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}

associate

Authorizations:

REGARDS_OAUTH2

path Parameters

dataset_id

required

integer <int64>

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

dissociate

Authorizations:

REGARDS_OAUTH2

path Parameters

dataset_id

required

integer <int64>

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

dataset-with-access-right-controller

retrieveDatasets_1

Authorizations:

REGARDS_OAUTH2

path Parameters

accessGroupName

required

string

query Parameters

datasetLabel	string
required	object (Pageable)

Responses

data-source-controller

Get IDataSourcePlugin plugin configurations

Return a list of plugin configurations of type IDataSourcePlugin

Authorizations:

REGARDS_OAUTH2

Responses

createDataSource

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

deleteDataSource

Authorizations:

REGARDS_OAUTH2

path Parameters

businessId

required

string

Responses

getDataSource

Authorizations:

REGARDS_OAUTH2

path Parameters

businessId

required

string

Responses

updateDataSource

Authorizations:

REGARDS_OAUTH2

path Parameters

businessId

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

attachment-controller

removeFile

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum required	string
urn required	string

Responses

getFile

Authorizations:

REGARDS_OAUTH2

path Parameters

checksum required	string
urn required	string

query Parameters

isContentInline	boolean
origin	string

Responses

attachFiles

Authorizations:

REGARDS_OAUTH2

path Parameters

dataType required	string Enum: "RAWDATA" "QUICKLOOK_SD" "QUICKLOOK_MD" "QUICKLOOK_HD" "DOCUMENT" "THUMBNAIL" "OTHER" "AIP" "DESCRIPTION"
urn required	string

Request Body schema: application/json

file	Array of strings <binary> [ items <binary > ]
	Array of objects (DataFileReference)

Responses

Request samples

Payload

Content type

application/json

{"file": ["string"
],
"refs": [{"filename": "string",
"imageHeight": 0.1,
"imageWidth": 0.1,
"mimeType": "string",
"uri": "string"
}
]
}

index-controller

recreateIndex

Authorizations:

REGARDS_OAUTH2

Responses

updateCollections

Authorizations:

REGARDS_OAUTH2

Responses

updateDatasets

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

model-controller

Get models

Return a model list

Authorizations:

REGARDS_OAUTH2

query Parameters

type	string Enum: "COLLECTION" "DATA" "DATASET"

Responses

createModel

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

description	string
id	integer <int64>
identifiable	boolean
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
type required	string Enum: "COLLECTION" "DATA" "DATASET"
version	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
}

importModel

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

deleteModel

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Responses

getModel

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Responses

updateModel

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Request Body schema: application/json
required

description	string
id	integer <int64>
identifiable	boolean
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
type required	string Enum: "COLLECTION" "DATA" "DATASET"
version	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
}

duplicateModel

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Request Body schema: application/json
required

description	string
id	integer <int64>
identifiable	boolean
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
type required	string Enum: "COLLECTION" "DATA" "DATASET"
version	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
}

exportModel

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Responses

model-attr-assoc-controller

Models and attrs links by type

Endpoint enabling retrieval of all links between models and attribute for a given type of entity

Authorizations:

REGARDS_OAUTH2

query Parameters

type	string Enum: "COLLECTION" "DATA" "DATASET" Filter using entity type

Responses

Available plugin conf by attr type

Endpoint enabling retrieval, for every attribute type, compatible plugin configurations and plugin metadata

Authorizations:

REGARDS_OAUTH2

Responses

Get model attr assocs

Return all model attribute associations matching provided criteria.

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Filter using model name

Responses

Bind attr to model

Bind an attribute to a model.

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Filter using model name

Request Body schema: application/json
required

required	object (AttributeModel)
	object (PluginConfiguration)
id	integer <int64>
identifiable	boolean
mode	string Enum: "GIVEN" "COMPUTED"
	object (Model)
pos	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"attribute": {"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
},
"computationConf": {"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,
"identifiable": true,
"mode": "GIVEN",
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"pos": 0
}

Bind fragment

Bind fragment attributes to a model.

Authorizations:

REGARDS_OAUTH2

path Parameters

modelName

required

string

Model receiving the fragment

Request Body schema: application/json
required

defaultFragment	boolean
description	string
id	integer <int64>
identifiable	boolean
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
version	string [ 0 .. 16 ] characters
virtual	boolean

Responses

Request samples

Payload

Content type

application/json

{"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
}

Unbind fragment

Unbind fragment attributes from a model.

Authorizations:

REGARDS_OAUTH2

path Parameters

fragmentId required	integer <int64> Fragment id to unbind
modelName required	string Filter using model name

Responses

Unbind attribute

Unbind an attribute from a model.

Authorizations:

REGARDS_OAUTH2

path Parameters

attributeId required	integer <int64> Attribute id to unbind
modelName required	string Model that loose one attribute

Responses

Get model attr assoc

Return a model attribute association matching criteria.

Authorizations:

REGARDS_OAUTH2

path Parameters

attributeId required	integer <int64> Filter using attribute id
modelName required	string Filter using model name

Responses

Update model attr assoc

Update a model attribute association matching provided model name and attribute id.

Authorizations:

REGARDS_OAUTH2

path Parameters

attributeId required	integer <int64> Filter using attribute id
modelName required	string Filter using model name

Request Body schema: application/json
required

required	object (AttributeModel)
	object (PluginConfiguration)
id	integer <int64>
identifiable	boolean
mode	string Enum: "GIVEN" "COMPUTED"
	object (Model)
pos	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"attribute": {"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
},
"computationConf": {"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,
"identifiable": true,
"mode": "GIVEN",
"model": {"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"type": "COLLECTION",
"version": "string"
},
"pos": 0
}

attribute-model-controller

Get attribute models

Return a list of attribute models

Authorizations:

REGARDS_OAUTH2

query Parameters

fragmentName	string
modelNames	Array of strings unique
noLink	boolean
type	string Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"

Responses

addAttribute

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

alterable	boolean
arraysize	integer <int32>
booleanAttribute	boolean
description	string
dynamic	boolean
esMapping	string
	object (Fragment) Fragment to add to the model
fullJsonPath	string
fullName	string
group	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
id	integer <int64>
identifiable	boolean
indexed	boolean
internal	boolean
jsonPath	string
jsonPropertyPath	string
label required	string [ 0 .. 255 ] characters
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
optional	boolean
precision	integer <int32>
	Array of objects (AttributeProperty)
	object (AbstractRestriction)
restrictionType	string Enum: "NO_RESTRICTION" "PATTERN" "ENUMERATION" "DATE_ISO8601" "INTEGER_RANGE" "LONG_RANGE" "DOUBLE_RANGE" "URL" "GEOMETRY" "JSON_SCHEMA"
textAttribute	boolean
type required	string Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"
unit	string
virtual	boolean

Responses

Request samples

Payload

Content type

application/json

{"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
}

getModelsAttributes

Authorizations:

REGARDS_OAUTH2

path Parameters

modelType

required

string

Enum: "COLLECTION" "DATA" "DATASET"

Responses

getRestrictions

Authorizations:

REGARDS_OAUTH2

query Parameters

type

required

string

Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"

Responses

getPropertyTypes

Authorizations:

REGARDS_OAUTH2

Responses

deleteAttribute

Authorizations:

REGARDS_OAUTH2

path Parameters

attributeId

required

integer <int64>

Responses

getAttribute

Authorizations:

REGARDS_OAUTH2

path Parameters

attributeId

required

integer <int64>

Responses

updateAttribute

Authorizations:

REGARDS_OAUTH2

path Parameters

attributeId

required

integer <int64>

Request Body schema: application/json
required

alterable	boolean
arraysize	integer <int32>
booleanAttribute	boolean
description	string
dynamic	boolean
esMapping	string
	object (Fragment) Fragment to add to the model
fullJsonPath	string
fullName	string
group	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
id	integer <int64>
identifiable	boolean
indexed	boolean
internal	boolean
jsonPath	string
jsonPropertyPath	string
label required	string [ 0 .. 255 ] characters
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
optional	boolean
precision	integer <int32>
	Array of objects (AttributeProperty)
	object (AbstractRestriction)
restrictionType	string Enum: "NO_RESTRICTION" "PATTERN" "ENUMERATION" "DATE_ISO8601" "INTEGER_RANGE" "LONG_RANGE" "DOUBLE_RANGE" "URL" "GEOMETRY" "JSON_SCHEMA"
textAttribute	boolean
type required	string Enum: "STRING" "JSON" "INTEGER" "DOUBLE" "DATE_ISO8601" "URL" "BOOLEAN" "STRING_ARRAY" "INTEGER_ARRAY" "DOUBLE_ARRAY" "DATE_ARRAY" "INTEGER_RANGE" "INTEGER_INTERVAL" "DOUBLE_RANGE" "DOUBLE_INTERVAL" "DATE_RANGE" "DATE_INTERVAL" "LONG" "LONG_RANGE" "LONG_INTERVAL" "LONG_ARRAY" "OBJECT"
unit	string
virtual	boolean

Responses

Request samples

Payload

Content type

application/json

{"alterable": true,
"arraysize": 0,
"booleanAttribute": true,
"description": "string",
"dynamic": true,
"esMapping": "string",
"fragment": {"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
},
"fullJsonPath": "string",
"fullName": "string",
"group": "a",
"id": 0,
"identifiable": true,
"indexed": true,
"internal": true,
"jsonPath": "string",
"jsonPropertyPath": "string",
"label": "string",
"name": "a",
"optional": true,
"precision": 0,
"properties": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string"
}
],
"restriction": {"id": 0,
"identifiable": true,
"type": "NO_RESTRICTION"
},
"restrictionType": "NO_RESTRICTION",
"textAttribute": true,
"type": "STRING",
"unit": "string",
"virtual": true
}

fragment-controller

Get fragments

Return a list of fragments

Authorizations:

REGARDS_OAUTH2

Responses

addFragment

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

defaultFragment	boolean
description	string
id	integer <int64>
identifiable	boolean
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
version	string [ 0 .. 16 ] characters
virtual	boolean

Responses

Request samples

Payload

Content type

application/json

{"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
}

importFragment

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file

required

string <binary>

Responses

deleteFragment

Authorizations:

REGARDS_OAUTH2

path Parameters

fragmentId

required

integer <int64>

Responses

getFragment

Authorizations:

REGARDS_OAUTH2

path Parameters

fragmentId

required

integer <int64>

Responses

updateFragment

Authorizations:

REGARDS_OAUTH2

path Parameters

fragmentId

required

integer <int64>

Request Body schema: application/json
required

defaultFragment	boolean
description	string
id	integer <int64>
identifiable	boolean
name required	string [ 1 .. 32 ] characters [a-zA-Z_][0-9a-zA-Z_]*
version	string [ 0 .. 16 ] characters
virtual	boolean

Responses

Request samples

Payload

Content type

application/json

{"defaultFragment": true,
"description": "string",
"id": 0,
"identifiable": true,
"name": "a",
"version": "string",
"virtual": true
}

exportFragment

Authorizations:

REGARDS_OAUTH2

path Parameters

fragmentId

required

integer <int64>

Responses

opensearch-controller

retrieveDescriptor

Authorizations:

REGARDS_OAUTH2

query Parameters

url

required

string

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

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

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

MICROSERVICE DAM (1.15.0)

access-group-controller

Get groups of user

Authorizations:

query Parameters

Responses

createAccessGroup

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

deleteAccessGroup

Authorizations:

path Parameters

Responses

retrieveAccessGroup

Authorizations:

path Parameters

Responses

updateAccessGroup

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

access-right-controller

retrieveAccessRightsList

Authorizations:

query Parameters

Responses

Response samples

createAccessRight

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

retrieveAccessRight_1

Authorizations:

query Parameters

Responses

Response samples

isUserAutorisedToAccessDataset

Authorizations:

query Parameters

Responses

Response samples

deleteAccessRight

Authorizations:

path Parameters

Responses

retrieveAccessRight

Authorizations:

path Parameters

Responses

Response samples

updateAccessRight

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

collection-controller

Get collections

Authorizations:

query Parameters

Responses

createCollection

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

deleteCollection

Authorizations:

path Parameters

Responses

retrieveCollection

Authorizations:

path Parameters

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

Request Body schema: application/json
required