Object Relationships (Reserved)

Overview

Get the relationship graph (nodes and edges) for a set of objects in an application. This endpoint returns a graph representation showing how multiple objects are connected through various relationship types.

URI

POST /rest/applications/{name}/objects/relationships?linkMode=direct

Path parameters

name (string)

This parameter identifies the analyzed application. The application name must be properly encoded if it is required. Character back-quote is not allowed.

Query parameters

linkMode (string)

Optional, default: direct:

• linkMode=direct: only direct links are included in the response (excludes escalated links).
• linkMode=escalated: only escalated/reference links are included in the response.
• linkMode=all: both direct and escalated links are included in the response.

Request Body

application/json

The request body must contain an array of object IDs to retrieve relationships for:

{
  "objectIds": ["1234", "5678", "9012"]
}

Request Body Fields

Responses

application/json

A graph representation containing nodes and edges. Example:

{
  "nodes": [
    {
      "id": "1234",
      "data": {
        "name": "OrderService",
        "type": "Java Class",
      }
    },
    {
      "id": "5678",
      "data": {
        "name": "ProductService",
        "type": "Java Class",
      }
    }
  ],
  "edges": [
    {
      "source": "1234",
      "target": "5678",
      "type": "CALL",
      "isEscalated": false
    }
  ],
  "warnings": []
}

JSON representation

Response Object

Node Object

Edge Object