组织领域
您可以使用这个API在Zendesk用户界面的Organization页面中添加字段。亚博基本的文本字段、日期字段以及可定制的下拉列表和数字字段都是可用的。这些字段对应于管理员可以使用Zendesk管理界面添加的组织字段。亚博看到向组织添加自定义字段在Ze亚博ndesk帮助。
这些字段仅对代理和管理员可见。
关于下拉框
大多数自定义字段允许代理输入单个值，如自由格式的文本或日期。下拉字段允许代理从选项列表中进行选择。每个选项都有一个对代理可见的名称和一个不可见的底层值。在API中，这些选项在下拉框中列出custom_field_options财产。列表中的每个选项都有一个的名字而且价值财产。在Zendes亚博k管理界面中，这些属性对应于“Name”和“Tag”字段。
JSON格式
组织字段表示为具有以下属性的JSON对象:
| 的名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| 活跃的 | 布尔 | 假 | 假 | 如果为true，则该字段可用 |
| created_at | 字符串 | 真正的 | 假 | 票据字段的最后一次更新时间 |
| custom_field_options | 数组 | 假 | 假 | 类型为“dropdown”的自定义字段需要并显示。每个选项都由一个对象表示的名字而且价值财产 |
| 描述 | 字符串 | 假 | 假 | 用户自定义对该字段用途的描述 |
| id | 整数 | 真正的 | 假 | 在创建时自动分配 |
| 关键 | 字符串 | 假 | 真正的 | 标识此自定义字段的唯一键。这用于更新字段和在占位符中引用。删除后不能重复使用。 |
| 位置 | 整数 | 假 | 假 | 字段相对于其他字段的顺序 |
| raw_description | 字符串 | 假 | 假 | 动态内容占位符(如果存在)或描述价值，如果不是。看到动态内容项 |
| raw_title | 字符串 | 假 | 假 | 动态内容占位符(如果存在)或标题价值，如果不是。看到动态内容项 |
| regexp_for_validation | 字符串 | 假 | 假 | 仅限正则表达式字段。字段值被认为有效的验证模式 |
| relationship_filter | 对象 | 假 | 假 | 允许自动完成过滤结果的筛选器定义 |
| relationship_target_type | 字符串 | 假 | 假 | 字段引用对象类型的表示。选项包括“zen:用户”，“zen:组织”，“zen:票证” |
| 系统 | 布尔 | 真正的 | 假 | 如果为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/organization_fields/7.json”｝
组织字段列表
GET / api / v2 / organization_fields
返回帐户中的自定义组织字段列表。字段将按照您在Zendesk Support中的组织字段配置中指定的顺序返回。亚博属性下返回的值，并将每个组织字段的键映射到该属性下返回的值organization_fields属性上的组织资源。
分页
- 游标分页(推荐)
- 抵消分页
看到分页．
每页最多返回100条记录。
允许
- 代理
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields.json＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/organization_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（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/organization_fields”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/organization_fields”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/organization_fields”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“数”：1，“next_page”：零，“organization_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/organization_fields/7.json”｝］，“previous_page”：零｝
显示组织字段
GET / api / v2 / organization_fields / {organization_field_id}
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| organization_field_id | 路径 | 真正的 | 组织字段的ID或键 |
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields/｛organization_field_id｝. json＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/organization_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（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“organization_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/organization_fields/7.json”｝｝
创建组织字段
POST / api / v2 / organization_fields
创建以下任意自定义字段类型:
- 文本(没有指定“类型”时为默认值)
- 文本区域
- 复选框
- 日期
- 整数
- 小数
- 正则表达式
- 下拉
- 查找
看到关于自定义字段类型在Ze亚博ndesk帮助。
允许
- 管理员
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields.json＼- h“application / json内容类型:- x的帖子＼- d'{"organization_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/organization_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（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“职位”，url：“https://example.亚博zendesk.com/api/v2/organization_fields”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/organization_fields”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“职位”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/organization_fields”）请求＝网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
201年创建
//状态201已创建｛“organization_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/organization_fields/75.json”｝｝
更新组织字段
把/ api / v2 / organization_fields / {organization_field_id}
更新下拉标签字段
的下拉字段返回数组custom_field_options指定下拉选项的名称、值和顺序。更新下拉字段时，需要注意以下事项:
- 所有选项必须在更新时传递。未通过的选项将被删除。因此，这些值将从任何组织中删除
- 要创建一个新选项，传递一个空值
id伴随着的名字而且价值 - 若要更新现有选项，请传递其
id伴随着的名字而且价值 - 要重新排序一个选项，请在
custom_field_options数组相对于其他选项 - 若要删除一个选项，请在更新时将其从选项列表中删除
示例请求
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields/｛organization_field_id｝. json＼- h“application / json内容类型:- x将＼- d”{organization_field”:{“custom_field_options”:[{" id ": 124年,“名字”:“选项2”,“价值”:“option_2”},{" id ": 123年,“名字”:“选项1”,“价值”:“option_1”},{" id ": 125年,“名字”:“选项3”,“价值”:“option_3”}]}}”＼- v - u｛email_address｝：｛密码｝
允许
- 管理员
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| organization_field_id | 路径 | 真正的 | 组织字段的ID或键 |
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields/｛organization_field_id｝. json＼- h“application / json内容类型:- x将＼- d{"organization_field": {"title": "支持描述"}}＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/organization_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（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“把”，url：“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“organization_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/organization_fields/75.json”｝｝
删除组织字段
删除/ api / v2 / organization_fields / {organization_field_id}
允许
- 管理员
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| organization_field_id | 路径 | 真正的 | 组织字段的ID或键 |
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields/｛organization_field_id｝. json＼- v - u｛email_address｝：｛密码｝- x删除
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/organization_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（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“删除”，url：“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“删除”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/organization_fields/my_text_field”）请求＝网：：HTTP：：删除．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
204无内容
//状态204无内容零
重新排序组织字段
把/ api / v2 / organization_fields /重新排序
允许
- 管理员
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/organization_fields/reorder.json＼- v - u｛email_address｝：｛密码｝-X PUT -d“{"organization_field_ids":[3,4]}”- h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/organization_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（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“把”，url：“https://example.亚博zendesk.com/api/v2/organization_fields/reorder”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/organization_fields/reorder”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
Ruby
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/organization_fields/reorder”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK零