Jump to

• Request
• Response

dataImport

post

/ccadmin/v1/webhook/dataImport

The details of data import in the Oracle Commerce Cloud

Request

Supported Media Types

• application/json

Body ()

The details of the data import

Root Schema : dataImport_request

Type: object

The details of the data import

Show Source

• bundleItems(optional): array bundleItems
  The process item details for bundle mode
• failedAssociationsFileLink(optional): string
  The link url to failed records associationss file. This is an optional property and only available when running in ProductsV2 plugin mode
• failedRecordsFileLink(optional): string
  The link url to failed records file.
• metaLink(optional): string
  The meta link url to status file.
• processId(optional): string
  The process id of the data import job.
• standaloneItem(optional): object standaloneItem
  The process item details for standalone mode.

{
    "description":"The details of the data import",
    "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 imported",
                                "type":"integer"
                            },
                            "failureCount":{
                                "description":"Number of failed entities imported",
                                "type":"integer"
                            }
                        }
                    },
                    "fileName":{
                        "description":"The plugin import file",
                        "type":"string"
                    },
                    "format":{
                        "description":"The plugin format",
                        "type":"string"
                    },
                    "id":{
                        "description":"The unique id of the plugin",
                        "type":"string"
                    }
                }
            }
        },
        "processId":{
            "description":"The process id of the data import 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 imported",
                            "type":"integer"
                        },
                        "failureCount":{
                            "description":"Number of failed entities imported",
                            "type":"integer"
                        }
                    }
                },
                "format":{
                    "description":"The plugin format",
                    "type":"string"
                },
                "id":{
                    "description":"The unique id of the plugin",
                    "type":"string"
                }
            }
        },
        "failedRecordsFileLink":{
            "description":"The link url to failed records file.",
            "type":"string"
        },
        "metaLink":{
            "description":"The meta link url to status file.",
            "type":"string"
        },
        "failedAssociationsFileLink":{
            "description":"The link url to failed records associationss file. This is an optional property and only available when running in ProductsV2 plugin mode",
            "type":"string"
        }
    },
    "example":{
        "processId":"import_123",
        "standaloneItem":{
            "result":{
                "successCount":1,
                "failureCount":0
            },
            "format":"xml",
            "id":"test001"
        },
        "failedRecordsFileLink":"http://example.com/123456789/importFile.zip",
        "metaLink":"http://example.com/123456789/importStatus.zip",
        "failedAssociationsFileLink":"http://example.com/123456789/importFile.zip"
    }
}

Example:

{
    "processId":"import_123",
    "standaloneItem":{
        "result":{
            "successCount":1,
            "failureCount":0
        },
        "format":"xml",
        "id":"test001"
    },
    "failedRecordsFileLink":"http://example.com/123456789/importFile.zip",
    "metaLink":"http://example.com/123456789/importStatus.zip",
    "failedAssociationsFileLink":"http://example.com/123456789/importFile.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 imported",
                        "type":"integer"
                    },
                    "failureCount":{
                        "description":"Number of failed entities imported",
                        "type":"integer"
                    }
                }
            },
            "fileName":{
                "description":"The plugin import 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 imported",
                    "type":"integer"
                },
                "failureCount":{
                    "description":"Number of failed entities imported",
                    "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 import 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 imported",
                    "type":"integer"
                },
                "failureCount":{
                    "description":"Number of failed entities imported",
                    "type":"integer"
                }
            }
        },
        "fileName":{
            "description":"The plugin import 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 imported
• successCount(optional): integer
  Number of successful entities imported

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

Nested Schema : result

Type: object

Plugin results information.

Show Source

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

{
    "description":"Plugin results information.",
    "type":"object",
    "properties":{
        "successCount":{
            "description":"Number of successful entities imported",
            "type":"integer"
        },
        "failureCount":{
            "description":"Number of failed entities imported",
            "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