关系类型
关系类型定义对象记录之间的关系。关系类型可以是一对一、一对多或多对多。有关更多信息,请参见关系类型在自定义对象手册.
不能更新关系类型。您必须创建一个新的。
您可以通过调整其关系类型定义和关系记录来控制对该类型的关系类型定义和关系记录的访问政策.
JSON格式
关系类型表示为具有以下属性的JSON对象:
的名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
created_at | 字符串 | 真正的 | 假 | 创建关系类型的时间 |
关键 | 字符串 | 假 | 真正的 | 用户定义的唯一标识符。看到键属性 |
源 | 字符串 | 假 | 真正的 | 对象类型的键。看到源和目标属性 |
目标 | 假 | 真正的 | 不同对象类型的键。看到源和目标属性.它可以是字符串,也可以是数组 | |
updated_at | 字符串 | 真正的 | 假 | 关系类型最后一次更新的时间 |
键属性
的关键
属性是您自己定义的关系类型的唯一标识符。密钥长度必须在2到32个字符之间。例子:
- “product_has_one_product_category”
- “product_has_many_users”
- “stores_have_many_products”
源和目标属性
的源
而且目标
关系类型的属性定义两个对象记录之间的关系。
来源必须是以下之一:
- 对象类型的键或
- 一个亚博Zendesk对象类型,如“zen:user”或“zen:ticket”。看到亚博Zendesk对象类型
目标类型取决于您是想定义一对一关系类型还是一对多关系类型。
若要定义一对一关系类型,目标必须是以下类型之一:
- 对象类型的键或
- 一个亚博Zendesk对象类型,如“zen:user”或“zen:ticket”。看到亚博Zendesk对象类型
要定义一对多关系类型,目标必须是一个包含一个字符串的数组,该字符串表示对象类型或Zendesk对象类型的键。亚博
要定义一对多关系类型,请将目标值括在方括号中。若要定义多对一关系类型,请将源值括在方括号中。对于一对一关系类型,省略方括号。
下面的示例创建了一个名为"users"的一对多关系类型,它允许类型为"product"的每个对象记录拥有0个或多个类型为"zen:user"的对象记录:
{
“数据”:{
“关键”:“用户”,
“源”:“产品”,
“目标”:[“战:用户”]
}
}
下面的示例创建了一个名为“manufacturer”的一对一关系类型,它允许类型“product”的每个对象记录有0个或一个类型“manufacturer”的对象记录。一对一关系类型由目标属性缺少方括号表示。
{
“数据”:{
“关键”:“制造商”,
“源”:“产品”,
“目标”:“制造商”
}
}
亚博Zendesk对象类型
您可以创建一个关系类型,该关系类型定义了用户定义的对象类型和Zendesk对象类型(如票据或用户)之间的关系记录。亚博
以下是预定义的Zendesk对象类型:亚博
- “战:用户”
- “战:票”
- “禅:文章”
- “战:组织”
- “战:集团”
- “禅:聊天”
- “战:品牌”
- “禅:领导”
- “战:接触”
- “禅:协议”
使用标识符作为关系类型的源或目标。例子:
{
“数据”:{
“关键”:“product_has_many_tickets”,
“源”:“产品”,
“目标”:[“战:票”]
}
}
例子
{
“关键”:“制造商”,
“源”:“产品”,
“目标”:“制造商”
}
列表关系类型
得到阳光/ api / / /类型的关系
返回帐户的关系类型。
允许
- 每一个人
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/relationships/types\
- v - u{email_address}:{密码}
示例响应(年代)
200好了
// Status 200 OK
{
“数据”:[
{
“created_at”:“2017 - 01 - 01 t10:20:30z”,
“关键”:“制造商”,
“源”:“产品”,
“目标”:“制造商”,
“updated_at”:“2017 - 01 - 01 t10:20:30z”
}
]
}
显示关系类型
得到/ api /阳光/关系/类型/ {relationship_type_key}
属性的关系类型关键.
允许
- 每一个人
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
relationship_type_key | 字符串 | 路径 | 真正的 | 关系类型的键 |
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/relationships/types/{关键}\
- v - u{email_address}:{密码}
示例响应(年代)
200好了
// Status 200 OK
{
“数据”:{
“created_at”:“2017 - 01 - 01 t10:20:30z”,
“关键”:“制造商”,
“源”:“产品”,
“目标”:“制造商”,
“updated_at”:“2017 - 01 - 01 t10:20:30z”
}
}
创建关系类型
POST / api /阳光/ /类型的关系
创建关系类型。
根据现有的关系类型验证新键。如果检测到重复的键,则不会创建关系类型。
允许
- 管理员
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/relationships/types\
- d”{“数据”:{“关键”:“制造商”、“源”:“产品”,“目标”:“制造商”}}”\
- h“application / json内容类型:- x的帖子\
- v - u{email_address}:{密码}
示例响应(年代)
201年创建
//状态201已创建
{
“数据”:{
“created_at”:“2017 - 01 - 01 t10:20:30z”,
“关键”:“制造商”,
“源”:“产品”,
“目标”:“制造商”,
“updated_at”:“2017 - 01 - 01 t10:20:30z”
}
}
删除关系类型
删除/ api /阳光/关系/类型/ {relationship_type_key}
属性的关系类型关键.
只有当从关系类型创建的所有关系记录都已删除时,才能删除该关系类型。看到删除关系记录.
允许
- 管理员
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
relationship_type_key | 字符串 | 路径 | 真正的 | 关系类型的键 |
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/relationships/types/{关键}\
- x删除\
- v - u{email_address}:{密码}
示例响应(年代)
204无内容
//状态204无内容
零