eraseData
在 API v24 + 中受支援。
種類
| 資料提交 |
說明
| 在指定的時段內，針對具有層級和科目的選用篩選條件的科目，清除計畫或實際值資料。 |
調用所需權限
| 清除資料 |
要求時必填參數
| 憑證、EraseOptions |
在指定的時間範圍內，針對指定的科目集，從計畫或實際值版本中清除數值。不會清除任何公式 (例如共用公式、儲存格公式、科目公式)。其會刪除因清除流程而變成空白的科目拆分。「空白拆分」是指不包含任何資料、公式或儲存格附註的拆分。如果清除導致刪除拆分中的最後一個資料，則會刪除該拆分。如果在呼叫 API 之前拆分為空白，則此 API 會將拆分保留原樣。
eraseData 方法提供與 eraseActuals 相同的功能，但也包含清除計畫資料的功能，並可額外控製做為目標的特定科目-計畫組合。系統也將刪除符合條件的儲存格附註。
是一項超級使用者權限，可用來清除 Adaptive Planning 中的實際值或計畫資料，包括鎖定的層級中。「清除資料」會覆寫存取規則和層級所有權限制。您只能從具有資料輸入覆寫功能的計算科目中刪除資料。
此 API 會驗證所選科目的時間級別。
正在清除匯總帳戶
清除資料 API 不會清除匯總帳戶的資料。在您的要求中個別包含每個科目。
正在清除層級
如果您在要求中傳遞父系層級，則 eraseData API 只會清除父系層級的資料，而不會清除子系層級的資料。您必須在 API 要求中個別包含每個層級。
要求格式
要求拒絕無法識別的標記。標記允許不區分大小寫的比對。範例︰<accounts>、<Accounts> 和 <ACCOUNTS> 可用於 Accounts 元素。
清除預設實際值版本所有層級的實際值
若要從預設實際值版本所有層級的所有總分類帳科目中，清除介於開始與結束之間的時段的數值和新空白的拆分，請執行以下操作︰
<?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" instanceCode="MYINSTANCE" locale="en_US"/> <eraseOptions actualsVersionName="Actuals" 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>
使用篩選條件清除特定層級帳戶的實際值資料
在此範例中，實際值版本中的實際值資料
ActualsSubVersion2013
自訂科目 WAT_Input_Custom
和 WAT_Test_Custom
在層級上 QA
將被刪除。<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US" /> <eraseOptions actualsVersionName="ActualsSubVersion2013" accountType="CUSTOM" start="01/2010" end="11/2010" includeCellNotes="true"> <filters> <Accounts> <Account code="WAT_Input_Custom"/> <Account code="WAT_Test_Custom"/> </Accounts> <Levels> <Level name="QA"/> </Levels> </filters> </eraseOptions> </call>
使用篩選條件清除計畫資料以從特定自訂科目刪除
在此範例中，計畫版本中的計畫資料
clone2013Budget
自訂科目 SUM_TEXT
和 LAST_NB
將被刪除。<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/> <eraseOptions planVersionName="clone2013budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true"> <filters> <Accounts> <Account code="SUM_TEXT"/> <Account code="LAST_NB"/> </Accounts> </filters> </eraseOptions> </call>
清除包含要刪除的篩選條件的計畫資料，從特定層級的特定自訂科目
在此範例中，計畫版本中的計畫資料
clone2013Budget
自訂科目 WA_SUM
和 SUM_SUM
在層級上 Development
和 Hosting
將被刪除。<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/> <eraseOptions planVersionName="clone2013Budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true"> <filters> <Accounts> <Account code="WA_SUM"/> <Account code="SUM_SUM"/> </Accounts> <Levels> <Level name="Development"/> <Level name="Hosting"/> </Levels> </filters> </eraseOptions> </call>
清除包含要刪除的篩選條件的計畫資料，從特定層級的特定 Cube 科目
在此範例中，計畫版本中的計畫資料
10YearBudget
Cube 科目 ExpenseCube.Units
在層級中 WorldWide Sales
將被刪除。<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US" /> <eraseOptions planVersionName="10YearBudget" accountType="CUBE" cubeSheetName="Expense Cube" start="01/2010" end="12/2017" includeCellNotes="true"> <filters> <Accounts> <Account code="ExpenseCube.Units" /> </Accounts> <Levels> <Level name="WorldWide Sales" /> </Levels> </filters> </eraseOptions> </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 | 否 | 若要清除實際值資料，此為必填欄位。指定要從中清除資料的實際值版本名稱。 不清除任何公式 (例如共用公式、儲存格公式、科目公式)。 | ActualsSubVersion2013 |
planVersionName | 否 | 若要清除計畫資料，則為必填。指定要清除資料的計畫版本名稱。 不清除任何公式 (例如共用公式、儲存格公式、科目公式)。 | clone2013Budget |
accountType | 是 | 指定科目分類是否為總分類帳 ("GL")、自訂 ("自訂") 或 Cube 工作表 ("CUBE")。 | 總分類帳 |
cubeSheetName | 否 | 如果符合以下條件，則為必填accountType="CUBE"指定 Cube 工作表的名稱。 | 銷售 Cube |
開始 | 是 | 指定時間範圍的開始時段代碼。代碼必須參照帳戶時間級別的時段。 如果您指定 Cube 工作表，則代碼必須參照 Cube 工作表時間級別的時段。 如果您指定總分類帳或自訂科目分類，則代碼必須參照預設時間級別。
指定的時段必須與科目的時間級別一致。例如，如果科目的時間級別為「季」，從 1 月開始，則無法選取 2 月做為開始。 | 01/2013 |
結束 | 是 | 指定時間範圍的結束時段代碼。代碼必須參照帳戶時間級別的時段。 如果您指定 Cube 工作表，則代碼必須參照 Cube 工作表時間級別的時段。 如果您指定總分類帳或自訂科目分類，則代碼必須參照預設時間級別。
指定的時段必須與科目的時間級別一致。例如，如果科目的時間級別為「季」，從 1 月開始，則您無法選取 2 月做為結束。 | 03/2013 |
includeCellNotes | 是 | 如果設為「true」，則 eraseData 會清除所選版本、科目類型和時間範圍 (以及符合篩選條件的科目層級組合，如果已指定) 中的所有儲存格附註，無論是否也會清除儲存格如果為「False」，則不會刪除任何儲存格附註 | true |
displayNameEnabled
僅在 API v30+ 中適用於啟用顯示名稱的實例。 | 否 | displayNameEnabled=true 表示 eraseData 應遵循以下項目的顯示名稱屬性 code 當實例的「啟用顯示名稱」設為「開啟」時。displayNameEnabled=false 表示即使在實例的「啟用顯示名稱」設為開啟時，eraseData API 仍應繼續遵循 v30 之前的 API 協定。eraseData API 會忽略顯示名稱屬性 code 。displayNameEnabled 的預設值為「False」。 | True |
元素內容
| |||
(無) | |||
篩選元素
| |||
標記名稱
| 篩選條件 | ||
說明
| 指定清除資料時要使用的科目和層級篩選條件。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
元素內容
| |||
一個科目元素、一個層級元素，或同時包含科目元素和層級元素。 | |||
科目元素
| |||
標記名稱
| 科目 | ||
說明
| eraseData 篩選條件的一或多個科目元素的容器。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
元素內容
| |||
一或多個科目元素 | |||
層級元素
| |||
標記名稱
| 層級 | ||
說明
| eraseData 篩選條件的一或多個層級元素的容器。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
元素內容
| |||
一或多個層級元素 | |||
科目元素
| |||
標記名稱
| Account | ||
說明
| 將從中清除資料的科目，由科目代碼指定。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
代碼 | 是 | 指定要清除的資料科目的科目代碼。 | WA_SUM |
元素內容
| |||
(無) | |||
層級元素
| |||
標記名稱
| 層級 | ||
說明
| 要清除的科目資料所屬層級，由層級名稱指定。 | ||
元素的屬性
| |||
屬性內容名稱
| EOI？
| 值
| 範例
|
名稱 | 是 | 指定要清除的科目資料的層級名稱。 | 全球銷售 |
代碼
僅在 API v30+ 中適用於啟用顯示名稱的實例。 | 否 | 層級的代碼。
當為實例開啟「啟用顯示名稱」時，此為必填欄位。 | 全球銷售 |
元素內容
| |||
(無) | |||
回覆格式
<?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 |
元素內容
| |||
訊息的文字。此文字使用要求中指定地區設定的語言 (假設支援地區設定)。文字也可能包含變數資訊，例如已處理的列數，或導致錯誤的特定欄或值。 | |||