1. 批量获取模型构件属性

获取一批构件的指定或全部属性。


请求方式:POST

请求地址:/api/{databaseKey}/components/batch?return={name,key}&share={share}

1.1. 请求参数

Headers:

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

PathParas:

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

SearchParas:

参数名 类型 示例 是否必填 参数含义
return string NULL 返回的属性列表
share string NULL 分享key

Body

application/json:

{
    "components":["38592-675657","38592-675658"]
}

1.2. 参数说明

参数名 类型 示例 是否必填 参数含义
components 数组 ["38592-675657","38592-675658"] 构件key列表

1.3. 正确返回

{
    "code":"SUCCESS",
    "message":"请求处理成功",
    "data": [
        {
            "name": "【S】HY-三通-丝接:标准:5874473",
            "key": "38592-675657"
        },
        {
            "name": "三'通",
            "key": "38592-675658"
        }
    ]
}

1.4. 状态码

状态码 code message data 原因
400 BAD_PARAMETER components中的key不能为空 NULL 当components中存在空的key时
400 BAD_PARAMETER_FORMAT 参数(xxx)格式不正确 NULL 当构件参数格式错误时
400 BAD_PARAMETER components中的key(key)重复 NULL 当components中存在重复的key时
400 COMPONENT_NOT_FOUND 构件(xx_xxx、yy_yyy)不存在 NULL 有一个或多个构件不存在时

1.5. 备注

建议查询参数components中的构件key不超过1000个。

1.6. 注意事项

1、如指定return参数,则返回指定的字段;否则返回全部属性。

2、对于attribute属性,可以指定其子属性,属性与子属性用英文符号点(.)连接,如attribute.限制条件.标高。

3、数据库启用gacl时,有模型关联的BOSF文档读取权限的用户。

4、数据库未启用gacl时,有数据库访问权限的用户。

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

results matching ""

    No results matching ""