[SalesForce] REST Integration – JSON Serialization/Deserialization alternative to wrapper class

I am building a REST integration between two Salesforce Environments. One environment will be used to setup and stage Data and when ready the Integration will be able to push data from the src to the target.

It is not a lot of data at any one time, but it is a lot of related objects that would need to be Upserted to the target org in the right order.

The steps for one migration looks more or less like the following:

Retrieve object1 data with SOQL.
JSON Serialize the retrieved data using a wrapper class.
Send the JSON as a HTTP PUT Request to the Source Org
Rest Webservice in the targer org gets the JSON, Deserializes it using the same wrapper class and Upserts the data

This all works and I am able to send and work with Lists of data for each object, however to get it to work I need:
One wrapper class per object, which has all the fields that I want to migrate as Class variables, then as part of the constructor then as part of a jsonSerializeMethod for serialization and as part of a getMethod for deserialization, plus as a retrieveBySOQL method to return the lists of related data.

This would not be a problem if I only had one object (or even 3) as part of the migration, but I happen to have 20ish objects, which mean I would need one such class for each object.

It is the same fields in both Salesforce Environments.

Specifically I would like to know if I can accomplish the same without using these wrapper classes for serializing/deserializing the json. Here is an example:

public class PriceListItemClass {
public String aptsExtId;

public PriceListItemClass(String aptsExtId){
    this.aptsExtId = aptsExtId;
}

public Apttus_Config2__PriceListItem__c getRecord(){
    Apttus_Config2__PriceListItem__c priceListItem = new Apttus_Config2__PriceListItem__c();
    priceListItem.APTS_Ext_Id__c = aptsExtId;
    return priceListItem;
}

public static List<Apttus_Config2__PriceListItem__c> retrieveBySOQL(Set<Id> productExtIdSet){
    List<Apttus_Config2__PriceListItem__c> priceListItems = [
        SELECT APTS_Ext_Id__c, Apttus_Config2__PriceListId__c
        FROM Apttus_Config2__PriceListItem__c
        WHERE Apttus_Config2__ProductId__r.APTS_Ext_ID__c
        IN : productExtIdSet
        ];

    priceListItems = updateAPTSExtIds(priceListItems);

    return priceListItems;
}

public static String jsonSerialize(List<Apttus_Config2__PriceListItem__c> priceListItemList){
    List<PriceListItemClass> priceListItemClassList = new List<PriceListItemClass>();

    for(Apttus_Config2__PriceListItem__c priceListItem : priceListItemList){
        PriceListItemClass priceListItemClass = new PriceListItemClass(priceListItem.Name);
        priceListItemClassList.add(priceListItemClass);
    }

    String httpRequestBody = JSON.serialize(priceListItemClassList);
    System.debug('httpRequestBody: ' + httpRequestBody);

    return httpRequestBody;
}

I am able to send a List of Products without the wrapper class: This is the JSON: [{"attributes":{"type":"Product2","url":"/services/data/v45.0/sobjects/Product2/01t0E000004dz71QAA"},"LastModifiedDate":"2019-02-28T11:24:53.000+0000","Description":"test","APTS_Enable_Reselling__c":true,"APTS_Exclude_from_SBL_PPL__c":false,"IsActive":true,"Apttus_Config2__HasOptions__c":false,"Apttus_Config2__HasSearchAttributes__c":false,"APTS_MBL_Enabled__c":false,"Apttus_Config2__ConfigurationType__c":"Standalone","Apttus_Config2__Uom__c":"Each","APTS_Foundations__c":false,"APTS_Fixed_Price__c":false,"Name":"Oracle5 – Update11","APTS_Exclude_from_MBL__c":false,"CreatedById":"005570000082wlWAAQ","pse__IsServicesProduct__c":false,"APTS_PSA_Product__c":false,"APTS_Product_Link__c":"_HL_ENCODED_/01t0E000004dz71_HL_01t0E000004dz71_HL__blank_HL_","APTS_Solution_Owner_Prod_Sum__c":" ","APTS_Follows_IMS_Users__c":false,"APTS_Price_Point__c":1,"APTS_Safe_ID__c":"01t0E000004dz71QAA","Apttus_Config2__HasAttributes__c":false,"IsDeleted":false,"Migrate_To_Production__c":false,"APTS_Pre_CPQ__c":false,"Apttus_Config2__Version__c":1.00,"Apttus_Config2__HasDefaults__c":false,"TECH_MigratePreprod__c":false,"CanUseRevenueSchedule":false,"Apttus_Config2__Customizable__c":false,"CurrencyIsoCode":"EUR","SystemModstamp":"2019-02-28T11:24:53.000+0000","IsArchived":false,"Apttus_Config2__ExcludeFromSitemap__c":false,"Is_SBL_Product__c":false,"Migrate_To_Preprod__c":true,"APTS_Quantity_Check_Against_Asset__c":false,"CreatedDate":"2019-02-21T13:48:32.000+0000","Id":"01t0E000004dz71QAA","APTS_Enable_Base_Price_Edit__c":false,"LastModifiedById":"005570000082wlWAAQ","APTS_Ext_ID__c":"01t0E000004dz71QAA","Apttus_Config2__Icon__c":"_HL_ENCODED_/apex/Apttus_Config2__IconUploader?productId=01t0E000004dz71_HL__IM1_/resource/Apttus_Config2__Image_UploadIcon_IM2_Upload Icon_IM3__50_IM4_50_IM5__HL__top_HL_"}]

I use the APTS_Ext_Id__c as the external Id.

This is the REST Ressource:

@RestResource(urlMapping='/Product/*')

global class ProductToolsRest {

//Upsert a List of Products
@HttpPut
global static void doPut() {
    RestRequest request = RestContext.request;
    RestResponse response = RestContext.response;

    String jSONRequestBody = request.requestBody.toString().trim();
    System.debug('jSONRequestBody: ' + jSONRequestBody);

    // List<ProductClass> productClassRequests = (List<ProductClass>)JSON.deserialize(jSONRequestBody, List<ProductClass>.class);

    List<Product2> productsToUpsert = new List<Product2>();
    List<Product2> productList = JSON.deserialize(jSONRequestBody, productsToUpsert);
    // for(ProductClass productClassRequest : productClassRequests){
    //     productsToUpsert.add(productClassRequest.getRecord());
    // }

    // for(Product2 product : productList){
    //     productsToUpsert.add(product);
    // }

    if(!productsToUpsert.isEmpty()){
        System.debug('productsToUpsert: ' + productsToUpsert);
        Schema.SObjectField extID = Product2.Fields.APTS_Ext_Id__c;
        System.debug('productsToUpsert: ' + productsToUpsert);

        // Database.UpsertResult[] cr = Database.upsert(productsToUpsert, extID);
        Database.UpsertResult[] cr = Database.upsert(productsToUpsert, extID);

        upsert productsToUpsert;
    }
}

}

Thank you!

Best Answer

You might be interested in the SObject tree resource from the REST API that Salesforce provides.

SObject tree allows you to use a single request to insert a record hierarchy up to 5 levels deep. The SObject tree resource is mostly aimed at creating a hierarchy of records. If you're not looking for that per se, you may want to simply insert single records using the Composite resource. You may also try the composite resource if your record hierarchy is greater than 5 levels deep.

For the cost of understanding and prototyping a solution using this, you get to avoid the need to create any wrapper classes (if the SObjects in both orgs share your target fields).

I'm assuming that you already have the authentication part taken care of, since you already rolled your own cross-org integration using an Apex webservice.

Related Solutions

[SalesForce] Displaying JSON response data from a wrapper class onto a VF Page

You're shadowing your Visualforce-accessible wrapper property with a local variable declaration:

