# 批量创建分享结构化文档 - BatchCreateShareDocs #### 功能介绍 本接口用于批量创建结构化文档的分享记录，实现文档的跨用户或跨团队协作共享。当需要将产品设计说明书、工艺卡片、BOM清单等结构化文档共享给团队成员、上下游合作伙伴或全体用户时，可调用本接口一次性完成批量分享配置。 - 调用本接口时，需在params数组中传入多个分享记录，每个元素对应一条文档分享配置。 - 分享时可指定被分享用户的权限级别： - 当auth_type为read时，被分享用户仅可查看文档内容。 - 当auth_type为write时，被分享用户可查看和编辑文档内容。 - 当shared_user_id和shared_user_name均设置为all时，表示将文档分享给所有用户。 #### 接口约束 - 目标数据模型已在应用设计态配置了"结构化文档管理"功能。 - 待分享的结构化文档必须已存在，且未被删除。 - 分享用户需具备目标文档的分享权限。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/iDMEClassicAPI/doc?api=BatchCreateShareDocs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 #### URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc/batch 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | identifier | 是 | String | **参数解释：** 应用的唯一标识。 - 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。 - 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。 获取方法请参见[获取运行服务清单 - ListEnvs](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | modelName | 是 | String | **参数解释：** 数据模型的英文名称。 **约束限制：** 不涉及。 **取值范围：** 以大写字母开头，只能包含字母、数字、"_"，且长度为1-60个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** IAM用户的token。 获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | applicationId | 否 | String | **参数解释：** 应用ID，用于指定实例所属的应用。 当URL路径中已能明确应用上下文时，此参数可不传。 获取方法请参见[获取租户下的应用清单 - ListApps](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | params | 是 | Array of [ShareDocsParamDto] objects | **参数解释：** 批量分享参数数组，每个元素包含一条文档分享配置信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4ShareDocsParamDto | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | structured_doc_id | 否 | String | **参数解释：** 结构化文档ID，系统生成的文档主键唯一标识，用于指定待分享的目标文档。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | shared_user_id | 否 | String | **参数解释：** 被分享用户ID，用于指定接收文档分享的目标用户。 **约束限制：** 不涉及。 **取值范围：** - all：表示分享给所有用户。 - 其他值：指定具体用户的ID。 **默认取值：** 不涉及。 | | shared_user_name | 否 | String | **参数解释：** 被分享用户名，用于指定接收文档分享的目标用户名称。 **约束限制：** 不涉及。 **取值范围：** - all：表示分享给所有用户。 - 其他值：指定具体用户的名称。 **默认取值：** 不涉及。 | | share_user_id | 否 | String | **参数解释：** 分享用户ID，用于标识执行本次分享操作的用户。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | share_user_name | 否 | String | **参数解释：** 分享用户名，用于标识执行本次分享操作的用户名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | auth_type | 否 | String | **参数解释：** 认证类型，用于指定被分享用户对文档的访问权限级别。 **约束限制：** 不涉及。 **取值范围：** - read：只读权限，被分享用户仅可查看文档内容，适用于文档发布、信息同步等场景。 - write：读写权限，被分享用户可查看和编辑文档内容，适用于协同设计、工艺评审等场景。 **默认取值：** 不涉及。 | | modifier | 否 | String | **参数解释：** 更新者账号，用于记录执行本次分享操作的用户信息。 若不指定，默认使用当前调用者账号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 当前调用者账号。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 请求处理结果状态。 **取值范围：** - SUCCESS：请求成功。 - FAIL：请求失败。 | | data | Array of integers | **参数解释：** 请求数据，返回本次操作影响的记录数。 **取值范围：** 不涉及。 | | errors | Array of strings | **参数解释：** 异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。 **取值范围：** 不涉及。 | #### 请求示例 **示例：批量创建结构化文档分享（分享给所有用户）** 将文档ID为721022465261703168的结构化文档以读权限分享给所有用户。 ``` POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/StructuredDocableModel/structured-doc/share-doc/batch { "params" : [ { "structured_doc_id" : "721022465261703168", "shared_user_id" : "all", "shared_user_name" : "all", "share_user_id" : "93172bbfd0f64437956d4c9de9345386", "share_user_name" : "XDM_Developer", "auth_type" : "read" } ] } ``` #### 响应示例 **状态码：200** OK，表示请求成功。 ``` { "result" : "SUCCESS", "data" : [ ], "errors" : [ ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK，表示请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/APIE-XDM-Runtime-ErrorCode.html)。