REST API for GoldenGate Veridata

Create User Favorites

post

http://{host}:{port}/veridata/v1/services/preferences/favorites

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

Create Veridata User Favorites

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

connections: array connections
jobs: array jobs
monitorJobs: array monitorJobs

{ "type":"object", "properties":{ "jobs":{ "type":"array", "items":{ "type":"integer", "description":"List of Job ID's." } }, "monitorJobs":{ "type":"array", "items":{ "type":"string", "description":"List of Job RunID's." } }, "connections":{ "type":"array", "items":{ "type":"integer", "description":"List of Connection ID's." } } }, "example":{ "jobs":[ 0 ], "monitorJobs":[ "string" ], "connections":[ 0 ] } }

Example:

{ "jobs":[ 0 ], "monitorJobs":[ "string" ], "connections":[ 0 ] }

Nested Schema : connections

Type: array

Show Source

Array of: integer

List of Connection ID's.

{ "type":"array", "items":{ "type":"integer", "description":"List of Connection ID's." } }

Nested Schema : jobs

Type: array

Show Source

Array of: integer

List of Job ID's.

{ "type":"array", "items":{ "type":"integer", "description":"List of Job ID's." } }

Nested Schema : monitorJobs

Type: array

Show Source

Array of: string

List of Job RunID's.

{ "type":"array", "items":{ "type":"string", "description":"List of Job RunID's." } }

Response

Supported Media Types

application/json

201 Response

User Favorites created successfully.

Root Schema : ListUserFavorites

Type: object

Show Source

connections: array connections
jobs: array jobs
monitorJobs: array monitorJobs

{ "type":"object", "properties":{ "jobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/FavoriteJob" } }, "monitorJobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/FavoriteMonitorJob" } }, "connections":{ "type":"array", "items":{ "$ref":"#/components/schemas/FavoriteConnection" } } }, "example":{ "jobs":[ { "id":1020, "name":"job1" } ], "monitorJobs":[ { "runId":1021, "name":"job1" } ], "connections":[ { "id":1001, "name":"oracle" } ] } }

Example:

{ "jobs":[ { "id":1020, "name":"job1" } ], "monitorJobs":[ { "runId":1021, "name":"job1" } ], "connections":[ { "id":1001, "name":"oracle" } ] }

Nested Schema : connections

Type: array

Show Source

Array of: object FavoriteConnection

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

Nested Schema : jobs

Type: array

Show Source

Array of: object FavoriteJob

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

Nested Schema : monitorJobs

Type: array

Show Source

Array of: object FavoriteMonitorJob

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

Nested Schema : FavoriteConnection

Type: object

Show Source

id: integer (int64)

Connection ID. This is a required parameter.
name: string

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Connection ID. This is a required parameter.", "format":"int64" }, "name":{ "type":"string" } } }

Nested Schema : FavoriteJob

Type: object

Show Source

id: integer (int64)

Job ID. This is a required parameter.
name: string

{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Job ID. This is a required parameter.", "format":"int64" }, "name":{ "type":"string" } } }

Nested Schema : FavoriteMonitorJob

Type: object

Show Source

name: string
runId: integer (int64)

Run ID. This is a required parameter.

{ "type":"object", "properties":{ "runId":{ "type":"integer", "format":"int64", "description":"Run ID. This is a required parameter." }, "name":{ "type":"string" } } }

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