Retrieve Request Status

get

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

Retrieve the background request status.

Request

Path Parameters

Response

Supported Media Types

200 Response

The request status was retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Asynchronous Request
Type: object
Title: Oracle GoldenGate Asynchronous Request
Resource describes a REST API request executing asynchronously
Show Source
  • Allowed Values: [ "ogg:request" ]
  • Whether the request is completed or not
  • 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])$
    Time when the request finished
  • Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused" ]
    The current progress of the request. These values indicate that the request has finished: 'succeeded', 'failed', 'aborted'. The values that indicate the request is in process are: 'pending', 'processing', 'paused'
  • HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed.
  • 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])$
    Time when the request started
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/requests/425988381/result",
            "mediaType":"application/json",
            "rel":"related"
        },
        {
            "href":"http://localhost:11001/services/v2/requests/425988381",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/requests/425988381",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/request",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:request",
        "completed":true,
        "endTime":"2017-12-14T12:41:56.950+00:00",
        "progress":"succeeded",
        "requestStatus":200,
        "startTime":"2017-12-14T12:41:56.948+00:00"
    }
}