> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Storage Policy Operations

REST API - GET Storage Policy Search Engine List

Updated

This operation returns the list of search engines associated with a storage policy.

Request

Syntax

GET <webservice>/V2/StoragePolicy/{storagePolicyId}/SearchEngineProperties HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>

where <webservice> is the root path that routes the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

storagePolicyId

The system-generated ID of the storage policy.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token that you receive after successfully logging on. For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

id

The system-generated ID of the entity.

allEntities

name

The name of the entity.

allEntities

clientId

The system-generated ID of the client.

eeClient

clientName

The name of the client.

eeClient

errorCode

The possible error codes.

Valid values are:

  • 0, a successful completion.

  • 2, a failure.

  • a specific error code.

error

errorString

The description of the error code. Not all error codes have an error message.

error

Examples

Sample Request

GET <webservice>/V2/StoragePolicy/10/SearchEngineProperties HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<EVGui_ContentIndexingGetPropsResp>
    <header localeId="0" userId="0"/>
    <error errorCode="1" errorString=""/>
    <ciProps archGroupId="6" calendarId="1" cloudId="31183" contentIndexDataOver="0" dayNumber="0" deferredDays="0" enable="1" entityIds="" excludeDocTypes="" filterSelected="1" flags="4" includeDocTypes="*.bmp,*.csv,*.doc,*.docx,*.dot,*.eml,*.htm,*.html,*.jpeg,*.jpg,*.log,*.msg,*.odg,*.odp,*.ods,*.odt,*.pages,*.pdf,*.png,*.ppt,*.pptx,*.rtf,*.txt,*.xls,*.xlsx,*.xml" indexType="0" jobsOlderThan="0" maxDocSizeKB="51200" minDocSizeKB="0" numPeriod="1" retentionDays="-1" sourceCopyId="0" startTime="0" synchronizeOn="0" type="0">
        <allEntities id="1" name="SSN"/>
        <allEntities id="2" name="American CC"/>
        <allEntities id="3" name="VISA CC"/>
        <allEntities id="4" name="MasterCard CC"/>
        <allEntities id="5" name="Discover CC"/>
        <allEntities id="6" name="Routing Number"/>
        <allEntities id="7" name="Location"/>
        <allEntities id="8" name="US Phone number"/>
    </ciProps>
    <entityExtraction isConfigured="0">
        <entities enabled="0" entityId="1" entityName="Social Security number (SSN)"/>
        <entities enabled="0" entityId="9" entityName="Credit Card"/>
        <entities enabled="0" entityId="10" entityName="Email"/>
        <entities enabled="0" entityId="14" entityName="Bank Routing"/>
        <entities enabled="0" entityId="15" entityName="Individual Taxpayer Identification Number (ITIN)"/>
        <entities enabled="0" entityId="17" entityName="Hostname"/>
        <entities enabled="0" entityId="18" entityName="Finance Tags"/>
        <entities enabled="0" entityId="19" entityName="Finland Hetu"/>
        <entities enabled="0" entityId="20" entityName="France INSEE"/>
        <entities enabled="0" entityId="21" entityName="Greece AFM"/>
        <entities enabled="0" entityId="22" entityName="Greece Tautotita"/>
        <entities enabled="0" entityId="23" entityName="Germany PK"/>
        <entities enabled="0" entityId="24" entityName="Germany Steuer ID"/>
        <entities enabled="0" entityId="25" entityName="Germany VSNR"/>
        <entities enabled="0" entityId="29" entityName="DateParser"/>
        <entities enabled="0" entityId="30" entityName="Phone Number"/>
        <entities enabled="0" entityId="31" entityName="IP Address"/>
        <entities enabled="0" entityId="34" entityName="UK Nino"/>
        <entities enabled="0" entityId="35" entityName="UK NHS Number"/>
        <entities enabled="0" entityId="36" entityName="UK Driving License"/>
        <entities enabled="0" entityId="37" entityName="UK Passport"/>
        <entities enabled="0" entityId="38" entityName="Date"/>
        <entities enabled="0" entityId="39" entityName="Date of Birth"/>
        <entities enabled="0" entityId="40" entityName="Finland Passport"/>
        <entities enabled="0" entityId="41" entityName="France Passport"/>
        <entities enabled="0" entityId="42" entityName="Germany Passport"/>
        <entities enabled="0" entityId="43" entityName="Greece Passport"/>
        <entities enabled="0" entityId="44" entityName="Danish SSN"/>
        <entities enabled="0" entityId="45" entityName="Danish Passport"/>
        <entities enabled="0" entityId="46" entityName="Ireland PPSN"/>
        <entities enabled="0" entityId="47" entityName="Austria Passport"/>
        <entities enabled="0" entityId="48" entityName="Hungary Passport"/>
        <entities enabled="0" entityId="49" entityName="Italy Passport"/>
        <entities enabled="0" entityId="50" entityName="Sweden Passport"/>
        <entities enabled="0" entityId="51" entityName="Dutch SSN"/>
        <entities enabled="0" entityId="52" entityName="Australia Bank State Branch Code"/>
        <entities enabled="0" entityId="53" entityName="Australia Driving License"/>
        <entities enabled="0" entityId="54" entityName="Australia Medical Account Number"/>
        <entities enabled="0" entityId="55" entityName="Australia Passport"/>
        <entities enabled="0" entityId="56" entityName="Australia Tax File Number"/>
        <entities enabled="0" entityId="57" entityName="Health Insurance Claim Number"/>
        <entities enabled="0" entityId="58" entityName="Medicare Beneficiary Identifier"/>
        <entities enabled="0" entityId="59" entityName="Canada Social Insurance Number"/>
        <entities enabled="0" entityId="60" entityName="Canada Bank Transit Number"/>
        <entities enabled="0" entityId="61" entityName="Canada Health Service Number"/>
        <entities enabled="0" entityId="62" entityName="Canada Passport"/>
        <entities enabled="0" entityId="63" entityName="Canada PHIN"/>
        <entities enabled="0" entityId="64" entityName="Canada Ontario Driving License"/>
        <entities enabled="0" entityId="65" entityName="Canada Postal Code"/>
        <extractingClientList enabled="0">
            <eeClient clientId="5" clientName="V11AUTOMATIONSE"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="1032" clientName="QUANTUM2"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="2145" clientName="solr73_3"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="3496" clientName="lshtest02"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="3535" clientName="snatch"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="3739" clientName="bhuvi2"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="3801" clientName="watson"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="3934" clientName="yongtaoliu-pc"/>
        </extractingClientList>
        <extractingClientList enabled="0">
            <eeClient clientId="4169" clientName="theta_CA_test"/>
        </extractingClientList>
    </entityExtraction>
</EVGui_ContentIndexingGetPropsResp>