REST API 概述

REST API 使用 HTTP 向客户机和 Web 浏览器公开 Java™ API 函数的子集。 通过使用 REST 资源,您可以为支持 HTTP 调用的任何操作系统和语言开发应用程序。

REST 资源公开可用于按类名,全局唯一标识 (GUID) 或使用模型查询语言 (MQL) 查询来查询模型对象的 TADDM 函数。 您还可以创建,删除和更新模型对象,以及管理 TADDM 发现过程。 所有这些函数都使用标准 HTTP 接口,并支持 JSON 或 XML 格式的输入和输出数据。

REST 服务器组件安装在 TADDM 服务器上 $COLLATION_HOME/deploy-tomcat 目录 (TADDM 7.3.0) 或 $COLLATION_HOME/apps(TADDM 7.3.0.1 及更高版本)中,且会在 TADDM 服务器启动时自动启动。 REST 服务可通过使用 TADDM 管理 Web 界面使用的相同 TCP/IP 端口来获取。 (对于 HTTP,缺省端口是 9430;对于 HTTPS,缺省端口是 9431。)

REST API 使用 HTTP 基本认证来使用 MIME Base64 编码传输用户标识和密码。 由于每个请求都是无状态的,因此对 REST API 的每个调用都必须包含 HTTP 授权头。 对于安全连接,请使用 HTTPS 连接。

REST 调用的参数是使用标准查询字符串表示法指定的:
http://resource_url?parameter=value&parameter=value...

如果指定的参数值无效,那么 TADDM 服务器将忽略该值并使用缺省值 (如果可以确定)。 (例如,如果指定 fetchSize=-2,那么服务器将使用 fetchSize 值 1。) 如果无法确定缺省值,那么请求将失败。