Retrieve Message Explanation
get
/services/{version}/oggerr/{message}
Retrieve a detailed explanation for an Oracle GoldenGate message.
Request
Path Parameters
-
message: string
Minimum Length:
9
Maximum Length:9
Pattern:OGG[-][0-9]{5}
The Oracle GoldenGate Message Code, OGG-99999
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Oracle GoldenGate message explanation retrieved.
Root Schema : Oracle GoldenGate Message Explanation
Type:
object
Title:
Oracle GoldenGate Message Explanation
Explanation for a message issued by an Oracle GoldenGate application
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:messageExplanation" ]
-
action(optional):
string
Minimum Length:
1
Maximum Length:4095
The action to take when the message is issued -
cause(optional):
string
Minimum Length:
1
Maximum Length:4095
The cause associated with the message -
details(optional):
array details
Minimum Number of Items:
1
Maximum Number of Items:16
Description of details used to populate the message -
severity:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]
The severity of the message -
title:
string
Minimum Length:
1
Maximum Length:4095
The textual body of the message
Nested Schema : details
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
16
Description of details used to populate the message
Show Source
-
Array of:
object items
Description of a message detail
Nested Schema : items
Type:
object
Description of a message detail
Show Source
-
name:
string
Minimum Length:
1
Maximum Length:32
Name of detail -
type:
Allowed Values:
[ "Boolean", "CatalogName", "ColumnName", "DateTime", "Int32", "Int64", "LoginName", "ObjectName", "Pointer", "QualObjectName", "QualTableName", "SchemaName", "ServerName", "String", "TableName", "UInt32", "UInt64" ]
Message detail data type
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/oggerr/OGG-01234",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/oggerr/OGG-01234",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/message",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:messageExplanation",
"action":"Make certain that the Oracle GoldenGate versions on the source and target are the same. If the problem persists, contact Oracle Support.",
"cause":"The command received from the TCP/IP packet is not recognizable. The TCP packet itself is correct, but the enclosed message is unrecognizable.",
"severity":"ERROR",
"title":"Command sent was not recognized by receiving process"
}
}