REST API for GoldenGate Veridata

Retrieve Out-of-Sync data.

get

http://{host}:{port}/veridata/v1/services/oos/{runId}

Required Role: Administrator, SuperUser, CommandLineOperator, DetailMonitoringOperator

Get out-of-sync data for a Compare Pair.

Request

Path Parameters

runId(required): integer(int64)

Comparison Compare Pair run ID.

Query Parameters

operationType:

Filter rows based on operation type. Comma seperated operation type. Default is UPDATE,INSERT,DELETE.
repairStatus:

Filter rows based on repair status. Comma seperated repair status. Default value is Out of Sync rows.

There's no request body for this operation.

Response

Supported Media Types

application/json
*/*

200 Response

Successfully retrieved Out-Of-Sync data.

Root Schema : schema

Type: array

Show Source

Array of: object OutOfSyncDetails

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

Nested Schema : OutOfSyncDetails

Type: object

Show Source

repairStatus: string

Allowed Values: [ "PENDING", "RUNNING", "ERRORS", "WARNINGS", "SUCCESSFUL", "CANCELLED", "OOS" ]

Repair Status.
rowsData: array rowsData

{
    "type":"object",
    "properties":{
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "rowsData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OutOfSyncRow"
            }
        }
    }
}

Nested Schema : rowsData

Type: array

Show Source

Array of: object OutOfSyncRow

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

Nested Schema : OutOfSyncRow

Type: object

Show Source

duplicateRow: boolean

Default Value: false
operation: string

Allowed Values: [ "INSERT", "UPDATE", "DELETE", "MATCH" ]

Operation type.
repairStatus: string

Allowed Values: [ "PENDING", "RUNNING", "ERRORS", "WARNINGS", "SUCCESSFUL", "CANCELLED", "OOS" ]

Repair Status.
rowData: array rowData
skippedRow: boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "rowData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OutOfSyncRowData"
            }
        },
        "operation":{
            "$ref":"#/components/schemas/OperationType"
        },
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "skippedRow":{
            "type":"boolean",
            "default":false
        },
        "duplicateRow":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : rowData

Type: array

Show Source

Array of: object OutOfSyncRowData

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

Nested Schema : OutOfSyncRowData

Type: object

Show Source

columnName: string
columnType: string
keyCol: boolean
srcColumnData: srcColumnData
tgtColumnData: tgtColumnData

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string"
        },
        "columnType":{
            "type":"string"
        },
        "keyCol":{
            "type":"boolean"
        },
        "srcColumnData":{
            "items":{
                "$ref":"#/components/schemas/OutOfSyncRowDataColumnData"
            }
        },
        "tgtColumnData":{
            "items":{
                "$ref":"#/components/schemas/OutOfSyncRowDataColumnData"
            }
        }
    }
}

Nested Schema : srcColumnData

Type: array

Show Source

Array of: object OutOfSyncRowDataColumnData

{
    "items":{
        "$ref":"#/components/schemas/OutOfSyncRowDataColumnData"
    }
}

Nested Schema : tgtColumnData

Type: array

Show Source

Array of: object OutOfSyncRowDataColumnData

{
    "items":{
        "$ref":"#/components/schemas/OutOfSyncRowDataColumnData"
    }
}

Nested Schema : OutOfSyncRowDataColumnData

Type: object

Show Source

binary: boolean
diff: boolean
hex: boolean
isnull: boolean

Default Value: false
name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "hex":{
            "type":"boolean"
        },
        "binary":{
            "type":"boolean"
        },
        "diff":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        },
        "isnull":{
            "type":"boolean",
            "default":false
        }
    }
}

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