Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Manage Procedural Supplemental Logging

post

/services/{version}/connections/{connection}/trandata/procedure

Required Role: Administrator

Manage Supplemental Logging for Database Procedures

Request

Supported Media Types

application/json

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" ]

Root Schema : Manage Supplemental Logging for Database Procedures

Type: object

Title: Manage Supplemental Logging for Database Procedures

Show Source

$schema:

Allowed Values: [ "ogg:trandataProcedure" ]
operation(required):

Allowed Values: [ "add", "delete", "info" ]

{
    "title":"Manage Supplemental Logging for Database Procedures",
    "required":[
        "operation"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:trandataProcedure"
            ]
        },
        "operation":{
            "enum":[
                "add",
                "delete",
                "info"
            ]
        }
    },
    "additionalProperties":false
}

Example Request (application/json)

{
    "operation":"info"
}

Response

Supported Media Types

application/json

200 Response

Supplemental logging command completed successfully.

Root Schema : Manage Supplemental Logging for Database Procedure

Type: object

Title: Manage Supplemental Logging for Database Procedure

Show Source

$schema:

Allowed Values: [ "ogg:trandataProcedureResponse" ]
enabled(required): boolean

True if procedure supplemental logging is enabled on the connected database
type(required):

Allowed Values: [ "info" ]

{
    "title":"Manage Supplemental Logging for Database Procedure",
    "required":[
        "type",
        "enabled"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:trandataProcedureResponse"
            ]
        },
        "type":{
            "enum":[
                "info"
            ]
        },
        "enabled":{
            "description":"True if procedure supplemental logging is enabled on the connected database",
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggnorth/trandata/procedure",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggnorth/trandata/procedure",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:trandataProcedureResponse",
        "enabled":false,
        "type":"info"
    }
}