Oracle GoldenGate

Retrieve an existing Process Messages

get

/services/{version}/monitoring/messages

Request

Path Parameters

version: string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Query Parameters

fromID(optional): string

Starting Index Number
limit(optional): string

Limit on the number of records to retreive
offset(optional): string

Starting offset in result set
toID(optional): string

Ending Index Number

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Process Messages

Type: object

Title: Oracle GoldenGate Process Messages

Show Source

$schema:

Allowed Values: [ "monitoring:messages" ]
message: array message

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Process Messages",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "monitoring:messages"
            ]
        },
        "message":{
            "type":"array",
            "minItems":0,
            "maxItems":2147483647,
            "items":{
                "type":"object",
                "properties":{
                    "identifier":{
                        "description":"The message id number",
                        "type":"integer",
                        "minimum":0,
                        "maximum":4.294967295E9
                    },
                    "process":{
                        "description":"The process name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":16
                    },
                    "issued":{
                        "description":"Date and Time the message was issued",
                        "type":"string",
                        "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
                        "minLength":20,
                        "maxLength":32
                    },
                    "code":{
                        "description":"The message code",
                        "type":"string",
                        "minLength":1,
                        "maxLength":9
                    },
                    "severity":{
                        "description":"The message severity",
                        "type":"string",
                        "minLength":1,
                        "maxLength":32
                    },
                    "text":{
                        "description":"The mesage text",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4096
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : message

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

[0]: object items

{
    "type":"array",
    "minItems":0,
    "maxItems":2147483647,
    "items":{
        "type":"object",
        "properties":{
            "identifier":{
                "description":"The message id number",
                "type":"integer",
                "minimum":0,
                "maximum":4.294967295E9
            },
            "process":{
                "description":"The process name",
                "type":"string",
                "minLength":1,
                "maxLength":16
            },
            "issued":{
                "description":"Date and Time the message was issued",
                "type":"string",
                "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
                "minLength":20,
                "maxLength":32
            },
            "code":{
                "description":"The message code",
                "type":"string",
                "minLength":1,
                "maxLength":9
            },
            "severity":{
                "description":"The message severity",
                "type":"string",
                "minLength":1,
                "maxLength":32
            },
            "text":{
                "description":"The mesage text",
                "type":"string",
                "minLength":1,
                "maxLength":4096
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

code: string

Minimum Length: 1

Maximum Length: 9

The message code
identifier: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

The message id number
issued: string

Minimum Length: 20

Maximum Length: 32

Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$

Date and Time the message was issued
process: string

Minimum Length: 1

Maximum Length: 16

The process name
severity: string

Minimum Length: 1

Maximum Length: 32

The message severity
text: string

Minimum Length: 1

Maximum Length: 4096

The mesage text

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"The message id number",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "process":{
            "description":"The process name",
            "type":"string",
            "minLength":1,
            "maxLength":16
        },
        "issued":{
            "description":"Date and Time the message was issued",
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":20,
            "maxLength":32
        },
        "code":{
            "description":"The message code",
            "type":"string",
            "minLength":1,
            "maxLength":9
        },
        "severity":{
            "description":"The message severity",
            "type":"string",
            "minLength":1,
            "maxLength":32
        },
        "text":{
            "description":"The mesage text",
            "type":"string",
            "minLength":1,
            "maxLength":4096
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"monitoring:messages",
        "identifier":1,
        "process":"MGR",
        "issued":"2015-06-05T13:22:18.034Z",
        "code":"OGG-12345",
        "severity":"GGInfo",
        "text":"This is a sample message"
    },
    "messages":[
    ],
    "links":[
    ]
}