Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Request Result

get

/services/{version}/requests/{request}/result

Required Role: User

Retrieve the background request result.

Request

Path Parameters

request(required): integer

Identifier for background request.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

The request result was retrieved successfully.

Root Schema : Oracle GoldenGate Asynchronous Result

Type: object

Title: Oracle GoldenGate Asynchronous Result

Resource contains the result of a request executing asynchronously

Show Source

$schema:

Allowed Values: [ "ogg:requestResult" ]
body: body

HTTP body of the response to the original async request
headers(required): array headers

Minimum Number of Items: 1

Maximum Number of Items: 128

List of the HTTP headers of the response to the original asynchronous request
status(required): object status

HTTP status line of the response to the original asynchronous request

{
    "title":"Oracle GoldenGate Asynchronous Result",
    "description":"Resource contains the result of a request executing asynchronously",
    "required":[
        "status",
        "headers"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:requestResult"
            ]
        },
        "status":{
            "type":"object",
            "description":"HTTP status line of the response to the original asynchronous request",
            "properties":{
                "code":{
                    "description":"HTTP response status code",
                    "type":"integer",
                    "minimum":"100",
                    "maximum":"599"
                },
                "reason":{
                    "description":"HTTP response reason phrase",
                    "type":"string",
                    "minLength":"2",
                    "maxLength":"32"
                }
            }
        },
        "headers":{
            "description":"List of the HTTP headers of the response to the original asynchronous request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"HTTP response header name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"128"
                    },
                    "value":{
                        "description":"HTTP response header value",
                        "type":"string",
                        "minLength":"0",
                        "maxLength":"4096"
                    }
                }
            },
            "minItems":"1",
            "maxItems":"128"
        },
        "body":{
            "description":" HTTP body of the response to the original async request",
            "x-anyOf":[
                {
                    "type":"object"
                },
                {
                    "type":"string",
                    "minLength":"0",
                    "maxLength":"131072"
                }
            ]
        }
    },
    "additionalProperties":false
}

Nested Schema : body

HTTP body of the response to the original async request

Match Any

Show Source

object body-x-anyOf[0]
string

Minimum Length: 0

Maximum Length: 131072

{
    "description":" HTTP body of the response to the original async request",
    "x-anyOf":[
        {
            "type":"object"
        },
        {
            "type":"string",
            "minLength":"0",
            "maxLength":"131072"
        }
    ]
}

Nested Schema : headers

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 128

List of the HTTP headers of the response to the original asynchronous request

Show Source

Array of: object items

{
    "description":"List of the HTTP headers of the response to the original asynchronous request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"HTTP response header name",
                "type":"string",
                "minLength":"1",
                "maxLength":"128"
            },
            "value":{
                "description":"HTTP response header value",
                "type":"string",
                "minLength":"0",
                "maxLength":"4096"
            }
        }
    },
    "minItems":"1",
    "maxItems":"128"
}

Nested Schema : status

Type: object

HTTP status line of the response to the original asynchronous request

Show Source

code: integer

Minimum Value: 100

Maximum Value: 599

HTTP response status code
reason: string

Minimum Length: 2

Maximum Length: 32

HTTP response reason phrase

{
    "type":"object",
    "description":"HTTP status line of the response to the original asynchronous request",
    "properties":{
        "code":{
            "description":"HTTP response status code",
            "type":"integer",
            "minimum":"100",
            "maximum":"599"
        },
        "reason":{
            "description":"HTTP response reason phrase",
            "type":"string",
            "minLength":"2",
            "maxLength":"32"
        }
    }
}

Nested Schema : body-x-anyOf[0]

Type: object

Nested Schema : items

Type: object

Show Source

name: string

Minimum Length: 1

Maximum Length: 128

HTTP response header name
value: string

Minimum Length: 0

Maximum Length: 4096

HTTP response header value

{
    "type":"object",
    "properties":{
        "name":{
            "description":"HTTP response header name",
            "type":"string",
            "minLength":"1",
            "maxLength":"128"
        },
        "value":{
            "description":"HTTP response header value",
            "type":"string",
            "minLength":"0",
            "maxLength":"4096"
        }
    }
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/requests/425988381/result",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/requests/425988381/result",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/result",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:requestResult",
        "body":{
            "$schema":"api:standardResponse",
            "links":[
                {
                    "href":"http://localhost:9012/services/v2/requests",
                    "mediaType":"application/json",
                    "rel":"canonical"
                },
                {
                    "href":"http://localhost:9012/services/v2/requests",
                    "mediaType":"application/json",
                    "rel":"self"
                },
                {
                    "href":"http://localhost:9012/services/v2/metadata-catalog/requests",
                    "mediaType":"application/schema+json",
                    "rel":"describedby"
                }
            ],
            "messages":[
            ],
            "response":{
                "$schema":"ogg:collection",
                "items":[
                    {
                        "$schema":"ogg:collectionItem",
                        "links":[
                            {
                                "href":"http://localhost:9012/services/v2/requests/425988381",
                                "mediaType":"application/json",
                                "rel":"canonical"
                            },
                            {
                                "href":"http://localhost:9012/services/v2/requests/425988381/result",
                                "mediaType":"application/json",
                                "rel":"related"
                            }
                        ],
                        "name":"425988381"
                    }
                ]
            }
        },
        "headers":[
            {
                "name":"Content-Type",
                "value":"application/json"
            },
            {
                "name":"Set-Cookie",
                "value":"ogg.sca.+zmVRp5uSsundqUzYMjBBg=yZDk5n6sj4u3MgZOl0p/TPSqqPUiH3YhhDeqccxiPDN8YLEHxn09Q+FWbjazdaEdiK/D3qmEKsgZ/VnMj8ABYwlYSJkSHeZsc4Yzb2bAWVT7cp6XupowugG3vQfhap/FYh/vIrtjT/bFWzeWn1wwnQHESbgQJhbxolovoLgZpGwVAlpqocEcofQ6hMeVpo1On+IlNPYOf0sIFt6CnGeM+YBSewdO4AJR8BfYpq88JPdq12Iif+FWri1zqGt72hQeLlEmMSUNyclg5I4SLR3JBB/x+JuXee9M8ZhesxFraaxibeitC9vZbdhV2ITy9XRq7ZqPdhOSod4fTAAMa3ZTR8g0jOBfUi7z+MHgN/9Vwt1CBF18CWmeAswwWIRDgtjw5b76qtg0ZVbi1LmPddWcDYeC1zAk3V0P4anet1mAqzOysE9ifdu0tSSqtdOwzFhAjqGxlbB4J7Q+rv7kSSftedQjT3WumdZzma3RbtXjPyOUFrArDytf8kR/fmk3hcCVt6M8aCs83DVbTZPYQyWKY5rRVk7f9qJ+qZ9HFrsR/pGPxSmyq6dGkb+EuOTCGz1EMoKumTndqhinmaf15r4pq6vYPiXt+up9pMqgtzlqENcMYjSbUW6zO9aGv/4h0pLg43mXbP1TMl3W/k5oRTOuKqQsr9InFVYIh4PfbT9nFyPr4qavg8/DL4gqRw==.p0Kg0ECv9dhz1WDEXcmNK0dYSjo82F8qI/RWPdG4rao=.lpRIOU8yjupoIQdQaqnzcUw3hUVcQljpfeBHkF4YWYs=; Domain=localhost; Path=/; HttpOnly; SameSite=strict"
            }
        ],
        "status":{
            "code":"200",
            "reason":"OK"
        }
    }
}