Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Export Status Response.

Body ()

Root Schema : exportStatuses

Extended standard status message with additional Data Replication status data.

Match All

Extended standard status message with additional Data Replication status data.

Extended standard status message with additional Data Replication status data.

Show Source

• object oraStatuses
• object exportStatuses-allOf[1]

{
    "description":"Extended standard status message with additional Data Replication status data.",
    "allOf":[
        {
            "$ref":"#/components/schemas/oraStatuses"
        },
        {
            "type":"object",
            "properties":{
                "result":{
                    "description":"Specifies the full request status.",
                    "type":"object",
                    "properties":{
                        "body":{
                            "type":"object",
                            "properties":{
                                "requestID":{
                                    "description":"Export Request ID",
                                    "type":"string"
                                },
                                "submitDate":{
                                    "description":"Date/Time at which the request was submitted.",
                                    "allOf":[
                                        {
                                            "$ref":"#/components/schemas/dateTimeType"
                                        }
                                    ]
                                },
                                "externalRef":{
                                    "description":"External reference passed in request message. Can be used to correlate the request.",
                                    "type":"string"
                                },
                                "tables":{
                                    "properties":{
                                        "items":{
                                            "type":"array",
                                            "items":{
                                                "$ref":"#/components/schemas/exportStatusItemType"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : oraStatuses

Type: object

Show Source

• 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.

{
    "properties":{
        "progress":{
            "$ref":"#/components/schemas/progressType"
        },
        "startTime":{
            "description":"Time at which the transaction starts.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "completed":{
            "description":"Indicates the completion status of the message.",
            "type":"boolean"
        },
        "endTime":{
            "description":"Time at which the transaction ended.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "context":{
            "description":"Context information specific to the type of request.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    }
}

Nested Schema : exportStatuses-allOf[1]

Type: object

Show Source

• result: object result
  Specifies the full request status.

{
    "type":"object",
    "properties":{
        "result":{
            "description":"Specifies the full request status.",
            "type":"object",
            "properties":{
                "body":{
                    "type":"object",
                    "properties":{
                        "requestID":{
                            "description":"Export Request ID",
                            "type":"string"
                        },
                        "submitDate":{
                            "description":"Date/Time at which the request was submitted.",
                            "allOf":[
                                {
                                    "$ref":"#/components/schemas/dateTimeType"
                                }
                            ]
                        },
                        "externalRef":{
                            "description":"External reference passed in request message. Can be used to correlate the request.",
                            "type":"string"
                        },
                        "tables":{
                            "properties":{
                                "items":{
                                    "type":"array",
                                    "items":{
                                        "$ref":"#/components/schemas/exportStatusItemType"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : endTime

Time at which the transaction ended.

Match All

Time at which the transaction ended.

Show Source

• object dateTimeType

{
    "description":"Time at which the transaction ended.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : startTime

Time at which the transaction starts.

Match All

Time at which the transaction starts.

Show Source

• object dateTimeType

{
    "description":"Time at which the transaction starts.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : result

Type: object

Specifies the full request status.

Show Source

• body: object body

{
    "description":"Specifies the full request status.",
    "type":"object",
    "properties":{
        "body":{
            "type":"object",
            "properties":{
                "requestID":{
                    "description":"Export Request ID",
                    "type":"string"
                },
                "submitDate":{
                    "description":"Date/Time at which the request was submitted.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/dateTimeType"
                        }
                    ]
                },
                "externalRef":{
                    "description":"External reference passed in request message. Can be used to correlate the request.",
                    "type":"string"
                },
                "tables":{
                    "properties":{
                        "items":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/exportStatusItemType"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : body

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "requestID":{
            "description":"Export Request ID",
            "type":"string"
        },
        "submitDate":{
            "description":"Date/Time at which the request was submitted.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "externalRef":{
            "description":"External reference passed in request message. Can be used to correlate the request.",
            "type":"string"
        },
        "tables":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/exportStatusItemType"
                    }
                }
            }
        }
    }
}

Nested Schema : submitDate

Date/Time at which the request was submitted.

Match All

Date/Time at which the request was submitted.

Show Source

• object dateTimeType

{
    "description":"Date/Time at which the request was submitted.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : tables

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/exportStatusItemType"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object exportStatusItemType
  Specifies the status of an individual request item.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/exportStatusItemType"
    }
}

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.

{
    "description":"Specifies the status of an individual request item.",
    "properties":{
        "itemID":{
            "description":"The unique request item ID within this request.",
            "type":"string"
        },
        "itemName":{
            "description":"Name of table providing the content for this item.",
            "type":"string"
        },
        "externalRef":{
            "description":"External reference passed in request item. Can be used to correlate the request item.",
            "type":"string"
        },
        "progress":{
            "$ref":"#/components/schemas/progressType"
        },
        "totalResults":{
            "description":"The total number of records matching the filter criteria for this item.",
            "type":"string"
        },
        "offset":{
            "description":"Specifies the offset within a result set from which to start replicating content. Defaults to 0.",
            "type":"integer",
            "format":"int32"
        },
        "partSize":{
            "description":"Specifies any limit applied to the number of records to be included within any part for this item.",
            "type":"integer",
            "format":"int32"
        },
        "totalRecordCount":{
            "description":"The total number of records in all parts for this item..",
            "type":"string"
        },
        "parts":{
            "description":"Information for each part within the item.",
            "properties":{
                "count":{
                    "description":"Total number of parts produced (so far if still in progress) for the item.",
                    "type":"integer",
                    "format":"int32"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/partType"
                    }
                }
            }
        }
    }
}

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

{
    "description":"Information for each part within the item.",
    "properties":{
        "count":{
            "description":"Total number of parts produced (so far if still in progress) for the item.",
            "type":"integer",
            "format":"int32"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/partType"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object partType
  Details for each part exported.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/partType"
    }
}

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.

{
    "description":"Details for each part exported.",
    "properties":{
        "partName":{
            "description":"The unique file name for the part. See online API documentation for naming standard.",
            "type":"string"
        },
        "recordCount":{
            "description":"Total number of data rows contained in the part.",
            "type":"integer",
            "format":"int32"
        },
        "checksum":{
            "description":"A hash of the file contents using the algorithm specified in the request. Defaults to MD5.",
            "type":"string"
        },
        "errorStatus":{
            "description":"Error status from the external system if the transport of the exported file fails.",
            "type":"string"
        }
    }
}

404 Response

Export Status Response not found.

Back to Top