Describe API Version
get
/services/{version}
Required Role: Any
Use this endpoint to obtain details of a specific version of an Oracle GoldenGate Service REST API.
Request
Path Parameters
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
The API version details were retrieved successfully.
Root Schema : Oracle GoldenGate RESTful API version
Type:
objectTitle:
Show Source
Oracle GoldenGate RESTful API version-
$schema:
Allowed Values:
[ "api:version" ] -
catalog(required):
object catalog
-
isLatest:
boolean
Default Value:
false -
lifecycle:
Default Value:
activeAllowed Values:[ "active", "deprecated" ] -
links:
array links
Minimum Number of Items:
0Maximum Number of Items:16 -
messages:
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Messages issued during processing of the request -
terminationDate:
string
Minimum Length:
20Maximum Length:32Pattern:^[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])$ -
version(required):
string
Minimum Length:
2Maximum Length:5Pattern:v[0-9.]+
Nested Schema : catalog
Type:
Show Source
object-
links:
array links
Minimum Number of Items:
1Maximum Number of Items:16
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
16Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Messages issued during processing of the request
Show Source
Nested Schema : links
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
16Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[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])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:version",
"catalog":{
"links":[
{
"href":"http://localhost:9012/services/v2/metadata-catalog",
"mediaType":"application/json",
"rel":"canonical"
}
]
},
"isLatest":true,
"lifecycle":"active",
"links":[
{
"href":"http://localhost:9012/services/v2",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2",
"mediaType":"application/json",
"rel":"self"
}
],
"version":"v2"
}