Data Monitors

Create Data Monitor

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:

  • TRIGGER - causes reevaluation of data whenever CDQ Business Partner model of your data has changed or whenever linked reference data has changed
  • JOB - reevaluates data every specified period of time.

Note: creation of data monitor starts background process that is invoked for all Business Partners from data monitor scope.

SecurityapiKey
Request
path Parameters
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Request Body schema: application/json
required
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 (DataMonitorFeatureParam)

Features to be activated for Data Monitor.

Items Value: Description
BUILD_REPORT

Builds report for data monitor when it has JOB execution type.

Example: ["BUILD_REPORT"]
required
object (DataMonitorTypeParam)

Type of the Data Monitor.

object (DataMonitorValiditySpanParam)

Period after which Business Partner is evaluated again.

Responses
200

OK

post/v2/storages/{storageId}/datamonitors
Request samples
application/json
{
  • "technicalKey": "YOUR_TECHNICAL_KEY",
  • "dataSources": [
    ],
  • "enabled": "true",
  • "configuration": {
    },
  • "executions": [
    ]
}
Response samples
application/json
{
  • "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
  • "type": {
    },
  • "dataSources": [
    ],
  • "enabled": true,
  • "disabledAt": "2024-11-21T16:00:54Z",
  • "configuration": {
    },
  • "executions": [
    ],
  • "validitySpan": {
    },
  • "createdAt": "2024-11-21T16:00:54Z",
  • "createdBy": "76248934691294444",
  • "modifiedAt": "2024-11-21T16:00:54Z",
  • "modifiedBy": "76248934691294444",
  • "featuresOn": [
    ]
}

Delete a Data Monitor

Delete a data monitor.

SecurityapiKey
Request
path Parameters
dataMonitorId
required
string (DataMonitorId)

Unique ID of a Data Monitor.

Example: bfdfd6f7-562f-4d4a-921f-e68cba60d5cf
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Responses
200

OK

delete/storages/{storageId}/datamonitors/{dataMonitorId}
Request samples 
List Data Monitors
List all Data Monitors of the give storage.


SecurityapiKey 
Request 
path Parameters
storageId
required
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  72d6900fce6b326088f5d9d91049e3e6
query Parameters
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.


Items Enum: Description
AUGMENTATION
Augmentation monitor returning Augmented Business Partner as a result of the curation process and raw updates from Reference Data Sources.


DATA_QUALITY_PROFILING
Data validation monitor based on the configuration provided by cusotmer providing lis tof data defects of monitored business partners.


SCREENING
Monitor for sanction & watchlist screening processes.


 
 Example:  typeTechnicalKeys=AUGMENTATION
Responses 
200
OK


get/v2/storages/{storageId}/datamonitors
Request samples 
Response samples 
application/json
{
  • "values": "[ff864c7bfe38397b8c160bc624f97574, 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p]",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67"
}
Refresh Data Monitors
Refresh Data Monitors. When refreshing data monitor, a reevaluation is done
for all Business Partners from the data monitor scope.


SecurityapiKey 
Request 
path Parameters
storageId
required
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  72d6900fce6b326088f5d9d91049e3e6
Request Body schema: application/json
required
Array of objects (DataMonitorRefresh)   <= 1 items 
List of Data Monitors.


 
Responses 
200
OK


post/v2/storages/{storageId}/datamonitors/refresh
Request samples 
application/json
{
  • "dataMonitors": [
    ]
}
Response samples 
application/json
{
  • "dataMonitors": [
    ]
}
Update Data Monitor
Note: modification of configuration.id or set of dataSources starts background process
that populates processing log for all Business Partners from data monitor scope.


SecurityapiKey 
Request 
path Parameters
dataMonitorId
required
string (DataMonitorId) 
Unique ID of a Data Monitor.


 
 Example:  bfdfd6f7-562f-4d4a-921f-e68cba60d5cf
storageId
required
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  72d6900fce6b326088f5d9d91049e3e6
Request Body schema: application/json
required
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.


Items Value: Description
REEVALUATION_ON_CHANGES
Re-evaluates business partners based on changes in the configuration. This feature is not persisted.


 
 Example:  ["BUILD_REPORT"]
object (DataMonitorValiditySpanParam) 
Period after which Business Partner is evaluated again.


 
Responses 
200
OK


put/v2/storages/{storageId}/datamonitors/{dataMonitorId}
Request samples 
application/json
{
  • "dataSources": [
    ],
  • "enabled": true,
  • "configuration": {
    },
  • "executions": [
    ],
  • "validitySpan": {
    },
  • "featuresOn": [
    ]
}
Response samples 
application/json
{
  • "created": "4",
  • "updated": "0",
  • "failed": "4"
}