1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Common
  4. REST API Catalog

Retrieve API Versions

get

/services

Required Role: Any

Each Oracle GoldenGate service exposes one or more versions of the REST API for backward compatibility. Retrieve the collection of available API versions using this endpoint.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

The list of available API versions was retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Supported API versions
Type: object
Title: Oracle GoldenGate Supported API versions
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 8
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Messages issued during processing of the request
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : catalog
Type: object
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Messages issued during processing of the request
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • 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.
  • 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.
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • 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.
  • 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.
Example Response (application/json)
{
    "$schema":"api:versions",
    "items":[
        {
            "$schema":"api:version",
            "catalog":{
                "links":[
                    {
                        "href":"http://localhost:9012/services/v2/metadata-catalog",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ]
            },
            "isLatest":true,
            "lifecycle":"active",
            "version":"v2"
        }
    ],
    "links":[
        {
            "href":"http://localhost:9012/services/v2",
            "mediaType":"application/json",
            "rel":"current"
        },
        {
            "href":"http://localhost:9012/services",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services",
            "mediaType":"application/json",
            "rel":"self"
        }
    ]
}
Back to Top