Java SDK Samples - Tags Operations
Get Tags
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Get Tags
* This method is used to get all the tags in a module.
* @param moduleAPIName - The API Name of the module to get tags.
* @throws Exception
*/
public static void getTags(String moduleAPIName) throws Exception
{
//example
//String moduleAPIName = "Leads";
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetTagsParam.MODULE, moduleAPIName);
//paramInstance.add(GetTagsParam.MY_TAGS, ""); //Displays the names of the tags created by the current user.
//Call getTags method that takes paramInstance as parameter
APIResponse response = tagsOperations.getTags(paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
if(Arrays.asList(204,304).contains(response.getStatusCode()))
{
System.out.println(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
ResponseHandler responseHandler = response.getObject();
if(responseHandler instanceof ResponseWrapper)
{
//Get the received ResponseWrapper instance
ResponseWrapper responseWrapper = (ResponseWrapper) responseHandler;
//Get the obtained ShareRecord instance
List tags = responseWrapper.getTags();
for(com.zoho.crm.api.tags.Tag tag : tags)
{
//Get the CreatedTime of each Tag
System.out.println("Tag CreatedTime: " + tag.getCreatedTime());
//Get the ModifiedTime of each Tag
System.out.println("Tag ModifiedTime: " + tag.getModifiedTime());
//Get the Name of each Tag
System.out.println("Tag Name: " + tag.getName());
//Get the modifiedBy User instance of each Tag
com.zoho.crm.api.users.User modifiedBy = tag.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null)
{
//Get the ID of the modifiedBy User
System.out.println("Tag Modified By User-ID: " + modifiedBy.getId());
//Get the name of the modifiedBy User
System.out.println("Tag Modified By User-Name: " + modifiedBy.getName());
}
//Get the ID of each Tag
System.out.println("Tag ID: " + tag.getId());
//Get the createdBy User instance of each Tag
com.zoho.crm.api.users.User createdBy = tag.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null)
{
//Get the ID of the createdBy User
System.out.println("Tag Created By User-ID: " + createdBy.getId());
//Get the name of the createdBy User
System.out.println("Tag Created By User-Name: " + createdBy.getName());
}
}
//Get the Object obtained Info instance
Info info = responseWrapper.getInfo();
//Check if info is not null
if(info != null)
{
if(info.getCount() != null)
{
//Get the Count of the Info
System.out.println("Tag Info Count: " + info.getCount().toString());
}
if(info.getAllowedCount() != null)
{
//Get the AllowedCount of the Info
System.out.println("Tag Info AllowedCount: " + info.getAllowedCount().toString());
}
}
}
//Check if the request returned an exception
else if(responseHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) responseHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Create Tags
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Create Tags
* This method is used to create new tags and print the response.
* @param moduleAPIName - The API Name of the module to create tags.
* @throws Exception
*/
public static void createTags(String moduleAPIName) throws Exception
{
//example
//String moduleAPIName = "Leads";
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(CreateTagsParam.MODULE, moduleAPIName);
//List of Tag instances
List tagList = new ArrayList();
//Get instance of Tag Class
com.zoho.crm.api.tags.Tag tag1 = new com.zoho.crm.api.tags.Tag();
tag1.setName("tagName");
tagList.add(tag1);
request.setTags(tagList);
//Call createTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse response = tagsOperations.createTags(request, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
ActionHandler actionHandler = response.getObject();
if(actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
ActionWrapper actionWrapper = (ActionWrapper) actionHandler;
//Get the list of obtained ActionResponse instances
List actionResponses = actionWrapper.getTags();
for(ActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(actionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Update Tags
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Update Tags
* This method is used to update multiple tags simultaneously and print the response.
* @param moduleAPIName - The API Name of the module to update tags.
* @throws Exception
*/
public static void updateTags(String moduleAPIName) throws Exception
{
//example
//String moduleAPIName = "Leads";
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(UpdateTagsParam.MODULE, moduleAPIName);
//List of Tag instances
List tagList = new ArrayList();
//Get instance of Tag Class
com.zoho.crm.api.tags.Tag tag1 = new com.zoho.crm.api.tags.Tag();
tag1.setId(34770619341003l);
tag1.setName("tagName123");
tagList.add(tag1);
request.setTags(tagList);
//Call updateTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse response = tagsOperations.updateTags(request, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
ActionHandler actionHandler = response.getObject();
if(actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
ActionWrapper actionWrapper = (ActionWrapper) actionHandler;
//Get the list of obtained ActionResponse instances
List actionResponses = actionWrapper.getTags();
for(ActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(actionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Update Specific Tag
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
**
* Update Tag
* This method is used to update single tag and print the response.
* @param moduleAPIName - The API Name of the module to update tag.
* @param tagId - The ID of the tag to be obtained.
* @throws Exception
*/
public static void updateTag(String moduleAPIName, Long tagId) throws Exception
{
//example
//String moduleAPIName = "Leads";
//Long tagId = 34770615794039;
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(UpdateTagParam.MODULE, moduleAPIName);
//List of Tag instances
List tagList = new ArrayList();
//Get instance of Tag Class
com.zoho.crm.api.tags.Tag tag1 = new com.zoho.crm.api.tags.Tag();
tag1.setName("tagName12345");
tagList.add(tag1);
request.setTags(tagList);
//Call updateTag method that takes tagId, paramInstance and BodyWrapper instance as parameter
APIResponse response = tagsOperations.updateTag(tagId, request, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
ActionHandler actionHandler = response.getObject();
if(actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
ActionWrapper actionWrapper = (ActionWrapper) actionHandler;
//Get the list of obtained ActionResponse instances
List actionResponses = actionWrapper.getTags();
for(ActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(actionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Delete a Tag
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Delete Tag
* This method is used to delete a tag from the module and print the response.
* @param tagId - The ID of the tag to be obtained.
* @throws Exception
*/
public static void deleteTag(Long tagId) throws Exception
{
//example
//Long tagId = 34770615794039;
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Call deleteTag method that takes tag id as parameter
APIResponse response = tagsOperations.deleteTag(tagId);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
ActionHandler actionHandler = response.getObject();
if(actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
ActionWrapper actionWrapper = (ActionWrapper) actionHandler;
//Get the list of obtained ActionResponse instances
List actionResponses = actionWrapper.getTags();
for(ActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(actionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Merge Tags
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Merge Tags
* This method is used to merge tags and put all the records under the two tags into a single tag and print the response.
* @param tagId - The ID of the tag to be obtained.
* @param conflictId - - The ID of the conflict tag to be obtained.
* @throws Exception
*/
public static void mergeTags(Long tagId, String conflictId) throws Exception
{
//example
//Long tagId = 34770615794039;
//Long conflictId = 34770615803151;
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of MergeWrapper Class that will contain the request body
MergeWrapper request = new MergeWrapper();
//List of Tag ConflictWrapper
List tags = new ArrayList();
//Get instance of ConflictWrapper Class
ConflictWrapper mergeTag = new ConflictWrapper();
mergeTag.setConflictId(conflictId);
tags.add(mergeTag);
request.setTags(tags);
//Call mergeTags method that takes tag and MergeWrapper instance id as parameter
APIResponse response = tagsOperations.mergeTags(tagId, request);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
ActionHandler actionHandler = response.getObject();
if(actionHandler instanceof ActionWrapper)
{
//Get the received ActionWrapper instance
ActionWrapper actionWrapper = (ActionWrapper) actionHandler;
//Get the list of obtained ActionResponse instances
List actionResponses = actionWrapper.getTags();
for(ActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(actionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Add Tags to a Record
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Add Tags To a Record
* This method is used to add tags to a specific record and print the response.
* @param moduleAPIName - The API Name of the module to add tag.
* @param recordId - The ID of the record to be obtained.
* @param tagNames - The names of the tags to be added.
* @throws Exception
*/
public static void addTagsToRecord(String moduleAPIName, long recordId, List tagNames) throws Exception
{
//example
//String moduleAPIName = "Leads";
//long recordId = 34770615623115L;
//ArrayList tagNames = new ArrayList(Arrays.asList("addtag1,addtag12"));
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
for(String tagName : tagNames)
{
paramInstance.add(AddTagsToRecordParam.TAG_NAMES, tagName);
}
paramInstance.add(AddTagsToRecordParam.OVER_WRITE, "false");
//Call addTagsToRecord method that takes recordId, moduleAPIName and paramInstance as parameter
APIResponse response = tagsOperations.addTagsToRecord(recordId, moduleAPIName, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
RecordActionHandler recordActionHandler = response.getObject();
if(recordActionHandler instanceof RecordActionWrapper)
{
//Get the received RecordActionWrapper instance
RecordActionWrapper recordActionWrapper = (RecordActionWrapper) recordActionHandler;
//Get the list of obtained RecordActionResponse instances
List actionResponses = recordActionWrapper.getData();
for(RecordActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(recordActionHandler instanceof APIException)
{
//Check if the request returned an exception
APIException exception = (APIException) recordActionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Remove Tags from a Record
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Remove Tags From Record
* This method is used to delete the tag associated with a specific record and print the response.
* @param moduleAPIName - The API Name of the module to remove tag.
* @param recordId - The ID of the record to be obtained.
* @param tagNames - The names of the tags to be remove.
* @throws Exception
*/
public static void removeTagsFromRecord(String moduleAPIName, long recordId, List tagNames) throws Exception
{
//example
//String moduleAPIName = "Leads";
//long recordId = 34770615623115L;
//ArrayList tagNames = new ArrayList(Arrays.asList("addtag1,addtag12"));
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
for(String tagName : tagNames)
{
paramInstance.add(RemoveTagsFromRecordParam.TAG_NAMES, tagName);
}
//Call removeTagsFromRecord method that takes recordId, moduleAPIName and paramInstance as parameter
APIResponse response = tagsOperations.removeTagsFromRecord(recordId, moduleAPIName, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
RecordActionHandler recordActionHandler = response.getObject();
if(recordActionHandler instanceof RecordActionWrapper)
{
//Get the received RecordActionWrapper instance
RecordActionWrapper recordActionWrapper = (RecordActionWrapper) recordActionHandler;
//Get the list of obtained RecordActionResponse instances
List actionResponses = recordActionWrapper.getData();
for(RecordActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
}
//Check if the request returned an exception
else if(recordActionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) recordActionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Add Tags to Multiple Records
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Add Tags To Multiple Records
* This method is used to add tags to multiple records simultaneously and print the response.
* @param moduleAPIName - The API Name of the module to add tags.
* @param recordIds - The ID of the record to be obtained.
* @param tagNames - The names of the tags to be add.
* @throws Exception
*/
public static void addTagsToMultipleRecords(String moduleAPIName, List recordIds, List tagNames) throws Exception
{
//example
//String moduleAPIName = "Leads";
//ArrayList recordIds = new ArrayList(Arrays.asList(34770615623115l, 34770616114067l));
//ArrayList tagNames = new ArrayList(Arrays.asList("addtag1,addtag12"));
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
for(String tagName : tagNames)
{
paramInstance.add(AddTagsToMultipleRecordsParam.TAG_NAMES, tagName);
}
for(Long recordId : recordIds)
{
paramInstance.add(AddTagsToMultipleRecordsParam.IDS, recordId);
}
paramInstance.add(AddTagsToMultipleRecordsParam.OVER_WRITE, "false");
//Call addTagsToMultipleRecords method that takes moduleAPIName, paramInstance as parameter
APIResponse response = tagsOperations.addTagsToMultipleRecords(moduleAPIName, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
RecordActionHandler recordActionHandler = response.getObject();
if(recordActionHandler instanceof RecordActionWrapper)
{
//Get the received RecordActionWrapper instance
RecordActionWrapper recordActionWrapper = (RecordActionWrapper) recordActionHandler;
//Get the list of obtained RecordActionResponse instances
List actionResponses = recordActionWrapper.getData();
for(RecordActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
//Check if locked count is null
if(recordActionWrapper.getLockedCount() != null)
{
System.out.println("Locked Count: " + recordActionWrapper.getLockedCount().toString());
}
//Check if success count is null
if(recordActionWrapper.getSuccessCount() != null)
{
System.out.println("Success Count: " + recordActionWrapper.getSuccessCount());
}
//Check if wf scheduler is null
if(recordActionWrapper.getWfScheduler() != null)
{
System.out.println("WF Scheduler: " + recordActionWrapper.getWfScheduler());
}
}
//Check if the request returned an exception
else if(recordActionHandler instanceof APIException)
{
//Check if the request returned an exception
APIException exception = (APIException) recordActionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Remove Tags from Multiple Records
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Remove Tags From Multiple Records
* This method is used to delete the tags associated with multiple records and print the response.
* @param moduleAPIName - The API Name of the module to remove tags.
* @param recordIds - The ID of the record to be obtained.
* @param tagNames - The names of the tags to be remove.
* @throws Exception
*/
public static void removeTagsFromMultipleRecords(String moduleAPIName, List recordIds, List tagNames) throws Exception
{
//example
//String moduleAPIName = "Leads";
//ArrayList recordIds = new ArrayList(Arrays.asList(34770615623115, 34770616114067));
//ArrayList tagNames = new ArrayList(Arrays.asList("addtag1,addtag12"));
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
ParameterMap paramInstance = new ParameterMap();
for(String tagName : tagNames)
{
paramInstance.add(RemoveTagsFromMultipleRecordsParam.TAG_NAMES, tagName);
}
for(Long recordId : recordIds)
{
paramInstance.add(RemoveTagsFromMultipleRecordsParam.IDS, recordId);
}
//Call RemoveTagsFromMultipleRecordsParam method that takes moduleAPIName, paramInstance as parameter
APIResponse response = tagsOperations.removeTagsFromMultipleRecords(moduleAPIName, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
RecordActionHandler recordActionHandler = response.getObject();
if(recordActionHandler instanceof RecordActionWrapper)
{
//Get the received RecordActionWrapper instance
RecordActionWrapper recordActionWrapper = (RecordActionWrapper) recordActionHandler;
//Get the list of obtained RecordActionResponse instances
List actionResponses = recordActionWrapper.getData();
for(RecordActionResponse actionResponse : actionResponses)
{
//Check if the request is successful
if(actionResponse instanceof SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
System.out.println("Status: " + successResponse.getStatus().getValue());
//Get the Code
System.out.println("Code: " + successResponse.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : successResponse.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + successResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) actionResponse;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
//Check if locked count is null
if(recordActionWrapper.getLockedCount() != null)
{
System.out.println("Locked Count: " + recordActionWrapper.getLockedCount().toString());
}
//Check if success count is null
if(recordActionWrapper.getSuccessCount() != null)
{
System.out.println("Success Count: " + recordActionWrapper.getSuccessCount());
}
//Check if wf scheduler is null
if(recordActionWrapper.getWfScheduler() != null)
{
System.out.println("WF Scheduler: " + recordActionWrapper.getWfScheduler());
}
}
//Check if the request returned an exception
else if(recordActionHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) recordActionHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}
Get Record Count for a Tag
package samples.src.com.zoho.crm.api.tags;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.tags.APIException;
import com.zoho.crm.api.tags.ActionHandler;
import com.zoho.crm.api.tags.ActionResponse;
import com.zoho.crm.api.tags.ActionWrapper;
import com.zoho.crm.api.tags.BodyWrapper;
import com.zoho.crm.api.tags.ConflictWrapper;
import com.zoho.crm.api.tags.CountHandler;
import com.zoho.crm.api.tags.CountWrapper;
import com.zoho.crm.api.tags.Info;
import com.zoho.crm.api.tags.MergeWrapper;
import com.zoho.crm.api.tags.RecordActionHandler;
import com.zoho.crm.api.tags.RecordActionResponse;
import com.zoho.crm.api.tags.RecordActionWrapper;
import com.zoho.crm.api.tags.ResponseHandler;
import com.zoho.crm.api.tags.ResponseWrapper;
import com.zoho.crm.api.tags.SuccessResponse;
import com.zoho.crm.api.tags.TagsOperations;
import com.zoho.crm.api.tags.TagsOperations.CreateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.GetRecordCountForTagParam;
import com.zoho.crm.api.tags.TagsOperations.GetTagsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.RemoveTagsFromRecordParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagParam;
import com.zoho.crm.api.tags.TagsOperations.UpdateTagsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToMultipleRecordsParam;
import com.zoho.crm.api.tags.TagsOperations.AddTagsToRecordParam;
import com.zoho.crm.api.util.APIResponse;
import com.zoho.crm.api.util.Model;
public class Tag
{
/**
* Get Record Count For Tag
* This method is used to get the total number of records under a tag and print the response.
* @param moduleAPIName - The API Name of the module.
* @param tagId - The ID of the tag to be obtained.
* @throws Exception
*/
public static void getRecordCountForTag(String moduleAPIName, Long tagId) throws Exception
{
//example
//String moduleAPIName = "Leads";
//Long tagId = 34770615803151l;
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetRecordCountForTagParam.MODULE, moduleAPIName);
//Call getRecordCountForTag method that takes tagId and paramInstance as parameter
APIResponse response = tagsOperations.getRecordCountForTag(tagId, paramInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
if(Arrays.asList(204,304).contains(response.getStatusCode()))
{
System.out.println(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Check if expected response is received
if(response.isExpected())
{
//Get object from response
CountHandler countHandler = response.getObject();
if(countHandler instanceof CountWrapper)
{
//Get the received CountWrapper instance
CountWrapper countWrapper = (CountWrapper) countHandler;
//Get the Count of Tag
System.out.println("Tag Count: " + countWrapper.getCount());
}
//Check if the request returned an exception
else if(countHandler instanceof APIException)
{
//Get the received APIException instance
APIException exception = (APIException) countHandler;
//Get the Status
System.out.println("Status: " + exception.getStatus().getValue());
//Get the Code
System.out.println("Code: " + exception.getCode().getValue());
System.out.println("Details: " );
//Get the details map
for(Map.Entry entry : exception.getDetails().entrySet())
{
//Get each value in the map
System.out.println(entry.getKey() + ": " + entry.getValue());
}
//Get the Message
System.out.println("Message: " + exception.getMessage().getValue());
}
}
else
{//If response is not as expected
//Get model object from response
Model responseObject = response.getModel();
//Get the response object's class
Class extends Model> clas = responseObject.getClass();
//Get all declared fields of the response class
java.lang.reflect.Field[] fields = clas.getDeclaredFields();
for(java.lang.reflect.Field field : fields)
{
//Get each value
System.out.println(field.getName() + ":" + field.get(responseObject));
}
}
}
}
}