Jump to

• Request
• Response

Retrieve Veridata comparison report

get

http://{host}:{port}/veridata/v1/services/monitoring/comparison/{runId}/reports

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

API to get Veridata comparison report for Job, Group and Compare Pair.

Request

Path Parameters

• runId(required): string
  Defines the Run ID of the Job/Group/Compare pair for which the report should be fetched.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Report successfully fetched.

Body ()

Root Schema : Report

Type: object

Show Source

• content: string
  Report contents.
• name: string
  Report name with full path.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Report name with full path."
        },
        "content":{
            "type":"string",
            "description":"Report contents."
        }
    },
    "example":{
        "name":"/scratch/vdt23cNew/bin/../veridata/reports/rpt/job1234/00186923/base2/CP_SRC2=TRG2.rpt",
        "content":"Report Content"
    }
}

Example:

{
    "name":"/scratch/vdt23cNew/bin/../veridata/reports/rpt/job1234/00186923/base2/CP_SRC2=TRG2.rpt",
    "content":"Report Content"
}

400 Response

Bad Request.

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

"Unauthorized."

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

"Not found."

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

"Server error."

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

Back to Top