Retrieve an existing Process Messages
get
/services/{version}/monitoring/{item}/messages
Request
Path Parameters
-
item: string
-
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:
Show Source
Oracle GoldenGate Process Messages
-
$schema(optional):
Allowed Values:
[ "monitoring:messages" ]
-
message(optional):
array message
Minimum Number of Items:
0
Maximum Number of Items:2147483647
Nested Schema : message
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
2147483647
Nested Schema : items
Type:
Show Source
object
-
code(optional):
string
Minimum Length:
1
Maximum Length:9
The message code -
identifier(optional):
integer
Minimum Value:
0
Maximum Value:4.294967295E9
The message id number -
issued(optional):
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(optional):
string
Minimum Length:
1
Maximum Length:16
The process name -
severity(optional):
string
Minimum Length:
1
Maximum Length:32
The message severity -
text(optional):
string
Minimum Length:
1
Maximum Length:4096
The mesage text
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":[
]
}