Data Monitors

Create Data MonitorDeprecated

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 Business Partner Storage, having sharedWithOrganization set to true.

Creation of data monitor in v1 is configured as JOB execution type which reevaluates data every specified period of time. See v2 of this endpoint for comparison and additional options.

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
frequency
required
string (DataMonitorFrequency)

It is the interval at which updates are performed.

Example: "BI_WEEKLY"
required
object (DataMonitorTypeParam)

Type of the Data Monitor.

Responses
200

OK

post/storages/{storageId}/datamonitors
Request samples
application/json
{
  • "type": {
    },
  • "dataSources": [
    ],
  • "enabled": true,
  • "configuration": {
    },
  • "frequency": "BI_WEEKLY"
}
Response samples
application/json
{
  • "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
  • "frequency": "BI_WEEKLY",
  • "type": {
    },
  • "dataSources": [
    ],
  • "enabled": true,
  • "disabledAt": "2024-11-22T13:20:20Z",
  • "configuration": {
    }
}

Delete 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 MonitorsDeprecated
List all Data Monitors of the give Business Partner Storage.


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


 
 Example:  72d6900fce6b326088f5d9d91049e3e6
query Parameters
limit
integer <int32>   >= 1 
 Default:  500
Number of items to be returned on the page.


 
 Example:  limit=100
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
Responses 
200
OK


get/storages/{storageId}/datamonitors
Request samples 
Response samples 
application/json
{
  • "values": "[ff864c7bfe38397b8c160bc624f97574, 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p]",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67"
}
Update Data MonitorDeprecated
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
frequency
required
string (DataMonitorFrequency) 
It is the interval at which updates are performed.


 
 Example:  "BI_WEEKLY"
required
object (DataMonitorTypeParam) 
Type of the Data Monitor.


 
Responses 
200
OK


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