REST API for GoldenGate Veridata

Reset Profile

put

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

Required Role: Administrator, SuperUser, CommandLineOperator

Resets Veridata Profile to default value.

Request

Path Parameters

Id(required): integer

There's no request body for this operation.

Response

Supported Media Types

application/json
*/*

200 Response

Profile returned successfully. The attributes of the profile will be reset to default values.

Root Schema : DetailedProfile

Type: object

Match All

Show Source

object BaseObject
object ProfileObject2

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/BaseObject" }, { "$ref":"#/components/schemas/ProfileObject2" } ], "example":{ "id":0, "name":"profile1", "description":"profile", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "attributesList":[ { "name":"ProfileGeneralOOSFormat", "default":true, "value":"binary", "defaultValue":"xml", "type":"ENUM", "options":"string", "min":0, "max":0 } ] } }

Example:

{ "id":0, "name":"profile1", "description":"profile", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "attributesList":[ { "name":"ProfileGeneralOOSFormat", "default":true, "value":"binary", "defaultValue":"xml", "type":"ENUM", "options":"string", "min":0, "max":0 } ] }

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 : ProfileObject2

Type: object

Show Source

attributesList: array attributesList

{ "type":"object", "properties":{ "attributesList":{ "type":"array", "items":{ "$ref":"#/components/schemas/Attribute" } } } }

Nested Schema : attributesList

Type: array

Show Source

Array of: object Attribute

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

Nested Schema : Attribute

Type: object

Show Source

default: boolean
defaultValue: string
max: integer

It is displayed when type is INTEGER.
min: integer

It is displayed when type is INTEGER.
name: string

Allowed Values: [ "ProfileGeneralOOSFormat", "ProfileGeneralOOSXMLChunkSize", "ReportInSyncRows", "ReportInFlightRows", "SortUsing", "SourceTempDirectory", "TargetTempDirectory", "ProfileGeneralMaxParallelCompares", "InitCompRptMaxRecsOOS", "InitCompRptDtlsOutRecordDtls", "InitCompRptRptIntervalSecs", "InitCompRptRptIntervalRecs", "InitCompRptLimitInputRows", "InitCompHintSrc", "InitCompHintTarg", "InitCompRptDtls", "InitCompRptDtlsErrAlarmThreshold", "VeriAgtInitialCompareSrcAgentPort", "VeriAgtInitialCompareTargAgentPort", "VeriAgtCOOSSrcAgentPort", "VeriAgtCOOSTargAgentPort", "NSKInitialCompareSrcCPU", "NSKInitialCompareSrcPriority", "NSKInitialCompareSrcProcessName", "NSKInitialCompareTargCPU", "NSKInitialCompareTargPriority", "NSKInitialCompareTargProcessName", "NSKCOOSSrcProcessName", "NSKCOOSSrcCPU", "NSKCOOSSrcPriority", "NSKCOOSTargProcessName", "NSKCOOSTargCPU", "NSKCOOSTargPriority", "DoCOOSStep", "COOSConcurrent", "COOSConfirmDelaySecs", "COOSBatchSize", "COOSRptMaxRecsOOS", "COOSRptDtlsOutRecordDtls", "COOSRptRptIntervalSecs", "COOSRptRptIntervalRecs", "COOSHintSrc", "COOSHintTarg", "COOSRptDtls", "COOSRptDtlsErrAlarmThreshold", "RepairAfterCompare", "RepairBatchSize", "RepairTransactionSize", "ConcurrRepairOperations", "ChkChangedValues", "TermWhenMaxRepairWarnings", "RepairSQLPath", "WriteRepairSuccessMsgs", "ProfileDisableDbTriggers" ]
options: string

It is displayed when type is ENUM.
type: string

Allowed Values: [ "BOOLEAN", "ENUM", "INTEGER", "STRING" ]
value: string

{ "type":"object", "properties":{ "name":{ "$ref":"#/components/schemas/AttributeEnum" }, "default":{ "type":"boolean" }, "value":{ "type":"string" }, "defaultValue":{ "type":"string" }, "type":{ "type":"string", "enum":[ "BOOLEAN", "ENUM", "INTEGER", "STRING" ] }, "options":{ "type":"string", "description":"It is displayed when type is ENUM." }, "min":{ "type":"integer", "description":"It is displayed when type is INTEGER." }, "max":{ "type":"integer", "description":"It is displayed when type is INTEGER." } } }

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