用户字段
您可以使用此API向Zendesk用户界面中的用户配置文件页面添加字段。亚博基本文本字段、日期字段以及可自定义的下拉框和数字字段都是可用的。这些字段对应于管理员可以使用Zendesk管理界面添加的用户字段。亚博看到向用户添加自定义字段在Ze亚博ndesk帮助。
这些字段仅对代理和管理员可见。
关于下拉字段
大多数自定义字段允许代理输入单个值,如自由格式文本或日期。下拉字段允许代理从选项列表中进行选择。每个选项都有一个对代理可见的名称和一个不可见的基础值。在API中,这些选项在下拉字段中列出custom_field_options
财产。列表中的每个选项都有名字
和价值
财产。在Zendes亚博k管理界面中,这些属性对应于“Name”和“Tag”字段。
JSON格式
用户字段表示为具有以下属性的JSON对象:
名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
活跃的 | 布尔 | 假 | 假 | 如果为true,则此字段可供使用 |
created_at | 字符串 | 真正的 | 假 | 票证字段最后一次更新的时间 |
custom_field_options | 数组 | 假 | 假 | 需要并提出了类型“下拉”的自定义字段。每个选项都由一个对象表示名字 和价值 财产 |
描述 | 字符串 | 假 | 假 | 用户自定义对该字段用途的描述 |
id | 整数 | 真正的 | 假 | 创建时自动分配 |
关键 | 字符串 | 假 | 真正的 | 标识此自定义字段的唯一键。这用于更新字段和引用占位符。删除后不能重用。 |
位置 | 整数 | 假 | 假 | 字段相对于其他字段的排序 |
raw_description | 字符串 | 假 | 假 | 动态内容占位符(如果存在)或描述 价值,如果不是的话。看到动态内容项 |
raw_title | 字符串 | 假 | 假 | 动态内容占位符(如果存在)或标题 价值,如果不是的话。看到动态内容项 |
regexp_for_validation | 字符串 | 假 | 假 | 仅限正则表达式字段。将字段值视为有效的验证模式 |
relationship_filter | 对象 | 假 | 假 | 一个过滤器定义,允许您的自动完成过滤结果 |
relationship_target_type | 字符串 | 假 | 假 | 表示字段引用的对象类型。选项为“zen:user”,“zen:organization”,“zen:ticket”。 |
系统 | 布尔 | 真正的 | 假 | 如果为true,则只能更改该字段的活动值和位置值 |
标签 | 字符串 | 假 | 假 | 可选的自定义字段类型为“checkbox”;另有说明。 |
标题 | 字符串 | 假 | 真正的 | 自定义字段的标题 |
类型 | 字符串 | 假 | 真正的 | 自定义字段类型:“复选框”、“日期”、“小数”、“下拉”、“整数”、“查找”, "regexp", "text",或"textarea" |
updated_at | 字符串 | 真正的 | 假 | 票证字段最后一次更新的时间 |
url | 字符串 | 真正的 | 假 | 此资源的URL |
例子
{
“活跃”:真正的,
“created_at”:“2012 - 10 - 16 - t16:04:06z”,
“描述”:“自定义字段描述”,
“id”:7,
“关键”:“custom_field_1”,
“位置”:9999,
“raw_description”:“{{dc.my_description}}”,
“raw_title”:“自定义字段1”,
“regexp_for_validation”:零,
“标题”:“自定义字段1”,
“类型”:“文本”,
“updated_at”:“2012 - 10 - 16 - t16:04:06z”,
“url”:“https://company.亚博zendesk.com/api/v2/user_fields/7.json”
}
列出用户字段
GET / api / v2 / user_fields
返回帐户中自定义用户字段的列表。字段将按照您在Zendesk Support中的用户字段配置中指定的顺序返回。亚博客户端应该在API使用期间缓存此资源,并将每个User Field的键映射到属性下返回的值user_fields
属性上的用户资源。
分页
- 游标分页(推荐)
- 抵消分页
看到分页。
每页最多返回100条记录。
允许
- 代理
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields.json\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://example.亚博zendesk.com/api/v2/user_fields”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数”:1,
“next_page”:零,
“previous_page”:零,
“user_fields”:[
{
“活跃”:真正的,
“created_at”:“2012 - 10 - 16 - t16:04:06z”,
“描述”:“自定义字段描述”,
“id”:7,
“关键”:“custom_field_1”,
“位置”:9999,
“raw_description”:“{{dc.my_description}}”,
“raw_title”:“自定义字段1”,
“regexp_for_validation”:零,
“标题”:“自定义字段1”,
“类型”:“文本”,
“updated_at”:“2012 - 10 - 16 - t16:04:06z”,
“url”:“https://company.亚博zendesk.com/api/v2/user_fields/7.json”
}
]
}
显示用户字段
GET / api / v2 / user_fields / {user_field_id}
允许
- 代理
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}. json\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“user_field”:{
“活跃”:真正的,
“created_at”:“2012 - 10 - 16 - t16:04:06z”,
“描述”:“自定义字段描述”,
“id”:7,
“关键”:“custom_field_1”,
“位置”:9999,
“raw_description”:“{{dc.my_description}}”,
“raw_title”:“自定义字段1”,
“regexp_for_validation”:零,
“标题”:“自定义字段1”,
“类型”:“文本”,
“updated_at”:“2012 - 10 - 16 - t16:04:06z”,
“url”:“https://company.亚博zendesk.com/api/v2/user_fields/7.json”
}
}
创建用户字段
POST / api / v2 / user_fields
创建以下任何自定义字段类型:
- 文本(未指定"type"时的默认值)
- 文本区域
- 复选框
- 日期
- 整数
- 小数
- 正则表达式
- 下拉
- 查找
看到关于自定义字段类型在Ze亚博ndesk帮助。
允许
- 管理员
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields.json\
- h“application / json内容类型:- x的帖子\
- d{"user_field": {"type": "text", "title": "Support description",
description:描述该用户拥有的支持计划。
"position": 0, "active": true, "key": "support_description"}}'\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields”
方法:=“职位”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“职位”,身体)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“职位”,
url:“https://example.亚博zendesk.com/api/v2/user_fields”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields”)
请求=网::HTTP::帖子。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
201年创建
//状态201创建
{
“user_field”:{
“活跃”:真正的,
“created_at”:“2013 - 02 - 27 t20:35:55z”,
“描述”:"此字段描述该用户拥有的支持计划",
“id”:75,
“关键”:“support_description”,
“位置”:0,
“raw_description”:"此字段描述该用户拥有的支持计划",
“raw_title”:“支持描述”,
“regexp_for_validation”:零,
“标题”:“支持描述”,
“类型”:“文本”,
“updated_at”:“2013 - 02 - 27 t20:35:55z”,
“url”:“https://company.亚博zendesk.com/api/v2/user_fields/75.json”
}
}
更新用户字段
把/ api / v2 / user_fields / {user_field_id}
更新下拉(标签)字段
下拉字段返回一个数组custom_field_options
指定下拉选项列表的名称、值和顺序。当更新下拉字段时,理解以下行为:
- 所有选项必须在更新时传递。未传递的选项将被删除。因此,这些值将从任何组织中删除。
- 要创建一个新选项,传递一个null
id
随着名字
和价值
。 - 要更新现有选项,请传递其
id
随着名字
和价值
。 - 要重新排序选项,请将其重新定位在
custom_field_options
数组相对于其他选项。 - 要删除一个选项,请在更新时将其从选项列表中省略。
示例请求
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}. json\
- h“application / json内容类型:- x将\
- d”{user_field”:{“custom_field_options”:[{" id ": 124年,“名字”:“选项2”,“价值”:“option_2”},{" id ": 123年,“名字”:“选项1”,“价值”:“option_1”},{" id ": 125年,“名字”:“选项2”,“价值”:“option_3”}]}}”\
- v - u{email_address}:{密码}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}. json\
- h“application / json内容类型:- x将\
- d'{"user_field": {"title": "支持描述"}}'\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”
方法:=“把”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“把”,身体)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“把”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“把”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”)
请求=网::HTTP::把。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“user_field”:{
“活跃”:真正的,
“created_at”:“2013 - 02 - 27 t20:35:55z”,
“描述”:"此字段描述该用户拥有的支持计划",
“id”:75,
“关键”:“support_description”,
“位置”:0,
“raw_description”:"此字段描述该用户拥有的支持计划",
“raw_title”:“支持描述”,
“regexp_for_validation”:零,
“标题”:“支持描述”,
“类型”:“文本”,
“updated_at”:“2013 - 02 - 27 t20:35:55z”,
“url”:“https://company.亚博zendesk.com/api/v2/user_fields/75.json”
}
}
删除用户字段
删除/ api / v2 / user_fields / {user_field_id}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}. json\
- v - u{email_address}:{密码}- x删除
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”
方法:=“删除”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“删除”,零)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“删除”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“删除”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field”)
请求=网::HTTP::删除。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
204无内容
//状态204无内容
零
重新排序用户字段
把/ api / v2 / user_fields /重新排序
允许
- 管理员
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/reorder.json - h“application / json内容类型:\
- v - u{email_address}:{密码}-X PUT -d'{"user_field_ids": [3,4]}'
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/reorder”
方法:=“把”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/reorder”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“把”,身体)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“把”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/reorder”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/reorder”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“把”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/reorder”)
请求=网::HTTP::把。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
零
列出用户字段选项
GET / api / v2 / user_fields / {user_field_id} /选项
返回给定下拉用户字段的自定义用户字段选项列表。
分页
- 游标分页(推荐)
- 抵消分页
看到分页。
每页最多返回100条记录。
允许
- 代理
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}/ options.json\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“数”:2,
“custom_field_options”:[
{
“id”:10000,
“名称”:“苹果”,
“位置”:0,
“raw_name”:“苹果”,
“url”:“http://{子域名}.zendes亚博k.com/api/v2/user_fields/1/options/10000.json”,
“价值”:“苹果”
},
{
“id”:10001,
“名称”:“香蕉”,
“位置”:1,
“raw_name”:“香蕉”,
“url”:“http://{子域名}.zendes亚博k.com/api/v2/user_fields/1/options/10001.json”,
“价值”:“香蕉”
}
],
“next_page”:零,
“previous_page”:零
}
显示用户字段选项
GET / api / v2 / user_fields / {user_field_id} /选项/ {user_field_option_id}
允许
- 代理
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 | |
user_field_option_id | 整数 | 路径 | 真正的 | 用户字段选项的ID |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}/选项/{user_field_option_id}. json\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”
方法:=“获得”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“获得”,零)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”)
请求=网::HTTP::得到。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“custom_field_option”:{
“id”:10001,
“名称”:“香蕉”,
“位置”:1,
“raw_name”:“香蕉”,
“url”:“http://{子域名}.zendes亚博k.com/api/v2/user_fields/1/options/10001.json”,
“价值”:“香蕉”
}
}
创建或更新用户字段选项
POST / api / v2 / user_fields / {user_field_id} /选项
为给定的下拉用户字段创建新选项或更新现有选项。
控件中包含该选项的id,即可更新该选项custom_field_option
对象。例子:{" custom_field_option ": {" id ": 10002年,“名字”:“菠萝”,…}
。如果给定ID存在一个选项,则该选项将被更新。否则,将创建一个新选项。
响应
返回以下状态码之一:
- 200年,
地点:/ api / v2 / user_fields / {user_field_id} / options.json
如果数据库中已经存在用户字段选项 - 201年,
地点:/ api / v2 / user_fields / {user_field_id} / options.json
如果用户字段选项是新的
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 |
代码示例
旋度
创建用户字段选项
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}/ options.json\
- h“application / json内容类型:- x的帖子\
- d”{custom_field_option”:{“名称”:“葡萄”,“位置”:2,“价值”:“葡萄”}}”\
- v - u{email_address}:{密码}
旋度
更新用户字段选项
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}/ options.json\
- h“application / json内容类型:- x的帖子\
- d”{custom_field_option”:{" id ": 10002年,“名字”:“菠萝”,“位置”:2,“价值”:“菠萝”}}”\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”
方法:=“职位”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”)
。newBuilder();
RequestBody身体=RequestBody。创建(MediaType。解析(“application / json”),
”“”
”“”);
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“职位”,身体)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“职位”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options”)
请求=网::HTTP::帖子。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
200好了
//状态200 OK
{
“custom_field_option”:{
“id”:10002,
“名称”:“菠萝”,
“位置”:2,
“raw_name”:“菠萝”,
“url”:“http://{子域名}.zendes亚博k.com/api/v2/user_fields/1/options/10002.json”,
“价值”:“菠萝”
}
}
201年创建
//状态201创建
{
“custom_field_option”:{
“id”:10002,
“名称”:“葡萄”,
“位置”:2,
“raw_name”:“葡萄”,
“url”:“http://{子域名}.zendes亚博k.com/api/v2/user_fields/1/options/10002.json”,
“价值”:“葡萄”
}
}
删除用户字段选项
删除/ api / v2 / user_fields / {user_field_id} /选项/ {user_field_option_id}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_field_id | 路径 | 真正的 | 用户字段的ID或键 | |
user_field_option_id | 整数 | 路径 | 真正的 | 用户字段选项的ID |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/user_fields/{user_field_id}/选项/{user_field_option_id}. json\
- v - u{email_address}:{密码}- x删除
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url:=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”
方法:=“删除”
要求的事情,犯错:=http。NewRequest(方法,url,零)
如果犯错! =零{
fmt。Println(犯错)
返回
}
要求的事情。头。添加(“内容类型”,“application / json”)
要求的事情。头。添加(“授权”,“基本< auth-value >”)// Base64编码的"username:password"
客户端:=&http。客户端{}
res,犯错:=客户端。做(要求的事情)
如果犯错! =零{
fmt。Println(犯错)
返回
}
推迟res。身体。关闭()
身体,犯错:=io。ReadAll(res。身体)
如果犯错! =零{
fmt。Println(犯错)
返回
}
fmt。Println(字符串(身体))
}
Java
进口com。squareup。okhttp。*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl。构建器urlBuilder=HttpUrl。解析(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”)
。newBuilder();
请求请求=新请求。构建器()
。url(urlBuilder。构建())
。方法(“删除”,零)
。addHeader(“内容类型”,“application / json”)
。addHeader(“授权”,凭证。基本(“电子邮件”,“你的密码”))
。构建();
响应响应=客户端。newCall(请求)。执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“删除”,
url:“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
。然后(函数(响应){
控制台。日志(JSON。stringify(响应。数据));
})
。抓(函数(错误){
控制台。日志(错误);
});
Python
进口请求
url=“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”
头={
“内容类型”:“application / json”,
}
响应=请求。请求(
“删除”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应。文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://example.亚博zendesk.com/api/v2/user_fields/my_text_field/options/10001”)
请求=网::HTTP::删除。新(uri,“内容类型”:“application / json”)
请求。basic_auth“用户名”,“密码”
响应=网::HTTP。开始uri。主机名,uri。港口,use_ssl:真正的做|http|
http。请求(请求)
结束
示例响应(年代)
204无内容
//状态204无内容
零