Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve an existing Basic Configuration Information for Manager and Services

get

/services/{version}/mpoints/{item}/configurationManager

Required Role: User

Retrieve an existing Basic Configuration Information for Manager and Services

Request

Path Parameters

item(required): string

Minimum Length: 1

Maximum Length: 32
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Manager Configuration Details

Type: object

Title: Oracle GoldenGate Manager Configuration Details

Show Source

$schema:

Allowed Values: [ "mpoints:configurationManager" ]
buildDate: string

Minimum Length: 1

Maximum Length: 32

BuildDate
buildDB: string

Minimum Length: 1

Maximum Length: 32

Build Database
buildPlatform: string

Minimum Length: 1

Maximum Length: 32

Build Platform
hostName: string

Minimum Length: 1

Maximum Length: 256

Local Host Name
oggVersion: string

Minimum Length: 1

Maximum Length: 256

Golden Gate Version
osName: string

Minimum Length: 1

Maximum Length: 512

Operating System Name and Version
workingDirectory: string

Minimum Length: 1

Maximum Length: 512

The directory of the OGG installation

{
    "title":"Oracle GoldenGate Manager Configuration Details",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:configurationManager"
            ]
        },
        "oggVersion":{
            "description":"Golden Gate Version",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        },
        "hostName":{
            "description":"Local Host Name",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        },
        "osName":{
            "description":"Operating System Name and Version",
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "workingDirectory":{
            "description":"The directory of the OGG installation",
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "buildDB":{
            "description":"Build Database",
            "type":"string",
            "minLength":"1",
            "maxLength":"32"
        },
        "buildPlatform":{
            "description":"Build Platform",
            "type":"string",
            "minLength":"1",
            "maxLength":"32"
        },
        "buildDate":{
            "description":"BuildDate",
            "type":"string",
            "minLength":"1",
            "maxLength":"32"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"mpoints:configurationManager",
        "oggVersion":"Version 12.2.0.1.0 OGGCORE_MAIN_PLATFORMS_150601.1402",
        "hostName":"slc03flg",
        "osName":"Linux  x86_64 Version #1 SMP Fri Nov 15 13:39:16 PST 2013 (2.6.39-400.211.1.el6uek.x86_64)",
        "workingDirectory":"/net/slc03flg/scratch/jdivinc/view_storage/jdivinc_db1/tklocal/ggora",
        "buildDB":"Oracle12",
        "buildPlatform":"Linux",
        "buildDate":"Nov 15 2015 12:11:41"
    },
    "messages":[
    ],
    "links":[
    ]
}