GET Reports ID Parameters

The GET /Reports/{id}/Parameters operation returns the parameters for the built-in report with the specified report ID. On success, the operation returns HTTP 200 OK with  the details of the report parameters.

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 715: GET Reports {id} Parameters Input Parameters

Name In Description
id Path

Required. The Keyfactor Command reference ID of the built-in report the parameter is associated with.

Use the GET Reports operation to retrieve a list of your built-in reports to determine the report ID to use.

Table 716: GET Reports {id} Parameters Response Data

Name

Description

Id

An integer indicating the Keyfactor Command reference ID of the report parameter.

Parameter Name

 A string containing the short reference name for the report parameter (for example, EvalDate).
Parameter Type

A string containing the type of the parameter. Possible values include:

  • Bool
  • CertAuth (certificate authorities)
  • Int
  • Metadata
  • OrchestratorPool
  • RelativeDate
  • SingleCA
  • SingleMetadata
  • SSHKeyType
  • Templates
  • TimePeriod
Display Name A string containing the display name for the parameter (for example, Evaluation Date (UTC)).
Description A string containing the description for the parameter.
Default Value A string containing the default value for the parameter.
Tip:  Default values that are integers are also stored as strings in this parameter.
Display Order An integer indicating the order in which the parameters should be displayed on the scheduling page in Keyfactor Command, beginning with 0.
Parameter Visibility A string indicating whether the parameter should be displayed in the Keyfactor Command Management Portal. The default is Visible. The alternative setting is Hidden.
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.