使用Collibra REST A新万博移动客户端PI创建数据
在本教程中,您将使用Collibra REST API在Collibra数据智能云中创建一个社区、一个域、一些资产和定义。新万博移动客户端
curl -X POST \ https:///rest/2.0/communities \ -H 'Content-Type: application/json' \ -d '{"name": "Finance", "description": "组织中管理资金的部分。"} '
首先登录并创建一个根社区。您可以在社区中创建一个域,并添加资产和该资产的定义。然后学习执行批量操作,创建多个子社区和域。
我们的目标是在你的Collibra数据智能云中拥有如下所示的结构:新万博移动客户端
先决条件
- 进入Collibra新万博移动客户端。
- 邮差或替代HTTP API客户端。
有些引用可能特定于Postman应用程序。
有关如何安装Postman和建立身份验证会话的详细信息,请参见新万博移动客户端Collibra REST API认证教程。
API文档
API引用是Collibra平台环境的一部分。新万博移动客户端您需要登录才能访问它们。
要访问API文档:
用户访问 | API文档 |
---|---|
Sysadmin角色 | 在任何Collibra页面的右上角,单击新万博移动客户端并选择API文档. |
所有角色 | 在浏览器中,访问https:// |
进行身份验证
要验证用户的身份,请使用身份验证资源。
文章https:// < your_dgc_environment_url > / rest / 2.0 /认证/会话
你必须提供用户名和密码在JSON主体中。
{"username": "…","password": "…"}
有关身份验证的详细信息,请参见新万博移动客户端Collibra RSET API认证教程。
创建一个社区
在本节中,将创建一个名为金融给它一个有意义的描述。一个没有父社区的根社区。
curl -X POST \ https:///rest/2.0/communities \ -H 'Content-Type: application/json' \ -d '{"name": "Finance", "description": "组织中管理资金的部分。"} '
要创建社区,请使用帖子
方法和/社区
的端点社区资源。
帖子https:// < your_dgc_environment_url > / rest / 2.0 /社区
要成功创建根社区,必须在JSON正文中提供社区名。对您创建的Collibra数据智能云资源进行有意义的描述不是强制性的,但这是一个很好的实践。狗万新闻c新万博移动客户端
创建根团体的参数如下:
参数 | 强制性的 | 类型 | 描述 |
---|---|---|---|
描述 | 没有 | 字符串 | 描述社区。 |
的名字 | 是的 | 字符串 | 设置团体的名称。必须是唯一的。 |
响应包含关于新创建的团体的信息,包括通用唯一标识符(UUID),您将在接下来的步骤中使用它来标识金融社区。
创建域
域是资产的逻辑分组。它们属于社区,具有不同的域类型。在本节中,您将创建一个术语表域命名金融Gloassary,属于金融社区。
curl -X POST \ https:///rest/2.0/domains \ -H 'Content-Type: application/json' \ -d '{"name": "Finance Glossary", "description": "A collection of Finance related assets.", "communityId": " ", "typeId": "0000000 -0000-0000-0000-000000010001"}'
要创建域,请使用帖子
方法和/域
的端点域资源。
帖子https:// < your_dgc_environment_url > / rest / 2.0 /域
要成功创建域,必须提供域名、域类型ID和所属团体ID。
为金融术语表域时,使用创建后收到的团体ID金融社区和00000000-0000-0000-0000-000000010001随着类型id.类的打包UUID术语表域类型。
用于创建域的参数包括:
参数 | 强制性的 | 类型 | 描述 |
---|---|---|---|
communityId | 是的 | UUID | 设置域所属的团体。社区必须存在。 |
描述 | 没有 | 字符串 | 描述域。 |
的名字 | 是的 | 字符串 | 设置域的名称。在同一社区内必须是唯一的。 |
类型id | 是的 | UUID | 设置域类型。 |
响应包含关于新创建的域的信息,包括通用唯一标识符(UUID),您将在接下来的步骤中使用它来标识金融术语表域。
创建资产
现在已经创建了术语表,可以开始向其中添加资产了。类中添加业务术语金融术语表域。
curl -X POST \ https:///rest/2.0/assets \ -H 'Content-Type: application/json' \ -d '{"name": "Customer Lifetime Value", "typeId": "0000000 -0000-0000-0000-000000011001", "domainId": " "}'
要创建资产,使用帖子
方法和/资产
的端点资产资源。
帖子https:// < your_dgc_environment_url > / rest / 2.0 /资产
要成功创建资产,必须提供资产名称、资产类型ID和资产所属的域ID。
为客户终身价值属性后,使用您在创建金融术语表域和00000000-0000-0000-0000-000000011001随着类型id.类的打包UUID业务术语资产类型。
用于创建资产的参数有:
参数 | 强制性的 | 类型 | 描述 |
---|---|---|---|
domainId | 是的 | UUID | 设置资产所属的域。域必须已经存在。 |
的名字 | 是的 | 字符串 | 设置资产的名称。在同一域中必须唯一。 |
类型id | 是的 | UUID | 设置资产类型。 |
响应包含关于新创建的资产的信息,包括通用唯一标识符(UUID),您将在接下来的步骤中使用它来标识客户终身价值资产。
创建定义
资产的定义只是其属性之一。属性中添加定义客户终身价值资产。
curl -X POST \ https:///rest/2.0/attributes \ -H 'Content-Type: application/json' \ -d '{"assetId": " ", "typeId": "0000000 -0000-0000-0000-000000000202", "value": "客户关系的货币价值。"} '
要创建定义,请使用帖子
方法和/属性
的端点属性资源。
帖子https:// < your_dgc_environment_url > / rest / 2.0 /属性
要成功创建定义,必须提供定义、属性类型ID和定义对应的资产ID。
为客户终身价值定义时,使用您在创建客户终身价值资产和00000000-0000-0000-0000-000000000202随着类型id.类的打包UUID定义属性类型。
用于创建定义的参数有:
参数 | 强制性的 | 类型 | 描述 |
---|---|---|---|
assetyId | 是的 | UUID | 标识属性所属的资产。资产必须已经存在。 |
类型id | 是的 | UUID | 设置属性类型。 |
价值 | 是的 | 对象 | 设置属性的值。定义的预期类型是字符串。 |
响应包含关于新创建的定义的信息。
创建多个资源狗万新闻c
若要使用单个调用创建多个资源,请使用狗万新闻c帖子
方法和/散装
需要创建的资源的端点。在JSON数组中提供所需的参数。
让我们通过创建一系列子社区和几个域来将缺少的部分添加到Finance社区中。
要创建会计,应付账款,应收账款,预测而且工资子社区时,您必须提供它们的名称和父社区的ID。属性后收到的响应可以确定父社区的ID金融社区。
curl -X POST \ https:///rest/2.0/communities/bulk \ -H 'Content-Type: application/json' \ -d '[{"name": "会计","parentId": "<金融社群_id>"}, {"name": "应付账款","parentId": "<金融社群_id>"}, {"name": "应收账款","parentId": "<金融社群_id>"}, {"name": "预测","parentId": "<金融社群_id>"}, {"name": "工资单","parentId": "<金融社群_id>"}]'
响应包含关于新创建的社区的信息,包括每个社区的通用唯一标识符(universal Unique Identifier, UUID)。
要创建会计政策而且预测政策域,您必须提供它们的名称,域所属的团体id和域类型id。使用创建子社区和之后收到的社区id00000000-0000-0000-0000-000000030013随着类型id.类的打包UUID政策域类型。
curl -X POST \ https:///rest/2.0/domains/bulk \ -H 'Content-Type: application/json' \ -d '[{"name": "Accounting Policies", "typeId": "00000000-0000-0000-0000-000000030013", "communityId": " "}, {"name": "Forecasting Policies", "typeId": "00000000-0000-0000-0000-000000030013", "communityId": " "}]'
响应包含关于新创建的域的信息。
响应代码
创建资源时常见的响应代码有:狗万新闻c
代码 | 意义 |
---|---|
201 | 已完成资源的创建。 |
400 | 坏的请求。响应体包含有关错误的详细信息。 |
401 | 当前用户没有进行认证。 |
总结
通过本教程,你已经使用Collibra REST API:新万博移动客户端
- 创建一个有意义的描述的根社区。
- 在根社区中添加子社区。
- 在社区中创建域。
- 向域添加资产。
- 向资产添加定义。
- 从API调用的响应中获取新创建的Collibra资源的UUI新万博移动客户端D。狗万新闻c
下一个步骤
下一个教程将通过一个示例指导您如何从Collibra数据智能云检索数据,并通过Collibra REST API添加资产。新万博移动客户端
额外的资源狗万新闻c
- 参考您的Collibra数据智能云版本提供的REST API文档。新万博移动客户端
- 阅读Collibr新万博移动客户端a管理指南API文档.