开始使用搜索API

在本教程中你执行你的第一个查询Collibra搜索API。新万博移动客户端使用通配符来扩大你的搜索和过滤器来完善它。

curl - x发布的https:// < your_c新万博移动客户端ollibra_platform_url > / rest / 2.0 /搜索' \ - h的application / json内容类型:\ - d '{“关键词”:“问题”}’

本教程中的示例使用的所有包装Collibra平台的安装过程中创建的资源。狗万新闻c新万博移动客户端

先决条件

  • 访问Collibra新万博移动客户端数据治理中心。
  • 邮递员或另一个HTTP客户机API。

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

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

关于Collibra新万博移动客户端搜索API

搜索API允许您利用相同的引擎,Collibra数据治理中心用户界面搜索。新万博移动客户端它使用相同的通配符UI搜索和搜索结果的影响是相同的搜索索引配置设置控制台。

的UI搜索附加通配符*设置只适用于UI搜索,如果设置(默认),与不同的结果可能导致相同的搜索Collibra数据治理中心和搜索API。新万博移动客户端

的搜索请求

的搜索请求是一个JSON对象。最简单的请求包含唯一强制性字段表示搜索词:

{“关键词”:“搜索词”}

通配符

扩大你的搜索,你可以使用相同的通配符搜索的用户界面。

通配符

使用

搜索的例子

结果示例
吗? 替换一个字符。 国际空间站? e 问题
* 替换没有一个或多个字符。 惠* 完整性、合规
~

进行模糊搜索。

你必须把通配符搜索词。

 应用程序~ 应用程序,重复
!或- - - - - -

不包括包含搜索词的结果。

之前你必须把通配符搜索词。

 业务!或业务之事 业务分析师社区但不是新业务术语
+

不包括结果不包含搜索词。

之前你必须把通配符搜索词。

 业务+新 新业务术语和新的应用程序但不是业务分析师社区
& &

不包括结果不包含所有搜索词。

你必须把之间的通配符搜索条件。

 新的& &数据 新的参考数据和新数据资产
”“

执行一个精确的搜索。

你必须摆脱双引号:\”

 \ \“政策问题” 数据政策问题
”“~n 执行一个精确的搜索没有或n单词之间的搜索词。 \ \“政策问题”~ 2 数据政策问题和政策不合规问题 
curl - x发布的https:// < your_c新万博移动客户端ollibra_platform_url > / rest / 2.0 /搜索' \ - h的application / json内容类型:\ - d '{“关键词”:\“\”政策问题"}

过滤器

你可以缩小你的搜索结果显示什么样的资源返回或者寻找资源的搜索词。

过滤器

字段名

描述
搜索过滤器 过滤器 一个过滤器来改进搜索结果基于特定类型、状态、日期和标签返回的资源。狗万新闻c
搜索领域 searchInFields 一个过滤器来改进搜索结果的基础上出现的搜索词在特定领域的资源类型。

你可以同时使用这两种类型的过滤器。

搜索过滤器

搜索筛选器是一个对象数组组成场和值对。

curl - x发布的https:// < your_c新万博移动客户端ollibra_platform_url > / rest / 2.0 /搜索' \ - h的application / json内容类型:\ - d '{“关键词”:“数据”,“过滤器”:[{”字段”:“assetType”、“价值观”:[“00000000-0000-0000-0000-000000031112”]}]}”

你可以把每个场有一定价值值价值观:

场

值作为字符串的数组

结果
社区 一个或多个社区的uuid 只有资源属狗万新闻c于所选社区,不包括社区。
域 一个或多个域uuid 只属于所选狗万新闻c领域的资源,包括域和社区。
domainType 一个或多个域类型uuid 只有选择域的域类型。
assetType 一个或多个资产类型uuid 只有资产的选择的资产类型。
状态 一个或多个状态uuid 只有资产选择的状态。
createdBy 一个或多个用户uuid 只有选中的狗万新闻c用户创建的资源。
lastModifiedOn 具体以下值之一:LAST_24H,LAST_7D,LAST_30D,LAST_365D,OLDER_THAN_365D 只有资源,狗万新闻c最后修改选定的时段。
createdOn 只有选定的狗万新闻c时段中创建资源。
标签 一个或多个标签 只有资产选择的标签。

的场/值对使用的逻辑连接和操作符,除非相同的关键是重复和它们一起使用或操作符。的元素值数组使用逻辑连接或操作符。

一些组合将不返回结果,因为过滤器指不同类型的资源,例如的组合狗万新闻cdomainType和标签返回0的结果因为域没有标签。

搜索领域

搜索领域的过滤器是一个对象数组组成resourceType和字段对。

curl - x发布的https:// < your_c新万博移动客户端ollibra_platform_url > / rest / 2.0 /搜索' \ - h的application / json内容类型:\ - d '{“关键词”:“数据”,“searchInFields”: [{“resourceType”:“域”,“字段”:["名称"]}]}”

你可以把每个resourceType有一定价值字段价值观:

resourceType

字段作为字符串的数组

结果
社区 可能的值是的名字和评论 只有社区搜索词的名称或评论。
域 只有域搜索词的名称或评论。
资产 可能的值是的名字,displayName,评论,标签,dataClassification,属性和属性:< attribute_type_UUID > 只有资产选择的字段的搜索词。属性是指所有资产的属性类型而对属性:< attribute_type_UUID >只指一个特定的属性类型。
用户 的名字 只有用户的搜索词的名字。
userGroup 只有用户组名称的搜索词。

的resourceType/字段对使用的逻辑连接或操作符。为请求是有效的,如果其中一个字段其他双值是可用的,它必须出现在所有的对。

相当于的名字为资产是displayName。

例子

有效的

原因

 
“searchInFields”: [{“resourceType”:“域”,“字段”:[“名称”、“评论”]},{“resourceType”:“用户”,“字段”:["名称"]}]
 是的 唯一的共同字段值对的名字和两个对包含它。 
“searchInFields”: [{“resourceType”:“域”,“字段”:[“名称”、“评论”]},{“resourceType”:“资产”、“字段”:["名称"]}]
 没有

相当于的名字为资产是displayName。

评论也可用于资产但没有指定。

正确的一对应该是:

{“resourceType”:“资产”,“字段”:[“displayName”、“评论”]}

的元素字段数组使用逻辑连接或操作符。

REST调用搜索API

执行搜索,使用帖子方法和/搜索端点的搜索资源。

没有参数,但是你必须包含JSON的身体。

curl - x发布的https:// < your_c新万博移动客户端ollibra_platform_url > / rest / 2.0 /搜索' \ - h的application / json内容类型:\ - d '{“关键词”:“问题”,“searchInFields”: [{“resourceType”:“域”,“字段”:["名称"]}]}”

响应包含结果的总数,每个结果的细节。

总结

遵循本教程:

  • 你有学过Collibra休息搜索API的以下组件:新万博移动客户端
    • JSON对象。
    • 通配符。
    • 搜索过滤器。
    • 搜索领域的过滤器。
    • API调用。

额外的资源狗万新闻c

  • 咨询提供的Collibr新万博移动客户端a REST API文档导入您的版本Collibra数据治理中心https:// < your_collibra_platform_url > / docs / rest-search / index . html。