文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 版本服务/ 批量检出M-V模型数据实例
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

批量检出M-V模型数据实例

功能介绍

根据主对象ID批量检出M-V模型数据实例。

接口约束

仅MV模型可以使用该接口。

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchCheckout

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

应用ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

params

否

Array of VersionModelVersionCheckOutDTO objects

参数解释：

请求参数对象。

取值范围：

不涉及。

默认取值：

不涉及。
表4 VersionModelVersionCheckOutDTO

参数

是否必选

参数类型

描述

creator

否

String

参数解释：

创建人。

取值范围：

不涉及。

默认取值：

不涉及。

customLinkSet

否

Array of strings

参数解释：

关系实体名称集合，与workCopyType的值CUSTOM配合使用。

取值范围：

不涉及。

默认取值：

不涉及。

masterId

是

String

参数解释：

主对象ID。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

否

String

参数解释：

更新者。

取值范围：

不涉及。

默认取值：

不涉及。

workCopyType

否

String

参数解释：

关系的复制类型。

取值范围：

  • BOTH：若存在关系实例引用此数据实例作为源端实例或目标端实例，检出后的数据实例将继承这些关系实例。

  • SOURCE：若存在关系实例引用此数据实例作为源端实例，检出后的数据实例将继承这些关系实例。

  • TARGET：若存在关系实例引用此数据实例作为目标端实例，检出后的数据实例将继承这些关系实例。

  • NONE：检出后的数据实例将不继承任何关系实例。

  • CUSTOM：若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例，检出后的数据实例将继承这些关系实例。

默认取值：

不涉及。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求结果。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

默认取值：

不涉及。

data

Array of VersionModelViewDTO objects

参数解释：

请求数据。

取值范围：

不涉及。

默认取值：

不涉及。

errors

Array of strings

参数解释：

异常信息。

取值范围：

不涉及。

默认取值：

不涉及。
表6 VersionModelViewDTO

参数

参数类型

描述

branch

VersionModelBranchViewDTO object

参数解释：

分支对象。

取值范围：

不涉及。

默认取值：

不涉及。

checkOutTime

String

参数解释：

检出时间。

取值范围：

不涉及。

默认取值：

不涉及。

checkOutUserName

String

参数解释：

检出人。

取值范围：

不涉及。

默认取值：

不涉及。

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

description

String

参数解释：

描述信息。

取值范围：

不涉及。

默认取值：

不涉及。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

iteration

Integer

参数解释：

迭代版本。

取值范围：

不涉及。

默认取值：

不涉及。

kiaguid

String

参数解释：

KIA密级。

取值范围：

不涉及。

默认取值：

不涉及。

lastUpdateTime

String

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

latest

Boolean

参数解释：

是否为最新版本。

取值范围：

  • true：是最新版本。

  • false：不是最新版本。

默认取值：

false。

latestIteration

Boolean

参数解释：

是否为最新迭代版本。

取值范围：

  • true：是最新迭代版本。

  • false：不是最新迭代版本。

默认取值：

不涉及。

latestVersion

Boolean

参数解释：

是否为最新修订版本。

取值范围：

  • true：是最新修订版本。

  • false：不是最新修订版本。

默认取值：

不涉及。

master

VersionModelMasterViewDTO object

参数解释：

主对象。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

中文名称。

取值范围：

不涉及。

默认取值：

不涉及。

preVersionId

String

参数解释：

前序版本实例ID。

取值范围：

不涉及。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

securityLevel

String

参数解释：

安全密级。

取值范围：

  • INTERNAL：内部公开。

  • SECRET：秘密。

  • CONFIDENTIAL：机密。

  • TOP_SECRET：绝密。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。

version

String

参数解释：

版本号。

取值范围：

不涉及。

默认取值：

不涉及。

versionCode

Integer

参数解释：

业务版本内码。

取值范围：

不涉及。

默认取值：

不涉及。

workingCopy

Boolean

参数解释：

是否已检出。

取值范围：

  • true：已检出。

  • false：未检出。

默认取值：

false。

workingState

WorkingState object

参数解释：

工作状态。

取值范围：

不涉及。

默认取值：

不涉及。
表7 VersionModelBranchViewDTO

参数

参数类型

描述

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

id

String

参数解释：

唯一标识。

约束限制：

不涉及。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

lastUpdateTime

Object

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。

version

String

参数解释：

版本号。

取值范围：

不涉及。

默认取值：

不涉及。
表8 VersionModelMasterViewDTO

参数

参数类型

描述

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

lastUpdateTime

String

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。
表9 TenantViewDTO

参数

参数类型

描述

className

String

参数解释：

类名。

取值范围：

不涉及。

默认取值：

不涉及。

code

String

参数解释：

租户编码。

取值范围：

不涉及。

默认取值：

不涉及。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

默认取值：

不涉及。

dataSource

String

参数解释：

租户使用的数据源名称。

取值范围：

不涉及。

默认取值：

不涉及。

description

String

参数解释：

描述信息。

取值范围：

不涉及。

默认取值：

不涉及。

disableFlag

Boolean

参数解释：

失效标识。

取值范围：

  • true：失效。

  • false：未失效。

默认取值：

false。

id

String

参数解释：

唯一标识。

取值范围：

-9223372036854775808到9223372036854775807的整数。

默认取值：

不涉及。

kiaguid

String

参数解释：

KIA密级。

取值范围：

不涉及。

默认取值：

不涉及。

lastUpdateTime

String

参数解释：

最后更新时间。

取值范围：

不涉及。

默认取值：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

中文名称。

