Validate a Parameter Set By ID

Overview

GET /rest/parameterSets/validate/{id}

POST /rest/parameterSets/validate/{id}

This endpoint is used to validate the parameters of an existing Parameter Set.

Required Permissions

Users can validate parameters of an existing Parameter Set.

Request

CODE

GET <service_url>/rest/parameterSets/validate/{id}

POST <service_url>/rest/parameterSets/validate/{id}

Parameters

Parameter	Type	Description	Required
id	String	The ID of the parameter set you want to validate	Yes

Example Requests

CODE

GET https://tis.obss.io/rest/parameterSets/validate/2710a694-ec07-4b68-b9f3-1be82fd3af10

POST https://tis.obss.io/rest/parameterSets/validate/2710a694-ec07-4b68-b9f3-1be82fd3af10

Response

Response Structure

CODE

{
  "valid": Boolean, // Indicates if the parameter set is valid
  "messages": Array<String> | null // Contains validation messages if any, otherwise null
}

Example Response Body

JSON

{
  "valid": true,
  "messages": null
}

Response Codes

200 OK: Indicates that the parameter set is valid.
400 Bad Request: If the request parameter is invalid.
404 Not Found: If the requested parameter set does not exist.