Documentation Center

DocumentObj 2.5 ContainingLogicalId

The method returns the objects which reference the supplied logical object. For example: the maps in which a topic is used/referenced.


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.
psLogicalIdStringInThe logical identifier of the object.
peLinkTypeeLinkTypeInThe enumeration indicating which link fields must be used.
psIshTypeFilterStringInThe type of the objects that should match the filter. Allowed values are defined in the enumeration eISHType.
peStatusFiltereISHStatusGroupInThe status category of an object in order to return metadata
psXMLMetadataFilterStringInMetadataFilter XML structure with additional filter on metadata to limit the objects on which metadata has to be returned.
psXMLRequestedMetadataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutXMLObjListStringOutObjectList XML structure containing the metadata of the objects.

Requirements are:
  • The user must have read access to the object which the logged on user is trying to find.
  • The supplied logical object must exist and the user must have read access to this logical object.
Note that:
  • All logical identifiers within Content Manager are in uppercase.
  • Conditions are ignored.
  • Only the direct parents are returned...So, only one level up.
  • This method will always return language objects as separate ishobject element.
  • When filtering on version numbers in psXMLMetaDataFilter, only exact version numbers can be used.
  • The metadata filter can specify metadata fields on logical, version and language level.
  • The order of the returned objects in psOutXMLObjList is random.
  • The default value for the parameter psIshTypeFilter is: ISHModule, ISHMasterDoc, ISHIllustration, ISHLibrary, ISHTemplate.