Get features
Return a page of features matching criteria.
Authorizations:
query Parameters
required | object (Pageable) Sorting and page configuration |
Request Body schema: application/jsonrequired
Set of search criteria.
disseminationPending | boolean Filter on dissemination pending |
object (ValuesRestrictionLong) Filter on feature id | |
object (DatesRangeRestriction) Filter on range of date for last update | |
model | string Filter on model |
object (ValuesRestrictionString) Filter on provider id | |
session | string Filter on session that emitted the request |
source | string Filter on source |
Responses
Request samples
- Payload
{- "disseminationPending": false,
- "featureIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- 0
]
}, - "lastUpdate": {
- "after": "2019-08-24T14:15:22Z",
- "before": "2019-08-24T14:15:22Z"
}, - "model": "string",
- "providerIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "string"
]
}, - "session": "Today_Mission1",
- "source": "string"
}
Response samples
- 200
{- "content": [
- {
- "content": {
- "disseminationPending": true,
- "disseminationsInfo": [
- { }
], - "feature": {
- "bbox": [
- 0.1
], - "crs": "string",
- "entityType": "COLLECTION",
- "files": [
- {
- "attributes": {
- "algorithm": "string",
- "checksum": "string",
- "crc32": "string",
- "dataType": "RAWDATA",
- "filename": "string",
- "filesize": 0,
- "mimeType": "string"
}, - "locations": [
- {
- "storage": "string",
- "url": "string"
}
]
}
], - "geometry": {
- "type": "string"
}, - "history": {
- "createdBy": "string",
- "deletedBy": "string",
- "updatedBy": "string"
}, - "id": "string",
- "last": true,
- "model": "string",
- "normalizedGeometry": {
- "type": "string"
}, - "type": "string",
- "urn": "string"
}, - "id": 0,
- "lastUpdate": "2019-08-24T14:15:22Z",
- "providerId": "string",
- "session": "string",
- "source": "string",
- "urn": "string",
- "version": 0
}, - "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
}
}
Delete features according to search parameters
Delete features according to search parameters
Authorizations:
Request Body schema: application/jsonrequired
Set of search criteria.
disseminationPending | boolean Filter on dissemination pending |
object (ValuesRestrictionLong) Filter on feature id | |
object (DatesRangeRestriction) Filter on range of date for last update | |
model | string Filter on model |
object (ValuesRestrictionString) Filter on provider id | |
session | string Filter on session that emitted the request |
source | string Filter on source |
Responses
Request samples
- Payload
{- "disseminationPending": false,
- "featureIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- 0
]
}, - "lastUpdate": {
- "after": "2019-08-24T14:15:22Z",
- "before": "2019-08-24T14:15:22Z"
}, - "model": "string",
- "providerIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "string"
]
}, - "session": "Today_Mission1",
- "source": "string"
}
Notify features to given recipients according to search parameters
Notify features to given recipients according to search parameters
Authorizations:
Request Body schema: application/jsonrequired
Set of search criteria with the recipients of direct notification.
disseminationPending | boolean Filter on dissemination pending |
object (ValuesRestrictionLong) Filter on feature id | |
object (DatesRangeRestriction) Filter on range of date for last update | |
model | string Filter on model |
object (ValuesRestrictionString) Filter on provider id | |
session | string Filter on session that emitted the request |
source | string Filter on source |
Responses
Request samples
- Payload
{- "disseminationPending": false,
- "featureIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- 0
]
}, - "lastUpdate": {
- "after": "2019-08-24T14:15:22Z",
- "before": "2019-08-24T14:15:22Z"
}, - "model": "string",
- "providerIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "string"
]
}, - "session": "Today_Mission1",
- "source": "string"
}
Retrieve one feature by its urn
Retrieve one feature by its urn
Authorizations:
path Parameters
urn required | string URN of the feature |
Responses
Response samples
- 200
{- "disseminationPending": true,
- "disseminationsInfo": [
- { }
], - "feature": {
- "bbox": [
- 0.1
], - "crs": "string",
- "entityType": "COLLECTION",
- "files": [
- {
- "attributes": {
- "algorithm": "string",
- "checksum": "string",
- "crc32": "string",
- "dataType": "RAWDATA",
- "filename": "string",
- "filesize": 0,
- "mimeType": "string"
}, - "locations": [
- {
- "storage": "string",
- "url": "string"
}
]
}
], - "geometry": {
- "type": "string"
}, - "history": {
- "createdBy": "string",
- "deletedBy": "string",
- "updatedBy": "string"
}, - "id": "string",
- "last": true,
- "model": "string",
- "normalizedGeometry": {
- "type": "string"
}, - "type": "string",
- "urn": "string"
}, - "id": 0,
- "lastUpdate": "2019-08-24T14:15:22Z",
- "providerId": "string",
- "session": "string",
- "source": "string",
- "urn": "string",
- "version": 0
}
Publish urns collection to delete and return urns of granted and denied requests
Publish urns collection to delete and return urns of granted and denied requests
Authorizations:
Request Body schema: application/geo+jsonrequired
featuresUrns | Array of strings unique |
priority | string Enum: "HIGH" "NORMAL" "LOW" |
Responses
Request samples
- Payload
{- "featuresUrns": [
- "string"
], - "priority": "HIGH"
}
Publish a feature collection to update and return urns of granted and denied requests
Publish a feature collection to update and return urns of granted and denied requests
Authorizations:
Request Body schema: application/geo+jsonrequired
bbox | Array of numbers <double> [ items <double > ] |
crs | string |
Array of objects (Feature) | |
object (FeatureMetadata) | |
requestOwner required | string |
type required | string |
Responses
Request samples
- Payload
{- "bbox": [
- 0.1
], - "crs": "string",
- "features": [
- {
- "bbox": [
- 0.1
], - "crs": "string",
- "entityType": "COLLECTION",
- "files": [
- {
- "attributes": {
- "algorithm": "string",
- "checksum": "string",
- "crc32": "string",
- "dataType": "RAWDATA",
- "filename": "string",
- "filesize": 0,
- "mimeType": "string"
}, - "locations": [
- {
- "storage": "string",
- "url": "string"
}
]
}
], - "geometry": {
- "crs": "string",
- "type": "string"
}, - "history": {
- "createdBy": "string",
- "deletedBy": "string",
- "updatedBy": "string"
}, - "id": "string",
- "last": true,
- "model": "string",
- "normalizedGeometry": {
- "crs": "string",
- "type": "string"
}, - "type": "string",
- "urn": "string"
}
], - "metadata": {
- "acknowledgedRecipient": "string",
- "priority": "HIGH",
- "storages": [
- {
- "pluginBusinessId": "string",
- "storePath": "string",
- "targetTypes": [
- "RAWDATA"
]
}
]
}, - "requestOwner": "string",
- "type": "string"
}
Publish a new feature and return the request id
Publish a new feature and return the request id
Authorizations:
Request Body schema: application/geo+jsonrequired
bbox | Array of numbers <double> [ items <double > ] |
crs | string |
Array of objects (Feature) | |
object (FeatureCreationSessionMetadata) | |
requestOwner required | string |
type required | string |
Responses
Request samples
- Payload
{- "bbox": [
- 0.1
], - "crs": "string",
- "features": [
- {
- "bbox": [
- 0.1
], - "crs": "string",
- "entityType": "COLLECTION",
- "files": [
- {
- "attributes": {
- "algorithm": "string",
- "checksum": "string",
- "crc32": "string",
- "dataType": "RAWDATA",
- "filename": "string",
- "filesize": 0,
- "mimeType": "string"
}, - "locations": [
- {
- "storage": "string",
- "url": "string"
}
]
}
], - "geometry": {
- "crs": "string",
- "type": "string"
}, - "history": {
- "createdBy": "string",
- "deletedBy": "string",
- "updatedBy": "string"
}, - "id": "string",
- "last": true,
- "model": "string",
- "normalizedGeometry": {
- "crs": "string",
- "type": "string"
}, - "type": "string",
- "urn": "string"
}
], - "metadata": {
- "acknowledgedRecipient": "string",
- "override": true,
- "priority": "HIGH",
- "session": "string",
- "sessionOwner": "string",
- "storages": [
- {
- "pluginBusinessId": "string",
- "storePath": "string",
- "targetTypes": [
- "RAWDATA"
]
}
], - "updateIfExists": true
}, - "requestOwner": "string",
- "type": "string"
}
Response samples
- 200
[- {
- "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"
}
]
}
]
Get plugin configurations
Return a list of plugin configurations for a specific type
Authorizations:
query Parameters
pluginType | string |
Responses
Response samples
- 200
[- {
- "content": {
- "active": true,
- "businessId": "string",
- "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:
path Parameters
configBusinessId required | string |
Responses
Response samples
- 200
{- "content": {
- "active": true,
- "businessId": "string",
- "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"
}
]
}
Response samples
- 200
{- "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:
path Parameters
pluginId required | string |
Responses
Response samples
- 200
[- {
- "content": {
- "active": true,
- "businessId": "string",
- "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:
Request Body schema: application/jsonrequired
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
{- "active": true,
- "businessId": "string",
- "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
- 200
{- "content": {
- "active": true,
- "businessId": "string",
- "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"
}
]
}
getPluginConfiguration
Authorizations:
path Parameters
configBusinessId required | string |
pluginId required | string |
Responses
Response samples
- 200
{- "content": {
- "active": true,
- "businessId": "string",
- "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:
path Parameters
configBusinessId required | string |
pluginId required | string |
Request Body schema: application/jsonrequired
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
{- "active": true,
- "businessId": "string",
- "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
- 200
{- "content": {
- "active": true,
- "businessId": "string",
- "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"
}
]
}
Response samples
- 200
[- {
- "content": "string",
- "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "media": "string",
- "name": "string",
- "profile": "string",
- "rel": "string",
- "title": "string",
- "type": "string"
}
]
}
]
Delete feature requests by selection
Delete feature requests by selection. Synchronous process, so the number of request handled is limited. Information about number of requests handled is returned in the response.
Authorizations:
path Parameters
type required | string Enum: "COPY" "UPDATE" "NOTIFICATION" "CREATION" "DELETION" "SAVE_METADATA" Type of requests to search for |
Request Body schema: application/jsonrequired
Set of search criterias.
object (DatesRangeRestriction) Filter on range of date for last update | |
object (ValuesRestrictionString) Filter on provider id | |
object (ValuesRestrictionLong) Filter on feature id | |
session | string Filter on session that emitted the request |
source | string Filter on source |
object (ValuesRestrictionRequestState) Filter on request states | |
object (ValuesRestrictionFeatureRequestStep) Filter on request step |
Responses
Request samples
- Payload
{- "lastUpdate": {
- "after": "2019-08-24T14:15:22Z",
- "before": "2019-08-24T14:15:22Z"
}, - "providerIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "string"
]
}, - "requestIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- 0
]
}, - "session": "Today_Mission1",
- "source": "string",
- "states": "GRANTED|DENIED|SUCCESS|ERROR",
- "steps": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "LOCAL_DENIED"
]
}
}
Response samples
- 200
{- "message": "string",
- "totalHandled": 0,
- "totalRequested": 0
}
Retry feature requests by selection
Retry feature requests by selection. Synchronous process, so the number of request handled is limited. Information about number of requests handled is returned in the response.")
Authorizations:
path Parameters
type required | string Enum: "COPY" "UPDATE" "NOTIFICATION" "CREATION" "DELETION" "SAVE_METADATA" Type of requests to search for |
Request Body schema: application/jsonrequired
Set of search criterias.
object (DatesRangeRestriction) Filter on range of date for last update | |
object (ValuesRestrictionString) Filter on provider id | |
object (ValuesRestrictionLong) Filter on feature id | |
session | string Filter on session that emitted the request |
source | string Filter on source |
object (ValuesRestrictionRequestState) Filter on request states | |
object (ValuesRestrictionFeatureRequestStep) Filter on request step |
Responses
Request samples
- Payload
{- "lastUpdate": {
- "after": "2019-08-24T14:15:22Z",
- "before": "2019-08-24T14:15:22Z"
}, - "providerIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "string"
]
}, - "requestIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- 0
]
}, - "session": "Today_Mission1",
- "source": "string",
- "states": "GRANTED|DENIED|SUCCESS|ERROR",
- "steps": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "LOCAL_DENIED"
]
}
}
Response samples
- 200
{- "message": "string",
- "totalHandled": 0,
- "totalRequested": 0
}
Get feature requests
Return a page of feature requests according criterias
Authorizations:
path Parameters
type required | string Enum: "COPY" "UPDATE" "NOTIFICATION" "CREATION" "DELETION" "SAVE_METADATA" Type of feature requests to search for |
query Parameters
required | object (Pageable) Sorting and page configuration |
Request Body schema: application/jsonrequired
Set of search criterias.
object (DatesRangeRestriction) Filter on range of date for last update | |
object (ValuesRestrictionString) Filter on provider id | |
object (ValuesRestrictionLong) Filter on feature id | |
session | string Filter on session that emitted the request |
source | string Filter on source |
object (ValuesRestrictionRequestState) Filter on request states | |
object (ValuesRestrictionFeatureRequestStep) Filter on request step |
Responses
Request samples
- Payload
{- "lastUpdate": {
- "after": "2019-08-24T14:15:22Z",
- "before": "2019-08-24T14:15:22Z"
}, - "providerIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "string"
]
}, - "requestIds": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- 0
]
}, - "session": "Today_Mission1",
- "source": "string",
- "states": "GRANTED|DENIED|SUCCESS|ERROR",
- "steps": {
- "ignoreCase": true,
- "matchMode": "STRICT",
- "mode": "INCLUDE",
- "values": [
- "LOCAL_DENIED"
]
}
}
Response samples
- 200
{- "content": [
- {
- "content": {
- "errors": [
- "string"
], - "id": 0,
- "processing": true,
- "providerId": "string",
- "registrationDate": "2019-08-24T14:15:22Z",
- "session": "string",
- "source": "string",
- "state": "GRANTED",
- "step": "LOCAL_DENIED",
- "type": "string",
- "urn": "string"
}, - "links": [
- {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "media": "string",
- "name": "string",
- "profile": "string",
- "rel": "string",
- "title": "string",
- "type": "string"
}
]
}
], - "info": {
- "nbErrors": 0
}, - "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
}
}
Response samples
- 200
[- {
- "autorizedRoles": [
- {
- "authority": "string",
- "authorizedIpAdresses": [
- "string"
], - "roleName": "string"
}
], - "controllerSimpleName": "string",
- "fullPath": "string",
- "method": "GET",
- "resourceAccess": { },
- "resourceMappingId": "string"
}
]
update
Authorizations:
path Parameters
name required | string |
Request Body schema: application/jsonrequired
defaultValue | object |
description | string |
name | string |
value | object |
Responses
Request samples
- Payload
{- "defaultValue": { },
- "description": "string",
- "name": "string",
- "value": { }
}