REST API for GoldenGate Veridata

Retrieve Agent Connection

get

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

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Returns agent connection details.

Request

Path Parameters

Id(required): integer(int64)

agent connection ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successfully returned agent connection.

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"
        }
    ],
    "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"
        }
    ],
    "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."
        }
    }
}

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

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

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

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

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