The GET /Reports/Definitions operation retrieves all report definitions for the newer report system. A report definition includes the report ID, title, and description, as well as a layout that defines the report parameters and widgets. The layout lists all parameters required by the widgets included in the report and provides the configuration details for each widget, including references to the predefined widgets used in the report.
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 selected details of the reports.
Table 700: GET Reports Definitions 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:
|
| 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: Title |
| 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 701: GET Reports Definitions Response Data
| Name |
In |
Description |
|---|---|---|
| Title | Body | Required. A string containing the user-defined title of the report. |
| Description | Body | Required. A string containing the user-defined description of the report. |
| Layout | Body |
Required. The layout of a report definition contains a list of widgets (referencing predefined widgets) and their report parameters. Note: The description and name of the parameters used by the widgets can be customized to meet your specific user needs. Customizing the parameter name allows you to use the same parameter type (for example, certificate collection) multiple times on the same report in different widgets and reference different values. For more information, see Customize Report Parameters.
|
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 workflow 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.Was this page helpful? Provide Feedback