选项集
获取选项集列表
根据鉴权方式查看“获取选项集列表”对应的真实 API 地址、参数与响应。
鉴权方式
AppKey + Sign 是应用密钥鉴权,由管理员创建,用于以应用管理员身份访问应用数据。
版本
请求地址
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
响应参数
200成功获取选项集列表| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 是否调用成功 |
error_code | integer | 错误代码 |
error_msg | string | 错误消息 |
data | object | 选项集列表查询结果 |
data.optionsets | object[] | 选项集列表 |
data.optionsets.id | string | 选项集ID |
data.optionsets.name | string | 选项集名称 |
data.optionsets.accountId | string | 账户ID |
data.optionsets.worksheetIds | string[] | 引用选项集的工作表列表 |
data.optionsets.options | object[] | 选项列表 |
data.optionsets.options.key | string | 选项id |
data.optionsets.options.value | string | 选项值,不允许重复 |
data.optionsets.options.index | integer | 选项排序值: 必须为整数,越小越靠前 |
data.optionsets.options.isDeleted | boolean | 该选项是否已被删除 |
data.optionsets.options.color | string | 颜色值 |
data.optionsets.options.score | integer | 选项分值 |
data.optionsets.enableColor | boolean | 启用彩色 |
data.optionsets.enableScore | boolean | 启用分值 |
curl -X GET "https://example.com/v3/app/optionsets" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}"{ "data": { "optionsets": [ { "id": "optionset123", "name": "状态选项集", "accountId": "account123", "worksheetIds": [ "worksheet123", "worksheet456" ], "options": [ { "key": "key1", "value": "进行中", "index": 1, "isDeleted": false, "color": "#2196F3", "score": 50 }, { "key": "key2", "value": "已完成", "index": 2, "isDeleted": false, "color": "#4CAF50", "score": 100 } ], "enableColor": true, "enableScore": true } ] }, "success": true}