App to App Objects (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 object-level interactions between applications. Optionally filter by source and/or target application to retrieve the specific objects that form links between a given pair of applications.

URI

GET /rest/app-to-app/objects

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.
source_app	string	No	Filter results to only include links originating from this application.
target_app	string	No	Filter results to only include links targeting this application.

Responses

application/json

Example:

{
  "total": 15,
  "limit": 10,
  "skip": 0,
  "results": [
    {
      "SourceFullName": "com.example.frontend.ApiClient.sendRequest",
      "SourceName": "sendRequest",
      "SourceType": "Java Method",
      "SourceApplication": "app-frontend",
      "LinkDirection": "OUTGOING",
      "Protocol": "HTTP",
      "Technology": "Java",
      "TargetFullName": "com.example.backend.Controller.handleRequest",
      "TargetName": "handleRequest",
      "TargetType": "Java Method",
      "TargetApplication": "app-backend"
    }
  ]
}

JSON representation

Property	Type	Description
total	integer	Total number of object-level 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 object-level app-to-app interactions.
results[].SourceFullName	string	The fully qualified name of the source object.
results[].SourceName	string	The short name of the source object.
results[].SourceType	string	The technology type of the source object (e.g., “Java Method”).
results[].SourceApplication	string	The name of the application containing the source object.
results[].LinkDirection	string	The direction of the link from the source object’s perspective (e.g., “OUTGOING”).
results[].Protocol	string	The communication protocol used for the interaction.
results[].Technology	string	The technology through which the interaction is established.
results[].TargetFullName	string	The fully qualified name of the target object.
results[].TargetName	string	The short name of the target object.
results[].TargetType	string	The technology type of the target object (e.g., “Java Method”).
results[].TargetApplication	string	The name of the application containing the target object.