PHP SDK Samples - Bulk Write Operations

              Copy to Clipboard
              
<?php
namespace samples\bulkwrite;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkwrite\FileBodyWrapper;
use com\zoho\crm\api\bulkwrite\BulkWriteOperations;
use com\zoho\crm\api\util\StreamWrapper;
use com\zoho\crm\api\bulkwrite\UploadFileHeader;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\bulkwrite\SuccessResponse;
use com\zoho\crm\api\bulkwrite\APIException;
require_once "vendor/autoload.php";

class UploadFile
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

	public static function uploadFile(string $orgID, string $absoluteFilePath)
	{
		$bulkWriteOperations = new BulkWriteOperations();
		$fileBodyWrapper = new FileBodyWrapper();
	    $streamWrapper = new StreamWrapper(null, null, $absoluteFilePath);
        // $file = fopen($absoluteFilePath, "rb");
        // $stream = fread($file, filesize($absoluteFilePath));
        // fclose($file);
		// $streamWrapper = new StreamWrapper(basename($absoluteFilePath), $stream);
		$fileBodyWrapper->setFile($streamWrapper);
		$headerInstance = new HeaderMap();
		$headerInstance->add(UploadFileHeader::feature(), "bulk-write");
		$headerInstance->add(UploadFileHeader::XCRMORG(), $orgID);
        $response = $bulkWriteOperations->uploadFile($fileBodyWrapper, $headerInstance);
        if($response != null)
        {
            echo("Status code : " . $response->getStatusCode() . "\n");
            $actionResponse = $response->getObject();
            if($actionResponse instanceof SuccessResponse)
            {
                $successResponse = $actionResponse;
                echo("Status: " . $successResponse->getStatus()->getValue() . "\n");
                echo("Code: " . $successResponse->getCode()->getValue() . "\n");
                echo("Details: " );
                foreach($successResponse->getDetails() as $key => $value)
                {
                    echo( $key . " : ");
                    print_r($value);
                    echo("\n");
                }
                echo("Message: " . $successResponse->getMessage()->getValue() . "\n");
            }
            else if($actionResponse instanceof APIException)
            {
                $exception = $actionResponse;
                echo("Status: " . $exception->getStatus()->getValue() . "\n");
                echo("Code: " . $exception->getCode()->getValue() . "\n");
                echo("Details: " );
                if($exception->getDetails() != null)
                {
                    foreach($exception->getDetails() as $key => $value)
                    {
                        echo($key . ": " . $value . "\n");
                    }
                }
                echo("Message: " . $exception->getMessage()->getValue() . "\n");
            }
        }
    }
}

UploadFile::initialize();
$orgID = "xxxx";
$absoluteFilePath = "/Documents/Leads.zip";
UploadFile::uploadFile($orgID, $absoluteFilePath);

 

              Copy to Clipboard
              
<?php
namespace samples\bulkwrite;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkwrite\BulkWriteOperations;
use com\zoho\crm\api\bulkwrite\SuccessResponse;
use com\zoho\crm\api\bulkwrite\APIException;
use com\zoho\crm\api\bulkwrite\RequestWrapper;
use com\zoho\crm\api\bulkwrite\CallBack;
use com\zoho\crm\api\util\Choice;
use com\zoho\crm\api\bulkwrite\Resource;
use com\zoho\crm\api\bulkwrite\FieldMapping;
use com\zoho\crm\api\modules\Module;
require_once "vendor/autoload.php";

