Oracle GoldenGate Microservices Architecture REST API

Retrieve Report

get

/services/{version}/extracts/{extract}/info/reports/{report}

Retrieve a report from the extract process.

Request

Path Parameters

extract: 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.
report: string

Minimum Length: 5

Maximum Length: 13

Pattern: ^[A-Z_$][A-Z0-9_$]{0,7}[0-9]?[.](rpt|dsc)$

The name of the report, which is the extract name, followed by an optional revision number and '.rpt'
version: string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Report retrieved successfully.

Root Schema : Oracle GoldenGate Process Report

Type: object

Title: Oracle GoldenGate Process Report

Process Report

Show Source

$schema(optional):

Allowed Values: [ "ogg:report" ]
lines: array lines

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Process Report",
    "description":"Process Report",
    "required":[
        "lines"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:report"
            ]
        },
        "lines":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":0,
                "maxLength":4095
            },
            "minItems":0,
            "maxItems":2147483647
        }
    },
    "additionalProperties":false
}

Nested Schema : lines

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

Array of: string

Minimum Length: 0

Maximum Length: 4095

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":0,
        "maxLength":4095
    },
    "minItems":0,
    "maxItems":2147483647
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/reports/EXT2.rpt",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/reports/EXT2.rpt",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/extractReport",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:report",
        "lines":[
            "",
            "***********************************************************************",
            "                 Oracle GoldenGate Capture for Oracle",
            "      Version 21.3.0.0.0 OGGCORE_21.3.0.0.0_PLATFORMS_210704.0633",
            "     Linux, x64, 64bit (optimized), Oracle on Jul 13 2021 09:21:44",
            " ",
            "Copyright (C) 1995, 2021, Oracle and/or its affiliates. All rights reserved.",
            "",
            "                    Starting at 2021-07-13 16:37:08",
            "***********************************************************************",
            "",
            "Operating System Version:",
            "Linux",
            "Version #1 SMP PREEMPT Wed, 07 Jul 2021 23:35:29 +0000, Release 5.12.15-arch1-1",
            "Node: ogg",
            "Machine: x86_64",
            "                         soft limit   hard limit",
            "Address Space Size   :    unlimited    unlimited",
            "Heap Size            :    unlimited    unlimited",
            "File Size            :    unlimited    unlimited",
            "CPU Time             :    unlimited    unlimited",
            "",
            "Process id: 1837",
            "",
            "Description: ",
            "",
            "***********************************************************************",
            "**            Running with the following parameters                  **",
            "***********************************************************************",
            "",
            "2021-07-13 16:37:08  INFO    OGG-03059  Operating system character set identified as US-ASCII.",
            "",
            "2021-07-13 16:37:08  INFO    OGG-02695  ANSI SQL parameter syntax is used for parameter parsing.",
            "",
            "2021-07-13 16:37:08  INFO    OGG-01360  EXTRACT is running in Integrated mode.",
            "Extract     EXT2",
            "ExtTrail    X2 Format Release 12.3",
            "UseridAlias oggadmin",
            "",
            "2021-07-13 16:37:08  INFO    OGG-03541  Oracle Environment Variables: ",
            "TNS_ADMIN = /u02/ogg/Local/etc",
            "LD_LIBRARY_PATH = /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-1.el7_9.x86_64/jre/lib/amd64/server:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-1.el7_9.x86_64/jre/lib/amd64:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-1.el7_9.x86_64/jre/../lib/amd64:/usr/lib/jvm/jre/lib/amd64/server:/u01/app/oracle/product/12cR2/dbhome/lib.",
            "Table       oggadmin.*;",
            "",
            "2021-07-13 16:37:08  INFO    OGG-02733  Heartbeat table found in the connected schema oggadmin, using this heartbeat table.",
            "",
            "2021-07-13 16:37:08  INFO    OGG-01815  Virtual Memory Facilities for: BR",
            "    anon alloc: mmap(MAP_ANON)  anon free: munmap",
            "    file alloc: mmap(MAP_SHARED)  file free: munmap",
            "    target directories:",
            "    /u02/ogg/Local/var/run/BR/EXT2.",
            "",
            "Bounded Recovery Parameter:",
            "BRINTERVAL = 4HOURS",
            "BRDIR      = /u02/ogg/Local/var/run/",
            "",
            "2021-07-13 16:37:08  INFO    OGG-01851  filecaching started: thread ID: 140019459147520.",
            "",
            "2021-07-13 16:37:08  INFO    OGG-01815  Virtual Memory Facilities for: COM",
            "    anon alloc: mmap(MAP_ANON)  anon free: munmap",
            "    file alloc: mmap(MAP_SHARED)  file free: munmap",
            "    target directories:",
            "    /u02/ogg/Local/var/temp.",
            "",
            "2021-07-13 16:37:08  INFO    OGG-25340  ",
            "Database Version:",
            "Oracle Database 12c Enterprise Edition Release 12.2.0.1.0 - 64bit Production",
            "PL/SQL Release 12.2.0.1.0 - Production",
            "CORE\t12.2.0.1.0\tProduction",
            "TNS for Linux: Version 12.2.0.1.0 - Production",
            "NLSRTL Version 12.2.0.1.0 - Production.",
            "",
            "2021-07-13 16:37:08  INFO    OGG-25341  ",
            "Database Language and Character Set:",
            "NLS_LANGUAGE     = \"AMERICAN\" ",
            "NLS_TERRITORY    = \"AMERICA\" ",
            "NLS_CHARACTERSET = \"AL32UTF8\".",
            "",
            "2021-07-13 16:37:08  INFO    OGG-26025  ",
            "Database Unique Name: ORCL.",
            "",
            "2021-07-13 16:37:09  INFO    OGG-06604  Connected to database ORCL, CPU info: CPU Count 40, CPU Core Count 20, CPU Socket Count 2.",
            "",
            "2021-07-13 16:37:09  INFO    OGG-06618  Database ORCL Platform: Linux x86 64-bit.",
            "",
            "2021-07-13 16:37:24  INFO    OGG-02248  Logmining server DDL filtering enabled.",
            "",
            "2021-07-13 16:37:28  INFO    OGG-02068  Integrated capture successfully attached to logmining server OGG$CAP_EXT2 using OGGCapture API.",
            "",
            "2021-07-13 16:37:28  INFO    OGG-02089  Source redo compatibility version is: 12.2.0.",
            "",
            "2021-07-13 16:37:28  INFO    OGG-15446  Extract configured as OTHER_GROUPS resource group.",
            "",
            "2021-07-13 16:37:28  INFO    OGG-02086  Integrated Dictionary will be used.",
            "",
            "2021-07-13 16:37:29  WARNING OGG-02905  Replication of OID column in object tables may diverge.",
            "",
            "2021-07-13 16:37:29  INFO    OGG-01052  No recovery is required for target file X2000000000, at RBA 0 (file not opened).",
            "",
            "2021-07-13 16:37:29  INFO    OGG-01478  Output file X2 is using format RELEASE 12.3/18.1.",
            "",
            "***********************************************************************",
            "**                     Run Time Messages                             **",
            "***********************************************************************",
            "",
            "",
            "2021-07-13 16:38:01  INFO    OGG-02557  Heartbeat table OGGADMIN.GG_HEARTBEAT_SEED metadata is resolved and will write to trail file X2."
        ]
    }
}