Get a List of Parameter Sets

Overview

GET /rest/parameterSets

A list of Parameter Sets defined in the system with their IDs can be requested through this REST endpoint.

The list includes the Parameter Sets owned by the current user and public Parameter Sets created by other users. (When a report is shared using a Quick Share link, a public parameter set with a GUID as its name is created by the system. The list returned by this endpoint also includes those Quick Share parameter sets)

Required Permissions

All Users with Timepiece access can retrieve a list of Parameter Sets they own, as well as public Parameter Sets created and shared by other users.
Admin users (users with the "Administer Jira" permission) can use the allUsers=true parameter to retrieve both public and private Parameter Sets created by any user. Only admins can use this parameter; for non-admins, the list is limited to their own and public sets.

Request

CODE

GET <service_url>/rest/parameterSets

Parameters

Parameter	Description	Value Samples
includePublic	Controls whether public parameter sets created and shared by other users should be included in the list. The default value is true.	true false
allUsers	Controls whether (public and private) parameter sets created and shared by other users should be included in the list. The default value is false. Only users with Administer Jira permissions can use this parameter with "true" value. When this parameter is set to "true", "includePublic" parameter is automatically processed as "true".	true false
includeQuickShare	Controls whether parameter sets created by the Quick Share function will be included in the list. The default value is false.	true false
startAt	The issue index to start at. The default value is 0.	10
maxResults	The maximum number of issues in a page. (1-100) The default is 100 and values greater than 100 or less than 0 will be processed as 100.	50

Example Requests

CODE

GET https://tis.obss.io/rest/parameterSets?includePublic=false

Response

Example Response Body

JSON

{
  "elements": [
    {
      "id": "eab0e07d-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "08ddaf88-3f4f-4396-a447-23756ad4d34e",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": true
    },
    {
      "id": "eab0e145-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "Param Set Test",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": false
    },
    {
      "id": "eab0e1cf-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "Param Set Test 001",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": false
    },
    {
      "id": "eab0e2a5-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "Param Set Test 002",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": false
    },
    {
      "id": "eab0e31d-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "Param Set Test 003",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": false
    },
    {
      "id": "c02af5a7-4c7e-454e-8a15-835cb2506024",
      "name": "Status Duration Average",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": true
    },
    {
      "id": "eab2ec97-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "Time period by Month",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": true
    },
    {
      "id": "eab2ed8b-1bfd-11ef-8f2a-02c4dc0af329",
      "name": "Time period by Week",
      "owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a",
      "public": true
    }
  ],
  "totalElementCount": 8,
  "pageNumber": 0,
  "pageSize": 100,
  "last": true
}

Response Codes

200 OK: Returns a JSON that contains all parameter sets defined in your instance that the current user has permission to see.