Documentation Center

DocumentObj 2.5 GetMetaData

Retrieves logical, version, language and resolution metadata information for one 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.
psLogicalIdStringInThe logical identifier of the object
psVersionStringInOutThe version of the object. When no exact version is given, the version number will be returned.
psLanguageStringInThe (working)language of the object
psResolutionStringInThe resolution of the object. Only used for illustrations, for other object types this parameter has to be empty
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 for the folder holding the object.
Some scenarios on what to expect as result depends on the used supplied parameters and the Requested Metadata XML:
  • When psLanguage is provided, one logical-version-language object is returned even if only metadata of the logical level is requested.
  • When the lowest specified level is the version level...
    • one logical-version object is returned even if only metadata of the logical level is requested
    • an exception is thrown when metadata of the language level is requested
  • When only logical level information is needed
    • exactly one ishobject element is returned
    • an exception is thrown when metadata of the language or version level is requested
Note that:
  • All logical identifiers within Content Manager are in uppercase.
  • When the Requested Metadata XML contains fields of the language level, the language must be supplied.
  • It is not possible to get baseline objects. Use the dedicated API.
  • For publications use the dedicated API function PublicationOutput.GetMetaData.