工单字典接口
1.查询工单字典接口
- 接口请求方式：POST
- 接口参数格式：json
- 请求链接：{HOST}/v20210827/business/queryDictionary/{ACCOUNTID}?sig=SIG
- 请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
- 鉴权文档：接口鉴权
- 频次限制：20次/每分钟
请求参数
| 字段名 |
字段类型 |
是否必填 |
字段描述 |
| _id |
String |
否 |
字典id，根据字典id查询 |
| name |
String |
否 |
查询条件，根据字典名称查询 |
| page |
number |
否，默认1 |
页数 |
| pageSize |
number |
否，默认10 |
每页大小 |
请求体示例
{
"_id":"75cf1273-042e-a83d-8118-ddfb50af4ac1",
"name":"字典名字",
"page":1,
"pageSize":10
}
返回示例
{
"code": 200,
"success": true,
"message": "success!",
"list": [
{
"_id": "75cf1273-042e-a83d-8118-ddfb50af4ac1",
"accountId": "N00000046053",
"name": "修改接口三级",
"cascade": "3",
"headers": [
"接口新增1",
"接口新增2",
"接口新增3"
],
"createTime": "2021-12-03 15:16:12",
"biUpdateTime": "2021-12-03 15:52:10",
"options": [
{
"name": "李婷测试接口3",
"key": "2546b891-9593-64b0-82e0-3485251c6a5a",
"state": "1",
"options": [
{
"name": "嘿嘿1",
"key": "9056baed-c79c-cf29-f718-d76a02741076",
"state": "1",
"options": [
{
"name": "滴滴2",
"key": "85a9691d-331a-0f23-afa2-a093e2c1c371",
"state": "1",
"options": [],
"level": 3
}
],
"level": 2
}
],
"level": 1
}
],
"updateTimeArr": [
{
"updateTime": "2021-12-03 15:52:10",
"updateUser": "3c4a5fa0-b812-11e9-b8d5-ed6d6e27def9"
}
]
}
],
"count": 1
}
返回字段说明
| 字段名 |
字段类型 |
字段描述 |
| code |
字符串 |
请求结果状态码请（200、403、400、500等） |
| success |
Boolean |
请求是否成功 true |
| message |
String |
请求结果说明 |
| list |
Array[] |
返回值结果 |
| count |
number |
结果数目 |
返回字典内容字段说明
| 字段名 |
字段类型 |
字段描述 |
| name |
string |
字典名称 |
| _id |
string |
字典id |
| options |
Array[] |
字典内容（同修改工单字典接口） 单个数据： key: string，字典key id name: string, 字典值 state:string，启用2，停用1 options:array, 下级字典对象 |
| createTime |
string |
创建时间 |
| headers |
string数组 |
各级标题 |
| accountId |
string |
账户id |
| cascade |
String |
字典级联级数 |
2.新增工单字典接口
- 接口请求方式：POST
- 接口参数格式：json
- 请求链接：{HOST}/v20210827/business/addDictionary/{ACCOUNTID}?sig=SIG
- 请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
- 鉴权文档：接口鉴权
- 频次限制：20次/每分钟
请求参数
| 字段名 |
字段类型 |
是否必填 |
字段描述 |
| _id |
String |
是 |
字典id，格式为标准的uuid，比如“24066b93-bbab-4d41-9321-bf7e8ce40bd2”(不能重复)
|
| name |
String |
是 |
字典名称（不能重复） |
| cascade |
String |
是 |
字典级数 |
| headers |
Array[string] |
是 |
字典每级的标题，数组大小对应字典级数 示例："headers":[ "一级标题", "二级标题", "三级标题", "四级标题" ] |
| options |
Array[Object] |
否 |
字典内容（options级数不可大于cascade） 注意：添加某个字典时，按统一格式插入即可，key值需要重新生成且不能重复，格式为标准的uuid，比如“24066b93-bbab-4d41-9321-bf7e8ce40bd2” |
注意：新增时，请满足以下约束条件。比如字典名称不能重复；同级字典名称不能重复；header标题不能为空；同一个字典级别必须有一个启用的字典等。验证出错时，会统一返回格式无效，修改失败。
请求体示例
{
"_id": "2d9b11fb-364d-7ee4-b726-b0893daad58d",
"name": "接口五级",
"cascade": "5",
"headers": [
"接口新增1",
"接口新增2",
"接口新增3",
"接口新增4",
"接口新增5"
],
"options": [
{
"name": "李婷测试接口",
"key": "a1585b5b-f89d-0582-1161-540e9914bbc5",
"state": "2",
"options": [
{
"name": "嘿嘿",
"key": "25b9ed27-af09-e05c-8976-cc99a7025caa",
"state": "1",
"options": [
{
"name": "滴滴",
"key": "c9d96949-423d-1e68-6cda-409ae2c3d561",
"state": "2",
"options": [
{
"name": "嘻嘻",
"key": "8498c7a1-74b2-3cdc-a12c-b647700ae056",
"state": "2",
"options": [
{
"name": "啦啦",
"key": "c0535f45-2b4c-d818-9cf3-c46285fcda47",
"state": "2",
"options": []
}
]
}
]
}
]
}
]
}
]
}
返回示例
{
"code": "200",
"success": "true",
"message": "success!"
}
{
"code": 400,
"success": false,
"message": "this dictionary id or name is exist"
}
3.修改工单字典接口
- 接口请求方式：POST
- 接口参数格式：json
- 请求链接：{HOST}/v20210827/business/updateDictionary/{ACCOUNTID}?sig=SIG
- 请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
- 鉴权文档：接口鉴权
- 频次限制：20次/每分钟
请求参数
| 字段名 |
字段类型 |
是否必填 |
字段描述 |
| _id |
String |
否 |
字典id，系统根据id匹配要修改的字典 |
| name |
String |
否，不传时不做修改 |
字典名称 |
| cascade |
String |
否，不传时不做修改 |
字典级数 |
| headers |
Array[string] |
否，不传时不做修改 |
字典每级的标题，数组大小对应字典级数 示例："headers":[ "一级标题", "二级标题", "三级标题", "四级标题" ] |
| options |
Array[Object] |
否，不传时不做修改 |
字典内容（参照查询返回的数据结构进行修改） 注意：修改时，字典的key不要调整，系统根据key匹配要修改的具体字典 |
注意：修改时，请满足以下约束条件。比如字典名称不能重复；同级字典名称不能重复；header标题不能为空；同一个字典级别必须有一个启用的字典等。验证出错时，会统一返回格式无效，修改失败。
请求头示例
{
"_id": "75cf1273-042e-a83d-8118-ddfb50af4ac1",
"name": "修改接口三级",
"cascade": "3",
"headers": [
"接口新增1",
"接口新增2",
"接口新增3"
],
"options": [
{
"name": "李婷测试接口3",
"key": "2546b891-9593-64b0-82e0-3485251c6a5a",
"state": "1",
"options": [
{
"name": "嘿嘿1",
"key": "9056baed-c79c-cf29-f718-d76a02741076",
"state": "1",
"options": [
{
"name": "滴滴2",
"key": "85a9691d-331a-0f23-afa2-a093e2c1c371",
"state": "1",
"options": []
}
]
}
]
}
]
}
返回结果
{
"code": 200,
"success": true,
"message": "success!"
}
{
"code": 400,
"success": false,
"message": "字典项第一级至少有一个启用"
}
{
"code": 400,
"success": false,
"message": "Please check your parameters, not found this dictionary"
}