PUT Reports ID Parameters

The PUT /Reports/{id}/Parameters method is used to update the parameters for the built-in report with the specified report ID. Only some fields can be updated. This method returns HTTP 200 OK on a success with the details of the report parameters.

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

/reports/modify/

Table 577: PUT 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 method (see GET Reports) to retrieve a list of your built-in reports to determine the report ID to use.
Id Body

Required. The Keyfactor Command reference ID of the report parameter.

Use the GET /Reports/{id} (see GET Reports ID) to retrieve the details for the desired report to determine the parameter ID to use.
DisplayName Body

A string containing the display name for the parameter (e.g. Evaluation Date (UTC)).

Note:  The DisplayName cannot be updated if the ParameterType is Templates.
Description Body A string containing the description for the parameter.
DefaultValue Body A string containing the default value for the parameter.
Tip:  Default values that are integers are also stored as strings in this parameter.

Table 578: PUT 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 (e.g. 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 (e.g. 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 value is Visible. The alternative setting is Hidden.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.