class CreateBulkWriteJob
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

	public static function createBulkWriteJob(string $moduleAPIName, string $fileId)
	{
		$bulkWriteOperations = new BulkWriteOperations();
		$requestWrapper = new RequestWrapper();
		$callback = new CallBack();
		$callback->setUrl("https://www.example.com/callback");
		$callback->setMethod(new Choice("post"));
		$requestWrapper->setCallback($callback);
		$requestWrapper->setCharacterEncoding("UTF-8");
		$requestWrapper->setOperation(new Choice("insert"));
		$resource = array();
		$resourceIns = new Resource();
		$resourceIns->setType(new Choice("data"));
        $module = new Module();
        $module->setAPIName($moduleAPIName);
		$resourceIns->setModule($module);
		$resourceIns->setFileId($fileId);
		$resourceIns->setIgnoreEmpty(true);
		$resourceIns->setFindBy("Email");
		$fieldMappings = array();
		$fieldMapping = new FieldMapping();
		$fieldMapping->setAPIName("Last_Name");
		$fieldMapping->setIndex(0);
		array_push($fieldMappings, $fieldMapping);
        $fieldMapping = new FieldMapping();
        $fieldMapping->setAPIName("Email");
		$fieldMapping->setIndex(1);
		array_push($fieldMappings, $fieldMapping);
		$fieldMapping = new FieldMapping();
        $fieldMapping->setAPIName("Company");
		$fieldMapping->setIndex(2);
		array_push($fieldMappings, $fieldMapping);
		$fieldMapping = new FieldMapping();
        $fieldMapping->setAPIName("Phone");
		$fieldMapping->setIndex(3);
		array_push($fieldMappings, $fieldMapping);
		$fieldMapping = new FieldMapping();
        $fieldMapping->setAPIName("Website");
        //$fieldMapping->setFormat("");
        //$fieldMapping->setFindBy("");
        $defaultValue = array();
        $defaultValue["value"] = "https://www.zohoapis.com";
        $fieldMapping->setDefaultValue($defaultValue);
		array_push($fieldMappings, $fieldMapping);
		$resourceIns->setFieldMappings($fieldMappings);
		array_push($resource, $resourceIns);
		$requestWrapper->setResource($resource);
        $response = $bulkWriteOperations->createBulkWriteJob($requestWrapper);
        if($response != null)
        {
            echo("Status code : " . $response->getStatusCode() . "\n");
            $actionResponse = $response->getObject();
            if($actionResponse instanceof SuccessResponse)
            {
                $successResponse = $actionResponse;
                echo("Status: " . $successResponse->getStatus()->getValue() . "\n");
                echo("Code: " . $successResponse->getCode()->getValue() . "\n");
                echo("Details: " );
                foreach($successResponse->getDetails() as $key => $value)
                {
                    echo( $key . ": ");
                    print_r($value);
                    echo("\n");
                }
                echo("Message: " . $successResponse->getMessage()->getValue() . "\n");
            }
            else if($actionResponse instanceof APIException)
            {
                $exception = $actionResponse;
                echo("Status: " . $exception->getStatus()->getValue() . "\n");
                echo("Code: " . $exception->getCode()->getValue() . "\n");
                echo("Details: " );
                if($exception->getDetails() != null)
                {
                    foreach($exception->getDetails() as $key => $value)
                    {
                        echo($key . ": " . $value . "\n");
                    }
                }
                echo("Message: " . $exception->getMessage()->getValue() . "\n");
            }
        }
    }
}

CreateBulkWriteJob::initialize();
$moduleAPIName = "Leads";
$fileId = "347706118194001";
CreateBulkWriteJob::createBulkWriteJob($moduleAPIName, $fileId);


 

              Copy to Clipboard
              
<?php
namespace samples\bulkwrite;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkwrite\BulkWriteOperations;
use com\zoho\crm\api\bulkwrite\APIException;
use com\zoho\crm\api\bulkwrite\BulkWriteResponse;
require_once "vendor/autoload.php";

