Oracle GoldenGate 19c Microservices Architecture REST API

Create Heartbeat Table

post

/services/{version}/connections/{connection}/tables/heartbeat

Create the heartbeat table for a database connection.

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

Root Schema : Oracle GoldenGate Heartbeat Table

Type: object

Title: Oracle GoldenGate Heartbeat Table

Show Source

$schema(optional):

Allowed Values: [ "ogg:tablesHeartbeat" ]
frequency(optional): integer

Minimum Value: 0

Maximum Value: 7999

Default Value: 60

Interval, in seconds, at which the heartbeat table is updated.
partitioned(optional): boolean

Default Value: false

Whether the heartbeat history table is partitioned or not.
purgeFrequency(optional): integer

Minimum Value: 1

Maximum Value: 199

Default Value: 1

Interval, in days, at which the heartbeat history table is purged.
retentionTime(optional): integer

Minimum Value: 1

Maximum Value: 2147483646

Default Value: 30

Heartbeats older than this retention time (in days) will be deleted from the heartbeat table.
targetOnly(optional): boolean

Default Value: false

Boolean value to enable or disable supplemental logging and the scheduler job for updating heartbeat seed and heartbeat tables.
trackingExtractRestart(optional): boolean

Default Value: true

Whether current heartbeat table setup is tracking extract restart position or not.
upgrade(optional): boolean

Default Value: false

Boolean value to detect when to upgrade the heartbeat tables.

{
    "title":"Oracle GoldenGate Heartbeat Table",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:tablesHeartbeat"
            ]
        },
        "frequency":{
            "description":"Interval, in seconds, at which the heartbeat table is updated.",
            "type":"integer",
            "default":60,
            "minimum":0,
            "maximum":7999
        },
        "retentionTime":{
            "description":"Heartbeats older than this retention time (in days) will be deleted from the heartbeat table.",
            "type":"integer",
            "default":30,
            "minimum":1,
            "maximum":2147483646
        },
        "purgeFrequency":{
            "description":"Interval, in days, at which the heartbeat history table is purged.",
            "type":"integer",
            "minimum":1,
            "default":1,
            "maximum":199
        },
        "partitioned":{
            "description":"Whether the heartbeat history table is partitioned or not.",
            "type":"boolean",
            "default":false
        },
        "targetOnly":{
            "description":"Boolean value to enable or disable supplemental logging and the scheduler job for updating heartbeat seed and heartbeat tables.",
            "type":"boolean",
            "default":false
        },
        "trackingExtractRestart":{
            "description":"Whether current heartbeat table setup is tracking extract restart position or not.",
            "type":"boolean",
            "default":true
        },
        "upgrade":{
            "description":"Boolean value to detect when to upgrade the heartbeat tables. ",
            "type":"boolean",
            "default":false
        }
    },
    "additionalProperties":false
}

Example Request (application/json)

{
    "frequency":60
}

Response

Supported Media Types

application/json

201 Response

Heartbeat table resources created successfully.

Root Schema : RESTful API Standard Response

Type: object

Title: RESTful API Standard Response

Standard Response for all Oracle GoldenGate RESTful API calls

Show Source

$schema(optional):

Allowed Values: [ "api:standardResponse" ]
links: array links

Minimum Number of Items: 0

Maximum Number of Items: 16

Oracle GoldenGate links for the request
messages: array messages

Minimum Number of Items: 0

Maximum Number of Items: 65535

Oracle GoldenGate messages issued during the request
response(optional): object response

Oracle GoldenGate document from the request

{
    "title":"RESTful API Standard Response",
    "description":"Standard Response for all Oracle GoldenGate RESTful API calls",
    "required":[
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "api:standardResponse"
            ]
        },
        "response":{
            "description":"Oracle GoldenGate document from the request",
            "type":"object"
        },
        "messages":{
            "description":"Oracle GoldenGate messages issued during the request",
            "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":65535
        },
        "links":{
            "description":"Oracle GoldenGate links for the request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:link"
                        ]
                    },
                    "rel":{
                        "description":"Relationship of href to the requested link",
                        "enum":[
                            "alternate",
                            "canonical",
                            "current",
                            "describedby",
                            "describes",
                            "enclosure",
                            "parent",
                            "related",
                            "self",
                            "first",
                            "last",
                            "next",
                            "previous"
                        ]
                    },
                    "href":{
                        "description":"An absolute URI for the link",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":2,
                        "maxLength":4095
                    },
                    "mediaType":{
                        "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                        "type":"string",
                        "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                        "minLength":6,
                        "maxLength":255
                    },
                    "description":{
                        "description":"A human-readable description that provides information and detail specific to this link.",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4095
                    }
                },
                "required":[
                    "rel",
                    "href"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":16
        }
    },
    "additionalProperties":false
}

Nested Schema : links

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 16

