Search Parameter Set

Overview

GET /rest/parameterSets/search

This endpoint is used to search existing Parameter Sets.

Required Permissions

Users can search existing parameter sets.

Request

CODE

GET <service_url>/rest/parameterSets/search

Parameters

Parameter	Type	Description	Required
name	String	The name of the parameter set to search for.	No
searchType	String	The type of search to perform. Can only be "exact" or "contain".	No
pageNumber	Integer	The page number of the paginated results	No
maxResults	Integer	The maximum number of results is 100. Default value is 10.	No

Example Requests

CODE

GET https://tis.obss.io/rest/parameterSets/search?name=Example&searchType=exact

GET https://tis.obss.io/rest/parameterSets/search?name=Example&searchType=contain

GET https://tis.obss.io/rest/parameterSets/search?name=&searchType=exact

GET https://tis.obss.io/rest/parameterSets/search?name=Example&searchType=contain&pageNumber=0&max

Response

Response Structure

JSON

{
  "pageNumber": Integer, // The current page number
  "pageSize": Integer, // The number of items per page
  "total": Long, // The total number of items
  "last": Boolean, // Indicates if this is the last page
  "parameterSets": [
    {
      "id": Integer, // The unique identifier of the parameter set
      "name": String, // The name of the parameter set
      "public": Boolean, // Indicates if the parameter set is public
      "ownerId": String, // The ID of the owner of the parameter set
    }
  ]
}

Example Response Body

JSON

{
  "pageNumber": 0,
  "pageSize": 50,
  "total": 1,
  "parameterSets": [
    {
      "id": "2710a694-ec07-4b68-b9f3-1be82fd3af10",
      "name": "Parameter set From Rest",
      "ownerId": "5d2wqe63b7a11eas7f31cd27",
      "public": false
    }
  ],
  "last": true
}

Response Codes

200 OK: Returns a paginated list of parameter sets matching the search criteria.
400 Bad Request: If the request parameters are invalid.