REST API for GoldenGate Veridata

Retrieve Group details

get

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

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

Get Veridata Group details.

Request

Path Parameters

Id(required): integer

Query Parameters

name: string

compare pair name like.
profile: string

compare pair profile like.
srcTable: string

source table name like.
status:

Compare pair validation status.
tgtTable: string

target table name like.

There's no request body for this operation.

Response

Supported Media Types

application/json
*/*

200 Response

Group returned successfully.

Root Schema : Group

Type: object

Show Source

comparePairs: array comparePairs
sourceConnection: GroupConnection
targetConnection: GroupConnection

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "sourceConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "targetConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComparePairForGroupDetails"
            }
        }
    }
}

Match All

Show Source

object BaseObject
object Group-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "sourceConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "targetConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComparePairForGroupDetails"
            }
        }
    }
}

Nested Schema : comparePairs

Type: array

Show Source

Array of: object ComparePairForGroupDetails

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

Nested Schema : GroupConnection

Type: object

Show Source

id: integer (int64)

Source Connection ID.
name: string

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Source Connection ID."
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : BaseObject

Type: object

Show Source

createdOn: string (date-time)

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

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

Object Description.
id: integer (int64)

Object Id.
name: string

Object Name.
updatedOn: string (date-time)

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

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        },
        "description":{
            "type":"string",
            "description":"Object Description."
        },
        "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 : Group-allOf[1]

Type: object

Nested Schema : ComparePairForGroupDetails

Type: object

Show Source

deltaProcessingEnabled: boolean

Default Value: false

Delta processing is enabled for this compare pair.
enabled: boolean

Default Value: true

Compare Pair is enabled in the group to run.
groupId: integer (int64)

Group ID.
name: string
profileId: integer (int64)

Default Value: 1

Profile ID.
srcTable: object srcTable

Represents a table in Compare Pair with table and row partitions info, if any.
tgtTable: object tgtTable

Represents a table in Compare Pair with table and row partitions info, if any.
validationStatus: string

Allowed Values: [ "NeverValidated", "Validated" ]

enum for compare pair validation status.
validationTime: string (date-time)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":"1",
            "description":"Profile ID."
        },
        "groupId":{
            "type":"integer",
            "format":"int64",
            "description":"Group ID."
        },
        "srcTable":{
            "type":"object",
            "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
            "properties":{
                "name":{
                    "type":"string"
                },
                "schema":{
                    "type":"string"
                },
                "catalog":{
                    "type":"string"
                }
            }
        },
        "tgtTable":{
            "type":"object",
            "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
            "properties":{
                "name":{
                    "type":"string"
                },
                "schema":{
                    "type":"string"
                },
                "catalog":{
                    "type":"string"
                }
            }
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run.",
            "default":true
        },
        "deltaProcessingEnabled":{
            "type":"boolean",
            "description":"Delta processing is enabled for this compare pair.",
            "default":false
        },
        "validationTime":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "$ref":"#/components/schemas/ComparePairValidationStatus"
        }
    }
}

Nested Schema : srcTable

Type: object

Represents a table in Compare Pair with table and row partitions info, if any.

Show Source

catalog: string
name: string
schema: string

{
    "type":"object",
    "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        }
    }
}

Nested Schema : tgtTable

Type: object

Represents a table in Compare Pair with table and row partitions info, if any.

Show Source

catalog: string
name: string
schema: string

{
    "type":"object",
    "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        }
    }
}

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