REST API for GoldenGate Veridata

Update Agent Connection

patch

http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}

Required Role: Administrator, SuperUser, CommandLineOperator

Update agent connection.

Request

Path Parameters

Id(required): integer(int64)

ID of the connection to be updated.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

description: string

Connection Description.
host: string

Veridata Agent Host.
password: string (password)

Encrypted Database connection password.
port: integer (int32)

Veridata Agent Port.
properties: array properties
repairPassword: string (password)

Encrypted DB password having repair access.
repairUsername: string

DB user having repair access.
settings: object ConnectionSettings
ssl: boolean

Default Value: false

SSL enabled Agent connection to the Server.
username: string

Database connection username.

{ "type":"object", "properties":{ "description":{ "type":"string", "description":"Connection Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "ssl":{ "type":"boolean", "description":"SSL enabled Agent connection to the Server.", "default":false }, "username":{ "type":"string", "description":"Database connection username." }, "password":{ "type":"string", "description":"Encrypted Database connection password.", "format":"password" }, "repairUsername":{ "type":"string", "description":"DB user having repair access." }, "repairPassword":{ "type":"string", "description":"Encrypted DB password having repair access.", "format":"password" }, "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/UpdateConnectionProperty" } }, "settings":{ "$ref":"#/components/schemas/ConnectionSettings" } }, "example":{ "description":"Updated description", "host":"100.00.00.01", "port":7851, "ssl":false, "username":"User1", "password":"Abc@1234", "repairUsername":"User1", "repairPassword":"Abc@1234", "properties":[ { "datatype":"string", "compareFormat":{ "formatName":"blob", "precision":0, "scale":0, "timezone":"string" } } ], "settings":{ "agentTimeout":3000, "trimTrailingSpaces":true, "fetchSize":5000, "ssl":false, "useSourceTargetAsKeys":true, "useAllColsAsKeys":true } } }

Example:

{ "description":"Updated description", "host":"100.00.00.01", "port":7851, "ssl":false, "username":"User1", "password":"Abc@1234", "repairUsername":"User1", "repairPassword":"Abc@1234", "properties":[ { "datatype":"string", "compareFormat":{ "formatName":"blob", "precision":0, "scale":0, "timezone":"string" } } ], "settings":{ "agentTimeout":3000, "trimTrailingSpaces":true, "fetchSize":5000, "ssl":false, "useSourceTargetAsKeys":true, "useAllColsAsKeys":true } }

Nested Schema : properties

Type: array

Show Source

Array of: object UpdateConnectionProperty

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

Nested Schema : ConnectionSettings

Type: object

Show Source

agentTimeout: integer (int32)

Default Value: 3600

Agent Message Timeout in seconds.
fetchSize: integer (int32)

Default Value: 1000

Initial Compare Fetch Batch Size.
ssl: boolean

Default Value: false

Use Secure Socket Layer (SSL) for server-agent communication.
trimTrailingSpaces: boolean

Default Value: true

Truncate trailing spaces when comparing values.
useAllColsAsKeys: boolean

Default Value: true

Use all Columns as Key columns when generating Compare Pairs.
useSourceTargetAsKeys: boolean

Default Value: true

Use Source or Target Columns as Key columns when generating ompare. Pairs

{ "type":"object", "properties":{ "agentTimeout":{ "type":"integer", "description":"Agent Message Timeout in seconds.", "format":"int32", "default":3600 }, "trimTrailingSpaces":{ "type":"boolean", "description":"Truncate trailing spaces when comparing values.", "default":true }, "fetchSize":{ "type":"integer", "description":"Initial Compare Fetch Batch Size.", "format":"int32", "default":1000 }, "ssl":{ "type":"boolean", "description":"Use Secure Socket Layer (SSL) for server-agent communication.", "default":false }, "useSourceTargetAsKeys":{ "type":"boolean", "description":"Use Source or Target Columns as Key columns when generating ompare. Pairs", "default":true }, "useAllColsAsKeys":{ "type":"boolean", "description":"Use all Columns as Key columns when generating Compare Pairs.", "default":true } } }

Nested Schema : UpdateConnectionProperty

Type: object

Show Source

compareFormat: object UpdateCompareFormat
dataType: string

{ "type":"object", "properties":{ "dataType":{ "type":"string" }, "compareFormat":{ "$ref":"#/components/schemas/UpdateCompareFormat" } } }

Nested Schema : UpdateCompareFormat

Type: object

Show Source

formatName: string

Allowed Values: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

Compare Format.
precision: integer (int32)
scale: integer (int32)
timezone: string

{ "type":"object", "properties":{ "formatName":{ "$ref":"#/components/schemas/CompareFormat" }, "precision":{ "type":"integer", "format":"int32" }, "scale":{ "type":"integer", "format":"int32" }, "timezone":{ "type":"string" } } }

Response

Supported Media Types

application/json

200 Response

Connection Updated.

Root Schema : Connection

Type: object

Show Source

availableTimezones: object availableTimezones

List of timezones.
dbType: string

Allowed Values: [ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]

Database Type.
properties: array properties
repairUsername: string

DB user having repair access.
settings: object ConnectionSettings
username: string

Database connection username.

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/BaseConnection" } ], "example":{ "createdOn":"2025-04-02T11:20:51.270Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800, "availableTimezones":{ "DEFAULT TIMEZONE":"DEFAULT", "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway" }, "dbType":"oracle", "properties":[ { "datatype":"ARRAY", "datatypeNumber":2004, "defaultFormat":{ "defaultFormatType":"ggComparisonFormatBlob", "formatName":"blob" }, "searchable":true, "useDefault":true } ], "settings":{ "useSourceTargetAsKeys":"true", "useAllColsAsKeys":"true" }, "updatedOn":"2025-04-02T11:20:51Z", "username":"User" }, "properties":{ "dbType":{ "$ref":"#/components/schemas/DatabaseType" }, "username":{ "type":"string", "description":"Database connection username." }, "repairUsername":{ "type":"string", "description":"DB user having repair access." }, "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConnectionProperty" } }, "settings":{ "$ref":"#/components/schemas/ConnectionSettings" }, "availableTimezones":{ "type":"object", "description":"List of timezones." } } }

