Documentation Suite v26.2.1

Submit Search

GET Report Definitions GET ID (v2)

The GET /Reports/Definitions/{id} operation retrieves the report with the specified ID 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. On success, the operation returns HTTP 200 OK with details of the report.

Note: This operation is available only in Version 2 and does not have a Version 1 equivalent.

Tip: The following permissions (see Security Roles and Claims) are required to use this feature:

/reports/read/

Table 705: GET Reports Definitions {id} Input Parameters

Name	In	Description
Id	Path	The ID of the report definition to retrieve. Use the GET Reports Definitions (v2) operation to retrieve a list of all the reports in the newer report system to determine the report's ID.

Name

Description

Path

The ID of the report definition to retrieve.

Use the GET Reports Definitions (v2) operation to retrieve a list of all the reports in the newer report system to determine the report's ID.

Table 706: GET Reports Definitions {id} Response Data

Name

Description

Title

A string containing the user-defined title of the report.

Description

A string containing the user-defined description of the report.

Layout

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.

Show report layout details.

Name

Parameters

ReportParameters

An array of objects defining all the widget parameters for the report. Show report parameter details.

Name

Description

Name

A string indicating the widget parameter name. This value reflects the effective parameter name—either the user-defined name (if configured) or the default name.

Description

A string indicating the optional, user-defined description of the widget parameter.

ParameterTypeId

A string indicating the Keyfactor Command reference GUID of the report parameter.

If custom parameters are used, the ParameterTypeId is used to determine the parameter to widget links. This allows for the use of, for example, more than one certificate collection per report.

Widgets

An array of objects that indicate a list of widgets and their linked report parameters that make up the report.

Show report definition widget details.

Name

Description

A string indicating the Keyfactor Command reference GUID of the widget.

Title

A string indicating the name of the widget in this report. This is a system-defined, read-only value.

Description

A string indicating any description that may be associated with the widget. This is a system-defined, read-only value.

An integer indicating the starting horizontal (X) position of the widget on the report page. The first widget added to a page takes position 0 (zero). Each additional widget is positioned according to the grid space occupied by the widgets beside it. See Table 12: Available Widgets for the dimensions of each widget.

An integer indicating the starting vertical (Y) position of the widget on the report page. The first widget added to a page takes position 0 (zero). Each additional widget is positioned according to the grid space occupied by the widgets above it. See Table 12: Available Widgets for the dimensions of each widget.

Tip: For example, the first widget added would be at X:0 Y:0. If that widget is a 2 x 2, the next widget added would be at either X:3 or Y:3 depending on its size, and so forth.

Static

A Boolean indicating whether the widget is static (True or False). A widget is considered static if its X/Y position has been locked For more information, see Editing a Report Lock, Unlock, or Move Widgets.

Parameters

An array of objects defining the parameters in use for the report. Show parameter details.

Name	Description
Name	A string indicating the predefined name of the report parameter associated with this widget.
ReportParameter	A string indicating the user-defined name of the report parameter associated with this widget.
ParameterTypeId	A string indicating the Keyfactor Command reference GUID of the parameter type ID. This is used to link the widget to the parameter.
ParameterDataType	A string indicating the data type of the parameter. Possible values include: Bool DateTime Guid Int ListOfInts String

Text

A string containing the text provided in the user-defined Text Entry widget. This text only displays if the widget is a text-based widget. If any text is added to a non-text widgets it will get cleared upon saving. Show as Null if empty.

Tip: See the Keyfactor API

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

Version v26.2.1

On This Page