GetSearchMetadataResponse Element

System.Object
  ObjectSetType
    GetSearchMetadataResponse
Client Declaration
  public class GetSearchMetadataResponse
Represents a collection of objects as the output of the GetSearchMetadata operation. GetSearchMetadataResponse can represent a complete collection or only a portion (page) of a collection.

Element Structure

Attributes
  • String metadataEpochId: [response] Optional expression specifying a unique ID labeling the particular state of the metadata for the search scope, guaranteed to change only when the metadata of the scope changes.

Base Element Inheritance

Elements
  • CollectionTerminatorType CollectionTerminator: [response] Optional element specifying the status of navigation within an object set collection. Resolves to one of the following elements, depending on navigation status:
    • EndOfCollection: The last result row is included in this response. If the end of the page coincides with the end of the collection (this can occur if the collection contains an exact multiple of the page size) EndOfPage is returned instead.
    • EndOfPage: The object set contains the maximum number of object elements (page size) requested by the client.
    • TraversalError: A error has occurred in traversing the object set.
  • ObjectValue[] Object: [response] Optional element specifying an array of Content Engine objects selected by the search.

XML Schema

<xsd:element name="GetSearchMetadataResponse">
   <xsd:complexType>
      <xsd:complexContent>
         <xsd:extension base="ObjectSetType">
            <xsd:attribute name="metadataEpochId" type="xsd:string"/>
         </xsd:extension>
      </xsd:complexContent>
   </xsd:complexType>
</xsd:element>