Skip to main content
Skip table of contents

Get the details of a single Parameter Set

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.

Request

XML
<service_url>/rest/parameterSets/<param_set_id>

Parameters

Expand Parameters...

Parameter

Description

Required

Value Samples

param_set_idThe ID of the Parameter Sets for which you want to query the information.Yes

d93e59ca-548a-43b0-8baa-2b66a404d1ba

Examples

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

Responses

Expand responses...
200 - Success

Success

HTTP 200

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


{
  "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
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.