eraseData
API v24 以上でサポートされています。
カテゴリ
| データの送信 |
説明
| 組織と科目に対するオプションのフィルタを使用して、科目の指定された期間の計画または実績のデータを消去します。 |
起動に必要な権限
| データの消去 |
リクエストに応じてパラメータが必要
| 認証情報、消去オプション |
特定の時間枠で指定された科目のセットについて、計画または実績のバージョンから数値を消去します。数式 (共有数式、セルの数式、科目の数式など) は消去されません。消去プロセスの結果として空になった科目の分割を削除します。空の分割は、データ、数式、セル メモを含まない分割です。消去の結果、分割から最後のデータが削除された場合、その分割は削除されます。この API は、この API を呼び出す前に空であった場合、分割をそのまま残します。
eraseData メソッドは eraseActuals と同じ機能ですが、計画データを消去する機能も含まれ、ターゲットである特定の科目と計画の複合に対する追加制御があります。条件に一致するセル メモも削除されます。
ロック済組織を含め、Adaptive Planning 全体で実績または計画データを消去できるスーパーユーザー権限です。"データの消去" は、アクセス ルールと組織所有権の制限をオーバーライドします。データを削除できるのは、データ入力オーバーライドがある算出科目のみです。
この API は、選択された科目の時間層を検証します。
合計科目の消去
データの消去 API では、合計科目のデータは消去されません。リクエストに各アカウントを個別に含める。
組織の消去
リクエストで親組織を渡すと、eraseData API は親組織のデータのみを消去し、子組織のデータは消去しません。API リクエストには各組織を個別に含める必要があります。
リクエストのフォーマット
認識されないタグをリクエストが却下した場合。タグでは大文字と小文字を区別しないマッチングが可能です。例: <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>
指定された開始から終了までの特定の実績バージョンのすべての組織について、単一のキューブ シートから数値とセル メモを消去するには、次のようにします。
<?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>
特定の組織の特定のキューブ科目から削除するフィルタを使用した計画データの消去
この例では、計画バージョン内の計画データ
10YearBudget
キューブ科目 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>
認証情報要素
| |||
タグ名
| 認証情報 | ||
説明
| すべての API 呼び出しに単一の値を含める必要がありますcredentials 要素を使用して、API を呼び出したユーザーを識別する。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功: | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、期間名、日付形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容
| |||
(なし) | |||
eraseOptis 要素
| |||
タグ名
| eraseOptions | ||
説明
| 実績または計画データを消去する際に使用するオプションを指定します。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
actualsVersionName | なし | 実績データを消去する場合は必須です。データを消去する実績バージョンの名前を指定します。 すべての数式 (共有数式、セルの数式、科目の数式など) は消去されません。 | ActualsSubVersion2013 |
planVersionName | なし | 計画データを消去する場合は必須です。データを消去する計画バージョンの名前を指定します。 すべての数式 (共有数式、セルの数式、科目の数式など) は消去されません。 | clone2013Budget |
accountType | あり | 科目タイプが総勘定元帳 ("GL")、カスタム ("カスタム") またはキューブ シート ("CUBE") | 総勘定元帳 |
cubeSheetName | なし | 以下の場合は必須accountType="CUBE"。キューブ シートの名前を指定します。 | 売上キューブ |
開始 | あり | 期間範囲の開始期間のコードを指定します。コードは科目の時間層の期間を参照する必要があります。 キューブ シートを指定した場合、コードはキューブ シートの時間層の期間を参照する必要があります。 GL またはカスタム科目タイプを指定した場合、コードはデフォルトの時間層を参照する必要があります。
指定する期間は、科目の時間層と一致している必要があります。たとえば、科目の時間層が 1 月に開始する "四半期" の場合、2 月を開始として選択することはできません。 | 01/2013 |
終了 | あり | 期間の終了期間のコードを指定します。コードは科目の時間層の期間を参照する必要があります。 キューブ シートを指定した場合、コードはキューブ シートの時間層の期間を参照する必要があります。 GL またはカスタム科目タイプを指定した場合、コードはデフォルトの時間層を参照する必要があります。
指定する期間は、科目の時間層と一致している必要があります。たとえば、科目の時間層が "1 月" に始まる "四半期" の場合、2 月を終了として選択することはできません。 | 03/2013 |
includeCellNotes | あり | "true" に設定されている場合、eraseData は、選択されたバージョン、科目タイプ、期間 (および指定されている場合はフィルタに一致する科目組織の組み合わせ) のすべてのセル メモを消去します。セル"false" の場合、セル メモは削除されません | 真 |
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameEnabled=true は、eraseData が の表示名プロパティに従う必要があることを示します code インスタンスで "表示名の有効化" がオンの場合。displayNameEnabled=false は、インスタンスで "表示名の有効化" がオンになっている場合でも、eraseData API が v30 前の API 契約に従う必要があることを示します。eraseData API は表示名プロパティを無視します。 code 。displayNameEnabled のデフォルト値は "false" です。 | True |
エレメントの内容
| |||
(なし) | |||
フィルタ要素
| |||
タグ名
| フィルタ | ||
説明
| データを消去するときに使用する科目と組織のフィルタを指定します。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
エレメントの内容
| |||
1 つの科目要素、1 つの組織要素、または科目要素と組織要素の両方。 | |||
科目要素
| |||
タグ名
| 科目 | ||
説明
| eraseData フィルタの 1 つまたは複数の科目要素のコンテナです。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
エレメントの内容
| |||
1 つ以上の "科目" 要素 | |||
組織要素
| |||
タグ名
| 組織 | ||
説明
| eraseData フィルタの 1 つ以上の組織要素のコンテナ | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
エレメントの内容
| |||
1 つ以上の "組織" 要素 | |||
科目要素
| |||
タグ名
| Account | ||
説明
| 科目コードで指定された、データが消去される科目。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
code | あり | 消去するデータの科目の科目コードを指定します。 | WA_SUM |
エレメントの内容
| |||
(なし) | |||
組織要素
| |||
タグ名
| Level | ||
説明
| 消去される科目データの組織。組織名で指定されます。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
名前 | あり | 消去する科目データの組織名を指定します。 | 全世界営業 |
code
表示名を有効にしたインスタンスの 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>
回答エレメント
| |||
タグ名
| response | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
成功 | あり | 両方真またはfalse。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | true |
エレメントの内容
| |||
単一 (任意)メッセージ要素 | |||
メッセージ要素
| |||
タグ名
| メッセージ | ||
説明
| 1 つ以上のコンテナメッセージ要素 | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
1 つ以上メッセージ要素 | |||
メッセージ要素
| |||
タグ名
| message | ||
説明
| システムから呼び出し元に送り返されるメッセージを表します。メッセージは、リクエストが成功しない場合のエラー メッセージ、リクエストが成功した場合の警告メッセージ、成功した場合の確認メッセージに使用されます。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
キー | なし | キーを入力すると、特定のメッセージやメッセージのタイプを識別することができ、クライアント プログラムにおけるエラーの記録と復旧の自動化に役立ちます。メッセージの言語が変わってもキーはリクエストのロケールの中で変更されません。また、単語の調整や用語の変更によってキーが将来変更される可能性も低いです。 | error-invalid-timespan-start |
エレメントの内容
| |||
メッセージのテキスト。このテキストは、リクエストで指定されたロケールの言語になります (そのロケールがサポートされている場合)。テキストには、処理された行数や、エラーの原因となった特定の列や値などの可変情報を含めることもできます。 | |||