Retrieve Request Status
get
/services/{version}/requests/{request}
Retrieve the background request status.
Request
Path Parameters
-
request: integer
Identifier for background request.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
The request status was retrieved successfully.
Root Schema : Oracle GoldenGate Asynchronous Request
Type:
object
Title:
Oracle GoldenGate Asynchronous Request
Resource describes a REST API request executing asynchronously
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:request" ]
-
completed(optional):
boolean
Whether the request is completed or not
-
endTime(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])$
Time when the request finished -
progress:
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' -
requestStatus(optional):
number
HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed.
-
startTime(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])$
Time when the request started
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/requests/425988401/result",
"mediaType":"application/json",
"rel":"related"
},
{
"href":"http://localhost:11001/services/v2/requests/425988401",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/requests/425988401",
"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":"2021-07-13T16:36:54.967+00:00",
"progress":"succeeded",
"requestStatus":200,
"startTime":"2021-07-13T16:36:54.965+00:00"
}
}