Jump to

• Request
• Response

Update Backend

patch

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

Required Role: Security

Update the Configuration Service Backend with one or more JSON Patch operations.

Request

Supported Media Types

• application/json

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

Body ()

Root Schema : JavaScript Object Notation (JSON) Patch - RFC 6902

Type: object

Title: JavaScript Object Notation (JSON) Patch - RFC 6902

A structure for expressing a sequence of operations to apply to a JSON document

Show Source

• $schema:
  Allowed Values: [ "type:jsonPatch" ]
• patches(required): array patches
  Minimum Number of Items: 1

  Maximum Number of Items: 32767

{
    "title":"JavaScript Object Notation (JSON) Patch - RFC 6902",
    "description":"A structure for expressing a sequence of operations to apply to a JSON document",
    "required":[
        "patches"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "type:jsonPatch"
            ]
        },
        "patches":{
            "type":"array",
            "items":{
                "x-oneOf":[
                    {
                        "type":"object",
                        "properties":{
                            "op":{
                                "description":"The operation to perform",
                                "enum":[
                                    "add",
                                    "replace",
                                    "test"
                                ]
                            },
                            "path":{
                                "description":"A JSON Pointer path",
                                "type":"string",
                                "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                                "minLength":2,
                                "maxLength":255
                            },
                            "value":{
                                "description":"The value to add, replace, or test"
                            }
                        },
                        "required":[
                            "op",
                            "path"
                        ]
                    },
                    {
                        "type":"object",
                        "properties":{
                            "op":{
                                "description":"The operation to perform",
                                "enum":[
                                    "move",
                                    "copy"
                                ]
                            },
                            "from":{
                                "description":"A JSON Pointer path",
                                "type":"string",
                                "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                                "minLength":2,
                                "maxLength":255
                            },
                            "path":{
                                "description":"A JSON Pointer path",
                                "type":"string",
                                "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                                "minLength":2,
                                "maxLength":255
                            }
                        },
                        "required":[
                            "op",
                            "from",
                            "path"
                        ]
                    },
                    {
                        "type":"object",
                        "properties":{
                            "op":{
                                "description":"The operation to perform",
                                "enum":[
                                    "remove"
                                ]
                            },
                            "path":{
                                "description":"A JSON Pointer path",
                                "type":"string",
                                "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                                "minLength":2,
                                "maxLength":255
                            }
                        },
                        "required":[
                            "op",
                            "path"
                        ]
                    }
                ]
            },
            "minItems":1,
            "maxItems":32767
        }
    },
    "additionalProperties":false
}

Nested Schema : patches

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 32767

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "x-oneOf":[
            {
                "type":"object",
                "properties":{
                    "op":{
                        "description":"The operation to perform",
                        "enum":[
                            "add",
                            "replace",
                            "test"
                        ]
                    },
                    "path":{
                        "description":"A JSON Pointer path",
                        "type":"string",
                        "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                        "minLength":2,
                        "maxLength":255
                    },
                    "value":{
                        "description":"The value to add, replace, or test"
                    }
                },
                "required":[
                    "op",
                    "path"
                ]
            },
            {
                "type":"object",
                "properties":{
                    "op":{
                        "description":"The operation to perform",
                        "enum":[
                            "move",
                            "copy"
                        ]
                    },
                    "from":{
                        "description":"A JSON Pointer path",
                        "type":"string",
                        "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                        "minLength":2,
                        "maxLength":255
                    },
                    "path":{
                        "description":"A JSON Pointer path",
                        "type":"string",
                        "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                        "minLength":2,
                        "maxLength":255
                    }
                },
                "required":[
                    "op",
                    "from",
                    "path"
                ]
            },
            {
                "type":"object",
                "properties":{
                    "op":{
                        "description":"The operation to perform",
                        "enum":[
                            "remove"
                        ]
                    },
                    "path":{
                        "description":"A JSON Pointer path",
                        "type":"string",
                        "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                        "minLength":2,
                        "maxLength":255
                    }
                },
                "required":[
                    "op",
                    "path"
                ]
            }
        ]
    },
    "minItems":1,
    "maxItems":32767
}

Nested Schema : items

Match One

Show Source

