Retrieve API Versions
get
/services
Each Oracle GoldenGate service exposes one or more versions of the REST API for backward compatibility. Retrieve the collection of available API versions using this endpoint.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The list of available API versions was retrieved successfully.
Root Schema : Oracle GoldenGate Supported API versions
Type:
object
Title:
Show Source
Oracle GoldenGate Supported API versions
-
$schema(optional):
Allowed Values:
[ "api:versions" ]
-
items:
array items
Minimum Number of Items:
1
Maximum Number of Items:8
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
16
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "api:version" ]
-
catalog:
object catalog
-
isLatest(optional):
boolean
Default Value:
false
-
lifecycle(optional):
Default Value:
active
Allowed Values:[ "active", "deprecated" ]
-
links(optional):
array links
Minimum Number of Items:
0
Maximum Number of Items:16
-
terminationDate(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])$
-
version:
string
Minimum Length:
2
Maximum Length:5
Pattern:v[0-9.]+
Nested Schema : catalog
Type:
Show Source
object
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
16
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
16
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Example Response (application/json)
{
"$schema":"api:versions",
"items":[
{
"$schema":"api:version",
"catalog":{
"links":[
{
"href":"http://localhost:11001/services/v2/metadata-catalog",
"mediaType":"application/json",
"rel":"canonical"
}
]
},
"isLatest":true,
"lifecycle":"active",
"version":"v2"
}
],
"links":[
{
"href":"http://localhost:11001/services/v2",
"mediaType":"application/json",
"rel":"current"
},
{
"href":"http://localhost:11001/services",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services",
"mediaType":"application/json",
"rel":"self"
}
]
}