Oracle GoldenGate 19c Microservices Architecture REST API

Manage Instantiation CSN

post

/services/{version}/connections/{connection}/databases/{database}/{schema}/{table}/instantiationCsn

Manage the instantiation CSN for filtering.

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.
database: string

Minimum Length: 1

Maximum Length: 130

Database name.
schema: string

Minimum Length: 1

Maximum Length: 130

Schema name in the database.
table: string

Minimum Length: 1

Maximum Length: 130

Table name in the database.
version: string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Root Schema : Oracle GoldenGate Instantiation CSN

Title: Oracle GoldenGate Instantiation CSN

Match One

Show Source

object Oracle GoldenGate Instantiation CSN-x-oneOf[0]
object Oracle GoldenGate Instantiation CSN-x-oneOf[1]

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:instantiationCsn"
                    ]
                },
                "command":{
                    "enum":[
                        "clear"
                    ]
                },
                "source":{
                    "description":"Source database name",
                    "type":"string",
                    "minLength":1,
                    "maxLength":4096
                }
            },
            "required":[
                "command",
                "source"
            ],
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:instantiationCsn"
                    ]
                },
                "command":{
                    "enum":[
                        "set"
                    ]
                },
                "csn":{
                    "x-oneOf":[
                        {
                            "description":"Normal format",
                            "type":"integer",
                            "minimum":0,
                            "maximum":9.223372036854776E18
                        },
                        {
                            "description":"Alternate format",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":3,
                            "maxLength":64
                        }
                    ]
                },
                "source":{
                    "description":"Source database name",
                    "type":"string",
                    "minLength":1,
                    "maxLength":4096
                }
            },
            "required":[
                "command",
                "csn",
                "source"
            ],
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Instantiation CSN"
}

Nested Schema : Oracle GoldenGate Instantiation CSN-x-oneOf[0]

Type: object

Show Source

$schema(optional):

Allowed Values: [ "ogg:instantiationCsn" ]
command:

Allowed Values: [ "clear" ]
source: string

Minimum Length: 1

Maximum Length: 4096

Source database name

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:instantiationCsn"
            ]
        },
        "command":{
            "enum":[
                "clear"
            ]
        },
        "source":{
            "description":"Source database name",
            "type":"string",
            "minLength":1,
            "maxLength":4096
        }
    },
    "required":[
        "command",
        "source"
    ],
    "additionalProperties":false
}

Nested Schema : Oracle GoldenGate Instantiation CSN-x-oneOf[1]

Type: object

Show Source

$schema(optional):

Allowed Values: [ "ogg:instantiationCsn" ]
command:

Allowed Values: [ "set" ]
csn: csn
source: string

Minimum Length: 1

Maximum Length: 4096

Source database name

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:instantiationCsn"
            ]
        },
        "command":{
            "enum":[
                "set"
            ]
        },
        "csn":{
            "x-oneOf":[
                {
                    "description":"Normal format",
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                {
                    "description":"Alternate format",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":3,
                    "maxLength":64
                }
            ]
        },
        "source":{
            "description":"Source database name",
            "type":"string",
            "minLength":1,
            "maxLength":4096
        }
    },
    "required":[
        "command",
        "csn",
        "source"
    ],
    "additionalProperties":false
}

Nested Schema : csn

Match One

Show Source

integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Normal format
string

Minimum Length: 3

Maximum Length: 64

Pattern: [0-9]+[.][0-9]+

Alternate format

{
    "x-oneOf":[
        {
            "description":"Normal format",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        {
            "description":"Alternate format",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":3,
            "maxLength":64
        }
    ]
}

Example Request (application/json)

{
    "command":"clear",
    "source":"source.table"
}

Response

Supported Media Types

application/json

201 Response

The instantiation CSN request completed 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/databases/ORCL/OGGADMIN/TABLE01/instantiationCsn",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/databases/ORCL/OGGADMIN/TABLE01/instantiationCsn",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-10464",
            "issued":"2019-03-15T14:43:23Z",
            "severity":"INFO",
            "title":"Instantiation CSN has been cleared successfully.",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-10464"
        }
    ]
}