REST API for GoldenGate Veridata

Update Agent Log Configurations

patch

http://{host}:{port}/veridata/v1/services/logs/agents/{Id}/configuration

Required Role: Administrator, SuperUser, CommandLineOperator

Update Agent Log configurations.

Request

Path Parameters

Id(required): integer

Agent ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

logParameters(required): array logParameters

{
    "type":"object",
    "properties":{
        "logParameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LogConfigParams"
            }
        }
    },
    "required":[
        "logParameters"
    ]
}

Nested Schema : logParameters

Type: array

Show Source

Array of: object LogConfigParams

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LogConfigParams"
    }
}

Nested Schema : LogConfigParams

Type: object

Show Source

level: string

Allowed Values: [ "INFO", "SEVERE", "OFF", "FINEST" ]

Log level to be updated for component
name: string

Log component to be updated

{
    "type":"object",
    "properties":{
        "level":{
            "$ref":"#/components/schemas/SettingsLogLevel"
        },
        "name":{
            "type":"string",
            "description":"Log component to be updated"
        }
    },
    "example":{
        "level":"INFO",
        "name":"oracle.veridata"
    }
}

Example:

{
    "level":"INFO",
    "name":"oracle.veridata"
}

Response

Supported Media Types

application/json

200 Response

Updated Agent log configurations successfully.

Root Schema : schema

Type: object

Show Source

message: string

Example: Configurations updated successfully

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "example":"Configurations updated successfully"
        }
    }
}

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}