Skip to end of metadata
Go to start of metadata

Overview

Creates a new Storage Policy.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
storagePolicyStoragePolicyStorage folder filterMandatory

Response

Parameters of the API response:

ParameterType

Description

statusStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED
storagePolicyStoragePolicy

Examples


 Example CreateStoragePolicy transaction.
Example CreateStoragePolicy 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:createStoragePolicy>
         <token>n6nxbbGLZjFwpgGNubnS54f0FjZbkCjl</token>
         <storagePolicy>
            <action>export</action>
            <callFilter>WHERE section.owner_eid = '0000'</callFilter>
            <customSql>false</customSql>
            <decrypt>1</decrypt>
            <eid>0000</eid>
            <enabled>1</enabled>
            <engineId></engineId>
            <firstTranscode>0</firstTranscode>
            <format></format>
            <keepCdr>1</keepCdr>
            <languageId></languageId>
            <moveToRecycleBin>0</moveToRecycleBin>
            <name>Test Data Retention</name>
            <olderThanMinutes>0</olderThanMinutes>
            <olderThanYears>0</olderThanYears>
            <onlyForArchived>0</onlyForArchived>
            <priority>33</priority>

            <storageFolder>
               <id>2</id>
            </storageFolder>
            
         </storagePolicy>
      </v3:createStoragePolicy>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createStoragePolicyResponse 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>
               <engineId/>
               <firstTranscode>false</firstTranscode>
               <format></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>AKIAIDR3I26OLTLTJVKA</userLogin>
                  <userPassword>HR3Q74zh93GiU/T0FTFm0syhdfZereaIVLaZxuDN/drsOKVb2CuUBjoK8LeDn0ab</userPassword>
               </storageFolder>
            </storagePolicy>
         </return>
      </ns2:createStoragePolicyResponse>
   </S:Body>
</S:Envelope>
 Example CreateStoragePolicy transaction. Transcode to mp3.
Example CreateStoragePolicy transaction. Transcode to mp3.
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:createStoragePolicy>
         <token>n6nxbbGLZjFwpgGNubnS54f0FjZbkCjl</token>
         <storagePolicy>
            <action>export</action>
            <callFilter>WHERE section.owner_eid = '0000'</callFilter>
            <customSql>false</customSql>
            <decrypt>1</decrypt>
            <eid>0000</eid>
            <enabled>1</enabled>
            <engineId></engineId>
            <firstTranscode>0</firstTranscode>
            <format>mp3</format>
            <keepCdr>1</keepCdr>
            <languageId></languageId>
            <moveToRecycleBin>0</moveToRecycleBin>
            <name>Test Data Retention</name>
            <olderThanMinutes>0</olderThanMinutes>
            <olderThanYears>0</olderThanYears>
            <onlyForArchived>0</onlyForArchived>
            <priority>33</priority>

            <storageFolder>
               <id>2</id>
            </storageFolder>
            
         </storagePolicy>
      </v3:createStoragePolicy>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createStoragePolicyResponse 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>
               <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>AKIAIDR3I26OLTLTJVKA</userLogin>
                  <userPassword>HR3Q74zh93GiU/T0FTFm0syhdfZereaIVLaZxuDN/drsOKVb2CuUBjoK8LeDn0ab</userPassword>
               </storageFolder>
            </storagePolicy>
         </return>
      </ns2:createStoragePolicyResponse>
   </S:Body>
</S:Envelope>