Jump to

• Request
• Response

Manage Procedural Supplemental Logging

post

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

Manage Supplemental Logging for Database Procedures

Request

Supported Media Types

• application/json

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

Body ()

Root Schema : Manage Supplemental Logging for Database Procedures

Type: object

Title: Manage Supplemental Logging for Database Procedures

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:trandataProcedure" ]
• operation:
  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"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Supplemental logging command completed successfully.

Body ()

Root Schema : Manage Supplemental Logging for Database Procedure

Type: object

Title: Manage Supplemental Logging for Database Procedure

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:trandataProcedureResponse" ]
• enabled: boolean
  True if procedure supplemental logging is enabled on the connected database
• type:
  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:11001/services/v2/connections/OracleGoldenGate.oggadmin/trandata/procedure",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/trandata/procedure",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:trandataProcedureResponse",
        "enabled":false,
        "type":"info"
    }
}

Back to Top