开始使用进口API

在本教程中,您将了解的基本构建块Collibra REST API:进口JSON文件格式标识符和导入命令。新万博移动客户端你导入一个新的资产,属于一个新的领域的新社区。

先决条件

  • 访问Collibra新万博移动客户端数据智能云。
  • 邮递员或另一个HTTP客户机API。

    参考可能是特定于应用程序的邮差。

为更多的信息关于如何安装邮差和建立一个身份验证会话,看到新万博移动客户端Collibra REST API认证教程。

关于Collibra新万博移动客户端 REST API导入

导入功能允许您创建或编辑数据批量Collibra数据智能云。新万博移动客户端

通过导入,您可以创建和编辑社区领域,资产,或复杂的映射关系及其特征等属性、关系和标签。

所有进口操作是基于一组通用的规则和一个共同的格式。

  • 您必须提供所有关于进口资源以JSON格式的信息。狗万新闻c
  • 你必须惟一地标识的所有资源。狗万新闻c

JSON文件格式

导入API接受一个对象数组,其中每个对象代表一个命令被执行。每个导入命令必须包含以下字段:

  • resourceType:资源导入命令的类型,例如社区,域,资产,映射,复杂的关系。
  • 标识符:全局惟一标识符(UUID)的资源或其他特征的组合唯一地标识的资源,例如id,的名字,externalSystemId和externalEntityId。
[{“resourceType”:“社区”,“标识符”:{“名称”:“数据治理委员会”}})

的标识符场

标识符确保进口资源是唯一标识。所有的资狗万新闻c源都可以被他们的Collibra UUID。新万博移动客户端此外,大多数可以通过名称或标识的资源组狗万新闻c合的IDs包含资源和外部资源的外部系统。

当你确定资源的名字,你也必须包含资源标识域或社区。例如,您可以确定资产的名字但你还必须包含资产包括域的标识符。你也可以识别域的名字但你必须包括社区包含域的标识符。

[{“resourceType”:“资产”,“标识符”:{“名称”:“准确性”,“域”:{“名称”:“数据质量维”、“社区”:{“名称”:“数据治理委员会”}}}})

导入命令

接下来的字段标识符代表期望的结果导入的资源。这些可能的位置资源或资源的特点。

现有的处理特点不同于现有的资源:更新现有资源而取代现有的特征。狗万新闻c例如,如果import命令包含一个描述现有的资产,描述在Collibra数据智能云被替换为一个从导入命令。新万博移动客户端

下面的示例添加或替换包装的描述精度资产:

[{“resourceType”:“资产”,“标识符”:{“名称”:“准确性”,“域”:{“名称”:“数据质量维”、“社区”:{“名称”:“数据治理委员会”}}},“属性”:{“描述”:[{“价值”:“一个属性数据正确的值,以明确的形式表示。”}] } } ]

可用字段的列表,请参阅API导入命令部分进口API文档。

导入示例

在本例中,您添加一个新的社区,一个新的领域和新的资产描述和额外的分析信息。

如果一个命令依赖于前一个命令的结果,前面的命令之前出现在输入数据的命令取决于它。当您使用一个单独的文件中导入一个社区和属于一个域,该命令导入社区应该先出现。

下载完整的JSON的例子或建立自己的文件通过以下命令:

社区导入命令

{“resourceType”:“社区”,“标识符”:{“名称”:“DBs社区”}}

创建一个新的社区,import命令必须有以下字段:

  • 的名字

域导入命令

{“resourceType”:“域”,“标识符”:{“名称”:“物理域”、“社区”:{“名称”:“DBs社区”}},“类型”:{“名称”:“物理数据字典”}}

创建一个新的域,import命令必须有以下字段:

  • 的名字
  • 类型
  • 社区

资产导入命令

{“resourceType”:“资产”,“标识符”:{“名称”:“DB_TABLE”,“域”:{“名称”:“物理域”、“社区”:{“名称”:“DBs社区”}}},“类型”:{“名称”:“表”},“属性”:{“描述”:[{“价值”:“用户表。”} ], "Profiling Information": [ { "value": "Profiling information not available." } ] } }

创建一个新的资产,import命令必须有以下字段:

  • 的名字
  • 类型
  • 域

在这个例子中,您还将两个属性添加到导入资产。

导入其他API调用

开始导入工作,使用帖子方法和/进口/ json-job端点的进口资源。

唯一所需的参数文件。

curl - x发布的https:// < your_dgc_environment_url > / rest / 2.0 /导入/ json-job \ - h”内容类型:多部分/格式“\ - f”(电子邮件保护)< path_to_JSON_file >”

一个可选的参数列表,请参阅关于进口REST API部分进口API文档。

响应包含有关工作的信息。

你可以看到的结果导入工作活动页面或在控制台日志。

监控的状态导入工作,使用工作资源的核心API:获得/工作/ {jobId}。工作的id导入请求响应返回的身体的id字段。

总结

遵循本教程:

  • 您已经了解了Collibra REST API:导入的基本构建块新万博移动客户端
    • JSON文件格式。
    • 的标识符。
    • 导入命令。
  • 你用Collibra REST AP新万博移动客户端I导入:
    • 创建一个根社区。
    • 创建一个域。
    • 创建一个资产。
    • 添加属性的资产。

额外的资源狗万新闻c

  • 读了新万博移动客户端Collibra进口API文档。
  • 咨询提供的Collibr新万博移动客户端a REST API文档导入您的版本的Collibra数据智能云在https:// < your_collibra_platform_url > / docs / rest-importer / index . html。