1. 批量生成构件二维码

批量生成构件的二维码。


请求方式:POST

请求地址:/api/{databaseKey}/components/qrcs ?modelKey={xxx}share={yyy}

1.1. 请求参数

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea 操作的通关令牌

PathParas:

参数名 类型 示例 是否必填 参数含义
databaseKey string test 数据库key,必传

SearchParas:

参数名 类型 示例 是否必填 参数含义
modelKey string NULL 模型key
share string NULL 分享的key

Body

application/json:

multipart/form-data
{
        "treeKey":""
            "components":["38592-675657","38592-675658"]
        "attributes":{
        "构件id":"key",
        "构件名称":"name",
        "业务编码":"attribute.xxx"
        }
        "size":100
}

1.2. 正确返回

Excel文件,格式如下:

序号 二维码 构件id 构件名称 业务编码 模型树路径
1 图片 NULL NULL NULL NULL
2 图片 NULL NULL NULL NULL
3 图片 NULL NULL NULL NULL
4 图片 NULL NULL NULL NULL

1.3. 状态码

状态码 code message data 原因
400 BAD_QRC_PARAMETER components中的(key)不属于模型 NULL 当components中的构件不属于模型时
400 BAD_QRC_PARAMETER 不支持族树或部件树 NULL 当treeKey对应的树结构为族树或部件树时
400 BAD_QRC_PARAMETER components中的key不能为空 NULL 当components中存在空的key时
400 BAD_QRC_PARAMETER components中的key(key)重复 NULL 当components中存在重复的key时
400 BAD_QRC_PARAMETER 参数(size)必须介于100~1000之间 NULL 当size不在[100,1000]区间时

1.4. 备注

建议参数components中的构件key不超过500个

1.5. 注意事项

1)扫描二维码得到信息:{ "product": "BOS", //默认 "app": "BOS应用key",//默认 "db": "模型库key",//默认 "model": "模型key",//默认 "构件id": "构件key",//默认"构件名称":"构件001","业务编码":"SN001"}

2)attributes列表可以指定二维码需要包含的构件属性显示名及属性名,属性名可以是name、type等,也可以是构件attribute属性中的某个子属性(如attribute.标高),属性与子属性用英文符号点(.)连接,返回值中属性名使用显示名

3)size指定二维码图片宽度和高度(像素),默认值100,取值范围[100,1000]

4)treeKey可选,默认值为空间树,不支持族树、部件树。Excel文件中的路径为构件在该树结构中的路径

5)components不能为空,元素不能为空、不可重复、且应属于同一个模型

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2021 all right reserved,powered by Gitbook该文件修订时间: 2021-08-25 16:16:24

results matching ""

    No results matching ""