Documentation Center

DocumentObj 2.0 GetDocObj [deprecated]

Retrieves a particular object version and language with necessary metadata from the Content Manager repository.


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
psVersionStringInOutThe version of the object. When no exact version is given, the version number will be returned.
psLngStringInThe (working) language of the object
psResolutionStringInThe resolution of the object. Only used for illustrations, for other object types this parameter has to be empty
psXMLMetadataFilterStringInMetadataFilter XML structure with additional filter on metadata to limit the objects on which metadata has to be returned
psXMLProductDefStringInProduct Definition XML structure that defines which publishing context has to be used for conditional publishing.
psXMLRequestedMetadataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutXMLObjListStringInOutObjectList XML structure containing both the object content (base 64 encoded) and the requested metadata.

Requirements are:
  • The user must have read access for the folder holding the object.
Note that:
  • All logical identifiers within Content Manager are in uppercase.
  • The option to expand a master document that was available within DocumentObj10.GetDocObj has been removed because:
    1. The baseline API makes it possible to expand according to latest available, latest approved or even version 1.
    2. DTDs are not preserved when expanding.
  • The result is no longer a bytestream with the requested object but an objectlist with the metadata and the requested object. This way metadata can also be returned for objects that are not XML and the returned metadata does not imply DTD modifications.