Documentation Center

Reports 2.0 GetReferencedDocObj

Returns a list of all document objects referenced by the specified language part of the document object.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
psDocIdStringInThe logical identifier of the object
psVersionStringInThe version of the object. This version number has to be an exact number.
psLngStringInThe (working) language of the object
pbFullDepthBooleanInWhen set to true a drill down operation occurs to find all referenced objects
psXMLRequestedMetaDataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutObjectListStringInOutObjectList XML structure containing both the object content (base 64 encoded) and the requested metadata.

Some typical scenarios:
  • When the pbFullDepth parameter is set than all document objects referenced will be included in the result; otherwise only the directly referenced objects will be part of the result.
  • The first ishobject element of the object list returned will always contain information about the object provided through parameter psDocId for which the report is requested.
  • Referred objects will only occur once in the list.