文档首页/ 云客服/ API参考/ 智能化模块接口参考/ 智能填单接口/ 工单模板启用接口
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

工单模板启用接口

场景描述

给第三方接入方调用，实现工单模板启用，用于将工单模板以及工单模板下的工单字段列表同步到元数据的功能。

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/caseTemplateActive

消息头

表1 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

userName

String

True

参见C3 智能助手平台接口鉴权方式中的说明下的第三点的appKey。

3

token

String

True

生成方式参见C3 智能助手平台接口鉴权方式。

请求说明

表2 请求体参数

参数名称

数据类型

参数位置

必选/可选

描述

tenantId

String

body

True

租户ID。

templateId

String

body

True

工单模板ID。

language

String

body

True

语言。选项如下：

  • zh_CN：中文
  • en_US：英文

caseTypeList

caseType[]

body

False

工单类型对象数组。

caseFieldList

caseField[]

body

True

工单字段对象数组。
表3 caseType

Name

Mandatory

Type

Description

typeId

True

String

工单类型ID

typeName

True

String

工单类型名称
表4 caseField

Name

Mandatory

Type

Description

caseFieldId

True

String

工单字段ID

caseFieldName

True

String

工单字段名称

caseFieldDesc

False

String

工单字段描述

fieldType

True

String

工单字段类型

响应说明

参数名称

数据类型

参数位置

必选/可选

描述

errorCode

int

body

True

错误码

  • 0表示成功
  • 非0表示失败

errorMsg

String

body

True

响应信息

data

int

body

True

同步成功的工单字段数据量

报文样例

  • 请求样例 
    {
    "templateId": "templateIdxxx",
    "tenantId": "202301041851",
    "language": "zh_CN",
    "caseTypeList": [
        {
            "typeId": "rr111type111",
            "typeName": "rr1111TYPENAME"
        },
        {
            "typeId": "rr222type222",
            "typeName": "rr2222TYPENAME2"
        }
    ],
    "caseFieldList": [
        {
            "caseFieldId": "AICC111",
            "caseFieldName": "地址",
            "caseFieldDesc": "描述",
            "fieldType": "Text"
        },
        {
            "caseFieldId": "AICC222",
            "caseFieldName": "姓名",
            "caseFieldDesc": null,
            "fieldType": "Text"
        }
    ]
}
  • 响应样例 
    {
    "errorCode": 0,
    "errorMsg": null,
    "data": 2,
    "count": 0
}
父主题： 智能填单接口

相关文档