Retrieve Configuration File
get
/services/{version}/config/files/{file}
Retrieve the contents of a configuration file.
Request
Path Parameters
-
file: string
Minimum Length:
5
Maximum Length:255
Pattern:^(GLOBALS|ENCKEYS|[a-zA-Z0-9_$]*[.](prm|inc|properties))$
The name of a configuration file.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Configuration file retrieved successfully.
Root Schema : Oracle GoldenGate Configuration
Type:
object
Title:
Oracle GoldenGate Configuration
This schema represents the plain contents of a parameter file
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:config" ]
-
lines:
array lines
Minimum Number of Items:
0
Maximum Number of Items:32767
Nested Schema : lines
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
32767
-
Array of:
string
Minimum Length:
0
Maximum Length:4095
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/config/files/Common.inc",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/config/files/Common.inc",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/file",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:config",
"lines":[
"UseridAlias oggadmin",
"ReportCount Every 100000 Records"
]
}
}