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

Retrieve Status

get

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

Retrieve the current status of the extract process.

Request

Path Parameters
  • 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.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]

Response

Supported Media Types

200 Response

Process status retrieved successfully.

Body ()
Root Schema : Extract process status
Type: object
Title: Extract process status
Show Source
Nested Schema : lastStarted
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 : position
Match One
Show Source
  • position-x-oneOf[0]
  • 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])$
  • position-x-oneOf[2]
Nested Schema : position-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 : position-x-oneOf[2]
Match One
Show Source
Nested Schema : position-x-oneOf[2]-x-oneOf[0]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : position-x-oneOf[2]-x-oneOf[1]
Type: object
Position in archive logs (classic mode, threaded)
Show Source
Nested Schema : position-x-oneOf[2]-x-oneOf[2]
Type: object
Position at a specific SCN (integrated mode)
Show Source
Nested Schema : positions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Show Source
Nested Schema : items
Type: object
Position in archive logs for one thread in a classic extract
Show Source
Nested Schema : position
Match One
Show Source
  • Allowed Values: [ "now" ]
  • position-x-oneOf[1]
  • 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])$
  • position-x-oneOf[3]
    Position in archive logs (classic mode, non-threaded)
Nested Schema : position-x-oneOf[1]
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 : position-x-oneOf[3]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : csn
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/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":"2017-12-14T12:42:36.350Z",
        "position":"0.1543170",
        "processId":1642,
        "sinceLagReported":0,
        "status":"running"
    }
}