Collection list operation

The listCollections operation returns a list of all the collections in a data domain.

listCollections syntax

The syntax for the listCollections operation is:
<listCollections>
   <outerTransactionId>?</outerTransactionId>
   <language>en</language>
</listCollections>

The outerTransactionId and language attributes are optional.

listCollections example

The following is an example of making a listCollections call from soapUI:
<soapenv:Envelope 
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:ns="http://www.endeca.com/endeca-server/sconfig/3/0">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:listCollections>
         <ns:language>en</ns:language>
      </ns:listCollections>
   </soapenv:Body>
</soapenv:Envelope>

listCollections response

The list of returned collections might look like this example:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <ns2:listCollectionsResponse xmlns:ns2="http://www.endeca.com/endeca-server/sconfig/3/0">
         <ns2:collectionRecord collectionKey="ProductRecs" displayName="Product records" uniquePropertyKey="ProductId">
            <ns2:description>Collects product records in the system</ns2:description>
            <ns2:property key="PriceUnits">US dollars</ns2:property>
            <ns2:collectionAttributes/>
         </ns2:collectionRecord>
         <ns2:collectionRecord collectionKey="SalesRecs" displayName="Sales orders" uniquePropertyKey="SalesOrderCol">
            <ns2:description>Collects the sales order records in the system</ns2:description>
            <ns2:property key="Locale">New England</ns2:property>
            <ns2:collectionAttributes/>
         </ns2:collectionRecord>
      </ns2:listCollectionsResponse>
   </env:Body>
</env:Envelope>

The operation shows that the data domain currently has two collections defined: ProductRecs and SalesRecs.