Retrieve Database Schemas
get
/services/{version}/connections/{connection}/databases/{database}
Required Role: User
Retrieve names of schemas in the database.
Request
Path Parameters
-
connection(required): string
Minimum Length:
1
Maximum Length:61
Pattern:^[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.
-
database(required): string
Minimum Length:
1
Maximum Length:130
Database name.
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Query Parameters
-
name: string
Schema name filter, including wildcard characters '*' or '?'.
Response
Supported Media Types
- application/json
200 Response
Schema names retrieved successfully.
Root Schema : Oracle GoldenGate Collection
Type:
object
Title:
Show Source
Oracle GoldenGate Collection
-
$schema:
Allowed Values:
[ "ogg:collection" ]
-
items(required):
array items
Minimum Number of Items:
0
Maximum Number of Items:32767
Nested Schema : items
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
32767
-
Array of:
object items
Additional Properties Allowed:
true
Nested Schema : items
Type:
object
Additional Properties Allowed:
Show Source
true
-
$schema:
string
Minimum Length:
1
Maximum Length:255
Default Value:ogg:collectionItem
Name of schema for collection item, defaults to this schema -
links(required):
array links
Minimum Number of Items:
1
Maximum Number of Items:16
Links for item -
name(required):
string
Minimum Length:
1
Maximum Length:255
Item name -
status:
status
Item status
Nested Schema : links
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
16
Links for item
Show Source
Nested Schema : items
Type:
Show Source
object
-
$schema:
Allowed Values:
[ "ogg:link" ]
-
description:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType:
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(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/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:9012/services/v2/metadata-catalog/database",
"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/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/AUDSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"AUDSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYSTEM",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYSTEM"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYSBACKUP",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYSBACKUP"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYSDG",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYSDG"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYSKM",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYSKM"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYSRAC",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYSRAC"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/OUTLN",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"OUTLN"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GSMADMIN_INTERNAL",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GSMADMIN_INTERNAL"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GSMUSER",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GSMUSER"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/DIP",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DIP"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/SYS%24UMF",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"SYS$UMF"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/XS%24NULL",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"XS$NULL"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/REMOTE_SCHEDULER_AGENT",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"REMOTE_SCHEDULER_AGENT"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/DBSFWUSER",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DBSFWUSER"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GGSHAREDCAP",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GGSHAREDCAP"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/APPQOSSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"APPQOSSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/DGPDB_INT",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DGPDB_INT"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/DBSNMP",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DBSNMP"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GSMCATUSER",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GSMCATUSER"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GGSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GGSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/CTXSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"CTXSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/XDB",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"XDB"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/ANONYMOUS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"ANONYMOUS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/WMSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"WMSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/OJVMSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"OJVMSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/DVSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DVSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/OLAPSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"OLAPSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/MDSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"MDSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/MDDATA",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"MDDATA"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/LBACSYS",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"LBACSYS"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/DVF",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"DVF"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/PDBADMIN",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"PDBADMIN"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GGADMIN",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GGADMIN"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/C%23%23GGADMIN",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"C##GGADMIN"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GGUSER01",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GGUSER01"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/GGUSER02",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"GGUSER02"
},
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/HR",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"HR"
}
]
}
}