The export process can be initiated using the following steps:
Initiate the export process by using the
exportProcessendpoint. Provide the name of the file that will contain the exported data. The following example is of a bundled export process:POST /ccadmin/v1/exportProcess
{
"fileName": "account.zip",
"items": [
{
"id": "bulkAccountHandler",
"format": "json"
}
]
}The following example is of a standalone export file:
POST /ccadmin/v1/exportProcess
{
"fileName": "account.json",
"mode": "standalone",
"id": "bulkAccountHandler",
"format": "json"
}Note that when generating a standalone file, you must provide values for the
idandformatparameters.The resulting payload provides you with the token that allows you to generate the export file. Append the UI of the Export Process API with the token generated by the POST method. For example:
/ccadminui/v1/exportProcess/8Hq80xXIhnQgNX3T5gro9BJQlM_10000Once the export job is done, the resulting payload provides the links you can use to download the export and status files. The file URL provides information on how many accounts are in the export file. The Meta URL identifies successful and unsuccessful counts.
{
"fileLink": "http://localhost/file/v4/account.zip",
"metaLink": http://localhost/export/status.zip
}Note that if there is a failure during the export process, the export file will include a failure count. For example:
{
"endTime" : 1469782227619,
"startTime" : 1469782227582,
"failureCount" : 1,
"successCount" : 152,
"failureExceptions" : [Invalid Phone Number is provided for 313]
}
