Get quality models
Get a list of the quality models defined on your system.
For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
API call
<protocol>://<ws-host>:<ws-port>/ws-api/v1/qualityModels?token=<sessionId>
Details
- GET method
- Content-Type in the header:
application/json - Mandatory parameter: the session token (as a query string parameter or as a key-value pair in the header)
Available filters
You can add the filters as query string parameters or as key-value pairs in the header:
| Filter | Description |
|---|---|
| sortBy=<fieldName> | Use this filter in conjunction with the fields filter. If the fields you specified for sorting are not available, the results will not be sorted. |
| sortDirection=<asc|desc> | Ascending or descending. |
| fields=<fieldName1,fieldName2,…,fieldNameN> | The names of the fields to be included in the JSON response, separated by commas. Do not use in conjunction with the excludedFields filter. |
| excludedFields=<fieldName1,fieldName2,…,fieldNameN> | The names of the fields to be excluded from the JSON response, separated by commas. Do not use in conjunction with the fields filter. |
Examples:
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/qualityModels?token=<sessionId>&sortBy=name
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/qualityModels?token=<sessionId>&sortBy=name&sortDirection=asc
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/qualityModels?token=<sessionId>&fields=name,description&sortBy=name&sortDirection=asc
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/qualityModels?token=<sessionId>&excludedFields=name
Response
Error messages
No session token provided or invalid token (401 Unauthorized)