Getting Resources

Usage

Returns a list of resources stored on the CMS repository according to a search pattern.

You can search for folders, universes, and connections. The search is targeted to meaningful business intelligence resources, therefore you cannot search for folders only.

Folders can be searched by identifier. Universes and connections can be searched by resource type and by folder identifier. If no folder identifier is specified, the search is performed on the root folder of the CMS repository.

Request

POST /searches

Request type: application/xml or application/json

Request body:

<search>
    <folder>
        <folderId>
    <connection>
        <type>
        <folderId>
    <universe>
        <type>
        <folderId>

Where:

  • <folderId> is the folder identifier. Is optional.
  • <type> is the universe type (unx or unv) or connection type (Relational, Olap, FlattenedOlap, or DataFederator). Is optional.
Response

Response type: application/xml or application/json

Response body: the list of folders, universes, and connections requested with the following information:

  • Folder ID, CUID, name and subfolder ID
  • Universe ID, CUID, name, type, and folder ID
  • Connection type and folder ID

Example

Searching for Universes from the Root Folder (XML)

Request and response types are application/xml.

Request body:

<search>
    <universe/>
</search>

Response:

<search>  
    <universe> 
        <id>6912</id>  
        <cuid>AViz5oUgKhRLrfeDYOPufRk</cuid>  
        <name>Refbeach</name>  
        <type>unv</type>  
        <folderId>532</folderId> 
    </universe> 
</search>

Example

Searching for Universes and Folders from the Root Folder (XML)

Request and response types are application/xml.

Request body:

<search>
    <folder/>
    <universe/>
</search>

Response:

<search> 
    <folder> 
        <id>6011</id>  
        <cuid>AVHaHy88GNRHmJCGmL6wBQo</cuid>  
        <name>CMSREF_UNIVERSES</name>  
        <folderId>532</folderId> 
    </folder>  
    <folder> 
        <id>7619</id>  
        <cuid>AZzzdaim0c9IoT9ZFnaimEU</cuid>  
        <name>MyUniverses</name>  
        <folderId>532</folderId> 
    </folder>  
    <universe> 
        <id>6912</id>  
        <cuid>AViz5oUgKhRLrfeDYOPufRk</cuid>  
        <name>Refbeach</name>  
        <type>unv</type>  
        <folderId>532</folderId> 
    </universe> 
</search>

Example

Searching for Folders and Universes in a Specific Folder (JSON)

The search is performed in the folder of ID 7619.

Request and response types are application/json.

Request body:

{"search":
     {"folder":
         {"folderId":"7619"},
     "universe":
         {"type":"unx", "folderId":"7619"}
     }
} 

Response:

{"search":
     {"folder": 
         {"id":"7619", "cuid":"AZzzdaim0c9IoT9ZFnaimEU", "name":"MyUniverses", "folderId":"532"},  
      "universe":[
         {"id":"7777", "cuid":"AbP4G5D9C6BMnOL6k0NzLpk", "name":"ADW.unx", "type":"unx", "folderId":"7619"},
         {"id":"7784", "cuid":"AdlMl0EJrmNCmQP0UUttgog", "name":"Beach For Calculations.unx", "type":"unx", "folderId":"7619"}]
     }      
}