The Parameter Sets API allows you to programmatically read, create, update, and validate the saved report configurations in Timepiece. A parameter set is a named collection of all the settings that define a Timepiece report.
In the context of the REST API, parameter sets serve two important purposes. First, they can be used as the basis for report requests. Instead of passing every report parameter individually, you can supply a paramSetId and the report will be built from the saved configuration, with any explicitly provided parameters overriding the saved values. Second, this API group allows you to manage parameter sets programmatically, which is useful for provisioning, migration, and automation workflows.
Reading Parameter Sets
Search Parameter Set
GET /rest/parameterSets/search
Searches existing parameter sets by name, using either exact or partial matching controlled by the searchType parameter. Returns a paginated list with a default page size of 10 and a maximum of 100. Useful for finding a specific parameter set's ID when you know its name or part of it. All users with Timepiece access can call this endpoint.
See Search Parameter Set for the full parameter reference and example requests.
Get a List of Parameter Sets
GET /rest/parameterSets
Returns a paginated list of parameter sets visible to the authenticated user, their own sets, plus any sets other users have marked as public. The response includes each set's ID, name, owner, and public flag.
See Get a List of Parameter Sets for the full parameter reference and example response.
Get the Details of a Single Parameter Set
GET /rest/parameterSets/<param_set_id>
Returns the complete saved configuration of a single parameter set identified by its UUID. The response includes the full parameters object with every saved value. Users can access their own sets and public sets. Jira Admins can access any set regardless of ownership or visibility.
See Get the Details of a Single Parameter Set for the full reference and example response.
Writing Parameter Sets
Create a Parameter Set
POST /rest/parameterSets
Creates a new parameter set with the provided name, visibility flag (public), owner ID, and parameters object. The endpoint accepts the parameters without automatically validating them. It is strongly recommended to use the Validate endpoint before or after creating to confirm the parameters are correct. Users can only create sets for themselves; Jira Admins can create sets on behalf of any user.
See Create a Parameter Set for the full request body reference and example.
Update a Parameter Set
PUT /rest/parameterSets/<param_set_id>
Replaces the definition of an existing parameter set with the values in the request body. The structure of the request body is identical to the Create endpoint. Parameters are accepted without automatic validation, so using the Validate endpoint before submitting is recommended. Users can only update their own sets; Jira Admins can update any set.
See Update a Parameter Set for the full request body reference and example.
Validating Parameter Sets
Validate a Parameter Set
POST /rest/parameterSets/validate
Validates a parameters object without saving it. You submit the parameters in the request body and the endpoint responds with a valid boolean and a messages array containing any validation errors. This is the recommended step to take before creating or updating a parameter set via the API, ensuring the configuration is correctly structured and references valid Jira entities before it is persisted.
See Validate a Parameter Set for the full request body reference and example response.
Validate a Parameter Set By ID
POST /rest/parameterSets/validate/<param_set_id>
Validates the parameters of an already-saved parameter set identified by its UUID, without requiring you to supply the parameters in the request body. Useful for checking whether an existing parameter set remains valid after Jira configuration changes.
See Validate a Parameter Set By ID for the full reference and example response.