Match All

Show Source

object BaseConnection

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/BaseConnection" } ], "example":{ "createdOn":"2025-04-02T11:20:51.270Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800, "availableTimezones":{ "DEFAULT TIMEZONE":"DEFAULT", "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway" }, "dbType":"oracle", "properties":[ { "datatype":"ARRAY", "datatypeNumber":2004, "defaultFormat":{ "defaultFormatType":"ggComparisonFormatBlob", "formatName":"blob" }, "searchable":true, "useDefault":true } ], "settings":{ "useSourceTargetAsKeys":"true", "useAllColsAsKeys":"true" }, "updatedOn":"2025-04-02T11:20:51Z", "username":"User" }, "properties":{ "dbType":{ "$ref":"#/components/schemas/DatabaseType" }, "username":{ "type":"string", "description":"Database connection username." }, "repairUsername":{ "type":"string", "description":"DB user having repair access." }, "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConnectionProperty" } }, "settings":{ "$ref":"#/components/schemas/ConnectionSettings" }, "availableTimezones":{ "type":"object", "description":"List of timezones." } } }

Example:

{ "createdOn":"2025-04-02T11:20:51.270Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800, "availableTimezones":{ "DEFAULT TIMEZONE":"DEFAULT", "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway" }, "dbType":"oracle", "properties":[ { "datatype":"ARRAY", "datatypeNumber":2004, "defaultFormat":{ "defaultFormatType":"ggComparisonFormatBlob", "formatName":"blob" }, "searchable":true, "useDefault":true } ], "settings":{ "useSourceTargetAsKeys":"true", "useAllColsAsKeys":"true" }, "updatedOn":"2025-04-02T11:20:51Z", "username":"User" }

Nested Schema : availableTimezones

Type: object

List of timezones.

Nested Schema : properties

Type: array

Show Source

Array of: object ConnectionProperty

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

Nested Schema : ConnectionSettings

Type: object

Show Source

agentTimeout: integer (int32)

Default Value: 3600

Agent Message Timeout in seconds.
fetchSize: integer (int32)

Default Value: 1000

Initial Compare Fetch Batch Size.
ssl: boolean

Default Value: false

Use Secure Socket Layer (SSL) for server-agent communication.
trimTrailingSpaces: boolean

Default Value: true

Truncate trailing spaces when comparing values.
useAllColsAsKeys: boolean

Default Value: true

Use all Columns as Key columns when generating Compare Pairs.
useSourceTargetAsKeys: boolean

Default Value: true

Use Source or Target Columns as Key columns when generating ompare. Pairs

{ "type":"object", "properties":{ "agentTimeout":{ "type":"integer", "description":"Agent Message Timeout in seconds.", "format":"int32", "default":3600 }, "trimTrailingSpaces":{ "type":"boolean", "description":"Truncate trailing spaces when comparing values.", "default":true }, "fetchSize":{ "type":"integer", "description":"Initial Compare Fetch Batch Size.", "format":"int32", "default":1000 }, "ssl":{ "type":"boolean", "description":"Use Secure Socket Layer (SSL) for server-agent communication.", "default":false }, "useSourceTargetAsKeys":{ "type":"boolean", "description":"Use Source or Target Columns as Key columns when generating ompare. Pairs", "default":true }, "useAllColsAsKeys":{ "type":"boolean", "description":"Use all Columns as Key columns when generating Compare Pairs.", "default":true } } }

Nested Schema : BaseConnection

Type: object

Show Source

createdOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
description: string

Connection Description.
host: string

Veridata Agent Host.
id: integer (int64)

Connection Id.
name: string

Connection Name.
port: integer (int32)

Veridata Agent Port.
updatedOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "name":{ "type":"string", "description":"Connection Name." }, "description":{ "type":"string", "description":"Connection Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "updatedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" } }, "example":{ "createdOn":"2025-04-02T11:20:51.269Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800 } }

Example:

{ "createdOn":"2025-04-02T11:20:51.269Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800 }

Nested Schema : ConnectionProperty

Type: object

Show Source

compareFormat: string

Allowed Values: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

Compare Format.
dataType: string
isDefault: boolean

Default Value: true

Defines if default property is used or not.
precision: integer (int32)
scale: integer (int32)
timezone: string

{ "type":"object", "properties":{ "dataType":{ "type":"string" }, "compareFormat":{ "$ref":"#/components/schemas/CompareFormat" }, "precision":{ "type":"integer", "format":"int32" }, "scale":{ "type":"integer", "format":"int32" }, "timezone":{ "type":"string" }, "isDefault":{ "type":"boolean", "description":"Defines if default property is used or not.", "default":true } } }

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" }