Oracle GoldenGate Microservices REST APIs

Delete Backend

delete

/services/{version}/installation/configuration/backends/{backend}

Required Role: Security

The DELETE operation will remove the reference to the Backend identified by {backend}.

Request

Path Parameters

backend(required): string

Minimum Length: 36

Maximum Length: 36

Pattern: ^[0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}$

Identifier for a Configuration Service Backend.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Query Parameters

deleteData: string

Indicates whether or not the data managed by a backend is also deleted when the backend is deleted.

Response

Supported Media Types

application/json

200 Response

Configuration backend deleted 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:

Allowed Values: [ "api:standardResponse" ]
links(required): array links

Minimum Number of Items: 0

Maximum Number of Items: 16

Oracle GoldenGate links for the request
messages(required): array messages

Minimum Number of Items: 0

Maximum Number of Items: 65535

Oracle GoldenGate messages issued during the request
response: 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",
                            "ogg://service"
                        ]
                    },
                    "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",
                    "ogg://service"
                ]
            },
            "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:

Allowed Values: [ "ogg:link" ]
description: string

Minimum Length: 1

Maximum Length: 4095

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

Minimum Length: 2

Maximum Length: 4095

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

An absolute URI for the link
mediaType: 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(required):

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

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",
                "ogg://service"
            ]
        },
        "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:

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://localhost:9011/services/v2/installation/configuration/backends/24d9565c-3f4d-49ea-9b1e-61df05c368c3",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9011/services/v2/installation/configuration/backends/24d9565c-3f4d-49ea-9b1e-61df05c368c3",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-12010",
            "issued":"2024-04-03T22:37:04Z",
            "severity":"INFO",
            "title":"The requested service completed successfully but did not return a result.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        }
    ]
}