GET Reports Custom

The GET /Reports/Custom operation returns all custom report links. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with  the details of the report linkages.

Important:  The v1 report endpoints use the legacy reporting system and have been deprecated. They are retained for backward compatibility but require the legacy reports to be installed (see the Logi component in Install Keyfactor Command on a Windows Server Under IIS). New development should use the v2 endpoints, which use the current reporting system.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/reports/read/

Table 725: GET Reports Custom Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. For querying guidelines, refer to: Using Search in the Management Portal. The query fields supported for this operation are:

  • Favorite (true, false)
  • InNavigator (true, false)
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • CustomURL

  • Description

  • DisplayName

  • Favorite

  • Id

  • InNavigator

Available sort fields are affected by the query provided in QueryString. The default sort field is DisplayName.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 726: GET Reports Custom Response Data

Name Description
CustomURL A string containing the URL users should click from within Keyfactor Command to display the custom report (for example, https://mywebserver.keyexample.com/mycustomreport/).
Tip:  Custom reports are automatically opened in a new browser tab.
Id

An integer containing the Keyfactor Command reference ID for the report link.
DisplayName A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and on the menu.
Description A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page.
InNavigator A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (True or False).
Favorite A Boolean that indicates whether the report has been marked as a favorite (True or False).
Tip:  See the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.