侧载
概述
侧加载允许您检索作为单个请求一部分的相关记录。例如,通常请求/ tickets.json
返回结构类似如下的票证资源:亚博电脑端
{
“门票”:[
{
“requester_id”:7,
…
},
…
]
}
要获取请求者的数据,必须发出另一个请求/用户/ 7. json
。
使用侧加载,您可以在单个请求中获取部分用户资源和票据。要发出请求,请添加一个包括
参数,其中包含要加载的以逗号分隔的资源列表。亚博电脑端例子:
…/ tickets.json吗?包括=用户,groups
…/ / 1. json票吗?包括=用户,groups
响应将在适当的资源键下包含关联数据的顶级数组。
{
“门票”:[
{
“requester_id”:7,
…
},
…
],
“用户”:[
{
“id”:7,
“名称”:“鲍勃Bobberson”,
…
}
]
}
特殊的拷贝
能力
资源可能有附加的能力
描述当前用户可以对资源执行的操作的副负载。例子:
GET / api / v2 /用户/ me.json吗?包括=能力
{
“用户”:{
“活跃”:真正的,
“别名”:零,
“created_at”:“2012 - 05 - 08 - t01:04:47z”,
…
},
“能力”:[
{
“can_edit”:真正的,
“can_edit_password”:真正的,
“can_manage_identities_of”:真正的,
“can_verify_identities”:假,
“url”:“http://example.亚博zendesk.com/api/v2/users/11.json”,
“user_id”:11
}
]
}
评论事件
票证事件流可以有comment_events
包含票证注释的副加载。返回的数据嵌入到child_events
属性,而不是在单独的数组中。有关更多信息,请参见侧加载增量票务事件导出。
未开票数
用户可以拥有open_ticket_count
指定分配给用户的开放票据总数的副负载。
GET / api / v2 /用户/ me.json吗?包括= open_ticket_count
{
“用户”:{
“id”:10001,
“活跃”:真正的,
“别名”:零,
“created_at”:“2012 - 05 - 08 - t01:04:47z”,
…
},
“open_ticket_count”:{
“10001”:10
}
}
有关更多信息,请参见加载相关记录在开发帮助中心。
搜索
搜索支持拷贝。方法中搜索的记录类型包括
查询参数来加载与该记录类型相关的数据。使用以下语法指定类型和旁载:
包括={类型}({拷贝})
例如,下面的请求搜索用户并指定类型用户
要加载用户的身份:
/api/v2/搜索。json?查询=电子邮件:(电子邮件保护)。com&包括=用户(身份)
下面的请求搜索票据并指定类型票
加载票证的用户和SLA数据;
api/v2/搜索。json?查询=类型:票%20.计费&包括=票(用户,sla)
参见支持端点查看不同记录类型支持的旁负载。
支持端点
以下支持API资源支持侧加载记录:亚博电脑端
支持API资源 | Side-loaded记录 |
---|---|
票 | 品牌、custom_status、用户、组、组织、last_audit、metric_sets、日期、sharing_agreements、comment_count、incident_counts、ticket_forms、metric_events(单票)、sla(单票) |
票形式 | ticket_fields |
审计 | 用户、组织、组、票 |
请求 | 用户,组织 |
用户 | 组织、能力、角色、身份、组、open_ticket_count |
组 | 用户 |
组成员 | 用户、组 |
自动化 | App_installation, permissions, usage_1h, usage_24h, usage_7d, usage_30d |
宏 | App_installation, categories, permissions, usage_1h, usage_24h, usage_7d, usage_30d |
触发器 | App_installation, permissions, usage_1h, usage_24h, usage_7d, usage_30d |
的观点 | app_installation、权限 |
组织 | 能力 |
支持地址 | 品牌 |
查看执行/预览 | 如果适用,以下是自动侧加载的:组、组织、用户 |
搜索 | 与查询记录类型相关的记录(主要是票证、用户、组织)。看到搜索 |
以下帮助中心API资源支持侧加载记录:亚博电脑端