    List<HAPI_TerrByCount_wrapper> wrapper = (List<HAPI_TerrByCount_wrapper>)JSON.deserialize(response.getBody(), List<HAPI_TerrByCount_wrapper>.class);

You need to remove the declaration (List<HAPI_TerrByCount_wrapper>) from your deserialize() method, because the local variable goes out of scope at the end of the method, but your property's value is never set.

Additionally, you need to make sure the type of your instance variable and the type of your deserializing code are in sync with one another. This is a little confusing (and definitely tripped me up, if you review the edit history of this answer!) because you're trying to deserialize a single HAPI_TerrByCount_wrapper object that contains a List<HAPI_TerrByCount_wrapper.TerritoriesByCountry>. However, your JSON can't directly be deserialized into HAPI_TerrByCount_wrapper or List<HAPI_TerrByCount_wrapper>, because that type has another layer of property declaration in the form of its instance variable terrByCountList, which is not represented in the JSON.

What you'll need to do ultimately is deserialize a List<HAPI_TerrByCount_wrapper.TerritoriesByCountry> and assign that list to your wrapper.terrByCountList property.

This will prevent a "‘{‘ is expected, but the JSON response is starts with an array ‘[‘" error, because you're deserializing the correct type.

(I'm sorry for the confusion - I initially overlooked the fact that you had a wrapper class around the list that actually mapped to the JSON).

[SalesForce] How to create JSON string for REST callout from Wrapper class

You can do the following workaround to make this happen. First, generate the wrapper class from the JSON (it will have those __c). Then replace the __c to _c to Save the wrapper class (WorkRequest).

Now you can populate the data in the wrapper class, Serialize it, get the raw JSON String and replace all the _c to __c before sending to the request as below. By doing this you can send the JSON as required by your web service.

String rqString = System.JSON.serialize(wr);
System.debug(rqString);
rqString = rqString.replaceAll('_c', '__c');
System.debug(rqString);

Wrapper Class

//
// Generated by JSON2Apex http://json2apex.herokuapp.com/
//

public class WorkRequest {

    public Rqst rqst;

    public class WorkList {
        public String Name;
        public String Sprint_c;
        public String Description_c;
        public Integer isTest_c;
    }

    public class Rqst {
        public List<WorkList> workList;
    }


    public static WorkRequest parse(String json) {
        return (WorkRequest) System.JSON.deserialize(json, WorkRequest.class);
    }
}

Best Answer

Related Solutions

[SalesForce] Displaying JSON response data from a wrapper class onto a VF Page

[SalesForce] How to create JSON string for REST callout from Wrapper class

Related Topic