streamedSearchRequest

Used to provide a cursor-like search over a document library. You pass the lastHitId element value from the last streamedSearchResponse in the next streamSearchRequest until you get back an empty list or a null lastHitId element. --For GroupWise 2012 and later.

Request

<streamedSearchRequest>
  <container type="types:uid" />
  <view type="string" />
  <filter type="types:Filter" />
  <count type="int" />
  <lastHitId type="xs:string" />
</streamedSearchRequest>

Response

<streamedSearchResponse>
  <items type="types:Items" />
  <lastHitId type="string" />
  <status type="types:Status" />
</streamedSearchResponse>

Elements

container

(optional) Specifies the library container ID. If the container is not specified, the filter is used. If the filter is not present, an error is returned.

view

Specifies the elements returned for each item. The view reduces the amount of data returned. If a view is not specified, all item elements are returned.

filter

Specifies the items to return based on a filter.

items

Specifies a list of item ids to return.

count

Specifies the number of items to return. If the count element is -1, all items are returned.

items

Returns the specified items.

code

Specifies the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Example

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <filter>
    <element type="FilterEntry">
      <op>contains</op>
      <field>subject</field>
      <value>test</value>
    </element>
  </filter>
  <count>5</count>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201326849_121_5</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201326849_121_5</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201327105_15_12</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201327105_15_12</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201327617_22_17</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearhResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201327617_22_17</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201327873_20_22</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201327873_20_22</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201328385_215_27</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201328385_215_27</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201328897_25_32</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201328897_25_32</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <items>
...
  </items>
  <lastHitId>201328897_9_37</lastHitId>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>

<streamedSearchRequest>
  <container>domain.PO1.PO1 Library@67</container>
  <count>5</count>
  <lastHitId>201328897_9_37</lastHitId>
</streamedSearchRequest>

<streamedSearchResponse>
  <status>
    <code>0</code>
  </status>
</streamedSearchResponse>