Consumer Goods Cloud Real Time Reporting Developer Guide

Introduction
Prerequisites
Configuring Integration Dimension Meta
Triggering the CSV Export Process
REST API Endpoints
Triggering CSV Exports
Checking Job Status
Committing CSV
Retrieving CSV Exports
Examples
CGCloud Namespace
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Committing CSV

This endpoint is used to commit a specific csvGuid and take the related CSV as a new baseline for future delta exports—that is, after this commit, the next delta export contains only those KPIs that have been either added, changed, or deleted from this committed state.

You can see the current version of this commit when checking the status of the export. For example: "metaVersion": 8.

If the underlying RTR Report Configuration record in Salesforce changes, It’s reflected as an implicit commit and therefore, set as a new baseline.

Endpoint

COMMIT_RTR_EXPORT

Request Parameters

URL Parameter Sample Value
csvGuid 3b549543-d420-401a-b424-29c7f3c75713
Parameter Mandatory Type
businessyear Yes Integer
metaname Yes String
salesorg Yes String

Sample Request Body

1<namespace>OffPlatformCallout request = new <namespace>.OffPlatformCallout('COMMIT_RTR_EXPORT','<salesorg>');
2Map<String, Object> data = new Map<String, Object>();
3data.put('metaname','AccountAndPromotionMeasures');
4data.put('salesorg', '0001');
5data.put('businessyear',2020);
6String requestBodyContent = JSON.serialize(data, true);
7Map<String, String> params = new Map<String, String>();
8params.put('csvGuid', '<CSV Guid received as response from Triggering CSV Export>');
9<namespace>.OffPlatformCalloutResponse response = request.execute(<namespace>.TransactionHandler.getTransactionIdentifier(), params, requestBodyContent);
10System.debug(response);

Sample Response Body

1{
2  "csvGuid": "94f49a3f-37bc-4794-8051-123456789",
3  "commitdate": "Thu, 16 Sep 2021 13:04:23 GMT"
4}