REST API for GoldenGate Veridata

Retrieve Repair Statistics

get

http://{host}:{port}/veridata/v1/services/monitoring/repair/jobs

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

This API is used to monitor Repair Jobs. Pass the runId as input to fetch Group and Compare Pair details.

Request

Query Parameters

fromDate: string

Defines the start date range (inclusive) to filter out the Repair Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'. Example: 2024-03-13T18:30:00Z
last: string

Fetch Repair job stats of last x units. Supported units D(Days) or H(hours) or M(minutes). Example: 1D
runId: string

The Repair Job's Run ID. Example: runId=1024,0,0. Group and Compare Pair details will be returned in response only when this parameter is passed.
status:

Defines Repair Job Status. To fetch Jobs of different status, pass comma separated values.
toDate: string

Defines the end date range (not inclusive) to filter out the Repair Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'. Example: 2024-03-13T18:30:00Z

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Returns a collection of Repair Jobs.

Root Schema : schema

Type: array

Show Source

Array of: RepairJobStats

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

Nested Schema : RepairJobStats

Match All

Show Source

object BaseStats
object RepairJobStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "comparePairsProcessed":{
                    "type":"integer",
                    "format":"int64"
                },
                "comparePairsRepaired":{
                    "type":"integer",
                    "format":"int64"
                },
                "comparePairsWithWarnings":{
                    "type":"integer",
                    "format":"int64"
                },
                "comparePairsCancelled":{
                    "type":"integer",
                    "format":"int64"
                },
                "repairStatus":{
                    "$ref":"#/components/schemas/RepairStatus"
                },
                "groups":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RepairGroupStats"
                    }
                }
            }
        }
    ]
}

Nested Schema : BaseStats

Type: object

Show Source

endTime: string (date-time)

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

Example: 2024-02-03T10:15:30Z
runId: object RunID

Run ID.
startTime: string (date-time)

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

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

{
    "type":"object",
    "properties":{
        "runId":{
            "$ref":"#/components/schemas/RunID",
            "type":"object"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    }
}

Nested Schema : RepairJobStats-allOf[1]

Type: object

Show Source

comparePairsCancelled: integer (int64)
comparePairsProcessed: integer (int64)
comparePairsRepaired: integer (int64)
comparePairsWithWarnings: integer (int64)
groups: array groups
name: string
repairStatus: string

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

Repair Status.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "comparePairsProcessed":{
            "type":"integer",
            "format":"int64"
        },
        "comparePairsRepaired":{
            "type":"integer",
            "format":"int64"
        },
        "comparePairsWithWarnings":{
            "type":"integer",
            "format":"int64"
        },
        "comparePairsCancelled":{
            "type":"integer",
            "format":"int64"
        },
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepairGroupStats"
            }
        }
    }
}

Nested Schema : RunID

Type: object

Run ID.

Show Source

asString: string

Displays Run ID in string format.
comparePairNum: integer

pPart of the run ID.
groupNum: integer

Part of the run ID
runID: integer

Part of the run ID.

{
    "type":"object",
    "description":"Run ID.",
    "properties":{
        "asString":{
            "type":"string",
            "description":"Displays Run ID in string format."
        },
        "comparePairNum":{
            "type":"integer",
            "description":"pPart of the run ID."
        },
        "groupNum":{
            "type":"integer",
            "description":"Part of the run ID"
        },
        "runID":{
            "type":"integer",
            "description":"Part of the run ID."
        }
    }
}

Nested Schema : groups

Type: array

Show Source

Array of: RepairGroupStats

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

Nested Schema : RepairGroupStats

Match All

Show Source

object BaseStats
object RepairGroupStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "grpId":{
                    "type":"integer",
                    "format":"int64"
                },
                "name":{
                    "type":"string"
                },
                "runId":{
                    "type":"integer",
                    "format":"int64"
                },
                "numOfComparePairs":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "comparePairs":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RepairPairStats"
                    }
                }
            }
        }
    ]
}

Nested Schema : RepairGroupStats-allOf[1]

Type: object

Show Source

comparePairs: array comparePairs
grpId: integer (int64)
name: string
numOfComparePairs: integer (int64)

Default Value: 0
runId: integer (int64)

{
    "type":"object",
    "properties":{
        "grpId":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "runId":{
            "type":"integer",
            "format":"int64"
        },
        "numOfComparePairs":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepairPairStats"
            }
        }
    }
}

Nested Schema : comparePairs

Type: array

Show Source

Array of: RepairPairStats

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

Nested Schema : RepairPairStats

Match All

Show Source

