Annotation 2.5 RetrieveMetadata
Describe how to retrieve the metadata information for annotations (and replies).
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. |
| pasAnnotationIds | StringArray | In | List of strings with element names of annotations |
| psXMLMetadataFilter | String | In | Annotation Metadata Filter XML structure with additional filter on metadata to limit the annotations on which metadata has to be returned. |
| psXMLRequestedMetadata | String | In | Requested Annotation Metadata XML structure indicating which metadata has to be retrieved for the annotations |
| psOutXMLObjList | String | InOut | The Annotation ObjectList XML structure containing the metadata of the annotations (and replies) |
Note that:
- All logical identifiers within Content Manager are in uppercase.
- The order of the returned objects in
psOutXMLObjListis random.
Scenarios
Depending on the requested metadata and the filter metadata annotations, without replies are returned or not.
Here are possible scenarios:
| Scenario | Annotation without replies | Annotation with replies |
|---|---|---|
| Retrieve only annotation information. | The requested metadata of the annotation is returned. | Only the information of the annotation is returned. |
| Retrieve annotation and reply information without filtering. | The requested metadata of the annotation is returned. | The requested information of the annotation and the replies are returned. |
| Retrieve annotation and reply information, but filter only on the 'annotation' level. | The requested metadata of the annotation is returned (if the annotation matches the filtering). | The requested information of the annotation and the replies are returned (if the annotation matches the filtering). |
| Filter on annotation and reply information. | The annotation is not returned because, by definition, it cannot match the filtering on the reply information. | The requested information of the annotation and the replies are returned (if the annotation and the reply match the filtering). |