查询工程树
功能介绍
逐层查询工程树。
- 查询工程树中包的直接子节点,子节点类型包含:包、图、元素。
- 查询工程树中元素的直接子节点,子节点类型包含:图、元素。
URI
GET /v1/modelproject/{uuid}/tree 请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| uuid | 是 | String | 参数解释: 软件建模工程id。 通过查询模型工程列表接口获取,响应消息体content中的model_project_uuid就是软件建模工程id。 约束限制: 由数字、字母、'-'组成。 取值范围: 32/36位字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| version_uuid | 是 | String | 参数解释: 分支uuid。master分支传空字符串。 通过查询工程分支信息获取。 约束限制: 由数字、字母、'-'组成。 取值范围: 空字符串、32/36位字符。 默认取值: 空字符串 |
| parent_uuid | 否 | String | 参数解释: 父节点的id。可以是包uuid或者元素uuid,传空或不传默认查询根目录下节点数据。获取方式: 通过本接口逐级查询,响应消息体中的packages数组中的uuid是包uuid,elements数组中的uuid是元素uuid。 约束限制: 由数字、字母、'-'组成。 取值范围: 空字符串、32/36位字符。 默认取值: 空字符串 |
| parent_node_type | 否 | String | 参数解释: 父节点类型,不传默认package 约束限制: 不涉及。 取值范围:
默认取值: package |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 接口返回的状态信息 取值范围: success:执行成功, failed:执行失败。 |
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
| result | Object | 参数解释: 响应对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| content | Array of content objects | 参数解释: 工程树响应体内容。 取值范围: 不涉及。 |
| count | Integer | 参数解释: 分页返回的总条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| packages | Arrays of packages objects | 参数解释: 包列表。 取值范围: 不涉及。 |
| elements | Arrays of elements objects | 参数解释: 元素列表。 取值范围: 不涉及。 |
| diagrams | Arrays of diagrams objects | 参数解释: 模型图列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| model_project_uuid | String | 参数解释: 软件建模工程id。 取值范围: 不涉及。 |
| version_uuid | String | 参数解释: 分支uuid。 取值范围: 不涉及。 |
| uuid | String | 参数解释: 包id。 取值范围: 不涉及。 |
| name | String | 参数解释: 包名称。 取值范围: 不涉及。 |
| parent_uuid | String | 参数解释: 工程树父节点uuid。 取值范围: 不涉及。 |
| stereotype | String | 参数解释: 包构造型。 取值范围: 不涉及。 |
| type | String | 参数解释: 包类型。 取值范围: 不涉及。 |
| sequence | Integer | 参数解释: 序号。 取值范围: 不涉及。 |
| has_child | Boolean | 参数解释: 是否包含子节点。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| model_project_uuid | String | 参数解释: 软件建模工程id。 取值范围: 不涉及。 |
| version_uuid | String | 参数解释: 分支uuid。 取值范围: 不涉及。 |
| uuid | String | 参数解释: 元素id。 取值范围: 不涉及。 |
| name | String | 参数解释: 元素名称。 取值范围: 不涉及。 |
| package_uuid | String | 参数解释: 上层包节点uuid。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述。 取值范围: 不涉及。 |
| stereotype | String | 参数解释: 元素构造型。 取值范围: 不涉及。 |
| type | String | 参数解释: 元素类型。 取值范围: 不涉及。 |
| instance_from | String | 参数解释: 实例元素的源元素uuid。 取值范围: 不涉及。 |
| link_from | String | 参数解释: 引用元素的源元素uuid。 取值范围: 不涉及。 |
| parent_uuid | String | 参数解释: 工程树父节点uuid。 取值范围: 不涉及。 |
| sequence | Integer | 参数解释: 序号。 取值范围: 不涉及。 |
| has_child | Boolean | 参数解释: 是否包含子节点。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| model_project_uuid | String | 参数解释: 软件建模工程id。 取值范围: 不涉及。 |
| version_uuid | String | 参数解释: 分支uuid。 取值范围: 不涉及。 |
| uuid | String | 参数解释: 模型图id。 取值范围: 不涉及。 |
| name | String | 参数解释: 模型图名称。 取值范围: 不涉及。 |
| package_uuid | String | 参数解释: 上层包节点uuid。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述。 取值范围: 不涉及。 |
| stereotype | String | 参数解释: 模型构造型。 取值范围: 不涉及。 |
| type | String | 参数解释: 模型类型。 取值范围: 不涉及。 |
| parent_uuid | String | 参数解释: 工程树父节点uuid。 取值范围: 不涉及。 |
| sequence | Integer | 参数解释: 序号。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/modelproject/b83895e1c0464192be392a6f9e6deace/tree?version_uuid=184d5695f7814daf8124145dfae02735&parent_uuid=&parent_node_type=package 响应示例
状态码: 200
success
{
"status": "success",
"error_code": null,
"error_msg": null,
"result": {
"content": {
"packages": [
{
"model_project_uuid": "acc76f55df0e453080094aa89b80047b",
"version_uuid": "",
"uuid": "30ca6fc9285b498b8120ffa292595810",
"name": "111",
"stereotype": "package",
"type": "Package",
"parent_uuid": "9545fa8e7c4c455db41b7fc11cd5045a",
"sequence": 1,
"has_child": false
}
],
"elements": [
{
"model_project_uuid": "acc76f55df0e453080094aa89b80047b",
"version_uuid": "",
"package_uuid": null,
"uuid": "7fde21f2462b4125e6bbd80c4e7dca56",
"name": "System1",
"description": "",
"stereotype": "System",
"type": "Component",
"instance_from": "",
"link_from": "",
"parent_uuid": "9545fa8e7c4c455db41b7fc11cd5045a",
"sequence": 0,
"has_child": false
}
],
"diagrams": [
{
"model_project_uuid": "acc76f55df0e453080094aa89b80047b",
"version_uuid": "",
"package_uuid": "9545fa8e7c4c455db41b7fc11cd5045a",
"uuid": "688a07493875486d91396a3970002a19",
"name": "逻辑模型",
"description": "",
"stereotype": "f0a5e8a3-ac06-11e1-012-0242ac117104",
"type": "rtu1ee8a3-ac06-11e8-9e12-0242ac117104",
"parent_uuid": "",
"sequence": 0
}
]
},
"count": 0
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | success |
错误码
参考错误码。