GetDocTypeHierarchy Method - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

This method returns the document hierarchy in XML format. The document hierarchy is structured as shown below and contains document categories, document types, and document subtypes. The XML contains the UID and the name for each doc category, type, and subtype.

<DocTypeHierarchy>

<DocCat UID="EE73" Name="Process Documents">

<DocType UID="EE877" Name="Instrument Process Datasheet"/>

</DocCat>

<DocCat UID="{E4528C47-83A9-11D6-BD6F-00104BCC2B69}" Name="WBS Documents">

<DocType UID="{6BDBDA13-9A8C-11D6-BDA3-00104BCC2B69}" Name="WBS Document">

<DocSubtype UID="{6BDBDA25-9A8C-11D6-BDA3-00104BCC2B69}"

Name="Project List"/>

<DocSubtype UID="{6BDBDA2B-9A8C-11D6-BDA3-00104BCC2B69}"

Name="Project Definition"/>

<DocSubtype UID="{0294705D-BAE4-4E1B-BFEC-88610D3A4FCE}"

Name="Project Breakdown"/>

</DocType>

</DocCat>

</DocTypeHierarchy>

Arguments

Name

Data type

Input/output

Description

oDocTypeHierarchy

DOMDocument

Output

The document type hierarchy in XML format that contains document categories, document types, and document subtypes from the SmartPlant Schema.

Return Value

0 if the method is successful.

A negative number if the method fails. (Check LastErrorMessage property for error message.)

Comments

None.