Skip to end of metadata
Go to start of metadata

Overview

Lists Storage Folders.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
filterStorageFolderFilterStorage folder filterMandatory

Response

Parameters of the API response:

ParameterType

Description

returnGetStorageFoldersRespose

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED

Examples


 Example ListStorageFolders transaction.
Example ListStorageFolders 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:listStorageFolders>
         <token>TvmWUbL3w0H5G1ajgh1fCjfc6wtOA537</token>
         <filter>
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
               <inactive>0</inactive>
               <!--  Needed if eid is not present
               <shortName></shortName>
               <shortNameExact></shortNameExact>
                -->
            </environmentFilter>
            <!-- <id></id> -->
            <!-- <name></name> -->
         </filter>
      </v3:listStorageFolders>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listStorageFoldersResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <storageFolders>
               <certPublic/>
               <eid>0000</eid>
               <emailTls>false</emailTls>
               <exportTarget>true</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>17</id>
               <name>AAA-TSM</name>
               <path>fileSpace</path>
               <storageType>tsm</storageType>
               <userLogin/>
               <userPassword>Ogrwt4OfRps=</userPassword>
            </storageFolders>
            <storageFolders>
               <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>
            </storageFolders>
            <storageFolders>
               <certPublic/>
               <eid>0000</eid>
               <emailTls>true</emailTls>
               <exportTarget>true</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>8</id>
               <name>EWS Test</name>
               <path>IngestionMbx@VerbaMsftTest.ccsctp.net</path>
               <port>443</port>
               <serverName>https://3rdpartyingestion.cloudapp.net/service/ThirdPartyIngestion.svc</serverName>
               <storageType>ews</storageType>
               <userLogin>IngestionMbx@VerbaTest.ccsctp.com</userLogin>
               <userPassword>............</userPassword>
            </storageFolders>
            <storageFolders>
               <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>............</userPassword>
            </storageFolders>
            <storageFolders>
               <eid>0000</eid>
               <emailTls>false</emailTls>
               <exportTarget>false</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>1</id>
               <name>Recycle Bin</name>
               <path>C:\Program Files (x86)\Verba\media\recycle-bin</path>
               <port>20111</port>
               <storageType>mr</storageType>
            </storageFolders>
            <storageFolders>
               <certPublic/>
               <eid>0000</eid>
               <emailTls>false</emailTls>
               <exportTarget>false</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>12</id>
               <name>RS1</name>
               <path>\\RS\SHARE</path>
               <storageType>nas</storageType>
               <userLogin>verbalabs\svc_storage3</userLogin>
               <userPassword>............</userPassword>
            </storageFolders>
            <storageFolders>
               <certPublic/>
               <eid>0000</eid>
               <emailTls>false</emailTls>
               <exportTarget>true</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>19</id>
               <name>SFTP - Storage Target</name>
               <path>/C:/sftp_verba/my_media_folder</path>
               <port>22</port>
               <serverName>192.168.1.141</serverName>
               <storageType>sftp</storageType>
               <userLogin>Administrator</userLogin>
               <userPassword>............</userPassword>
            </storageFolders>
            <storageFolders>
               <certPublic/>
               <eid>0000</eid>
               <emailFrom>info@verbalabs.com</emailFrom>
               <emailTls>true</emailTls>
               <exportTarget>true</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>14</id>
               <name>smtp test1</name>
               <path>olah@verba.com</path>
               <port>465</port>
               <serverName>smtp.gmail.com</serverName>
               <storageType>smtp</storageType>
               <userLogin>olah@verba.com</userLogin>
               <userPassword>............</userPassword>
            </storageFolders>
            <storageFolders>
               <certPublic/>
               <eid>0000</eid>
               <emailTls>false</emailTls>
               <exportTarget>true</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>16</id>
               <name>Tivoli</name>
               <path>VERBA</path>
               <storageType>tsm</storageType>
               <userLogin/>
               <userPassword>............</userPassword>
            </storageFolders>
         </return>
      </ns2:listStorageFoldersResponse>
   </S:Body>
</S:Envelope>
 
 Example ListStorageFolders, filtering for a specific Storage Folder name.
Example ListStorageFolders filtering for a specific Storage Folder name.
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:listStorageFolders>
         <token>TvmWUbL3w0H5G1ajgh1fCjfc6wtOA537</token>
         <filter>
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
               <inactive>0</inactive>
               <!--  Needed if eid is not present
               <shortName></shortName>
               <shortNameExact></shortNameExact>
                -->
            </environmentFilter>
            <!-- <id></id> -->
            <name>Amazon S3 Test</name>
         </filter>
      </v3:listStorageFolders>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listStorageFoldersResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <storageFolders>
               <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>
            </storageFolders>
         </return>
      </ns2:listStorageFoldersResponse>
   </S:Body>
</S:Envelope>