批量查询图
功能介绍
批量查询图。支持按图名称、图uuid和图类型进行查询
URI
POST /v1/modelproject/{uuid}/diagrams 请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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位字符。 默认取值: 空字符串 |
| offset | 否 | Integer | 参数解释: 偏移量,表示从此偏移量开始查询需配合limit一起使用。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 1到200。 默认取值: 10。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| diagram_uuids | 否 | Array of Strings | 参数解释: 图uuid列表,可传多个,过滤使用,与其他过滤参数独立。获取方式:
约束限制: 图uuid由32/36位数字、字母、'-'组成。 取值范围: 0到200个图uuid。 默认取值: 不涉及。 |
| name | 否 | String | 参数解释: 图名称,过滤使用,与其他过滤参数独立。支持模糊查询。 约束限制: 图uuid。 取值范围: 0到255个字符。 默认取值: 不涉及。 |
注意:body参数中的条件间是 "且" 的关系,多个参数意味着同时满足所有类型条件,传空则不过滤此条件。
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 接口返回的状态信息 取值范围: success:执行成功, failed:执行失败。 |
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
| result | Object | 参数解释: 响应对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| content | Array of content objects | 参数解释: 模型图响应体内容。 取值范围: 不涉及。 |
| count | Integer | 参数解释: 分页返回的总条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| model_project_uuid | String | 参数解释: 软件建模工程id。 取值范围: 不涉及。 |
| version_uuid | String | 参数解释: 分支uuid。 取值范围: 不涉及。 |
| package_uuid | String | 参数解释: 上层包节点uuid。 取值范围: 不涉及。 |
| parent_uuid | String | 参数解释: 工程树父节点uuid。 取值范围: 不涉及。 |
| uuid | String | 参数解释: 模型图id。 取值范围: 不涉及。 |
| name | String | 参数解释: 模型图名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述。 取值范围: 不涉及。 |
| type | String | 参数解释: 模型类型。 取值范围: 不涉及。 |
| stereotype | String | 参数解释: 模型构造型。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v1/modelproject/4448ce13e7f045728ba63bd44bb00811/diagrams?version_uuid&limit=2&offset=1
{
"name":"",
"diagram_uuids":[]
} 响应示例
状态码: 200
{
"status": "success",
"error_code": null,
"error_msg": null,
"result": {
"content": [
{
"model_project_uuid": "7e03b0002d0644d68ebb88b629f0aafe",
"version_uuid": "",
"package_uuid": "01cd4ccaf85048c4b80e91511fbc04eb",
"parent_uuid": "",
"uuid": "95d46ca5db114ba8aaf43f18a607a7e6",
"name": "用例模型",
"description": "",
"type": "Usecase View",
"stereotype": "Usecase Model"
},
{
"model_project_uuid": "7e03b0002d0644d68ebb88b629f0aafe",
"version_uuid": "",
"package_uuid": "b01154dad6544c928bccfd6d829ddb9e",
"parent_uuid": "",
"uuid": "ed7d70dfc9ff495eaf68e2c8b290eb53",
"name": "逻辑模型",
"description": "",
"type": "Logic View",
"stereotype": "Logic Model"
}
],
"count": 14
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | success |
错误码
参考错误码。