文档首页/ 开天集成工作台 MSSI/ API参考/ API/ 应用模型/ 关系管理/ 关系操作接口
更新时间：2024-10-21 GMT+08:00
查看PDF
分享

关系操作接口

功能介绍

关系操作接口。

URI

POST /v3/{project_id}/abm/instances/{instance_id}/metadata3/relationships

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

instance_id

是

String

实例的ID。

  • 最小长度：1
  • 最大长度：64

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

relationships

是

Array of 表3 objects

关系，最大个数不超过200个。
表3 MetadataRelationshipRequest

参数

是否必选

参数类型

描述

from_urn

是

String

起点urn。

  • 最小长度：1
  • 最大长度：2000

target_urn

是

String

终点urn。

  • 最小长度：1
  • 最大长度：2000

relationship_code

是

String

关系编码。

  • 最小长度：1
  • 最大长度：255

relationship_extend

否

String

关系扩展。

change_type

是

String

操作类型。

枚举值：

  • UPSERT
  • DELETE

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

success

Array of 表5 objects

操作成功列表。

failure

Array of 表6 objects

操作失败列表。

msg

String

提示信息。
表5 MetadataRelationshipResponse

参数

参数类型

描述

from_urn

String

起点urn。

target_urn

String

终点urn。

relationship_code

String

关系编码。

relationship_extend

String

关系扩展。
表6 MetadataRelationshipFailureResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

from_urn

String

起点urn。

target_urn

String

终点urn。

relationship_code

String

关系编码。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/relationships
{
    "relationships": [
        {
            "from_urn": "urn:abm:Metamodel3-Report:3b0d3d1e8c0143dda08cc8ae9d058e",
            "target_urn": "urn:abm:Metamodel3-ReportGroup:a40d2f1e8c0143dda08cc8aeb401e4",
            "relationship_code": "Metamodel3-Report-Metamodel3-ReportGroup_CO",
            "change_type": "UPSERT"
        }
    ]
}

响应示例

状态码： 200

successful operation

{
    "msg": null,
    "success": [
        {
            "target_urn": "urn:abm:Metamodel3-ReportGroup:a40d2f1e8c0143dda08cc8aeb401e4",
            "relationship_extend": null,
            "from_urn": "urn:abm:Metamodel3-Report:3b0d3d1e8c0143dda08cc8ae9d058e",
            "relationship_code": "Metamodel3-Report-Metamodel3-ReportGroup_CO"
        }
    ],
    "failure": []
}

状态码

状态码

描述

200

successful operation.

400

Bad Request.

500

Internal Server Error.

错误码

请参见错误码。

父主题： 关系管理

相关文档