Valuekeep Developers - Web API Reference

Work | Maintenance Notification

Service to manage entities of type 'MaintenanceNotification'.

This service extends Notifications.

Overview


URL api/{tenantKey}/{orgKey}/maintenanceCore/maintenanceNotifications
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Notification Groups

Custom operation 'GetNotificationGroups'.

Response:

When successful, the response body contains a list of resources of type 'NotificationGroup'. See NotificationGroup.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /maintenanceCore/maintenanceNotifications/getNotificationGroups

GET Get Notification Rules Background Services

Custom operation 'GetNotificationRulesBackgroundServices'.

Response:

When successful, the response body contains a list of resources of type 'NotificationRuleBackgroundService'. See NotificationRuleBackgroundService.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /maintenanceCore/maintenanceNotifications/getNotificationRulesBackgroundServices

PUT Operations

PUT Set Custom Attribute MaintenanceNotification

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
notificationKey (string) The key for the notification.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenanceCore/maintenanceNotifications/{companyKey}/{notificationKey}/{customAttributeName}

PUT Operations

PUT Set Custom Attribute NotificationLog

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
notificationKey (string) The key for the notification.
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /maintenanceCore/maintenanceNotifications/{companyKey}/{notificationKey}/notificationLogs/{lineId}/{customAttributeName}

Resources


NotificationGroup

The following elements are optional:

notificationGroupId (int) Notification Group Id.
notificationGroupDescription (string) Notification Group Description.


NotificationRuleBackgroundService

The following elements are optional:

notificationRuleBackgroundServiceId (int) Notification Rule Background Service Id.
notificationRuleBackgroundServiceDescription (string) Notification Rule Background Service Description.