eraseActuals

種類	資料提交
說明	清除實際值版本的指定時段和科目中的數值資料。
調用所需權限	清除資料
要求時必填參數	憑證、EraseOptions

此方法會在指定時間範圍內，針對指定科目集的所有層級，清除實際值版本中的數值。不會清除任何公式 (例如共用公式、儲存格公式、科目公式)。系統會刪除因清除實際值流程而變成空白的科目拆分。「空白拆分」是指不包含任何資料、公式或儲存格附註的拆分。如果清除實際值導致刪除拆分中的最後一個資料，則會刪除該拆分。如果在呼叫 API 之前拆分為空白，此 API 將保持原狀。

要求格式

若要從預設實際值版本所有層級的所有總分類帳科目中，清除介於開始與結束之間的時段的數值和新空白的拆分，請執行以下操作︰


 <?xml version='1.0' encoding='UTF-8'?>
<call method="eraseActuals" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <eraseOptions
     accountType="GL"
     start="01/2013"     
     end="03/2013"
     includeCellNotes="false" />
</call>

若要針對特定實際值版本的所有層級，從單一 Cube 工作表在指定的開始與結束之間清除數值和儲存格附註︰


 <?xml version='1.0' encoding='UTF-8'?>
<call method="eraseActuals" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <eraseOptions
     actualsVersionName="Actuals"
     accountType="CUBE"
     cubeSheetName="Sales Cube"
     start="01/2013"         
     end="03/2013"
     includeCellNotes="true" />
</call>

credentials 元素
標記名稱		憑證
說明		所有 API 呼叫都必須包含單一credentials 元素，以識別調用 API 的使用者。然後會以此使用者的身分執行 API 呼叫 (系統中的任何稽核軌跡或動作記錄都會顯示此使用者執行了動作)，因此使用者必須具有執行動作所需的權限，才能讓 API 呼叫針對成功。
元素的屬性
屬性內容名稱	EOI？	值	範例
登入	是	調用 API 方法的使用者的登入名稱。此使用者必須具有必要的權限，才能調用該方法。	sampleuser@company.com
密碼	是	調用 API 方法的使用者的密碼。	my_password
地區設定	否	指定用來解釋傳入數字和日期，以及傳出數字和日期格式的地區設定 (使用正確的千分位分隔符號、時段名稱和日期格式)。地區設定也可用來指定回應中任何系統訊息的顯示語言。如果未指定，則會使用 en_US (美式英語)。	fr_FR
instanceCode	否	如果憑證中指定的使用者有權存取的多個實例 Adaptive Planning ，此屬性內容可用於指定使用者要存取其預設實例以外的實例。如果未指定，則會使用使用者的預設實例。若要確定可用的實例代碼，請使用 exportInstances API。	MYINSTANCE1
元素內容
(無)

eraseOptions 元素
標記名稱		eraseOptions
說明		指定清除實際值時要使用的選項。
元素的屬性
屬性內容名稱	EOI？	值	範例
actualsVersionName	否	如果有多個實際值版本，則為必填。如果此實例僅包含 Planning 產品，則EraseActuals 將從唯一的實際值版本中清除資料。	實際值
accountType	是	指定科目分類是否為總分類帳 ("GL")、自訂 ("自訂") 或 Cube 工作表 ("CUBE")。	總分類帳
cubeSheetName	否	如果符合以下條件，則為必填accountType="CUBE"指定 Cube 工作表的名稱。	銷售 Cube
開始	是	指定實際值時間範圍的開始時段代碼。代碼必須參照帳戶時間級別的時段。如果您指定 Cube 工作表，則代碼必須參照 Cube 工作表時間級別的時段。如果您指定總分類帳或自訂科目分類，則代碼必須參照預設時間級別。對於 API v15+，指定的時段必須與科目的時間級別一致。例如，如果科目的時間級別為「季」，從 1 月開始，則無法選取 2 月做為開始。	01/2013
結束	是	指定實際值時間範圍的結束時段代碼。代碼必須參照帳戶時間級別的時段。如果您指定 Cube 工作表，則代碼必須參照 Cube 工作表時間級別的時段。如果您指定總分類帳或自訂科目分類，則代碼必須參照預設時間級別。對於 API v15+，指定的時段必須與科目的時間級別一致。例如，如果科目的時間級別為「季」，從 1 月開始，則您無法選取 2 月做為結束。	03/2013
includeCellNotes	是	如果設為「true"，則EraseActuals 會清除所選版本、科目分類和時間範圍內的所有儲存格附註，無論其是否也會清除儲存格中的資料。如果「false"，則不會刪除任何儲存格附註。	true
元素內容
(無)

回覆格式


 <?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <messages>
     <message key="erase-actuals-success">Successfully erased actuals data.</message>
     <message key="erase-actuals-facts-deleted">4 facts deleted.</message>
     <message key="erase-actuals-notes-deleted">2 notes deleted.</message>
     <message key="erase-actuals-splits-deleted">1 splits deleted.</message>
   </messages>
</response>

回應元素
標記名稱		回應
元素的屬性
屬性內容名稱	EOI？	值	範例
成功	是	兩者之一True 或false，表示 API 呼叫是否成功。即使是成功的呼叫，其回應中也可能包含警告訊息。	True
元素內容
單項選填messages 元素

訊息元素
標記名稱		訊息
說明		一或多個容器訊息元素
元素的屬性
(無)
元素內容
一項或多項訊息元素

訊息元素
標記名稱		訊息
說明		表示系統正在將訊息傳回呼叫者。「訊息」用於顯示要求未成功時的錯誤訊息、要求成功時的警告訊息，以及成功時的確認訊息。
元素的屬性
屬性內容名稱	EOI？	值	範例
索引鍵	否	指定時，金鑰是識別特定訊息或訊息類型的一種方式，可用於用戶端程式中的自動化錯誤記錄和復原。即使訊息的語言變更，關鍵字在要求的不同地區設定下也不會變更。未來也不太可能因為措辭調整或術語變更而變更索引鍵。	警告-invalid-timespan-start
元素內容
訊息的文字。此文字使用要求中指定地區設定的語言 (假設支援地區設定)。文字也可能包含變數資訊，例如已處理的列數，或導致錯誤的特定欄或值。