GetStoragePolicyById (v3)

Overview

Returns a Storage Policy information by id.

The function is available as a Web Service request.

Request

Parameters of the API request:

Parameter	Type	Description	Requirements

Parameter	Type	Description	Requirements
token	String	API authentication token	Mandatory
id	Integer	The requested Storage Policy's id	Mandatory

Response

Parameters of the API response in GetStoragePolicyById type called return:

Parameter	Type	Description

Parameter	Type	Description
status	Status	Possible return values:
storagePolicy	StoragePolicy

Examples

Example GetStoragePolicyById 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:getStoragePolicyById>
         <token>n6nxbbGLZjFwpgGNubnS54f0FjZbkCjl</token>
         <id>3</id>
      </v3:getStoragePolicyById>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStoragePolicyByIdResponse 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>false</enabled>
               <firstTranscode>false</firstTranscode>
               <format>mp3</format>
               <id>3</id>
               <keepCdr>false</keepCdr>
               <moveToRecycleBin>false</moveToRecycleBin>
               <name>Amazon testy</name>
               <olderThanMinutes>0</olderThanMinutes>
               <olderThanYears>0</olderThanYears>
               <onlyForArchived>false</onlyForArchived>
               <priority>10</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>AKIAIDR3I26OLTLTJVKA</userLogin>
                  <userPassword>HR3Q74zh93GiU/T0FTFm0syhdfZereaIVLaZxuDN/drsOKVb2CuUBjoK8LeDn0ab</userPassword>
               </storageFolder>
            </storagePolicy>
         </return>
      </ns2:getStoragePolicyByIdResponse>
   </S:Body>
</S:Envelope>

Example GetStoragePolicyById 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:getStoragePolicyById>
         <token>n6nxbbGLZjFwpgGNubnS54f0FjZbkCjl</token>
         <id>6</id>
      </v3:getStoragePolicyById>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStoragePolicyByIdResponse 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>false</enabled>
               <firstTranscode>false</firstTranscode>
               <id>6</id>
               <keepCdr>false</keepCdr>
               <moveToRecycleBin>false</moveToRecycleBin>
               <name>EWS Test Export</name>
               <olderThanMinutes>0</olderThanMinutes>
               <olderThanYears>0</olderThanYears>
               <onlyForArchived>false</onlyForArchived>
               <priority>40</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://3rdpartyingestio.cloudapp.net/service/ThirdPartyIngestion.svc</serverName>
                  <storageType>ews</storageType>
                  <userLogin>Ingestion@VerbaTest.ccsctp.net</userLogin>
                  <userPassword>...............</userPassword>
               </storageFolder>
            </storagePolicy>
         </return>
      </ns2:getStoragePolicyByIdResponse>
   </S:Body>
</S:Envelope>