Retrieve User Preferences
get
http://{host}:{port}/veridata/v1/services/preferences
Required Role: Administrator, SuperUser, CommandLineOperator
Fetch User Preferences
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Retrieve User Preference details successfully.
Root Schema : PreferenceDetails
Type:
objectMatch All
Show Source Example:
{ "attributesList":[ { "name":"autoRefreshInterval", "default":true, "value":30, "defaultValue":30, "type":"INTEGER", "min":10, "max":100 } ] }Nested Schema : BaseObject_3
Type:
Show Source object- id: integer (int64) Object Id.
- name: string Object Name.
Nested Schema : PreferenceAttribute
Type:
Show Source object- default: boolean
- defaultValue: string
- max: integer It is displayed when type is INTEGER.
- min: integer It is displayed when type is INTEGER.
- name: string Allowed Values:
[ "autoRefreshInterval", "fontSize" ] - options: string It is displayed when type is ENUM.
- type: string Allowed Values:
[ "BOOLEAN", "ENUM", "INTEGER", "STRING" ] - value: string
400 Response
Bad Request.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }404 Response
Not Found.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }500 Response
Server Error.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }