getHierarchyMetadataByModuleName
Gets the permissible structure of the hierarchy that can be created from the object types in a hierarchy module. The method specifies which object type must be used to create the record that is the root of the hierarchy and what types of records can appear under each type of record.
Parameters
moduleName is the module name whose hierarchy is retrieved.
Returns
The hierarchy object type is returned.
Errors
- ModuleDoesNotExistException
- The moduleId does not exist in the system.
- java.lang.Exception
- A system error occurred when the request was being processed.
- AccessException
- The user does not have access to the module.
Sample request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.tririga.com">
<soapenv:Body>
<ws:getHierarchyMetadata>
<ws:moduleId>6</ws:moduleId>
<ws:objectTypeId>106403</ws:objectTypeId>
</ws:getHierarchyMetadata>
</soapenv:Body>
</soapenv:Envelope>
Sample response
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body>
<getHierarchyMetadataResponse xmlns="http://ws.tririga.com">
<out>
<childBaseObjectTypes xsi:nil="true" xmlns="http://dto.ws.tririga.com"/>
<children xmlns="http://dto.ws.tririga.com">
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10008239</id>
<name>triVerticalShaft</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10002873</id>
<name>triSpace</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002582</id>
<name>triFloor</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002599</id>
<name>triProposedSite</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10002585</id>
<name>triLand</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10008239</id>
<name>triVerticalShaft</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10008239</id>
<name>triVerticalShaft</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10002873</id>
<name>triSpace</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002582</id>
<name>triFloor</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002100</id>
<name>triBuilding</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002586</id>
<name>triProperty</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10002585</id>
<name>triLand</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10008239</id>
<name>triVerticalShaft</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10008239</id>
<name>triVerticalShaft</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
<HierarchyObjectType>
<childBaseObjectTypes xsi:nil="true"/>
<children/>
<id>10002873</id>
<name>triSpace</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002582</id>
<name>triFloor</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id>10002100</id>
<name>triBuilding</name>
<rootOfHierarchy>false</rootOfHierarchy>
</HierarchyObjectType>
</children>
<id xmlns="http://dto.ws.tririga.com">106403</id>
<name xmlns="http://dto.ws.tririga.com">Location</name>
<rootOfHierarchy xmlns="http://dto.ws.tririga.com">true</rootOfHierarchy>
</out>
</getHierarchyMetadataResponse>
</soap:Body>
</soap:Envelope>