Capacity record change notification

A Capacity Record Change notification is emitted by the API to report changes related to a capacity record object. [Added by feature bcpii-notifications]

Characteristic Description
Destination The per-session object notification topic for each API session that is authorized to receive the notification.

In addition to the common message characteristics and properties the following property is provided for this type of notification:

Message property name Description
notification-type Contains the value "capacity-record-change".

The body of a Capacity Record Change notification message is a JSON representation of an object that contains the following fields and values:

Field name Type Description
capacity-record-change-type String Enum The type of capacity change.
  • "add" - A capacity record was added.
  • "delta" - A capacity record was modified.
  • "level" - A capacity record has changed its level of activation.
  • "priority-pending" - Additional capacity has been added for the capacity record with priority, but not enough resources were available to allow for all the capacity specified to be put into effect. As resources become available, they will be added for this record in order to completely satisfy the original request for additional capacity.
  • "other" - Some other unexpected type of capacity record change.
  • "delete" - A capacity record was deleted.
  • "accounting" - An accounting change has occurred.