Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve an existing Checkpoint Position Information

get

/services/{version}/mpoints/{item}/positionEr

Required Role: User

Retrieve an existing Checkpoint Position Information

Request

Path Parameters

item(required): string

Minimum Length: 1

Maximum Length: 32
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Position details for ER processes

Type: object

Title: Oracle GoldenGate Position details for ER processes

Show Source

$schema:

Allowed Values: [ "mpoints:positionEr" ]
endOfFile: boolean

End of file indicator
highWatermarkLagMs: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Lag of the high watermark (milliseconds)
highWatermarkTs: highWatermarkTs

Time of the high watermark
inputCheckpoint: object inputCheckpoint

Input checkpoint position
lastCheckpointTs: lastCheckpointTs

Time of last checkpoint
lastOperationLagMs: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Lag of last operation (milliseconds)
lastOperationTs: lastOperationTs

Time of last operation processed
lowWatermarkLagMs: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Lag of the low watermark (milliseconds)
lowWatermarkTs: lowWatermarkTs

Time of the low watermark
outputCheckpoint: object outputCheckpoint

Output checkpoint position
processMode:

Allowed Values: [ "Unknown", "Classic", "Integrated", "Coordinated", "Parallel", "ParallelApplier", "ParallelMapper", "Not Applicable" ]

The Process Mode
trailTimesAtEof: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Number of Times Read Hit End of File

{
    "title":"Oracle GoldenGate Position details for ER processes",
    "type":"object",
    "properties":{
        "lowWatermarkLagMs":{
            "description":"Lag of the low watermark (milliseconds)",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "endOfFile":{
            "description":"End of file indicator",
            "type":"boolean"
        },
        "$schema":{
            "enum":[
                "mpoints:positionEr"
            ]
        },
        "lastCheckpointTs":{
            "description":"Time of last checkpoint",
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "lowWatermarkTs":{
            "description":"Time of the low watermark",
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "outputCheckpoint":{
            "description":"Output checkpoint position",
            "properties":{
                "sequence":{
                    "description":"Sequence Number",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                },
                "rba":{
                    "description":"Relative Byte Address",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                },
                "timestamp":{
                    "description":"Time of last write checkpoint",
                    "x-oneOf":[
                        {
                            "type":"string",
                            "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])$",
                            "minLength":"20",
                            "maxLength":"32"
                        },
                        {
                            "type":"null"
                        }
                    ]
                },
                "trail":{
                    "description":"Trail Path",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"64"
                }
            }
        },
        "lastOperationLagMs":{
            "description":"Lag of last operation (milliseconds)",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "lastOperationTs":{
            "description":"Time of last operation processed",
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "trailTimesAtEof":{
            "description":"Number of Times Read Hit End of File",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "processMode":{
            "description":"The Process Mode",
            "enum":[
                "Unknown",
                "Classic",
                "Integrated",
                "Coordinated",
                "Parallel",
                "ParallelApplier",
                "ParallelMapper",
                "Not Applicable"
            ]
        },
        "highWatermarkLagMs":{
            "description":"Lag of the high watermark (milliseconds)",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "highWatermarkTs":{
            "description":"Time of the high watermark",
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "inputCheckpoint":{
            "description":"Input checkpoint position",
            "properties":{
                "redoThread":{
                    "description":"Redo Thread Id",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                },
                "sequence":{
                    "description":"Sequence Number",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                },
                "rba":{
                    "description":"Relative Byte Address",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                },
                "timestamp":{
                    "description":"Time of last read checkpoint",
                    "x-oneOf":[
                        {
                            "type":"string",
                            "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])$",
                            "minLength":"20",
                            "maxLength":"32"
                        },
                        {
                            "type":"null"
                        }
                    ]
                },
                "scn":{
                    "description":"SCN number",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"32"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : highWatermarkTs

Time of the high watermark

Match One

Show Source

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])$
null

{
    "description":"Time of the high watermark",
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : inputCheckpoint

Type: object

Input checkpoint position

Show Source

rba: integer

Minimum Value: 0

Maximum Value: 4294967295

Relative Byte Address
redoThread: integer

Minimum Value: 0

Maximum Value: 4294967295

Redo Thread Id
scn: string

Minimum Length: 1

Maximum Length: 32

SCN number
sequence: integer

Minimum Value: 0

Maximum Value: 4294967295

Sequence Number
timestamp: timestamp

Time of last read checkpoint

{
    "description":"Input checkpoint position",
    "properties":{
        "redoThread":{
            "description":"Redo Thread Id",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "sequence":{
            "description":"Sequence Number",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "rba":{
            "description":"Relative Byte Address",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "timestamp":{
            "description":"Time of last read checkpoint",
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "scn":{
            "description":"SCN number",
            "type":"string",
            "minLength":"1",
            "maxLength":"32"
        }
    }
}

Nested Schema : lastCheckpointTs

Time of last checkpoint

Match One

Show Source

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])$
null

{
    "description":"Time of last checkpoint",
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : lastOperationTs

Time of last operation processed

Match One

Show Source

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])$
null

{
    "description":"Time of last operation processed",
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : lowWatermarkTs

Time of the low watermark

Match One

Show Source

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])$
null

{
    "description":"Time of the low watermark",
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : outputCheckpoint

Type: object

Output checkpoint position

Show Source

rba: integer

Minimum Value: 0

Maximum Value: 4294967295

Relative Byte Address
sequence: integer

Minimum Value: 0

Maximum Value: 4294967295

Sequence Number
timestamp: timestamp

Time of last write checkpoint
trail: string

Minimum Length: 1

Maximum Length: 64

Trail Path

{
    "description":"Output checkpoint position",
    "properties":{
        "sequence":{
            "description":"Sequence Number",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "rba":{
            "description":"Relative Byte Address",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "timestamp":{
            "description":"Time of last write checkpoint",
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "trail":{
            "description":"Trail Path",
            "type":"string",
            "minLength":"1",
            "maxLength":"64"
        }
    }
}

Nested Schema : timestamp

Time of last read checkpoint

Match One

Show Source

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])$
null

{
    "description":"Time of last read checkpoint",
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : timestamp

Time of last write checkpoint

Match One

Show Source

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])$
null

{
    "description":"Time of last write checkpoint",
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"mpoints:positionEr",
        "lastOperationLagMs":"2100",
        "lastOperationTs":null,
        "lastCheckpointTs":"2015-06-10T11:06:48.462Z",
        "inputCheckpoint":{
            "redoThread":"1",
            "sequence":"20",
            "rba":"1530",
            "timestamp":"2015-06-09 17:11:32.997Z",
            "scn":"0.2415487 (2415487)"
        },
        "outputCheckpoint":{
            "sequence":"31",
            "rba":"1530",
            "timestamp":"2015-06-09 11:06:48.462Z",
            "trail":"/net/slc03flg/scratch/jdivinc/view_storage/jdivinc_db2/tklocal/ggora/dirdat/bb"
        },
        "endOfFile":true,
        "trailTimesAtEof":"1"
    },
    "messages":[
    ],
    "links":[
    ]
}