Level Nodes

Draft

Retrieve nodes of a level (from 2 to 5) matching a name, or a volatile identifier.
The children nodes of the next level are included.
When the node is a level 5 node, the children are objects with a permanent ID.
The children are sorted by name.

As a use case, the following URI reports all target objects of Java unclassified API for application Shopizer_2_17_0:
/rest/applications/Shopizer_2.17.0/levels/5/nodes?select=children&name=API%20-%20Java%20unclassified

URI

  • GET /rest/applications/{name}/levels/{level}/nodes?name={string}&select=children
  • GET /rest/applications/{name}/levels/{level}/nodes?_id={integer}&select=children

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.
  • level (integer):
    The taxonomy level.

Query Parameters

  • name (string), required if _id is not present:
    A substring of the node name to match. The matching is case insensitive.
    The string must be properly encoded if it is required (character “&” must be encoded with “%26”).
  • _id (integer), required if name is not present:
    A volatile and local ID to identify a node in the scope of the ‘Level’ graph.
  • select (string), required:
    Force to retrieve the list of children nodes for each node. The value children is required.

Responses

  • application/json:

    A list of nodes matching the input name, and for each node, the list of aggregated nodes (or objects for a level 5 node).

    Level is between 2 and 4

    [
  {
    "_id": 263283,
    "level": 2,
    "name": "Batch Services",
    "children": [
      {
        "_id": 263282,
        "name": "Script Batch Interfaces"?
        "level": 3
      }
    ]
  }
]

    JSON Representation

    Property Type Description
    nodes[]._id integer A volatile and local ID to identify a node in the scope of the ‘Level’ graph. This ID cannot be used as a path parameter for any URI.
    nodes[].name string The parent node name
    nodes[].level integer The parent node level
    nodes[].children[]._id integer This is a volatile and local ID to identify a child node in the scope of the ‘Level’ graph. This ID cannot be used as a path parameter for any URI.
    nodes[].children[].name integer The child node name.
    nodes[].children[].level integer The child node level.

    Level is 5

    [
  {
    "_id": 263300,
    "name": "API itextpdf",
    "level": 5,
    "children": [
      {
        "id": "419",
        "name": "VerticalAlignment",
        "fullName": "com.itextpdf.layout.properties.VerticalAlignment",
        "type": "Java Enum",
        "typeId": "JV_ENUM"
      }
      {
        "id": "1026",
        "name": "ElementPropertyContainer<T extends com.itextpdf.layout.IPropertyContainer>",
        "fullName": "com.itextpdf.layout.ElementPropertyContainer",
        "type": "Generic Java Class",
        "typeId": "JV_GENERIC_CLASS"
      }
    ]
  }
]

    JSON Representation

    Property Type Description
    nodes[]._id integer A volatile and local ID to identify a node in the scope of the ‘Level’ graph. This ID cannot be used as a path parameter for any URI.
    nodes[].name string The parent node name
    nodes[].level integer The parent node level which is 5.
    nodes[].children[].id string The object ID.
    nodes[].children[].name string The object name.
    nodes[].children[].fullName string The object long name, usually locates the object in a software architecture.
    nodes[].children[].type string The object type for a display.
    nodes[].children[].typeId string The object type identifier is the type reference key.