跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2025-05-09
概念：Adaptive Planning REST API

概念：Adaptive Planning REST API

基本 REST API 方法

Adaptive Planning API 具有 3 个常规区域：
  • 元数据检索和操作
  • 数据检索
  • 数据创建和更新
客户端通过向 Adaptive Planning 主 Web 服务端点发送 HTTP POST 请求来发起 API 调用。端点包含一个版本号，用于指示正在使用的 API 版本。Adaptive Planning API 的当前版本为 v40。如果您的实例使用基于非美国的区域身份验证，则您的授权 URL 和 API 端点会因区域而异。请参见 参考信息：区域身份验证 URL。
https://api.adaptiveplanning.com/api/v40
API 版本通常会随着 Adaptive Planning 产品的新发布而更新，但并非所有产品发布都会带来新的 API 版本。在后续 API 版本发布后，Workday 会为当前版本提供至少一年的支持。
有关 API 变更的历史记录，请参见 API 变更（按发行版）。
HTTP POST 请求包含 XML 文档中的发布数据。此 XML 文档包含每个 API 方法调用中存在的标准版块，以及特定于每个 API 方法调用的版块。Adaptive Planning 服务器会处理 API 方法调用，并以另一个 XML 文档的形式返回结果。与请求一样，响应 XML 文档包含每个 API 方法相同的版块，以及特定于每个 API 方法的版块。
所有数据检索均使用搜索。调用方指定用于匹配多个元素的条件，然后服务器会使用与条件匹配的元数据实体或数据列表进行响应。数据创建和更新使用的是批量上传的数据，也是通过 POST 指令提交的数据。

安全性

每次单独调用时都必须对用户进行身份验证，从而消除了入侵者劫持 Web 服务会话的可能性。
所有 API 请求都已加密，因为它们必须使用 HTTPS Web 协议。用户的身份验证凭据将作为 Web 服务请求正文的一部分传输到 Adaptive Planning。这意味着，在用户的登录编号和密码离开生成 Web 服务请求的计算机之前，Web 图层会对用户的登录编号和密码进行加密，并仅在目标服务器收到后进行解密。
在 API 请求中对用户进行身份验证时，系统不会为该用户创建持续性会话，而是会为该用户创建持续性会话。每个单独的 Web 服务调用都必须单独对其用户进行身份验证。

权限和数据访问控制

用户无需特殊权限即可访问 Web 服务。但是，发出 Web 服务请求的用户必须具有必要的权限才能执行所请求的操作。示例：用户必须具有
“导入功能”
 权限，才能调用 importStandardData Web 服务方法。
此外，对于发出请求的用户可见的数据集，Web 服务方法会限制每次调用的输出。示例：exportData Web 服务方法将返回的数据限制为在调用用户拥有的层级中找到的数据。