使用API检索查找关系数据
查找关系字段是一种自定义字段,Zendesk管理员可以将其添加到Zendesk中的用户、组织或票证中。亚博添加查找关系字段后,团队成员可以使用它与其他用户、组织或票据建立关系。要了解更多信息,请参见使用查找关系字段在Ze亚博ndesk帮助和查询关系在API参考文档中。
理解查找关系
查找关系由源记录和目标记录组成。关系可以表示为:
源记录->目标记录
源记录可以是用户、组织或票据。目标记录可以是不同的用户、组织或票据。
所有的关系都是单向的。例如,如果在源票据和相关用户之间创建关系,则票据记录将具有标识用户的查找关系字段。但是,相应的用户记录将没有标识票据的字段。
列出与目标记录相关联的源记录
您可以使用API列出与查找关系中的特定目标记录相关联的源记录。例如,您可以请求与特定用户相关的所有票据的列表。
列出与特定目标用户、组织或票证相关联的源记录
向……提出请求按目标获取来源端点:
https:/{子域名}.亚博.com/api/v2/{target_type}/{target_id}/relationship_fields/{field_id}/{source_type}
在请求中指定以下查询参数:
target_type
-相关对象的类型。取值为“zen:用户”、“zen:组织”或“zen:票务”。target_id
-特定相关用户、组织或票证的id。您可以从API或从Zendesk接口中对象页面的URL获取id。亚博field_id
-查找关系字段的id。您可以从API或从Zendesk界面中自定义字段页面的URL获取id。亚博例如,字段id为6498722764059。source_type
-源对象的类型。取值为“zen:用户”、“zen:组织”或“zen:票务”。
例子
假设Zendesk中的Organizations页面有一个查找关系字亚博段,其中列出了客户经理。团队成员使用该字段将内部客户经理关联到每个组织。
下面的API请求邮递员列出与特定客户经理关联的所有组织。它返回组织的列表(source_type
(“zen:organization”),查找关系字段为account_managers
(field_id
6436064572443)。响应中的组织都与一个特定的客户经理相关target_type
“zen:user”和atarget_id
1262482787270,普通Zendesk用户id。亚博
有关使用Postman的更多信息,请参见探索Zendesk 亚博api与邮差.
curl中相同的请求如下所示:
旋度“https://{子域名}.zendes亚博k.com/api/v2/zen:用户/ 1262482787270 / relationship_fields / 1262482787270 /禅:组织的
-v-u{email_address}:{密码}