[]
        
(Showing Draft Content)

DataMonitoring

DataMonitoring

[POST] /api/data/monitorings

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DataMonitoringRequestModel

Responses

[200] Success

[DELETE] /api/data/monitorings

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DataMonitoringDeleteRequestModel

Responses

[200] Success

[GET] /api/data/monitorings

Parameters

Name In Type
orderby query string
limit query integer
offset query integer

Responses

[200] Success

[PUT] /api/data/monitorings/{id}

Parameters

Name In Type
id query string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DataMonitoringRequestModel

Responses

[200] Success

[GET] /api/data/monitorings/info/{id}

Parameters

Name In Type
id query string

Responses

[200] Success

[GET] /api/data/monitorings/detail/{id}

Parameters

Name In Type
id query string

Responses

[200] Success

[GET] /api/data/monitorings/count

Responses

[200] Success

[PUT] /api/data/monitorings/status

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DataMonitoringStatusRequestModel

Responses

[200] Success

[PUT] /api/data/monitorings/rename/{id}

Parameters

Name In Type
id query string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

newName

Responses

[200] Success

[PUT] /api/data/monitorings/description/{id}

Parameters

Name In Type
id query string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

newDescription

Responses

[200] Success

Models

Ƭ DataMonitoringRequestModel

Name Type
nameNullable string
descriptionNullable string
dashboardIdNullable string
query QueryInfo
condition ConditionInfo
notificationsNullable Array<NotificationInfo>
notificationStrategy NotificationStrategyInfo
executionPlan RecurrenceInfo

Ƭ QueryInfo

Name Type
documentIdNullable string
aggregateModelsNullable string
filtersNullable string
valuesNullable string
encryptReferenceTokenNullable string
createdByIntegration Boolean
fieldNullable string
dimensionsNullable string
userIdNullable string
userNameNullable string
userProviderNullable string
tenantIdNullable string

Ƭ ConditionInfo

Name Type
operatorNullable string
thresholdNullable string

Ƭ NotificationInfo

Name Type
channelNullable string
contactsNullable Array<Contact>
contentNullable string

Ƭ NotificationStrategyInfo

Name Type
typeNullable string
definition NotificationStrategyDefination

Ƭ RecurrenceInfo

Name Type
patternNullable string
startDateNullable ISO DateTime Sting
endDateNullable ISO DateTime Sting
timezoneIdNullable string

Ƭ Contact

Name Type
displayNameNullable string
addressNullable string
addressTypeNullable string

Ƭ NotificationStrategyDefination

Name Type
withinNullable string
timeUnitNullable string
totalSeconds int64

Ƭ DataMonitoringDeleteRequestModel

Name Type
idListNullable Array<string>

Ƭ DataMonitoringStatusRequestModel

Name Type
idListNullable Array<string>
enabled Boolean