JavaScript SDK Samples - Blueprint Operations

              Copy to Clipboard
              
class Blueprint
{
    /**
     *  Get Blueprint 
     * This method is used to get a single record's Blueprint details with ID and print the response.
     * @param {String} moduleAPIName The API Name of the record's module
     * @param {BigInt} recordId The ID of the record to get Blueprint
     */
    static async getBlueprint(moduleAPIName, recordId) {
        //example
        // let moduleAPIName = "Leads";
        // let recordId = 34096432469044n;

        //Get instance of BluePrintOperations Class that takes moduleAPIName and recordId as parameter
        let bluePrintOperations = new ZCRM.BluePrint.Operations(recordId, moduleAPIName);

        //Call getBlueprint method
        let response = await bluePrintOperations.getBlueprint();

        if (response != null) {
            //Get the status code from response
            console.log("Status Code: " + response.getStatusCode());

            if ([204, 304].includes(response.getStatusCode())) {
                console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");

                return;
            }

            //Get object from response
            let responseObject = response.getObject();

            if (responseObject != null) {
                //Check if expected ResponseWrapper instance is received.
                if (responseObject instanceof ZCRM.BluePrint.Model.ResponseWrapper) {
                    //Get the obtained BluePrint instance
                    let bluePrint = responseObject.getBlueprint();

                    //Get the ProcessInfo instance of the obtained BluePrint
                    let processInfo = bluePrint.getProcessInfo();

                    //Check if ProcessInfo is not null
                    if (processInfo != null) {
                        //Get the ID of the ProcessInfo
                        console.log("ProcessInfo ID: " + processInfo.getId());

                        //Get the Field ID of the ProcessInfo
                        console.log("ProcessInfo Field-ID: " + processInfo.getFieldId());

                        //Get the isContinuous of the ProcessInfo
                        console.log("ProcessInfo isContinuous: " + processInfo.getIsContinuous());

                        //Get the API Name of the ProcessInfo
                        console.log("ProcessInfo API Name: " + processInfo.getAPIName());

                        //Get the Continuous of the ProcessInfo
                        console.log("ProcessInfo Continuous: " + processInfo.getContinuous());

                        //Get the FieldLabel of the ProcessInfo
                        console.log("ProcessInfo FieldLabel: " + processInfo.getFieldLabel());

                        //Get the Name of the ProcessInfo
                        console.log("ProcessInfo Name: " + processInfo.getName());

                        //Get the ColumnName of the ProcessInfo
                        console.log("ProcessInfo ColumnName: " + processInfo.getColumnName());

                        //Get the FieldValue of the ProcessInfo
                        console.log("ProcessInfo FieldValue: " + processInfo.getFieldValue());

                        //Get the FieldName of the ProcessInfo
                        console.log("ProcessInfo FieldName: " + processInfo.getFieldName());

                        //Get the Escalation of the ProcessInfo
                        console.log("ProcessInfo FieldName: " + processInfo.getEscalation());
                    }

                    //Get the array of transitions from BluePrint instance
                    let transitions = bluePrint.getTransitions();

                    transitions.forEach(transition => {
                        let nextTransitions = transition.getNextTransitions();

                        nextTransitions.forEach(nextTransition => {
                            //Get the ID of the NextTransition
                            console.log("NextTransition ID: " + nextTransition.getId());

                            //Get the Name of the NextTransition
                            console.log("NextTransition Name: " + nextTransition.getName());
                        });

                        //Get the PercentPartialSave of each Transition
                        console.log("Transition PercentPartialSave: " + transition.getPercentPartialSave());

                        let data = transition.getData();

                        if (data != null) {
                            //Get the ID of each record
                            console.log("Record ID: " + data.getId());

                            //Get the createdBy User instance of each record
                            let createdBy = data.getCreatedBy();

                            if (createdBy != null) {
                                //Get the ID of the createdBy User
                                console.log("Record Created By User-ID: " + createdBy.getId());

                                //Get the name of the createdBy User
                                console.log("Record Created By User-Name: " + createdBy.getName());
                            }

                            //Check if the created time is not null
                            if (data.getCreatedTime() != null) {
                                //Get the created time of each record
                                console.log("Record Created Time: " + data.getCreatedTime().toString());
                            }

                            //Check if the modified time is not null
                            if (data.getModifiedTime() != null) {
                                //Get the modified time of each record
                                console.log("Record Modified Time: " + data.getModifiedTime().toString());
                            }

                            //Get the modifiedBy User instance of each record
                            let modifiedBy = data.getModifiedBy();

                            //Check if modifiedByUser is not null
                            if (modifiedBy != null) {
                                //Get the ID of the modifiedBy User
                                console.log("Record Modified By User-ID: " + modifiedBy.getId());

                                //Get the name of the modifiedBy User
                                console.log("Record Modified By user-Name: " + modifiedBy.getName());
                            }

                            //Get all entries from the keyValues map
                            Array.from(data.getKeyValues().keys()).forEach(key => {
                                console.log(key + ": " + data.getKeyValues().get(key));
                            });
                        }

                        //Get the NextFieldValue of the Transition
                        console.log("Transition NextFieldValue: " + transition.getNextFieldValue());

                        //Get the Name of each Transition
                        console.log("Transition Name: " + transition.getName());

                        //Get the CriteriaMatched of the Transition
                        console.log("Transition CriteriaMatched: " + transition.getCriteriaMatched().toString());

                        //Get the ID of the Transition
                        console.log("Transition ID: " + transition.getId());

                        if (transition.getExecutionTime() != null) {
                            //Get the Execution Time of the Transition
                            console.log("Transition Execution Time: " + transition.getExecutionTime().toString());
                        }

                        let fields = transition.getFields();

                        console.log("Transition Fields");

                        for (let index = 0; index  {
                                    //Get the DisplayValue of each PickListValues
                                    console.log("DisplayValue: " + pickListValue.getDisplayValue());

                                    //Get the SequenceNumber of each PickListValues
                                    console.log("SequenceNumber: " + pickListValue.getSequenceNumber().toString());

                                    //Get the ExpectedDataType of each PickListValues
                                    console.log("ExpectedDataType: " + pickListValue.getExpectedDataType());

                                    //Get the ActualValue of each PickListValues
                                    console.log("ActualValue: " + pickListValue.getActualValue());

                                    if (pickListValue.getMaps() != null) {
                                        Array.from(pickListValue.getMaps().keys()).forEach(key => {
                                            console.log(key + ": " + pickListValue.getMaps().get(key));
                                        });
                                    }
                                });
                            }

                            //Get all entries from the MultiSelectLookup instance
                            let multiSelectLookup = field.getMultiselectlookup();

                            if (multiSelectLookup != null) {
                                //Get the DisplayValue of the MultiSelectLookup
                                console.log("DisplayLabel: " + multiSelectLookup.getDisplayLabel());

                                //Get the LinkingModule of the MultiSelectLookup
                                console.log("LinkingModule: " + multiSelectLookup.getLinkingModule());

                                //Get the LookupApiname of the MultiSelectLookup
                                console.log("LookupApiname: " + multiSelectLookup.getLookupApiname());

                                //Get the APIName of the MultiSelectLookup
                                console.log("APIName: " + multiSelectLookup.getAPIName());

                                //Get the ConnectedlookupApiname of the MultiSelectLookup
                                console.log("ConnectedlookupApiname: " + multiSelectLookup.getConnectedlookupApiname());

                                //Get the ID of the MultiSelectLookup
                                console.log("ID: " + multiSelectLookup.getId());
                            }

                            //Get the AutoNumber of each Field
                            let autoNumber = field.getAutoNumber();

                            if (autoNumber != null) {
                                //Get the Prefix of the AutoNumber
                                console.log("Prefix: " + autoNumber.getPrefix());

                                //Get the Suffix of the AutoNumber
                                console.log("Suffix: " + autoNumber.getSuffix());

                                if (autoNumber.getStartNumber() != null) {
                                    //Get the StartNumber of the AutoNumber
                                    console.log("StartNumber: " + autoNumber.getStartNumber().toString());
                                }
                            }
                        }

                        //Get the CriteriaMessage of each Transition
                        console.log("Transition CriteriaMessage: " + transition.getCriteriaMessage());

                    });
                }
                //Check if the request returned an exception
                else if (responseObject instanceof ZCRM.BluePrint.Model.APIException) {
                    //Get the Status
                    console.log("Status: " + responseObject.getStatus().getValue());

                    //Get the Code
                    console.log("Code: " + responseObject.getCode().getValue());

                    console.log("Details");

                    let details = responseObject.getDetails();

                    //Get the details map
                    if (details != null) {
                        Array.from(details.keys()).forEach(key => {
                            console.log(key + ": " + details.get(key));
                        });
                    }

                    //Get the Message
                    console.log("Message: " + responseObject.getMessage().getValue());
                }
            }
        }
    }
}
 

              Copy to Clipboard
              
