Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Report

get

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

Required Role: User

Retrieve a report from 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.
report(required): 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(required): 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:

Allowed Values: [ "ogg:report" ]
lines(required): array lines

Minimum Number of Items: 0

Maximum Number of Items: 100000

{
    "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":"100000"
        }
    },
    "additionalProperties":false
}

Nested Schema : lines

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 100000

Show Source

Array of: string

Minimum Length: 0

Maximum Length: 4095

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

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/extracts/EXTN/info/reports/EXTN.rpt",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/extracts/EXTN/info/reports/EXTN.rpt",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/extractReport",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:report",
        "lines":[
            "",
            "***********************************************************************",
            "                 Oracle GoldenGate Capture for Oracle",
            "         Version 23.4.0.0.0 OGGCORE_MAIN_LINUX.X64_240331.1800",
            "     Linux, x64, 64bit (optimized), Oracle on Apr  3 2024 11:20:25",
            " ",
            "Copyright (C) 1995, 2024, Oracle and/or its affiliates. All rights reserved.",
            "",
            "                    Starting at 2024-04-03 22:33:51",
            "***********************************************************************",
            "",
            "Operating System Version:",
            "Linux",
            "Version #2 SMP Wed Dec 21 19:38:18 PST 2022, Release 5.4.17-2136.315.5.el8uek.x86_64",
            "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: 664",
            "",
            "Description: Region North",
            "",
            "***********************************************************************",
            "**            Running with the following parameters                  **",
            "***********************************************************************",
            "",
            "2024-04-03 22:33:51  INFO    OGG-03059  Operating system character set identified as UTF-8.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-02695  ANSI SQL parameter syntax is used for parameter parsing.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-02742  GLOBALS parameter GGSCHEMA set to 'ggadmin'. This schema contains objects that are managed by Oracle GoldenGate. Objects in this schema are not included in wildcard resolution rules. To capture objects in schema 'ggadmin', please explicitly map using a fully qualified object name.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-01360  EXTRACT is running in Integrated mode.",
            "EXTRACT extn",
            "EXTTRAIL north/ea",
            "USERIDALIAS ggnorth",
            "",
            "2024-04-03 22:33:51  INFO    OGG-03541  Oracle Environment Variables: ",
            "TNS_ADMIN = /u02/Deployment/etc",
            "LD_LIBRARY_PATH = /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.402.b06-2.0.1.el8.x86_64/jre/lib/amd64/server:.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-06644  Connection recovery inactive, TAF failover mode type 'SELECT' is required for connection recovery.",
            "SOURCECATALOG dbnorth_pdb1",
            "TABLE hr.*;",
            "",
            "2024-04-03 22:33:51  INFO    OGG-02623  Default source catalog name dbnorth_pdb1 will be used for source table name hr.* mapping.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-02734  Using heartbeat table from schema ggadmin.",
            "",
            "2024-04-03 22:33:51  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/Deployment/var/temp/BR/EXTN.",
            "",
            "Bounded Recovery Parameter:",
            "BRINTERVAL = 4HOURS",
            "BRDIR      = /u02/Deployment/var/temp/",
            "",
            "2024-04-03 22:33:51  INFO    OGG-01851  filecaching started: thread ID: 140218918737664.",
            "",
            "2024-04-03 22:33:51  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/Deployment/var/temp.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-25340  ",
            "Database Version:",
            "Oracle Database 23c Enterprise Edition Release 23.0.0.0.0 - Development",
            "Version 23.4.0.23.00.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-25341  ",
            "Database Language and Character Set:",
            "NLS_LANGUAGE     = \"AMERICAN\" ",
            "NLS_TERRITORY    = \"AMERICA\" ",
            "NLS_CHARACTERSET = \"AL32UTF8\".",
            "",
            "2024-04-03 22:33:51  INFO    OGG-26025  ",
            "Database Unique Name: ORCLCDB.",
            "",
            "2024-04-03 22:33:51  INFO    OGG-03146  Performing output trail file scan on the trail file 'north/ea'.",
            "",
            "2024-04-03 22:33:52  INFO    OGG-06604  Connected to database ORCLCDB, CPU info: CPU Count 64, CPU Core Count 64, CPU Socket Count 1.",
            "",
            "2024-04-03 22:33:52  INFO    OGG-06618  Database ORCLCDB Platform: Linux x86 64-bit.",
            "",
            "2024-04-03 22:34:24  INFO    OGG-02248  Logmining server DDL filtering enabled.",
            "",
            "2024-04-03 22:34:29  INFO    OGG-02339  Integrated capture successfully attached to logmining server OGG$CAP_EXTN using 60 second streaming duration.",
            "",
            "2024-04-03 22:34:29  INFO    OGG-02089  Source redo compatibility version is: 23.0.0.",
            "",
            "2024-04-03 22:34:29  INFO    OGG-15446  Extract configured as OTHER_GROUPS resource group.",
            "",
            "2024-04-03 22:34:29  INFO    OGG-02086  Integrated Dictionary will be used.",
            "",
            "2024-04-03 22:34:30  WARNING OGG-02905  Replication of OID column in object tables may diverge.",
            "",
            "2024-04-03 22:34:30  INFO    OGG-02776  Native data capture is enabled for Oracle NUMBER data type.",
            "",
            "2024-04-03 22:34:30  INFO    OGG-01971  The previous message, 'INFO OGG-02776', repeated 1 times.",
            "",
            "2024-04-03 22:34:30  INFO    OGG-01052  No recovery is required for target file north/ea000000000, at RBA 0 (file not opened).",
            "",
            "2024-04-03 22:34:30  INFO    OGG-01478  Output file north/ea is using format RELEASE 19.1/21.1/23.1.",
            "",
            "***********************************************************************",
            "**                     Run Time Messages                             **",
            "***********************************************************************",
            "",
            "",
            "2024-04-03 22:34:31  INFO    OGG-01515  Positioning to begin time 2024 M04 3 22:33:44.",
            "",
            "2024-04-03 22:34:31  INFO    OGG-02845  Position of first record processed Sequence 4, RBA 21241360, SCN 2065844, Time 2024 M04 3 22:33:46.",
            "",
            "2024-04-03 22:34:36  INFO    OGG-02557  Heartbeat table DBNORTH_PDB1.GGADMIN.GG_HEARTBEAT_SEED metadata is resolved and will write to trail file north/ea.",
            "",
            "2024-04-03 22:34:36  WARNING OGG-30426  Error mapping update record, because key column(s) of table DBNORTH_PDB1.GGADMIN.GG_HEARTBEAT_SEED is/are missing from the trail."
        ]
    }
}