Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Abort Export Process

Uses the POST method to set the state of a CSV export process to Aborted.

When a CSV export process is running for a longer duration than expected, it consumes resources and blocks the scheduling of new exports. Abort Export API unblocks the scheduling by aborting the export process. It takes csvGuid as the path parameter and IntegrationMetaName as the query parameter.

Resource

/measures/export/abort/{{csvGuid}}?integrationmetaname=<integration_meta_name>

  • csvGuid: Enter the ID of the CSV export that needs to be aborted.
Resource Example

https://pumpkinspice.salesforce.com/services/apexrest/cgcloud/measures/export/abort/ad95ce25-365b-43c0-8c79-e0e01ab0505a?integrationmetaname=integrationExportPromotion

Available Version
65.0 and later
HTTP Method
POST
Query Parameters
Parameter Type Description Required or Optional Available Version
integrationmetaname String Enter the name of the export configuration. Required 65.0
Response
1{
2"message":"Abort Export is scheduled successfully."
3}