Retrieve Checkpoints
get
/services/{version}/extracts/{extract}/info/checkpoints
Retrieve the checkpoint information for the 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" ]
Query Parameters
-
history(optional): string
Number of historical checkpoint records to return
Response
Supported Media Types
- application/json
200 Response
Checkpoint information for the extract process retrieved successfully.
Root Schema : Collection of all checkpoints for an extract process
Type:
object
Title:
Show Source
Collection of all checkpoints for an extract process
-
$schema(optional):
Allowed Values:
[ "ogg:extractCheckpoints" ]
-
current:
object current
Single checkpoint for an extract process
-
history(optional):
array history
Minimum Number of Items:
1
Maximum Number of Items:100
Nested Schema : current
Type:
object
Single checkpoint for an extract process
Show Source
-
input(optional):
array input
Minimum Number of Items:
1
Maximum Number of Items:128
Checkpoint details for each input -
output(optional):
array output
Minimum Number of Items:
1
Maximum Number of Items:128
Checkpoint details for each trail output
Nested Schema : history
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
100
-
Array of:
object items
Single checkpoint for an extract process
Nested Schema : input
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
128
Checkpoint details for each input
Show Source
Nested Schema : output
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
128
Checkpoint details for each trail output
Show Source
Nested Schema : current
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
offset
-
path:
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number -
sequenceLength:
Allowed Values:
[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Indicates sequence number length will change
-
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
offset
-
path:
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number -
sequenceLength:
Allowed Values:
[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Indicates sequence number length will change
-
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : offset
Match One
Show Source
-
Allowed Values:
[ -2 ]
Special value for BEGIN NOW -
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file
Nested Schema : offset
Match One
Show Source
-
Allowed Values:
[ -2 ]
Special value for BEGIN NOW -
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file
Nested Schema : current
Type:
Show Source
object
-
name:
string
Minimum Length:
1
Maximum Length:4096
The name of the file -
offset:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Offset in file -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
name:
string
Minimum Length:
1
Maximum Length:4096
The name of the file -
offset:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Offset in file -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : current
Type:
Show Source
object
-
name:
name
The name of the table
-
sequence:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Record number from table -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
name:
name
The name of the table
-
sequence:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Record number from table -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : name
The name of the table
Match Any
Show Source
-
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
-
name-x-anyOf[1]
Nested Schema : name
The name of the table
Match Any
Show Source
-
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
-
name-x-anyOf[1]
Nested Schema : boundedRecoveryBegin
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : boundedRecoveryEnd
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : boundedRecoveryPrevious
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : current
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : recovery
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : current
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
offset
-
path:
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number -
sequenceLength:
Allowed Values:
[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Indicates sequence number length will change
-
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : offset
Match One
Show Source
-
Allowed Values:
[ -2 ]
Special value for BEGIN NOW -
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file
Nested Schema : items
Type:
object
Single checkpoint for an extract process
Show Source
-
input:
array input
Minimum Number of Items:
1
Maximum Number of Items:128
Checkpoint details for each input -
output:
array output
Minimum Number of Items:
1
Maximum Number of Items:128
Checkpoint details for each trail output
Nested Schema : input
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
128
Checkpoint details for each input
Show Source
Nested Schema : output
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
128
Checkpoint details for each trail output
Show Source
Nested Schema : current
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
offset
-
path:
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number -
sequenceLength:
Allowed Values:
[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Indicates sequence number length will change
-
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
offset
-
path:
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number -
sequenceLength:
Allowed Values:
[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Indicates sequence number length will change
-
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : offset
Match One
Show Source
-
Allowed Values:
[ -2 ]
Special value for BEGIN NOW -
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file
Nested Schema : offset
Match One
Show Source
-
Allowed Values:
[ -2 ]
Special value for BEGIN NOW -
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file
Nested Schema : current
Type:
Show Source
object
-
name:
string
Minimum Length:
1
Maximum Length:4096
The name of the file -
offset:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Offset in file -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
name:
string
Minimum Length:
1
Maximum Length:4096
The name of the file -
offset:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Offset in file -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : current
Type:
Show Source
object
-
name:
name
The name of the table
-
sequence:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Record number from table -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
name:
name
The name of the table
-
sequence:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Record number from table -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : name
The name of the table
Match Any
Show Source
-
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
-
name-x-anyOf[1]
Nested Schema : name
The name of the table
Match Any
Show Source
-
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
-
name-x-anyOf[1]
Nested Schema : boundedRecoveryBegin
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : boundedRecoveryEnd
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : boundedRecoveryPrevious
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : current
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : recovery
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : starting
Type:
Show Source
object
-
csn:
csn
-
name:
name
The name of the archive log
-
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Archive log offset -
sequence:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Archive log sequence -
thread:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Integrated capture thread number -
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : current
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
offset
-
path:
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number -
sequenceLength:
Allowed Values:
[ 6, 9 ]
Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Indicates sequence number length will change
-
timestamp:
timestamp
Time the checkpoint was recorded
Nested Schema : offset
Match One
Show Source
-
Allowed Values:
[ -2 ]
Special value for BEGIN NOW -
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in trail sequence file
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/extracts/EXT2/info/checkpoints",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/extracts/EXT2/info/checkpoints",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extractCheckpoints",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:extractCheckpoints",
"current":{
"input":[
{
"boundedRecoveryBegin":{
"csn":null,
"name":null,
"offset":0,
"sequence":0,
"thread":1,
"timestamp":"2019-03-15T14:40:54.375Z"
},
"boundedRecoveryEnd":{
"csn":null,
"name":null,
"offset":0,
"sequence":0,
"thread":1,
"timestamp":"2019-03-15T14:40:54.375Z"
},
"boundedRecoveryPrevious":{
"csn":null,
"name":null,
"offset":0,
"sequence":0,
"thread":1,
"timestamp":"2019-03-15T14:40:54.375Z"
},
"current":{
"csn":1543768,
"name":"Not Available",
"offset":0,
"sequence":0,
"thread":0,
"timestamp":"2019-03-15T14:42:14.000Z"
},
"recovery":{
"csn":1543768,
"name":"Not Available",
"offset":0,
"sequence":0,
"thread":1,
"timestamp":"2019-03-15T14:42:14.000Z"
},
"starting":{
"csn":null,
"name":null,
"offset":0,
"sequence":0,
"thread":1,
"timestamp":"2019-03-15T14:40:45.000Z"
}
}
],
"output":[
{
"current":{
"name":"X2",
"offset":4375,
"path":"/u02/ogg/Local/var/lib/data/",
"sequence":0,
"sequenceLength":9,
"sequenceLengthFlip":false,
"timestamp":"2019-03-15T14:42:17.424Z"
}
}
]
}
}
}