REST API for GoldenGate Veridata

Retrieve Job statistics

get

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

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

This API is used to monitor running and completed Jobs. By default this returns the latest Job stats.

Request

Query Parameters

fromDate: string

Defines the start date range (inclusive) to filter out the Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'. "
jobId: string

The job ID.The response contains groups and compare pairs latest completed run.
last: string

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

The Job's Run ID. Example: runId=1024,0,0. Job runId can be obtained from Monitoring API.
status:
toDate: string

Defines the end date range (not inclusive) to filter out the Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'.
type: string

Supported values: GROUP/CP. Valid only when Job runId is passed in Query Param. When type=GROUP, returns Group basestats info and when type=CP, returns both Group and Compare Pair stats along with Job stats

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Returns a collection of completed Jobs with the statistics.

Root Schema : schema

Type: array

Show Source

Array of: JobStats

Statistics of Running or Completed Job.

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

Nested Schema : JobStats

Statistics of Running or Completed Job.

Match All

Statistics of Running or Completed Job.

Show Source

allOf JobsStats

Statistics of Running or Completed Jobs.
object JobStats-allOf[1]

{
    "description":"Statistics of Running or Completed Job.",
    "allOf":[
        {
            "$ref":"#/components/schemas/JobsStats"
        },
        {
            "type":"object",
            "properties":{
                "group":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/GroupStats"
                    }
                },
                "repairJobs":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RepairJobBase"
                    }
                }
            }
        }
    ]
}

Nested Schema : JobsStats

Statistics of Running or Completed Jobs.

Match All

Statistics of Running or Completed Jobs.

Show Source

object BaseStats
object JobsStats-allOf[1]

{
    "description":"Statistics of Running or Completed Jobs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "jobId":{
                    "type":"integer",
                    "format":"int64"
                },
                "jobName":{
                    "type":"string"
                },
                "status":{
                    "$ref":"#/components/schemas/JobFinishedStatus"
                },
                "repairStatus":{
                    "$ref":"#/components/schemas/RepairStatus"
                },
                "repairRunId":{
                    "$ref":"#/components/schemas/RunID",
                    "type":"object"
                },
                "comparePairsTotal":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsProcessed":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsWithErrors":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsWithOOS":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsWithNoOOS":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsCancelled":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsRunning":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "comparePairsPending":{
                    "type":"integer",
                    "format":"int32",
                    "default":"0"
                },
                "skippedRows":{
                    "type":"boolean",
                    "default":false
                }
            }
        }
    ]
}

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 : JobsStats-allOf[1]

Type: object

Show Source

comparePairsCancelled: integer (int32)

Default Value: 0
comparePairsPending: integer (int32)

Default Value: 0
comparePairsProcessed: integer (int32)

Default Value: 0
comparePairsRunning: integer (int32)

Default Value: 0
comparePairsTotal: integer (int32)

Default Value: 0
comparePairsWithErrors: integer (int32)

Default Value: 0
comparePairsWithNoOOS: integer (int32)

Default Value: 0
comparePairsWithOOS: integer (int32)

Default Value: 0
jobId: integer (int64)
jobName: string
repairRunId: object RunID

Run ID.
repairStatus: string

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

Repair Status.
skippedRows: boolean

Default Value: false
status: string

Allowed Values: [ "FAILED", "CANCELLED", "OUTOFSYNC", "INSYNC", "RUNNING", "FINISHED" ]

Job status.

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"integer",
            "format":"int64"
        },
        "jobName":{
            "type":"string"
        },
        "status":{
            "$ref":"#/components/schemas/JobFinishedStatus"
        },
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "repairRunId":{
            "$ref":"#/components/schemas/RunID",
            "type":"object"
        },
        "comparePairsTotal":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsProcessed":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsWithErrors":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsWithOOS":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsWithNoOOS":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsCancelled":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsRunning":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "comparePairsPending":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "skippedRows":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : JobStats-allOf[1]

Type: object

Show Source

group: array group
repairJobs: array repairJobs

{
    "type":"object",
    "properties":{
        "group":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GroupStats"
            }
        },
        "repairJobs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepairJobBase"
            }
        }
    }
}

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 : group

Type: array

Show Source

Array of: GroupStats

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

Nested Schema : repairJobs

Type: array

Show Source

Array of: object RepairJobBase

RepairJob Base object.

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

Nested Schema : GroupStats

Match All

Show Source

