1. Oracle GoldenGate
  2. Tasks
  3. Administrative Server
  4. Replicats

Retrieve Checkpoints

get

/services/{version}/replicats/{replicat}/info/checkpoints

Retrieve the checkpoint information for the replicat process.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$

    The name of the replicat. Replicat names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Query Parameters

Response

Supported Media Types

200 Response

Checkpoint information for the replicat process retrieved successfully.

Body ()
Root Schema : Collection of all checkpoints for a replicat process
Type: object
Title: Collection of all checkpoints for a replicat process
Show Source
Nested Schema : current
Type: object
Single checkpoint for an replicat process
Show Source
  • input
    Minimum Number of Items: 1
    Maximum Number of Items: 128
    Checkpoint details for each input
Nested Schema : history
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Show Source
Nested Schema : input
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
Checkpoint details for each input
Show Source
Nested Schema : items
Checkpoint details for a single input
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
Nested Schema : items-x-oneOf[2]
Type: object
Show Source
Nested Schema : items-x-oneOf[3]
Type: object
Show Source
Nested Schema : current
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : current
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : current
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : name
The name of the table
Match Any
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : name-x-anyOf[1]
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : name
The name of the table
Match Any
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : name-x-anyOf[1]
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : boundedRecoveryBegin
Type: object
Show Source
Nested Schema : boundedRecoveryEnd
Type: object
Show Source
Nested Schema : boundedRecoveryPrevious
Type: object
Show Source
Nested Schema : current
Type: object
Show Source
Nested Schema : recovery
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : items
Type: object
Single checkpoint for an replicat process
Show Source
  • input
    Minimum Number of Items: 1
    Maximum Number of Items: 128
    Checkpoint details for each input
Nested Schema : input
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
Checkpoint details for each input
Show Source
Nested Schema : items
Checkpoint details for a single input
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
Nested Schema : items-x-oneOf[2]
Type: object
Show Source
Nested Schema : items-x-oneOf[3]
Type: object
Show Source
Nested Schema : current
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : current
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : current
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : name
The name of the table
Match Any
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : name-x-anyOf[1]
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : name
The name of the table
Match Any
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : name-x-anyOf[1]
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : boundedRecoveryBegin
Type: object
Show Source
Nested Schema : boundedRecoveryEnd
Type: object
Show Source
Nested Schema : boundedRecoveryPrevious
Type: object
Show Source
Nested Schema : current
Type: object
Show Source
Nested Schema : recovery
Type: object
Show Source
Nested Schema : starting
Type: object
Show Source
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : csn
Match One
Show Source
Nested Schema : name
The name of the archive log
Match One
Show Source
Nested Schema : timestamp
Time the checkpoint was recorded
Match One
Show Source
  • 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])$
Nested Schema : csn-x-oneOf[0]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2/info/checkpoints",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2/info/checkpoints",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/replicatCheckpoints",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:replicatCheckpoints",
        "current":{
            "input":[
                {
                    "current":{
                        "name":"X2",
                        "offset":3987,
                        "path":"/u02/ogg/Local/var/lib/data",
                        "sequence":0,
                        "sequenceLength":9,
                        "sequenceLengthFlip":false,
                        "timestamp":"2017-12-14T12:43:07.000Z"
                    },
                    "starting":{
                        "name":"X2",
                        "offset":0,
                        "path":"/u02/ogg/Local/var/lib/data",
                        "sequence":0,
                        "sequenceLength":9,
                        "sequenceLengthFlip":false,
                        "timestamp":null
                    }
                }
            ]
        }
    }
}