遍历特征项
-
请求地址:
GET /sns/{sn}/features
-
接口概述:
遍历指定授权码的特征项。
-
请求参数:
参数名 参数类型 参数说明 必需 备注 offset integer 响应结果起始下标 否 默认0 limit integer 响应结果的数量 否 默认50,最大1000 scope string 控制返回的内容,支持已勾选(selected)、未勾选(unselected)以及全部(all) 否 默认已勾选(selected) 地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 -
请求体:
无
-
请求示例:
GET /bitanswer/api/sns/{sn}/features?limit=1 HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例:
{ "status": 0, "data": { "total": 10, "items": [ { "id": 1, "guid": "xxx", "name": "foo", "featureId": 1, "value": 0, "source": "PRODUCT", "hidden": false, "status": 3, "type": "ReadOnly" } ] } }
查询特征项
-
请求地址:
POST /sns/{sn}/features/data
-
接口概述:
指定授权码,根据限定的条件查询、排序符合的特征项。
-
请求参数:
参数名 参数类型 参数说明 必需 备注 offset integer 响应结果起始下标 否 默认0 limit integer 响应结果的数量 否 默认50,最大1000 地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 -
请求体:
参数名 参数类型 参数说明 必需 备注 querys array 查询参数 否 sorts array 排序参数 否 querys
支持:
guid
,name
,status
。sorts
支持:
id
,name
,featureId
,version
,status
。 -
请求示例
POST /bitanswer/api/sns/{sn}/features/data HTTP/1.1 Host: back-office-api.bitanswer.cn Content-Type: application/json bitkey: •••••• { "querys": [ { "name": "name", "op": "like", "values": [ "foo" ] } ], "sorts": [ { "name": "name" } ] }
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1, "guid": "xxx", "name": "foo", "featureId": 1, "value": 0, "source": "PRODUCT", "hidden": false, "status": 3, "type": "ReadOnly" } ] } }
批量绑定/更新特征项
-
请求地址:
PATCH /sns/{sn}/features
POST /sns/{sn}/features
-
接口概述:
根据输入内容,为授权码勾选特征项,并更新授权码特征项信息,目前仅支持通过ID查找。
PATCH 方法表示仅设置输入的特征项内容;
POST 方法表示除输入的内容外,未输入的内容按默认值处理,适用于重置数据。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 -
请求体:
参数名 参数类型 参数说明 必需 备注 id integer 唯一ID,用于精确定位 是 value integer 特征值 否 endDate string 结束时间 否 格式: yyyy-MM-dd HH:mm:ss
。
当传yyyy-MM-dd
,代表yyyy-MM-dd 23:59:59
。expirationDays integer 有效期 否 users integer 用户数 否 version string 特征项版本 否 type string 操作 否 支持select(勾选)、unselect(取消勾选)、override(修改)三种。override会自动勾选。 请求体以数组形式输入。
-
请求示例
PATCH /bitanswer/api/sns/{sn}/features HTTP/1.1 Host: back-office-api.bitanswer.cn Content-Type: application/json bitkey: •••••• [ { "id": 1, "value": 1002 } ]
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1, "value": 1002 } ] } }
批量删除特征项
-
请求地址:
DELETE /sns/{sn}/features
-
接口概述:
根据输入内容删除授权码的特征项,目前仅支持通过ID删除。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 -
请求体:
参数名 参数类型 参数说明 必需 备注 id integer 唯一ID,用于精确定位 是 请求体以数组形式输入。
-
请求示例
DELETE /bitanswer/api/sns/{sn}/features HTTP/1.1 Host: back-office-api.bitanswer.cn Content-Type: application/json bitkey: •••••• [ { "id": 1 } ]
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1 } ] } }
按名称获取特征项
-
请求地址:
GET /sns/{sn}/features/name/{featureName}
-
接口概述:
获取指定sn、指定名称的特征项。同FID下可以存在同名特征项,可以遍历获取所有。
-
请求参数:
参数名 参数类型 参数说明 必需 备注 offset integer 响应结果起始下标 否 默认0 limit integer 响应结果的数量 否 默认50,最大1000 地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 featureName string 特征项名称 是 -
请求体:
无
-
请求示例
GET /bitanswer/api/sns/{sn}/features/name/{featureName} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1, "guid": "xxx", "name": "foo", "featureId": 1, "value": 0, "source": "PRODUCT", "hidden": false, "status": 3, "type": "ReadOnly" } ] } }
按名称删除特征项
-
请求地址:
DELETE /sns/{sn}/features/name/{featureName}
-
接口概述:
指定名称,移除SN所有的关联特征项。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 featureName string 特征项名称 是 -
请求体:
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 featureName string 特征项名称 是 -
请求示例
DELETE /bitanswer/api/sns/{sn}/features/name/{featureName} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1 } ] } }
按fid获取特征项
-
请求地址:
GET /sns/{sn}/features/fid/{fid}
-
接口概述:
获取指定授权码的指定fid的特征项列表。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 fid integer 特征项fid 是 -
请求体:
无
-
请求示例
GET /bitanswer/api/sns/{sn}/features/fid/{fid} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 2, "items": [ { "id": 1, "guid": "xxxxx1", "name": "feature_name_1", "featureId": 101, "value": 2220, "source": "PRODUCT", "hidden": false, "overwrite": true, "display": true, "online": false, "ignoreSnUser": false, "status": 3, "type": "ReadOnly" }, { "id": 2, "guid": "xxxxx2", "name": "feature_name_2", "featureId": 101, "value": 1111, "source": "PRODUCT", "hidden": false, "overwrite": true, "display": true, "online": false, "ignoreSnUser": false, "status": 3, "type": "ReadOnly" } ] } }
按fid取消勾选指定特征项
-
请求地址:
DELETE /sns/{sn}/features/fid/{fid}
-
接口概述:
按fid取消勾选授权码的特征项列表。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 uid integer 特征项uid 是 -
请求体:
无
-
请求示例
DELETE /bitanswer/api/sns/{sn}/features/fid/{fid} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 2, "items": [ { "id": 1 }, { "id": 2 } ] } }
按ID获取特征项
-
请求地址:
GET /sns/{sn}/features/{uid}
-
接口概述:
获取指定SN、指定ID的特征项。ID通过产品特征项接口获取。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 uid integer 特征项uid 是 -
请求体:
无
-
请求示例
GET /bitanswer/api/sns/{sn}/features/{uid} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1, "guid": "xxx", "name": "foo", "featureId": 1, "value": 0, "source": "PRODUCT", "hidden": false, "status": 3, "type": "ReadOnly" } ] } }
按ID绑定/更新特征项
-
请求地址:
PATCH /sns/{sn}/features/{uid}
POST /sns/{sn}/features/{uid}
-
接口概述:
指定特征项ID,为SN绑定特征项或更新特征项信息。
仅绑定时,请求体不可以设置为none,必须传入一个空对象。
PATCH 方法表示仅更新输入的内容;
POST 方法表示除输入的内容外,未输入的内容按默认值处理,适用于重置数据。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 uid integer 特征项uid 是 -
请求体:
参数名 参数类型 参数说明 必需 备注 value integer 值 否 -
请求示例
PATCH /bitanswer/api/sns/{sn}/features/{uid} HTTP/1.1 Host: back-office-api.bitanswer.cn Content-Type: application/json bitkey: •••••• { "value": 1 }
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1, "value": 1 } ] } }
按ID取消勾选指定特征项
-
请求地址:
DELETE /sns/{sn}/features/{uid}
-
接口概述:
指定特征项ID,为SN取消勾选特征项。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 uid integer 特征项uid 是 -
请求体:
参数名 参数类型 参数说明 必需 备注 value integer 值 否 -
请求示例
DELETE /bitanswer/api/sns/{sn}/features/{uid} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1 } ] } }
按名称和版本获取特征项
-
请求地址:
GET /sns/{sn}/features/name/{featureName}/version/{version}
-
接口概述:
获取指定SN、指定名称和版本的唯一特征项。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 featureName string 特征项名称 是 version string 特征项版本 是 -
请求体:
无
-
请求示例
GET /bitanswer/api/sns/{sn}/features/name/{featureName}/version/{version} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1, "guid": "xxx", "name": "foo", "featureId": 1, "value": 0, "source": "PRODUCT", "hidden": false, "status": 3, "type": "ReadOnly" } ] } }
按名称和版本取消勾选指定特征项
-
请求地址:
DELETE /sns/{sn}/features/name/{featureName}/version/{version}
-
接口概述:
指定SN、指定名称和版本,接触特征项的勾选。
-
请求参数:
地址参数
参数名 参数类型 参数说明 必需 备注 sn string 授权码 是 featureName string 特征项名称 是 version string 特征项版本 是 -
请求体:
无
-
请求示例
DELETE /bitanswer/api/sns/{sn}/features/name/{featureName}/version/{version} HTTP/1.1 Host: back-office-api.bitanswer.cn bitkey: ••••••
-
响应示例
{ "status": 0, "data": { "total": 1, "items": [ { "id": 1 } ] } }