标签信息API
# 说明
标签信息Api,用于添加,修改,删除,查询标签信息
标签信息的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询标签信息列表。
接口版本
v1接口地址
/api-web-v1/tags
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是标签信息字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | page | number | false | 分页第几页 | 1 | |
query | limit | number | false | 单页几条数据 | 10 | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"page":"1",
"limit":"10",
"sort":"-createdAt",
"autopopulate":"false"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | 标签信息总条数 |
-rows | array | False | 当前返回的标签信息对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 2,
"rows": [
{
"type": 0,
"_id": "62cd1d0ae450544275d8fd05",
"flag": true,
"name": "开关",
"remark": "2",
"creator": "5714a78935b1fecb47044bf7",
"__v": 0
},
{
"type": 0,
"_id": "62cd1cffe450544275d8fcef",
"flag": true,
"name": "空调",
"remark": "1",
"creator": "5714a78935b1fecb47044bf7",
"__v": 0
}
]
}
}
# 查询标签信息ID
接口说明
根据标签信息ID查询标签信息
接口版本
v1接口地址
/api-v1/tags/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 标签信息ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"_id": "62cd1cffe450544275d8fcef"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回标签信息信息 |
返回参数举例
{
"code": 0,
"data": {
"type": 0,
"_id": "62cd1cffe450544275d8fcef",
"flag": true,
"name": "空调",
"remark": "1",
"creator": "5714a78935b1fecb47044bf7",
"__v": 0
}
}
# 新建
接口说明
新建一个标签信息。
接口版本
v1接口地址
/api-v1/tags
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 标签信息对象字段说明 |
请求参数举例
{
"type": 0,
"flag": true,
"name": "空调",
"remark": "1",
"creator": "5714a78935b1fecb47044bf7"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"type": 0,
"_id": "62cd1cffe450544275d8fcef",
"flag": true,
"name": "空调",
"remark": "1",
"creator": "5714a78935b1fecb47044bf7",
"__v": 0
}
}
# 编辑
接口说明
修改标签信息。
接口版本
v1接口地址
/api-v1/tags/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的标签信息ID |
body | - | Object | True | 标签信息对象字段说明 |
请求参数举例
{
"name":"大金空调"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"type": 0,
"_id": "62cd1cffe450544275d8fcef",
"flag": true,
"name": "大金空调",
"remark": "1",
"creator": "5714a78935b1fecb47044bf7",
"__v": 0
}
}
# 删除
接口说明
删除一个标签信息。
接口版本
v1接口地址
/api-v1/tags/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的标签信息ID |
请求参数举例
只需发送删除标签信息的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
message | string | false | 成功删除返回complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
此接口需实际标签信息。文档不提供删除在线调试
上次更新: 2022/07/13, 14:05:11