GetClassHierarchy response message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the full structure of a GetClassHierarchy response message.
<GetClassHierarchyResponseMessage xmlns="http://www.citect.com/Ampla/Data/2008/06">
<GetClassHierarchyResponse>
<Context>
<Class>Any</Class>
</Context>
<ClassDefinitions>
<ClassDefinition>
<Name>Operator</Name>
<FullName>Personnel Class.Operator</FullName>
<Class>Personnel</Class>
<ClassDefinitions />
<DisplayName>Betreiber</DisplayName>
<DisplayFullName>Betreiber</DisplayFullName>
</ClassDefinition>
<ClassDefinition>
<Name>Coal</Name>
<FullName>Material Class.Coal</FullName>
<Class>Material</Class>
<ClassDefinitions />
<DisplayName>Kohle</DisplayName>
<DisplayFullName>Kohle</DisplayFullName>
</ClassDefinition>
<ClassDefinition>
<Identifier>Material Class.mat1.mat2</Identifier>
<ClassDefinitions />
</ClassDefinition>
</ClassDefinitions>
</GetClassHierarchyResponse>
Response parameters: Context section
Contains the contextual information about the request, such as class type.
<Context>
<Class>Any</Class>
</Context>
|
Parameter |
Description |
|---|---|
|
Class |
The class type that was specified in the request. This can be Any, Material, Equipment, or Personnel. |
Response parameters: ClassDefinition section
Contains the contextual information about the request, such as class type.
<ClassDefinition>
<Name>Brown Coal</Name>
<FullName>Material Class.Brown Coal</FullName>
<Class>Material</Class>
<ClassDefinitions>
<DisplayName>Braunkohle</DisplayName>
<DisplayFullName>Braunkohle</DisplayFullName>
</ClassDefinition>
|
Parameter |
Description |
|---|---|
|
ClassDefinition |
Contains information about one class definition. |
|
Name |
The name of the class definition. For example, Iron Ore. |
|
FullName |
The full name of the class definition. For example, Material Class.Iron Ore |
|
Class |
The class type for the class definition. For example, Any, Material, Equipment, or Personnel. |
|
Identifier |
The unique external identifier so that AVEVA™ Production Management recognizes the material class for the class definition from an external system. For example, an identifier from SAP for a material class. |