Oracle GoldenGate Microservices REST API

Execute a command

post

/services/{version}/monitoring/commands/execute

Required Role: Operator

Execute a command

Request

Supported Media Types

application/json

Path Parameters

version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Root Schema : Oracle GoldenGate PM Service Command

Title: Oracle GoldenGate PM Service Command

Match One

Show Source

object Oracle GoldenGate PM Service Command-x-oneOf[0]

Purge the Datastore Messages and Status Changes

{
    "x-oneOf":[
        {
            "description":"Purge the Datastore Messages and Status Changes",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "monitoring:command"
                    ]
                },
                "name":{
                    "enum":[
                        "purgeDatastore"
                    ]
                },
                "retentionDays":{
                    "description":"Allowed value for days value",
                    "type":"integer",
                    "minimum":"1",
                    "maximum":"365"
                }
            },
            "required":[
                "name",
                "retentionDays"
            ],
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate PM Service Command"
}

Nested Schema : Oracle GoldenGate PM Service Command-x-oneOf[0]

Type: object

Purge the Datastore Messages and Status Changes

Show Source

$schema:

Allowed Values: [ "monitoring:command" ]
name(required):

Allowed Values: [ "purgeDatastore" ]
retentionDays(required): integer

Minimum Value: 1

Maximum Value: 365

Allowed value for days value

{
    "description":"Purge the Datastore Messages and Status Changes",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "monitoring:command"
            ]
        },
        "name":{
            "enum":[
                "purgeDatastore"
            ]
        },
        "retentionDays":{
            "description":"Allowed value for days value",
            "type":"integer",
            "minimum":"1",
            "maximum":"365"
        }
    },
    "required":[
        "name",
        "retentionDays"
    ],
    "additionalProperties":false
}

Example Request (application/json)

{
    "name":"purgeDatastore",
    "daysValue":"90"
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Task Manager Command Result

Type: object

Title: Oracle GoldenGate Task Manager Command Result

Show Source

$schema:

Allowed Values: [ "monitoring:commandResult" ]
commandResult: object commandResult
messages: array messages

Minimum Number of Items: 0

Maximum Number of Items: 1024

{
    "title":"Oracle GoldenGate Task Manager Command Result",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "monitoring:commandResult"
            ]
        },
        "commandResult":{
            "type":"object",
            "properties":{
                "messagesPurged":{
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                },
                "statusChangesPurged":{
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295"
                }
            },
            "additionalProperties":false
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:message"
                        ]
                    },
                    "type":{
                        "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":"2",
                        "maxLength":"4095"
                    },
                    "title":{
                        "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4095"
                    },
                    "code":{
                        "description":"The Oracle GoldenGate message code",
                        "type":"string",
                        "pattern":"^OGG[-][0-9]{5}$",
                        "minLength":"9",
                        "maxLength":"9"
                    },
                    "severity":{
                        "description":"The severity of the message",
                        "enum":[
                            "INFO",
                            "WARNING",
                            "ERROR"
                        ]
                    },
                    "issued":{
                        "description":"The date and time that the message was issued",
                        "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"
                    }
                },
                "required":[
                    "type",
                    "title",
                    "code",
                    "severity",
                    "issued"
                ],
                "additionalProperties":false
            },
            "minItems":"0",
            "maxItems":"1024"
        }
    },
    "additionalProperties":false
}

Nested Schema : commandResult

Type: object

Show Source

messagesPurged: integer

Minimum Value: 0

Maximum Value: 4294967295
statusChangesPurged: integer

Minimum Value: 0

Maximum Value: 4294967295

{
    "type":"object",
    "properties":{
        "messagesPurged":{
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "statusChangesPurged":{
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        }
    },
    "additionalProperties":false
}

Nested Schema : messages

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 1024

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:message"
                ]
            },
            "type":{
                "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":"2",
                "maxLength":"4095"
            },
            "title":{
                "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
                "type":"string",
                "minLength":"1",
                "maxLength":"4095"
            },
            "code":{
                "description":"The Oracle GoldenGate message code",
                "type":"string",
                "pattern":"^OGG[-][0-9]{5}$",
                "minLength":"9",
                "maxLength":"9"
            },
            "severity":{
                "description":"The severity of the message",
                "enum":[
                    "INFO",
                    "WARNING",
                    "ERROR"
                ]
            },
            "issued":{
                "description":"The date and time that the message was issued",
                "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"
            }
        },
        "required":[
            "type",
            "title",
            "code",
            "severity",
            "issued"
        ],
        "additionalProperties":false
    },
    "minItems":"0",
    "maxItems":"1024"
}

Nested Schema : items

Type: object

Show Source

$schema:

Allowed Values: [ "ogg:message" ]
code(required): string

Minimum Length: 9

Maximum Length: 9

Pattern: ^OGG[-][0-9]{5}$

The Oracle GoldenGate message code
issued(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])$

The date and time that the message was issued
severity(required):

Allowed Values: [ "INFO", "WARNING", "ERROR" ]

The severity of the message
title(required): string

Minimum Length: 1

Maximum Length: 4095

A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
type(required): string

Minimum Length: 2

Maximum Length: 4095

Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

An absolute URI [RFC3986] to a page that describes the info, warning or error type.

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:message"
            ]
        },
        "type":{
            "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":"2",
            "maxLength":"4095"
        },
        "title":{
            "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "code":{
            "description":"The Oracle GoldenGate message code",
            "type":"string",
            "pattern":"^OGG[-][0-9]{5}$",
            "minLength":"9",
            "maxLength":"9"
        },
        "severity":{
            "description":"The severity of the message",
            "enum":[
                "INFO",
                "WARNING",
                "ERROR"
            ]
        },
        "issued":{
            "description":"The date and time that the message was issued",
            "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"
        }
    },
    "required":[
        "type",
        "title",
        "code",
        "severity",
        "issued"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://ogg.example.com:9000/services/v2/commands/execute",
            "mediaType":"text/html",
            "rel":"canonical"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-14082",
            "issued":"2015-08-12T16:52:47Z",
            "severity":"INFO",
            "title":"Purge Complete, 123 Messages Removed, 11 Status Changes Removed.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-14082"
        }
    ]
}