Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Message Explanation

get

/services/{version}/oggerr/{message}

Required Role: Any

Retrieve a detailed explanation for an Oracle GoldenGate message.

Request

Path Parameters

message(required): string

Minimum Length: 9

Maximum Length: 9

Pattern: OGG[-][0-9]{5}

The Oracle GoldenGate Message Code, OGG-99999
version(required): 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:

Allowed Values: [ "ogg:messageExplanation" ]
action: string

Minimum Length: 1

Maximum Length: 4095

The action to take when the message is issued
cause: string

Minimum Length: 1

Maximum Length: 4095

The cause associated with the message
details: array details

Minimum Number of Items: 1

Maximum Number of Items: 16

Description of details used to populate the message
severity(required):

Allowed Values: [ "INFO", "WARNING", "ERROR" ]

The severity of the message
title(required): string

Minimum Length: 1

Maximum Length: 4095

The textual body of the message

{
    "title":"Oracle GoldenGate Message Explanation",
    "description":"Explanation for a message issued by an Oracle GoldenGate application",
    "required":[
        "severity",
        "title"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:messageExplanation"
            ]
        },
        "severity":{
            "description":"The severity of the message",
            "enum":[
                "INFO",
                "WARNING",
                "ERROR"
            ]
        },
        "title":{
            "description":"The textual body of the message",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "details":{
            "description":"Description of details used to populate the message",
            "type":"array",
            "items":{
                "description":"Description of a message detail",
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Name of detail",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"32"
                    },
                    "type":{
                        "description":"Message detail data type",
                        "enum":[
                            "Boolean",
                            "CatalogName",
                            "ColumnName",
                            "DateTime",
                            "Int32",
                            "Int64",
                            "LoginName",
                            "ObjectName",
                            "Pointer",
                            "QualObjectName",
                            "QualTableName",
                            "SchemaName",
                            "ServerName",
                            "String",
                            "TableName",
                            "UInt32",
                            "UInt64"
                        ]
                    }
                },
                "required":[
                    "name",
                    "type"
                ],
                "additionalProperties":false
            },
            "minItems":"1",
            "maxItems":"16"
        },
        "cause":{
            "description":"The cause associated with the message",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "action":{
            "description":"The action to take when the message is issued",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        }
    },
    "additionalProperties":false
}

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

{
    "description":"Description of details used to populate the message",
    "type":"array",
    "items":{
        "description":"Description of a message detail",
        "type":"object",
        "properties":{
            "name":{
                "description":"Name of detail",
                "type":"string",
                "minLength":"1",
                "maxLength":"32"
            },
            "type":{
                "description":"Message detail data type",
                "enum":[
                    "Boolean",
                    "CatalogName",
                    "ColumnName",
                    "DateTime",
                    "Int32",
                    "Int64",
                    "LoginName",
                    "ObjectName",
                    "Pointer",
                    "QualObjectName",
                    "QualTableName",
                    "SchemaName",
                    "ServerName",
                    "String",
                    "TableName",
                    "UInt32",
                    "UInt64"
                ]
            }
        },
        "required":[
            "name",
            "type"
        ],
        "additionalProperties":false
    },
    "minItems":"1",
    "maxItems":"16"
}

Nested Schema : items

Type: object

Description of a message detail

Show Source

name(required): string

Minimum Length: 1

Maximum Length: 32

Name of detail
type(required):

Allowed Values: [ "Boolean", "CatalogName", "ColumnName", "DateTime", "Int32", "Int64", "LoginName", "ObjectName", "Pointer", "QualObjectName", "QualTableName", "SchemaName", "ServerName", "String", "TableName", "UInt32", "UInt64" ]

Message detail data type

{
    "description":"Description of a message detail",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of detail",
            "type":"string",
            "minLength":"1",
            "maxLength":"32"
        },
        "type":{
            "description":"Message detail data type",
            "enum":[
                "Boolean",
                "CatalogName",
                "ColumnName",
                "DateTime",
                "Int32",
                "Int64",
                "LoginName",
                "ObjectName",
                "Pointer",
                "QualObjectName",
                "QualTableName",
                "SchemaName",
                "ServerName",
                "String",
                "TableName",
                "UInt32",
                "UInt64"
            ]
        }
    },
    "required":[
        "name",
        "type"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/oggerr/OGG-01234",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/oggerr/OGG-01234",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/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"
    }
}