Create Export Request
post
/exportRequests
Request
Header Parameters
-
Prefer:
Optional header parameter to process the request asynchronously
Supported Media Types
- application/json
Root Schema : schema
Match All
Show Source
-
object
configOptionsType
Specifies various configuration options that control the output of data replication content.
-
object
type
Nested Schema : configOptionsType
Type:
object
Specifies various configuration options that control the output of data replication content.
Show Source
-
contentCompression: string
Specifies if content should be compressed. Supported options are zip and gzip. Default is 'gzip'.
-
contentDateFormat: string
Specifies how dates should be formatted in output content. Valid patterns are defined by java.time.format.DataTimeFormatter. Defaults to ISO_LOCAL_DATE
-
contentDateTimeFormat: string
Specifies how date/times should be formatted in output content. Valid patterns are defined by java.time.format.DataTimeFormatter. Defaults to ISO_OFFSET_DATE_TIME
-
contentDigest: string
Specifies algorithm to be used to calculate the checksum for each part. Only 'md5' is supported.
-
contentFilePrefix: string
Specifies prefix to be pre-pended to filenames. Default is 'DATA_'.
-
contentSendEmptyFile: boolean
Specifies if an empty file should be sent if no records match query criteria. Default is false.
-
contentTimeZone: string
Specifies time zone for date/times. Valid names are defined by java.time.ZoneId. Defaults to 'UTC'
Nested Schema : type
Type:
Show Source
object
-
contentType: string
Specifies media type for the content. Defaults to text/plain (currently only text/plain is supported).
-
deletes:
deletes
Used to export the list of primary keys deleted from a table within in a given time period.
-
excludePublic: boolean
If true, PUBLIC data will not be included in exported content. Defaults to true.
-
externalRef: string
Specifies an external reference that can be used to correlate requests.
-
objects:
objects
Describes content to be exported based on individally declared object names.
-
rangeAfter:
rangeAfter
Only include records that were inserted or updated after this date/time.
-
rangeBefore:
rangeBefore
Only include records that were inserted or updated before this date/time.
-
schema: string
Used to specify the database schema which owns the tables to be extracted. Defaults to PRIMARY.
-
tables:
tables
Describes content to be exported based on individally declared table names.
-
targetSystem:
targetSystem
Specifies where content should be sent.
Nested Schema : deletes
Used to export the list of primary keys deleted from a table within in a given time period.
Match All
Show Source
-
allOf
requestItemType
Describes properties common to all item types. Many will override the corresponding value at the request level, if present.
-
object
type
Nested Schema : objects
Describes content to be exported based on individally declared object names.
Match All
Show Source
Nested Schema : rangeAfter
Only include records that were inserted or updated after this date/time.
Match All
Show Source
Nested Schema : rangeBefore
Only include records that were inserted or updated before this date/time.
Match All
Show Source
Nested Schema : tables
Describes content to be exported based on individally declared table names.
Match All
Show Source
-
allOf
requestItemType
Describes properties common to all item types. Many will override the corresponding value at the request level, if present.
-
object
type
Nested Schema : targetSystem
Specifies where content should be sent.
Match All
Show Source
-
object
targetSystemType
Specifies target system details for destination of data replication content.
Nested Schema : requestItemType
Describes properties common to all item types. Many will override the corresponding value at the request level, if present.
Match All
Show Source
-
object
configOptionsType
Specifies various configuration options that control the output of data replication content.
-
object
requestItemType-allOf[1]
Nested Schema : requestItemType-allOf[1]
Type:
Show Source
object
-
excludePublic: boolean
If true, PUBLIC data will not be included in exported content. Defaults to true.
-
externalRef: string
Specifies an external reference that can be used to correlate request items.
-
offset: integer
Used if multiple requests are needed which can occur if row limits are exceeded.
-
partSize: integer
Specifies a limit to the number of records included in one physical message part.
-
rangeAfter:
rangeAfter
Only include records that were inserted or updated after this date/time.
-
rangeBefore:
rangeBefore
Only include records that were inserted or updated before this date/time.
-
targetSystem:
targetSystem
Specifies where content should be sent.
Nested Schema : type
Type:
Show Source
object
-
schema: string
Used to specify the database schema which owns the table to be extracted. Currently only PRIMARY is supported.
-
tableName: string
Name of table.
Nested Schema : rangeAfter
Only include records that were inserted or updated after this date/time.
Match All
Show Source
Nested Schema : rangeBefore
Only include records that were inserted or updated before this date/time.
Match All
Show Source
Nested Schema : targetSystem
Specifies where content should be sent.
Match All
Show Source
-
object
targetSystemType
Specifies target system details for destination of data replication content.
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 : targetSystemType
Type:
object
Specifies target system details for destination of data replication content.
Show Source
-
appendName: boolean
If true, the part name will be appended as an additional path element to the target system URL. Defaults to false.
-
comMethod: string
Specifies transport method to be used to send content. Defaults to REST (currently only REST is supported).
-
externalSystem: string
Specifies External System GID where target details are configured.
-
httpMethod: string
Specifies HTTP method to be used - POST, PUT etc. Defaults to POST
-
path: string
Specifies any additional path element that should be appended to target system URL. Note: this would be before any additional part name is also appended.
-
targetURL: string
Specifies target system URL e.g. Object Storage PAR.
Nested Schema : type
Type:
Show Source
object
-
filterCriteria: object
filterCriteria
Alternative criteria used to select records in preference to rangeAfter & rangeBefore.
-
offset: integer
Used if multiple requests are needed which can occur if row limits are exceeded.
-
partSize: integer
Specifies a limit to the number of records included in one physical message part.
-
resourceName: string
Name of resource to provide export records.
Nested Schema : filterCriteria
Type:
object
Alternative criteria used to select records in preference to rangeAfter & rangeBefore.
Show Source
-
copiedFrom: string
Saved Query GID to be executed to identify primary keys of target records.
Nested Schema : type
Type:
Show Source
object
-
filterCriteria: object
filterCriteria
Alternative criteria used to select records in preference to rangeAfter & rangeBefore.
-
schema: string
Used to specify the database schema which owns the table to be extracted. Defaults to schema specified at root level or PRIMARY.
-
selectList: string
Comma-separated list of columns to override all columns if not specified.
-
tableName: string
Name of table to provide export records.
Nested Schema : filterCriteria
Type:
object
Alternative criteria used to select records in preference to rangeAfter & rangeBefore.
Show Source
-
copiedFrom: string
Saved Query GID to be executed to identify primary keys of target records.
Response
Supported Media Types
- application/json
- text/csv
- text/plain
200 Response
CSV content for synchronous request
202 Response
Status Response for asynchronous request.
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.
400 Response
Error in request
Root Schema : errorResponse
Type:
Show Source
object
-
detail(required): string
Provides more information about the error.
-
status(required): number
HTTP status code.
-
title(required): string
Provides a short summary message.