REST API for Fusion Cloud Transportation and Global Trade Management Data Export

Create Export Request

post

/exportRequests

Request

Header Parameters

Prefer: string

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/configOptionsType"
        },
        {
            "type":"object",
            "properties":{
                "schema":{
                    "description":"Used to specify the database schema which owns the tables to be extracted. Defaults to PRIMARY.",
                    "type":"string"
                },
                "excludePublic":{
                    "description":"If true, PUBLIC data will not be included in exported content. Defaults to true.",
                    "type":"boolean"
                },
                "targetSystem":{
                    "description":"Specifies where content should be sent.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/targetSystemType"
                        }
                    ]
                },
                "contentType":{
                    "description":"Specifies media type for the content. Defaults to text/plain (currently only text/plain is supported).",
                    "type":"string"
                },
                "externalRef":{
                    "description":"Specifies an external reference that can be used to correlate requests.",
                    "type":"string"
                },
                "rangeAfter":{
                    "description":"Only include records that were inserted or updated after this date/time.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/dateTimeType"
                        }
                    ]
                },
                "rangeBefore":{
                    "description":"Only include records that were inserted or updated before this date/time.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/dateTimeType"
                        }
                    ]
                },
                "objects":{
                    "description":"Describes content to be exported based on individally declared object names.",
                    "allOf":[
                        {
                            "type":"object",
                            "properties":{
                                "resourceName":{
                                    "description":"Name of resource to provide export records.",
                                    "type":"string"
                                },
                                "partSize":{
                                    "description":"Specifies a limit to the number of records included in one physical message part.",
                                    "type":"integer"
                                },
                                "offset":{
                                    "description":"Used if multiple requests are needed which can occur if row limits are exceeded.",
                                    "type":"integer"
                                },
                                "filterCriteria":{
                                    "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
                                    "type":"object",
                                    "properties":{
                                        "copiedFrom":{
                                            "description":"Saved Query GID to be executed to identify primary keys of target records.",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    ]
                },
                "tables":{
                    "description":"Describes content to be exported based on individally declared table names.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/requestItemType"
                        },
                        {
                            "type":"object",
                            "properties":{
                                "schema":{
                                    "description":"Used to specify the database schema which owns the table to be extracted. Defaults to schema specified at root level or PRIMARY.",
                                    "type":"string"
                                },
                                "tableName":{
                                    "description":"Name of table to provide export records.",
                                    "type":"string"
                                },
                                "selectList":{
                                    "description":"Comma-separated list of columns to override all columns if not specified.",
                                    "type":"string"
                                },
                                "filterCriteria":{
                                    "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
                                    "type":"object",
                                    "properties":{
                                        "copiedFrom":{
                                            "description":"Saved Query GID to be executed to identify primary keys of target records.",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    ]
                },
                "deletes":{
                    "description":"Used to export the list of primary keys deleted from a table within in a given time period.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/requestItemType"
                        },
                        {
                            "type":"object",
                            "properties":{
                                "schema":{
                                    "description":"Used to specify the database schema which owns the table to be extracted. Currently only PRIMARY is supported.",
                                    "type":"string"
                                },
                                "tableName":{
                                    "description":"Name of table.",
                                    "type":"string"
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

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'

{
    "description":"Specifies various configuration options that control the output of data replication content.",
    "properties":{
        "contentCompression":{
            "description":"Specifies if content should be compressed. Supported options are zip and gzip. Default is 'gzip'.",
            "type":"string"
        },
        "contentDigest":{
            "description":"Specifies algorithm to be used to calculate the checksum for each part. Only 'md5' is supported.",
            "type":"string"
        },
        "contentDateTimeFormat":{
            "description":"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",
            "type":"string"
        },
        "contentDateFormat":{
            "description":"Specifies how dates should be formatted in output content. Valid patterns are defined by java.time.format.DataTimeFormatter. Defaults to ISO_LOCAL_DATE",
            "type":"string"
        },
        "contentTimeZone":{
            "description":"Specifies time zone for date/times. Valid names are defined by java.time.ZoneId. Defaults to 'UTC'",
            "type":"string"
        },
        "contentSendEmptyFile":{
            "description":"Specifies if an empty file should be sent if no records match query criteria. Default is false.",
            "type":"boolean"
        },
        "contentFilePrefix":{
            "description":"Specifies prefix to be pre-pended to filenames. Default is 'DATA_'.",
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "schema":{
            "description":"Used to specify the database schema which owns the tables to be extracted. Defaults to PRIMARY.",
            "type":"string"
        },
        "excludePublic":{
            "description":"If true, PUBLIC data will not be included in exported content. Defaults to true.",
            "type":"boolean"
        },
        "targetSystem":{
            "description":"Specifies where content should be sent.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/targetSystemType"
                }
            ]
        },
        "contentType":{
            "description":"Specifies media type for the content. Defaults to text/plain (currently only text/plain is supported).",
            "type":"string"
        },
        "externalRef":{
            "description":"Specifies an external reference that can be used to correlate requests.",
            "type":"string"
        },
        "rangeAfter":{
            "description":"Only include records that were inserted or updated after this date/time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "rangeBefore":{
            "description":"Only include records that were inserted or updated before this date/time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "objects":{
            "description":"Describes content to be exported based on individally declared object names.",
            "allOf":[
                {
                    "type":"object",
                    "properties":{
                        "resourceName":{
                            "description":"Name of resource to provide export records.",
                            "type":"string"
                        },
                        "partSize":{
                            "description":"Specifies a limit to the number of records included in one physical message part.",
                            "type":"integer"
                        },
                        "offset":{
                            "description":"Used if multiple requests are needed which can occur if row limits are exceeded.",
                            "type":"integer"
                        },
                        "filterCriteria":{
                            "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
                            "type":"object",
                            "properties":{
                                "copiedFrom":{
                                    "description":"Saved Query GID to be executed to identify primary keys of target records.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            ]
        },
        "tables":{
            "description":"Describes content to be exported based on individally declared table names.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/requestItemType"
                },
                {
                    "type":"object",
                    "properties":{
                        "schema":{
                            "description":"Used to specify the database schema which owns the table to be extracted. Defaults to schema specified at root level or PRIMARY.",
                            "type":"string"
                        },
                        "tableName":{
                            "description":"Name of table to provide export records.",
                            "type":"string"
                        },
                        "selectList":{
                            "description":"Comma-separated list of columns to override all columns if not specified.",
                            "type":"string"
                        },
                        "filterCriteria":{
                            "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
                            "type":"object",
                            "properties":{
                                "copiedFrom":{
                                    "description":"Saved Query GID to be executed to identify primary keys of target records.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            ]
        },
        "deletes":{
            "description":"Used to export the list of primary keys deleted from a table within in a given time period.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/requestItemType"
                },
                {
                    "type":"object",
                    "properties":{
                        "schema":{
                            "description":"Used to specify the database schema which owns the table to be extracted. Currently only PRIMARY is supported.",
                            "type":"string"
                        },
                        "tableName":{
                            "description":"Name of table.",
                            "type":"string"
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : deletes

Used to export the list of primary keys deleted from a table within in a given time period.

Match All

Used to export the list of primary keys deleted from a table within in a given time period.

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

{
    "description":"Used to export the list of primary keys deleted from a table within in a given time period.",
    "allOf":[
        {
            "$ref":"#/components/schemas/requestItemType"
        },
        {
            "type":"object",
            "properties":{
                "schema":{
                    "description":"Used to specify the database schema which owns the table to be extracted. Currently only PRIMARY is supported.",
                    "type":"string"
                },
                "tableName":{
                    "description":"Name of table.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : objects

Describes content to be exported based on individally declared object names.

Match All

Describes content to be exported based on individally declared object names.

Show Source

object type

{
    "description":"Describes content to be exported based on individally declared object names.",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "resourceName":{
                    "description":"Name of resource to provide export records.",
                    "type":"string"
                },
                "partSize":{
                    "description":"Specifies a limit to the number of records included in one physical message part.",
                    "type":"integer"
                },
                "offset":{
                    "description":"Used if multiple requests are needed which can occur if row limits are exceeded.",
                    "type":"integer"
                },
                "filterCriteria":{
                    "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
                    "type":"object",
                    "properties":{
                        "copiedFrom":{
                            "description":"Saved Query GID to be executed to identify primary keys of target records.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : rangeAfter

Only include records that were inserted or updated after this date/time.

Match All

Only include records that were inserted or updated after this date/time.

Show Source

object dateTimeType

{
    "description":"Only include records that were inserted or updated after this date/time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : rangeBefore

Only include records that were inserted or updated before this date/time.

Match All

Only include records that were inserted or updated before this date/time.

Show Source

object dateTimeType

{
    "description":"Only include records that were inserted or updated before this date/time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : tables

Describes content to be exported based on individally declared table names.

Match All

Describes content to be exported based on individally declared table names.

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

{
    "description":"Describes content to be exported based on individally declared table names.",
    "allOf":[
        {
            "$ref":"#/components/schemas/requestItemType"
        },
        {
            "type":"object",
            "properties":{
                "schema":{
                    "description":"Used to specify the database schema which owns the table to be extracted. Defaults to schema specified at root level or PRIMARY.",
                    "type":"string"
                },
                "tableName":{
                    "description":"Name of table to provide export records.",
                    "type":"string"
                },
                "selectList":{
                    "description":"Comma-separated list of columns to override all columns if not specified.",
                    "type":"string"
                },
                "filterCriteria":{
                    "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
                    "type":"object",
                    "properties":{
                        "copiedFrom":{
                            "description":"Saved Query GID to be executed to identify primary keys of target records.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : targetSystem

Specifies where content should be sent.

Match All

Specifies where content should be sent.

Show Source

object targetSystemType

Specifies target system details for destination of data replication content.

{
    "description":"Specifies where content should be sent.",
    "allOf":[
        {
            "$ref":"#/components/schemas/targetSystemType"
        }
    ]
}

Nested Schema : requestItemType

Describes properties common to all item types. Many will override the corresponding value at the request level, if present.

Match All

Describes properties common to all item types. Many will override the corresponding value at the request level, if present.

Show Source

object configOptionsType

Specifies various configuration options that control the output of data replication content.
object requestItemType-allOf[1]

{
    "description":"Describes properties common to all item types. Many will override the corresponding value at the request level, if present.",
    "allOf":[
        {
            "$ref":"#/components/schemas/configOptionsType"
        },
        {
            "type":"object",
            "properties":{
                "excludePublic":{
                    "description":"If true, PUBLIC data will not be included in exported content. Defaults to true.",
                    "type":"boolean"
                },
                "targetSystem":{
                    "description":"Specifies where content should be sent.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/targetSystemType"
                        }
                    ]
                },
                "externalRef":{
                    "description":"Specifies an external reference that can be used to correlate request items.",
                    "type":"string"
                },
                "rangeAfter":{
                    "description":"Only include records that were inserted or updated after this date/time.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/dateTimeType"
                        }
                    ]
                },
                "rangeBefore":{
                    "description":"Only include records that were inserted or updated before this date/time.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/dateTimeType"
                        }
                    ]
                },
                "partSize":{
                    "description":"Specifies a limit to the number of records included in one physical message part.",
                    "type":"integer"
                },
                "offset":{
                    "description":"Used if multiple requests are needed which can occur if row limits are exceeded.",
                    "type":"integer"
                }
            }
        }
    ]
}

Nested Schema : requestItemType-allOf[1]

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "excludePublic":{
            "description":"If true, PUBLIC data will not be included in exported content. Defaults to true.",
            "type":"boolean"
        },
        "targetSystem":{
            "description":"Specifies where content should be sent.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/targetSystemType"
                }
            ]
        },
        "externalRef":{
            "description":"Specifies an external reference that can be used to correlate request items.",
            "type":"string"
        },
        "rangeAfter":{
            "description":"Only include records that were inserted or updated after this date/time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "rangeBefore":{
            "description":"Only include records that were inserted or updated before this date/time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "partSize":{
            "description":"Specifies a limit to the number of records included in one physical message part.",
            "type":"integer"
        },
        "offset":{
            "description":"Used if multiple requests are needed which can occur if row limits are exceeded.",
            "type":"integer"
        }
    }
}

Nested Schema : type

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "schema":{
            "description":"Used to specify the database schema which owns the table to be extracted. Currently only PRIMARY is supported.",
            "type":"string"
        },
        "tableName":{
            "description":"Name of table.",
            "type":"string"
        }
    }
}

Nested Schema : rangeAfter

Only include records that were inserted or updated after this date/time.

Match All

Only include records that were inserted or updated after this date/time.

Show Source

object dateTimeType

{
    "description":"Only include records that were inserted or updated after this date/time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : rangeBefore

Only include records that were inserted or updated before this date/time.

Match All

Only include records that were inserted or updated before this date/time.

Show Source

object dateTimeType

{
    "description":"Only include records that were inserted or updated before this date/time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : targetSystem

Specifies where content should be sent.

Match All

Specifies where content should be sent.

Show Source

object targetSystemType

Specifies target system details for destination of data replication content.

{
    "description":"Specifies where content should be sent.",
    "allOf":[
        {
            "$ref":"#/components/schemas/targetSystemType"
        }
    ]
}

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

{
    "description":"Specifies target system details for destination of data replication content.",
    "properties":{
        "targetURL":{
            "description":"Specifies target system URL e.g. Object Storage PAR.",
            "type":"string"
        },
        "httpMethod":{
            "description":"Specifies HTTP method to be used - POST, PUT etc. Defaults to POST",
            "type":"string"
        },
        "externalSystem":{
            "description":"Specifies External System GID where target details are configured.",
            "type":"string"
        },
        "comMethod":{
            "description":"Specifies transport method to be used to send content. Defaults to REST (currently only REST is supported).",
            "type":"string"
        },
        "path":{
            "description":"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.",
            "type":"string"
        },
        "appendName":{
            "description":"If true, the part name will be appended as an additional path element to the target system URL. Defaults to false.",
            "type":"boolean"
        }
    }
}

Nested Schema : type

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "resourceName":{
            "description":"Name of resource to provide export records.",
            "type":"string"
        },
        "partSize":{
            "description":"Specifies a limit to the number of records included in one physical message part.",
            "type":"integer"
        },
        "offset":{
            "description":"Used if multiple requests are needed which can occur if row limits are exceeded.",
            "type":"integer"
        },
        "filterCriteria":{
            "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
            "type":"object",
            "properties":{
                "copiedFrom":{
                    "description":"Saved Query GID to be executed to identify primary keys of target records.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
    "type":"object",
    "properties":{
        "copiedFrom":{
            "description":"Saved Query GID to be executed to identify primary keys of target records.",
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "schema":{
            "description":"Used to specify the database schema which owns the table to be extracted. Defaults to schema specified at root level or PRIMARY.",
            "type":"string"
        },
        "tableName":{
            "description":"Name of table to provide export records.",
            "type":"string"
        },
        "selectList":{
            "description":"Comma-separated list of columns to override all columns if not specified.",
            "type":"string"
        },
        "filterCriteria":{
            "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
            "type":"object",
            "properties":{
                "copiedFrom":{
                    "description":"Saved Query GID to be executed to identify primary keys of target records.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"Alternative criteria used to select records in preference to rangeAfter & rangeBefore.",
    "type":"object",
    "properties":{
        "copiedFrom":{
            "description":"Saved Query GID to be executed to identify primary keys of target records.",
            "type":"string"
        }
    }
}

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

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"
        }
    }
}

400 Response

Error in request

Root Schema : errorResponse

Type: object

Show Source

detail(required): string

Provides more information about the error.
status(required): number

HTTP status code.
title(required): string

Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}