object BaseStats
object GroupStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "grpId":{
                    "type":"integer",
                    "format":"int64"
                },
                "name":{
                    "type":"string"
                },
                "numOfComparePairs":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "comparePairs":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ComparePairBaseStats"
                    }
                },
                "skippedRows":{
                    "type":"boolean",
                    "default":false
                },
                "repairStatus":{
                    "$ref":"#/components/schemas/RepairStatus"
                },
                "repairRunId":{
                    "$ref":"#/components/schemas/RunID",
                    "type":"object"
                },
                "srcConnection":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "id":{
                            "type":"integer"
                        },
                        "dbType":{
                            "type":"string"
                        }
                    }
                },
                "trgConnection":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "id":{
                            "type":"integer"
                        },
                        "dbType":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : GroupStats-allOf[1]

Type: object

Show Source

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

Default Value: 0
repairRunId: object RunID

Run ID.
repairStatus: string

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

Repair Status.
skippedRows: boolean

Default Value: false
srcConnection: object srcConnection
trgConnection: object trgConnection

{
    "type":"object",
    "properties":{
        "grpId":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "numOfComparePairs":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComparePairBaseStats"
            }
        },
        "skippedRows":{
            "type":"boolean",
            "default":false
        },
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "repairRunId":{
            "$ref":"#/components/schemas/RunID",
            "type":"object"
        },
        "srcConnection":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "id":{
                    "type":"integer"
                },
                "dbType":{
                    "type":"string"
                }
            }
        },
        "trgConnection":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "id":{
                    "type":"integer"
                },
                "dbType":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : comparePairs

Type: array

Show Source

Array of: ComparePairBaseStats

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

Nested Schema : srcConnection

Type: object

Show Source

dbType: string
id: integer
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"integer"
        },
        "dbType":{
            "type":"string"
        }
    }
}

Nested Schema : trgConnection

Type: object

Show Source

dbType: string
id: integer
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"integer"
        },
        "dbType":{
            "type":"string"
        }
    }
}

Nested Schema : ComparePairBaseStats

Match All

Show Source

object BaseStats
object ComparePairBaseStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "comparePairId":{
                    "type":"integer",
                    "format":"int64"
                },
                "name":{
                    "type":"string"
                },
                "numRowsOos":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "skippedRows":{
                    "type":"boolean",
                    "default":false
                },
                "phase":{
                    "$ref":"#/components/schemas/ComparisonPhase"
                },
                "status":{
                    "$ref":"#/components/schemas/JobFinishedStatus"
                },
                "repairStatus":{
                    "$ref":"#/components/schemas/RepairStatus"
                },
                "repairRunId":{
                    "$ref":"#/components/schemas/RunID",
                    "type":"object"
                },
                "errorMessage":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : ComparePairBaseStats-allOf[1]

Type: object

Show Source

comparePairId: integer (int64)
errorMessage: string
name: string
numRowsOos: integer (int64)

Default Value: 0
phase: string

Allowed Values: [ "INITIALIZING", "INITCOMPARE", "INITCOMPARECOOS", "COOS", "SORTING", "FINISHED" ]

enum for comparison phase.
repairRunId: object RunID

Run ID.
repairStatus: string

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

Repair Status.
skippedRows: boolean

Default Value: false
status: string

Allowed Values: [ "FAILED", "CANCELLED", "OUTOFSYNC", "INSYNC", "RUNNING", "FINISHED" ]

Job status.

{
    "type":"object",
    "properties":{
        "comparePairId":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "numRowsOos":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "skippedRows":{
            "type":"boolean",
            "default":false
        },
        "phase":{
            "$ref":"#/components/schemas/ComparisonPhase"
        },
        "status":{
            "$ref":"#/components/schemas/JobFinishedStatus"
        },
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "repairRunId":{
            "$ref":"#/components/schemas/RunID",
            "type":"object"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : RepairJobBase

Type: object

RepairJob Base object.

Show Source

endTime: string (date-time)

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

Example: 2024-02-03T10:15:30Z
repairRunId: repairRunId
repairStatus: string

Status of Repair operation.
startTime: string (date-time)

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

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

{
    "type":"object",
    "description":"RepairJob Base object.",
    "properties":{
        "repairRunId":{
            "allOf":[
                {
                    "type":"object"
                },
                {
                    "$ref":"#/components/schemas/RunID"
                }
            ]
        },
        "repairStatus":{
            "type":"string",
            "description":"Status of Repair operation."
        },
        "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 : repairRunId

Match All

Show Source

object repairRunId-allOf[0]
object RunID

Run ID.

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

Nested Schema : repairRunId-allOf[0]

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