从搜索API开始

在本教程中，您将使用Collibra REST Search API执行第一个查询。新万博移动客户端您可以使用通配符来扩展搜索，并使用过滤器来优化搜索。

curl -X POST 'https:///rest/2.0/search' \ -H 'Content-Type: application/json' \ -d '{"keywords": "issue"}'

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

先决条件

  • 访问Collibra新万博移动客户端数据治理中心。
  • 邮差或替代HTTP API客户端。

    有些引用可能特定于Postman应用程序。

有关如何安装Postman和建立身份验证会话的详细信息，请参见新万博移动客户端Collibra REST API认证教程。

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

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

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

搜索请求

搜索请求是一个JSON对象。最简单的请求只包含表示搜索词的必填字段:

{"关键词":"搜索词"}

通配符

要扩展搜索，可以使用用户界面搜索中提供的相同通配符。

通配符

使用

搜索的例子

结果示例
? 恰好替换一个字符。 国际空间站?e 问题
＊ 替换一个或多个字符。 惠* 完整性、合规
～

执行模糊搜索。

必须将通配符放在搜索词之后。

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

排除包含搜索词的结果。

必须将通配符放在搜索词之前。

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

排除不包含搜索词的结果。

必须将通配符放在搜索词之前。

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

排除不包含所有搜索词的结果。

必须在搜索词之间放置通配符。

 新的&&数据 新参考数据而且新数据资产
”“

执行精确搜索。

你必须转义双引号:\”

 \ \“政策问题” 数据政策问题
”“~n 使用no或up to执行精确搜索n搜索词之间的单词。 \ \“政策问题”~ 2 数据政策问题而且政策不合规问题 
curl -X POST 'https:///rest/2.0/search' \ -H 'Content-Type: application/json' \ -d '{"keywords": "\"policy issue\""}

过滤器

您可以通过指示要返回的资源类型或在资源中查找搜索词的位置来缩小搜索结果的范围。

过滤器

字段名

描述
搜索过滤器 过滤器 根据返回资源的特定类型、状态、日期和标签来细化搜索结果的过滤器。狗万新闻c
在字段中搜索 searchInFields 一个过滤器，用于根据搜索词在资源类型的特定字段中的出现情况来细化搜索结果。

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

搜索过滤器

搜索筛选器是由场而且值对。

curl -X POST 'https:///rest/2.0/search' \ -H 'Content-Type: application/json' \ -d '{"keywords": "data"， "filters": [{"field": "assetType"， "values": ["0000000 -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 POST 'https:///rest/2.0/search' \ -H 'Content-Type: application/json' \ -d '{"keywords": "data"， "searchInFields": [{"resourceType": "domain"， "fields": ["name"]}]}'

你可以把它们结合起来resourceType具有一定价值字段价值观:

resourceType

字段作为字符串数组

结果
社区 可能的值为的名字而且评论 只有名称或评论中有搜索词的社区。
域 只有名称或评论中有搜索词的域名。
资产 可能的值为的名字，displayName，评论，标签，dataClassification，属性而且属性:< attribute_type_UUID > 仅选择在所选字段中具有搜索项的资产。属性引用资产的所有属性类型属性:< attribute_type_UUID >只引用一种特定的属性类型。
用户 的名字 只有名称中有搜索词的用户。
userGroup 只有名称中包含搜索词的用户组。

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

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

例子

有效的

原因

 
“searchInFields”:[{“resourceType”:“域”,“字段”:[“名称”、“评论”]},{“resourceType”:“用户”,“字段”:["名称"]}]
 是的 唯一常见的字段值为的名字两对都含有它。 
"searchInFields": [{"resourceType": "domain"， "fields": ["name"， "comments"]}， {"resourceType": "asset"， "fields": ["name"]}]
 没有

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

评论也可用于资产但没有具体说明。

正确的配对应该是:

{"resourceType": "asset"， "fields": ["displayName"， "comments"]}

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

Search API REST调用

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

没有参数，但必须包含JSON主体。

curl -X POST 'https:///rest/2.0/search' \ -H 'Content-Type: application/json' \ -d '{"keywords": "issue"， "searchInFields": [{"resourceType": "domain"， "fields": ["name"]}]}'

响应包含结果的总数和每个结果的详细信息。

总结

遵循本教程:

  • 您已经了解了Collibra REST搜索API的以下组件:新万博移动客户端
    • JSON对象。
    • 通配符。
    • 搜索过滤器。
    • 字段中的搜索过滤器。
    • API调用。

额外的资源狗万新闻c

  • 在https:///docs/ REST -search/index.html上查阅随您的Collibra数据治理中心版本提供的Collibra REST Import API文档。