Oracle GoldenGate links for the request

Show Source

Array of: object items

{
    "description":"Oracle GoldenGate links for the request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:link"
                ]
            },
            "rel":{
                "description":"Relationship of href to the requested link",
                "enum":[
                    "alternate",
                    "canonical",
                    "current",
                    "describedby",
                    "describes",
                    "enclosure",
                    "parent",
                    "related",
                    "self",
                    "first",
                    "last",
                    "next",
                    "previous"
                ]
            },
            "href":{
                "description":"An absolute URI for the link",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":2,
                "maxLength":4095
            },
            "mediaType":{
                "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                "type":"string",
                "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                "minLength":6,
                "maxLength":255
            },
            "description":{
                "description":"A human-readable description that provides information and detail specific to this link.",
                "type":"string",
                "minLength":1,
                "maxLength":4095
            }
        },
        "required":[
            "rel",
            "href"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":16
}

Nested Schema : messages

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 65535

Oracle GoldenGate messages issued during the request

Show Source

Array of: object items

{
    "description":"Oracle GoldenGate messages issued during the request",
    "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":65535
}

Nested Schema : response

Type: object

Oracle GoldenGate document from the request

Nested Schema : items

Type: object

Show Source

$schema(optional):

Allowed Values: [ "ogg:link" ]
description(optional): string

Minimum Length: 1

Maximum Length: 4095

A human-readable description that provides information and detail specific to this link.
href: string

Minimum Length: 2

Maximum Length: 4095

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

An absolute URI for the link
mediaType(optional): string

Minimum Length: 6

Maximum Length: 255

Pattern: ^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$

Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)
rel:

Allowed Values: [ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]

Relationship of href to the requested link

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:link"
            ]
        },
        "rel":{
            "description":"Relationship of href to the requested link",
            "enum":[
                "alternate",
                "canonical",
                "current",
                "describedby",
                "describes",
                "enclosure",
                "parent",
                "related",
                "self",
                "first",
                "last",
                "next",
                "previous"
            ]
        },
        "href":{
            "description":"An absolute URI for the link",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":2,
            "maxLength":4095
        },
        "mediaType":{
            "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
            "type":"string",
            "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
            "minLength":6,
            "maxLength":255
        },
        "description":{
            "description":"A human-readable description that provides information and detail specific to this link.",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "additionalProperties":false
}

Nested Schema : items

Type: object

Show Source

$schema(optional):

Allowed Values: [ "ogg:message" ]
code: string

Minimum Length: 9

Maximum Length: 9

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

The Oracle GoldenGate message code
issued: 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:

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

The severity of the message
title: 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: 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://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeat",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeat",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-14001",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created heartbeat seed table \"\"oggadmin\".\"GG_HEARTBEAT_SEED\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14001"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14089",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully tracking extract restart position with heartbeat table \"\"oggadmin\".\"GG_HEARTBEAT_SEED\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14089"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14032",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully added supplemental logging for heartbeat seed table \"\"oggadmin\".\"GG_HEARTBEAT_SEED\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14032"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14000",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created heartbeat table \"\"oggadmin\".\"GG_HEARTBEAT\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14000"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14089",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully tracking extract restart position with heartbeat table \"\"oggadmin\".\"GG_HEARTBEAT\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14089"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14033",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully added supplemental logging for heartbeat table \"\"oggadmin\".\"GG_HEARTBEAT\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14033"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14016",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created heartbeat history table \"\"oggadmin\".\"GG_HEARTBEAT_HISTORY\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14016"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14089",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully tracking extract restart position with heartbeat table \"\"oggadmin\".\"GG_HEARTBEAT_HISTORY\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14089"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14086",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully disabled partitioning for heartbeat history table \"\"oggadmin\".\"GG_HEARTBEAT_HISTORY\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14086"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14023",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created heartbeat lag view \"\"oggadmin\".\"GG_LAG\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14023"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14024",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created heartbeat lag history view \"\"oggadmin\".\"GG_LAG_HISTORY\"\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14024"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14003",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully populated heartbeat seed table with \"ORCL\".",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14003"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14004",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created procedure \"\"oggadmin\".\"GG_UPDATE_HB_TAB\"\" to update the heartbeat tables.",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14004"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14017",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created procedure \"\"oggadmin\".\"GG_PURGE_HB_TAB\"\" to purge the heartbeat history table.",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14017"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14005",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created scheduler job \"\"oggadmin\".\"GG_UPDATE_HEARTBEATS\"\" to update the heartbeat tables.",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14005"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-14018",
            "issued":"2019-03-15T14:40:44Z",
            "severity":"INFO",
            "title":"Successfully created scheduler job \"\"oggadmin\".\"GG_PURGE_HEARTBEATS\"\" to purge the heartbeat history table.",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14018"
        }
    ]
}