View All Connections

Use this REST API to view details for all of the connections saved in an application.

Required Roles

Service Administrator

REST Resource

GET /arm/rest/fcmapi/{api_version}/{module}/connections

Request

Parameters:

The following table summarizes the client request.

Table 17-56 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with (must be v1)	Path	Yes	None
module	The name of the module for which to view connections. For Account Reconciliation, set this value to RC.	Path	Yes	None

Example URL

https://<BASE-URL>/arm/rest/fcmapi/v1/rc/connections

Response

Supported Media Types: application/json

The following table summarizes the parameters.

Table 17-57 Parameters

Parameters	Description
items	Collection of information about the resource
id	Unique identifier for the connection, such as 1c89922d-92ba-46c1-850f-e2a8a416ddf2
type	The type of connection
url	The URL of the connection, such as https://<BASE-URL>
links	Detailed information about the link
details	In case of errors, details are published with the error string

Example Response

{
    "links": [
        {
            "rel": "self",
            "href": "http://<BASE-URL>/arm/rest/fcmapi/v1/rc/connections",
            "action": "GET"
        }
    ],
    "details": null,
    "items": [
        {
            "username": "ats_admin2",
            "password": null,
            "url": "https://<BASE-URL>",
            "id": 100000000558005,
            "type": "ENTERPRISE_JOURNALS"
        }
    ]
}