查询授权码配置项

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

接口说明

  • 分页遍历授权码关联的配置项。

请求参数

  • Query

    参数名 类型 必需 示例值 说明
    offset integer 否 0 起始下标
    limit integer 否 50 范围（≤1000，默认50）
    search string 否 dataName 配置项名称

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码

请求示例

GET https://back-office-api.bitanswer.cn/bitanswer/api/sns/ABCDEFG123456/datas?offset=0&limit=10&search=name
bitkey: xxx

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "data_name",
                "value": "data_value",
                "updateTime": "2022-08-25",
                "status": 0,
                "source": "product"
            }
        ]
    }
}

响应体参数说明

批量更新配置项全部信息

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

接口说明

  • 批量更新授权码关联的配置项，不存在的配置项自动添加。
  • 返回更新成功的配置项列表。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码

  • Body

    参数名 类型 必需 中文名
    name string 否 配置项名称
    value string 否 配置项值
    status integer 否 状态

注：请求体需以数组形式输入

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/sns/ABCDEFG123456/datas
bitkey: xxx
Content-Type: application/json

[{
    "name": "data_name",
    "value": "value1"
}]

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "data_name",
                "value": "value1",
                "updateTime": "2022-09-15",
                "source": "sn"
            }
        ]
    }
}

响应体参数说明

批量更新配置项

请求地址： PATCH /sns/{sn}/datas

接口说明

  • 批量更新授权码关联的配置项。
  • 返回更新成功的配置项列表。
  • 此接口仅处理有有效值的节点，不会更改其他属性。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码

  • Body

    参数名 类型 必需 中文名
    name string 否 配置项名称
    value string 否 配置项值
    status integer 否 状态

注：请求体需以数组形式输入

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/sns/ABCDEFG123456/datas
bitkey: xxx
Content-Type: application/json

[{
    "name": "data_name",
    "value": "value1"
}]

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "data_name",
                "value": "value1",
                "updateTime": "2022-09-15",
                "source": "sn"
            }
        ]
    }
}

响应体参数说明

批量删除配置项

xxxxxxxxxx {    "status": 0,    "data": {        "total": 1,        "items": [           {                "name": "cus"           }       ]   }}json

接口说明

  • 批量删除授权码关联的配置项，不影响产品和模版。
  • 返回删除成功的配置项列表。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码

  • Body

    参数名 类型 必需 中文名
    array 否 配置项名称列表

请求示例

DELETE https://back-office-api.bitanswer.cn/bitanswer/api/sns/ABCDEFG123456/datas
bitkey: xxx
Content-Type: application/json

[
    "data_name1"
]

响应示例

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

按条件检索授权码的配置项

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

接口说明

  • 按条件检索授权码关联的配置项。
  • 返回符合条件的配置列表。

请求参数

  • Query

    参数名 类型 必需 示例值 说明
    offset integer 否 0 起始下标
    limit integer 否 50 范围（≤1000，默认50）

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码

  • Body

    参数名 类型 必需 中文名
    querys array 否 查询条件
    sorts array 否 排序条件

支持的参数如下表所示

参数名 类型 检索类型 必需 中文名
name string query|sort 否 配置项名称
updateTime string query|sort 否 更新时间

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxxx/datas/data?offset=0&limit=2
bitkey: xxx
Content-Type: application/json

{
    "querys":[
        {
            "name":"name",
            "op":"like",
            "values":["data"]
        }
    ]
}

检索请求参数用法

响应示例

{
    "status": 0,
    "data": {
        "total": 2,
        "items": [
            {
                "name": "data-p-1",
                "value": "111",
                "updateTime": "2022-08-30",
                "status": 0,
                "source": "product"
            },
            {
                "name": "data-t-1",
                "value": "11",
                "updateTime": "2022-08-30",
                "status": 0,
                "source": "template"
            }
        ]
    }
}

响应体参数说明

使用名称获取一个配置项

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

接口说明

  • 查询授权码关联的配置项。

请求参数

  • Path
    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码
    name string 是 dataName 配置项名称

请求示例

GET https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxxx/datas/data-p-1
bitkey: xxx

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "data-p-1",
                "value": "111",
                "updateTime": "2022-08-30",
                "status": 0,
                "source": "product"
            }
        ]
    }
}

响应体参数说明

覆盖一个配置项的全部信息

请求地址： POST /sns/{sn}/datas/{name}

接口说明

  • 更新授权码关联的配置项。
  • 返回更新成功的配置项。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码
    name string 是 dataName 配置项名称

  • Body

    参数名 类型 必需 中文名
    name string 否 配置项名称
    value string 否 配置项值
    status integer 否 状态

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxx/datas/data-p-1
bitkey: xxx
Content-Type: application/json

{
    "name": "data-p-1",
    "value": "123",
    "status": 0
}

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "data-p-1",
                "value": "123",
                "updateTime": "2022-09-26",
                "status": 0,
                "source": "sn"
            }
        ]
    }
}

响应体参数说明

更新一个配置项

请求地址： PATCH /sns/{sn}/datas/{name}

接口说明

  • 更新授权码关联的配置项。
  • 返回更新成功的配置项。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码
    name string 是 dataName 配置项名称

  • Body

    参数名 类型 必需 中文名
    name string 否 配置项名称
    value string 否 配置项值
    status integer 否 状态

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxx/datas/data-p-1
bitkey: xxx
Content-Type: application/json

{
    "name": "data-p-1",
    "value": "123",
    "status": 0
}

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "data-p-1",
                "value": "123",
                "updateTime": "2022-09-26",
                "status": 0,
                "source": "sn"
            }
        ]
    }
}

响应体参数说明

删除一个配置项

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

接口说明

  • 删除授权码关联的配置项，不影响产品和模版。

请求参数

  • Path
    参数名 类型 必需 示例值 说明
    sn string 是 ABCDEFG123456 授权码

请求示例

DELETE https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxx/datas/data-1
bitkey: xxx

响应示例

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