Find Objects

Overview

Retrieve the list of objects according to a set of filters specified with query parameters:

• The objects are sorted by name.

URI

GET /rest/applications/{name}/objects?limit={number}

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

limit (integer)

Required. The maximum number of objects to return.

skip (integer)

Optional. The number of objects to skip before including objects in the search limit.

name (string)

Optional. A substring of the object name to match. The matching is case insensitive. The string must be properly encoded if it is required (character & must be encoded with %26).

fullname (string)

Optional. A substring of the object full name to match. The matching is case insensitive. The string must be properly encoded if it is required (character & must be encoded with %26). Repeat the query parameter to search by list of fullnames: fullname=Vector&fullname=Cell.

filepath (string)

Optional. A substring of the object file path to match. The matching is case insensitive.

mangling (string)

Optional. A substring of the object mangling to match. The matching is case insensitive.

type (string)

Optional. A substring of the object type (display name) to match. The matching is case insensitive. The string must be properly encoded if it is required.

select (string)

Optional.

• select=source-locations: The source location is added for each caller object. The response relies on the Source Code Service, it this service is disabled, or misconfigured then an HTTP 500 status code is returned.

Responses

application/json

The response includes a total number of objects macthing the input filters, and the list of objects matching the input filters according to the limit and skip input parameters. Example:

{
  "totalObjects": 50,
  "objects: [
      {
        "id": "2597057",
        "name": "OrderUpdateComponent",
        "fullName": "...\\src\\app\\feature\\order\\order\\order-details\\order-update\\order-update.component.ts.OrderUpdateComponent",
        "type": "Angular Component",
        "filePath": "...\\src\\app\\feature\\order\\order\\order-details\\order-update\\order-update.component.ts",
        "mangling": ""
      },
      ...
  ]
}

JSON representation