Filter Based on Custom Properties

Updated

On this page

Add this filter to search or list results that match a specific custom property.

<DM2ContentIndexing_CVSearchReq mode="">  <advSearchGrp>     <fileFilter>       <filter>         <filters field="">           <fieldValues>             <values val="" />           </fieldValues>         </filters>       </filter>     </fileFilter>   </advSearchGrp> 

</DM2ContentIndexing_CVSearchReq>

Parameters

The following table displays the parameters for the request body.

Name

Description

Elements

mode

The interface to perform the search. Valid values are:

  • Compliance

  • EndUser

  • Admin

  • WebConsole

DM2ContentIndexing_CVSearchReq

field

The custom property name.

To specify the data type, enter DATA_TYPE as the field value, and then specify one of the following values:

  • 1: File

  • 2: Email

  • 3: SharePonit

  • 4: Folder

  • 5: Mailbox

    For example:

    <filters field="DATA_TYPE">  <fieldValues>    <values val="2" />  </fieldValues>

    </filters>

filters

val

The custom property value. Files and folders with the specified custom property value will be listed or searched.

For the modified time property, provide the value in UNIX timestamp format (in seconds). For example, 1424813723.

dvalue

Examples

Filters for email data.

<DM2ContentIndexing_CVSearchReq mode="Compliance">  <advSearchGrp>    <emailFilter interGroupOP="0" interGroupOPStr="OR">      <filter interFilterOP="2" interFilterOPStr="OR">        <shareFolder>          <flags include="0" deleted="0" exclude="0" disabled="\" includeAll="0" />        </shareFolder>        <filters field="EMAIL_TO" intraFieldOpStr="OR">          <fieldValues>            <values val="*@example.com" />          </fieldValues>        </filters>        <filters field="EMAIL_FROM" intraFieldOpStr="OR">          <fieldValues>            <values val="*@Example.com" />          </fieldValues>        </filters>      </filter>    </emailFilter>    <commonFilter>      <filter>        <filters  field="DATA_TYPE">          <fieldValues>            <values val="2" />          </fieldValues>        </filters>      </filter>    </commonFilter>    <cvSearchKeyword keyword="" />    <cvSearchCondition />  </advSearchGrp>  <searchProcessingInfo resultOffset="4" pageSize="1" sampleSize="1">  </searchProcessingInfo>

</DM2ContentIndexing_CVSearchReq>

To list files that have a modified time between 1434945600 and 1435550400:

POST <webservice>/<REST_API> HTTP/1.1

Host: client.mydomain.com

Accept: application/xml

Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Content-type: application/xml

<DM2ContentIndexing_CVSearchReq >

  <advSearchGrp>

   <fileFilter>

     <filter>

      <filters field="MODIFIEDTIME">

       <fieldValues>

        <values val="1434945600" />

        <values val="1435550400" />

       </fieldValues>

     </filters>

    </filter>

   </fileFilter>

</advSearchGrp>

</DM2ContentIndexing_CVSearchReq>

To list files and folders that are assigned a specific custom property name:

POST <webservice>/<REST_API> HTTP/1.1

Host: client.mydomain.com

Accept: application/xml

Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Content-type: application/xml

<DM2ContentIndexing_CVSearchReq >

  <advSearchGrp>

   <fileFilter>

     <filter>

      <filters field="Prop1">

       <fieldValues>

        <values val="value1" />

       </fieldValues>

     </filters>

    </filter>

   </fileFilter>

</advSearchGrp>

</DM2ContentIndexing_CVSearchReq>