3.3.17.5 Record: NotificationRequestRecord

{

      "type": "record",

      "namespace": "Energistics.Datatypes.Object",

      "name": "NotificationRequestRecord",

      "fields":

     [

         { "name": "uri", "type": "string" },

         { "name": "uuid", "type": "string" },

         { "name": "includeObjectData", "type": "boolean" },

         { "name": "startTime", "type": "long" },

         {

          "name": "objectTypes",

          "type": { "type": "array", "items": "string" }

     }

     ]

}

uri

The content URI for the subscription. The exact definitions for allowable URIs are specified in the Energistics Identifier Specification.

string

1

1

uuid

A UUID for this notification request. This MUST be a newly-generated UUID from the customer sending the message. This ID can be used to remove the notification at a later point. This MUST be a UUID as specified by RFC 4122 (https://www.ietf.org/rfc/rfc4122.txt ). The UUID MUST be formatted as a string, in the form commonly known as "Windows Registry format". Example:

65CCC68E-C0B4-454E-8757-3284F94AE861

string

1

1

includeObjectData

• If true, then notification MUST contain the complete data object, corresponding to the change.
• If false, only a Resource record for the object is sent and the Store protocol MUST be used to get the object itself.

Growing parts of objects, such as trajectory stations or data arrays, MUST NOT be sent as a result of this parameter being set to 'true'.

boolean

1

1

startTime

Starting time for changes. If any of the objects within the context of the URI have changed since this time, then the store MUST immediately send one ChangeNotification message of the object in its current state. Note, the startTime is assumed to be in the past, and is ignored if it is in the future (i.e., notifications are still sent, but the immediate sending of one message does not occur).

long

1

1

objectTypes

An array of data object types for which change notification is requested. An empty array indicates all object types within the context of the supplied URI. The format of the object type string is exactly the same as the contentType field as defined in the Energistics Identifier Spec.

string

0

n