QueryComplexObjectsAndGetRelatedObjects Method - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

This is specifically for complex objects, which means Documents. Based on the Query method above, it allows criteria to be specified on the QuerySpecification and additional relationships to be retrieved via the ReturnSpecification. It only works by classdef and behind the scenes it retrieves the Master, Revision and Version objects. All the attributes are packaged together in one XFRItem. Revision and Version attributes are prefixed by Rev and Ver.

<XFRItem N="C056-000179" C="SPFDesignDocMaster">

  <XFRA V="e1DocStateRESERVED:RESERVED" N="SPFDocState" />

  <XFRA V="{5A83FC4C-2839-4B02-8688-C13C60392864}:3D documents" N="SPFDocCategory" />

  <XFRA V="{C23EA4F0-D9CB-4A0A-B9FF-0AA4D3C2B2D4}:Civil documents" N="SPFDocType" />

  <XFRA V="{434E685A-72A6-4FB0-823A-8EDBE07D7794}:Civil Details" N="SPFDocSubtype" />

  <XFRA V="40R0KQA" N="OBID" />

  <XFRA V="db6ae4f9-e5ca-4103-bcfe-c14804d9ea3b" N="UID" />

  <XFRA V="SPFAUTHORING" N="DomainUID" />

  <XFRA V="2010/09/26-20:52:32:716" N="CreationDate" />

  <XFRA V="9999/12/31-23:59:59:999" N="TerminationDate" />

  <XFRA V="2010/09/26-20:52:32:810" N="LastUpdatedDate" />

  <XFRA V="DM_C056-000179" N="UniqueKey" />

  <XFRA V="" N="Config" />

  <XFRA V="superuser" N="CreationUser" />

  <XFRA V="" N="TerminationUser" />

  <XFRA V="doc4" N="Description" />

  <XFRA V="C056-000179" N="Name" />

  <XFRA V="False" N="Rev.SPFRevUnderChangeInSameConfig" />

  <XFRA V="e1WORKING:Working" N="Rev.SPFRevState" />

  <XFRA V="A01" N="Rev.SPFExternalRevision" />

  <XFRA V="A" N="Rev.SPFMajorRevision" />

  <XFRA V="01" N="Rev.SPFMinorRevision" />

  <XFRA V="40R0KOA" N="Rev.OBID" />

  <XFRA V="5d1c432e-ed07-407a-8fdb-ae830c31a90c" N="Rev.UID" />

  <XFRA V="SPFAUTHORING" N="Rev.DomainUID" />

  <XFRA V="2010/09/26-20:52:32:716" N="Rev.CreationDate" />

  <XFRA V="9999/12/31-23:59:59:999" N="Rev.TerminationDate" />

  <XFRA V="2010/09/26-20:52:32:810" N="Rev.LastUpdatedDate" />

  <XFRA V="DM_C056-000179_A_01" N="Rev.UniqueKey" />

  <XFRA V="" N="Rev.Config" />

  <XFRA V="superuser" N="Rev.CreationUser" />

  <XFRA V="" N="Rev.TerminationUser" />

  <XFRA V="doc4" N="Rev.Description" />

  <XFRA V="C056-000179" N="Rev.Name" />

  <XFRA V="RevA01" N="Rev.+SPFDocRevisionRevisionScheme" />

  <XFRA V="False" N="Ver.SPFIsDocVersionSuperseded" />

  <XFRA V="1" N="Ver.SPFDocVersion" />

  <XFRA V="40R0KPA" N="Ver.OBID" />

  <XFRA V="daf12910-47cc-4c41-9193-c3386158a356" N="Ver.UID" />

  <XFRA V="SPFAUTHORING" N="Ver.DomainUID" />

  <XFRA V="2010/09/26-20:52:32:732" N="Ver.CreationDate" />

  <XFRA V="9999/12/31-23:59:59:999" N="Ver.TerminationDate" />

  <XFRA V="2010/09/26-20:52:32:810" N="Ver.LastUpdatedDate" />

  <XFRA V="DM_C056-000179_A_01_1" N="Ver.UniqueKey" />

  <XFRA V="" N="Ver.Config" />

  <XFRA V="superuser" N="Ver.CreationUser" />

  <XFRA V="" N="Ver.TerminationUser" />

  <XFRA V="doc4" N="Ver.Description" />

  <XFRA V="C056-000179" N="Ver.Name" />

  </XFRItem>

Above is the typical output produced for one complex object (document). This particular query specified a return specification to include the revision scheme related object (Rev.+SPFDocRevisionRevisionScheme).

Query specification examples

Primary classification

DESCRIPTION

NAME

VALUE

Primary classification

-SPFPrimaryClassification

3D Documents – can be OBID, UID or Name.

Master property Doc state

SPFDocState

e1DocStateRESERVED (has to be UID)

Revision scheme A1

Rev.+SPFDocRevisionRevisionScheme

RevA1

Revision rev status

Rev.SPFRevState

e1WORKING

Return specification examples

Rev.+SPFDocRevisionRevisionScheme – related to the revision.

-SPFPrimaryClassification – related to the master.

Interface-based query is not support with this web method because of the complexities involved in performing the queries across master, revision and version.