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

添加实体

功能介绍

添加实体。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例的ID。

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

entities

是

Array of 表3 objects

实体请求列表，最大个数不超过200个。
表3 MetadataEntityRequest

参数

是否必选

参数类型

描述

package_id

是

String

模型包ID。

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

entity_name

是

String

实体名称。

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

entity_type

是

String

实体类型。

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

subtype

否

String

实体子类型。

最大长度：50

entity_attributes

否

Array of 表5 objects

实体属性。

signatures

否

Array of 表4 objects

特征。
表4 MetadataSignature

参数

是否必选

参数类型

描述

signature_type

是

String

特征类型。

signature_name

否

String

特征名称。

signature_attributes

否

Array of 表5 objects

特征属性。
表5 MetadataAttributeRequest

参数

是否必选

参数类型

描述

attribute_id

否

String

属性ID。

最大长度：200

attribute_value

否

String

属性值。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

success

Array of 表7 objects

操作成功列表。

failure

Array of 表8 objects

操作失败列表。
表7 MetadataEntitySimpleRespone

参数

参数类型

描述

entity_urn

String

实体urn。

entity_name

String

实体名称。

entity_type

String

实体类别。
表8 MetadataEntityFailureResp

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

entity_name

String

实体名称。

entity_type

String

实体类别。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/entities
{
    "entities": [
        {
            "package_id": "Metamodel3",
            "entity_name": "q8",
            "entity_type": "Metamodel3-SubjectArea",
            "entity_attributes": [
                {
                    "attribute_id": "Metamodel3-SubjectArea-NAME",
                    "attribute_value": ""
                },
                {
                    "attribute_id": "Metamodel3-SubjectArea-PermissionCode",
                    "attribute_value": ""
                },
                {
                    "attribute_id": "Metamodel3-SubjectArea-OrderNumber",
                    "attribute_value": ""
                },
                {
                    "attribute_id": "entity_name",
                    "attribute_value": "q8"
                }
            ],
            "signatures": [
                {
                    "signature_name": "",
                    "signature_type": "Metamodel3-descriptionInfo",
                    "signature_attributes": [
                        {
                            "attribute_id": "Metamodel3-descriptionInfo-NAME",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-descriptionInfo-description",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-descriptionInfo-nameEn",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-descriptionInfo-nameCn",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber",
                            "attribute_value": ""
                        }
                    ]
                },
                {
                    "signature_name": "",
                    "signature_type": "Metamodel3-maintenanceInfo",
                    "signature_attributes": [
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-NAME",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-createdBy",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-createTime",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-updatedBy",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-updateTime",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount",
                            "attribute_value": ""
                        },
                        {
                            "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount",
                            "attribute_value": ""
                        }
                    ]
                }
            ]
        }
    ]
}

响应示例

状态码： 200

successful operation

{
    "msg": null,
    "success": [
        {
            "entity_type": "Metamodel3-SubjectArea",
            "entity_urn": "urn:abm:Metamodel3-SubjectArea:b2570da68c011fbf7bf8e784e9cd2c",
            "entity_name": "q8"
        }
    ],
    "failure": []
}

状态码

状态码

描述

200

successful operation.

400

Bad Request.

500

Internal Server Error.

错误码

请参见错误码。

父主题： 实体管理

相关文档