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，則會引發錯誤。
- 工作表元素 - 如果未指定工作表元素，則會在指定版本的最上層重新計算所有具有「隨需重新計算」選項的工作表。在這種情況下，會忽略層級。
- 層級元素
- 如果未指定層級，則會在指定版本的最上層重新計算工作表。
- 如果使用者無權存取指定的層級，則會引發錯誤。
- 系統會針對指定版本上的層級及其後代重新計算工作表。
credentials 元素
| |||
標記名稱
| 憑證 | ||
說明
| 所有 API 呼叫都必須包含單一 credentials 元素，以識別調用 API 的使用者。然後會以此使用者的身分執行 API 呼叫 (系統中的任何稽核軌跡或動作記錄都會顯示此使用者執行了動作)，因此使用者必須具有執行動作所需的權限，才能讓 API 呼叫針對成功。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
登入 | 是 | 調用 API 方法的使用者的登入名稱。此使用者必須具有必要的權限，才能調用該方法。 | sampleuser@company.com |
密碼 | 是 | 調用 API 方法的使用者的密碼。 | my_password |
地區設定 | 否 | 指定用來解釋傳入數字和日期，以及傳出數字和日期格式的地區設定 (使用正確的千分位分隔符號、時段名稱和日期格式)。地區設定也可用來指定回應中任何系統訊息的顯示語言。如果未指定，則會使用 en_US (美式英語)。 | fr_FR |
instanceCode | 否 | 如果憑證中指定的使用者有權存取的多個實例 Adaptive Planning ，此屬性內容可用於指定使用者要存取其預設實例以外的實例。如果未指定，則會使用使用者的預設實例。若要確定可用的實例代碼，請使用 exportInstances API。 | MYINSTANCE1 |
元素內容
| |||
(無) | |||
版本元素
| |||
標記名稱
| 版本 | ||
說明
| 指出應使用哪個版本來接收要求的資料。必須為每個呼叫提供版本。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
名稱 | 否 | 版本的名稱。 | 預設結構 |
ID | 否 | 版本的 ID。只有在 name 不存在時才會考慮 ID。 | 4 |
元素內容
| |||
(無) | |||
工作表元素
| |||
標記名稱
| 工作表 | ||
說明
| 依名稱或 ID 定義的工作表 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
名稱 | 否 | 工作表的名稱 | 費用 Cube |
ID | 否 | 工作表的 ID。只有在 name 不存在時才會考慮 ID。 | 1 |
元素內容
| |||
(無) | |||
層級元素
| |||
標記名稱
| 層級 | ||
說明
| 由名稱或 ID 定義的層級 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
名稱 | 否 | 層級的名稱 | 公司計畫 |
ID | 否 | 層級的 ID。只有在名稱不存在時才會考慮層級。 | 1 |
元素內容
| |||
(無) | |||
回覆格式
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> </response>
回應元素
| |||
標記名稱
| 回應 | ||
說明
| 由名稱或 ID 定義的層級 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
成功 | 是 | 「true」或「false」，表示 API 呼叫是否成功。即使是成功的呼叫，其回應中也可能包含警告訊息。 | True |
元素內容
| |||
單一選填的訊息元素。 | |||
訊息元素
| |||
標記名稱
| 訊息 | ||
說明
| 一或多個容器 訊息元素 | ||
元素的屬性
| |||
(無) | |||
元素內容
| |||
一項或多項 訊息元素 | |||
訊息元素
| |||
標記名稱
| 訊息 | ||
說明
| 表示系統正在將訊息傳回呼叫者。「訊息」用於顯示要求未成功時的錯誤訊息、要求成功時的警告訊息，以及成功時的確認訊息。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
索引鍵 | 否 | 指定時，金鑰是識別特定訊息或訊息類型的一種方式，可用於用戶端程式中的自動化錯誤記錄和復原。即使訊息的語言變更，關鍵字在要求的不同地區設定下也不會變更。未來也不太可能因為措辭調整或術語變更而變更索引鍵。 | invalid-attributevalueid |
元素內容
| |||
| |||