Jump to

• Request
• Response

Describe API Version

get

/services/{version}

Use this endpoint to obtain details of a specific version of an Oracle GoldenGate Service REST API.

Request

Path Parameters

• version: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

The API version details were retrieved successfully.

Body ()

Root Schema : Oracle GoldenGate RESTful API version

Type: object

Title: Oracle GoldenGate RESTful API version

Show Source

• $schema(optional):
  Allowed Values: [ "api:version" ]
• catalog: object catalog
• isLatest(optional): boolean
  Default Value: false
• lifecycle(optional):
  Default Value: active

  Allowed Values: [ "active", "deprecated" ]
• links(optional): array links
  Minimum Number of Items: 0

  Maximum Number of Items: 16
• messages(optional): array messages
  Minimum Number of Items: 0

  Maximum Number of Items: 65535

  Messages issued during processing of the request
• terminationDate(optional): 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])$
• version: string
  Minimum Length: 2

  Maximum Length: 5

  Pattern: v[0-9.]+

{
    "title":"Oracle GoldenGate RESTful API version",
    "required":[
        "version",
        "catalog"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "api:version"
            ]
        },
        "version":{
            "type":"string",
            "pattern":"v[0-9.]+",
            "minLength":2,
            "maxLength":5
        },
        "lifecycle":{
            "enum":[
                "active",
                "deprecated"
            ],
            "default":"active"
        },
        "isLatest":{
            "type":"boolean",
            "default":false
        },
        "terminationDate":{
            "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
        },
        "catalog":{
            "type":"object",
            "properties":{
                "links":{
                    "minItems":0,
                    "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
                    },
                    "maxItems":16
                }
            },
            "additionalProperties":false
        },
        "links":{
            "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
        },
        "messages":{
            "description":"Messages issued during processing of 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
        }
    },
    "additionalProperties":false
}

Nested Schema : catalog

Type: object

Show Source

• links(optional): array links
  Minimum Number of Items: 0

  Maximum Number of Items: 16

{
    "type":"object",
    "properties":{
        "links":{
            "minItems":0,
            "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
            },
            "maxItems":16
        }
    },
    "additionalProperties":false
}

Nested Schema : links

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 16

Show Source

• Array of: object items

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

Messages issued during processing of the request

Show Source

• Array of: object items

{
    "description":"Messages issued during processing of 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 : links

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 16

Show Source

• Array of: object items

{
    "minItems":0,
    "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
    },
    "maxItems":16
}

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: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:version",
    "catalog":{
        "links":[
            {
                "href":"http://localhost:11001/services/v2/metadata-catalog",
                "mediaType":"application/json",
                "rel":"canonical"
            }
        ]
    },
    "isLatest":true,
    "lifecycle":"active",
    "links":[
        {
            "href":"http://localhost:11001/services/v2",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "version":"v2"
}

Back to Top