Jump to

• Request
• Response

dataExport

post

/ccadmin/v1/webhook/dataExport

The details of data export in the Oracle Commerce Cloud

Request

Supported Media Types

• application/json

Body ()

The details of the data export

Root Schema : dataExport_request

Type: object

The details of the data export

Show Source

• bundleItems(optional): array bundleItems
  The process item details for bundle mode
• fileLink(optional): string
  The file link url to exported file.
• metaLink(optional): string
  The meta link url to status file.
• processId(optional): string
  The process id of the data export job.
• standaloneItem(optional): object standaloneItem
  The process item details for standalone mode.

{
    "description":"The details of the data export",
    "properties":{
        "bundleItems":{
            "description":"The process item details for bundle mode",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "result":{
                        "description":"Plugin results information.",
                        "type":"object",
                        "properties":{
                            "successCount":{
                                "description":"Number of successful entities exported",
                                "type":"integer"
                            },
                            "failureCount":{
                                "description":"Number of failed entities exported",
                                "type":"integer"
                            }
                        }
                    },
                    "fileName":{
                        "description":"The plugin export file",
                        "type":"string"
                    },
                    "format":{
                        "description":"The plugin format",
                        "type":"string"
                    },
                    "id":{
                        "description":"The unique id of the plugin",
                        "type":"string"
                    }
                }
            }
        },
        "fileLink":{
            "description":"The file link url to exported file.",
            "type":"string"
        },
        "processId":{
            "description":"The process id of the data export job.",
            "type":"string"
        },
        "standaloneItem":{
            "description":"The process item details for standalone mode.",
            "type":"object",
            "properties":{
                "result":{
                    "description":"Plugin results information.",
                    "type":"object",
                    "properties":{
                        "successCount":{
                            "description":"Number of successful entities exported",
                            "type":"integer"
                        },
                        "failureCount":{
                            "description":"Number of failed entities exported",
                            "type":"integer"
                        }
                    }
                },
                "format":{
                    "description":"The plugin format",
                    "type":"string"
                },
                "id":{
                    "description":"The unique id of the plugin",
                    "type":"string"
                }
            }
        },
        "metaLink":{
            "description":"The meta link url to status file.",
            "type":"string"
        }
    },
    "example":{
        "fileLink":"http://example.com/123456789/exportResults.xml",
        "processId":"export_123",
        "standaloneItem":{
            "result":{
                "successCount":1,
                "failureCount":0
            },
            "format":"xml",
            "id":"test001"
        },
        "metaLink":"http://example.com/123456789/exportStatus.zip"
    }
}

Example:

{
    "fileLink":"http://example.com/123456789/exportResults.xml",
    "processId":"export_123",
    "standaloneItem":{
        "result":{
            "successCount":1,
            "failureCount":0
        },
        "format":"xml",
        "id":"test001"
    },
    "metaLink":"http://example.com/123456789/exportStatus.zip"
}

Nested Schema : bundleItems

Type: array

The process item details for bundle mode

Show Source

• Array of: object items

{
    "description":"The process item details for bundle mode",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "result":{
                "description":"Plugin results information.",
                "type":"object",
                "properties":{
                    "successCount":{
                        "description":"Number of successful entities exported",
                        "type":"integer"
                    },
                    "failureCount":{
                        "description":"Number of failed entities exported",
                        "type":"integer"
                    }
                }
            },
            "fileName":{
                "description":"The plugin export file",
                "type":"string"
            },
            "format":{
                "description":"The plugin format",
                "type":"string"
            },
            "id":{
                "description":"The unique id of the plugin",
                "type":"string"
            }
        }
    }
}

Nested Schema : standaloneItem

Type: object

The process item details for standalone mode.

Show Source

• format(optional): string
  The plugin format
• id(optional): string
  The unique id of the plugin
• result(optional): object result
  Plugin results information.

{
    "description":"The process item details for standalone mode.",
    "type":"object",
    "properties":{
        "result":{
            "description":"Plugin results information.",
            "type":"object",
            "properties":{
                "successCount":{
                    "description":"Number of successful entities exported",
                    "type":"integer"
                },
                "failureCount":{
                    "description":"Number of failed entities exported",
                    "type":"integer"
                }
            }
        },
        "format":{
            "description":"The plugin format",
            "type":"string"
        },
        "id":{
            "description":"The unique id of the plugin",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fileName(optional): string
  The plugin export file
• format(optional): string
  The plugin format
• id(optional): string
  The unique id of the plugin
• result(optional): object result
  Plugin results information.

{
    "type":"object",
    "properties":{
        "result":{
            "description":"Plugin results information.",
            "type":"object",
            "properties":{
                "successCount":{
                    "description":"Number of successful entities exported",
                    "type":"integer"
                },
                "failureCount":{
                    "description":"Number of failed entities exported",
                    "type":"integer"
                }
            }
        },
        "fileName":{
            "description":"The plugin export file",
            "type":"string"
        },
        "format":{
            "description":"The plugin format",
            "type":"string"
        },
        "id":{
            "description":"The unique id of the plugin",
            "type":"string"
        }
    }
}

Nested Schema : result

Type: object

Plugin results information.

Show Source

• failureCount(optional): integer
  Number of failed entities exported
• successCount(optional): integer
  Number of successful entities exported

{
    "description":"Plugin results information.",
    "type":"object",
    "properties":{
        "successCount":{
            "description":"Number of successful entities exported",
            "type":"integer"
        },
        "failureCount":{
            "description":"Number of failed entities exported",
            "type":"integer"
        }
    }
}

Nested Schema : result

Type: object

Plugin results information.

Show Source

• failureCount(optional): integer
  Number of failed entities exported
• successCount(optional): integer
  Number of successful entities exported

{
    "description":"Plugin results information.",
    "type":"object",
    "properties":{
        "successCount":{
            "description":"Number of successful entities exported",
            "type":"integer"
        },
        "failureCount":{
            "description":"Number of failed entities exported",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top