PublicationOutput 2.5 TryGetMetadata
Tries to retrieve logical, version, language and resolution metadata information for one publication.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated 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. |
| psLogicalId | String | In | The logical identifier of the object |
| psVersion | String | InOut | The version of the object. When no exact version is given, the version number will be returned. |
| psOutputFormat | String | In | The name of the output format (e.g. Manual, Online Documentation, Booklet, Compiled Help,...) |
| psLngCombination | String | In | The ordered list of languages separated by the '+' character indicating the languages used in the content of the object. |
| psXMLRequestedMetadata | String | In | Requested Metadata XML structure indicating which metadata has to be retrieved for a given object. |
| psOutXMLObjList | String | Out | ObjectList 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
psOutputFormatandpsLngCombinationare 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
ishobjectelement is returned - an exception is thrown when metadata of the language or version level is requested
- exactly one
Note that:
- All logical identifiers within Content Manager are in uppercase.
- When the
Requested Metadata XMLcontains fields of the language level, the outputformat and the language combination must be supplied.
Requested metadata:
<ishfields>
<ishfield name="VERSION" level="version"/>
<ishfield name="DOC-LANGUAGE" level="lng"/>
<ishfield name="FISHPUBLNGCOMBINATION" level="lng"/>
<ishfield name="FISHOUTPUTFORMATREF" level="lng"/>
<ishfield name="FTITLE" level="logical"/>
<ishfield name="FISHPUBSTATUS" level="lng"/>
<ishfield name="FISHEVENTID" level="lng"/>
<ishfield name="FISHPUBLISHER" level="lng"/>
</ishfields>
Resulting ObjectList XML:
<ishobjects>
<ishobject ishlngref="15449" ishversionref="14063" ishlogicalref="8649" ishref="GUID-169AD55B-7316-4630-AEDD-6E4081778B00" ishtype="ISHPublication">
<ishfields>
<ishfield name="VERSION" level="version">6</ishfield>
<ishfield name="DOC-LANGUAGE" level="lng">en, fr, nl</ishfield>
<ishfield name="FISHPUBLNGCOMBINATION" level="lng">en+fr+nl</ishfield>
<ishfield name="FISHOUTPUTFORMATREF" level="lng">Manual</ishfield>
<ishfield name="FTITLE" level="logical">InfoShare_Documentation Set</ishfield>
<ishfield name="FISHPUBSTATUS" level="lng">Out-of-date</ishfield>
<ishfield name="FISHEVENTID" level="lng">148 tridt03 20071206 15:40:59</ishfield>
<ishfield name="FISHPUBLISHER" level="lng">Admin</ishfield>
</ishfields>
</ishobject>
</ishobjects>