The following information shows you how you can perform an export.
An export can be initiated using the following steps:
Initiate the export by using the
exportProcessendpoint. Provide the name of the file that will contain the exported data. The following example is of a archived export:POST /ccadmin/v1/exportProcess
{
"fileName": "account.zip",
"items": [
{
"id": "Profiles",
"format": "json"
},
{
"id": "Accounts",
"format": "json"
}
]
}The following example is of a standalone export:
POST /ccadmin/v1/exportProcess
{
"fileName": "product.json",
"mode": "standalone",
"accounts": "Products",
"format": "json"
}Note that when generating a standalone file, you must provide values for the parameters identified for the specific entity that you are exporting. These parameters are discussed in the following sections.
You can review the export progress by requesting the process ID returned from the
exportProcessAPI. For example:GET /ccadmin/v1/exportProcess/{processId}Once the export job is done, the resulting payload provides the links you can use to download the export and status files. The file URL is the export file that provides information on how many accounts were exported. The Meta URL identifies successful and unsuccessful counts.
{
"processId": "Ic01uuAyZwAyYrRhQiNtY9lAY_10001",
"links": [
{
"rel": "self",
"href": "http://localhost/ccadmin/v1/importProcess"
},
{
"rel": "self",
"href": "http://localhost/ccadmin/v1/importProcess"
}
],
"status": "submitted",
"___etag___": "eyJ2ZXJzaW9uIjowLCJ1cmkiOiJpbXBvcnRQcm9jZXNzIiwiaGFza
CI6Ik9IWEVidz09In0="
}{
"progress": "succeeded",
"startTime": "2017-05-22T07:28:04.242Z",
"links": [
{
"rel": "meta",
"href": "http://localhost/file/v8067309405303143112/export/
rKjSiAtgt8WCzJ1YHXrAc5mTQ_10000/exportStatus.zip"
},
{
"rel": "file",
"href": "http://localhost/file/v5846250199917046746/export/
rKjSiAtgt8WCzJ1YHXrAc5mTQ_10000/account.zip"
},
{
"rel": "self",
"href": "http://localhost/ccadmin/v1/exportProcess/
rKjSiAtgt8WCzJ1YHXrAc5mTQ_10000?fileName=account.zip&items=
%5Bobject%20Object%5D"
}
],
"endTime": "2017-05-22T07:28:05.434Z",
"completed": true,
"requestStatus": 200,
"___etag___": "eyJ2ZXJzaW9uIjowLCJ1cmkiOiJleHBvcnRQcm9jZXNzL3JL
alNpQXRndDhXQ3pKMVlIWHJBYzVtVFFfMTAwMDAiLCJoYXNoIjoielF0QjVRPT0ifQ=="
}Note that if there is a failure during the export, the status file includes a failure count. It is not included in the endpoint response. For example:
{
"endTime" : 1469782227619,
"startTime" : 1469782227582,
"failureCount" : 1,
"successCount" : 152,
}