取值范围：

不涉及。

默认取值：

不涉及。

rdmDeleteFlag

Integer

参数解释：

软删除标识。

取值范围：

  • 0：表示未删除。

  • 1：表示已删除。

默认取值：

0。

rdmExtensionType

String

参数解释：

扩展类型。

取值范围：

不涉及。

默认取值：

不涉及。

rdmVersion

Integer

参数解释：

系统版本。

取值范围：

不涉及。

默认取值：

不涉及。

securityLevel

String

参数解释：

安全密级。

取值范围：

  • INTERNAL：内部公开。

  • SECRET：秘密。

  • CONFIDENTIAL：机密。

  • TOP_SECRET：绝密。

默认取值：

不涉及。

tenant

TenantViewDTO object

参数解释：

租户信息。

取值范围：

不涉及。

默认取值：

不涉及。
表10 WorkingState

参数

参数类型

描述

alias

String

参数解释：

别名。

取值范围：

不涉及。

默认取值：

不涉及。

cnName

String

参数解释：

中文名称。

取值范围：

不涉及。

默认取值：

不涉及。

code

String

参数解释：

编码。

取值范围：

不涉及。

默认取值：

不涉及。

enName

String

参数解释：

英文名称。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/batchCheckout

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "params" : [ {
    "masterId" : "602146893727801345",
    "modifier" : "test1",
    "workCopyType" : "BOTH",
    "creator" : "test1",
    "customLinkSet" : [ ]
  } ]
}

响应示例

状态码： 200

OK

{
  "result" : "SUCCESS",
  "data" : [ {
    "id" : "601060080745455616",
    "creator" : "test1",
    "modifier" : "test1",
    "createTime" : "2024-02-19T06:38:10.406+0000",
    "lastUpdateTime" : "2024-02-19T06:56:43.319+0000",
    "rdmVersion" : 4,
    "rdmDeleteFlag" : 0,
    "rdmExtensionType" : "VersionModel",
    "tenant" : {
      "id" : "-1",
      "creator" : "xdmAdmin",
      "modifier" : "xdmAdmin",
      "createTime" : "2023-12-01T01:25:21.000+0000",
      "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
      "rdmVersion" : 1,
      "rdmDeleteFlag" : 0,
      "rdmExtensionType" : "Tenant",
      "tenant" : null,
      "className" : "Tenant",
      "name" : "basicTenant",
      "description" : "默认租户",
      "kiaguid" : null,
      "securityLevel" : "internal",
      "nameEn" : null,
      "code" : "basicTenant",
      "disableFlag" : false,
      "dataSource" : "DefaultDataSource"
    },
    "className" : "VersionModel",
    "name" : "modifier name",
    "description" : "modifier description",
    "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f",
    "securityLevel" : "internal",
    "master" : {
      "id" : "601060080779010048",
      "creator" : "test1",
      "modifier" : "test1",
      "createTime" : "2024-02-19T06:38:10.419+0000",
      "lastUpdateTime" : "2024-02-19T06:56:43.319+0000",
      "rdmVersion" : 4,
      "rdmDeleteFlag" : 0,
      "rdmExtensionType" : "VersionModelMaster",
      "tenant" : {
        "id" : "-1",
        "creator" : "xdmAdmin",
        "modifier" : "xdmAdmin",
        "createTime" : "2023-12-01T01:25:21.000+0000",
        "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
        "rdmVersion" : 1,
        "rdmDeleteFlag" : 0,
        "rdmExtensionType" : "Tenant",
        "tenant" : null,
        "className" : "Tenant",
        "name" : "basicTenant",
        "description" : "默认租户",
        "kiaguid" : null,
        "securityLevel" : "internal",
        "nameEn" : null,
        "code" : "basicTenant",
        "disableFlag" : false,
        "dataSource" : "DefaultDataSource"
      },
      "className" : "VersionModelMaster"
    },
    "branch" : {
      "id" : "601060080799981568",
      "creator" : "test1",
      "modifier" : "test1",
      "createTime" : "2024-02-19T06:38:10.464+0000",
      "lastUpdateTime" : "2024-02-19T06:56:43.319+0000",
      "rdmVersion" : 4,
      "rdmDeleteFlag" : 0,
      "rdmExtensionType" : "VersionModelBranch",
      "tenant" : {
        "id" : "-1",
        "creator" : "xdmAdmin",
        "modifier" : "xdmAdmin",
        "createTime" : "2023-12-01T01:25:21.000+0000",
        "lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
        "rdmVersion" : 1,
        "rdmDeleteFlag" : 0,
        "rdmExtensionType" : "Tenant",
        "tenant" : null,
        "className" : "Tenant",
        "name" : "basicTenant",
        "description" : "默认租户",
        "kiaguid" : null,
        "securityLevel" : "internal",
        "nameEn" : null,
        "code" : "basicTenant",
        "disableFlag" : false,
        "dataSource" : "DefaultDataSource"
      },
      "className" : "VersionModelBranch",
      "version" : "A"
    },
    "latest" : true,
    "latestIteration" : true,
    "versionCode" : 1,
    "iteration" : 1,
    "version" : "A",
    "latestVersion" : true,
    "workingCopy" : false,
    "workingState" : {
      "code" : "INWORK",
      "cnName" : "工作中",
      "enName" : "inwork",
      "alias" : "INWORK"
    },
    "checkOutUserName" : "Zhaoliu",
    "checkOutTime" : "2024-02-20T03:20:17.843+0000",
    "preVersionId" : "601372141664866304"
  } ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 版本服务

相关文档