开始使用Collibra REST AP新万博移动客户端I
在本教程中,您将学习REST标准的基础知识、Collibra提供的不同REST应用程序、在哪里可以找到通用文档以及如何使用它。新万博移动客户端您还可以对Collibra数据智能云执行GET调用,以检索有关新万博移动客户端环境的版本信息:
得到https:// < your_dgc_environment_url > /休息/ 2.0 /应用程序/信息
关于REST API
REST api是遵循允许您与数据交互的标准的web服务。
具象化状态传输(REpresentational State Transfer, REST)是一种软件架构风格,它定义了主要由web服务使用的约束。利用大多数CRUD HTTP方法(GET、POST、PUT、DELETE等等),每个API端点的特征是:
- 无状态:不存储上下文,每个客户端需要提供所有必要的信息来服务请求。
- 可缓存:客户端中介可以缓存响应。
- 统一接口:所有响应都以JSON格式提供。
当工作流和Java API在Collibra数据智能云中运行时,REST API从外部服务与Col新万博移动客户端libra环境交互。有很多用例,从数据可视化到移动客户端集成。
可以对大部分Collibra资源执行如下操作:狗万新闻c新万博移动客户端
操作 | 资源 | |
---|---|---|
资产 | ||
添加 | 域 | |
改变 | 社区 | |
找到 | 关系 | |
得到 | 属性 | |
删除 | 评论 | |
集 | 用户 | |
开始(工作流) | 角色 | |
权限 |
所有操作必须在连接的用户有权限的情况下才能执行。
- 可能会添加新的API特性来提供新的功能。
- 现有API特性可能会被弃用。它们仍然有效,但在下一个主要版本中可能不受支持。
Coll新万博移动客户端ibra REST API应用程序
Collibra数据智能云有三个REST应用程序,Collibra控制台有一个:新万博移动客户端
API | 描述 |
---|---|
REST核心API | 创建与Collibra的集成,创建自己的UI或构建自己的应用程序。新万博移动客户端 |
REST导入API | 将大量数据加载到Collibra中,并区分创建和更新数据。新万博移动客户端 |
REST目录API | 将信息摄取到数据目录中,包括本机不支持的源。 |
管理控制台API | 管理备份,配置和Collibra控制台环境。新万博移动客户端 |
API文档
API引用是Collibra平台环境的一部分。新万博移动客户端您需要登录才能访问它们。
要访问API文档:
用户访问 | API文档 |
---|---|
Sysadmin角色 | 在任何Collibra页面的右上角,单击新万博移动客户端并选择API文档. |
所有角色 | 在浏览器中,访问https:// |
控制台 | 在浏览器中,访问http:// |
我们使用Swagger UI来呈现Collibra REST AP新万博移动客户端I文档。登陆页面显示了应用程序包含的所有资源的列表:狗万新闻c
每个资源都可以展开以查看可用的方法和端点。您可以展开每个端点以查看详细信息:
使用嵌入式文档允许您:
- 参考适用于您的Collibra产品版本的文档。新万博移动客户端
- 直接尝试API。
- 获取要执行的CURL请求。
API文档数据是真实的,您在这里执行的任何操作都将反映在Collibra中。新万博移动客户端
REST调用url
REST调用url有三部分:
描述 | 例子 |
---|---|
实例基URL。 | https:// < your_dgc_environment_url > |
REST应用程序路径。 | /休息/ 2.0 |
终点路径。 | /应用程序/信息 |
完整的URL示例。 | https:// < your_dgc_environment_url > /休息/ 2.0 /应用程序/信息 |
应用程序路径特定于API和应用程序。
应用程序 | API |
其他路径 |
---|---|---|
新万博移动客户端Collibra数据智能云 | 核心API | /休息/ 2.0 |
进口API | /休息/ 2.0 | |
目录的API | / /目录/ 1.0 | |
搜索API | /休息/ 2.0 | |
新万博移动客户端Collibra控制台 | 控制台API | /休息 |
进行GET调用
最基本的Collibra API GET调用新万博移动客户端之一是/应用程序/信息
.由于API的目的是在应用程序之外工作,因此应用程序资源允许您检查Collibra数据智能云是否启动并运行,并获得有关版本的详细新万博移动客户端信息。
检索版本信息不需要经过身份验证,因为方法是GET,所以可以通过在浏览器中键入URL进行调用。
得到https:// < your_dgc_environment_url > /休息/ 2.0 /应用程序/信息
你看JSON在浏览器窗口中的响应:
{"baseUrl":"", "version":{"major":5, "minor":6, "fullVersion":"5.6.2-17"}, "buildNumber":"20190322181533"}
下一个步骤
绝大多数Collibra API操作都需要新万博移动客户端身份验证,所以下一个教程将向您展示如何进行身份验证使用REST API新万博移动客户端登录Collibra数据智能云.
额外的资源狗万新闻c
- 参考您的Collibra数据智能云版本提供的REST API文档。新万博移动客户端
- 阅读Collibr新万博移动客户端a管理指南API文档.