Retrieve Extract
get
/services/{version}/extracts/{extract}
Retrieve the details of an extract process.
Request
Path Parameters
-
extract: string
Minimum Length:
1
Maximum Length:8
Pattern:^[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" ]
Response
Supported Media Types
- application/json
200 Response
The details of the extract were retrieved successfully.
Root Schema : Oracle GoldenGate Extract
Type:
object
Title:
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:
0
Maximum Number of Items:32767
-
credentials(optional):
credentials
Credentials for source database
-
critical(optional):
boolean
Default Value:
false
Indicates the extract is critical to the deployment -
description(optional):
string
Minimum Length:
1
Maximum Length:4095
Description for the process -
encryptionProfile(optional):
encryptionProfile
-
intent(optional):
Default Value:
Unidirectional
Allowed 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:
false
Passive 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:
stopped
Allowed Values:[ "starting", "running", "stopped", "killed", "abended" ]
Oracle GoldenGate Process Status -
targets(optional):
array targets
Minimum Number of Items:
0
Maximum Number of Items:1024
Targets 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:
1
Maximum Length:8
Pattern:^[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:
now
Match One
Show Source
-
Allowed Values:
[ "now" ]
-
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])$
-
object begin-x-oneOf[2]
Nested Schema : config
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
32767
-
Array of:
string
Minimum Length:
0
Maximum Length:4095
Nested Schema : credentials
Credentials for source database
Default Value:
oracle.doceng.json.BetterJsonNull@7acbd3d0
Match 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:
1
Maximum Length:64
Pattern:^[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@689fe2a3
Match One
Show Source
Nested Schema : registration
Registration with the source database
Default Value:
none
Match 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:
array
Minimum Number of Items:
0
Maximum Number of Items:
1024
Targets for captured data
Show Source
Nested Schema : manager
Type:
object
Manager server to use
Show Source
-
host:
host
Host name or IP Address
-
port:
integer
Minimum Value:
1
Maximum Value:65535
IP 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:
1
Maximum Value:65535
Proxy server port number
Nested Schema : host
Host name or IP Address
Match One
Show Source
-
string
Minimum Length:
1
Maximum Length:4095
Pattern:^(((([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:
7
Maximum Length:15
Pattern:^((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:
1
Maximum Length:256
Pattern:^((([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@568cbf8d
Match One
Show Source
Nested Schema : host
Proxy server host name or IP address
Match One
Show Source
-
string
Minimum Length:
1
Maximum Length:4095
Pattern:^(((([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:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
-
string
Minimum Length:
7
Maximum Length:15
Pattern:^((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:
1
Maximum Length:256
Pattern:^((([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:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : managedProcessSettings-x-oneOf[0]
Type:
object
Custom 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:
object
Control 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:
0
Maximum Value:3600
Default Value:0
The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process. -
disableOnFailure(optional):
boolean
Default Value:
true
If true, the task is disabled when it fails all execution attempts in an execution window. -
enabled:
boolean
Default Value:
false
If set, the task can be restarted if it terminates. -
failures(optional):
integer
Minimum Value:
0
Maximum Value:3600
The number of times the task failed in the current window. -
onSuccess(optional):
boolean
Default Value:
false
If false, the task is only restarted if it fails. -
retries(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:9
The maximum number of times the task should be restarted before aborting retry efforts. -
window(optional):
integer
Minimum Value:
0
Maximum Value:604800
Default Value:60
The window of time, in seconds, during which retries are counted.
Nested Schema : autoStart
Type:
object
Description of how the ER process starts with Administration Server
Show Source
-
delay(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:0
Time to wait in seconds before starting process -
enabled:
boolean
Default Value:
false
If 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:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[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:
object
Integrated extract registration options
Show Source
-
containers(optional):
array containers
Minimum Number of Items:
0
Maximum Number of Items:256
-
csn(optional):
csn
-
optimized(optional):
boolean
Default Value:
false
-
replace(optional):
boolean
Default Value:
false
If true, replace existing registration details from an extract with the same name - share(optional): share
Match Any
Show Source
Nested Schema : containers
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
256
Nested Schema : items
Match One
Show Source
-
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : source-x-oneOf[2]
Type:
object
OGG 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:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file -
path(optional):
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
remote(optional):
boolean
Default Value:
false
Indicates if trail is local or remote -
sequence(optional):
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail beginning sequence number -
sequenceLength(optional):
Default Value:
9
Allowed Values:[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip(optional):
boolean
Default Value:
false
Indicates sequence number length will change -
sizeMB(optional):
integer
Minimum Value:
1
Maximum Value:2000
Default Value:500
The maximum size, in megabytes, of a file in the trail.
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"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extract",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"begin":"now",
"config":[
"Extract EXT2",
"ExtTrail X2 Format Release 12.3",
"UseridAlias oggadmin",
"Table oggadmin.*;"
],
"encryptionProfile":"LocalWallet",
"$schema":"ogg:extract",
"status":"running",
"targets":[
{
"name":"X2",
"offset":4528,
"remote":false,
"sequence":0,
"sequenceLength":9,
"sequenceLengthFlip":false,
"sizeMB":500
}
],
"registration":{
"csn":1525940
},
"source":"tranlogs",
"type":"Integrated",
"credentials":{
"alias":"oggadmin"
}
}
}