ListTicketTemplates - 获取工单模板列表

使用ListTickerTemplate获取工单模板列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SearchPatternstring

模板名称,模糊搜索。

模板1
CategoryIdstring

工单类目 ID。

43c2671b-********86d0-6bd187905cc8
Statestring

模板状态。

  • Enabled(已上线)
  • Disabled(已下线)
Enabled
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

100
InstanceIdstring

实例 ID。

ccc-test

返回参数

名称类型描述示例值
object

ListTicketTemplatesResponse

Dataobject

数据。

TotalCountinteger

总数。

25
PageNumberinteger

页码。

1
PageSizeinteger

分页大小。

100
Listarray<object>

模板列表。

object

模板。

InstanceIdstring

实例 ID。

ccc-test
TemplateIdstring

模板 ID。

b5c21219-3a1e-4bc0-92e7-da66e057d2f6
Namestring

模板名称。

测试模板
Statestring

状态。

Enabled
Editorstring

编辑人。

creator@ccc-test
TicketFieldsarray<object>

模板字段列表。

object

字段。

DisplayNamestring

显示名称。

姓名
Descriptionstring

描述。

姓名字段
Namestring

名称。

name
DataTypestring

数据类型 。

String
Patternstring

正则表达式校验规则。

^
PatternErrorMessagestring

正则表达式校验错误提示信息

不是有效的email地址
MinLengthinteger

最小长度。

1
MaxLengthinteger

最大长度。

30
Minimumdouble

数字最小值。

1
Maximumdouble

数字最大值。

10
Requiredboolean

是否必填。

false
Systemboolean

是否是系统字段。

false
Disabledboolean

是否被禁用。

false
Arrayboolean

是否是数组。

false
ReadOnlyboolean

是否只读。

false
EditorTypestring

编辑器类型。

textbox
Attributestring

扩展属性。

{}
DisplayOrderinteger

列表展示顺序。

1
CreatedTimelong

创建时间。

1715780670000
UpdatedTimelong

更新时间。

1715780670000
Creatorstring

创建者。

creator
ProcessDefinitionstring

流程信息(废弃)。

UpdatedTimelong

更新时间。

1715780670000
CategoryIdstring

类⽬ID。

43c2671b-*****-4223-86d0-6bd187905cc8
AppliedVersionstring

当前正在工作的版本。

0
LatestVersionstring

草稿版本。

1715780670000
RequestIdstring

请求 ID。

8707EB29-BAED-4302-B999-40BA61877437
HttpStatusCodeinteger

HTTP 状态码。

200
Codestring

响应码。

OK
Messagestring

响应信息。

Paramsarray

错误参数列表。

string

错误参数。

示例

正常返回示例

JSON格式

{
  "Data": {
    "TotalCount": 25,
    "PageNumber": 1,
    "PageSize": 100,
    "List": [
      {
        "InstanceId": "ccc-test",
        "TemplateId": "b5c21219-3a1e-4bc0-92e7-da66e057d2f6",
        "Name": "测试模板",
        "State": "Enabled",
        "Editor": "creator@ccc-test",
        "TicketFields": [
          {
            "DisplayName": "姓名\n",
            "Description": "姓名字段",
            "Name": "name",
            "DataType": "String",
            "Pattern": "^",
            "PatternErrorMessage": "不是有效的email地址\n",
            "MinLength": 1,
            "MaxLength": 30,
            "Minimum": 1,
            "Maximum": 10,
            "Required": false,
            "System": false,
            "Disabled": false,
            "Array": false,
            "ReadOnly": false,
            "EditorType": "textbox",
            "Attribute": "{}",
            "DisplayOrder": 1,
            "CreatedTime": 1715780670000,
            "UpdatedTime": 1715780670000,
            "Creator": "creator"
          }
        ],
        "ProcessDefinition": "无",
        "UpdatedTime": 1715780670000,
        "CategoryId": "43c2671b-*****-4223-86d0-6bd187905cc8",
        "AppliedVersion": "0",
        "LatestVersion": "1715780670000"
      }
    ]
  },
  "RequestId": "8707EB29-BAED-4302-B999-40BA61877437",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

错误码

HTTP status code错误码错误信息描述
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。