The following information shows how you can perform an import.
When you perform an import, you upload a file from an external system and then run the import endpoint from your REST API client.
Upload the file as a multipart/form-data using the POST method to initiate the upload:
Use the following endpoint to upload your import file:
POST /ccadmin/v1/filesImport the saved file by invoking the
importProcessendpoint. Make sure that file name matches the name of the saved file. The following is an example of an archive import:{
"fileName" : "profile.zip"
}The following example is of a standalone import. Note that only one file can be imported in standalone mode:
GET /ccadmin/v1/importProcess
{
"fileName": "product.json",
"mode" : "standalone",
"id" : "Products",
"format": "json"
}You can check the progress of the import using the process’ ID.
POST /ccadmin/v1/importProcess/{processId}
{
"fileName": "profile.zip"
}Once the import job is complete, the response of the import provides a link to download the import status.
{"metaLink": "http://localhost/import/status.zip"}Note that if there is a failure during import, the status file will include a failure count. For example:
{
"endTime" : 1587782346639,
"startTime" : 1587782346602,
"failureCount" : 1,
"successCount" : 202,
"failureExceptions" : [Invalid Phone Number is provided for 133]
}
