Get the details of a single Parameter Set

Overview

GET /rest/parameterSets/<param_set_id>

The details of a single Parameter Set set defined in the system with all the parameter values saved in the set can be requested through this REST endpoint.

Admin Users (users with Administer Jira permission) can see the details for (public or private) param sets owner by all users. Non-Admin users can only see the details for param sets they own or that are saved as public by other users.

Required Permissions

All Users with Timepiece access can view the details of parameter sets that they own or that have been marked as public by other users.
Admin Users (users with the "Administer Jira" permission) can view the details of all parameter sets, whether they are public or private, and regardless of ownership.

Request

CODE

GET <service_url>/rest/parameterSets/<param_set_id>

Parameters

Parameter	Description	Required	Value Samples
param_set_id	The ID of the Parameter Sets for which you want to query the information.	Yes	d93e59ca-548a-43b0-8baa-2b66a404d1ba

Example Requests

CODE

GET https://tis.obss.io/rest/parameterSets/d93e59ca-548a-43b0-8baa-2b66a404d1ba

Response

Example Response Body

JSON

{
    "id": "d93e59ca-548a-43b0-8baa-2b66a404d1ba",
    "name": "Sample Report",
    "parameters": {
        "filterType": "customjql",
        "user": "",
        "userDisplayName": "",
        "projectKey": "SSPA",
        "projectName": "SSPA - Sample Scrum Project",
        "boardID": "",
        "boardName": "",
        "sprintID": "",
        "sprintName": "",
        "customJql": "project in (SSPA, SSPT)",
        "jqlFilterID": "",
        "jqlFilterName": "",
        "columnsBy": "statusDuration",
        "calendar": "normalHours",
        "dayLength": "24HourDays",
        "viewFormat": "days",
        "startDate": "",
        "endDate": "",
        "dateRangeField": "created",
        "trimHistoryStartDate": "",
        "trimHistoryEndDate": "",
        "includeDeletedStatuses": true,
        "outputType": "csvClassic",
        "contentType": "tableList",
        "historyFields": [],
        "fields": [
            "duedate",
            "created"
        ],
        "groupByFields": [],
        "consolidatedStatuses": [],
        "sortBy": "10008",
        "sortDir": "asc",
        "filters": [],
        "dataBar": true,
        "oneDimensionChartType": "column",
        "twoDimensionsChartType": "stackedColumn",
        "dateChartType": "timeline",
        "excludeCurrentState": false,
        "oneDimensionChartPercentage": "onOverall",
        "twoDimensionsChartPercentage": "off",
        "groups": [],
        "dbsMetrics": [],
        "multiVisitBehavior": "total",
        "visitCounts": false,
        "averageDenominator": "nonNull",
        "exportDateFormat": "",
        "exportDateTimeFormat": "",
        "exportEmptyValueToken": "hyphen"
    },
	"owner": "276d7bea-f4df-49e6-b231-1b15d4ed852a"
    "public": true
}

Response Codes

200 OK: Returns a JSON that contains all the details of the given Parameter Set.