Green Deficiencies Occurrences

Overview

Get the list of objects with locations in the source code for a given green deficiency detection pattern. The objects are sorted by name, and bookmarks by file ID and start line.

URI

GET /rest/applications/{name}/insights/green-detection-patterns/{id}/occurrences

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 Green Deficiency detection pattern ID.

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.

Responses

application/json

Example:

[
  {
    "id": "9033",
    "name": "redirectAfterSuccess",
    "fullName": "com.salesmanager.shop.admin.security.UserAuthenticationSuccessHandler.redirectAfterSuccess",
    "mangling": "redirectAfterSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) return void",
    "type": "Java Method",
    "typeId": "JV_METHOD",
    "bookmarks": [
      {
        "startLine": 27,
        "endLine": 27,
        "fileId": -848
        "relativePath": "base\\src\\org\\compiere\\model\\MCommissionRun.java"
      }
    ]
  }
]

JSON representation

Property	Type	Description
id	string	The object ID.
name	string	The object name.
fullName	string	The object long name, usually locates the object in a software architecture.
mangling	string	The function signature or an empty string if not applicable.
type	string	The object type for a display.
typeId	string	The object type identifier is the type reference key.
bookmarks[].startLine	integer	The start line of this finding in the source code file.
bookmarks[].endLine	integer	The end line of this finding in the source code file.
bookmarks[].fileId	integer	The source file ID required to get the source text.
bookmarks[].relativePath	string	The source file relative path.