Jump to

• Request
• Response

Retrieve Connection

get

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

Retrieve the database connection details.

Request

Path Parameters

• connection: 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: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Database connection details retrieved.

Body ()

Root Schema : Oracle GoldenGate database connection

Type: object

Title: Oracle GoldenGate database connection

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:connection" ]
• credentials: 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(optional):
  Allowed Values: [ "ogg:credentialsRef" ]
• alias(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
• domain(optional): 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"
        }
    }
}

Back to Top