TypeScript SDK Samples - Bulk Read Operations

              Copy to Clipboard
              
import * as fs from 'fs';
import * as path from 'path';
import { ActionHandler } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_handler';
import {BulkReadOperations} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/bulk_read_operations";
import { CallBack } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/call_back';
import { ActionWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_wrapper';
import { ActionResponse } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_response';
import { FileBodyWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/file_body_wrapper';
import { SuccessResponse } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/success_response';
import { APIException } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/api_exception';
import { Criteria } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/criteria';
import { Query } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/query';
import { RequestWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/request_wrapper';
import {ResponseHandler} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/response_handler";
import {ResponseWrapper} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/response_wrapper";
import { APIResponse } from '@zohocrm/typescript-sdk/routes/controllers/api_response';
import { Choice } from '@zohocrm/typescript-sdk/utils/util/choice';
import { JobDetail } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/job_detail';
import { Result } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/result';
import { User } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/users/user';

export class BulkRead{

    /**
     * Create BulkRead Job
     * This method is used to create a bulk read job to export records.
     * @param moduleAPIName  The API Name of the record's module
     */
    public static async createBulkReadJob(moduleAPIName: string) {

        //example
        //let moduleAPIName = "Leads";

        //Get instance of BulkReadOperations Class
        let bulkReadOperations: BulkReadOperations = new BulkReadOperations();

        //Get instance of RequestWrapper Class that will contain the request body
        let requestWrapper: RequestWrapper = new RequestWrapper();

        //Get instance of CallBack Class
        let callBack: CallBack = new CallBack();

        //Set valid callback URL.
        callBack.setUrl("https://www.example.com/callback");

        //Set the HTTP method of the callback URL. The allowed value is post.
        callBack.setMethod(new Choice("post"));

        //The Bulk Read Job's details is posted to this URL on successful completion / failure of the job.
        requestWrapper.setCallback(callBack);

        //Get instance of Query Class
        let query: Query = new Query();

        //Specifies the API Name of the module to be read.
        query.setModule(moduleAPIName);

        //Specifies the unique ID of the custom view, whose records you want to export.
        query.setCvid("3477061087501");

        //Array of field names
        let fieldAPINames: string[] = [];

        fieldAPINames.push("Last_Name");

        //Specifies the API Name of the fields to be fetched.
        query.setFields(fieldAPINames);

        //To set page value, By default value is 1.
        query.setPage(1);

        //Get instance of Criteria Class
        let criteria: Criteria = new Criteria();

        criteria.setGroupOperator(new Choice("or"));

        let criteriaArray: Criteria[] = [];

        let group11: Criteria = new Criteria();

        group11.setGroupOperator(new Choice("and"));

        let groupArray11: Criteria[] = [];

        let group111: Criteria = new Criteria();

        group111.setAPIName("Company");

        group111.setComparator(new Choice("equal"));

        group111.setValue("Zoho");

        groupArray11.push(group111);

        let group112: Criteria = new Criteria();

        group112.setAPIName("Owner");

        group112.setComparator(new Choice("in"));

        group112.setValue(["3477061173021"]);

        groupArray11.push(group112);

        group11.setGroup(groupArray11);

        criteriaArray.push(group11);

        let group12 = new Criteria();

        group12.setGroupOperator(new Choice("or"));

        let groupArray12: Criteria[] = [];

        let group121 = new Criteria();

        group121.setAPIName("Paid");

        group121.setComparator(new Choice("equal"));

        group121.setValue(true);

        groupArray12.push(group121);

        let group122 = new Criteria();

        // To set API name of a field.
        group122.setAPIName("Created_Time");

        // To set comparator(eg: equal, greater_than.).
        group122.setComparator(new Choice("between"));

        let time = ["2020-06-03T17:31:48+05:30", "2020-06-03T17:31:48+05:30"];

        // To set the value to be compared
        group122.setValue(time);

        groupArray12.push(group122);

        group12.setGroup(groupArray12);

        criteriaArray.push(group12);

        criteria.setGroup(criteriaArray);

        //To filter the records to be exported.
        query.setCriteria(criteria);

        //Set the query object
        requestWrapper.setQuery(query);

        //Specify the value for this key as "ics" to export all records in the Events module as an ICS file.
        //requestWrapper.setFileType(new Choice("ics"));

        //Call createBulkReadJob method that takes RequestWrapper instance as parameter
        let response: APIResponse = await bulkReadOperations.createBulkReadJob(requestWrapper);

        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) {

                //Check if expected ActionWrapper instance is received
                if (responseObject instanceof ActionWrapper) {

                    //Get the array of obtained ActionResponse instances
                    let actionResponses: ActionResponse[] = responseObject.getData();

                    actionResponses.forEach(actionResponse => {

                        //Check if the request is successful
                        if (actionResponse instanceof SuccessResponse) {

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

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

                            console.log("Details");

                            //Get the details map
                            let details: Map = actionResponse.getDetails();

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

                            //Get the Message
                            console.log("Message: " + actionResponse.getMessage().getValue());
                        }
                        //Check if the request returned an exception
                        else if (actionResponse instanceof APIException) {

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

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

                            console.log("Details");

                            //Get the details map
                            let details: Map = actionResponse.getDetails();

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

                            //Get the Message
                            console.log("Message: " + actionResponse.getMessage().getValue());
                        }
                    });
                }
                //Check if the request returned an exception
                else if (responseObject instanceof 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: Map = 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());
                }
            }
        }
    }
 }
 

              Copy to Clipboard
              
