获取指定M-V模型实例的版本列表 - ListAllVersions
功能介绍
本接口用于根据主对象ID(masterId),分页获取指定Master-Branch-Version(M-V)模型实例的所有版本信息(包含对应版本下的属性信息)。
在调用本接口前,请确保目标数据模型满足以下条件:
接口约束
本接口仅支持M-V模型数据实例,不支持普通单实体或关系实体。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/getAllVersions/{pageSizePath}/{curPagePath}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSizePath | 是 | Integer | 参数解释: 分页大小,即每页返回的实例数量。 约束限制: 不涉及。 取值范围: 1-1000。 默认取值: 不涉及。 |
| curPagePath | 是 | Integer | 参数解释: 当前页数,从1开始计数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1。 |
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: M-V模型的英文名称。 约束限制: 必须为已发布的M-V模型,单实体、关系实体不支持。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| curPage | 否 | Integer | 参数解释: 当前页码,从1开始计数。当路径参数curPagePath未指定时生效。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1。 |
| endIndex | 否 | Integer | 参数解释: 结束索引,用于指定查询结果的结束位置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| maxPageSize | 否 | Integer | 参数解释: 最大分页数,用于限制返回的最大页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1000。 |
| pageSize | 否 | Integer | 参数解释: 分页大小,即每页返回的实例数量。当路径参数pageSizePath未指定时生效。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1000。 |
| startIndex | 否 | Integer | 参数解释: 起始索引,用于指定查询结果的起始位置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| totalPages | 否 | Integer | 参数解释: 总页数,用于指定查询的总页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| totalRows | 否 | Integer | 参数解释: 总行数,用于指定查询的总行数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度固定为32个字符。 默认取值: 不涉及。 |
| params | 是 | VersionModelVersionMasterDTO object | 参数解释: 请求参数对象,包含主对象标识及版本过滤条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 请求处理结果状态。 取值范围: |
| data | Array of VersionModelQueryViewDTO objects | 参数解释: 请求数据。 取值范围: 不涉及。 |
| errors | Array of strings | 参数解释: 异常信息列表。当result为FAIL时,返回具体的错误描述,包含失败原因及建议处理方式。 取值范围: 不涉及。 |
| pageInfo | PageInfoViewDTO object | 参数解释: 分页信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| branch | 参数解释: 分支对象。 取值范围: 不涉及。 | |
| checkOutTime | String | 参数解释: 检出时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| checkOutUserName | String | 参数解释: 检出人。 取值范围: 不涉及。 |
| className | String | 参数解释: 类名。 取值范围: 不涉及。 |
| createTime | String | 参数解释: 创建时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者账号。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述信息。 取值范围: 不涉及。 |
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 |
| iteration | Integer | 参数解释: 迭代版本。 取值范围: 不涉及。 |
| lastUpdateTime | String | 参数解释: 最后更新时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| latest | Boolean | 参数解释: 是否为最新版本。 取值范围: |
| latestIteration | Boolean | 参数解释: 是否为最新迭代版本。 取值范围: |
| latestVersion | Boolean | 参数解释: 是否为最新修订版本。 取值范围: |
| master | MasterObjectQueryViewDTO object | 参数解释: 主对象。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 更新者账号。 取值范围: 不涉及。 |
| name | String | 参数解释: 中文名称。 取值范围: 不涉及。 |
| preVersionId | String | 参数解释: 前序版本实例ID。 取值范围: 不涉及。 |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 |
| tenant | TenantQueryViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 |
| version | String | 参数解释: 版本号。 取值范围: 不涉及。 |
| versionCode | Integer | 参数解释: 业务版本内码。 取值范围: 不涉及。 |
| workingCopy | Boolean | 参数解释: 是否已检出。 取值范围: |
| workingState | WorkingState object | 参数解释: 工作状态。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| className | String | 参数解释: 类名。 取值范围: 不涉及。 |
| createTime | String | 参数解释: 创建时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者账号。 取值范围: 不涉及。 |
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 |
| lastUpdateTime | String | 参数解释: 最后更新时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 更新者账号。 取值范围: 不涉及。 |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 |
| tenant | TenantQueryViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 |
| version | String | 参数解释: 版本号。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| className | String | 参数解释: 类名。 取值范围: 不涉及。 |
| createTime | String | 参数解释: 创建时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者账号。 取值范围: 不涉及。 |
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 |
| lastUpdateTime | String | 参数解释: 最后更新时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 更新者账号。 取值范围: 不涉及。 |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 |
| tenant | TenantQueryViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| className | String | 参数解释: 类名。 取值范围: 不涉及。 |
| code | String | 参数解释: 租户编码。 取值范围: 不涉及。 |
| createTime | String | 参数解释: 创建时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者账号。 取值范围: 不涉及。 |
| dataSource | String | 参数解释: 租户使用的数据源名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述信息。 取值范围: 不涉及。 |
| disableFlag | Boolean | 参数解释: 失效标识。 取值范围: |
| id | String | 参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 |
| lastUpdateTime | String | 参数解释: 最后更新时间。使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 更新者账号。 取值范围: 不涉及。 |
| name | String | 参数解释: 中文名称。 取值范围: 不涉及。 |
| rdmExtensionType | String | 参数解释: 扩展类型。 取值范围: 不涉及。 |
| tenant | TenantQueryViewDTO object | 参数解释: 租户信息。 取值范围: 不涉及。 |
请求示例
示例:分页查询版本模型的所有历史版本
指定主干节点ID(masterId)为602146893727801345,版本标识(version)为A,分页查询第1页(每页10条)。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/VersionModel/getAllVersions/10/1
{
"applicationId" : "04219627d6794f37ae26e8aba250415d",
"params" : {
"masterId" : "602146893727801345",
"version" : "A"
}
} 响应示例
状态码: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": "CHECKED_IN",
"cnName": "已检入",
"enName": "checked in",
"alias": "CHECKED_IN"
},
"checkOutUserName": null,
"checkOutTime": null,
"preVersionId": null
}
],
"errors": [],
"pageInfo": {
"curPage": 1,
"pageSize": 10,
"totalRows": 1,
"totalPages": 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。