DocumentObj 2.5 Find
Used to identify all objects within the repository that match the criteria given in the metadata filter.
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. |
| psIshTypeFilter | String | In | The type of the objects that should match the filter. Allowed values are defined in the enumeration eISHType. |
| peStatusFilter | eISHStatusGroup | In | The status category of an object in order to return metadata |
| psXMLMetadataFilter | String | In | MetadataFilter XML structure with additional filter on metadata to limit the objects on which metadata has to be returned. |
| 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 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 language level information (explicit by
psXMLMetaDataFilteror implicit bypsXMLRequestedMetaDataor the optionpeStatusFilter) then every language-version of an object that meets the requirements is returned as separateishobjectelement. - 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
ishobjectelement. - When only logical level information is needed, exactly one
ishobjectelement is returned for every given logical identifier.
Note that:
- When filtering on version numbers in
psXMLMetaDataFilter, only exact version numbers can be used. - This function does not return the actual content of the objects. These can be retrieved by using DocumentObj.RetrieveObjectsByIshLngRefs.
- The metadata filter can specify metadata fields on logical, version and language level.
- The order of the returned objects in psOutXMLObjList is random.
- For baselines use the dedicated API function Baseline.GetBaselineList.
- For publications use the dedicated API function PublicationOutput.Find.
- The default value for the parameter psIshTypeFilter is: ISHModule, ISHMasterDoc, ISHIllustration, ISHLibrary, ISHTemplate.