class GetBulkWriteJobDetails
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

	public static function getBulkWriteJobDetails(string $jobId)
	{
		$bulkWriteOperations = new BulkWriteOperations();
		$response = $bulkWriteOperations->getBulkWriteJobDetails($jobId);
		if($response != null)
		{
            echo("Status code " . $response->getStatusCode() . "\n");
            if(in_array($response->getStatusCode(), array(204, 304)))
            {
                echo($response->getStatusCode() == 204? "No Content\n" : "Not Modified\n");
                return;
            }
            $responseWrapper = $response->getObject();
            if($responseWrapper instanceof BulkWriteResponse)
            {
                $bulkWriteResponse = $responseWrapper;
                echo("Bulkwrite Job Status: " . $bulkWriteResponse->getStatus() . "\n");
                echo("Bulkwrite CharacterEncoding: " . $bulkWriteResponse->getCharacterEncoding() . "\n");
                $resources = $bulkWriteResponse->getResource();
                if($resources != null)
                {
                    foreach($resources as $resource)
                    {
                        echo("Bulkwrite Resource Status: " . $resource->getStatus()->getValue() . "\n");
                        echo("Bulkwrite Resource Type: " . $resource->getType()->getValue() . "\n");
                        $module = $resource->getModule();
                        if($module != null)
                        {
                            echo("Bulkwrite Resource Module Name : " . $module->getAPIName() . "\n");
                            echo("Bulkwrite Resource Module Id : " . $module->getId() . "\n");
                        }
                        $fieldMappings = $resource->getFieldMappings();
                        if($fieldMappings != null)
                        {
                            foreach($fieldMappings as $fieldMapping)
                            {
                                echo("Bulkwrite Resource FieldMapping Module: " . $fieldMapping->getAPIName() . "\n");
                                echo("Bulkwrite Resource FieldMapping Index: "); print_r($fieldMapping->getIndex()); echo("\n");
                                if($fieldMapping->getFormat() != null)
                                {
                                    echo("Bulkwrite Resource FieldMapping Format: " . $fieldMapping->getFormat() . "\n");
                                }
                                if($fieldMapping->getFindBy() != null)
                                {
                                    echo("Bulkwrite Resource FieldMapping FindBy: " . $fieldMapping->getFindBy() . "\n");
                                }
                                if($fieldMapping->getModule() != null)
                                {
                                    echo("Bulkwrite Resource FieldMapping Module: "); print_r($fieldMapping->getModule()); echo("\n");
                                }
                                if($fieldMapping->getDefaultValue() != null)
                                {
                                    foreach($fieldMapping->getDefaultValue() as $key => $value)
                                    {
                                        echo($key . ": " . $value . "\n");
                                    }
                                }
                            }
                        }
                        if($resource->getFindBy() != null)
                        {
                            echo("Bulkwrite Resource FindBy: " . $resource->getFindBy() . "\n");
                        }
                        $file = $resource->getFile();
                        if($file != null)
                        {
                            echo("Bulkwrite Resource File Status: " . $file->getStatus()->getValue() . "\n");
                            echo("Bulkwrite Resource File Name: " . $file->getName() . "\n");
                            echo("Bulkwrite Resource File AddedCount: " . $file->getAddedCount() . "\n");
                            echo("Bulkwrite Resource File SkippedCount: " . $file->getSkippedCount() . "\n");
                            echo("Bulkwrite Resource File UpdatedCount: " . $file->getUpdatedCount() . "\n");
                            echo("Bulkwrite Resource File TotalCount: " . $file->getTotalCount() . "\n");
                        }
                        echo("Bulkwrite Resource Code: " . $resource->getCode() . "\n");
                    }
                }
                echo("Bulkwrite ID: " . $bulkWriteResponse->getId() . "\n");
                $callback = $bulkWriteResponse->getCallback();
                if($callback != null)
                {
                    echo("Bulkwrite Callback URL : " . $callback->getUrl() . "\n");
                     echo("Bulkwrite Method URL : " . $callback->getMethod()->getValue() . "\n");
                }
                $result = $bulkWriteResponse->getResult();
                if($result != null)
                {
                    echo("Bulkwrite DownloadUrl: " . $result->getDownloadUrl() . "\n");
                }
                $createdBy = $bulkWriteResponse->getCreatedBy();
                if($createdBy != null)
                {
                    echo("Bulkread Created By User-ID: " . $createdBy->getId() . "\n");
                    echo("Bulkread Created By User-Name: " . $createdBy->getName() . "\n");
                }
                echo("Bulkwrite Operation: " . $bulkWriteResponse->getOperation() . "\n");
                echo("Bulkwrite File CreatedTime: "); print_r($bulkWriteResponse->getCreatedTime()); echo("\n");
            }
            else if($responseWrapper instanceof APIException)
            {
                $exception = $responseWrapper;
                echo("Status: " . $exception->getStatus()->getValue() . "\n");
                echo("Code: " . $exception->getCode()->getValue() . "\n");
                if($exception->getDetails() != null)
                {
                    echo("Details: " );
                    foreach($exception->getDetails() as $key => $value)
                    {
                        echo($key . " : " . $value);
                    }
                }
                echo("Message: " . $exception->getMessage()->getValue() . "\n");
            }
        }
    }
}

