从特定的记录中获取备注
目的
从模块的特定记录中获取备注列表。
请求URL
https://www.zohoapis.com.cn/crm/v2/{module_api_name}/{record_id}/Notes
module_api_name - 模块的API名称
record_id - 记录的唯一ID
| 支持的模块 |
|---|
| 线索,客户,联系人,商机,市场活动,任务,服务支持,事件,通话,解决方案,产品,供货商,价格表,报价单,销售订单,采购订单,发货单和自定义模块 |
请求方法
GET
范围
scope=ZohoCRM.modules.all
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(和)
scope=ZohoCRM.modules.notes.READ
| 可能的模块名称 | 可能的操作类型 |
|---|---|
| 线索,客户,联系人,商机,市场活动,任务,事件,通话,服务支持,解决方案,产品,供货商,价格表,报价单,销售订单,采购订单,发货单和自定义模块 | ALL - 完全访问备注 READ - 获取备注数据 |
示例请求
curl "https://www.zohoapis.com.cn/crm/v2/Leads/410888000000698006/Notes"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" 示例响应
{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-09-15T18:03:09+05:30",
"Created_Time": "2016-09-15T18:03:09+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000698006"
},
"id": "410888000000734003",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "",
"Note_Content": "Demo scheduled for this Lead"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
} 示例请求
ZCRMRecord record = ZCRMRecord.getInstance("Leads",123456l);//模块API名称和记录ID
BulkAPIResponse response = record.getRelatedListRecords("Notes");
List<ZCRMNote> notes = (List<ZCRMNote>) response.getData();//相关列表名称 示例响应
{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-09-15T18:03:09+05:30",
"Created_Time": "2016-09-15T18:03:09+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000698006"
},
"id": "410888000000734003",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "",
"Note_Content": "Demo scheduled for this Lead"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
} 示例请求
try{
$record=ZCRMRecord::getInstance("Leads",410405000001111007);
$responseIns=$record->getNotes(null,null,1,50);
$records=$responseIns->getData();
foreach ($records as $note)
{
echo "\n";
echo $note->getId();
echo $note->getTitle();
echo $note->getContent();
$parentRecord=$note->getParentRecord();
echo $parentRecord->getEntityId();
echo $note->getParentName();
echo $note->getParentId();
$createdBy=$note->getCreatedBy();
echo $createdBy->getId();
echo $createdBy->getName();
$modifiedBy=$note->getModifiedBy();
echo $modifiedBy->getId();
echo $modifiedBy->getName();
$owner=$note->getOwner();
echo $owner->getId();
echo $owner->getName();
echo $note->getCreatedTime();
echo $note->getModifiedTime();
echo $note->isVoiceNote();
echo $note->getSize();
$attchments=$note->getAttachments();
if($attchments!=null)
{
foreach ($attchments as $attchmentIns)
{
echo "\nATTACHMENTS::\n";
echo $attchmentIns->getId();
echo $attchmentIns->getFileName();
echo $attchmentIns->getFileType();
echo $attchmentIns->getSize();
echo $attchmentIns->getParentModule();
$parentRecord=$attchmentIns->getParentRecord();
echo $parentRecord->getEntityId();
echo $attchmentIns->getParentName();
echo $attchmentIns->getParentId();
$createdBy=$attchmentIns->getCreatedBy();
echo $createdBy->getId();
echo $createdBy->getName();
$modifiedBy=$attchmentIns->getModifiedBy();
echo $modifiedBy->getId();
echo $modifiedBy->getName();
$owner=$attchmentIns->getOwner();
echo $owner->getId();
echo $owner->getName();
echo $attchmentIns->getCreatedTime();
echo $attchmentIns->getModifiedTime();
}
}
}
}catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
echo $e->getExceptionCode();
} 示例响应
{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-09-15T18:03:09+05:30",
"Created_Time": "2016-09-15T18:03:09+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000698006"
},
"id": "410888000000734003",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "",
"Note_Content": "Demo scheduled for this Lead"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
} 示例请求
def get_notes(self):
try:
record=ZCRMRecord.get_instance('Leads',440872000000222019) #module API Name, entityId
resp=record.get_notes()
print resp.status_code
note_ins_arr=resp.data
for note_ins in note_ins_arr:
print note_ins.id
print note_ins.title
print note_ins.content
print note_ins.owner.id
print note_ins.created_by.id
print note_ins.modified_by.id
print note_ins.created_time
print note_ins.modified_time
print "\n\n"
except ZCRMException as ex:
print ex.status_code
print ex.error_message
print ex.error_code
print ex.error_details
print ex.error_content 示例响应
{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-09-15T18:03:09+05:30",
"Created_Time": "2016-09-15T18:03:09+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000698006"
},
"id": "410888000000734003",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "",
"Note_Content": "Demo scheduled for this Lead"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
} 示例请求
ZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 3372164000000614001); //模块API名称和记录ID
BulkAPIResponse<ZCRMNote> response = recordIns.GetNotes();
List<ZCRMNote> notes = response.BulkData; //notes - ZCRMNote实例列表 示例响应
{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-09-15T18:03:09+05:30",
"Created_Time": "2016-09-15T18:03:09+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000698006"
},
"id": "410888000000734003",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "",
"Note_Content": "Demo scheduled for this Lead"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}