Find Objects

---

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 locations 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

  Property	Type	Description
  totalObjects	integer	The total number of objects matching the filters
  objects[].id	string	The object ID.
  objects[].name	string	The object name.
  objects[].fullName	string	The object long name, usually locates the object in a software architecture.
  objects[].filePath	string	The analyzed source file path. In case of multiple file paths, this is the first one. It may be null if not applicable (ex: a table column).
  objects[].mangling	string	The function signature or an empty string if not applicable.
  objects[].type	string	The object type for a display.
  objects[].typeId	string	The object type identifier is the type reference key.
  objects[].sourceLocations[].fileId	string	The source file ID.
  objects[].sourceLocations[].fileName	string	The source file short name.
  objects[].sourceLocations[].filePath	string	The source file absolute path.
  objects[].sourceLocations[].relativePath	string	The source file relative path to the delivery deployment folder itself deduced from the application original name.
  objects[].sourceLocations[].nbLines	integer	The number of lines of the source file.
  objects[].sourceLocations[].startLine	integer	The first line number of the object within the source file. Ex: 4 means the 4th line within the source file.
  objects[].sourceLocations[].endLine	integer	The last line number of the object within the source file. Ex: 14 means the 14th line within the source file.