User Manuals : FOXMAN-UN Northbound Interface - User Manual : Inventory report interface : General : Syntax : Inventory change registration unscheduled
Hitachi Energy
Inventory change registration unscheduled
Format of the request for the registration of an inventory change notification with unscheduled response:
inventory registerGetReport async <msgID> <reportType> [<address>] [<filter>] [<reportFormat>]
 
msgID
The «message identifier» is a number issued by the user. This number is returned by the report server in its response.
reportType
Possible values are
NE | Unit | Service
address (optional)
Refer to Equipment addressing.
filter (optional)
Refer to Filters.
reportFormat (optional)
Possible values are
xml | csv
(Default: xml)
 
Format of the immediate response to a registration request:
inventory registerGetReportResponse async <msgID> <errorCode> <regID> <datastream>
 
msgID
Message identifier of the corresponding request.
regID
Registration identifier assigned by the report server to this registration. This identifier will be quoted in all future notifications of inventory changes.
errorCode
Refer to Error codes.
datastream
Inventory data as requested.
Format of the notification caused by an inventory change:
inventory notification registration <regID> <reportNotificationType> <datastream>
 
regID
Registration identifier assigned by the report server to this registration.
reportNotificationType
The following types are generated:
NECreation | NEDeletion |
UnitCreation | UnitDeletion | ServiceCreation | ServiceDeletion
datastream
For notifications of the type «Creation»: Inventory data as requested.
For notifications of the type «Deletion»: Address of the deleted inventory item.