Get Export Status
get
/exportStatuses/{requestID}
Request
Path Parameters
-
requestID(required): string
Export Request ID
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Export Status Response.
Root Schema : exportStatuses
Extended standard status message with additional Data Replication status data.
Match All
Show Source
Nested Schema : oraStatuses
Type:
Show Source
object
-
completed: boolean
Indicates the completion status of the message.
-
context: string
Context information specific to the type of request.
-
endTime:
endTime
Time at which the transaction ended.
-
links: array
links
-
progress: string
Allowed Values:
[ "processing", "pending", "failed", "interrupted", "succeeded", "cancelling", "cancelled", "unknown" ]
Indicates the completion status. -
startTime:
startTime
Time at which the transaction starts.
Nested Schema : exportStatuses-allOf[1]
Type:
Show Source
object
-
result: object
result
Specifies the full request status.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : body
Type:
Show Source
object
-
externalRef: string
External reference passed in request message. Can be used to correlate the request.
-
requestID: string
Export Request ID
-
submitDate:
submitDate
Date/Time at which the request was submitted.
-
tables:
tables
Nested Schema : items
Type:
Show Source
array
-
Array of:
object exportStatusItemType
Specifies the status of an individual request item.
Nested Schema : exportStatusItemType
Type:
object
Specifies the status of an individual request item.
Show Source
-
externalRef: string
External reference passed in request item. Can be used to correlate the request item.
-
itemID: string
The unique request item ID within this request.
-
itemName: string
Name of table providing the content for this item.
-
offset: integer
(int32)
Specifies the offset within a result set from which to start replicating content. Defaults to 0.
-
parts:
parts
Information for each part within the item.
-
partSize: integer
(int32)
Specifies any limit applied to the number of records to be included within any part for this item.
-
progress: string
Allowed Values:
[ "processing", "pending", "failed", "interrupted", "succeeded", "cancelling", "cancelled", "unknown" ]
Indicates the completion status. -
totalRecordCount: string
The total number of records in all parts for this item..
-
totalResults: string
The total number of records matching the filter criteria for this item.
Nested Schema : parts
Type:
object
Information for each part within the item.
Show Source
-
count: integer
(int32)
Total number of parts produced (so far if still in progress) for the item.
-
items: array
items
Nested Schema : items
Type:
Show Source
array
-
Array of:
object partType
Details for each part exported.
Nested Schema : partType
Type:
object
Details for each part exported.
Show Source
-
checksum: string
A hash of the file contents using the algorithm specified in the request. Defaults to MD5.
-
errorStatus: string
Error status from the external system if the transport of the exported file fails.
-
partName: string
The unique file name for the part. See online API documentation for naming standard.
-
recordCount: integer
(int32)
Total number of data rows contained in the part.
404 Response
Export Status Response not found.