从导入API开始
在本教程中,您将了解Collibra REST Import API的基本构建模块:JSON文件格式、标识符和导入命令。新万博移动客户端您将导入属于新社区中的新域的新资产。
先决条件
- 访问Collibra新万博移动客户端数据智能云。
- 邮差或替代HTTP API客户端。
有些引用可能特定于Postman应用程序。
有关如何安装Postman和建立身份验证会话的详细信息,请参见新万博移动客户端Collibra REST API认证教程。
关于Collibra新万博移动客户端 REST导入API
导入功能允许您在Collibra数据智能云中批量创建或编辑数据。新万博移动客户端
通过导入,您可以创建和编辑团体、域、资产、映射或复杂关系及其属性、关系和标记等特征。
所有导入操作都基于一组通用规则和通用格式。
- 您必须以JSON格式提供关于导入资源的所有信息。狗万新闻c
- 您必须唯一地标识所使用的所有资源。狗万新闻c
JSON文件格式
导入API接受一个对象数组,其中每个对象代表一个要执行的命令。每个导入命令必须包含以下字段:
resourceType
:导入命令所针对的资源类型,例如社区
,域
,资产
,映射
,复杂的关系
.标识符
:资源的唯一标识符(UUID),或者是唯一标识资源的其他特征的组合id
,的名字
,externalSystemId
而且externalEntityId
.
[{"resourceType": "Community", "identifier": {"name": "数据治理委员会"}}]
的标识符
场
标识符确保导入的资源是唯一标识的。所有资源狗万新闻c都可以通过它们的Collibra UUID标识。新万博移动客户端此外,大多数资源可以通过名称或包含该资狗万新闻c源的外部系统的id和外部资源的组合来标识。
按名称标识资源时,还必须标识包含该资源的域或团体。例如,您可以通过名称标识资产,但还必须包含包含资产的域的标识符。您也可以通过名称标识域,但必须包含包含域的团体的标识符。
[{"resourceType": "Asset", "identifier": {"name": "Accuracy", "domain": {"name": "Data Quality Dimensions", "community": {"name": "Data Governance Council"}}}}]
导入命令
标识符后面的字段表示导入资源所需的结果。这些可能是资源的位置或一些资源特征。
对现有特征的处理不同于对现有资源的处理:更新现有资源,替换现有特征。狗万新闻c例如,如果导入命令包含现有资产的描述,则Collibra Data Intelligence Cloud中的描述将替换为导入命令中的描述。新万博移动客户端
下面的示例添加或替换打包的描述精度资产:
[{"resourceType": "Asset", "identifier": {"name": "Accuracy", "domain": {"name": "Data Quality Dimensions", "community": {"name": "Data Governance Council"}}}, "attributes": {"Description": [{"value": "具有正确值且以明确形式表示的数据属性。"}]}}]
有关可用字段的列表,请参见API导入命令部分的导入API文档。
导入示例
在本例中,您添加了一个新的社区、一个新的域和一个带有描述和附加概要信息的新资产。
如果一个命令依赖于前一个命令的结果,则前一个命令必须出现在依赖于它的命令之前。当使用单个文件导入团体字和属于该团体字的域时,首先应该出现导入团体字的命令。
下载全文JSON的例子或者通过组合以下命令构建自己的文件:
团体字导入命令
{"resourceType": "Community", "identifier": {"name": " db Community"}}
如果要创建一个新的团体,import命令必须包含以下字段:
的名字
域导入命令
{"resourceType": "Domain", "identifier": {"name": "物理域","community": {"name": " db community"}}, "type": {"name": "物理数据字典"}}
如果要创建一个新域,import命令必须包含以下字段:
的名字
类型
社区
资产导入命令
{"resourceType": "资产","identifier": {"name": "DB_TABLE", "domain": {"name": "物理域","community": {"name": " db community"}}}, "type": {"name": "表"},"attributes": {"Description": [{"value": " Users表"。}], "分析信息":[{"value": "分析信息不可用。"}]}}
要创建新资产,import命令必须包含以下字段:
的名字
类型
域
在本例中,您还向导入的资产添加了两个属性。
导入API REST调用
要启动导入作业,请使用帖子
方法和/进口/ json-job
的端点进口资源。
唯一需要的参数是文件
.
curl -X POST 'https:///rest/2.0/import/json-job' \ -H 'Content-Type: multipart/form-data' \ -F '(电子邮件保护)< path_to_JSON_file >”
有关可选参数的列表,请参见关于导入REST API部分的导入API文档。
响应包含有关作业的信息。
要监视导入作业的状态,请使用工作REST核心API资源:获得/工作/ {jobId}
.作业的id在导入请求响应体中作为id
字段。
总结
遵循本教程:
- 您已经了解了Collibra REST Import API的基本构建模块:新万博移动客户端
- JSON文件格式。
- 的标识符。
- 导入命令。
- 你已经使用Collibra REST新万博移动客户端导入API:
- 创建根社区。
- 创建域。
- 创建资产。
- 为资产添加属性。
额外的资源狗万新闻c
- 读了新万博移动客户端导入API文档.
- 在https://
/docs/ REST -importer/index.html上查阅随您的Collibra数据智能云版本提供的Collibra REST Import API文档。