查询工单类型列表

场景描述

按照条件查询工单类型列表，支持按照类型名称模糊查询、状态过滤和分页查询，默认最大分页100条。

接口方法

POST

接口URL

https://域名/service/AICC__Case/1.0.0/openapi/caseType/list，例如域名是service.besclouds.com。

请求说明

表1 请求头参数
序号	名称	参数类型	是否必选	说明
1	Content-Type	string	True	消息正文的类型为JSON
2	access-token	string	True	用户访问租间token

表2 请求体参数
序号	名称	参数类型	长度（字节）	是否必选	说明
1	typeName	string	128	False	工单类型名称模糊查询
2	status	string	-	False	类型状态，Active/Inactive
3	start	number	-	True	起始行数。（min:0）
4	limit	number	-	True	本次查询要求返回的行数（min：1，max:100）

响应说明

响应状态码: 200

表3 响应体参数
序号	名称	参数类型	是否必选	说明
1	caseTypes	CaseTypes[]	True	工单类型信息，参见表4。
2	count	number	True	符合条件的总数

表4 CaseTypes参数说明
序号	名称	参数类型	是否必选	说明
1	id	string	True	工单类型id
2	typeName	string	True	工单模板名称（唯一）
3	description	string	False	工单类型描述
4	status	string	True	类型状态
5	caseStatus	string	True	工单流程
6	templateId	string	True	关联的工单模板
7	templateName	string	True	关联的工单模板名称
8	contentTempalteId	string	False	关联的内容模板
9	parentId	string	False	父类型id
10	isStrictOrder	boolean	True	是否严格模式，值范围：true/false
11	creatorName	string	True	创建人名称
12	createdDate	Datetime	True	创建时间
13	lastModifiedName	string	True	最后修改人名称
14	lastModifiedDate	Datetime	True	最后修改时间
15	level	string	False	父子关系层级
16	maxReopenDuration	string	False	最大重启周期（天），整数值1-9999
17	maxReopenTimes	string	False	最大重启次数，整数值1-9999
18	questionnaireId	string	False	关联的调查问卷ID。
19	sendChannel	string	False	非必填，调查问卷发送渠道，枚举值SMS/Email，填写questionnaireId时必须填写sendChannel。
20	caseFSMStatus	string	False	工单高级流程id值。
21	caseStatusId	string	True	工单流程id，若存在多个使用逗号隔开，高级流程默认包含已完成。

消息样例

场景描述：查询工单类型列表

URL：https://域名/service/AICC__Case/1.0.0/openapi/caseType/list

请求头:

{
 "Content-Type": "application/json"，
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}

请求体：

{
  "limit": 2,"start": 0
}

响应头：

{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}

响应参数：

{
	"resCode": "0",
	"resMsg": "成功",
	"result": {
		"caseTypes": [{
			"caseStatus": "y,Completed",
			"contentTemplateId": null,
			"createdDate": "2023-06-16 10:46:37",
			"creatorName": "qianbin001",
			"description": "bbb",
			"id": "cvmC00000149PQzoNeq0",
			"isStrictOrder": false,
			"lastModifiedDate": "2023-06-16 10:46:58",
			"lastModifiedName": "10gd00000143C5ONGb0y",
			"parentId": null,
			"status": "Active",
                        "level": "1",
                        "maxReopenDuration": "1",
                        "maxReopenTimes": "1",  
                        "questionnaireId": "null",
                        "sendChannel": "null",   
                        "templateId": "c7s800000149PO9VmEWu",
			"templateName": "bbbb",
			"typeName": "bbb"
		}, {
			"caseStatus": "y,Completed",
			"contentTemplateId": null,
			"createdDate": "2023-06-16 10:26:31",
			"creatorName": "qianbin001",
			"description": "aaa",
			"id": "cvmC00000149NzxF1ePA",
			"isStrictOrder": false,
			"lastModifiedDate": "2023-06-16 10:26:50",
			"lastModifiedName": "10gd00000143C5ONGb0y",
			"parentId": null,
			"status": "Active",
			"templateId": "c7s800000149NtKyh4me",
			"templateName": "aaa",
			"typeName": "aaa"
		}],
		"count": 65
	}
}

父主题： 工单配置接口（V2.0）

上一篇：工单配置接口（V2.0）

下一篇：查询工单类型详情