GetNavigationHierarchy response message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the full structure of a GetNavigationHierarchy response message.
<GetNavigationHierarchyResponseMessage xmlns="http://www.citect.com/Ampla/Data/2008/06">
<GetNavigationHierarchyResponse>
<Context>
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Production</Module>
<Localization />
</Context>
<Hierarchy context="Plant" mode="Location" module="Production">
<ViewPoints>
<ViewPoint id="EnterpriseFolder">
<DisplayName>EnterpriseFolder</DisplayName>
<ViewPoints>
<ViewPoint id="EnterpriseFolder.SiteFolder1">
<DisplayName>SiteFolder1</DisplayName>
<ViewPoints />
<ReportingPoints>
<ReportingPoint id="EnterpriseFolder.SiteFolder1.Production1">
<DisplayName>Production1</DisplayName>
<LocationIdentifier>Location1</LocationIdentifier>
</ReportingPoint>
</ReportingPoints>
</ViewPoint>
<ViewPoint id="EnterpriseFolder.SiteFolder2">
<DisplayName>SiteFolder2</DisplayName>
<ViewPoints />
<ReportingPoints>
<ReportingPoint id="EnterpriseFolder.SiteFolder2.Production2">
<DisplayName>Production2</DisplayName>
</ReportingPoint>
</ReportingPoints>
</ViewPoint>
</ViewPoints>
</Hierarchy>
</GetNavigationHierarchyResponse>
Response parameters: Context section
The Context section reports the context and location of original request.
<Context>
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Production</Module>
<Localization />
</Context>
|
Parameter |
Description |
|---|---|
|
Context |
(Required) The navigation context. At this time, the only valid value for Context is Plant. |
|
Mode |
(Required) The navigation mode. When Context=Plant, the only valid value for Mode is “Location”. This option equates to navigating "by location." |
|
Module |
(Required) Module maps to one of the standard AVEVA™ Production Management modules and names the specified module in the request. This can be any module, such as Downtime, Production, Inventory. |
Response parameters: Localization section
The Localization section contains parameters that are relevant to localizing the data for display.
<Localization>
<Language>fr-FR</Language>
< /Localization>
|
Parameter |
Description |
|---|---|
|
Language |
The Windows regional setting to determine the language display of data in the client. This can be any Windows regional setting value, for example, en-AU, en-GB, fr-FR. If no language is specified, the default en-US is used. |
Response parameters: Hierarchy section
The Hierarchy section contains the returned set of viewpoints. The attributes on the Hierarchy element reflect the request parameters.
<Hierarchy context="Plant" mode="Location" module="Production">
<ViewPoints>
<ViewPoint id="EnterpriseFolder">
<DisplayName>EnterpriseFolder</DisplayName>
<ViewPoints>
<ViewPoint id="EnterpriseFolder.SiteFolder1">
<DisplayName>SiteFolder1</DisplayName>
<ViewPoints />
<ReportingPoints>
<ReportingPoint id="EnterpriseFolder.SiteFolder1.Production1">
<DisplayName>Production1</DisplayName>
<LocationIdentifier>Location1</LocationIdentifier>
</ReportingPoint>
</ReportingPoints>
</ViewPoint>
|
Parameter |
Description |
|---|---|
|
ViewPoints |
Contains the set of viewpoints. |
|
ViewPoint |
The id attribute reflects the internal AVEVA Production Management full name. This is the same format that is typically used in AVEVA Production Management expressions.EnterpriseFolder.SiteFolder |
|
DisplayName |
The DisplayName element provides the localized display name of the item.SiteFolder |
|
ReportingPoints |
Contains the set of reporting points. |
|
ReportingPoint |
Specifies the location of the reporting point.EnterpriseFolder.SiteFolder.ProductionReportingPoint |
|
DisplayName |
Specifies the display name of the reporting point. ProductionReportingPoint. |
|
LocationIdentifier |
The unique external identifier for a reporting point from an external system. For example, an identifier from SAP for a reporting point. |