class Blueprint
{
    /**
     *  Update Blueprint 
     * This method is used to update a single record's Blueprint details with ID and print the response.
     * @param {String} moduleAPIName The API Name of the record's module
     * @param {BigInt} recordId The ID of the record to update Blueprint
     * @param {BigInt} transitionId The ID of the Blueprint transition Id
     */
    static async updateBlueprint(moduleAPIName, recordId, transitionId) {
        //example
        // let moduleAPIName = "Leads";
        // let recordId = 34096432469044n;
        // let transitionId = 34096431172075n;

        //Get instance of BluePrintOperations Class that takes moduleAPIName and recordId as parameter
        let bluePrintOperations = new ZCRM.BluePrint.Operations(recordId, moduleAPIName);

        //Get instance of BodyWrapper Class that will contain the request body
        let bodyWrapper = new ZCRM.BluePrint.Model.BodyWrapper();

        //Array to contain BluePrint instances
        let bluePrintArray = [];

        //Get instance of BluePrint Class
        let bluePrint = new ZCRM.BluePrint.Model.BluePrint();

        //Set transitionId to the BluePrint instance
        bluePrint.setTransitionId(transitionId);

        //Get instance of Record Class
        let data = new ZCRM.Record.Model.Record();

        let lookup = new Map();

        lookup.set("Phone", "892937");

        lookup.set("id", "894937");

        // data.addKeyValue("Data_3", lookup);

        data.addKeyValue("Phone", "8942937");

        data.addKeyValue("Notes", "Updated via blueprint");

        let checkLists = [];

        let checkListItem = new Map();

        checkListItem.set("list 1", true);

        checkLists.push(checkListItem);

        checkListItem = new Map();

        checkListItem.set("list 2", true);

        checkLists.push(checkListItem);

        checkListItem = new Map();

        checkListItem.set("list 3", true);

        checkLists.push(checkListItem);

        data.addKeyValue("CheckLists", checkLists);

        //Set data to the BluePrint instance
        bluePrint.setData(data);

        //Add BluePrint instance to the array
        bluePrintArray.push(bluePrint);

        //Set the array to bluePrint in BodyWrapper instance
        bodyWrapper.setBlueprint(bluePrintArray);

        //Call updateBluePrint method that takes BodyWrapper instance
        let response = await bluePrintOperations.updateBlueprint(bodyWrapper);

        if (response != null) {
            //Get the status code from response
            console.log("Status Code: " + response.getStatusCode());

            //Get object from response
            let responseObject = response.getObject();

            if (responseObject != null) {
                if (responseObject instanceof ZCRM.BluePrint.Model.SuccessResponse) {

                    //Get the Status
                    console.log("Status: " + responseObject.getStatus().getValue());

                    //Get the Code
                    console.log("Code: " + responseObject.getCode().getValue());

                    console.log("Details");

                    //Get the details map
                    let details = responseObject.getDetails();

                    if (details != null) {
                        Array.from(details.keys()).forEach(key => {
                            console.log(key + ": " + details.get(key));
                        });
                    }

                    //Get the Message
                    console.log("Message: " + responseObject.getMessage().getValue());
                }
                else if (responseObject instanceof ZCRM.BluePrint.Model.APIException) {
                    //Get the Status
                    console.log("Status: " + responseObject.getStatus().getValue());

                    //Get the Code
                    console.log("Code: " + responseObject.getCode().getValue());

                    console.log("Details");

                    //Get the details map
                    let details = responseObject.getDetails();

                    if (details != null) {
                        Array.from(details.keys()).forEach(key => {
                            console.log(key + ": ");

                            var data = details.get(key);

                            if (Array.isArray(data)) {
                                for (let error of data) {
                                    console.log("Field APIName " + error.getAPIName() + " : " + error.getMessage());
                                }
                            }
                            else {
                                console.log(JSON.stringify(data));
                            }
                        });
                    }

                    //Get the Message
                    console.log("Message: " + responseObject.getMessage().getValue());
                }
            }
        }
    }
}