遗留对象记录
遗留自定义对象记录是从您定义的遗留对象类型创建的。您的遗留对象记录存储在Zendesk基础结构中。亚博有关更多信息,请参见遗留对象记录在遗留自定义对象手册。
方法验证遗留对象记录遗留对象类型模式。
可以定义不同遗留对象记录之间的关联遗留关系记录。
JSON格式
遗留对象记录被表示为具有以下属性的JSON对象:
名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
属性 | 对象 | 假 | 真正的 | 遗留对象记录的数据,最大不超过32 KB。中定义了遗留对象属性模式 的类型 |
created_at | 字符串 | 真正的 | 假 | 创建遗留对象记录的时间 |
external_id | 字符串 | 假 | 假 | 遗留对象记录的唯一、不区分大小写的标识符,通常来自另一个系统。只能在create上写 |
id | 字符串 | 真正的 | 假 | 在创建遗留对象记录时自动分配 |
类型 | 字符串 | 假 | 真正的 | 的遗留对象类型键。只能在create上写 |
type_version | 整数 | 假 | 假 | 记录的遗留对象类型的版本 |
updated_at | 字符串 | 真正的 | 假 | 遗留对象记录最后一次更新的时间 |
的created_at
和updated_at
属性可能不完全匹配,这是由于updated_at
时间戳。
例子
{
“属性”:{
“id”:“3 b0ff066-e8ec-11e6-bf01-fe55135034f3”,
“名称”:“站在桌子上
},
“created_at”:“2020 - 04 - 24 - t23:47:19.000z”,
“类型”:“产品”,
“updated_at”:“2020 - 04 - 24 - t23:47:19.000z”
}
列出遗留对象记录
GET / api /阳光/对象/记录
必须使用至少一个查询参数来筛选返回的集合。例如,你可以:
- 使用
类型
列出遗留对象记录对象类型键。例子:/ api /阳光/对象/记录?类型= {object_type}
- 使用
id
按id列出遗留对象记录。例子:/ api /阳光/对象/记录?id ={id, id,…}
- 使用
external_id
或external_ids
与类型
返回包含给定遗留对象记录外部id和对象类型键的一条或多条记录的数组。例子:/ api /阳光/对象/记录?类型= {object_type}&external_ids={id,id,。。。}
如果没有提供至少一个过滤参数,将返回一个400错误。
另外,当使用id
过滤器时,响应可能包含一个错误
如果某些id无效,则返回数组。例子:
{
“数据”:[
{
“id”:“14 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
“类型”:“产品”,
“type_version”:1,
“external_id”:“3”,
“属性”:{
“id”:“3”,
“名称”:“草莓口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
}
],
“错误”:[
{
“代码”:“BadRequest”,
“状态”:“400”,
“标题”:“坏请求”,
“细节”:"id 4不是有效的类型1 UUID"
}
]
}
允许
- 每一个人
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
external_ids | 数组 | 查询 | 假 | 根据遗留对象记录外部id返回遗留对象记录 |
id | 数组 | 查询 | 假 | 根据遗留对象记录id返回遗留对象记录 |
订单 | 字符串 | 查询 | 假 | 项目的顺序(按创建时间)。默认为升序。允许的值为"asc"或"desc"。 |
per_page | 字符串 | 查询 | 假 | 每页返回的项数从1到1000 |
类型 | 字符串 | 查询 | 假 | 看到对象类型键 |
object_record_id | 字符串 | 路径 | 真正的 | 遗留对象记录的ID |
代码示例
旋度
#根据对象类型键返回遗留对象记录
旋度“https://{子域名}.zendes亚博k.com/api/sunshine/objects/records ? type =产品”\
- v - u{email_address}:{密码}
#根据对象记录id返回遗留对象记录。
旋度“https://{子域名}.zendes亚博k.com/api/sunshine/objects/records ? id = 14 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf 4”\
- v - u{email_address}:{密码}
#返回一个匹配' type '和' external_id '的遗留记录数组。
旋度“https://{子域名}.zendes亚博k.com/api/sunshine/objects/records ?类型= product&external_id = 18”\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records?external_ids=%5b1%2c3%2c4%5d&ids=%5b%2214c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf%22%5d&order=desc&per_page=1&type=product”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
。newBuilder()
。addQueryParameter(“external_ids”,“(1,3,4)”)
。addQueryParameter(“id”,“(”14c6c4be-cb64-4678-ba73-296年e3d2c32cf“]”)
。addQueryParameter(“秩序”,“desc”)
。addQueryParameter(“per_page”,“1”)
。addQueryParameter(“类型”,“产品”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records”,
头:{
“内容类型”:“application / json”,
},
参数个数:{
“external_ids”:' % b1 % 2 c3 % 2 c4 % 5 d ',
“id”:% 5 b % 2214 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf % 22% 5 d ',
“秩序”:“desc”,
“per_page”:' 1 ',
“类型”:“产品”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records?external_ids=%5b1%2c3%2c4%5d&ids=%5b%2214c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf%22%5d&order=desc&per_page=1&type=product”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
uri。查询=URI。encode_www_form(“external_ids”:“(1,3,4)”,“id”:“(”14c6c4be-cb64-4678-ba73-296年e3d2c32cf“]”,“秩序”:“desc”,“per_page”:“1”,“类型”:“产品”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数据”:[
{
“属性”:{
“id”:“3”,
“名称”:“草莓口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“3”,
“id”:“14 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
},
{
“属性”:{
“id”:“4”,
“名称”:“咖啡口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“4”,
“id”:“d07b6206-1ea1-43c4-ae68-ef743aa36169”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
}
],
“链接”:{
“下一个”:零,
“以前”:零
}
}
列表相关对象记录
GET / api /阳光/对象/记录/ {object_record_id} /相关/ {relationship_type_key}
返回指定遗留对象记录所具有的所有遗留对象记录遗留关系记录,用于指定的关系类型。对于关系类型,指定a关系类型键。对于对象记录,指定一个遗留的自定义对象记录id或一个标准Zendesk对象记录id。亚博
例如,下面的请求返回与id为1edf74c1-8000-4d01-b75e-e14bf2c85442的关系类型中键名为“suppliers”的遗留对象记录相关的所有遗留对象记录:
GET / api /阳光/对象/记录/ 1 edf74c1 - 8000 - 4 - d01 b75e e14bf2c85442 /相关供应商
请参阅下面的示例响应部分。id为1edf74c1-8000-4d01-b75e-e14bf2c85442的遗留自定义对象记录具有到这些对象记录的关系记录,但是它们没有返回到原始对象记录的关系记录。
您可以按照如下方式指定Zendesk亚博对象记录:
GET / api /阳光/对象/记录/禅:用户:123456 /相关供应商
允许
- 每一个人
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
订单 | 字符串 | 查询 | 假 | 项目的顺序(按创建时间)。默认为升序。允许的值为"asc"或"desc"。 |
per_page | 字符串 | 查询 | 假 | 每页返回的项数从1到1000 |
object_record_id | 字符串 | 路径 | 真正的 | 遗留对象记录的ID |
relationship_type_key | 字符串 | 路径 | 真正的 | 遗留关系类型的键 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/objects/records/{id}/ /相关{relationship_type}\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf/related/suppliers?order=desc&per_page=1”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf/related/suppliers”)
。newBuilder()
。addQueryParameter(“秩序”,“desc”)
。addQueryParameter(“per_page”,“1”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf/related/suppliers”,
头:{
“内容类型”:“application / json”,
},
参数个数:{
“秩序”:“desc”,
“per_page”:' 1 ',
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf/related/suppliers?order=desc&per_page=1”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf/related/suppliers”)
uri。查询=URI。encode_www_form(“秩序”:“desc”,“per_page”:“1”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数据”:[
{
“属性”:{
“id”:“3”,
“名称”:“草莓口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“3”,
“id”:“14 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
},
{
“属性”:{
“id”:“4”,
“名称”:“咖啡口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“4”,
“id”:“d07b6206-1ea1-43c4-ae68-ef743aa36169”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
}
],
“链接”:{
“下一个”:零,
“以前”:零
}
}
显示遗留对象记录
GET / api /阳光/对象/记录/ {object_record_id}
返回指定的遗留对象记录。
允许
- 每一个人
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
object_record_id | 字符串 | 路径 | 真正的 | 遗留对象记录的ID |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/objects/records/{id}\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数据”:{
“属性”:{
“id”:“3”,
“名称”:“草莓口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“3”,
“id”:“14 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
“类型”:“产品”,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
}
}
创建遗留对象记录
POST / api /阳光/对象/记录
创建一个遗留对象记录。
除非遗留对象类型的模式包含“additionalProperties”:假的
,您可以为新记录指定其他属性,即使该属性的名称未包含在模式中。例外:不能指定使用星号(*)作为名称或下划线(_)作为名称前缀的附加属性。这些命名约定保留给内部使用。看到模式属性。
如果您创建的记录的属性使用星号作为名称或下划线作为前缀,则应该重命名属性以避免将来可能发生的冲突。
允许
- 每一个人
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/objects/records\
- d“{”数据”:{“类型”:“产品”、“external_id”:“3”,“属性”:{" id ":“3”,“名字”:“草莓口香糖”}}}”\
- h“application / json内容类型:- x的帖子\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records”
方法:=“职位”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“职位”,身体)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“职位”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
请求=网::HTTP::帖子。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
201年创建
//状态201创建
{
“数据”:{
“属性”:{
“id”:“3”,
“名称”:“草莓口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“3”,
“id”:“14 c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 03 t12:35:45z”
}
}
更新遗留对象记录
补丁/ api /阳光/对象/记录/ {object_record_id}
更新属性
指定的遗留对象记录的。它不更新任何其他记录属性。
的属性
对象修补先前存储的遗留对象。因此,请求应该只包含的属性属性
需要更新的对象。
请求必须包含一个"application/merge-patch+json"内容类型的头文件。
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
object_record_id | 字符串 | 路径 | 真正的 | 遗留对象记录的ID |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/objects/records/{id}\
- d”{“数据”:{"属性":{" id ":“4”,“名字”:“热狗口香糖”}}}”\
- h“内容类型:应用程序/ merge-patch + json”- x片\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”
方法:=“补丁”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“补丁”,身体)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“补丁”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“补丁”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”)
请求=网::HTTP::补丁。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数据”:{
“属性”:{
“id”:“4”,
“名称”:“热狗口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“4”,
“id”:“d07b6206-1ea1-43c4-ae68-ef743aa36169”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 04 - t18:15:00z”
}
}
按外部Id设置遗留对象记录
补丁/ api /阳光/对象/记录
如果具有给定外部id的对象不存在,则创建一个新的遗留对象并更新属性
如果具有给定外部id的对象确实存在,则返回指定对象记录的对象。此端点不更新任何其他记录属性。
请求应包括:
- 遗留对象类型
- 外部id
属性
需要更新的遗留对象的
请求必须包含一个"application/merge-patch+json"内容类型的头文件。
有些框架(比如。net)会自动将UTF-8字符集添加到内容类型头中。例如:
内容类型:application / json merge-patch +;utf - 8字符集=
这将导致400 Bad Request响应。删除utf - 8字符集=
修复错误。
允许
- 每一个人
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/objects/records\
- d“{”数据”:{“类型”:“产品”、“external_id”:“4”,“属性”:{" id ":“4”,“名字”:“热狗口香糖”}}}”\
- h“内容类型:应用程序/ merge-patch + json”- x片\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records”
方法:=“补丁”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“补丁”,身体)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“补丁”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“补丁”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
请求=网::HTTP::补丁。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数据”:{
“属性”:{
“id”:“4”,
“名称”:“热狗口香糖”
},
“created_at”:“2017 - 01 - 03 t12:35:45z”,
“external_id”:“4”,
“id”:“d07b6206-1ea1-43c4-ae68-ef743aa36169”,
“类型”:“产品”,
“type_version”:1,
“updated_at”:“2017 - 01 - 04 - t18:15:00z”
}
}
删除遗留对象记录
删除/ api /阳光/对象/记录/ {object_record_id}
删除指定的遗留对象记录。
在删除遗留对象记录之前,必须删除指定遗留对象记录的任何关系记录。看到关系的记录。
允许
- 每一个人
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
object_record_id | 字符串 | 路径 | 真正的 | 遗留对象记录的ID |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/sunshine/objects/records/{id}\
- x删除\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”
方法:=“删除”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“删除”,零)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“删除”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“删除”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records/14c6c4be cb64 - 4678 ba73 - 296 e3d2c32cf”)
请求=网::HTTP::删除。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
204无内容
//状态204无内容
零
根据外部Id和类型删除遗留对象记录
删除/ api /阳光/对象/记录?external_id = {external_id} +类型={类型}
删除指定的遗留对象记录(如果存在)。
在删除遗留对象记录之前,必须删除指定遗留对象记录的任何关系记录。看到关系的记录。
允许
- 每一个人
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
external_id | 字符串 | 查询 | 真正的 | 遗留对象记录的外部ID |
类型 | 字符串 | 查询 | 真正的 | 看到对象类型键 |
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/sunshine/objects/records ?类型= product&external_id = 1”\
- x删除\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://support.亚博zendesk.com/api/sunshine/objects/records?external_id=4&type=product”
方法:=“删除”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
。newBuilder()
。addQueryParameter(“external_id”,“4”)
。addQueryParameter(“类型”,“产品”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“删除”,零)
。addHeader(“内容类型”,“application / json”)
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“删除”,
url:“https://support.亚博zendesk.com/api/sunshine/objects/records”,
头:{
“内容类型”:“application / json”,
},
参数个数:{
“external_id”:“4”,
“类型”:“产品”,
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/sunshine/objects/records?external_id=4&type=product”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“删除”,
url,
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/sunshine/objects/records”)
uri。查询=URI。encode_www_form(“external_id”:“4”,“类型”:“产品”)
请求=网::HTTP::删除。新(uri,“内容类型”:“application / json”)
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
204无内容
//状态204无内容
零