Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve an existing Heartbeat timings

get

/services/{version}/mpoints/{item}/heartbeat

Required Role: User

Retrieve an existing Heartbeat timings

Request

Path Parameters

item(required): string

Minimum Length: 1

Maximum Length: 32
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Heartbeat Timings

Type: object

Title: Oracle GoldenGate Heartbeat Timings

Show Source

$schema:

Allowed Values: [ "mpoints:heartbeat" ]
heartbeats(required): array heartbeats

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Heartbeat Timings",
    "required":[
        "heartbeats"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:heartbeat"
            ]
        },
        "heartbeats":{
            "type":"array",
            "minItems":"0",
            "maxItems":"2147483647",
            "items":{
                "type":"object",
                "properties":{
                    "heartbeatName":{
                        "description":"Extract, Replicat or Path name",
                        "x-anyOf":[
                            {
                                "type":"string",
                                "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                                "minLength":"1",
                                "maxLength":"8"
                            },
                            {
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"4096"
                            }
                        ]
                    },
                    "heartbeatLag":{
                        "description":"Heartbeat Lag in milliseconds",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "heartbeatAge":{
                        "description":"Heartbeat Age in milliseconds",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    }
                },
                "required":[
                    "heartbeatName",
                    "heartbeatLag",
                    "heartbeatAge"
                ],
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : heartbeats

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":{
            "heartbeatName":{
                "description":"Extract, Replicat or Path name",
                "x-anyOf":[
                    {
                        "type":"string",
                        "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                        "minLength":"1",
                        "maxLength":"8"
                    },
                    {
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4096"
                    }
                ]
            },
            "heartbeatLag":{
                "description":"Heartbeat Lag in milliseconds",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "heartbeatAge":{
                "description":"Heartbeat Age in milliseconds",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            }
        },
        "required":[
            "heartbeatName",
            "heartbeatLag",
            "heartbeatAge"
        ],
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

heartbeatAge(required): integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Heartbeat Age in milliseconds
heartbeatLag(required): integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Heartbeat Lag in milliseconds
heartbeatName(required): heartbeatName

Extract, Replicat or Path name

{
    "type":"object",
    "properties":{
        "heartbeatName":{
            "description":"Extract, Replicat or Path name",
            "x-anyOf":[
                {
                    "type":"string",
                    "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                    "minLength":"1",
                    "maxLength":"8"
                },
                {
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                }
            ]
        },
        "heartbeatLag":{
            "description":"Heartbeat Lag in milliseconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "heartbeatAge":{
            "description":"Heartbeat Age in milliseconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        }
    },
    "required":[
        "heartbeatName",
        "heartbeatLag",
        "heartbeatAge"
    ],
    "additionalProperties":false
}

Nested Schema : heartbeatName

Extract, Replicat or Path name

Match Any

Show Source

string

Minimum Length: 1

Maximum Length: 8

Pattern: ^[A-Z_$][A-Z0-9_$]*$
string

Minimum Length: 1

Maximum Length: 4096

{
    "description":"Extract, Replicat or Path name",
    "x-anyOf":[
        {
            "type":"string",
            "pattern":"^[A-Z_$][A-Z0-9_$]*$",
            "minLength":"1",
            "maxLength":"8"
        },
        {
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"http://localhost:9103/services/v2/mpoints/DISTSRVR/heartbeat",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"http://localhost:9103/services/v2/mpoints/DISTSRVR/heartbeat",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"http://localhost:9103/services/v2/metadata-catalog/heartbeat",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "heartbeats":[
            {
                "heartbeatName":"pathE1toR2",
                "heartbeatLag":"3175",
                "heartbeatAge":"25023"
            },
            {
                "heartbeatName":"pathE1toR1",
                "heartbeatLag":"3190",
                "heartbeatAge":"25023"
            }
        ],
        "$schema":"mpoints:heartbeat"
    }
}