import * as fs from 'fs';
import * as path from 'path';
import { ActionHandler } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_handler';
import {BulkReadOperations} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/bulk_read_operations";
import { CallBack } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/call_back';
import { ActionWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_wrapper';
import { ActionResponse } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_response';
import { FileBodyWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/file_body_wrapper';
import { SuccessResponse } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/success_response';
import { APIException } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/api_exception';
import { Criteria } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/criteria';
import { Query } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/query';
import { RequestWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/request_wrapper';
import {ResponseHandler} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/response_handler";
import {ResponseWrapper} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/response_wrapper";
import { APIResponse } from '@zohocrm/typescript-sdk/routes/controllers/api_response';
import { Choice } from '@zohocrm/typescript-sdk/utils/util/choice';
import { JobDetail } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/job_detail';
import { Result } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/result';
import { User } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/users/user';

export class BulkRead{

    /**
     * Get BulkRead Job Details
     * This method is used to get the details of a bulk read job performed previously.
     * @param jobId The unique ID of the bulk read job.
    **/
    public static async getBulkReadJobDetails(jobId: bigint) {

        //example
        // let jobId = 34096432461001n;

        //Get instance of BulkReadOperations Class
        let bulkReadOperations: BulkReadOperations = new BulkReadOperations();

        //Call getBulkReadJobDetails method that takes jobId as parameter
        let response: APIResponse = await bulkReadOperations.getBulkReadJobDetails(jobId);

        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: ResponseHandler = response.getObject();

            if (responseObject != null) {

                //Check if expected ResponseWrapper instance is received.
                if (responseObject instanceof ResponseWrapper) {

                    //Get the array of obtained jobDetail instances
                    let jobDetails: JobDetail[] = responseObject.getData();

                    jobDetails.forEach(jobDetail => {

                        //Get the Job ID of each jobDetail
                        console.log("Bulk read Job ID: " + jobDetail.getId());

                        //Get the Operation of each jobDetail
                        console.log("Bulk read Operation: " + jobDetail.getOperation());

                        //Get the State of each jobDetail
                        console.log("Bulk read State: " + jobDetail.getState().getValue());

                        //Get the Result instance of each jobDetail
                        let result: Result = jobDetail.getResult();

                        //Check if Result is not null
                        if (result != null) {
                            //Get the Page of the Result
                            console.log("Bulkread Result Page: " + result.getPage().toString());

                            //Get the Count of the Result
                            console.log("Bulkread Result Count: " + result.getCount().toString());

                            //Get the Download URL of the Result
                            console.log("Bulkread Result Download URL: " + result.getDownloadUrl());

                            //Get the Per_Page of the Result
                            console.log("Bulkread Result Per_Page: " + result.getPerPage().toString());

                            //Get the MoreRecords of the Result
                            console.log("Bulkread Result MoreRecords: " + result.getMoreRecords().toString());

                        }

                        // Get the Query instance of each jobDetail
                        let query: Query = jobDetail.getQuery();

                        if (query != null) {
                            //Get the Module Name of the Query
                            console.log("Bulk read Query Module: " + query.getModule());

                            //Get the Page of the Query
                            console.log("Bulk read Query Page: " + query.getPage().toString());

                            //Get the cvid of the Query
                            console.log("Bulk read Query cvid: " + query.getCvid());

                            //Get the fields List of each Query
                            let fields: string[] = query.getFields();

                            //Check if fields is not null
                            if (fields != null) {
                                fields.forEach(fieldName => {
                                    //Get the Field Name of the Query
                                    console.log("Bulk read Query Fields: " + fieldName);
                                });
                            }

                            // Get the Criteria instance of each Query
                            let criteria: Criteria = query.getCriteria();

                            //Check if criteria is not null
                            if (criteria != null) {
                                this.printCriteria(criteria);
                            }
                        }

                        //Get the CreatedBy User instance of each jobDetail
                        let createdBy: User = jobDetail.getCreatedBy();

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

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

                        //Get the CreatedTime of each jobDetail
                        console.log("Bulkread CreatedTime: " + jobDetail.getCreatedTime());

                        //Get the FileType of each jobDetail
                        console.log("Bulkread File Type: " + jobDetail.getFileType());
                    });
                }
                //Check if the request returned an exception
                else if (responseObject instanceof 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: Map = 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());
                }
            }
        }
    }

    private static async printCriteria(criteria: Criteria) {
        if (criteria.getAPIName() != null) {
            //Get the APIName of the Criteria
            console.log("BulkRead Criteria API Name: " + criteria.getAPIName());
        }
        if (criteria.getComparator() != null) {
            //Get the Comparator of the Criteria
            console.log("BulkRead Criteria Comparator: " + criteria.getComparator().getValue());
        }

        if (criteria.getValue() != null) {
            //Get the Value of the Criteria
            console.log("BulkRead Criteria Value: " + criteria.getValue().toString());
        }

        //Get the array of Criteria instance of each Criteria
        let criteriaGroup: Criteria[] = criteria.getGroup();

        if (criteriaGroup != null) {
            criteriaGroup.forEach(eachCriteria => {
                this.printCriteria(eachCriteria);
            });
        }

        if (criteria.getGroupOperator() != null) {
            //Get the Group Operator of the Criteria
            console.log("BulkRead Criteria Group Operator: " + criteria.getGroupOperator().getValue());
        }
    }
 }
 

              Copy to Clipboard
              
import * as fs from 'fs';
import * as path from 'path';
import { ActionHandler } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_handler';
import {BulkReadOperations} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/bulk_read_operations";
import { CallBack } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/call_back';
import { ActionWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_wrapper';
import { ActionResponse } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/action_response';
import { FileBodyWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/file_body_wrapper';
import { SuccessResponse } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/success_response';
import { APIException } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/api_exception';
import { Criteria } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/criteria';
import { Query } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/query';
import { RequestWrapper } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/request_wrapper';
import {ResponseHandler} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/response_handler";
import {ResponseWrapper} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/response_wrapper";
import { APIResponse } from '@zohocrm/typescript-sdk/routes/controllers/api_response';
import { Choice } from '@zohocrm/typescript-sdk/utils/util/choice';
import { JobDetail } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/job_detail';
import { Result } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/bulk_read/result';
import { User } from '@zohocrm/typescript-sdk/core/com/zoho/crm/api/users/user';

export class BulkRead{

    /**
     * Download Result
     * This method is used to download the result of Bulk Read operation
     * @param jobId The unique ID of the bulk read job.
     * @param destinationFolder The absolute path where downloaded file has to be stored.
     */
    public static async downloadResult(jobId: bigint, destinationFolder: string) {

        //example
        //String jobId = 34096432461001n;
        //String destinationFolder = "/Users/user_name/Documents";

        //Get instance of BulkReadOperations Class
        let bulkReadOperations: BulkReadOperations = new BulkReadOperations();

        //Call downloadResult method that takes jobId as parameter
        let response: APIResponse = await bulkReadOperations.downloadResult(jobId);

        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: ResponseHandler = response.getObject();

            if (responseObject != null) {

                //Check if expected FileBodyWrapper instance is received.
                if (responseObject instanceof FileBodyWrapper) {

                    //Get StreamWrapper instance from the returned FileBodyWrapper instance
                    let streamWrapper = responseObject.getFile();

                    let name: string | undefined = streamWrapper.getName();

                    if (name !== undefined) {
                        //Construct the file name by joining the destinationFolder and the name from StreamWrapper instance
                        let fileName = path.join(destinationFolder, name);

                        //Get the stream from StreamWrapper instance
                        let readStream: Buffer | fs.ReadStream | undefined = streamWrapper.getStream();

                        if (readStream !== undefined && readStream instanceof Buffer) {
                            //Write the stream to the destination file.
                            fs.writeFileSync(fileName, readStream);
                        }

                    }

                }
                //Check if the request returned an exception
                else if (responseObject instanceof 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: Map = 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());
                }
            }
        }
    }
}