REST API for GoldenGate Veridata

Update User Preferences

patch

http://{host}:{port}/veridata/v1/services/preferences

Required Role: Administrator, SuperUser, CommandLineOperator

Update Veridata User Preferences

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

autoRefreshInterval: integer

Auto refresh time interval in seconds.
fontSize: string

Allowed Values: [ "Small", "Medium", "Large" ]

Customized Font size setting for an application.

{ "type":"object", "properties":{ "autoRefreshInterval":{ "type":"integer", "description":"Auto refresh time interval in seconds." }, "fontSize":{ "type":"string", "description":"Customized Font size setting for an application.", "enum":[ "Small", "Medium", "Large" ] } }, "example":{ "autoRefreshInterval":30, "fontSize":"Small" } }

Example:

{ "autoRefreshInterval":30, "fontSize":"Small" }

Response

Supported Media Types

application/json

200 Response

User Preference details updated successfully.

Root Schema : PreferenceDetails

Type: object

Match All

Show Source

object BaseObject_3
object PrefernceObject2

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/BaseObject_3" }, { "$ref":"#/components/schemas/PrefernceObject2" } ], "example":{ "attributesList":[ { "name":"autoRefreshInterval", "default":true, "value":30, "defaultValue":30, "type":"INTEGER", "min":10, "max":100 } ] } }

Example:

{ "attributesList":[ { "name":"autoRefreshInterval", "default":true, "value":30, "defaultValue":30, "type":"INTEGER", "min":10, "max":100 } ] }

Nested Schema : BaseObject_3

Type: object

Show Source

id: integer (int64)

Object Id.
name: string

Object Name.

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Object Id.", "format":"int64" }, "name":{ "type":"string", "description":"Object Name." } } }

Nested Schema : PrefernceObject2

Type: object

Show Source

attributesList: array attributesList

{ "type":"object", "properties":{ "attributesList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PreferenceAttribute" } } } }

Nested Schema : attributesList

Type: array

Show Source

Array of: object PreferenceAttribute

{ "type":"array", "items":{ "$ref":"#/components/schemas/PreferenceAttribute" } }

Nested Schema : PreferenceAttribute

Type: object

Show Source

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

{ "type":"object", "properties":{ "name":{ "$ref":"#/components/schemas/PreferenceAttributeEnum" }, "default":{ "type":"boolean" }, "value":{ "type":"string" }, "defaultValue":{ "type":"string" }, "type":{ "type":"string", "enum":[ "BOOLEAN", "ENUM", "INTEGER", "STRING" ] }, "options":{ "type":"string", "description":"It is displayed when type is ENUM." }, "min":{ "type":"integer", "description":"It is displayed when type is INTEGER." }, "max":{ "type":"integer", "description":"It is displayed when type is INTEGER." } } }

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }