Object Start and End Points (Reserved)


Overview

Get the start points and end points connected to a specific object within a given number of hops.

URI

GET /rest/applications/{name}/objects/{id}/start-end-points

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.

id (integer)

The unique identifier of the object for which to retrieve start and end points.

Responses

application/json

A graph containing lists of start points and end points. Example:

{
  "results": {
              "startPoints": [
                {
                  "id": "2469",
                  "name": "scope_criteria.html",
                  "fullName": "§{main_sources}§/orion-apache/src/main/resources/apache/htdocs/pages/scope_criteria.html",
                  "type": "HTML Pages"
                }
              ],
              "endPoints": [
                {
                  "id": "442",
                  "name": "evaluation_version",
                  "fullName": "orion.evaluation_version",
                  "type": "PostgreSQL Table"
                },
                {
                  "id": "552",
                  "name": "milestone",
                  "fullName": "orion.milestone",
                  "type": "PostgreSQL Table"
                },
                {
                  "id": "20819",
                  "name": "getCurrentUser",
                  "fullName": "com.bmw.orion.authority.boundary.UserService.getCurrentUser",
                  "type": "Java Method"
                }
              ]
          }
}

JSON representation

PropertyTypeDescription
results.startPointsarrayList of objects that serve as entry points.
results.endPointsarrayList of objects that serve as exit/terminal points.
results.startPoints[].idstringThe object ID.
results.startPoints[].namestringThe object name.
results.startPoints[].fullNamestringThe object long name, usually locates the object in a software architecture.
results.startPoints[].typestringThe object type for a display.
results.endPoints[].idstringThe object ID.
results.endPoints[].namestringThe object name.
results.endPoints[].fullNamestringThe object long name, usually locates the object in a software architecture.
results.endPoints[].typestringThe object type for a display.