Batch Export

Retrieve existing batch export settings

Method

GET

Path

/api/v2/batch-export

Parameters

Name	Type	Required	Description
id	number	N

Example cURL

curl -X GET \
'https://platform.flxone.com/api/v2/batch-export?id=1893223' \
-H 'Cache-Control: no-cache' \
-H 'X-Auth: es5a88dmlpktb5t6k9eifm6Pqjd0l70otkm1p2dv6g13h3h2thkptomb3k8dqe3ms3Xvorgr72h99uec0n92mf9hki9d23aprtsmds3' \
-H 'X-CSRF: 14f61670139eb434adf7f148bbea1a30'

Example Response

{
	"response": {
		"status": "OK",
		"export": {
			"id": "1893223",
			"customer": "121",
			"user": "229",
			"state": "COMPLETED",
			"rowCount": "23",
			"jobId": "0",
			"configuration": null,
			"configurationHash": null,
			"attempts": "1",
			"error": null,
			"deleted": "0",
			"modified": "2015-03-24 12:45:57",
			"created": "2015-03-24 12:45:57"
		}
	}
}

Delete existing batch export settings

Only batch exports that are in the PENDING state may be deleted

Method

GET

Path

/api/v2/batch-export

Parameters

Name	Type	Required	Description
id	number	Y

Example cURL

curl -X DELETE \
'https://platform.flxone.com/api/v2/batch-export?id=1893223' \
-H 'Cache-Control: no-cache' \
-H 'X-Auth: es5a88dmlpktb5t6k9eifm6Pqjd0l70otkm1p2dv6g13h3h2thkptomb3k8dqe3ms3Xvorgr72h99uec0n92mf9hki9d23aprtsmds3' \
-H 'X-CSRF: 14f61670139eb434adf7f148bbea1a30'

Example Response

{
	"response": {
        "status": "OK",
        "deleted": true,
        "num_deleted": 1
    }
}