Python SDK Samples - Records Operations
Get a Record
import os
fromimport os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def get_record(module_api_name, record_id, destination_folder):
"""
This method is used to get a single record of a module with ID and print the response.
:param module_api_name: The API Name of the record's module.
:param record_id: The ID of the record to be obtained.
:param destination_folder: The absolute path of the destination folder to store the downloaded attachment Record
"""
"""
example
module_api_name = 'Leads'
record_id = 3477061000006603276
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Get Record operation
param_instance.add(GetRecordParam.cvid, '3409643000000087501')
param_instance.add(GetRecordParam.approved, 'true')
param_instance.add(GetRecordParam.converted, 'both')
fields = ['id', 'company']
for field in fields:
param_instance.add(GetRecordParam.fields, field)
start_date_time = datetime(2020, 1, 1, 10, 10, 10)
param_instance.add(GetRecordParam.startdatetime, start_date_time)
end_date_time = datetime(2020, 7, 7, 10, 10, 10)
param_instance.add(GetRecordParam.enddatetime, end_date_time)
param_instance.add(GetRecordParam.territory_id, '3409643000000505351')
param_instance.add(GetRecordParam.include_child, 'true')
param_instance.add(GetRecordParam.uid, '3409643000000500741')
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Record operation
header_instance.add(GetRecordHeader.if_modified_since, datetime.now())
# header_instance.add(GetRecordHeader.x_external, "Leads.External")
# Call getRecord method that takes param_instance, header_instance, module_api_name and record_id as parameter
response = record_operations.get_record(record_id, module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ResponseWrapper instance is received.
if isinstance(response_object, ResponseWrapper):
# Get the list of obtained Record instances
record_list = response_object.get_data()
for record in record_list:
# Get the ID of each Record
print("Record ID: " + str(record.get_id()))
# Get the createdBy User instance of each Record
created_by = record.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Created By - ID: " + str(created_by.get_id()))
# Get the Email of the created_by User
print("Record Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record CreatedTime: " + str(record.get_created_time()))
if record.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record ModifiedTime: " + str(record.get_modified_time()))
# Get the modified_by User instance of each Record
modified_by = record.get_modified_by()
# Check if modified_by is not None
if modified_by is not None:
# Get the Name of the modified_by User
print("Record Modified By - Name: " + modified_by.get_name())
# Get the ID of the modified_by User
print("Record Modified By - ID: " + str(modified_by.get_id()))
# Get the Email of the modified_by User
print("Record Modified By - Email: " + modified_by.get_email())
# Get the list of obtained Tag instance of each Record
tags = record.get_tag()
if tags is not None:
for tag in tags:
# Get the Name of each Tag
print("Record Tag Name: " + tag.get_name())
# Get the Id of each Tag
print("Record Tag ID: " + str(tag.get_id()))
# To get particular field value
print("Record Field Value: " + str(record.get_key_value('Last_Name')))
print('Record KeyValues: ')
key_values = record.get_key_values()
for key_name, value in key_values.items():
if isinstance(value, list):
if len(value) > 0:
if isinstance(value[0], FileDetails):
file_details = value
for file_detail in file_details:
# Get the Extn of each FileDetails
print("Record FileDetails Extn: " + file_detail.get_extn())
# Get the IsPreviewAvailable of each FileDetails
print("Record FileDetails IsPreviewAvailable: " + str(file_detail.get_is_preview_available()))
# Get the DownloadUrl of each FileDetails
print("Record FileDetails DownloadUrl: " + file_detail.get_download_url())
# Get the DeleteUrl of each FileDetails
print("Record FileDetails DeleteUrl: " + file_detail.get_delete_url())
# Get the EntityId of each FileDetails
print("Record FileDetails EntityId: " + file_detail.get_entity_id())
# Get the Mode of each FileDetails
print("Record FileDetails Mode: " + file_detail.get_mode())
# Get the OriginalSizeByte of each FileDetails
print("Record FileDetails OriginalSizeByte: " + file_detail.get_original_size_byte())
# Get the PreviewUrl of each FileDetails
print("Record FileDetails PreviewUrl: " + file_detail.get_preview_url())
# Get the FileName of each FileDetails
print("Record FileDetails FileName: " + file_detail.get_file_name())
# Get the FileId of each FileDetails
print("Record FileDetails FileId: " + file_detail.get_file_id())
# Get the AttachmentId of each FileDetails
print("Record FileDetails AttachmentId: " + file_detail.get_attachment_id())
# Get the FileSize of each FileDetails
print("Record FileDetails FileSize: " + file_detail.get_file_size())
# Get the CreatorId of each FileDetails
print("Record FileDetails CreatorId: " + file_detail.get_creator_id())
# Get the LinkDocs of each FileDetails
print("Record FileDetails LinkDocs: " + file_detail.get_link_docs())
elif isinstance(value[0], Reminder):
reminders = value
for reminder in reminders:
# Get the Reminder Period
print("Reminder Period: " + reminder.get_period())
# Get the Reminder Unit
print("Reminder Unit: " + reminder.get_unit())
elif isinstance(value[0], Choice):
choice_list = value
print(key_name)
print('Values')
for choice in choice_list:
print(choice.get_value())
elif isinstance(value[0], Participants):
participants = value
for participant in participants:
print("Record Participants Name: ")
print(participant.get_name())
print("Record Participants Invited: " + str(participant.get_invited()))
print("Record Participants Type: " + participant.get_type())
print("Record Participants Participant: " + participant.get_participant())
print("Record Participants Status: " + participant.get_status())
elif isinstance(value[0], InventoryLineItems):
product_details = value
for product_detail in product_details:
line_item_product = product_detail.get_product()
if line_item_product is not None:
print("Record ProductDetails LineItemProduct ProductCode: " + line_item_product.get_product_code())
print("Record ProductDetails LineItemProduct Currency: " + line_item_product.get_currency())
print("Record ProductDetails LineItemProduct Name: " + line_item_product.get_name())
print("Record ProductDetails LineItemProduct Id: " + line_item_product.get_id())
print("Record ProductDetails Quantity: " + str(product_detail.get_quantity()))
print("Record ProductDetails Discount: " + product_detail.get_discount())
print("Record ProductDetails TotalAfterDiscount: " + str(product_detail.get_total_after_discount()))
print("Record ProductDetails NetTotal: " + str(product_detail.get_net_total()))
if product_detail.get_book() is not None:
print("Record ProductDetails Book: " + str(product_detail.get_book()))
print("Record ProductDetails Tax: " + str(product_detail.get_tax()))
print("Record ProductDetails ListPrice: " + str(product_detail.get_list_price()))
print("Record ProductDetails UnitPrice: " + str(product_detail.get_unit_price()))
print("Record ProductDetails QuantityInStock: " + str(product_detail.get_quantity_in_stock()))
print("Record ProductDetails Total: " + str(product_detail.get_total()))
print("Record ProductDetails ID: " + product_detail.get_id())
print("Record ProductDetails ProductDescription: " + product_detail.get_product_description())
line_taxes = product_detail.get_line_tax()
for line_tax in line_taxes:
print("Record ProductDetails LineTax Percentage: " + str(line_tax.get_percentage()))
print("Record ProductDetails LineTax Name: " + line_tax.get_name())
print("Record ProductDetails LineTax Id: " + line_tax.get_id())
print("Record ProductDetails LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Tag):
tags = value
if tags is not None:
for tag in tags:
print("Record Tag Name: " + tag.get_name())
print("Record Tag ID: ")
print(tag.get_id())
elif isinstance(value[0], PricingDetails):
pricing_details = value
for pricing_detail in pricing_details:
print("Record PricingDetails ToRange: " + str(pricing_detail.get_to_range()))
print("Record PricingDetails Discount: " + str(pricing_detail.get_discount()))
print("Record PricingDetails ID: " + pricing_detail.get_id())
print("Record PricingDetails FromRange: " + str(pricing_detail.get_from_range()))
elif isinstance(value[0], ZCRMRecord):
record_list = value
for each_record in record_list:
for key, val in each_record.get_key_values().items():
print(str(key) + " : " + str(val))
elif isinstance(value[0], LineTax):
line_taxes = value
for line_tax in line_taxes:
print("Record LineTax Percentage: " + str(
line_tax.get_percentage()))
print("Record LineTax Name: " + line_tax.get_name())
print("Record LineTax Id: " + line_tax.get_id())
print("Record LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Comment):
comments = value
for comment in comments:
print("Comment-ID: " + comment.get_id())
print("Comment-Content: " + comment.get_comment_content())
print("Comment-Commented_By: " + comment.get_commented_by())
print("Comment-Commented Time: " + str(comment.get_commented_time()))
elif isinstance(value[0], Attachment):
attachments = value
for attachment in attachments:
# Get the ID of each attachment
print('Record Attachment ID : ' + str(attachment.get_id()))
# Get the owner User instance of each attachment
owner = attachment.get_owner()
# Check if owner is not None
if owner is not None:
# Get the Name of the Owner
print("Record Attachment Owner - Name: " + owner.get_name())
# Get the ID of the Owner
print("Record Attachment Owner - ID: " + owner.get_id())
# Get the Email of the Owner
print("Record Attachment Owner - Email: " + owner.get_email())
# Get the modified time of each attachment
print("Record Attachment Modified Time: " + str(attachment.get_modified_time()))
# Get the name of the File
print("Record Attachment File Name: " + attachment.get_file_name())
# Get the created time of each attachment
print("Record Attachment Created Time: " + str(attachment.get_created_time()))
# Get the Attachment file size
print("Record Attachment File Size: " + str(attachment.get_size()))
# Get the parentId Record instance of each attachment
parent_id = attachment.get_parent_id()
if parent_id is not None:
# Get the parent record Name of each attachment
print(
"Record Attachment parent record Name: " + parent_id.get_key_value("name"))
# Get the parent record ID of each attachment
print("Record Attachment parent record ID: " + parent_id.get_id())
# Check if the attachment is Editable
print("Record Attachment is Editable: " + str(attachment.get_editable()))
# Get the file ID of each attachment
print("Record Attachment File ID: " + str(attachment.get_file_id()))
# Get the type of each attachment
print("Record Attachment File Type: " + str(attachment.get_type()))
# Get the seModule of each attachment
print("Record Attachment seModule: " + str(attachment.get_se_module()))
# Get the modifiedBy User instance of each attachment
modified_by = attachment.get_modified_by()
# Check if modifiedBy is not None
if modified_by is not None:
# Get the Name of the modifiedBy User
print("Record Attachment Modified By - Name: " + modified_by.get_name())
# Get the ID of the modifiedBy User
print("Record Attachment Modified By - ID: " + modified_by.get_id())
# Get the Email of the modifiedBy User
print("Record Attachment Modified By - Email: " + modified_by.get_email())
# Get the state of each attachment
print("Record Attachment State: " + attachment.get_state())
# Get the modifiedBy User instance of each attachment
created_by = attachment.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the modifiedBy User
print("Record Attachment Created By - Name: " + created_by.get_name())
# Get the ID of the modifiedBy User
print("Record Attachment Created By - ID: " + created_by.get_id())
# Get the Email of the modifiedBy User
print("Record Attachment Created By - Email: " + created_by.get_email())
# Get the linkUrl of each attachment
print("Record Attachment LinkUrl: " + str(attachment.get_link_url()))
else:
print(key_name)
for each_value in value:
print(str(each_value))
elif isinstance(value, User):
print("Record " + key_name + " User-ID: " + str(value.get_id()))
print("Record " + key_name + " User-Name: " + value.get_name())
print("Record " + key_name + " User-Email: " + value.get_email())
elif isinstance(value, Layout):
print(key_name + " ID: " + str(value.get_id()))
print(key_name + " Name: " + value.get_name())
elif isinstance(value, ZCRMRecord):
print(key_name + " Record ID: " + str(value.get_id()))
print(key_name + " Record Name: " + value.get_key_value('name'))
elif isinstance(value, Choice):
print(key_name + " : " + value.get_value())
elif isinstance(value, RemindAt):
print(key_name + " : " + value.get_alarm())
elif isinstance(value, RecurringActivity):
print(key_name)
print("RRULE: " + value.get_rrule())
elif isinstance(value, Consent):
print("Record Consent ID: " + str(value.get_id()))
# Get the createdBy User instance of each Record
created_by = value.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Consent Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Consent Created By - ID: " + created_by.get_id())
# Get the Email of the created_by User
print("Record Consent Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record Consent CreatedTime: " + str(value.get_created_time()))
if value.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record Consent ModifiedTime: " + str(value.get_modified_time()))
# Get the Owner User instance of the Consent
owner = value.get_owner()
if owner is not None:
# Get the Name of the Owner User
print("Record Consent Created By - Name: " + owner.get_name())
# Get the ID of the Owner User
print("Record Consent Created By - ID: " + owner.get_id())
# Get the Email of the Owner User
print("Record Consent Created By - Email: " + owner.get_email())
print("Record Consent ContactThroughEmail: " + str(value.get_contact_through_email()))
print("Record Consent ContactThroughSocial: " + str(value.get_contact_through_social()))
print("Record Consent ContactThroughSurvey: " + str(value.get_contact_through_survey()))
print("Record Consent ContactThroughPhone: " + str(value.get_contact_through_phone()))
print("Record Consent MailSentTime: " + str(value.get_mail_sent_time()))
print("Record Consent ConsentDate: " + str(value.get_consent_date()))
print("Record Consent ConsentRemarks: " + value.get_consent_remarks())
print("Record Consent ConsentThrough: " + value.get_consent_through())
print("Record Consent DataProcessingBasis: " + value.get_data_processing_basis())
# To get custom values
print("Record Consent Lawful Reason: " + str(value.get_key_value("Lawful_Reason")))
elif isinstance(value, dict):
for key, val in value.items():
print(key + " : " + str(val))
else:
print(key_name + " : " + str(value))
# Check if expected FileBodyWrapper instance is received.
elif isinstance(response_object, FileBodyWrapper):
# Get StreamWrapper instance from the returned FileBodyWrapper instance
stream_wrapper = response_object.get_file()
# Construct the file name by joining the destinationFolder and the name from StreamWrapper instance
file_name = os.path.join(destination_folder, stream_wrapper.get_name())
# Open the destination file where the file needs to be written in 'wb' mode
with open(file_name, 'wb') as f:
# Get the stream from StreamWrapper instance
for chunk in stream_wrapper.get_stream():
f.write(chunk)
f.close()
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Update a Record
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def update_record(module_api_name, record_id):
"""
This method is used to update a single record of a module with ID and print the response.
:param module_api_name: The API Name of the record's module.
:param record_id: The ID of the record to be updated
"""
"""
example
module_api_name = 'Leads'
record_id = 3477061000006603276
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Record instances
records_list = []
# Get instance of Record Class
record = ZCRMRecord()
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record.add_field_value(Field.Leads.last_name(), 'Python SDK')
record.add_field_value(Field.Leads.first_name(), 'New')
record.add_field_value(Field.Leads.company(), 'Zoho')
record.add_field_value(Field.Leads.city(), 'City')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record.add_key_value('Custom_field', 'Value')
record.add_key_value('Custom_field_2', 12)
record.add_key_value('Date_1', date(2020, 4, 9))
record.add_key_value('Discounted', 23.34)
file_details = []
file_detail = FileDetails()
file_detail.set_file_id('479f0f5eebf0fb982f99e3832b35d23e29f67c2868ee4c789f22579895383c8')
file_details.append(file_detail)
record.add_key_value('File_Upload', file_details)
# Used when GDPR is enabled
data_consent = Consent()
data_consent.set_consent_remarks("Approved.")
data_consent.set_consent_through('Email')
data_consent.set_contact_through_email(True)
data_consent.set_contact_through_social(False)
record.add_key_value('Data_Processing_Basis_Details', data_consent)
# Add Record instance to the list
records_list.append(record)
# Set the list to data in BodyWrapper instance
request.set_data(records_list)
trigger = ["approval", "workflow", "blueprint"]
# Set the list containing the trigger operations to be run
request.set_trigger(trigger)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Record operation
# header_instance.add(UpdateRecordHeader.x_external, "Leads.External")
# Call updateRecord method that takes BodyWrapper instance, module_api_name and record_id as parameter.
response = record_operations.update_record(record_id, module_api_name, request, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Delete a Record
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def delete_record(module_api_name, record_id):
"""
This method is used to delete a single record of a module with ID and print the response.
:param module_api_name: The API Name of the record's module.
:param record_id: The ID of the record to be deleted
"""
"""
example
module_api_name = 'Leads'
record_id = 3477061000006603276
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Delete Record operation
param_instance.add(DeleteRecordParam.wf_trigger, True)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Record operation
# header_instance.add(UpdateRecordHeader.x_external, "Leads.External")
# Call deleteRecord method that takes param_instance, module_api_name and record_id as parameter.
response = record_operations.delete_record(record_id, module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Get Record Using External ID
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def get_record_using_external_id(module_api_name, external_field_value, destination_folder):
"""
This method is used to get a single record of a module with external_field_value and print the response.
:param module_api_name: The API Name of the record's module.
:param external_field_value:
:param destination_folder: The absolute path of the destination folder to store the downloaded attachment Record
"""
"""
example
module_api_name = 'Leads'
external_field_value = "3477061000006603276"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Get Record operation
param_instance.add(GetRecordUsingExternalIDParam.cvid, '3409643000000087501')
param_instance.add(GetRecordUsingExternalIDParam.approved, 'true')
param_instance.add(GetRecordUsingExternalIDParam.converted, 'both')
fields = ['id', 'company']
for field in fields:
param_instance.add(GetRecordUsingExternalIDParam.fields, field)
start_date_time = datetime(2020, 1, 1, 10, 10, 10)
param_instance.add(GetRecordUsingExternalIDParam.startdatetime, start_date_time)
end_date_time = datetime(2020, 7, 7, 10, 10, 10)
param_instance.add(GetRecordUsingExternalIDParam.enddatetime, end_date_time)
param_instance.add(GetRecordUsingExternalIDParam.territory_id, '3409643000000505351')
param_instance.add(GetRecordUsingExternalIDParam.include_child, 'true')
param_instance.add(GetRecordUsingExternalIDParam.uid, '3409643000000500741')
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Record operation
header_instance.add(GetRecordUsingExternalIDHeader.if_modified_since, datetime.now())
header_instance.add(GetRecordUsingExternalIDHeader.x_external, "Leads.External")
# Call get_record_using_external_id method that takes external_field_value, module_api_name, param_instance
# and header_instance as parameter
response = record_operations.get_record_using_external_id(external_field_value, module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ResponseWrapper instance is received.
if isinstance(response_object, ResponseWrapper):
# Get the list of obtained Record instances
record_list = response_object.get_data()
for record in record_list:
# Get the ID of each Record
print("Record ID: " + str(record.get_id()))
# Get the createdBy User instance of each Record
created_by = record.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Created By - ID: " + str(created_by.get_id()))
# Get the Email of the created_by User
print("Record Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record CreatedTime: " + str(record.get_created_time()))
if record.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record ModifiedTime: " + str(record.get_modified_time()))
# Get the modified_by User instance of each Record
modified_by = record.get_modified_by()
# Check if modified_by is not None
if modified_by is not None:
# Get the Name of the modified_by User
print("Record Modified By - Name: " + modified_by.get_name())
# Get the ID of the modified_by User
print("Record Modified By - ID: " + str(modified_by.get_id()))
# Get the Email of the modified_by User
print("Record Modified By - Email: " + modified_by.get_email())
# Get the list of obtained Tag instance of each Record
tags = record.get_tag()
if tags is not None:
for tag in tags:
# Get the Name of each Tag
print("Record Tag Name: " + tag.get_name())
# Get the Id of each Tag
print("Record Tag ID: " + str(tag.get_id()))
# To get particular field value
print("Record Field Value: " + str(record.get_key_value('Last_Name')))
print('Record KeyValues: ')
key_values = record.get_key_values()
for key_name, value in key_values.items():
if isinstance(value, list):
if len(value) > 0:
if isinstance(value[0], FileDetails):
file_details = value
for file_detail in file_details:
# Get the Extn of each FileDetails
print("Record FileDetails Extn: " + file_detail.get_extn())
# Get the IsPreviewAvailable of each FileDetails
print("Record FileDetails IsPreviewAvailable: " + str(file_detail.get_is_preview_available()))
# Get the DownloadUrl of each FileDetails
print("Record FileDetails DownloadUrl: " + file_detail.get_download_url())
# Get the DeleteUrl of each FileDetails
print("Record FileDetails DeleteUrl: " + file_detail.get_delete_url())
# Get the EntityId of each FileDetails
print("Record FileDetails EntityId: " + file_detail.get_entity_id())
# Get the Mode of each FileDetails
print("Record FileDetails Mode: " + file_detail.get_mode())
# Get the OriginalSizeByte of each FileDetails
print("Record FileDetails OriginalSizeByte: " + file_detail.get_original_size_byte())
# Get the PreviewUrl of each FileDetails
print("Record FileDetails PreviewUrl: " + file_detail.get_preview_url())
# Get the FileName of each FileDetails
print("Record FileDetails FileName: " + file_detail.get_file_name())
# Get the FileId of each FileDetails
print("Record FileDetails FileId: " + file_detail.get_file_id())
# Get the AttachmentId of each FileDetails
print("Record FileDetails AttachmentId: " + file_detail.get_attachment_id())
# Get the FileSize of each FileDetails
print("Record FileDetails FileSize: " + file_detail.get_file_size())
# Get the CreatorId of each FileDetails
print("Record FileDetails CreatorId: " + file_detail.get_creator_id())
# Get the LinkDocs of each FileDetails
print("Record FileDetails LinkDocs: " + file_detail.get_link_docs())
elif isinstance(value[0], Reminder):
reminders = value
for reminder in reminders:
# Get the Reminder Period
print("Reminder Period: " + reminder.get_period())
# Get the Reminder Unit
print("Reminder Unit: " + reminder.get_unit())
elif isinstance(value[0], Choice):
choice_list = value
print(key_name)
print('Values')
for choice in choice_list:
print(choice.get_value())
elif isinstance(value[0], Participants):
participants = value
for participant in participants:
print("Record Participants Name: ")
print(participant.get_name())
print("Record Participants Invited: " + str(participant.get_invited()))
print("Record Participants Type: " + participant.get_type())
print("Record Participants Participant: " + participant.get_participant())
print("Record Participants Status: " + participant.get_status())
elif isinstance(value[0], InventoryLineItems):
product_details = value
for product_detail in product_details:
line_item_product = product_detail.get_product()
if line_item_product is not None:
print("Record ProductDetails LineItemProduct ProductCode: " + line_item_product.get_product_code())
print("Record ProductDetails LineItemProduct Currency: " + line_item_product.get_currency())
print("Record ProductDetails LineItemProduct Name: " + line_item_product.get_name())
print("Record ProductDetails LineItemProduct Id: " + line_item_product.get_id())
print("Record ProductDetails Quantity: " + str(product_detail.get_quantity()))
print("Record ProductDetails Discount: " + product_detail.get_discount())
print("Record ProductDetails TotalAfterDiscount: " + str(product_detail.get_total_after_discount()))
print("Record ProductDetails NetTotal: " + str(product_detail.get_net_total()))
if product_detail.get_book() is not None:
print("Record ProductDetails Book: " + str(product_detail.get_book()))
print("Record ProductDetails Tax: " + str(product_detail.get_tax()))
print("Record ProductDetails ListPrice: " + str(product_detail.get_list_price()))
print("Record ProductDetails UnitPrice: " + str(product_detail.get_unit_price()))
print("Record ProductDetails QuantityInStock: " + str(product_detail.get_quantity_in_stock()))
print("Record ProductDetails Total: " + str(product_detail.get_total()))
print("Record ProductDetails ID: " + product_detail.get_id())
print("Record ProductDetails ProductDescription: " + product_detail.get_product_description())
line_taxes = product_detail.get_line_tax()
for line_tax in line_taxes:
print("Record ProductDetails LineTax Percentage: " + str(line_tax.get_percentage()))
print("Record ProductDetails LineTax Name: " + line_tax.get_name())
print("Record ProductDetails LineTax Id: " + line_tax.get_id())
print("Record ProductDetails LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Tag):
tags = value
if tags is not None:
for tag in tags:
print("Record Tag Name: " + tag.get_name())
print("Record Tag ID: ")
print(tag.get_id())
elif isinstance(value[0], PricingDetails):
pricing_details = value
for pricing_detail in pricing_details:
print("Record PricingDetails ToRange: " + str(pricing_detail.get_to_range()))
print("Record PricingDetails Discount: " + str(pricing_detail.get_discount()))
print("Record PricingDetails ID: " + pricing_detail.get_id())
print("Record PricingDetails FromRange: " + str(pricing_detail.get_from_range()))
elif isinstance(value[0], ZCRMRecord):
record_list = value
for each_record in record_list:
for key, val in each_record.get_key_values().items():
print(str(key) + " : " + str(val))
elif isinstance(value[0], LineTax):
line_taxes = value
for line_tax in line_taxes:
print("Record LineTax Percentage: " + str(
line_tax.get_percentage()))
print("Record LineTax Name: " + line_tax.get_name())
print("Record LineTax Id: " + line_tax.get_id())
print("Record LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Comment):
comments = value
for comment in comments:
print("Comment-ID: " + comment.get_id())
print("Comment-Content: " + comment.get_comment_content())
print("Comment-Commented_By: " + comment.get_commented_by())
print("Comment-Commented Time: " + str(comment.get_commented_time()))
elif isinstance(value[0], Attachment):
attachments = value
for attachment in attachments:
# Get the ID of each attachment
print('Record Attachment ID : ' + str(attachment.get_id()))
# Get the owner User instance of each attachment
owner = attachment.get_owner()
# Check if owner is not None
if owner is not None:
# Get the Name of the Owner
print("Record Attachment Owner - Name: " + owner.get_name())
# Get the ID of the Owner
print("Record Attachment Owner - ID: " + owner.get_id())
# Get the Email of the Owner
print("Record Attachment Owner - Email: " + owner.get_email())
# Get the modified time of each attachment
print("Record Attachment Modified Time: " + str(attachment.get_modified_time()))
# Get the name of the File
print("Record Attachment File Name: " + attachment.get_file_name())
# Get the created time of each attachment
print("Record Attachment Created Time: " + str(attachment.get_created_time()))
# Get the Attachment file size
print("Record Attachment File Size: " + str(attachment.get_size()))
# Get the parentId Record instance of each attachment
parent_id = attachment.get_parent_id()
if parent_id is not None:
# Get the parent record Name of each attachment
print(
"Record Attachment parent record Name: " + parent_id.get_key_value("name"))
# Get the parent record ID of each attachment
print("Record Attachment parent record ID: " + parent_id.get_id())
# Check if the attachment is Editable
print("Record Attachment is Editable: " + str(attachment.get_editable()))
# Get the file ID of each attachment
print("Record Attachment File ID: " + str(attachment.get_file_id()))
# Get the type of each attachment
print("Record Attachment File Type: " + str(attachment.get_type()))
# Get the seModule of each attachment
print("Record Attachment seModule: " + str(attachment.get_se_module()))
# Get the modifiedBy User instance of each attachment
modified_by = attachment.get_modified_by()
# Check if modifiedBy is not None
if modified_by is not None:
# Get the Name of the modifiedBy User
print("Record Attachment Modified By - Name: " + modified_by.get_name())
# Get the ID of the modifiedBy User
print("Record Attachment Modified By - ID: " + modified_by.get_id())
# Get the Email of the modifiedBy User
print("Record Attachment Modified By - Email: " + modified_by.get_email())
# Get the state of each attachment
print("Record Attachment State: " + attachment.get_state())
# Get the modifiedBy User instance of each attachment
created_by = attachment.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the modifiedBy User
print("Record Attachment Created By - Name: " + created_by.get_name())
# Get the ID of the modifiedBy User
print("Record Attachment Created By - ID: " + created_by.get_id())
# Get the Email of the modifiedBy User
print("Record Attachment Created By - Email: " + created_by.get_email())
# Get the linkUrl of each attachment
print("Record Attachment LinkUrl: " + str(attachment.get_link_url()))
else:
print(key_name)
for each_value in value:
print(str(each_value))
elif isinstance(value, User):
print("Record " + key_name + " User-ID: " + str(value.get_id()))
print("Record " + key_name + " User-Name: " + value.get_name())
print("Record " + key_name + " User-Email: " + value.get_email())
elif isinstance(value, Layout):
print(key_name + " ID: " + str(value.get_id()))
print(key_name + " Name: " + value.get_name())
elif isinstance(value, ZCRMRecord):
print(key_name + " Record ID: " + str(value.get_id()))
print(key_name + " Record Name: " + value.get_key_value('name'))
elif isinstance(value, Choice):
print(key_name + " : " + value.get_value())
elif isinstance(value, RemindAt):
print(key_name + " : " + value.get_alarm())
elif isinstance(value, RecurringActivity):
print(key_name)
print("RRULE: " + value.get_rrule())
elif isinstance(value, Consent):
print("Record Consent ID: " + str(value.get_id()))
# Get the createdBy User instance of each Record
created_by = value.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Consent Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Consent Created By - ID: " + created_by.get_id())
# Get the Email of the created_by User
print("Record Consent Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record Consent CreatedTime: " + str(value.get_created_time()))
if value.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record Consent ModifiedTime: " + str(value.get_modified_time()))
# Get the Owner User instance of the Consent
owner = value.get_owner()
if owner is not None:
# Get the Name of the Owner User
print("Record Consent Created By - Name: " + owner.get_name())
# Get the ID of the Owner User
print("Record Consent Created By - ID: " + owner.get_id())
# Get the Email of the Owner User
print("Record Consent Created By - Email: " + owner.get_email())
print("Record Consent ContactThroughEmail: " + str(value.get_contact_through_email()))
print("Record Consent ContactThroughSocial: " + str(value.get_contact_through_social()))
print("Record Consent ContactThroughSurvey: " + str(value.get_contact_through_survey()))
print("Record Consent ContactThroughPhone: " + str(value.get_contact_through_phone()))
print("Record Consent MailSentTime: " + str(value.get_mail_sent_time()))
print("Record Consent ConsentDate: " + str(value.get_consent_date()))
print("Record Consent ConsentRemarks: " + value.get_consent_remarks())
print("Record Consent ConsentThrough: " + value.get_consent_through())
print("Record Consent DataProcessingBasis: " + value.get_data_processing_basis())
# To get custom values
print("Record Consent Lawful Reason: " + str(value.get_key_value("Lawful_Reason")))
elif isinstance(value, dict):
for key, val in value.items():
print(key + " : " + str(val))
else:
print(key_name + " : " + str(value))
# Check if expected FileBodyWrapper instance is received.
elif isinstance(response_object, FileBodyWrapper):
# Get StreamWrapper instance from the returned FileBodyWrapper instance
stream_wrapper = response_object.get_file()
# Construct the file name by joining the destinationFolder and the name from StreamWrapper instance
file_name = os.path.join(destination_folder, stream_wrapper.get_name())
# Open the destination file where the file needs to be written in 'wb' mode
with open(file_name, 'wb') as f:
# Get the stream from StreamWrapper instance
for chunk in stream_wrapper.get_stream():
f.write(chunk)
f.close()
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Update Record Using External ID
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def update_record_using_external_id(module_api_name, external_field_value):
"""
This method is used to update a single record of a module with ID and print the response.
:param module_api_name: The API Name of the record's module.
:param external_field_value:
"""
"""
example
module_api_name = 'Leads'
external_field_value = '3477061000006603276'
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Record instances
records_list = []
# Get instance of Record Class
record = ZCRMRecord()
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record.add_field_value(Field.Leads.last_name(), 'Python SDK')
record.add_field_value(Field.Leads.first_name(), 'New')
record.add_field_value(Field.Leads.company(), 'Zoho')
record.add_field_value(Field.Leads.city(), 'City')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record.add_key_value('Custom_field', 'Value')
record.add_key_value('Custom_field_2', 12)
record.add_key_value('Date_1', date(2020, 4, 9))
record.add_key_value('Discounted', 23.34)
file_details = []
file_detail = FileDetails()
file_detail.set_file_id('479f0f5eebf0fb982f99e3832b35d23e29f67c2868ee4c789f22579895383c8')
file_details.append(file_detail)
record.add_key_value('File_Upload', file_details)
# Used when GDPR is enabled
data_consent = Consent()
data_consent.set_consent_remarks("Approved.")
data_consent.set_consent_through('Email')
data_consent.set_contact_through_email(True)
data_consent.set_contact_through_social(False)
record.add_key_value('Data_Processing_Basis_Details', data_consent)
# Add Record instance to the list
records_list.append(record)
# Set the list to data in BodyWrapper instance
request.set_data(records_list)
trigger = ["approval", "workflow", "blueprint"]
# Set the list containing the trigger operations to be run
request.set_trigger(trigger)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Record operation
header_instance.add(UpdateRecordUsingExternalIDHeader.x_external, "Leads.External")
# Call update_record_using_external_id method that takes external_field_value, module_api_name, BodyWrapper instance and header_instance as parameter.
response = record_operations.update_record_using_external_id(external_field_value, module_api_name, request, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Delete Record Using External ID
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def delete_record_using_external_id(module_api_name, external_field_value):
"""
This method is used to delete a single record of a module with ID and print the response.
:param module_api_name: The API Name of the record's module.
:param external_field_value:
"""
"""
example
module_api_name = 'Leads'
external_field_value = '3477061000006603276'
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Delete Record operation
param_instance.add(DeleteRecordUsingExternalIDParam.wf_trigger, True)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Record operation
header_instance.add(DeleteRecordUsingExternalIDHeader.x_external, "Leads.External")
# Call delete_record_using_external_id method that takes external_field_value, module_api_name,
# param_instance and header_instance as parameter.
response = record_operations.delete_record_using_external_id(external_field_value, module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Get All Records of a Module
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def get_records(module_api_name):
"""
This method is used to get all the records of a module and print the response.
:param module_api_name: The API Name of the module to fetch records
"""
"""
example
module_api_name = 'Leads'
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
ids = ["LeadsExternal", "3477061000004352001"]
# Possible parameters for Get Records operation
param_instance.add(GetRecordsParam.page, 1)
param_instance.add(GetRecordsParam.per_page, 120)
param_instance.add(GetRecordsParam.approved, 'both')
param_instance.add(GetRecordsParam.converted, 'both')
param_instance.add(GetRecordsParam.cvid, '3409643000000087501')
for each_id in ids:
param_instance.add(GetRecordsParam.ids, each_id)
param_instance.add(GetRecordsParam.uid, '3409643000000302031')
field_names = ["Company", "Email"]
for field in field_names:
param_instance.add(GetRecordsParam.fields, field)
param_instance.add(GetRecordsParam.sort_by, 'Email')
param_instance.add(GetRecordsParam.sort_order, 'desc')
start_date_time = datetime(2020, 1, 1, 0, 0, 0)
param_instance.add(GetRecordsParam.startdatetime, start_date_time)
end_date_time = datetime(2020, 7, 1, 0, 0, 0)
param_instance.add(GetRecordsParam.enddatetime, end_date_time)
param_instance.add(GetRecordsParam.territory_id, '3409643000000505351')
param_instance.add(GetRecordsParam.include_child, "true")
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Records operation
header_instance.add(GetRecordsHeader.if_modified_since, datetime.fromisoformat('2020-01-01T00:00:00+05:30'))
# header_instance.add(GetRecordsHeader.x_external, "Leads.External")
# Call get_records method that takes ParameterMap Instance, HeaderMap Instance and module_api_name as parameters
response = record_operations.get_records(module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ResponseWrapper instance is received.
if isinstance(response_object, ResponseWrapper):
# Get the list of obtained Record instances
record_list = response_object.get_data()
for record in record_list:
# Get the ID of each Record
print("Record ID: " + str(record.get_id()))
# Get the createdBy User instance of each Record
created_by = record.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Created By - ID: " + str(created_by.get_id()))
# Get the Email of the created_by User
print("Record Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record CreatedTime: " + str(record.get_created_time()))
if record.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record ModifiedTime: " + str(record.get_modified_time()))
# Get the modified_by User instance of each Record
modified_by = record.get_modified_by()
# Check if modified_by is not None
if modified_by is not None:
# Get the Name of the modified_by User
print("Record Modified By - Name: " + modified_by.get_name())
# Get the ID of the modified_by User
print("Record Modified By - ID: " + str(modified_by.get_id()))
# Get the Email of the modified_by User
print("Record Modified By - Email: " + modified_by.get_email())
# Get the list of obtained Tag instance of each Record
tags = record.get_tag()
if tags is not None:
for tag in tags:
# Get the Name of each Tag
print("Record Tag Name: " + tag.get_name())
# Get the Id of each Tag
print("Record Tag ID: " + str(tag.get_id()))
# To get particular field value
print("Record Field Value: " + str(record.get_key_value('Last_Name')))
print('Record KeyValues: ')
key_values = record.get_key_values()
for key_name, value in key_values.items():
if isinstance(value, list):
if len(value) > 0:
if isinstance(value[0], FileDetails):
file_details = value
for file_detail in file_details:
# Get the Extn of each FileDetails
print("Record FileDetails Extn: " + file_detail.get_extn())
# Get the IsPreviewAvailable of each FileDetails
print("Record FileDetails IsPreviewAvailable: " + str(file_detail.get_is_preview_available()))
# Get the DownloadUrl of each FileDetails
print("Record FileDetails DownloadUrl: " + file_detail.get_download_url())
# Get the DeleteUrl of each FileDetails
print("Record FileDetails DeleteUrl: " + file_detail.get_delete_url())
# Get the EntityId of each FileDetails
print("Record FileDetails EntityId: " + file_detail.get_entity_id())
# Get the Mode of each FileDetails
print("Record FileDetails Mode: " + file_detail.get_mode())
# Get the OriginalSizeByte of each FileDetails
print("Record FileDetails OriginalSizeByte: " + file_detail.get_original_size_byte())
# Get the PreviewUrl of each FileDetails
print("Record FileDetails PreviewUrl: " + file_detail.get_preview_url())
# Get the FileName of each FileDetails
print("Record FileDetails FileName: " + file_detail.get_file_name())
# Get the FileId of each FileDetails
print("Record FileDetails FileId: " + file_detail.get_file_id())
# Get the AttachmentId of each FileDetails
print("Record FileDetails AttachmentId: " + file_detail.get_attachment_id())
# Get the FileSize of each FileDetails
print("Record FileDetails FileSize: " + file_detail.get_file_size())
# Get the CreatorId of each FileDetails
print("Record FileDetails CreatorId: " + file_detail.get_creator_id())
# Get the LinkDocs of each FileDetails
print("Record FileDetails LinkDocs: " + file_detail.get_link_docs())
elif isinstance(value[0], Reminder):
reminders = value
for reminder in reminders:
# Get the Reminder Period
print("Reminder Period: " + reminder.get_period())
# Get the Reminder Unit
print("Reminder Unit: " + reminder.get_unit())
elif isinstance(value[0], Choice):
choice_list = value
print(key_name)
print('Values')
for choice in choice_list:
print(choice.get_value())
elif isinstance(value[0], Participants):
participants = value
for participant in participants:
if participant is not None:
print("Record Participants Name: ")
print(participant.get_name())
print("Record Participants Invited: " + str(participant.get_invited()))
print("Record Participants Type: " + participant.get_type())
print("Record Participants Participant: " + participant.get_participant())
print("Record Participants Status: " + participant.get_status())
elif isinstance(value[0], InventoryLineItems):
product_details = value
for product_detail in product_details:
line_item_product = product_detail.get_product()
if line_item_product is not None:
print("Record ProductDetails LineItemProduct ProductCode: " + str(line_item_product.get_product_code()))
print("Record ProductDetails LineItemProduct Currency: " + str(line_item_product.get_currency()))
print("Record ProductDetails LineItemProduct Name: " + str(line_item_product.get_name()))
print("Record ProductDetails LineItemProduct Id: " + str(line_item_product.get_id()))
print("Record ProductDetails Quantity: " + str(product_detail.get_quantity()))
print("Record ProductDetails Discount: " + str(product_detail.get_discount()))
print("Record ProductDetails TotalAfterDiscount: " + str(product_detail.get_total_after_discount()))
print("Record ProductDetails NetTotal: " + str(product_detail.get_net_total()))
if product_detail.get_book() is not None:
print("Record ProductDetails Book: " + str(product_detail.get_book()))
print("Record ProductDetails Tax: " + str(product_detail.get_tax()))
print("Record ProductDetails ListPrice: " + str(product_detail.get_list_price()))
print("Record ProductDetails UnitPrice: " + str(product_detail.get_unit_price()))
print("Record ProductDetails QuantityInStock: " + str(product_detail.get_quantity_in_stock()))
print("Record ProductDetails Total: " + str(product_detail.get_total()))
print("Record ProductDetails ID: " + str(product_detail.get_id()))
print("Record ProductDetails ProductDescription: " + str(product_detail.get_product_description()))
line_taxes = product_detail.get_line_tax()
for line_tax in line_taxes:
print("Record ProductDetails LineTax Percentage: " + str(line_tax.get_percentage()))
print("Record ProductDetails LineTax Name: " + line_tax.get_name())
print("Record ProductDetails LineTax Id: " + str(line_tax.get_id()))
print("Record ProductDetails LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Tag):
tags = value
if tags is not None:
for tag in tags:
print("Record Tag Name: " + tag.get_name())
print("Record Tag ID: " + str(tag.get_id()))
elif isinstance(value[0], PricingDetails):
pricing_details = value
for pricing_detail in pricing_details:
print("Record PricingDetails ToRange: " + str(pricing_detail.get_to_range()))
print("Record PricingDetails Discount: " + str(pricing_detail.get_discount()))
print("Record PricingDetails ID: ")
print(pricing_detail.get_id())
print("Record PricingDetails FromRange: " + str(pricing_detail.get_from_range()))
elif isinstance(value[0], ZCRMRecord):
record_list = value
for each_record in record_list:
for key, val in each_record.get_key_values().items():
print(str(key) + " : " + str(val))
elif isinstance(value[0], LineTax):
line_taxes = value
for line_tax in line_taxes:
print("Record LineTax Percentage: " + str(
line_tax.get_percentage()))
print("Record LineTax Name: " + line_tax.get_name())
print("Record LineTax Id: " + str(line_tax.get_id()))
print("Record LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Comment):
comments = value
for comment in comments:
print("Comment-ID: " + str(comment.get_id()))
print("Comment-Content: " + str(comment.get_comment_content()))
print("Comment-Commented_By: " + str(comment.get_commented_by()))
print("Comment-Commented Time: " + str(comment.get_commented_time()))
elif isinstance(value[0], Attachment):
attachments = value
for attachment in attachments:
# Get the ID of each attachment
print('Record Attachment ID : ' + str(attachment.get_id()))
# Get the owner User instance of each attachment
owner = attachment.get_owner()
# Check if owner is not None
if owner is not None:
# Get the Name of the Owner
print("Record Attachment Owner - Name: " + owner.get_name())
# Get the ID of the Owner
print("Record Attachment Owner - ID: " + owner.get_id())
# Get the Email of the Owner
print("Record Attachment Owner - Email: " + owner.get_email())
# Get the modified time of each attachment
print("Record Attachment Modified Time: " + str(attachment.get_modified_time()))
# Get the name of the File
print("Record Attachment File Name: " + attachment.get_file_name())
# Get the created time of each attachment
print("Record Attachment Created Time: " + str(attachment.get_created_time()))
# Get the Attachment file size
print("Record Attachment File Size: " + str(attachment.get_size()))
# Get the parentId Record instance of each attachment
parent_id = attachment.get_parent_id()
if parent_id is not None:
# Get the parent record Name of each attachment
print(
"Record Attachment parent record Name: " + parent_id.get_key_value("name"))
# Get the parent record ID of each attachment
print("Record Attachment parent record ID: " + parent_id.get_id())
# Check if the attachment is Editable
print("Record Attachment is Editable: " + str(attachment.get_editable()))
# Get the file ID of each attachment
print("Record Attachment File ID: " + str(attachment.get_file_id()))
# Get the type of each attachment
print("Record Attachment File Type: " + str(attachment.get_type()))
# Get the seModule of each attachment
print("Record Attachment seModule: " + str(attachment.get_se_module()))
# Get the modifiedBy User instance of each attachment
modified_by = attachment.get_modified_by()
# Check if modifiedBy is not None
if modified_by is not None:
# Get the Name of the modifiedBy User
print("Record Attachment Modified By - Name: " + modified_by.get_name())
# Get the ID of the modifiedBy User
print("Record Attachment Modified By - ID: " + modified_by.get_id())
# Get the Email of the modifiedBy User
print("Record Attachment Modified By - Email: " + modified_by.get_email())
# Get the state of each attachment
print("Record Attachment State: " + attachment.get_state())
# Get the modifiedBy User instance of each attachment
created_by = attachment.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the modifiedBy User
print("Record Attachment Created By - Name: " + created_by.get_name())
# Get the ID of the modifiedBy User
print("Record Attachment Created By - ID: " + created_by.get_id())
# Get the Email of the modifiedBy User
print("Record Attachment Created By - Email: " + created_by.get_email())
# Get the linkUrl of each attachment
print("Record Attachment LinkUrl: " + str(attachment.get_link_url()))
else:
print(key_name)
for each_value in value:
print(str(each_value))
elif isinstance(value, User):
print("Record " + key_name + " User-ID: " + str(value.get_id()))
print("Record " + key_name + " User-Name: " + value.get_name())
print("Record " + key_name + " User-Email: " + value.get_email())
elif isinstance(value, Layout):
print(key_name + " ID: " + str(value.get_id()))
print(key_name + " Name: " + value.get_name())
elif isinstance(value, ZCRMRecord):
print(key_name + " Record ID: " + str(value.get_id()))
print(key_name + " Record Name: " + value.get_key_value('name'))
elif isinstance(value, Choice):
print(key_name + " : " + value.get_value())
elif isinstance(value, RemindAt):
print(key_name + " : " + value.get_alarm())
elif isinstance(value, RecurringActivity):
print(key_name)
print("RRULE: " + value.get_rrule())
elif isinstance(value, Consent):
print("Record Consent ID: " + str(value.get_id()))
# Get the createdBy User instance of each Record
created_by = value.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Consent Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Consent Created By - ID: " + created_by.get_id())
# Get the Email of the created_by User
print("Record Consent Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record Consent CreatedTime: " + str(value.get_created_time()))
if value.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record Consent ModifiedTime: " + str(value.get_modified_time()))
# Get the Owner User instance of the Consent
owner = value.get_owner()
if owner is not None:
# Get the Name of the Owner User
print("Record Consent Created By - Name: " + owner.get_name())
# Get the ID of the Owner User
print("Record Consent Created By - ID: " + owner.get_id())
# Get the Email of the Owner User
print("Record Consent Created By - Email: " + owner.get_email())
print("Record Consent ContactThroughEmail: " + str(value.get_contact_through_email()))
print("Record Consent ContactThroughSocial: " + str(value.get_contact_through_social()))
print("Record Consent ContactThroughSurvey: " + str(value.get_contact_through_survey()))
print("Record Consent ContactThroughPhone: " + str(value.get_contact_through_phone()))
print("Record Consent MailSentTime: " + str(value.get_mail_sent_time()))
print("Record Consent ConsentDate: " + str(value.get_consent_date()))
print("Record Consent ConsentRemarks: " + value.get_consent_remarks())
print("Record Consent ConsentThrough: " + value.get_consent_through())
print("Record Consent DataProcessingBasis: " + value.get_data_processing_basis())
# To get custom values
print("Record Consent Lawful Reason: " + str(value.get_key_value("Lawful_Reason")))
elif isinstance(value, dict):
for key, val in value.items():
print(key + " : " + str(val))
else:
print(key_name + " : " + str(value))
info = response_object.get_info()
if info is not None:
if info.get_per_page() is not None:
# Get the PerPage from Info
print('Record Info PerPage: ' + str(info.get_per_page()))
if info.get_page() is not None:
# Get the Page from Info
print('Record Info Page: ' + str(info.get_page()))
if info.get_count() is not None:
# Get the Count from Info
print('Record Info Count: ' + str(info.get_count()))
if info.get_more_records() is not None:
# Get the MoreRecords from Info
print('Record Info MoreRecords: ' + str(info.get_more_records()))
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Create Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def create_records(module_api_name):
"""
This method is used to create records of a module and print the response.
:param module_api_name: The API Name of the module to create records.
"""
"""
example
module_api_name = 'Leads'
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Record instances
records_list = []
# Get instance of Record Class
record = ZCRMRecord()
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record.add_field_value(Field.Leads.last_name(), 'Python SDK')
record.add_field_value(Field.Leads.first_name(), 'New')
record.add_field_value(Field.Leads.company(), 'Zoho')
record.add_field_value(Field.Leads.city(), 'City')
record.add_field_value(Field.Leads.salutation(), Choice('Prof.'))
record.add_key_value('Multi_Select_1', [Choice('Test2'), Choice('Test1')])
record.add_key_value('External', 'Test1')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record.add_key_value('Custom_field', 'Value')
record.add_key_value('Custom_field_2', 12)
record.add_key_value('Date', date(2020, 4, 9))
record.add_key_value('Discounted', 23.34)
tax_name = [Choice('Vat'), Choice('Sales Tax')]
record.add_key_value("Tax", tax_name)
record.add_key_value("Product_Name", "AutomatedSDK")
file_details = []
file_detail = FileDetails()
file_detail.set_file_id('479f0f5eebf0fb982f99e3832b35d23e29f67c2868ee4c789f22579895383c8')
file_details.append(file_detail)
record.add_key_value('File_Upload', file_details)
"""
Following methods are being used only by Inventory modules
"""
deal_name = ZCRMRecord()
deal_name.add_field_value(Field.Deals.id(), 3477061000011067033)
record.add_field_value(Field.Sales_Orders.deal_name(), deal_name)
contact_name = ZCRMRecord()
contact_name.add_field_value(Field.Contacts.id(), 3477061000010346007)
record.add_field_value(Field.Sales_Orders.contact_name(), contact_name)
account_name = ZCRMRecord()
account_name.add_field_value(Field.Accounts.id(), 3477061000011067025)
record.add_field_value(Field.Sales_Orders.account_name(), account_name)
record.add_key_value("Discount", 10.5)
inventory_line_item_list = []
inventory_line_item = InventoryLineItems()
line_item_product = LineItemProduct()
# line_item_product.set_id(3477061000011217004)
line_item_product.add_key_value("Products_External", "TestExternalLead121")
inventory_line_item.set_product(line_item_product)
inventory_line_item.set_quantity(3.0)
inventory_line_item.set_product_description('productDescription')
inventory_line_item.set_list_price(10.0)
inventory_line_item.set_discount('5.90')
product_line_taxes = []
product_line_tax = LineTax()
product_line_tax.set_name('Tax1')
product_line_tax.set_percentage(12.0)
product_line_taxes.append(product_line_tax)
inventory_line_item_list.append(inventory_line_item)
record.add_key_value('Product_Details', inventory_line_item_list)
record.add_field_value(Field.Quotes.subject(), "Python- testing")
line_taxes = []
line_tax = LineTax()
line_tax.set_name('Total-Tax')
line_tax.set_percentage(5.0)
line_taxes.append(line_tax)
record.add_key_value("$line_tax", line_taxes)
vendor_name = ZCRMRecord()
vendor_name.set_id(1234)
record.add_field_value(Field.Purchase_Orders.vendor_name(), vendor_name)
"""
End Inventory
"""
"""
Following methods are being used only by Activity modules
"""
record.add_field_value(Field.Tasks.description(), "New Task")
record.add_key_value('Currency', Choice('INR'))
remind_at = RemindAt()
remind_at.set_alarm("FREQ=NONE;ACTION=POPUP;TRIGGER=DATE-TIME:2021-01-18T12:45:00+05:30")
record.add_field_value(Field.Tasks.remind_at(), remind_at)
record.add_field_value(Field.Tasks.subject(), "Python - testing")
record.add_field_value(Field.Calls.reminder(), Choice("5 mins"))
record.add_field_value(Field.Calls.call_type(), Choice("Outbound"))
record.add_field_value(Field.Calls.call_start_time(), datetime(2020,12,1,1,1,1))
who_id = ZCRMRecord()
who_id.set_id(3477061000010346007)
record.add_field_value(Field.Tasks.who_id(), who_id)
record.add_field_value(Field.Tasks.status(), Choice('Waiting for Input'))
record.add_field_value(Field.Tasks.due_date(), date(2020, 10, 10))
record.add_field_value(Field.Tasks.priority(), Choice('High'))
what_id = ZCRMRecord()
what_id.set_id(3477061000011067025)
record.add_field_value(Field.Tasks.what_id(), what_id)
record.add_key_value("$se_module", "Accounts")
# Recurring Activity can be provided in any activity module
recurring_activity = RecurringActivity()
recurring_activity.set_rrule('FREQ=DAILY;INTERVAL=10;UNTIL=2020-08-14;DTSTART=2020-07-03')
record.add_field_value(Field.Events.recurring_activity(), recurring_activity)
record.add_field_value(Field.Events.description(), "My Event")
start_date_time = datetime.fromisoformat('2020-07-03T12:30:00+05:30')
record.add_field_value(Field.Events.start_datetime(), start_date_time)
participants_list = []
participant = Participants()
participant.set_participant('test@gmail.com')
participant.set_type('email')
participants_list.append(participant)
participant = Participants()
participant.set_participant('3477061000010346007')
participant.set_type('contact')
participants_list.append(participant)
record.add_field_value(Field.Events.participants(), participants_list)
record.add_key_value("$send_notification", True)
record.add_field_value(Field.Events.event_title(), "New Automated Event")
end_date_time = datetime(2020, 9, 3, 10, 10, 10)
record.add_field_value(Field.Events.end_datetime(), end_date_time)
remind_at_value = datetime(2020, 7, 3, 8, 10, 10)
record.add_field_value(Field.Events.remind_at(), remind_at_value)
record.add_field_value(Field.Events.check_in_status(), 'PLANNED')
what_id = ZCRMRecord()
what_id.set_id(3477061000011218001)
record.add_field_value(Field.Events.what_id(), what_id)
record.add_key_value("$se_module", "Leads")
"""
End Activity
"""
"""
Following methods are being used only by Price_Books module
"""
pricing_details_list = []
pricing_detail = PricingDetails()
pricing_detail.set_from_range(1.0)
pricing_detail.set_to_range(5.0)
pricing_detail.set_discount(2.0)
pricing_details_list.append(pricing_detail)
pricing_detail = PricingDetails()
pricing_detail.add_key_value('from_range', 6.0)
pricing_detail.add_key_value('to_range', 11.0)
pricing_detail.add_key_value('discount', 3.0)
pricing_details_list.append(pricing_detail)
record.add_field_value(Field.Price_Books.pricing_details(), pricing_details_list)
record.add_key_value("Email", "abc@zoho.com")
record.add_field_value(Field.Price_Books.description(), "My Price Book")
record.add_field_value(Field.Price_Books.price_book_name(), 'book_name')
record.add_field_value(Field.Price_Books.pricing_model(), Choice('Flat'))
"""
End of Price_Books
"""
# Used when GDPR is enabled
data_consent = Consent()
data_consent.set_consent_remarks("Approved.")
data_consent.set_consent_through('Email')
data_consent.set_contact_through_email(True)
data_consent.set_contact_through_social(False)
record.add_key_value('Data_Processing_Basis_Details', data_consent)
tags_list = []
tag = Tag()
tag.set_name("My Record")
tags_list.append(tag)
# Add Record instance to the list
records_list.append(record)
# Set the list to data in BodyWrapper instance
request.set_data(records_list)
trigger = ["approval", "workflow", "blueprint"]
# Set the list containing the trigger operations to be run
request.set_trigger(trigger)
lar_id = '3409643000002157065'
# Set the larId
request.set_lar_id(lar_id)
process = ["review_process"]
# Set the array containing the process to be run
request.set_process(process)
header_instance = HeaderMap()
header_instance.add(CreateRecordsHeader.x_external, "Quotes.Product_Details.product.Products_External")
# Call create_records method that takes module_api_name, BodyWrapper instance and header_instance as parameters
response = record_operations.create_records(module_api_name, request, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Update Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def update_records(module_api_name):
"""
This method is used to update the records of a module with ID and print the response.
:param module_api_name: The API Name of the module to update records.
"""
"""
example
module_api_name = 'Leads'
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Record instances
records_list = []
# Get instance of Record Class
record1 = ZCRMRecord()
# ID of the record to be updated
record1.set_id(3477061000011218001)
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record1.add_field_value(Field.Leads.last_name(), 'Python SDK')
record1.add_field_value(Field.Leads.company(), 'NNN')
record1.add_field_value(Field.Leads.city(), 'Hola')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record1.add_key_value('Custom_field', 'Value')
record1.add_key_value('Custom_field_2', 90)
# record1.add_key_value('External', 'Test1')
# Add Record instance to the list
records_list.append(record1)
# Get instance of Record Class
record2 = ZCRMRecord()
# ID of the record to be updated
record2.set_id(3409643000000986033)
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record2.add_field_value(Field.Leads.last_name(), 'Edited Name')
record2.add_field_value(Field.Leads.city(), 'Hola')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record2.add_key_value('Custom_field_2', 90)
record2.add_key_value('Discounted', 19.8)
# Used when GDPR is enabled
data_consent = Consent()
data_consent.set_consent_remarks("Approved.")
data_consent.set_consent_through('Email')
data_consent.set_contact_through_email(True)
data_consent.set_contact_through_social(False)
record2.add_key_value('Data_Processing_Basis_Details', data_consent)
# Add Record instance to the list
records_list.append(record2)
# Set the list to data in BodyWrapper instance
request.set_data(records_list)
trigger = []
trigger.append("approval")
trigger.append("workflow")
trigger.append("blueprint")
# Set the list containing the trigger operations to be run
request.set_trigger(trigger)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# header_instance.add(UpdateRecordsHeader.x_external, "Leads.External")
# Call update_records method that takes BodyWrapper instance and module_api_name as parameter.
response = record_operations.update_records(module_api_name, request, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Delete Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def delete_records(module_api_name, record_ids):
"""
This method is used to delete multiple records of a module and print the response.
:param module_api_name: The API Name of the module to delete records.
:param record_ids: The list of record IDs to be deleted
"""
"""
example
module_api_name = "Contacts";
record_ids = [3409643000000756050, 3409643000000729017, 3409643000000729009]
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Delete Records operation
param_instance.add(DeleteRecordsParam.wf_trigger, True)
for record_id in record_ids:
param_instance.add(DeleteRecordsParam.ids, record_id)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
header_instance.add(DeleteRecordsHeader.x_external, "Leads.External")
# Call deleteRecords method that takes param_instance and module_api_name as parameter.
response = record_operations.delete_records(module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Upsert Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def upsert_records(module_api_name):
"""
This method is used to Upsert records of a module and print the response.
:param module_api_name: The API Name of the module to upsert records.
"""
"""
example
module_api_name = 'Leads'
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Record instances
records_list = []
# Get instance of Record Class
record_1 = ZCRMRecord()
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record_1.add_field_value(Field.Leads.last_name(), 'Python SDK')
record_1.add_field_value(Field.Leads.first_name(), 'New')
record_1.add_field_value(Field.Leads.company(), 'Zoho')
record_1.add_field_value(Field.Leads.city(), 'City')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record_1.add_key_value('Custom_field', 'Value')
record_1.add_key_value('Custom_field_2', 12)
# Add Record instance to the list
records_list.append(record_1)
# Get instance of Record Class
record_2 = ZCRMRecord()
# Value to Record's fields can be provided in any of the following ways
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
record_2.add_field_value(Field.Leads.last_name(), 'Boyle')
record_2.add_field_value(Field.Leads.first_name(), 'Patricia')
record_2.add_field_value(Field.Leads.company(), 'Law')
record_2.add_field_value(Field.Leads.city(), 'Man')
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
record_2.add_key_value('Custom_field', 'Value')
record_2.add_key_value('Custom_field_2', 12)
# Add Record instance to the list
records_list.append(record_2)
# Set the list to data in BodyWrapper instance
request.set_data(records_list)
duplicate_check_fields = ["City", "Last_Name", "First_Name"]
# Set the array containing duplicate check fields to BodyWrapper instance
request.set_duplicate_check_fields(duplicate_check_fields)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# header_instance.add(UpsertRecordsHeader.x_external, "Leads.External")
# Call upsertRecords method that takes BodyWrapper instance and module_api_name as parameters.
response = record_operations.upsert_records(module_api_name, request, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Get Deleted Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def get_deleted_records(module_api_name):
"""
This method is used to get the deleted records of a module and print the response.
:param module_api_name: The API Name of the module to get the deleted records.
"""
"""
example
module_api_name = "Deals"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Get Deleted Records operation
param_instance.add(GetDeletedRecordsParam.page, 1)
param_instance.add(GetDeletedRecordsParam.per_page, 200)
# can be all/recycle/permanent
param_instance.add(GetDeletedRecordsParam.type, 'permanent')
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers for Get Deleted Records operation
# header_instance.add(GetDeletedRecordsHeader.if_modified_since, datetime.fromisoformat('2020-01-15T10:35:32+05:30'))
# Call getDeletedRecords method that takes param_instance, header_instance and module_api_name as parameter
response = record_operations.get_deleted_records(module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected DeletedRecordsWrapper instance is received.
if isinstance(response_object, DeletedRecordsWrapper):
# Get the list of obtained DeletedRecord instances
deleted_records = response_object.get_data()
for deleted_record in deleted_records:
# Get the deletedBy User instance of each DeletedRecord
deleted_by = deleted_record.get_deleted_by()
# Check if deleted_by is not None
if deleted_by is not None:
# Get the Name of the deleted_by User
print("Record Deleted By - Name: " + deleted_by.get_name())
# Get the ID of the deleted_by User
print("Record Deleted By - ID: " + deleted_by.get_id())
# Get the ID of each DeletedRecord
print("DeletedRecord ID: " + str(deleted_record.get_id()))
# Get the DisplayName of each DeletedRecord
print("DeletedRecord DisplayName: " + str(deleted_record.get_display_name()))
# Get the Type of each DeletedRecord
print("DeletedRecord Type: " + str(deleted_record.get_type()))
# Get the DeletedTime of each DeletedRecord
print("DeletedRecord DeletedTime: " + str(deleted_record.get_deleted_time()))
# Get the createdBy User instance of each DeletedRecord
created_by = deleted_record.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Created By - ID: " + created_by.get_id())
info = response_object.get_info()
if info is not None:
if info.get_per_page() is not None:
# Get the PerPage from Info
print('Record Info PerPage: ' + str(info.get_per_page()))
if info.get_page() is not None:
# Get the Page from Info
print('Record Info Page: ' + str(info.get_page()))
if info.get_count() is not None:
# Get the Count from Info
print('Record Info Count: ' + str(info.get_count()))
if info.get_more_records() is not None:
# Get the MoreRecords from Info
print('Record Info MoreRecords: ' + str(info.get_more_records()))
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Search Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def search_records(module_api_name):
"""
This method is used to search records of a module and print the response.
:param module_api_name: The API Name of the module to search records.
"""
"""
example
module_api_name = "Price_Books"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Search Records operation
param_instance.add(SearchRecordsParam.email, 'user@zoho.com')
param_instance.add(SearchRecordsParam.phone, '234567890')
param_instance.add(SearchRecordsParam.word, 'First Name Last Name')
param_instance.add(SearchRecordsParam.approved, 'both')
param_instance.add(SearchRecordsParam.converted, 'both')
param_instance.add(SearchRecordsParam.page, 1)
param_instance.add(SearchRecordsParam.per_page, 20)
# Encoding must be done for parentheses or comma
param_instance.add(SearchRecordsParam.criteria, '((Last_Name:starts_with:Last Name) and (Company:starts_with:fasf\\(123\\) K))')
# param_instance.add(SearchRecordsParam.criteria, "(External:in:TestExternal12)")
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# header_instance.add(SearchRecordsHeader.x_external, "Leads.External")
# Call searchRecords method that takes ParameterMap Instance and moduleAPIName as parameter
response = record_operations.search_records(module_api_name, param_instance, header_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ResponseWrapper instance is received.
if isinstance(response_object, ResponseWrapper):
# Get the list of obtained Record instances
record_list = response_object.get_data()
for record in record_list:
# Get the ID of each Record
print("Record ID: " + str(record.get_id()))
# Get the createdBy User instance of each Record
created_by = record.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Created By - ID: " + str(created_by.get_id()))
# Get the Email of the created_by User
print("Record Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record CreatedTime: " + str(record.get_created_time()))
if record.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record ModifiedTime: " + str(record.get_modified_time()))
# Get the modified_by User instance of each Record
modified_by = record.get_modified_by()
# Check if modified_by is not None
if modified_by is not None:
# Get the Name of the modified_by User
print("Record Modified By - Name: " + modified_by.get_name())
# Get the ID of the modified_by User
print("Record Modified By - ID: " + str(modified_by.get_id()))
# Get the Email of the modified_by User
print("Record Modified By - Email: " + modified_by.get_email())
# Get the list of obtained Tag instance of each Record
tags = record.get_tag()
if tags is not None:
for tag in tags:
# Get the Name of each Tag
print("Record Tag Name: " + tag.get_name())
# Get the Id of each Tag
print("Record Tag ID: " + str(tag.get_id()))
# To get particular field value
print("Record Field Value: " + str(record.get_key_value('Last_Name')))
print('Record KeyValues: ')
key_values = record.get_key_values()
for key_name, value in key_values.items():
if isinstance(value, list):
if len(value) > 0:
if isinstance(value[0], FileDetails):
file_details = value
for file_detail in file_details:
# Get the Extn of each FileDetails
print("Record FileDetails Extn: " + file_detail.get_extn())
# Get the IsPreviewAvailable of each FileDetails
print("Record FileDetails IsPreviewAvailable: " + str(file_detail.get_is_preview_available()))
# Get the DownloadUrl of each FileDetails
print("Record FileDetails DownloadUrl: " + file_detail.get_download_url())
# Get the DeleteUrl of each FileDetails
print("Record FileDetails DeleteUrl: " + file_detail.get_delete_url())
# Get the EntityId of each FileDetails
print("Record FileDetails EntityId: " + file_detail.get_entity_id())
# Get the Mode of each FileDetails
print("Record FileDetails Mode: " + file_detail.get_mode())
# Get the OriginalSizeByte of each FileDetails
print("Record FileDetails OriginalSizeByte: " + file_detail.get_original_size_byte())
# Get the PreviewUrl of each FileDetails
print("Record FileDetails PreviewUrl: " + file_detail.get_preview_url())
# Get the FileName of each FileDetails
print("Record FileDetails FileName: " + file_detail.get_file_name())
# Get the FileId of each FileDetails
print("Record FileDetails FileId: " + file_detail.get_file_id())
# Get the AttachmentId of each FileDetails
print("Record FileDetails AttachmentId: " + file_detail.get_attachment_id())
# Get the FileSize of each FileDetails
print("Record FileDetails FileSize: " + file_detail.get_file_size())
# Get the CreatorId of each FileDetails
print("Record FileDetails CreatorId: " + file_detail.get_creator_id())
# Get the LinkDocs of each FileDetails
print("Record FileDetails LinkDocs: ")
print(file_detail.get_link_docs())
elif isinstance(value[0], Reminder):
reminders = value
for reminder in reminders:
# Get the Reminder Period
print("Reminder Period: " + reminder.get_period())
# Get the Reminder Unit
print("Reminder Unit: " + reminder.get_unit())
elif isinstance(value[0], Choice):
choice_list = value
print(key_name)
print('Values')
for choice in choice_list:
print(choice.get_value())
elif isinstance(value[0], Participants):
participants = value
for participant in participants:
print("Record Participants Name: " + participant.get_name())
print("Record Participants Invited: " + str(participant.get_invited()))
print("Record Participants Type: " + participant.get_type())
print("Record Participants Participant: " + participant.get_participant())
print("Record Participants Status: " + participant.get_status())
elif isinstance(value[0], InventoryLineItems):
product_details = value
for product_detail in product_details:
line_item_product = product_detail.get_product()
if line_item_product is not None:
print("Record ProductDetails LineItemProduct ProductCode: " + line_item_product.get_product_code())
print("Record ProductDetails LineItemProduct Currency: " + line_item_product.get_currency())
print("Record ProductDetails LineItemProduct Name: " + line_item_product.get_name())
print("Record ProductDetails LineItemProduct Id: " + line_item_product.get_id())
print("Record ProductDetails Quantity: " + str(product_detail.get_quantity()))
print("Record ProductDetails Discount: " + product_detail.get_discount())
print("Record ProductDetails TotalAfterDiscount: " + str(product_detail.get_total_after_discount()))
print("Record ProductDetails NetTotal: " + str(product_detail.get_net_total()))
if product_detail.get_book() is not None:
print("Record ProductDetails Book: " + str(product_detail.get_book()))
print("Record ProductDetails Tax: " + str(product_detail.get_tax()))
print("Record ProductDetails ListPrice: " + str(product_detail.get_list_price()))
print("Record ProductDetails UnitPrice: " + str(product_detail.get_unit_price()))
print("Record ProductDetails QuantityInStock: " + str(product_detail.get_quantity_in_stock()))
print("Record ProductDetails Total: " + str(product_detail.get_total()))
print("Record ProductDetails ID: " + product_detail.get_id())
print("Record ProductDetails ProductDescription: " + product_detail.get_product_description())
line_taxes = product_detail.get_line_tax()
for line_tax in line_taxes:
print("Record ProductDetails LineTax Percentage: " + str(line_tax.get_percentage()))
print("Record ProductDetails LineTax Name: " + line_tax.get_name())
print("Record ProductDetails LineTax Id: " + line_tax.get_id())
print("Record ProductDetails LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Tag):
tags = value
if tags is not None:
for tag in tags:
print("Record Tag Name: " + tag.get_name())
print("Record Tag ID: ")
print(tag.get_id())
elif isinstance(value[0], PricingDetails):
pricing_details = value
for pricing_detail in pricing_details:
print("Record PricingDetails ToRange: " + str(pricing_detail.get_to_range()))
print("Record PricingDetails Discount: " + str(pricing_detail.get_discount()))
print("Record PricingDetails ID: " + pricing_detail.get_id())
print("Record PricingDetails FromRange: " + str(pricing_detail.get_from_range()))
elif isinstance(value[0], ZCRMRecord):
record_list = value
for each_record in record_list:
for key, val in each_record.get_key_values().items():
print(str(key) + " : " + str(val))
elif isinstance(value[0], LineTax):
line_taxes = value
for line_tax in line_taxes:
print("Record LineTax Percentage: " + str(
line_tax.get_percentage()))
print("Record LineTax Name: " + line_tax.get_name())
print("Record LineTax Id: " + line_tax.get_id())
print("Record LineTax Value: " + str(line_tax.get_value()))
elif isinstance(value[0], Comment):
comments = value
for comment in comments:
print("Comment-ID: " + comment.get_id())
print("Comment-Content: " + comment.get_comment_content())
print("Comment-Commented_By: " + comment.get_commented_by())
print("Comment-Commented Time: " + str(comment.get_commented_time()))
else:
print(key_name)
for each_value in value:
print(str(each_value))
elif isinstance(value, User):
print("Record " + key_name + " User-ID: " + str(value.get_id()))
print("Record " + key_name + " User-Name: " + value.get_name())
print("Record " + key_name + " User-Email: " + value.get_email())
elif isinstance(value, Layout):
print(key_name + " ID: " + str(value.get_id()))
print(key_name + " Name: " + value.get_name())
elif isinstance(value, ZCRMRecord):
print(key_name + " Record ID: " + str(value.get_id()))
print(key_name + " Record Name: " + value.get_key_value('name'))
elif isinstance(value, Choice):
print(key_name + " : " + value.get_value())
elif isinstance(value, RemindAt):
print(key_name + " : " + value.get_alarm())
elif isinstance(value, RecurringActivity):
print(key_name)
print("RRULE: " + value.get_rrule())
elif isinstance(value, Consent):
print("Record Consent ID: " + str(value.get_id()))
# Get the createdBy User instance of each Record
created_by = value.get_created_by()
# Check if created_by is not None
if created_by is not None:
# Get the Name of the created_by User
print("Record Consent Created By - Name: " + created_by.get_name())
# Get the ID of the created_by User
print("Record Consent Created By - ID: " + created_by.get_id())
# Get the Email of the created_by User
print("Record Consent Created By - Email: " + created_by.get_email())
# Get the CreatedTime of each Record
print("Record Consent CreatedTime: " + str(value.get_created_time()))
if value.get_modified_time() is not None:
# Get the ModifiedTime of each Record
print("Record Consent ModifiedTime: " + str(value.get_modified_time()))
# Get the Owner User instance of the Consent
owner = value.get_owner()
if owner is not None:
# Get the Name of the Owner User
print("Record Consent Created By - Name: " + owner.get_name())
# Get the ID of the Owner User
print("Record Consent Created By - ID: " + owner.get_id())
# Get the Email of the Owner User
print("Record Consent Created By - Email: " + owner.get_email())
print("Record Consent ContactThroughEmail: " + str(value.get_contact_through_email()))
print("Record Consent ContactThroughSocial: " + str(value.get_contact_through_social()))
print("Record Consent ContactThroughSurvey: " + str(value.get_contact_through_survey()))
print("Record Consent ContactThroughPhone: " + str(value.get_contact_through_phone()))
print("Record Consent MailSentTime: " + str(value.get_mail_sent_time()))
print("Record Consent ConsentDate: " + str(value.get_consent_date()))
print("Record Consent ConsentRemarks: " + value.get_consent_remarks())
print("Record Consent ConsentThrough: " + value.get_consent_through())
print("Record Consent DataProcessingBasis: " + value.get_data_processing_basis())
# To get custom values
print("Record Consent Lawful Reason: " + str(value.get_key_value("Lawful_Reason")))
elif isinstance(value, dict):
for key, val in value.items():
print(key + " : " + str(val))
else:
print(key_name + " : " + str(value))
info = response_object.get_info()
if info is not None:
if info.get_per_page() is not None:
# Get the PerPage from Info
print('Record Info PerPage: ' + str(info.get_per_page()))
if info.get_page() is not None:
# Get the Page from Info
print('Record Info Page: ' + str(info.get_page()))
if info.get_count() is not None:
# Get the Count from Info
print('Record Info Count: ' + str(info.get_count()))
if info.get_more_records() is not None:
# Get the MoreRecords from Info
print('Record Info MoreRecords: ' + str(info.get_more_records()))
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Convert a Lead
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def convert_lead(lead_id):
"""
This method is used to Convert a Lead record and print the response.
:param lead_id: The ID of the Lead to be converted.
"""
"""
example
lead_id = 3409643000002034003
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ConvertBodyWrapper Class that will contain the request body
request = ConvertBodyWrapper()
# List to hold LeadConverter instances
data = []
# Get instance of LeadConverter Class
record = LeadConverter()
record.set_overwrite(True)
record.set_notify_lead_owner(True)
record.set_notify_new_entity_owner(True)
record.set_accounts('3409643000000692007')
record.set_contacts('3409643000000836001')
record.set_assign_to('3409643000000302031')
deals = ZCRMRecord()
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
2 -> Value
"""
deals.add_field_value(Field.Deals.deal_name(), 'deal_name')
deals.add_field_value(Field.Deals.description(), "deals description")
deals.add_field_value(Field.Deals.closing_date(), date(2020, 10, 2))
deals.add_field_value(Field.Deals.stage(), Choice("Closed Won"))
deals.add_field_value(Field.Deals.amount(), 500.78)
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
deals.add_key_value('Custom_field', 'Value')
tag_list = []
tag = Tag()
tag.set_name('Converted')
tag_list.append(tag)
deals.set_tag(tag_list)
record.set_deals(deals)
data.append(record)
request.set_data(data)
# Call convertLead method that takes ConvertBodyWrapper instance and lead_id as parameter
response = record_operations.convert_lead(lead_id, request)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, ConvertActionWrapper):
# Get the list of obtained ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, SuccessfulConvert):
# Get the Accounts ID of Record
print("LeadConvert Accounts ID: " + action_response.get_accounts())
# Get the Contacts ID of Record
print("LeadConvert Contacts ID: " + action_response.get_contacts())
# Get the Deals ID of Record
print("LeadConvert Deals ID: " + action_response.get_deals())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Get a Record's Photo
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def get_photo(module_api_name, record_id, destination_folder):
"""
This method is used to download a photo associated with a record.
:param module_api_name: The API Name of the record's module
:param record_id: The ID of the record
:param destination_folder: The absolute path of the destination folder to store the photo.
"""
"""
example
module_api_name = "Contacts"
record_id = 3409643000002034003
destination_folder = "/Users/user-name/Documents"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Call getPhoto method that takes module_api_name and record_id as parameters
response = record_operations.get_photo(record_id, module_api_name)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ResponseWrapper instance is received.
if isinstance(response_object, FileBodyWrapper):
# Get StreamWrapper instance from the returned FileBodyWrapper instance
stream_wrapper = response_object.get_file()
# Construct the file name by joining the destinationFolder and the name from StreamWrapper instance
file_name = os.path.join(destination_folder, stream_wrapper.get_name())
# Open the destination file where the file needs to be written in 'wb' mode
with open(file_name, 'wb') as f:
# Get the stream from StreamWrapper instance
for chunk in stream_wrapper.get_stream():
f.write(chunk)
f.close()
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Upload a Photo to a Record
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def upload_photo(module_api_name, record_id, absolute_file_path):
"""
This method is used to attach a photo to a record. You must include the file in the request
:param module_api_name: The API Name of the record's module
:param record_id: The ID of the record
:param absolute_file_path: The absolute file path of the file to be uploaded
"""
"""
example
module_api_name = "Contacts"
record_id = 3409643000002034003
absolute_file_path = "/Users/user_name/Desktop/image.png"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of FileBodyWrapper class that will contain the request file
request = FileBodyWrapper()
"""
StreamWrapper can be initialized in any of the following ways
* param 1 -> fileName
* param 2 -> Read Stream.
"""
# stream_wrapper = StreamWrapper(stream=open(absolute_file_path, 'rb'))
"""
* param 1 -> fileName
* param 2 -> Read Stream
* param 3 -> Absolute File Path of the file to be attached
"""
stream_wrapper = StreamWrapper(file_path=absolute_file_path)
# Set file to the FileBodyWrapper instance
request.set_file(stream_wrapper)
# Call uploadPhoto method that takes FileBodyWrapper instance, module_api_name and record_id as parameter
response = record_operations.upload_photo(record_id, module_api_name, request)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from responsse
response_object = response.get_object()
if response_object is not None:
# Check if the request is successful
if isinstance(response_object, SuccessResponse):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Delete the Photo of a Record
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def delete_photo(module_api_name, record_id):
"""
This method is used to delete a photo from a record in a module.
:param module_api_name: The API Name of the record's module
:param record_id: The ID of the record to delete photo
"""
"""
example
module_api_name = "Contacts"
record_id = 3409643000002034003
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Call deletePhoto method that takes module_api_name and record_id as parameter
response = record_operations.delete_photo(record_id, module_api_name)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from responsse
response_object = response.get_object()
if response_object is not None:
# Check if the request is successful
if isinstance(response_object, SuccessResponse):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Mass Update Records
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def mass_update_records(module_api_name):
"""
This method is used to update the values of specific fields for multiple records and print the response.
:param module_api_name: The API Name of the module to mass update records.
"""
"""
example
module_api_name = "Contacts"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of MassUpdateBodyWrapper Class that will contain the request body
request = MassUpdateBodyWrapper()
# List to hold Record instances
records_list = []
# Get instance of Record Class
record = ZCRMRecord()
record.add_field_value(Field.Leads.city(), 'HOO')
# Add the record instance to list
records_list.append(record)
# Set the array to data in MassUpdateBodyWrapper instance
request.set_data(records_list)
# Set the cvid to MassUpdateBodyWrapper instance
request.set_cvid('3409643000000087537')
ids = [3409643000002049003, 3409643000002043003, 3409643000001881002]
# Set the array of IDs to MassUpdateBodyWrapper instance
request.set_ids(ids)
# Set the value to over write
request.set_over_write(True)
# Get instance of Territory Class
territory = Territory()
# Set ID to Territory
territory.set_id(3409643000000505351)
territory.set_include_child(True)
request.set_territory(territory)
# Call mass_update_records method that takes MassUpdateBodyWrapper instance, module_api_name as parameter.
response = record_operations.mass_update_records(module_api_name, request)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
# Get object from responsse
response_object = response.get_object()
if response_object is not None:
# Check if expected ActionWrapper instance is received.
if isinstance(response_object, MassUpdateActionWrapper):
# Get the list of obtained MassUpdate ActionResponse instances
action_response_list = response_object.get_data()
for action_response in action_response_list:
# Check if the request is successful
if isinstance(action_response, MassUpdateSuccessResponse):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(action_response, APIException):
# Get the Status
print("Status: " + action_response.get_status().get_value())
# Get the Code
print("Code: " + action_response.get_code().get_value())
print("Details")
# Get the details dict
details = action_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + action_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())
Get the Status of Mass Update
import os
from datetime import date, datetime
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.attachments import Attachment
from zcrmsdk.src.com.zoho.crm.api.layouts import Layout
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api.record import Record as ZCRMRecord
from zcrmsdk.src.com.zoho.crm.api.tags import Tag
from zcrmsdk.src.com.zoho.crm.api.users import User
from zcrmsdk.src.com.zoho.crm.api.util import Choice, StreamWrapper
class Record(object):
@staticmethod
def get_mass_update_status(module_api_name, job_id):
"""
This method is used to get the status of the mass update job scheduled previously and print the response.
:param module_api_name: The API Name of the module to obtain status of Mass Update.
:param job_id: The ID of the job obtained from the response of Mass Update Records.
"""
"""
example
module_api_name = "Leads"
job_id = "3477061000005177002"
"""
# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Get MassUpdate Status operation
param_instance.add(GetMassUpdateStatusParam.job_id, job_id)
# Call getMassUpdateStatus method that takes ParameterMap instance and module_api_name as parameter
response = record_operations.get_mass_update_status(module_api_name, param_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() == 204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected MassUpdateResponseWrapper instance is received.
if isinstance(response_object, MassUpdateResponseWrapper):
# Get the list of MassUpdate ActionResponse data
mass_update_responses = response_object.get_data()
for mass_update_response in mass_update_responses:
# Check if the request is successful
if isinstance(mass_update_response, MassUpdate):
# Get the Status of each MassUpdate
print("MassUpdate Status: " + mass_update_response.get_status().get_value())
# Get the FailedCount of each MassUpdate
print("MassUpdate FailedCount: " + str(mass_update_response.get_failed_count()))
# Get the UpdatedCount of each MassUpdate
print("MassUpdate UpdatedCount: " + str(mass_update_response.get_updated_count()))
# Get the NotUpdatedCount of each MassUpdate
print("MassUpdate NotUpdatedCount: " + str(mass_update_response.get_not_updated_count()))
# Get the TotalCount of each MassUpdate
print("MassUpdate TotalCount: " + str(mass_update_response.get_total_count()))
# Check if the request returned an exception
elif isinstance(mass_update_response, APIException):
# Get the Status
print("Status: " + mass_update_response.get_status().get_value())
# Get the Code
print("Code: " + mass_update_response.get_code().get_value())
print("Details")
# Get the details dict
details = mass_update_response.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + mass_update_response.get_message().get_value())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " + response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " + response_object.get_message().get_value())