GetStoragePolicyByName (v3)

Overview

Returns a Storage Policy information by name.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
eidStringThe requested Storage Policy's eidMandatory
nameStringThe requested Storage Policy's nameMandatory

Response

Parameters of the API response in GetStoragePolicyByName type called return:

ParameterType

Description

statusStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED
storagePolicyStoragePolicy

Examples


 Example GetStoragePolicyByName transaction.
Example GetStoragePolicyByName transaction.
Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:getStoragePolicyByName>
         <token>kmViATcGv0fqsPgBMsiUn47Bm8U8l1WX</token>
         <eid>0000</eid>
         <name>ASDF002</name>
      </v3:getStoragePolicyByName>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStoragePolicyByNameResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <storagePolicy>
               <action>export</action>
               <callFilter>WHERE section.owner_eid = '0000'</callFilter>
               <customSql>false</customSql>
               <decrypt>true</decrypt>
               <eid>0000</eid>
               <enabled>true</enabled>
               <firstTranscode>false</firstTranscode>
               <id>1030</id>
               <keepCdr>false</keepCdr>
               <moveToRecycleBin>false</moveToRecycleBin>
               <name>ASDF002</name>
               <olderThanMinutes>0</olderThanMinutes>
               <olderThanYears>0</olderThanYears>
               <onlyForArchived>false</onlyForArchived>
               <priority>250</priority>
               <storageFolder>
                  <certPublic/>
                  <eid>0000</eid>
                  <emailTls>true</emailTls>
                  <exportTarget>true</exportTarget>
                  <exportTargetEveryone>true</exportTargetEveryone>
                  <id>8</id>
                  <name>EWS Test</name>
                  <path>Ingestion@VerbaTest.ccsctp.net</path>
                  <port>443</port>
                  <serverName>https://3rdpartyingestion.cloudapp.net/service/ThirdPartyIngestion.svc</serverName>
                  <storageType>ews</storageType>
                  <userLogin>Ingestion@VerbaTest.ccsctp.net</userLogin>
                  <userPassword>................</userPassword>
               </storageFolder>
            </storagePolicy>
         </return>
      </ns2:getStoragePolicyByNameResponse>
   </S:Body>
</S:Envelope>