Get a List of Parameter Sets

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)

Request

XML

<service_url>/rest/parameterSets

Parameters

Expand Parameters...

Parameter

Description

Required

Value Samples

includePublic

Controls whether parameter sets created and shared by other users should be included in the list.

The default value is true.

true

false

Examples

Expand examples...

XML

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

Responses

Expand responses...

200 - Success

Success

HTTP 200

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


[
    {
        "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
    }
]