1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Receiver Service

Retrieve an existing Oracle GoldenGate Receiver Server Path Checkpoints

get

/services/{version}/targets/{path}/checkpoints

Required Role: User

Retrieve an existing Oracle GoldenGate Receiver Server Path Checkpoints

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : Collection of all checkpoints for a distribution path
Type: object
Title: Collection of all checkpoints for a distribution path
Show Source
Nested Schema : current
Type: object
Single checkpoint for a distribution path
Show Source
  • input
    Minimum Number of Items: 0
    Maximum Number of Items: 128
    Optional checkpoint details for each input
  • output
    Minimum Number of Items: 0
    Maximum Number of Items: 128
    Optional checkpoint details for each trail output
Nested Schema : input
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 128
Optional checkpoint details for each input
Show Source
Nested Schema : output
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 128
Optional checkpoint details for each trail output
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 : offset
Match One
Show Source
  • Allowed Values: [ "-2" ]
    Special value for BEGIN NOW
  • Minimum Value: 0
    Maximum Value: 2147483647
    Offset in trail sequence file
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 : offset
Match One
Show Source
  • Allowed Values: [ "-2" ]
    Special value for BEGIN NOW
  • Minimum Value: 0
    Maximum Value: 2147483647
    Offset in trail sequence file
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: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
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: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
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: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
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: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
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: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
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: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
Nested Schema : items
Type: object
Show Source
Nested Schema : current
Type: object
Show Source
Nested Schema : offset
Match One
Show Source
  • Allowed Values: [ "-2" ]
    Special value for BEGIN NOW
  • Minimum Value: 0
    Maximum Value: 2147483647
    Offset in trail sequence file
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])$
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"ogg:distPtahCheckpoints",
        "current":{
            "input":[
                {
                    "current":{
                        "name":"t1",
                        "offset":"819",
                        "path":"/u01/app/oracle/product/12.2.0/ogghome_1/var/lib/data",
                        "sequence":"17",
                        "sequenceLength":"9",
                        "timestamp":"2016-07-26T00:20:29.878Z"
                    },
                    "starting":{
                        "name":"t1",
                        "offset":"1466",
                        "path":"/u01/app/oracle/product/12.2.0/ogghome_1/var/lib/data",
                        "sequence":"14",
                        "sequenceLength":"9",
                        "timestamp":"2016-07-25T21:48:17.000Z"
                    }
                }
            ],
            "output":[
                {
                    "current":{
                        "name":"t1",
                        "offset":"819",
                        "sequence":"17",
                        "sequenceLength":"9",
                        "timestamp":"2016-07-26T00:20:29.878Z"
                    }
                }
            ]
        }
    },
    "messages":[
    ],
    "links":[
    ]
}
Back to Top