Jump to

• Request
• Response

Get Configuration

get

/services/{version}/installation/configuration

Required Role: Administrator

Retrieve the configuration details for the GoldenGate installation.

Request

Path Parameters

• version(required): string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Configuration retrieved

Body ()

Root Schema : Oracle GoldenGate Installation Configuration

Type: object

Title: Oracle GoldenGate Installation Configuration

Properties for an Oracle GoldenGate deployment

Show Source

• $schema:
  Allowed Values: [ "ogg:installationConfiguration" ]
• configurationServiceEnabled(required): boolean
  Indicates the Configuration Service is enabled for the installation
• installationId: string(uuid)
  Unique Identifier for the installation

{
    "title":"Oracle GoldenGate Installation Configuration",
    "description":"Properties for an Oracle GoldenGate deployment",
    "required":[
        "configurationServiceEnabled"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:installationConfiguration"
            ]
        },
        "installationId":{
            "description":"Unique Identifier for the installation",
            "type":"string",
            "format":"uuid"
        },
        "configurationServiceEnabled":{
            "description":"Indicates the Configuration Service is enabled for the installation",
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9011/services/v2/installation/configuration",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9011/services/v2/installation/configuration",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9011/services/v2/metadata-catalog/configuration",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:installationConfiguration",
        "configurationServiceEnabled":true
    }
}

Back to Top