任务式对话实体接口 - Udesk

实体-删除接口

请求地址

DELETE /v1/entity/:id

请求参数

Request parameters

Parameter	Type	Optional	Description
id	Integer	false	实体id.
force	Integer	true	是否强制删除 0:否 1:是（默认为0）.

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明

示例

$ curl 'https://km.udesk.cn/api/v1/entity/12?force=0&email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

{
    "code": 200,
    "message": "OK",
    "visible": false
}

实体-更新接口

请求地址

PUT /v1/entity/:id

请求参数

Request fields

Path	Type	Optional	Description
robotId	Integer	false	机器人ID.
name	String	false	实体名称.
apiName	String	false	api名称（api名称只能为字母、数字或下划线）.
remark	String	true	实体描述（描述长度不能超过255字符）.
regex	String	true	实体正则值 .
valueList	Array	true	实体值列表 .
valueList[].id	Integer	true	实体值ID
valueList[].originalValue	String	true	实体值名称
valueList[].changeType	Integer	true	修改状态（0.未修改 1.新增 2.修改 3.删除）
valueList[].similarValueList	Array	true	实体值近义值数组
valueList[].similarValueList[]	String	true	实体值近义值

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明
data	Object	实体信息
data[].id	Integer	实体ID.
data[].robotId	Integer	机器人ID.
data[].name	String	实体名称.
data[].apiName	String	实体api名称.
data[].type	Integer	类型 1:自定义 2:系统.
data[].status	Integer	实体状态 0:禁用 1:启用.
data[].regex	String	实体正则值.
data[].sysEntityIdentifier	String	系统标识描述符.
data[].remark	String	实体描述.
data[].orders	Integer	实体排序.
data[].valueList	Array	实体值列表.
data[].valueList[].id	Integer	实体值ID
data[].valueList[].originalValue	String	实体值名称
data[].valueList[].similarValueList	Array	实体值的近义值数组
data[].valueList[].similarValueList[]	String	实体值的近义值

示例

$ curl 'https://km.udesk.cn/api/v1/entity/12?email=admin@udesk.cn&timestamp=1559016375&sign=7f31519fd01b85d4043b9413d1fad225718eb914' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "apiName": "api",
    "name": "实体名称",
    "regex": "/d+",
    "remark": "描述",
    "robotId": 83,
    "valueList": [
     {
       "changeType": 2,
       "id": 23,
       "originalValue": "实体值",
       "similarValueList": [
         "近义词"
       ]
     }
    ]
  }'

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 12,
        "robotId": 83,
        "name": "实体名称",
        "apiName": "api",
        "type": 1,
        "status": 0,
        "regex": "/d+",
        "sysEntityIdentifier": null,
        "remark": "描述",
        "orders": 15,
        "valueList": [
            {
                "id": 23,
                "originalValue": "实体值",
                "similarValueList": [
                    "近义词"
                ]
            }
        ]
    }
}

实体-新建接口

请求地址

POST /v1/entity

请求参数

Request fields

Path	Type	Optional	Description
robotId	Integer	false	机器人ID.
name	String	false	实体名称.
apiName	String	false	实体api名称（api名称只能为字母、数字或下划线）.
regex	String	true	实体正则值 .
remark	String	true	实体描述（描述长度不能超过255字符）.

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明
data	Object	实体信息
data[].id	Integer	实体ID.
data[].robotId	Integer	实体的机器人ID.
data[].name	String	实体名称.
data[].apiName	String	实体api名称.
data[].type	Integer	实体类型 1:自定义 2:系统.
data[].status	Integer	实体状态 0:禁用 1:启用.
data[].regex	String	实体正则值.
data[].sysEntityIdentifier	String	实体系统标识描述符.
data[].remark	String	实体描述.
data[].orders	Integer	实体排序.
data[].valueList	Array	实体值列表.
data[].valueList[].id	Integer	实体值ID
data[].valueList[].originalValue	String	实体值名称
data[].valueList[].changeType	Integer	实体修改类型（0.未修改 1.新增 2.修改 3.删除）
data[].valueList[].similarValueList	Array	近义值数组
data[].valueList[].similarValueList[]	String	近义值

示例

$ curl 'https://km.udesk.cn/api/v1/entity?email=admin@udesk.cn&timestamp=1559016113&sign=f16d7f6fcc3fbab73855f4510cd4904f0f60e258' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "robotId" : 83,
    "name" : "实体名称",
    "apiName":"api",
    "remark":"描述"
  }'

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "实体名称",
        "apiName": "api",
        "type": 1,
        "status": null,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "描述",
        "orders": null,
        "valueList": null
    }
}

