Getting the List of Connections

Returns the list of connections stored in the CMS repository that the end-user has access to.

Request

GET <webiURL>/connections?type={type}&offset={offset}&limit={limit}

Where:

  • {type} indicates the connection type to be retrieved. Values are Relational, FlattenedOlap, Olap or DataFederator. This parameter is optional. The default is none.
  • {offset} indicates the position in the list, from which connections are returned. {offset} must be greater than or equal to 0. This parameter is optional. The default value is 0.
  • {limit} indicates the number of connections that you can list on one page. {limit} range is [1, 50]. This parameter is optional. The default value is 10.
Response

Response type: application/xml or application/json

Example

Request without Parameters

GET <webiURL>/connections

XML response:

<connections>
    <connection type="Olap"> 
        <id>6100</id>  
        <cuid>AbpsL1MVilFPoM.RfGB02m0</cuid>  
        <name>AAQUEY_HIERNODE_01</name>  
        <folderId>6069</folderId> 
    </connection>      
    <connection type="Relational"> 
        <id>5993</id>  
        <cuid>AbL85pdeN7NOqNjd1j0btlA</cuid>  
        <name>BOF_ERP_en_UK_Save_Lang_IDT</name>  
        <folderId>5971</folderId> 
    </connection>  
    <connection type="FlattenedOlap"> 
        <id>6118</id>  
        <cuid>ARgmu_R0AQhDvJFmrHnP5F0</cuid>  
        <name>BW_VAR_FORMULA</name>  
        <folderId>6069</folderId> 
    </connection>   
    <connection type="DataFederator"> 
        <id>6196</id>  
        <cuid>AYATF1eY_8RPt0LWH4Vcfug</cuid>  
        <name>DF data source BW</name>  
        <folderId>548</folderId> 
    </connection>  
    ...  
</connections>

Example

Request With Parameters

GET <webiURL>/connections?limit=3&offset=2&type=FlattenedOlap

JSON response:

{"connections":
    {"connection":
        [{"@type":"FlattenedOlap",
          "id":6117,
          "cuid":"AZHZlbdSX85LmE3U7dsC120",
          "name":"BW_VAR_KD_DEFVAL",
          "folderId":6069},
         {"@type":"FlattenedOlap",
          "id":6112,
          "cuid":"Adr6Epit67FPu_0JebFfgqY",
          "name":"BW_VAR_RANGE",
          "folderId":6069},
         {"@type":"FlattenedOlap",
          "id":6110,
          "cuid":"AQ5UAwvV1ptJhuNBzYmdXTw",
          "name":"BW_VAR_TEXT",
          "folderId":6069}
        ]
    }
}