Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve an existing Process Status Changes

get

/services/{version}/monitoring/{item}/statusChanges

Required Role: User

Retrieve an existing Process Status Changes

Request

Path Parameters

item(required): string
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Query Parameters

fromID: string

Starting Index Number
limit: string

Limit on the number of records to retreive
offset: string

Starting offset in result set
toID: string

Ending Index Number

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Process Status Changes

Type: object

Title: Oracle GoldenGate Process Status Changes

Show Source

$schema:

Allowed Values: [ "monitoring:statusChanges" ]
statusChange: array statusChange

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Process Status Changes",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "monitoring:statusChanges"
            ]
        },
        "statusChange":{
            "type":"array",
            "minItems":"0",
            "maxItems":"2147483647",
            "items":{
                "type":"object",
                "properties":{
                    "identifier":{
                        "description":"The status id number",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"4294967295"
                    },
                    "process":{
                        "description":"The process name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"16"
                    },
                    "date":{
                        "description":"Date and Time the status changed",
                        "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"
                    },
                    "status":{
                        "description":"The Process Status",
                        "enum":[
                            "Registered",
                            "Starting",
                            "Running",
                            "Stopping",
                            "StoppingForced",
                            "Stopped",
                            "StoppedForced",
                            "Abend",
                            "Killed",
                            "NotResponsive"
                        ]
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : statusChange

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

Array of: object items

{
    "type":"array",
    "minItems":"0",
    "maxItems":"2147483647",
    "items":{
        "type":"object",
        "properties":{
            "identifier":{
                "description":"The status id number",
                "type":"integer",
                "minimum":"0",
                "maximum":"4294967295"
            },
            "process":{
                "description":"The process name",
                "type":"string",
                "minLength":"1",
                "maxLength":"16"
            },
            "date":{
                "description":"Date and Time the status changed",
                "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"
            },
            "status":{
                "description":"The Process Status",
                "enum":[
                    "Registered",
                    "Starting",
                    "Running",
                    "Stopping",
                    "StoppingForced",
                    "Stopped",
                    "StoppedForced",
                    "Abend",
                    "Killed",
                    "NotResponsive"
                ]
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

date: 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 the status changed
identifier: integer

Minimum Value: 0

Maximum Value: 4294967295

The status id number
process: string

Minimum Length: 1

Maximum Length: 16

The process name
status:

Allowed Values: [ "Registered", "Starting", "Running", "Stopping", "StoppingForced", "Stopped", "StoppedForced", "Abend", "Killed", "NotResponsive" ]

The Process Status

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"The status id number",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "process":{
            "description":"The process name",
            "type":"string",
            "minLength":"1",
            "maxLength":"16"
        },
        "date":{
            "description":"Date and Time the status changed",
            "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"
        },
        "status":{
            "description":"The Process Status",
            "enum":[
                "Registered",
                "Starting",
                "Running",
                "Stopping",
                "StoppingForced",
                "Stopped",
                "StoppedForced",
                "Abend",
                "Killed",
                "NotResponsive"
            ]
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"monitoring:statusChanges",
        "identifier":"1",
        "process":"MGR",
        "date":"2015-06-05T13:22:18.034Z",
        "type":"Manager",
        "status":"Running"
    },
    "messages":[
    ],
    "links":[
    ]
}