Oracle GoldenGate Microservices REST API

Retrieve Connection

get

/services/{version}/connections/{connection}

Required Role: User

Retrieve the database connection details.

Request

Path Parameters

connection(required): string

Minimum Length: 1

Maximum Length: 61

Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]{1,29}([.][a-zA-Z][a-zA-Z0-9_#$]{1,29})?$

Connection name. For each alias in the credential store, a connection with the name 'domain.alias' exists.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Database connection details retrieved.

Root Schema : Oracle GoldenGate database connection

Type: object

Title: Oracle GoldenGate database connection

Show Source

$schema:

Allowed Values: [ "ogg:connection" ]
credentials(required): object credentials

Credentials for database

{
    "title":"Oracle GoldenGate database connection",
    "required":[
        "credentials"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:connection"
            ]
        },
        "credentials":{
            "description":"Credentials for database",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:credentialsRef"
                    ]
                },
                "domain":{
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                    "minLength":"1",
                    "maxLength":"30",
                    "default":"OracleGoldenGate"
                },
                "alias":{
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                    "minLength":"1",
                    "maxLength":"30"
                }
            },
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : credentials

Type: object

Credentials for database

Show Source

$schema:

Allowed Values: [ "ogg:credentialsRef" ]
alias: string

Minimum Length: 1

Maximum Length: 30

Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
domain: string

Minimum Length: 1

Maximum Length: 30

Default Value: OracleGoldenGate

Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$

{
    "description":"Credentials for database",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:credentialsRef"
            ]
        },
        "domain":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":"1",
            "maxLength":"30",
            "default":"OracleGoldenGate"
        },
        "alias":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":"1",
            "maxLength":"30"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/connections/LocalDBMS",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/LocalDBMS",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/connection",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:connection",
        "credentials":{
            "alias":"oggadmin",
            "domain":"OracleGoldenGate"
        }
    }
}