• object items-x-oneOf[0]
• object items-x-oneOf[1]
• object items-x-oneOf[2]

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "op":{
                    "description":"The operation to perform",
                    "enum":[
                        "add",
                        "replace",
                        "test"
                    ]
                },
                "path":{
                    "description":"A JSON Pointer path",
                    "type":"string",
                    "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                    "minLength":2,
                    "maxLength":255
                },
                "value":{
                    "description":"The value to add, replace, or test"
                }
            },
            "required":[
                "op",
                "path"
            ]
        },
        {
            "type":"object",
            "properties":{
                "op":{
                    "description":"The operation to perform",
                    "enum":[
                        "move",
                        "copy"
                    ]
                },
                "from":{
                    "description":"A JSON Pointer path",
                    "type":"string",
                    "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                    "minLength":2,
                    "maxLength":255
                },
                "path":{
                    "description":"A JSON Pointer path",
                    "type":"string",
                    "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                    "minLength":2,
                    "maxLength":255
                }
            },
            "required":[
                "op",
                "from",
                "path"
            ]
        },
        {
            "type":"object",
            "properties":{
                "op":{
                    "description":"The operation to perform",
                    "enum":[
                        "remove"
                    ]
                },
                "path":{
                    "description":"A JSON Pointer path",
                    "type":"string",
                    "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
                    "minLength":2,
                    "maxLength":255
                }
            },
            "required":[
                "op",
                "path"
            ]
        }
    ]
}

Nested Schema : items-x-oneOf[0]

Type: object

Show Source

• op(required):
  Allowed Values: [ "add", "replace", "test" ]

  The operation to perform
• path(required): string
  Minimum Length: 2

  Maximum Length: 255

  Pattern: ^([/][a-zA-Z0-9]+)+([/][-])?$

  A JSON Pointer path
• value:
  The value to add, replace, or test

{
    "type":"object",
    "properties":{
        "op":{
            "description":"The operation to perform",
            "enum":[
                "add",
                "replace",
                "test"
            ]
        },
        "path":{
            "description":"A JSON Pointer path",
            "type":"string",
            "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
            "minLength":2,
            "maxLength":255
        },
        "value":{
            "description":"The value to add, replace, or test"
        }
    },
    "required":[
        "op",
        "path"
    ]
}

Nested Schema : items-x-oneOf[1]

Type: object

Show Source

• from(required): string
  Minimum Length: 2

  Maximum Length: 255

  Pattern: ^([/][a-zA-Z0-9]+)+([/][-])?$

  A JSON Pointer path
• op(required):
  Allowed Values: [ "move", "copy" ]

  The operation to perform
• path(required): string
  Minimum Length: 2

  Maximum Length: 255

  Pattern: ^([/][a-zA-Z0-9]+)+([/][-])?$

  A JSON Pointer path

{
    "type":"object",
    "properties":{
        "op":{
            "description":"The operation to perform",
            "enum":[
                "move",
                "copy"
            ]
        },
        "from":{
            "description":"A JSON Pointer path",
            "type":"string",
            "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
            "minLength":2,
            "maxLength":255
        },
        "path":{
            "description":"A JSON Pointer path",
            "type":"string",
            "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
            "minLength":2,
            "maxLength":255
        }
    },
    "required":[
        "op",
        "from",
        "path"
    ]
}

Nested Schema : items-x-oneOf[2]

Type: object

Show Source

• op(required):
  Allowed Values: [ "remove" ]

  The operation to perform
• path(required): string
  Minimum Length: 2

  Maximum Length: 255

  Pattern: ^([/][a-zA-Z0-9]+)+([/][-])?$

  A JSON Pointer path

{
    "type":"object",
    "properties":{
        "op":{
            "description":"The operation to perform",
            "enum":[
                "remove"
            ]
        },
        "path":{
            "description":"A JSON Pointer path",
            "type":"string",
            "pattern":"^([/][a-zA-Z0-9]+)+([/][-])?$",
            "minLength":2,
            "maxLength":255
        }
    },
    "required":[
        "op",
        "path"
    ]
}

Example Request (application/json)

{
    "$schema":"type:jsonPatch",
    "patches":[
        {
            "op":"replace",
            "path":"/name",
            "value":"In-Memory"
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Backend updated

Body ()

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":[
    ],
    "response":{
        "$schema":"config:backend",
        "id":"24d9565c-3f4d-49ea-9b1e-61df05c368c3",
        "name":"In-Memory",
        "type":"Memory"
    }
}

Back to Top