Create Extract
post
/services/{version}/extracts/{extract}
Create a new extract process.
Request
Supported Media Types
- application/json
Path Parameters
-
extract: string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$The name of the extract. Extract names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Extract
Type:
objectTitle:
Show Source
Oracle GoldenGate Extract-
$schema(optional):
Allowed Values:
[ "ogg:extract" ] -
alias(optional):
object alias
-
begin(optional):
begin
Starting point for data processing
-
config(optional):
array config
Minimum Number of Items:
0Maximum Number of Items:32767 -
credentials(optional):
credentials
Credentials for source database
-
critical(optional):
boolean
Default Value:
falseIndicates the extract is critical to the deployment -
description(optional):
string
Minimum Length:
1Maximum Length:4095Description for the process -
encryptionProfile(optional):
encryptionProfile
-
intent(optional):
Default Value:
UnidirectionalAllowed Values:[ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]Intent for data capture workflow -
managedProcessSettings(optional):
managedProcessSettings
Control how the ER process is managed by the Administration Server
-
miningCredentials(optional):
miningCredentials
Credentials for downstream mining database
-
passive(optional):
boolean
Default Value:
falsePassive extract controlled by an alias on the target -
registration(optional):
registration
Registration with the source database
-
rollover(optional):
Allowed Values:
[ true ]Causes Extract to increment to the next file in the trail sequence when restarting. -
source(optional):
source
Source of data to process
-
status(optional):
Default Value:
stoppedAllowed Values:[ "starting", "running", "stopped", "killed", "abended" ]Oracle GoldenGate Process Status -
targets(optional):
array targets
Minimum Number of Items:
0Maximum Number of Items:1024Targets for captured data -
type(optional):
Allowed Values:
[ "Alias", "Classic", "Initial Load", "Integrated", "Passive", "Remote Task", "Source Extract" ]OGG Extract process type (read-only)
Nested Schema : alias
Type:
Show Source
object-
manager(optional):
object manager
Manager server to use
-
name(optional):
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$Name of passive extract on the source -
proxy(optional):
object proxy
Nested Schema : begin
Starting point for data processing
Default Value:
nowMatch One
Show Source
-
Allowed Values:
[ "now" ] -
string
Minimum Length:
20Maximum Length:32Pattern:^[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])$ -
object begin-x-oneOf[2]
Nested Schema : config
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
0Maximum Length:4095
Nested Schema : credentials
Credentials for source database
Default Value:
oracle.doceng.json.BetterJsonNull@7acbd3d0Match One
Show Source
Nested Schema : managedProcessSettings
Control how the ER process is managed by the Administration Server
Match One
Show Source
-
object managedProcessSettings-x-oneOf[0]
Custom settings
-
string
Minimum Length:
1Maximum Length:64Pattern:^[A-Za-z0-9][A-Za-z0-9_:-]*$Name of 'ogg:managedProcessSettings' configuration value
Nested Schema : miningCredentials
Credentials for downstream mining database
Default Value:
oracle.doceng.json.BetterJsonNull@689fe2a3Match One
Show Source
Nested Schema : registration
Registration with the source database
Default Value:
noneMatch One
Show Source
-
registration-x-oneOf[0]
-
Allowed Values:
[ "none", "default" ]
Nested Schema : source
Source of data to process
Match One
Show Source
-
Allowed Values:
[ "tables" ]Use tables (initial load) -
Allowed Values:
[ "tranlogs" ]Use transaction logs with change data capture -
object source-x-oneOf[2]
OGG 19c Syntax NO LONGER SUPPORTED
Nested Schema : targets
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
1024Targets for captured data
Show Source
Nested Schema : manager
Type:
objectManager server to use
Show Source
-
host:
host
Host name or IP Address
-
port:
integer
Minimum Value:
1Maximum Value:65535IP Port number
Nested Schema : proxy
Type:
Show Source
object-
credentials(optional):
credentials
Proxy server credentials
-
host:
host
Proxy server host name or IP address
-
port:
integer
Minimum Value:
1Maximum Value:65535Proxy server port number
Nested Schema : host
Host name or IP Address
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:4095Pattern:^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$Network host name -
host-x-oneOf[1]
Network IP address
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
-
string
Minimum Length:
7Maximum Length:15Pattern:^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$Network IPv4 address -
string
Minimum Length:
1Maximum Length:256Pattern:^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$Network IPv6 address
Nested Schema : credentials
Proxy server credentials
Default Value:
oracle.doceng.json.BetterJsonNull@568cbf8dMatch One
Show Source
Nested Schema : host
Proxy server host name or IP address
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:4095Pattern:^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$Network host name -
host-x-oneOf[1]
Network IP address
Nested Schema : credentials-x-oneOf[0]
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ] -
alias:
string
Minimum Length:
1Maximum Length:30Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$ -
domain(optional):
string
Minimum Length:
1Maximum Length:30Default Value:OracleGoldenGatePattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
-
string
Minimum Length:
7Maximum Length:15Pattern:^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$Network IPv4 address -
string
Minimum Length:
1Maximum Length:256Pattern:^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$Network IPv6 address
Nested Schema : begin-x-oneOf[2]
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "type:position/atDbms" ] -
at:
object at
Position at a specific SCN (integrated mode)
Nested Schema : credentials-x-oneOf[0]
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ] -
alias:
string
Minimum Length:
1Maximum Length:30Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$ -
domain(optional):
string
Minimum Length:
1Maximum Length:30Default Value:OracleGoldenGatePattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : managedProcessSettings-x-oneOf[0]
Type:
objectCustom settings
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:managedProcessSettings" ] -
autoRestart(optional):
object autoRestart
Control how the ER process is restarted by the Administration Server if it terminates
-
autoStart(optional):
object autoStart
Description of how the ER process starts with Administration Server
Nested Schema : autoRestart
Type:
objectControl how the ER process is restarted by the Administration Server if it terminates
Default Value:
Show Source
{
"enabled":false,
"onSuccess":false,
"delay":0,
"retries":9,
"window":60,
"disableOnFailure":true
}-
$schema(optional):
Allowed Values:
[ "ogg:taskRestart" ] -
delay(optional):
integer
Minimum Value:
0Maximum Value:3600Default Value:0The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process. -
disableOnFailure(optional):
boolean
Default Value:
trueIf true, the task is disabled when it fails all execution attempts in an execution window. -
enabled:
boolean
Default Value:
falseIf set, the task can be restarted if it terminates. -
failures(optional):
integer
Minimum Value:
0Maximum Value:3600The number of times the task failed in the current window. -
onSuccess(optional):
boolean
Default Value:
falseIf false, the task is only restarted if it fails. -
retries(optional):
integer
Minimum Value:
0Maximum Value:3600Default Value:9The maximum number of times the task should be restarted before aborting retry efforts. -
window(optional):
integer
Minimum Value:
0Maximum Value:604800Default Value:60The window of time, in seconds, during which retries are counted.
Nested Schema : autoStart
Type:
objectDescription of how the ER process starts with Administration Server
Show Source
-
delay(optional):
integer
Minimum Value:
0Maximum Value:3600Default Value:0Time to wait in seconds before starting process -
enabled:
boolean
Default Value:
falseIf set, the process is started when Administration Server starts
Nested Schema : miningCredentials-x-oneOf[0]
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ] -
alias:
string
Minimum Length:
1Maximum Length:30Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$ -
domain(optional):
string
Minimum Length:
1Maximum Length:30Default Value:OracleGoldenGatePattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : registration-x-oneOf[0]
Match One
Show Source
-
object registration-x-oneOf[0]-x-oneOf[0]
Integrated extract registration options
Nested Schema : registration-x-oneOf[0]-x-oneOf[0]
Type:
objectIntegrated extract registration options
Show Source
-
containers(optional):
array containers
Minimum Number of Items:
0Maximum Number of Items:256 -
csn(optional):
csn
-
optimized(optional):
boolean
Default Value:
false -
replace(optional):
boolean
Default Value:
falseIf true, replace existing registration details from an extract with the same name - share(optional): share
Match Any
Show Source
Nested Schema : containers
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
256Nested Schema : items
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:130Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : source-x-oneOf[2]
Type:
objectOGG 19c Syntax NO LONGER SUPPORTED
Show Source
-
tranlogs:
Allowed Values:
[ "integrated", "classic" ]
Nested Schema : items-x-oneOf[0]
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:trail" ] -
name:
string
Minimum Length:
2Maximum Length:2Pattern:^[A-Za-z][A-Za-z0-9]$The name of the trail -
offset(optional):
integer
Minimum Value:
0Maximum Value:2147483647Offset in trail sequence file -
path(optional):
string
Minimum Length:
1Maximum Length:4096The path where trail data is stored -
remote(optional):
boolean
Default Value:
falseIndicates if trail is local or remote -
sequence(optional):
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Trail beginning sequence number -
sequenceLength(optional):
Default Value:
9Allowed Values:[ 6, 9 ]Number of digits in sequence file name -
sequenceLengthFlip(optional):
boolean
Default Value:
falseIndicates sequence number length will change -
sizeMB(optional):
integer
Minimum Value:
1Maximum Value:2000Default Value:500The maximum size, in megabytes, of a file in the trail.
Example Request (application/json)
{
"config":[
"Extract EXT2",
"ExtTrail X2 Format Release 12.3",
"UseridAlias oggadmin",
"Table oggadmin.*;"
],
"source":"tranlogs",
"credentials":{
"alias":"oggadmin"
},
"registration":"default",
"begin":"now",
"targets":[
{
"name":"X2"
}
]
}Response
Supported Media Types
- application/json
201 Response
The extract process was created successfully.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema(optional):
Allowed Values:
[ "api:standardResponse" ] -
links:
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response(optional):
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:link" ] -
description(optional):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6Maximum Length:255Pattern:^(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:message" ] -
code:
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued:
string
Minimum Length:
20Maximum Length:32Pattern:^[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:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type:
string
Minimum Length:
2Maximum Length:4095Pattern:^[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/extracts/EXT2",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/extracts/EXT2",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
{
"$schema":"ogg:message",
"code":"OGG-12142",
"issued":"2021-07-13T16:37:01Z",
"severity":"WARNING",
"title":"The json property '/source/tranlogs' has been deprecated. Expected value is: '/source'.",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
},
{
"$schema":"ogg:message",
"code":"OGG-08100",
"issued":"2021-07-13T16:37:01Z",
"severity":"INFO",
"title":"Integrated Extract added.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-08100"
},
{
"$schema":"ogg:message",
"code":"OGG-02003",
"issued":"2021-07-13T16:37:08Z",
"severity":"INFO",
"title":"Extract group EXT2 successfully registered with database at SCN 1525940.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-02003"
},
{
"$schema":"ogg:message",
"code":"OGG-10183",
"issued":"2021-07-13T16:37:08Z",
"severity":"INFO",
"title":"Parameter file EXT2.prm passed validity check.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-10183"
},
{
"$schema":"ogg:message",
"code":"OGG-08100",
"issued":"2021-07-13T16:37:08Z",
"severity":"INFO",
"title":"EXTTRAIL added.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-08100"
}
]
}