GET 查询字典列表
GET 查询。query 参数见接口参考。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
project.drawing.configs.list | project:read | GET /v1/drawing/configs/list(comap-project) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
configType | string | 是 | — |
enabledOnly | boolean | — | — |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "project.drawing.configs.list",
"query": {
"configType": "string"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | — | ID |
configType | string | — | 配置类型(取值来源:图纸配置字典表) |
configName | string | — | 配置名称 |
parentCode | string | — | 父级码 |
sortOrder | integer(int32) | — | 排序 |
enabled | integer(int32) | — | 是否启用 |
extraJson | string | — | 扩展属性JSON |
remark | string | — | 备注 |
createTime | string(date-time) | — | 创建时间 |
updateTime | string(date-time) | — | 更新时间 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 project:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-project 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回图纸配置字典