App to App (RESERVED)
RESERVED: The keyword RESERVED annotation means that the API is available for use but is not yet part of the officially supported specification. Its behavior, interface, or output may change in future releases without backward compatibility guarantees.
Overview
Get a list of application-to-application links across the entire domain, showing the protocol, technology, and link count between each pair of applications.
URI
GET /rest/app-to-app
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | Yes | Maximum number of results to return. |
| skip | integer | No | Number of results to skip for pagination. Defaults to 0. |
Responses
application/json
Example:
{
"total": 42,
"limit": 10,
"skip": 0,
"results": [
{
"SourceApp": "app-frontend",
"TargetApp": "app-backend",
"Protocol": "HTTP",
"Technology": "Java",
"Links": "5"
}
]
}
JSON representation
| Property | Type | Description |
|---|---|---|
| total | integer | Total number of app-to-app links available. |
| limit | integer | Maximum number of results returned in this response. |
| skip | integer | Number of results skipped. |
| results | array of objects | The list of app-to-app links. |
| results[].SourceApp | string | The name of the source application. |
| results[].TargetApp | string | The name of the target application. |
| results[].Protocol | string | The communication protocol used between the two applications. |
| results[].Technology | string | The technology through which the link is established. |
| results[].Links | string | The number of distinct links from the source to the target application. |