recalculateSheet
在 API v16 及更高版本中受支持
种类
| 数据提交 |
描述
| 使用“按需重新计算”属性重新计算工作表。 |
调用所需的权限
| 工作表编辑权限 |
请求时需要的参数
| 凭据 |
此方法的请求包含凭据标记，用于识别调用方用户并为其授权。用户必须具有“工作表编辑权限”权限才能重新计算。
申请格式
<?xml version='1.0' encoding='UTF-8'?> <call method="recalculateSheet" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password"/> <version name="Default Structure"/> <sheet name="Expense Cube"/> <level name="Corporate Plan"/> </call>
- version 元素 - 如果未指定 version，则会引发错误。
- sheet 元素 - 如果未指定工作表元素，则系统会在给定版本的最高层级重新计算所有具有“按需重新计算”选项的工作表。在这种情况下，层级将被忽略。
- 层级元素
- 如果未指定层级，则系统会在给定版本的最高层级重新计算工作表。
- 如果用户无权访问指定的层级，则会引发错误。
- 系统会针对给定版本上的层级及其后代，重新计算工作表。
凭据元素
| |||
标记名称
| 凭据 | ||
描述
| 所有 API 调用都必须包含一个 凭据元素，用于识别调用 API 的用户。然后，系统会以此用户身份执行 API 调用（系统中的任何审核线索或操作历史记录都将显示此用户执行了该操作），因此，用户必须具有执行该操作所需的权限，才能执行 API 调用。成功。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
登录 | 是 | 调用 API 方法的用户的登录名。此用户必须具有所需的权限才能调用该方法。 | sampleuser@company.com |
密码 | 是 | 调用 API 方法的用户的密码。 | my_password |
区域设置 | 否 | 指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、时段名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。 | fr_FR |
instanceCode | 否 | 如果凭据中指定的用户有权访问多个实例， Adaptive Planning ，此属性可用于指定用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。 | MYINSTANCE1 |
元素的内容
| |||
（无） | |||
版本元素
| |||
标记名称
| 版本 | ||
描述
| 指示应使用哪个版本来接收所请求的数据。必须为每次调用提供版本。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
名称 | 否 | 版本的名称。 | 默认结构 |
编号 | 否 | 版本的编号。仅当名称不存在时，才会考虑编号。 | 4 |
元素的内容
| |||
（无） | |||
工作表元素
| |||
标记名称
| 工作表 | ||
描述
| 按名称或编号定义的工作表 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
名称 | 否 | 工作表的名称 | 费用多维 |
编号 | 否 | 工作表的编号。仅当名称不存在时，才会考虑编号。 | 1 |
元素的内容
| |||
（无） | |||
层级元素
| |||
标记名称
| level | ||
描述
| 按名称或编号定义的层级 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
名称 | 否 | 层级的名称 | 公司计划 |
编号 | 否 | 层级的编号。仅当名称不存在时，才会考虑层级。 | 1 |
元素的内容
| |||
（无） | |||
回复格式
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> </response>
回复元素
| |||
标记名称
| 回复 | ||
描述
| 按名称或编号定义的层级 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
成功 | 是 | “true”或“false”，指明 API 调用是否成功。即使成功调用，响应中也可能包含警告消息。 | 是 |
元素的内容
| |||
单个可选的 messages 元素。 | |||
messages 元素
| |||
标记名称
| 消息 | ||
描述
| 一个或多个容器 消息元素 | ||
元素的属性
| |||
（无） | |||
元素的内容
| |||
一个或多个 消息元素。 | |||
消息元素
| |||
标记名称
| 消息 | ||
描述
| 表示从系统发回给调用方的消息。消息用于在请求未成功时显示错误消息，在请求成功时显示警告消息，在成功时显示确认消息。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
键 | 否 | 指定密钥后，密钥可用于识别特定消息或消息类型，可用于在客户端程序中自动记录错误并进行恢复。在不同的请求区域设置下，即使消息的语言发生变化，键也不会发生变化。关键字在将来也不太可能因措辞调整或术语变更而发生变化。 | invalid-attributevalueid |
元素的内容
| |||
| |||