View All Connections
Use this REST API to view details for all of the connections saved in an application.
This API supports paging, so you can filter the number of connections you see in the output using the offset and limit parameters shown in the table.
Required Roles
Service Administrator
REST Resource
GET /HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections
Request
Supported Media Types: application/json
Parameters:
The following table summarizes the client request.
Table 8-112 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are developing with | Path | Yes | None |
application |
The name of the application for which to view connections | Path | Yes | None |
offset |
For paging of jobs. Indicates the actual index from which the records are returned. It is 0 based. | Query | No | 0 |
limit |
For paging for jobs. Controls how many items to return. Defaults to 25 if not specified. | Query | No | 25 |
Example URL
https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections?offset=2&limit=2
Response
The following table summarizes the parameters.
Table 8-113 Parameters
Parameters | Description |
---|---|
items |
Collection of information about the resource |
id |
Unique identifier for the connection, such as 1c89922d-92ba-46c1-850f-e2a8a416ddf2 |
name |
Name of the connection, such as Connection29 |
description |
Description of the connection, such as Planning |
url |
The URL of the connection, such as https://<BASE-URL>/HyperionPlanning |
username |
The username for the connection, such as admin |
domain |
The domain name for the connection |
modified |
The time stamp of the last modification to the connection details, such as 2021-01-18 12:23:49.0 |
modifiedBy |
The last service administrator to modify the connection details, such as admin |
Example Response
The identity domain information as shown as part of the response.
{
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections?offset=2&limit=2",
"action": "GET",
"rel": "self",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections?offset=0&limit=2",
"action": "GET",
"rel": "prev",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections?offset=4&limit=2",
"action": "GET",
"rel": "next",
"data": null
}
],
"items": [
{
"id": "1c89922d-92ba-46c1-850f-e2a8a416ddf2",
"name": "Connection20",
"url": "https://<BASE-URL>/HyperionPlanning",
"username": "admin",
"modified": "2021-01-18 12:23:49.0",
"modifiedBy": "admin",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections/1c89922d-92ba-46c1-850f-e2a8a416ddf2",
"action": "GET",
"rel": "Self",
"data": null
}
]
},
{
"id": "ec94a10e-717b-449a-89ce-0c16b1688caa",
"name": "Connection29",
"url": "https://<BASE-URL>/HyperionPlanning",
"username": "admin",
"domain": "<DOMAIN_NAME>",
"modified": "2021-01-18 12:23:49.0",
"modifiedBy": "admin",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/epm/v1/applications/epbcs1/connections/ec94a10e-717b-449a-89ce-0c16b1688caa",
"action": "GET",
"rel": "Self",
"data": null
}
]
}
],
"type": null
}