Expands a name relationship or list of relationships from a source object, the relationship can be described by either providing a pathdefn or just providing the class of the related object.
Inputs
-
ClassDef
-
Name
-
Array of relationships to expand. Accepted inputs are
-
Path definition – reldef prefixed by +/-
-
Or the classdef of the related object, such as, SPFFolder
-
Only return rels created since date – can be nothing, filters the rels returned
-
Return full details – rather than the simple view
-
An example of both types of input are,
-
SPFFolder
-
-SPFFolderPlantItem
Both the above are describing the same relationship definition between a DEVTag and a SPFFolder; however, each is using a different method to obtain the same result.
Relationships can be strung together and only requires to be comma separated,
-
SPFFolder,SPFEquipmentClass
-
-SPFFolderPlantItem,-SPFPrimaryClassification
Outputs
Transfer object sends back either the related items in the simple data transfer view or the full view. This is determined by the flag on the web method.
<XFRDataTransferSourceUTCDateYYYYMMDD="2010/02/05-15:06:24:626" Description="Relationships for DEVTag 20CB201" Source="GetRelationshipsForSingleObject">
<XFRConfiguration Plant="" xmlns="http://localhost/SPF40Server/" />
<XFRItems xmlns="http://localhost/SPF40Server/">
<XFRItem N="20CB201" C="SPFFolder">
<XFRA V="SPFFolder" N="Class" />
<XFRA V="Apex-PlantA-001" N="Name" />
<XFRA V="A18000A" N="OBID" />
<XFRA V="SPF" N="DomainUID" />
<XFRA V="SPF" N="UID" />
<XFRA V="001 PlantA" N="Description" />
</XFRItem>
<XFRItem N="20CB201" C="SPFEquipmentClass">
<XFRA V="SPFEquipmentClass" N="Class" />
<XFRA V="DEV Battery bank" N="Name" />
<XFRA V="0RX068A" N="OBID" />
<XFRA V="SPFREFERENCE" N="DomainUID" />
<XFRA V="SPFREFERENCE" N="UID" />
<XFRA N="Description" />
</XFRItem> </XFRItems>
</XFRDataTransfer>