REST API for GoldenGate Veridata

Create Group

post

http://{host}:{port}/veridata/v1/services/configuration/groups

Required Role: Administrator, SuperUser, CommandLineOperator

Creates group.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

sourceConnectionId(required): integer (int64)

Source Connection ID.
targetConnectionId(required): integer (int64)

Target Connection ID.

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject_1" }, { "type":"object" } ], "properties":{ "sourceConnectionId":{ "type":"integer", "format":"int64", "description":"Source Connection ID." }, "targetConnectionId":{ "type":"integer", "format":"int64", "description":"Target Connection ID." } }, "required":[ "name", "sourceConnectionId", "targetConnectionId" ], "example":{ "name":"Oracle Employee Group,", "description":"This group has tables containing Oracle Employee details,", "sourceConnectionId":"1023,", "targetConnectionId":1024 } }

Match All

Show Source

object BaseObject_1
object type

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject_1" }, { "type":"object" } ], "properties":{ "sourceConnectionId":{ "type":"integer", "format":"int64", "description":"Source Connection ID." }, "targetConnectionId":{ "type":"integer", "format":"int64", "description":"Target Connection ID." } }, "required":[ "name", "sourceConnectionId", "targetConnectionId" ], "example":{ "name":"Oracle Employee Group,", "description":"This group has tables containing Oracle Employee details,", "sourceConnectionId":"1023,", "targetConnectionId":1024 } }

Example:

{ "name":"Oracle Employee Group,", "description":"This group has tables containing Oracle Employee details,", "sourceConnectionId":"1023,", "targetConnectionId":1024 }

Nested Schema : BaseObject_1

Type: object

Show Source

description: string

Object Description.
name: string

Object Name.

{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Object Name." }, "description":{ "type":"string", "description":"Object Description." } } }

Nested Schema : type

Type: object

Response

Supported Media Types

application/json
*/*

201 Response

Group created successfully.

Root Schema : CreateGroupResponse

Type: object

Show Source

sourceConnection: GroupConnection
targetConnection: GroupConnection

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "type":"object" } ], "properties":{ "sourceConnection":{ "$ref":"#/components/schemas/GroupConnection" }, "targetConnection":{ "$ref":"#/components/schemas/GroupConnection" } } }

Match All

Show Source

object BaseObject
object CreateGroupResponse-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "type":"object" } ], "properties":{ "sourceConnection":{ "$ref":"#/components/schemas/GroupConnection" }, "targetConnection":{ "$ref":"#/components/schemas/GroupConnection" } } }

Nested Schema : GroupConnection

Type: object

Show Source

id: integer (int64)

Source Connection ID.
name: string

{ "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Source Connection ID." }, "name":{ "type":"string" } } }

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 : CreateGroupResponse-allOf[1]

Type: object

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