1. REST API for GoldenGate Veridata
  2. Tasks
  3. Monitor

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
  • Defines the start date range (inclusive) to filter out the Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'. "
  • The job ID.The response contains groups and compare pairs latest completed run.
  • Fetch Job stats of last x units. Supported units D(Days) or H(hours) or M(minutes). Example: 1D
  • The Job's Run ID. Example: runId=1024,0,0. Job runId can be obtained from Monitoring API.
  • Defines the end date range (not inclusive) to filter out the Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'.
  • 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.

Back to Top

Response

Supported Media Types

200 Response

Returns a collection of completed Jobs with the statistics.
Body ()
Root Schema : schema
Type: array
Show Source
Example:
[
    {
        "runId":{
            "asString":"12377/0/0",
            "comparePairNum":0,
            "groupNum":0,
            "runID":12377
        },
        "startTime":"2024-02-03T10:15:30Z",
        "endTime":"2024-02-03T10:15:30Z",
        "jobId":1017,
        "jobName":"repairTestJob",
        "status":"OOS",
        "repairStatus":"OOS",
        "repairRunId":{
            "asString":"10207/0/0",
            "comparePairNum":0,
            "groupNum":0,
            "runID":"10207"
        },
        "comparePairsTotal":1,
        "comparePairsProcessed":1,
        "comparePairsWithErrors":0,
        "comparePairsWithOOS":1,
        "comparePairsWithNoOOS":0,
        "comparePairsCancelled":0,
        "comparePairsRunning":0,
        "comparePairsPending":0,
        "skippedRows":false,
        "group":[
            {
                "runId":{
                    "asString":"12377/1/0",
                    "comparePairNum":0,
                    "groupNum":1,
                    "runID":12377
                },
                "startTime":"2024-02-03T10:15:30Z",
                "endTime":"2024-02-03T10:15:30Z",
                "grpId":1007,
                "name":"base",
                "numOfComparePairs":1,
                "comparePairs":[
                    {
                        "runId":{
                            "asString":"12377/1/1",
                            "comparePairNum":1,
                            "groupNum":1,
                            "runID":12377
                        },
                        "startTime":"2024-02-03T10:15:30Z",
                        "endTime":"2024-02-03T10:15:30Z",
                        "comparePairId":1017,
                        "name":"SRC1=TRG1",
                        "numRowsOos":7,
                        "skippedRows":false,
                        "phase":"FINISHED",
                        "status":"OOS",
                        "repairStatus":"OOS",
                        "repairRunId":{
                            "asString":"10207/1/1",
                            "comparePairNum":1,
                            "groupNum":1,
                            "runID":10207
                        },
                        "errorMessage":""
                    }
                ],
                "skippedRows":false,
                "repairStatus":"OOS",
                "repairRunId":{
                    "asString":"10207/1/0",
                    "comparePairNum":0,
                    "groupNum":1,
                    "runID":10207
                },
                "srcConnection":{
                    "name":"oracleLocal",
                    "id":1014,
                    "dbType":"oracle"
                },
                "trgConnection":{
                    "name":"oracleLocal",
                    "id":1014,
                    "dbType":"oracle"
                }
            }
        ],
        "repairJobs":[
            {
                "repairRunId":{
                    "asString":"10207/0/0",
                    "comparePairNum":0,
                    "groupNum":0,
                    "runID":10207
                },
                "repairStatus":"OOS",
                "startTime":"2024-02-03T10:15:30Z",
                "endTime":"2024-02-03T10:15:30Z"
            }
        ]
    }
]
Nested Schema : JobStats
Statistics of Running or Completed Job.
Match All
Statistics of Running or Completed Job.
Statistics of Running or Completed Job.
Show Source
Nested Schema : JobsStats
Statistics of Running or Completed Jobs.
Match All
Statistics of Running or Completed Jobs.
Statistics of Running or Completed Jobs.
Show Source
Nested Schema : BaseStats
Type: object
Show Source
Nested Schema : JobsStats-allOf[1]
Type: object
Show Source
Nested Schema : JobStats-allOf[1]
Type: object
Show Source
Nested Schema : RunID
Type: object
Run ID.
Show Source
Nested Schema : group
Type: array
Show Source
Nested Schema : repairJobs
Type: array
Show Source
Nested Schema : GroupStats
Match All
Show Source
Nested Schema : GroupStats-allOf[1]
Type: object
Show Source
Nested Schema : comparePairs
Type: array
Show Source
Nested Schema : srcConnection
Type: object
Show Source
Nested Schema : trgConnection
Type: object
Show Source
Nested Schema : ComparePairBaseStats
Match All
Show Source
Nested Schema : ComparePairBaseStats-allOf[1]
Type: object
Show Source
Nested Schema : RepairJobBase
Type: object
RepairJob Base object.
Show Source
Nested Schema : repairRunId
Match All
Show Source
Nested Schema : repairRunId-allOf[0]
Type: object

400 Response

Bad Request.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

"Unauthorized".
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

"Not found".
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

"Server error".
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}
Back to Top