ListStoragePolicies (v3)

Overview

Lists Storage Policies.

The function is available as a Web Service request.

Request

Parameters of the API request:

Parameter	Type	Description	Requirements
token	String	API authentication token	Mandatory
filter	StoragePolicyFilter	Storage Policy filter	Mandatory

Response

Parameters of the API response:

Parameter

Type

Description

status

Status

Possible return values:

- OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED

storagePolicies

List<storagePolicies>

Examples

Example ListStoragePolicies transaction. Filter: eid == '0000' and action == 'upload'.

Example ListStoragePolicies transaction. Filter: eid == '0000' and action == 'upload'.

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:listStoragePolicies>
         <token>iVHqMY3IpaKOX7Vf5QHxoalxtQUwrtTt</token>
         <filter>
           <action>upload</action>
            <inactive>0</inactive>
            <!-- <name></name> -->
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
              <!--
              <shortName></shortName>
               <shortNameExact>?</shortNameExact>
               -->
               <inactive>0</inactive>
            </environmentFilter>
         </filter>
      </v3:listStoragePolicies>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listStoragePoliciesResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <storagePolicies>
               <action>upload</action>
               <callFilter>WHERE section.owner_eid = '0000'
  AND section.source_caller_id = 'xxx'</callFilter>
               <customSql>false</customSql>
               <decrypt>true</decrypt>
               <eid>0000</eid>
               <enabled>true</enabled>
               <firstTranscode>false</firstTranscode>
               <format>pcm16</format>
               <id>1022</id>
               <keepCdr>false</keepCdr>
               <moveToRecycleBin>false</moveToRecycleBin>
               <name>test-upload</name>
               <olderThanMinutes>0</olderThanMinutes>
               <olderThanYears>0</olderThanYears>
               <onlyForArchived>false</onlyForArchived>
               <priority>200</priority>
               <storageFolder>
                  <certPublic/>
                  <eid>0000</eid>
                  <emailTls>false</emailTls>
                  <exportTarget>false</exportTarget>
                  <exportTargetEveryone>true</exportTargetEveryone>
                  <id>18</id>
                  <name>mr-for-upload</name>
                  <path>c:\xyz</path>
                  <port>20111</port>
                  <serverName>mr</serverName>
                  <storageType>mr</storageType>
                  <userLogin/>
                  <userPassword>Ogrwt4OfRps=</userPassword>
               </storageFolder>
            </storagePolicies>
         </return>
      </ns2:listStoragePoliciesResponse>
   </S:Body>
</S:Envelope>

Example ListStoragePolicies transaction. Filter: eid == '0000' and name == 'Test Data Retention'.

Example ListStoragePolicies transaction. Filter: eid == '0000' and action == 'upload'.

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:listStoragePolicies>
         <token>iVHqMY3IpaKOX7Vf5QHxoalxtQUwrtTt</token>
         <filter>
           <!-- <action></action> -->
            <inactive>0</inactive>
            <name>Test Data Retention</name>
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
              <!--
              <shortName></shortName>
               <shortNameExact>?</shortNameExact>
               -->
               <inactive>0</inactive>
            </environmentFilter>
         </filter>
      </v3:listStoragePolicies>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listStoragePoliciesResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <storagePolicies>
               <action>export</action>
               <callFilter>WHERE section.owner_eid = '0000'</callFilter>
               <customSql>false</customSql>
               <decrypt>true</decrypt>
               <eid>0000</eid>
               <enabled>true</enabled>
               <engineId/>
               <firstTranscode>false</firstTranscode>
               <format>mp3</format>
               <id>1036</id>
               <keepCdr>true</keepCdr>
               <languageId/>
               <moveToRecycleBin>false</moveToRecycleBin>
               <name>Test Data Retention</name>
               <olderThanMinutes>0</olderThanMinutes>
               <olderThanYears>0</olderThanYears>
               <onlyForArchived>false</onlyForArchived>
               <priority>33</priority>
               <storageFolder>
                  <certPublic/>
                  <eid>0000</eid>
                  <emailTls>false</emailTls>
                  <exportTarget>false</exportTarget>
                  <exportTargetEveryone>true</exportTargetEveryone>
                  <id>2</id>
                  <name>Amazon S3 TEST</name>
                  <path>verbatest</path>
                  <serverName>eu-west-1</serverName>
                  <storageType>amazon_s3</storageType>
                  <userLogin>.................</userLogin>
                  <userPassword>..................................</userPassword>
               </storageFolder>
            </storagePolicies>
         </return>
      </ns2:listStoragePoliciesResponse>
   </S:Body>
</S:Envelope>