Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Report

get

/services/{version}/replicats/{replicat}/info/reports/{report}

Required Role: User

Retrieve a report from the replicat process.

Request

Path Parameters

replicat(required): string

Minimum Length: 1

Maximum Length: 8

Pattern: ^[A-Z_$][A-Z0-9_$]*$

The name of the replicat. Replicat 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 replicat 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/replicats/REPS/info/reports/REPS.rpt",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS/info/reports/REPS.rpt",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/replicatReport",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:report",
        "lines":[
            "",
            "***********************************************************************",
            "                 Oracle GoldenGate Delivery for Oracle",
            "         Version 23.4.0.0.0 OGGCORE_MAIN_LINUX.X64_240331.1800",
            "     Linux, x64, 64bit (optimized), Oracle on Apr  3 2024 11:22:05",
            " ",
            "Copyright (C) 1995, 2024, Oracle and/or its affiliates. All rights reserved.",
            "",
            "                    Starting at 2024-04-03 22:35:29",
            "***********************************************************************",
            "",
            "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: 787",
            "",
            "Description: ",
            "",
            "***********************************************************************",
            "**            Running with the following parameters                  **",
            "***********************************************************************",
            "",
            "2024-04-03 22:35:29  INFO    OGG-03059  Operating system character set identified as UTF-8.",
            "",
            "2024-04-03 22:35:29  INFO    OGG-02695  ANSI SQL parameter syntax is used for parameter parsing.",
            "",
            "2024-04-03 22:35:29  INFO    OGG-02743  GLOBALS parameter GGSCHEMA is set to 'ggadmin'.",
            "",
            "2024-04-03 22:35:29  INFO    OGG-01360  REPLICAT is running in Integrated mode.",
            "Replicat    reps",
            "UseridAlias ggsouth",
            "",
            "2024-04-03 22:35:30  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:35:31  INFO    OGG-02679  The Replicat process logged on to database DBNORTH_PDB1 and can only apply to that database.",
            "Map         hr.*,",
            "Target    hr.*;",
            "",
            "2024-04-03 22:35:31  INFO    OGG-02669  Default catalog name DBNORTH_PDB1 will be used for target table name hr.* mapping.",
            "",
            "2024-04-03 22:35:31  INFO    OGG-06451  Triggers will be suppressed by default.",
            "",
            "2024-04-03 22:35:31  INFO    OGG-02733  Heartbeat table found in the connected schema ggadmin, using this heartbeat table.",
            "",
            "2024-04-03 22:35:31  INFO    OGG-01851  filecaching started: thread ID: 140219451614976.",
            "",
            "2024-04-03 22:35:31  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:35:31  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:35:31  INFO    OGG-25341  ",
            "Database Language and Character Set:",
            "NLS_LANGUAGE     = \"AMERICAN\" ",
            "NLS_TERRITORY    = \"AMERICA\" ",
            "NLS_CHARACTERSET = \"AL32UTF8\".",
            "",
            "2024-04-03 22:35:31  INFO    OGG-26025  ",
            "Database Unique Name: ORCLCDB.",
            "",
            "2024-04-03 22:35:31  INFO    OGG-06604  Connected to database DBNORTH_PDB1, CPU info: CPU Count 64, CPU Core Count 64, CPU Socket Count 1.",
            "",
            "2024-04-03 22:35:31  INFO    OGG-30192  Target Table DDL Notification turned ON.",
            "",
            "2024-04-03 22:35:31  INFO    OGG-02545  Parameter GROUPTRANSOPS is ignored by Integrated Replicat when parallelism is greater than 1.",
            "",
            "2024-04-03 22:35:35  INFO    OGG-02528  Replicat group REPS successfully registered with database as inbound server OGG$REPS.",
            "",
            "2024-04-03 22:35:35  INFO    OGG-06627  Replicat sets the key columns for each table replicated by inbound server OGG$REPS.",
            "",
            "2024-04-03 22:35:46  INFO    OGG-02530  Integrated replicat successfully attached to inbound server OGG$REPS.",
            "",
            "***********************************************************************",
            "**                     Run Time Messages                             **",
            "***********************************************************************",
            ""
        ]
    }
}