遍历配置项

1. 请求地址：GET /sns/{sn}/datas

2. 接口概述：

   遍历指定授权码的配置项。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   offset	integer	响应结果起始下标	否	默认0
   limit	integer	响应结果的数量	否	默认50，最大1000

   如何遍历？

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/sns/{sn}/datas?offset={offset}&limit={limit} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 6,
          "items": [
              {
                  "name": "unit_data_name",
                  "value": "unit_data_value",
                  "updateTime": "2022-08-25 17:13:35",
                  "status": 0,
                  "source": "product"
              },
              {
                  "name": "unit_data_name_s",
                  "value": "unit_data_value_s",
                  "updateTime": "2024-08-08 09:51:49",
                  "status": 0,
                  "source": "sn"
              }
          ]
      }
   }

   响应体说明

查询配置项

1. 请求地址：POST /sns/{sn}/datas/data

2. 接口概述：

   根据限定的条件查询指定授权码的配置项，并按条件排序。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   offset	integer	响应结果起始下标	否	默认0
   limit	integer	响应结果的数量	否	默认50，最大1000

   如何遍历？

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   querys	array	查询参数	否
   sorts	array	排序参数	否

   如何查询？

   querys

   支持：name，updateTime，source。

   source表示配置项的来源，可选值为：sn，template，product;

   updateTime的值格式为yyyy-MM-dd HH:mm:ss。

   sorts

   支持：name，updateTime。

   参数说明

5. 请求示例

   POST /bitanswer/api/sns/{sn}/datas/data HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "querys": [
          {
              "name":"name",
              "op": "=",
              "values": ["unit_data_name1","unit_data_name2"]
          },
          {
              "name":"updateTime",
              "op": ">",
              "values":["2020-12-12 00:00:00"]
          },
          {
              "name":"source",
              "op": "=",
              "values": ["product"]
          }
      ],
      "sorts": [
          {
              "name": "updateTime"
          }
      ]
   }

6. 响应示例

   {
      "status": 0,
      "data": {
          "total": 2,
          "items": [
              {
                  "name": "unit_data_name1",
                  "value": "unit_data_value1",
                  "updateTime": "2022-08-25 17:13:35",
                  "status": 0,
                  "source": "product"
              },
              {
                  "name": "unit_data_name2",
                  "value": "unit_data_value2",
                  "updateTime": "2023-04-26 09:37:21",
                  "status": 0,
                  "source": "product"
              }
          ]
      }
   }

   响应体说明

批量更新/添加配置项

1. 请求地址：

   • PATCH /sns/{sn}/datas
   • POST /sns/{sn}/datas

2. 接口概述：

   按配置项名称查询指定授权码的配置项：若存在则修改；若不存在则添加。

   两种方法在更新时只有当value、status不为空时进行修改；添加时status默认为0。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   name	string	配置项名称	是
   value	string	配置项值	否
   status	integer	状态	否	0：正常 2：删除

   请求体以数组形式输入。

5. 请求示例：

   PATCH /bitanswer/api/sns/{sn}/datas HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   [
      {
          "name":"unit_data_name3",
          "status":2
      },
      {
          "name":"unit_data_name4",
          "value":"unit_data_value4"
      }
   ]

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 2,
          "items": [
              {
                  "name": "unit_data_name3",
                  "value": "unit_data_value3",
                  "updateTime": "2024-08-15 13:45:15",
                  "status": 2,
                  "source": "sn"
              },
              {
                  "name": "unit_data_name4",
                  "value": "unit_data_value4",
                  "updateTime": "2024-08-15 13:37:13",
                  "status": 0,
                  "source": "sn"
              }
          ]
      }
   }

   响应体说明

批量删除配置项

1. 请求地址：DELETE /sns/{sn}/datas

2. 接口概述：

   批量删除授权码的配置项。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   	array	配置项名称列表	是	由string类型组成的数组

5. 请求示例：

   DELETE /bitanswer/api/sns/{sn}/datas HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   [
      "unit_data_name3",
      "unit_data_name4"
   ]

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 2,
          "items": [
              {
                  "name": "unit_data_name3"
              },
              {
                  "name": "unit_data_name4"
              }
          ]
      }
   }

   响应体说明

按名称获取配置项

1. 请求地址：GET /sns/{sn}/datas/{name}

2. 接口概述：

   按配置项名称查询指定授权码关联的配置项。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是
   name	string	配置项名称	是

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/sns/{sn}/datas/{name} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "name": "unit_data_name",
                  "value": "unit_data_value",
                  "updateTime": "2022-08-25 17:13:35",
                  "status": 0,
                  "source": "product"
              }
          ]
      }
   }

   响应体说明

按名称更新/添加配置项

1. 请求地址：

   • PATCH /sns/{sn}/datas/{name}
   • POST /sns/{sn}/datas/{name}

2. 接口概述：

   按配置项名称查询指定授权码的配置项：若存在则修改；若不存在则添加。

   两种方法在更新时只有当value、status不为空时进行修改；添加时status默认为0。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是
   name	string	配置项名称	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   name	string	配置项名称	是
   value	string	配置项值	否
   status	integer	状态	否	配置项状态：0：正常，2：删除

5. 请求示例：

   PATCH /bitanswer/api/sns/{sn}/datas/{name} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "name":"unit_data_name4",
      "value":"unit_data_value4"
   }

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "name": "unit_data_name4",
                  "value": "unit_data_value4",
                  "updateTime": "2024-08-15 14:25:41",
                  "status": 0,
                  "source": "sn"
              }
          ]
      }
   }

   响应体说明

按名称删除配置项

1. 请求地址：DELETE /sns/{sn}/datas/{name}

2. 接口概述：

   按配置项名称删除指定授权码的配置项。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   sn	string	授权码	是
   name	string	配置项名称	是

4. 请求体：

   无

5. 请求示例：

   DELETE /bitanswer/api/sns/{sn}/datas/{name} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "name": "unit_data_name4"
              }
          ]
      }
   }