REST API for GoldenGate Veridata

All REST Endpoints

Common/Retrieve Server Information

The operations from the Common/Retrieve Server Information category.

Retrieve Veridata Server details: Method: get
Path: http://{host}:{port}/veridata/v1/services/server/info

Configure/Compare Pairs

The operations from the Configure/Compare Pairs category.

Create Compare Pairs: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/group/{groupId}
Create or Generate Compare Pairs using mapped objects: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/mappings/group/{groupId}
Delete Compare Pair: Method: delete
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/{Id}
Generate Column Mapping Pairs: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/{Id}/colmap
Generate Compare Pairs using mapped objects: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/cps
Generate Mapping Objects using the Mapping Rules: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/mappings
Replace Compare Pair: Method: put
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/{Id}
Retrieve Compare Pair: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/{Id}

Configure/Connections

The operations from the Configure/Connections category.

Create Agent Connection: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/connections
Delete Agent Connection: Method: delete
Path: http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}
Retrieve Agent Connection: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}
Retrieve Agent Connections: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/connections
Retrieve Connection Status: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}/status
Retrieve Metadata.: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}/metadata
Update Agent Connection: Method: patch
Path: http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}

Configure/Groups

The operations from the Configure/Groups category.

Clone Group: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/groups/clone/{Id}
Create Group: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/groups
Delete Group: Method: delete
Path: http://{host}:{port}/veridata/v1/services/configuration/groups/{Id}
Retrieve Group details: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/groups/{Id}
Retrieve Groups: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/groups
Update Group: Method: patch
Path: http://{host}:{port}/veridata/v1/services/configuration/groups/{Id}

Configure/Jobs

The operations from the Configure/Jobs category.

Create Job: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/jobs
Delete Job: Method: delete
Path: http://{host}:{port}/veridata/v1/services/configuration/jobs/{Id}
Replace Job: Method: put
Path: http://{host}:{port}/veridata/v1/services/configuration/jobs/{Id}
Retrieve Job details: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/jobs/{Id}
Retrieve Jobs: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/jobs

Configure/Profiles

The operations from the Configure/Profiles category.

Create Profile: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/profiles
Delete Profile: Method: delete
Path: http://{host}:{port}/veridata/v1/services/configuration/profiles/{Id}
Reset Profile: Method: put
Path: http://{host}:{port}/veridata/v1/services/configuration/profiles/{Id}/reset
Retrieve Profile details: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/profiles/{Id}
Retrieve Profiles: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/profiles
Update Profile: Method: patch
Path: http://{host}:{port}/veridata/v1/services/configuration/profiles/{Id}

Manage Import and Export/Export

The operations from the Manage Import and Export/Export category.

Export Veridata Configurations: Method: get
Path: http://{host}:{port}/veridata/v1/services/configuration/export

Manage Import and Export/Import

The operations from the Manage Import and Export/Import category.

Import GoldenGate Parameter File: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/vgpp
Import Veridata XML: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/import

Manage User Session

Extend User Session: Method: get
Path: http://{host}:{port}/veridata/v1/session/extend
Invalidate Session: Method: get
Path: http://{host}:{port}/veridata/v1/session/invalidate
Login to Veridata: Method: get
Path: http://{host}:{port}/veridata/v1/auth/login

Manage User Settings/Favorites

The operations from the Manage User Settings/Favorites category.

Create User Favorites: Method: post
Path: http://{host}:{port}/veridata/v1/services/preferences/favorites
Delete User Favorite: Method: delete
Path: http://{host}:{port}/veridata/v1/services/preferences/favorites/{type}/{Id}
Retrieve User Favorites: Method: get
Path: http://{host}:{port}/veridata/v1/services/preferences/favorites
Update User Favorites: Method: patch
Path: http://{host}:{port}/veridata/v1/services/preferences/favorites

Manage User Settings/Preferences

The operations from the Manage User Settings/Preferences category.

Retrieve User Preferences: Method: get
Path: http://{host}:{port}/veridata/v1/services/preferences
Update User Preferences: Method: patch
Path: http://{host}:{port}/veridata/v1/services/preferences

Manage User/User Groups

The operations from the Manage User/User Groups category.

Create User Group: Method: post
Path: http://{host}:{port}/veridata/v1/services/admin/usergroups
Delete User Group: Method: delete
Path: http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}
Replace User Group: Method: put
Path: http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}
Retrieve User Group: Method: get
Path: http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}
Retrieve User Groups: Method: get
Path: http://{host}:{port}/veridata/v1/services/admin/usergroups

Manage User/Users

The operations from the Manage User/Users category.

Create a User: Method: post
Path: http://{host}:{port}/veridata/v1/services/admin/users
Delete User: Method: delete
Path: http://{host}:{port}/veridata/v1/services/admin/users/{Id}
Replace User: Method: put
Path: http://{host}:{port}/veridata/v1/services/admin/users/{Id}
Retrieve Current User: Method: get
Path: http://{host}:{port}/veridata/v1/services/currentuser
Retrieve User: Method: get
Path: http://{host}:{port}/veridata/v1/services/admin/users/{Id}
Retrieve User Access: Method: get
Path: http://{host}:{port}/veridata/v1/services/admin/access
Retrieve Users: Method: get
Path: http://{host}:{port}/veridata/v1/services/admin/users
Update Current User: Method: patch
Path: http://{host}:{port}/veridata/v1/services/currentuser
Update Current User Password: Method: patch
Path: http://{host}:{port}/veridata/v1/services/currentuser/password/reset
Update User Password: Method: patch
Path: http://{host}:{port}/veridata/v1/services/admin/users/{Id}/password

Monitor

Retrieve Compare Pair Statistics: Method: get
Path: http://{host}:{port}/veridata/v1/services/monitoring/cps
Retrieve Job statistics: Method: get
Path: http://{host}:{port}/veridata/v1/services/monitoring/jobs
Retrieve Out-of-Sync data.: Method: get
Path: http://{host}:{port}/veridata/v1/services/oos/{runId}
Retrieve Repair Statistics: Method: get
Path: http://{host}:{port}/veridata/v1/services/monitoring/repair/jobs
Retrieve repaired row details: Method: get
Path: http://{host}:{port}/veridata/v1/services/monitoring/repair/cps/{runId}
Retrieve Veridata comparison report: Method: get
Path: http://{host}:{port}/veridata/v1/services/monitoring/comparison/{runId}/reports
Retrieve Veridata repair report: Method: get
Path: http://{host}:{port}/veridata/v1/services/monitoring/repair/{runId}/reports

Purge

Delete Veridata statistics: Method: delete
Path: http://{host}:{port}/veridata/v1/services/purge/stats

Repair

Repair Job: Method: post
Path: http://{host}:{port}/veridata/v1/services/repair/jobs/{runId}
Stop Repair Job: Method: post
Path: http://{host}:{port}/veridata/v1/services/repair/jobs/{runId}/stop

Run Jobs

Run a Job: Method: post
Path: http://{host}:{port}/veridata/v1/services/execution/jobs/{Id}
Stop Compare Pair/Job: Method: post
Path: http://{host}:{port}/veridata/v1/services/execution/jobs/{runId}/stop

Validate

Validate Agent Connection: Method: post
Path: http://{host}:{port}/veridata/v1/services/validate/connection
Validate Agent Database: Method: post
Path: http://{host}:{port}/veridata/v1/services/validate/connection/db
Validate Compare Pairs: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/cps/validate/{Id}
Validate Group: Method: post
Path: http://{host}:{port}/veridata/v1/services/configuration/groups/validate/{Id}