Oracle GoldenGate Microservices REST API

Retrieve Status

get

/services/{version}/extracts/{extract}/info/status

Required Role: User

Retrieve the current status of the extract process.

Request

Path Parameters

extract(required): 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(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Process status retrieved successfully.

Root Schema : Extract process status

Type: object

Title: Extract process status

Show Source

$schema:

Allowed Values: [ "ogg:extractStatus" ]
lag: integer

Minimum Value: 0

Maximum Value: 4294967295

Process lag in seconds
lastStarted(required): lastStarted
position: position
processId: integer

Minimum Value: 1

Maximum Value: 4294967295
sinceLagReported: integer

Minimum Value: 0

Maximum Value: 4294967295

Time in seconds since process lag was reported
status(required):

Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]

{
    "title":"Extract process status",
    "required":[
        "status",
        "lastStarted"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:extractStatus"
            ]
        },
        "status":{
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        "lastStarted":{
            "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"
                }
            ]
        },
        "position":{
            "x-anyOf":[
                {
                    "x-oneOf":[
                        {
                            "description":"System Change Number(Normal Format) for Oracle Database.",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"9223372036854776000",
                            "example":"6488359"
                        },
                        {
                            "description":"System Change Number(Alternate Format) for Oracle Database.",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":"3",
                            "maxLength":"64",
                            "example":"6488359.3456712"
                        }
                    ]
                },
                {
                    "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"
                },
                {
                    "description":"Record number for table source",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"9223372036854776000"
                },
                {
                    "description":"Position at a specific SCN (integrated mode)",
                    "type":"object",
                    "properties":{
                        "csn":{
                            "x-oneOf":[
                                {
                                    "description":"System Change Number(Normal Format) for Oracle Database.",
                                    "type":"integer",
                                    "minimum":"0",
                                    "maximum":"9223372036854776000",
                                    "example":"6488359"
                                },
                                {
                                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                                    "type":"string",
                                    "pattern":"[0-9]+[.][0-9]+",
                                    "minLength":"3",
                                    "maxLength":"64",
                                    "example":"6488359.3456712"
                                }
                            ]
                        }
                    },
                    "required":[
                        "csn"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "lag":{
            "description":"Process lag in seconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "sinceLagReported":{
            "description":"Time in seconds since process lag was reported",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "processId":{
            "type":"integer",
            "minimum":"1",
            "maximum":"4294967295"
        }
    },
    "additionalProperties":false
}

Nested Schema : lastStarted

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

{
    "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 : position

Match Any

Show Source

position-x-anyOf[0]
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])$
integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Record number for table source
object position-x-anyOf[3]

Position at a specific SCN (integrated mode)

{
    "x-anyOf":[
        {
            "x-oneOf":[
                {
                    "description":"System Change Number(Normal Format) for Oracle Database.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"9223372036854776000",
                    "example":"6488359"
                },
                {
                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":"3",
                    "maxLength":"64",
                    "example":"6488359.3456712"
                }
            ]
        },
        {
            "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"
        },
        {
            "description":"Record number for table source",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        {
            "description":"Position at a specific SCN (integrated mode)",
            "type":"object",
            "properties":{
                "csn":{
                    "x-oneOf":[
                        {
                            "description":"System Change Number(Normal Format) for Oracle Database.",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"9223372036854776000",
                            "example":"6488359"
                        },
                        {
                            "description":"System Change Number(Alternate Format) for Oracle Database.",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":"3",
                            "maxLength":"64",
                            "example":"6488359.3456712"
                        }
                    ]
                }
            },
            "required":[
                "csn"
            ],
            "additionalProperties":false
        }
    ]
}

Nested Schema : position-x-anyOf[0]

Match One

Show Source

integer

Minimum Value: 0

Maximum Value: 9223372036854776000

System Change Number(Normal Format) for Oracle Database.

Example: 6488359
string

Minimum Length: 3

Maximum Length: 64

Pattern: [0-9]+[.][0-9]+

System Change Number(Alternate Format) for Oracle Database.

Example: 6488359.3456712

{
    "x-oneOf":[
        {
            "description":"System Change Number(Normal Format) for Oracle Database.",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000",
            "example":"6488359"
        },
        {
            "description":"System Change Number(Alternate Format) for Oracle Database.",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":"3",
            "maxLength":"64",
            "example":"6488359.3456712"
        }
    ]
}

Nested Schema : position-x-anyOf[3]

Type: object

Position at a specific SCN (integrated mode)

Show Source

csn(required): csn

{
    "description":"Position at a specific SCN (integrated mode)",
    "type":"object",
    "properties":{
        "csn":{
            "x-oneOf":[
                {
                    "description":"System Change Number(Normal Format) for Oracle Database.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"9223372036854776000",
                    "example":"6488359"
                },
                {
                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":"3",
                    "maxLength":"64",
                    "example":"6488359.3456712"
                }
            ]
        }
    },
    "required":[
        "csn"
    ],
    "additionalProperties":false
}

Nested Schema : csn

Match One

Show Source

integer

Minimum Value: 0

Maximum Value: 9223372036854776000

System Change Number(Normal Format) for Oracle Database.

Example: 6488359
string

Minimum Length: 3

Maximum Length: 64

Pattern: [0-9]+[.][0-9]+

System Change Number(Alternate Format) for Oracle Database.

Example: 6488359.3456712

{
    "x-oneOf":[
        {
            "description":"System Change Number(Normal Format) for Oracle Database.",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000",
            "example":"6488359"
        },
        {
            "description":"System Change Number(Alternate Format) for Oracle Database.",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":"3",
            "maxLength":"64",
            "example":"6488359.3456712"
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/extractStatus",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:extractStatus",
        "lag":"0",
        "lastStarted":"2021-07-13T16:37:29.021Z",
        "position":"0.1542600",
        "processId":"1837",
        "sinceLagReported":"0",
        "status":"running"
    }
}