object BaseStats
object RepairPairStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer"
                },
                "name":{
                    "type":"string"
                },
                "status":{
                    "$ref":"#/components/schemas/RepairStatus"
                },
                "rowsRepaired":{
                    "type":"integer"
                },
                "inserts":{
                    "type":"integer"
                },
                "updates":{
                    "type":"integer"
                },
                "deletes":{
                    "type":"integer"
                },
                "insertsWithWarnings":{
                    "type":"integer"
                },
                "deletesWithWarnings":{
                    "type":"integer"
                },
                "updatesWithWarnings":{
                    "type":"integer"
                },
                "rowComparisonsTotal":{
                    "type":"integer"
                },
                "totalBytesWithWarnings":{
                    "type":"integer"
                },
                "totalBytesRepaired":{
                    "type":"integer"
                },
                "startTime":{
                    "type":"string",
                    "format":"date-time",
                    "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
                    "example":"2024-02-03T10:15:30Z"
                },
                "endTime":{
                    "type":"string",
                    "format":"date-time",
                    "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
                    "example":"2024-02-03T10:15:30Z"
                },
                "comparePair":{
                    "allOf":[
                        {
                            "type":"object"
                        },
                        {
                            "$ref":"#/components/schemas/ComparePairViewStats"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : RepairPairStats-allOf[1]

Type: object

Show Source

comparePair: comparePair
deletes: integer
deletesWithWarnings: integer
endTime: string (date-time)

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

Example: 2024-02-03T10:15:30Z
id: integer
inserts: integer
insertsWithWarnings: integer
name: string
rowComparisonsTotal: integer
rowsRepaired: integer
startTime: string (date-time)

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

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

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

Repair Status.
totalBytesRepaired: integer
totalBytesWithWarnings: integer
updates: integer
updatesWithWarnings: integer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "rowsRepaired":{
            "type":"integer"
        },
        "inserts":{
            "type":"integer"
        },
        "updates":{
            "type":"integer"
        },
        "deletes":{
            "type":"integer"
        },
        "insertsWithWarnings":{
            "type":"integer"
        },
        "deletesWithWarnings":{
            "type":"integer"
        },
        "updatesWithWarnings":{
            "type":"integer"
        },
        "rowComparisonsTotal":{
            "type":"integer"
        },
        "totalBytesWithWarnings":{
            "type":"integer"
        },
        "totalBytesRepaired":{
            "type":"integer"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "comparePair":{
            "allOf":[
                {
                    "type":"object"
                },
                {
                    "$ref":"#/components/schemas/ComparePairViewStats"
                }
            ]
        }
    }
}

Nested Schema : comparePair

Match All

Show Source

object comparePair-allOf[0]
object ComparePairViewStats

{
    "allOf":[
        {
            "type":"object"
        },
        {
            "$ref":"#/components/schemas/ComparePairViewStats"
        }
    ]
}

Nested Schema : comparePair-allOf[0]

Type: object

Nested Schema : ComparePairViewStats

Type: object

Show Source

columnsSystemMapped: boolean
deltaProcessingEnabled: boolean
enabled: boolean
keyColumnsSystemMapped: boolean
srcTable: srcTable

Represents a table in compare pair with table and row partitions info, if any.
tgtTable: tgtTable

Represents a table in compare pair with table and row partitions info, if any.

{
    "properties":{
        "columnsSystemMapped":{
            "type":"boolean"
        },
        "deltaProcessingEnabled":{
            "type":"boolean"
        },
        "enabled":{
            "type":"boolean"
        },
        "keyColumnsSystemMapped":{
            "type":"boolean"
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Table"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Table"
                },
                {
                    "type":"object"
                }
            ]
        }
    }
}

Nested Schema : srcTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Show Source

object Table

Defines a table.
object srcTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/Table"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : tgtTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Show Source

object Table

Defines a table.
object tgtTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/Table"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Table

Type: object

Defines a table.

Show Source

catalog: string
filePattern: string

NSK Encribe file pattern.
isView: boolean
name: string
schema: string
tablePartition: object tablePartition

{
    "type":"object",
    "description":"Defines a table.",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        },
        "isView":{
            "type":"boolean"
        },
        "filePattern":{
            "type":"string",
            "description":"NSK Encribe file pattern."
        },
        "tablePartition":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TablePartition"
                }
            ]
        }
    }
}

Nested Schema : srcTable-allOf[1]

Type: object

Nested Schema : tablePartition

Type: object

Match All

Show Source

object TablePartition

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TablePartition"
        }
    ]
}

Nested Schema : TablePartition

Type: object

Show Source

name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : tgtTable-allOf[1]

Type: object

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