VariableCreate - 创建变量
更新时间:2024-11-07
API访问域名
请求方式 | POST |
---|---|
base url | https://keyue.cloud.baidu.com |
后缀接口 | /open/v1/api/v2/dialog/variable/create |
Authentication | token为API Key |
说明
无
请求参数
Header参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
Content-Type | string | 是 | 内容类型 | 固定值:application/json |
token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考:准备工作 |
uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考:准备工作 |
username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考:准备工作 |
Body参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
name | string | 是 | 变量名称 | |
description | string | 是 | 变量描述 |
响应参数
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
time | integer | 是 | 时间 | 1722233756403 |
data | object | 是 | 数据 | 数据对象 |
data \ id | string | 是 | 全局变量ID | 826868f2-25d8-4686-9c27-8ec44f57ee2d |
data \ name | string | 是 | 全局变量名称 | test_add |
data \ description | string | 是 | 全局变量注释 | 测试添加 |
data \ createdUsername | string | 是 | 全局变量创建用户名称 | pnstest3 |
data \ lastEditUsername | string | 是 | 全局变量最新编辑用户名称 | pnstest3 |
data \ created | string | 是 | 创建时间 | 2024-07-29 14:15:56 |
data \ updated | string | 是 | 更新时间 | 2024-07-29 14:15:56 |
data \ version | integer | 是 | 编辑版本 | 1 |
data \ type | integer | 是 | 变量类型,0表示用户变量,1表示系统变量 | 0 |
code | integer | 是 | 状态码 | 200 |
msg | string | 是 | 状态信息 | OK |
请求示例
curl --location 'http://keyue-test.cloud.baidu.com/open/v1/api/v2/dialog/variable/create' \
--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
--header 'uid: dd6283a283df42998bab14607e23f38d' \
--header 'username: xxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"name": "test_add",
"description": "测试添加"
}'
响应示例
{
"time": 1722233756403,
"data": {
"id": "826868f2-25d8-4686-9c27-8ec44f57ee2d",
"name": "test_add",
"description": "测试添加",
"status": 0,
"createdUsername": "pnstest3",
"lastEditUsername": "pnstest3",
"created": "2024-07-29 14:15:56",
"updated": "2024-07-29 14:15:56",
"version": 1,
"type": 0
},
"code": 200,
"msg": "OK"
}
{
"msg": "变量已存在,请更换变量名称再试",
"tip": "",
"code": 4001801,
"requestId": "aa8024ead0504d5ba8729e0c35879eb8"
}
{
"msg": "变量名称参数缺失",
"tip": "",
"code": 4001804,
"requestId": "6e24b9e160a540c88cfb0e2c92b06f14"
}