GetBulkWriteJobDetails::initialize();
$jobId = "347706118196001";
GetBulkWriteJobDetails::getBulkWriteJobDetails($jobId);


 

              Copy to Clipboard
              
<?php
namespace samples\bulkwrite;

use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\bulkwrite\FileBodyWrapper;
use com\zoho\crm\api\bulkwrite\BulkWriteOperations;
use com\zoho\crm\api\bulkwrite\APIException;
require_once "vendor/autoload.php";

class DownloadBulkWriteResult
{
    public static function initialize()
    {
        $user = new UserSignature('myname@mydomain.com');
        $environment = USDataCenter::PRODUCTION();
        $token = (new OAuthBuilder())
        ->clientId("1000.xxxx")
        ->clientSecret("xxxxxx")
        ->refreshToken("1000.xxxxx.xxxxx")
        ->build();
        (new InitializeBuilder())
            ->user($user)
            ->environment($environment)
            ->token($token)
            ->initialize();
    }

    public static function downloadBulkWriteResult(string $downloadUrl, string $destinationFolder)
	{
		$bulkWriteOperations = new BulkWriteOperations();
        $response = $bulkWriteOperations->downloadBulkWriteResult($downloadUrl);
        if($response != null)
		{
            echo("Status code " . $response->getStatusCode() . "\n");
            if(in_array($response->getStatusCode(), array(204, 304)))
            {
                echo($response->getStatusCode() == 204? "No Content\n" : "Not Modified\n");
                return;
            }
            $responseHandler = $response->getObject();
            if($responseHandler instanceof FileBodyWrapper)
            {
                $fileBodyWrapper = $responseHandler;
                $streamWrapper = $fileBodyWrapper->getFile();
                //Create a file instance with the absolute_file_path
                $fp = fopen($destinationFolder."/".$streamWrapper->getName(), "w");
                $stream = $streamWrapper->getStream();
                fputs($fp, $stream);
                fclose($fp);
            }
            else if($responseHandler instanceof APIException)
            {
                $exception = $responseHandler;
                if($exception->getStatus() != null)
                {
                    echo("Status: " . $exception->getStatus()->getValue());
                }
                if($exception->getCode() != null)
                {
                    echo("Code: " . $exception->getCode()->getValue());
                }
                if($exception->getDetails() != null)
                {
                    echo("Details: " );
                    foreach($exception->getDetails() as $key => $value)
                    {
                        echo($key . ": " . $value);
                    }
                }
                if($exception->getMessage() != null)
                {
                    echo("Message: " . $exception->getMessage()->getValue());
                }
                if($exception->getXError() != null)
                {
                    echo("XError: " . $exception->getXError()->getValue());
                }
                if($exception->getXInfo() != null)
                {
                    echo("XInfo: " . $exception->getXInfo()->getValue());
                }
                if($exception->getHttpStatus() != null)
                {
                    echo("Message: " . $exception->getHttpStatus());
                }
            }
        }
    }
}

DownloadBulkWriteResult::initialize();
$downloadUrl = "https://download-accl.zoho.com/v2/crm/673573045/bulk-write/347706118196001/347706118196001.zip";
$destinationFolder = "/Documents";
DownloadBulkWriteResult::downloadBulkWriteResult($downloadUrl, $destinationFolder);