Replace Configuration File
put
/services/{version}/config/files/{file}
Modify an existing configuration file.
Request
Supported Media Types
- application/json
Path Parameters
-
file: string
Minimum Length:
5
Maximum Length:255
Pattern:^(GLOBALS|ENCKEYS|[a-zA-Z0-9_$]*[.](prm|inc))$
The name of a configuration file.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Configuration
Type:
object
Title:
Oracle GoldenGate Configuration
This schema represents the plain contents of a parameter file
Show Source
-
$schema:
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
-
[0]:
string
Minimum Length:
0
Maximum Length:4095
Example Request (application/json)
{
"lines":[
"UseridAlias oggadmin",
"ReportCount Every 100000 Records"
]
}
Response
Supported Media Types
- application/json
200 Response
Configuration file updated successfully.
Root Schema : RESTful API Standard Response
Type:
object
Title:
RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ]
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
object
Oracle GoldenGate document from the request
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:
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:
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:
Allowed Values:
[ "ogg:message" ]
-
code:
string
Minimum Length:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued:
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])$
The date and time that the message was issued -
severity:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]
The severity of the message -
title:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[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: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"
}
],
"messages":[
]
}