文档首页/工业数字模型驱动引擎/API参考/API/数据建模引擎/结构化文档管理/批量创建分享结构化文档 - BatchCreateShareDocs
更新时间：2025-11-07 GMT+08:00
查看PDF
分享

批量创建分享结构化文档 - BatchCreateShareDocs

功能介绍

批量创建分享结构化文档。

接口约束

功能列表勾选了结构化文档管理的模型可以使用该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc/batch

表1 路径参数

参数

是否必选

参数类型

描述

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

大写字母开头，只能包含字母、数字、“_”，且长度为[1-60]个字符。

默认取值：

不涉及。

identifier

是

String

参数解释：

应用唯一标识。

约束限制：

不涉及。

取值范围：

由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

获取方法请参见获取IAM用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

应用ID。

约束限制：

不涉及。

取值范围：

由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

params

是

Array of ShareDocsParamDto objects

参数解释：

请求参数对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表4 ShareDocsParamDto

参数

是否必选

参数类型

描述

structured_doc_id

否

String

参数解释：

结构化文档ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

shared_user_id

否

String

参数解释：

被分享用户UserId。

约束限制：

不涉及。

取值范围：

all：表示所有人。

默认取值：

不涉及。

shared_user_name

否

String

参数解释：

被分享用户名。

约束限制：

不涉及。

取值范围：

all：表示所有人。

默认取值：

不涉及。

share_user_id

否

String

参数解释：

分享用户UserId。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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

参数解释：

异常信息。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_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

错误码

请参见错误码。

相关文档