Documentation Center

PublicationOutput 2.5 Find

Retrieves all publication objects within the repository that match the criteria given in the metadata filter.


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.
peStatusFiltereISHStatusGroupInThe 'status category' in which an object has 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.
Some scenarios on what to expect as result depends on the used explicit and implicit filters:
  • When a filter is set on publication output/language level information (explicit by psXMLMetaDataFilter or implicit by psXMLRequestedMetaData or the option peStatusFilter) then every language-version of an object that meets the requirements is returned as separate ishobject element.
  • When the lowest specified level for metadata is the version level then every version of an object that meets the requirements is returned as separate ishobject element.
  • When only logical level information is needed, exactly one ishobject element is returned for every given logical identifier.
Note that:
  • 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.
  • When using the DOC-LANGUAGE field in psXMLMetaDataFilter all Publication Output objects that have this value as part of their Language combination field FISHPUBLNGCOMBINATION will match this criteria. For example, Publication Output objects with the following Language Combinations 'en+nl+fr', 'en', 'en+de' will ALL be a match when filtering on DOC-LANGUAGE 'en'. Use the FISHPUBLNGCOMBINATION field to find Publication Output objects having an exact language combination.