Create a new data monitor.
Data monitor is a concept for asynchronous processing of data curation and data validation.
Data monitors should be unique by a pair: dataSources + type.
Data monitor can be created only for DATA_MIRROR storage, having sharedWithOrganization set to true.
Available execution types:
Note: creation of data monitor starts background process that is invoked for all Business Partners from data monitor scope.
OK
{- "technicalKey": "YOUR_TECHNICAL_KEY",
- "dataSources": [
- {
- "id": "YOUR_DATA_SOURCE"
}
], - "enabled": "true",
- "configuration": {
- "id": "ID_OF_AUGMENTATION_CONFIGURATION"
}, - "executions": [
- {
- "type": {
- "technicalKey": "YOUR_TECHNICAL_KEY"
}
}
]
}{- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
- "type": {
- "name": "Augmentation",
- "technicalKey": "AUGMENTATION"
}, - "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}
], - "enabled": true,
- "disabledAt": "2024-12-21T01:35:28Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-12-21T01:35:28Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-12-21T01:35:28Z",
- "modifiedBy": "76248934691294444",
- "featuresOn": [
- "BUILD_REPORT"
]
}List all Data Monitors of the give storage.
| configurationId | string (ConfigurationId) Filter by specified Configuration ID. Example: configurationId=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 | ||||||||
| dataSourceId | string (BusinessPartnerStorageDataSourceId) Filter by specified Data Source ID. Example: dataSourceId=648824a691d8d2503d65103e | ||||||||
| limit | integer <int32> >= 1 Default: 500 Number of items to be returned on the page. Example: limit=100 | ||||||||
| sort | string Default: "-modifiedAt" Defines the attributes to sort by. Supported attribute is 'modifiedAt'. Sort direction can be specified in front of each attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending. Example: sort=-modifiedAt | ||||||||
| startAfter | string Only items with an ID greater than the given one will be retrieved. When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page. Example: startAfter=5712566172571652 | ||||||||
| typeTechnicalKeys | Array of strings (DataMonitorTypeTechnicalKeyEnum) Business Partner type technical keys which should be filtered.
Example: typeTechnicalKeys=AUGMENTATION |
OK
{- "values": "[ff864c7bfe38397b8c160bc624f97574, 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p]",
- "limit": "100",
- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "total": "67"
}List all Data Monitors of a specific type across all storages.
| configurationId | string (ConfigurationId) Filter by specified Configuration ID. Example: configurationId=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 | ||||||||
| dataSourceId | string (BusinessPartnerStorageDataSourceId) Filter by specified Data Source ID. Example: dataSourceId=648824a691d8d2503d65103e | ||||||||
| limit | integer <int32> >= 1 Default: 500 Number of items to be returned on the page. Example: limit=100 | ||||||||
| sort | string Default: "-modifiedAt" Defines the attributes to sort by. Supported attribute is 'modifiedAt'. Sort direction can be specified in front of each attribute. '+' means ascending, '-' means descending. If direction is not given default sort is ascending. Example: sort=-modifiedAt | ||||||||
| startAfter | string Only items with an ID greater than the given one will be retrieved. When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page. Example: startAfter=5712566172571652 | ||||||||
| typeTechnicalKeys required | Array of strings (DataMonitorTypeTechnicalKeyEnum) Business Partner type technical keys which should be filtered.
Example: typeTechnicalKeys=AUGMENTATION |
A page of Data Monitors matching the specified type.
{- "values": "[ff864c7bfe38397b8c160bc624f97574, 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p]",
- "limit": "100",
- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "total": "67"
}Refresh Data Monitors. When refreshing data monitor, a reevaluation is done for all Business Partners from the data monitor scope.
OK
{- "dataMonitors": [
- {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"
}
]
}{- "dataMonitors": [
- {
- "dataMonitor": {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"
}, - "status": "APPLICATION_IN_PROGRESS"
}
]
}Note: modification of configuration.id or set of dataSources starts background process
that populates processing log for all Business Partners from data monitor scope.
object (DataMonitorConfigurationParam) Configuration which is used during processing Business Partners. | |||||
required | Array of objects (BusinessPartnerStorageDataSourceParam) [ 1 .. 7 ] items List of Data Sources. | ||||
| enabled | boolean (DataMonitorToggle) The toggle used to enable or disable the Data Monitor. Example: true | ||||
required | Array of objects (DataMonitorExecutionParam) non-empty Available executions of data monitor. | ||||
| featuresOn | Array of strings (DataMonitorUpdateFeatureParam) Features to be activated for Data Monitor.
Example: ["BUILD_REPORT"] | ||||
object (DataMonitorValiditySpanParam) Period after which Business Partner is evaluated again. |
OK
{- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e"
}
], - "enabled": true,
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "featuresOn": [
- "BUILD_REPORT"
]
}{- "created": "4",
- "updated": "0",
- "failed": "4"
}