Retrieve Database Names
get
/services/{version}/connections/{connection}/databases
Required Role: User
Retrieve names of databases.
Request
Path Parameters
-
connection(required): string
Minimum Length:
1Maximum Length:61Pattern:^[a-zA-Z][a-zA-Z0-9_#$]{1,29}([.][a-zA-Z][a-zA-Z0-9_#$]{1,29})?$Connection name. For each alias in the credential store, a connection with the name 'domain.alias' exists.
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Query Parameters
-
name: string
Database name filter, including wildcard characters '*' or '?'.
Response
Supported Media Types
- application/json
200 Response
Database names retrieved successfully.
Root Schema : Oracle GoldenGate Collection
Type:
objectTitle:
Show Source
Oracle GoldenGate Collection-
$schema:
Allowed Values:
[ "ogg:collection" ] -
items(required):
array items
Minimum Number of Items:
0Maximum Number of Items:32767
Nested Schema : items
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
object items
Additional Properties Allowed:
true
Nested Schema : items
Type:
objectAdditional Properties Allowed:
Show Source
true-
$schema:
string
Minimum Length:
1Maximum Length:255Default Value:ogg:collectionItemName of schema for collection item, defaults to this schema -
links(required):
array links
Minimum Number of Items:
1Maximum Number of Items:16Links for item -
name(required):
string
Minimum Length:
1Maximum Length:255Item name -
status:
status
Item status
Nested Schema : links
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
16Links for item
Show Source
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
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:9012/services/v2/metadata-catalog/databases",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:collection",
"items":[
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DBNORTH_PDB1"
}
]
}
}