Ticket Fields 工单自定义字段接口
JSON格式
| Name | Type | Read-only | Comment |
|---|---|---|---|
| id | integer | yes | 工单字段id，由系统自动分配 |
| url | string | yes | 当前资源url |
| name | string | yes | 工单字段的名称，格式为"field_{id}" |
| type | string | no | 字段类型 |
| agent_title | string | no | 字段对客服的显示名称 |
| agent_required | boolean | no | 客服在处理工单时是否必填 |
| enduser_visible | boolean | no | 普通用户提交工单时能否看到字段 |
| enduser_title | string | no | 字段对普通用户的显示名称 |
| enduser_editable | boolean | no | 普通用户是否能编辑此字段 |
| enduser_description | string | no | 对普通用户显示的字段说明 |
| enduser_required | boolean | no | 客服在提交工单时是否必填 |
| active | boolean | no | 字段是否启用 |
| cascade_id | inter | yes | 该字段属于的级联字段id |
| cascade_value | mix | yes | 该字段属于级联字段下的选项 |
| custom_field_options | array | no | 下拉菜单字段的选项数组 |
| regexp_for_validation | array | no | 正则匹配字段的表达式 |
JSON 示例
{
"id": 4,
"url": "https://support.kf5.com/apiv2/ticket_fields/4.json",
"name": "field_4",
"type": "dropdownlist",
"agent_title": "问题类型",
"agent_required": true,
"enduser_visible": true,
"enduser_title": "请选择问题类型",
"enduser_editable": true,
"enduser_description": "",
"enduser_required": true,
"active": true,
"custom_field_options": [
{
"key": "反馈建议",
"value": "反馈建议"
},
{
"key": "产品问题",
"value": "产品问题"
}
]
}
工单自定义字段列表
GET /apiv2/ticket_fields.json
调用权限
agents
也可以使用如下API：
获取状态为启用的自定义字段列表
GET /apiv2/ticket_fields/active.json
curl 示例
curl https://{subdomain}.kf5.com/apiv2/ticket_fields.json \
-v -u {email_address}:{password}
返回示例
Status: 200 OK
{
"ticket_fields":[
{
"id": 4,
"url": "https://support.kf5.com/apiv2/ticket_fields/4.json",
"name": "field_4",
"type": "dropdownlist",
"agent_title": "问题类型",
"agent_required": true,
"enduser_visible": true,
"enduser_title": "请选择问题类型",
"enduser_editable": true,
"enduser_description": "",
"enduser_required": true,
"active": true,
"custom_field_options": [
{
"key": "反馈建议",
"value": "反馈建议"
},
{
"key": "产品问题",
"value": "产品问题"
}
]
}
]
}
查看自定义字段
GET /apiv2/ticket_fields/{id}.json
调用权限
agents
curl 示例
curl https://{subdomain}.kf5.com/apiv2/ticket_fields/{id}.json \
-v -u {email_address}:{password}
返回示例
Status: 200 OK
{
"ticket_field":{
"id": 4,
"url": "https://support.kf5.com/apiv2/ticket_fields/4.json",
"name": "field_4",
"type": "dropdownlist",
"agent_title": "问题类型",
"agent_required": true,
"enduser_visible": true,
"enduser_title": "请选择问题类型",
"enduser_editable": true,
"enduser_description": "",
"enduser_required": true,
"active": true,
"custom_field_options": [
{
"key": "反馈建议",
"value": "反馈建议"
},
{
"key": "产品问题",
"value": "产品问题"
}
]
}
}
级联字段的属性说明
级联字段下面，只包含一层选项，所以该字段的custom_field_options与下拉字段的格式一致。
{
"ticket_field":{
...
"id":"751",
"type":"cascade",
"name":"field_751",
"agent_title":"级联菜单1",
"custom_field_options": [
{
"key": "级联1文本",
"value": "级联1文本"
},
{
"key": "级联2日期",
"value": "级联2日期"
}
]
}
}
如果一个字段属于级联字段，则该字段将有cascade_id和cascade_value两个额外属性。
{
"ticket_field":{
...
"id":"742",
"type":"int",
"name":"field_742",
"agent_title":"文本框",
...
"cascade_id":"751",
"cascade_value":"级联1文本"
}
}
"cascade_id":"751" 表示该字段属于field_751级联字段下，
"cascade_value":"级联1文本" 表示该字段属于field_751级联字段的选项："级联1文本"下。
三级级联字段的属性说明
三级级联字段下面，包含了数层结构。
custom_field_options属性中,表示该三级级联字段有"数字""文本"两个分支，
"数字"分支下有"111""222"两个选项，"文本"分支下有"44444"66666"两个选项。
{
"ticket_field":{
...
"id":"709",
"type":"multi_cascade",
"name":"field_709",
"agent_title":"三级级联",
"custom_field_options": [
{
"key": "数字",
"value": "数字"
"sub_items": [
"111",
"222"
]
},
{
"key": "文本",
"value": "文本"
"sub_items": [
"44444",
"66666"
]
}
]
}
}
如果一个字段属于三级级联字段，则该字段将有cascade_id和cascade_value两个额外属性。
{
"ticket_field":{
...
"id":"730",
"type":"date",
"name":"field_730",
"agent_title":"日期",
...
"cascade_id":"709",
"cascade_value": [
"数字",
"111"
]
}
}
"cascade_id":"709" 表示该字段属于field_709三级级联字段下，
"cascade_value":["数字","111"] 表示该字段属于field_709三级级联字段的"数字"下的"111"选项下。
删除自定义字段
DELETE /apiv2/ticket_fields/{id}.json
调用权限
admin
curl示例
curl https://{subdomain}.kf5.com/apiv2/ticket_fields/{id}.json \
-v -u {email_address}:{password} -X DELETE
返回示例
Status: 200 OK