Documentation Center

DocumentObj 2.5 RetrieveObjectsByIshLngRefs

Retrieves metadata and/or object content from Content Manager when the identifiers for the language levels (language reference card ids) are known.


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.
palLngRefsLongArrayInLong list with the unique identifiers of the language objects
psXmlProductDefinitionStringInProduct 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.
psOutXMLObjListStringOutObjectList 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.
Language reference card ids, also known as lngrefs, point exactly to the latest revision of a certain logical/version/language combination. So using a language reference card id directly bypasses the calculation algorithm to derive it from logical/version/language. This is used often when passing reasonable amounts of data, so they are typically made available in:
  • Inboxes
  • Baseline reports
  • Retrieve metadata
  • Custom events
Note that:
  • When a publishing context is provided, conditional publishing is only used for objects with electronic document type EDTXML. So xml objects and objects with a different electronic document type can be retrieved at the same time.