Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Database Table Details

get

/services/{version}/connections/{connection}/databases/{database}/{schema}/{table}

Required Role: User

Retrieve details for a table in the schema.

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.
database(required): string

Minimum Length: 1

Maximum Length: 130

Database name.
schema(required): string

Minimum Length: 1

Maximum Length: 130

Schema name in the database.
table(required): string

Minimum Length: 1

Maximum Length: 130

Table name in the database.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Table details retrieved successfully.

Root Schema : Database Table Details

Type: object

Title: Database Table Details

Show Source

$schema:

Allowed Values: [ "ogg:tableDetails" ]
autoCapture: boolean

Default Value: false
created(required): string

Minimum Length: 20

Maximum Length: 32

Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$

Date and time table was created
name(required): name

Qualified table name
type(required):

Allowed Values: [ "normal", "checkpoint", "heartbeat" ]

Type of table

{
    "title":"Database Table Details",
    "required":[
        "name",
        "type",
        "created"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:tableDetails"
            ]
        },
        "name":{
            "description":"Qualified table name",
            "x-anyOf":[
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":"3",
                    "maxLength":"261"
                },
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":"5",
                    "maxLength":"392"
                }
            ]
        },
        "type":{
            "description":"Type of table",
            "enum":[
                "normal",
                "checkpoint",
                "heartbeat"
            ]
        },
        "created":{
            "description":"Date and time table was created",
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":"20",
            "maxLength":"32"
        },
        "autoCapture":{
            "type":"boolean",
            "default":false
        }
    },
    "additionalProperties":false
}

Nested Schema : name

Qualified table name

Match Any

Show Source

string

Minimum Length: 3

Maximum Length: 261

Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
string

Minimum Length: 5

Maximum Length: 392

Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$

{
    "description":"Qualified table name",
    "x-anyOf":[
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":"3",
            "maxLength":"261"
        },
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":"5",
            "maxLength":"392"
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/HR/EMPLOYEES",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/HR/EMPLOYEES",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/table",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:tableDetails",
        "autoCapture":true,
        "created":"2024-04-03T22:32:46.000Z",
        "name":"HR.EMPLOYEES",
        "type":"normal"
    }
}