Json Schema
get
/services/{version}/dataTargetTypes/{dataTargetType}
Retrieve the json schema of a supported data target.
Request
Path Parameters
-
dataTargetType: string
Minimum Length:
1Maximum Length:128Pattern:^[A-Za-z][A-Za-z0-9-_.]*$The name of a supported data target
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
The data target json schema was retrieved successfully.
Root Schema : Oracle GoldenGate Distribution Path Data Target Type
Type:
objectTitle:
Oracle GoldenGate Distribution Path Data Target TypeA data target type supported in Oracle GoldenGate Distribution Path
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:distPathTargetType" ] -
dataTargetSchema:
object dataTargetSchema
the json schema for the supported data target type
-
dataTargetType:
string
Minimum Length:
1Maximum Length:128Pattern:^[A-Za-z][A-Za-z0-9-_.]*$Data Target Type Name
Nested Schema : dataTargetSchema
Type:
objectthe json schema for the supported data target type
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"rel":"canonical",
"href":"http://serverhost:9002/services/v2/dataTargetTypes/distPathEndpointTrail",
"mediaType":"application/json"
},
{
"rel":"self",
"href":"http://serverhost:9002/services/v2/dataTargetTypes/distPathEndpointTrail",
"mediaType":"application/json"
},
{
"rel":"describedby",
"href":"http://serverhost:9002/services/v2/metadata-catalog/dataTargetType",
"mediaType":"application/schema+json"
}
],
"messages":[
],
"response":{
"dataTargetType":"distPathEndpointTrail",
"dataTargetSchema":{
"id":"ogg:distPathEndpointTrail",
"title":"Oracle GoldenGate Distribution Path Local EndPoint",
"$schema":"http://json-schema.org/draft-04/schema#",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]$",
"minLength":2,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":4096
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeTransactionInfoText":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfoSql":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfoXml":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
],
"default":"canonical"
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
},
"keyname":{
"description":"encryption key logical name",
"type":"string",
"minLength":1,
"maxLength":128
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
}
}
}