请求失败原因

{
  "code": 400,
  "message": "{具体的异常信息}",
  "visible": false
}

message	description
"【具体字段】...."	【具体字段】{错误原因}

实体-启用禁用接口

请求地址

PUT /v1/entity/:id/status/:status

请求参数

Request fields

path	Type	Optional	Description
id	Integer	false	实体id.
status	Integer	false	实体状态 0:禁用 1:启用.

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明

示例

$ curl 'https://km.udesk.cn/api/v1/entity/12/status/1?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'

{
    "code": 200,
    "message": "OK",
    "visible": false
}

实体-获取详情接口

请求地址

GET /v1/entity/:id

请求参数

Request fields

path	Type	Optional	Description
id	Integer	false	实体id.

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明
data	Object	实体信息
data[].id	Integer	实体ID.
data[].robotId	Integer	机器人ID.
data[].name	String	实体名称.
data[].apiName	String	实体api名称.
data[].type	Integer	实体类型 1:自定义 2:系统.
data[].status	Integer	实体状态 0:禁用 1:启用.
data[].regex	String	实体正则值.
data[].sysEntityIdentifier	String	系统标识描述符.
data[].remark	String	实体描述.
data[].orders	Integer	实体排序.
data[].valueList	Array	实体值列表.
data[].valueList[].id	Integer	实体值ID
data[].valueList[].originalValue	String	实体值名称
data[].valueList[].similarValueList	Array	实体值的近义值数组
data[].valueList[].similarValueList[]	String	实体值的近义值

示例

$ curl 'https://km.udesk.cn/api/v1/entity/2850?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "实体名称",
        "apiName": "api",
        "type": 1,
        "status": 1,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "描述",
        "orders": null,
        "valueList": [
            {
                "id": 213984,
                "originalValue": "123123",
                "similarValueList": [
                    "b",
                    "a"
                ]
            }
        ]
    }
}

请求失败原因

{
  "code": 400,
  "message": "{具体的异常信息}",
  "visible": false
}

message	description
"Entity not exists"	参数中对应Id的实体不存在

实体-获取列表接口

请求地址

GET /v1/entity/robot/{robotId}

请求参数

Request parameters

Parameter	Type	Optional	Description
robotId	Integer	false	机器ID.
pageNum	Integer	true	页码 (默认为1).
pageSize	Integer	true	每页数量 (默认为10,最大为100).
keyword	Integer	true	搜索关键字.
status	Integer	true	实体启用状态 0:禁用 1:启用.

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明
data	Object	实体列表信息
data[].id	Integer	实体ID
data[].robotId	Integer	机器人ID,
data[].name	String	实体名称
data[].apiName	String	实体API名称
data[].type	Integer	实体类型 1:自定义 2:系统.
data[].status	Integer	实体状态 0:禁用 1:启用.
data[].regex	String	实体正则值.
data[].sysEntityIdentifier	String	系统标识描述符.
data[].remark	String	实体描述.
data[].orders	Integer	实体排序.
data[].valueList	Array	实体值列表.
data[].valueList[].id	Integer	实体值ID
data[].valueList[].originalValue	String	实体值名称
data[].valueList[].similarValueList	Array	实体值的近义值数组
data[].valueList[].similarValueList[]	String	实体值的近义值

示例

$ curl 'https://km.udesk.cn/api/v1/entity/robot/83?pageNum=1&pageSize=15&keyword="实体名称"&status=1&&email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 15,
        "total": 2
    },
    "data": [
        {
            "id": 179,
            "robotId": 83,
            "name": "城市实体",
            "apiName": "sys_city",
            "type": 2,
            "status": 1,
            "regex": null,
            "sysEntityIdentifier": "中国所有城市区县",
            "remark": null,
            "orders": 4,
            "valueList": null
        }
    ]
}

请求失败原因

message	description
Failed to convert value of type 'java.lang.String' to required type 'java.lang.Integer'	整型参数的值异常

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

实体-删除接口

请求地址

请求参数

Request parameters

请求结果

示例

返回

实体-更新接口

请求地址

请求参数

Request fields

请求结果

示例

返回

实体-新建接口

请求地址

请求参数

Request fields

请求结果

示例

返回

请求失败原因

实体-启用禁用接口

请求地址

请求参数

Request fields

请求结果

示例

返回

实体-获取详情接口

请求地址

请求参数

Request fields

请求结果

示例

返回

请求失败原因

实体-获取列表接口

请求地址

请求参数

Request parameters

请求结果

示例

返回

请求失败原因

文档反馈