REST API for GoldenGate Veridata

Retrieve Job details

get

http://{host}:{port}/veridata/v1/services/configuration/jobs/{Id}

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

Retrieve Veridata Job details by Job ID.

Request

Path Parameters

Id(required): integer(int64)

Veridata Job ID.

Query Parameters

detail: boolean

Boolean value. When set to true fetches Compare Pair details of that Job.

Default Value: false

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Veridata Job details retrieved successfully.

Root Schema : GetJobById

Type: object

Show Source

groups: array groups

{ "allOf":[ { "$ref":"#/components/schemas/Job" }, { "type":"object" } ], "properties":{ "groups":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"group ID." }, "name":{ "type":"string", "description":"group name." }, "comparePairs":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Compare pair ID." }, "name":{ "type":"string", "description":"Compare pair name." }, "columnsSystemMapped":{ "type":"boolean" }, "deltaProcessingEnabled":{ "type":"boolean" }, "enabled":{ "type":"boolean", "description":"Indicates whether the Compare Pair is mapped to the group or not." }, "keyColumnsSystemMapped":{ "type":"boolean" } } } } } } } }, "example":{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1, "groups":[ { "id":1001, "name":"group1", "comparePairs":[ { "id":1001, "name":"compare-pair1", "columnsSystemMapped":true, "deltaProcessingEnabled":true, "enabled":true, "keyColumnsSystemMapped":true } ] } ] } }

Match All

Show Source

object allOf Job
object GetJobById-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/Job" }, { "type":"object" } ], "properties":{ "groups":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"group ID." }, "name":{ "type":"string", "description":"group name." }, "comparePairs":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Compare pair ID." }, "name":{ "type":"string", "description":"Compare pair name." }, "columnsSystemMapped":{ "type":"boolean" }, "deltaProcessingEnabled":{ "type":"boolean" }, "enabled":{ "type":"boolean", "description":"Indicates whether the Compare Pair is mapped to the group or not." }, "keyColumnsSystemMapped":{ "type":"boolean" } } } } } } } }, "example":{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1, "groups":[ { "id":1001, "name":"group1", "comparePairs":[ { "id":1001, "name":"compare-pair1", "columnsSystemMapped":true, "deltaProcessingEnabled":true, "enabled":true, "keyColumnsSystemMapped":true } ] } ] } }

Example:

{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1, "groups":[ { "id":1001, "name":"group1", "comparePairs":[ { "id":1001, "name":"compare-pair1", "columnsSystemMapped":true, "deltaProcessingEnabled":true, "enabled":true, "keyColumnsSystemMapped":true } ] } ] }

Nested Schema : groups

Type: array

Show Source

Array of: object items

{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"group ID." }, "name":{ "type":"string", "description":"group name." }, "comparePairs":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Compare pair ID." }, "name":{ "type":"string", "description":"Compare pair name." }, "columnsSystemMapped":{ "type":"boolean" }, "deltaProcessingEnabled":{ "type":"boolean" }, "enabled":{ "type":"boolean", "description":"Indicates whether the Compare Pair is mapped to the group or not." }, "keyColumnsSystemMapped":{ "type":"boolean" } } } } } } }

Nested Schema : Job

Type: object

Show Source

createdOn: string (date-time)

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

Example: 2024-02-03T10:15:30Z
numOfGroups: integer
profileId: integer

Default Value: 1
updatedOn: string (date-time)

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

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

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "type":"object" } ], "properties":{ "profileId":{ "type":"integer", "default":1 }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "updatedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "numOfGroups":{ "type":"integer" } }, "example":{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1 } }

Match All

Show Source

object BaseObject
object Job-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "type":"object" } ], "properties":{ "profileId":{ "type":"integer", "default":1 }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "updatedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "numOfGroups":{ "type":"integer" } }, "example":{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1 } }

Example:

{ "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1 }

Nested Schema : BaseObject

Type: object

Show Source

createdOn: string (date-time)

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

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

Object Description.
id: integer (int64)

Object Id.
name: string

Object Name.
updatedOn: string (date-time)

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

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

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Object Id.", "format":"int64" }, "name":{ "type":"string", "description":"Object Name." }, "description":{ "type":"string", "description":"Object Description." }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "updatedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" } } }

Nested Schema : Job-allOf[1]

Type: object

Nested Schema : GetJobById-allOf[1]

Type: object

Nested Schema : items

Type: object

Show Source

comparePairs: array comparePairs
id: integer

group ID.
name: string

group name.

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"group ID." }, "name":{ "type":"string", "description":"group name." }, "comparePairs":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Compare pair ID." }, "name":{ "type":"string", "description":"Compare pair name." }, "columnsSystemMapped":{ "type":"boolean" }, "deltaProcessingEnabled":{ "type":"boolean" }, "enabled":{ "type":"boolean", "description":"Indicates whether the Compare Pair is mapped to the group or not." }, "keyColumnsSystemMapped":{ "type":"boolean" } } } } } }

Nested Schema : comparePairs

Type: array

Show Source

Array of: object items

{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Compare pair ID." }, "name":{ "type":"string", "description":"Compare pair name." }, "columnsSystemMapped":{ "type":"boolean" }, "deltaProcessingEnabled":{ "type":"boolean" }, "enabled":{ "type":"boolean", "description":"Indicates whether the Compare Pair is mapped to the group or not." }, "keyColumnsSystemMapped":{ "type":"boolean" } } } }

Nested Schema : items

Type: object

Show Source

columnsSystemMapped: boolean
deltaProcessingEnabled: boolean
enabled: boolean

Indicates whether the Compare Pair is mapped to the group or not.
id: integer

Compare pair ID.
keyColumnsSystemMapped: boolean
name: string

Compare pair name.

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Compare pair ID." }, "name":{ "type":"string", "description":"Compare pair name." }, "columnsSystemMapped":{ "type":"boolean" }, "deltaProcessingEnabled":{ "type":"boolean" }, "enabled":{ "type":"boolean", "description":"Indicates whether the Compare Pair is mapped to the group or not." }, "keyColumnsSystemMapped":{ "type":"boolean" } } }

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

Example:

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

Example:

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

Example:

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

Example:

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