eraseActuals
カテゴリ
| データの送信 |
説明
| 実績バージョンの指定された期間と科目の数値データを消去します。 |
起動に必要な権限
| データの消去 |
リクエストに応じてパラメータが必要
| 認証情報、消去オプション |
この方法は、特定の時間枠における指定された科目のセットのすべての組織について、実績バージョンから数値を消去します。数式 (共有数式、セルの数式、科目の数式など) は消去されません。実績の消去プロセスの結果として空になった科目の分割が削除されます。空の分割とは、データ、数式、セル メモを含まない分割のことです。実績を消去することにより、分割から最後のデータが削除される場合、その分割は削除されます。この 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>
指定された開始から終了までの特定の実績バージョンのすべての組織について、単一のキューブ シートから数値とセル メモを消去するには、次のようにします。
<?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>
認証情報要素
| |||
タグ名
| 認証情報 | ||
説明
| すべての 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 | なし | 実績バージョンが複数ある場合は必須です。このインスタンスにプランニング製品のみが含まれている場合は、次のようになります。"実績の消去" を実行すると、その唯一の実績バージョンからデータが消去されます。 | 実績 |
accountType | あり | 科目タイプが総勘定元帳 ("GL")、カスタム ("カスタム") またはキューブ シート ("CUBE") | 総勘定元帳 |
cubeSheetName | なし | 以下の場合は必須accountType="CUBE"。キューブ シートの名前を指定します。 | 売上キューブ |
開始 | あり | 実績の時間範囲の開始期間のコードを指定します。コードは科目の時間層の期間を参照する必要があります。 キューブ シートを指定した場合、コードはキューブ シートの時間層の期間を参照する必要があります。 GL またはカスタム科目タイプを指定した場合、コードはデフォルトの時間層を参照する必要があります。
API v15+ では、指定する期間が科目の時間層と一致している必要があります。たとえば、科目の時間層が 1 月に開始する "四半期" の場合、2 月を開始として選択することはできません。 | 01/2013 |
終了 | あり | 実績の期間の終了期間のコードを指定します。コードは科目の時間層の期間を参照する必要があります。 キューブ シートを指定した場合、コードはキューブ シートの時間層の期間を参照する必要があります。 GL またはカスタム科目タイプを指定した場合、コードはデフォルトの時間層を参照する必要があります。
API v15+ では、指定する期間が科目の時間層と一致している必要があります。たとえば、科目の時間層が "1 月" に始まる "四半期" の場合、2 月を終了として選択することはできません。 | 03/2013 |
includeCellNotes | あり | "に設定した場合true" の場合"実績の消去" は、セルのデータを消去するかどうかに関係なく、選択したバージョン、科目タイプ、期間内のすべてのセル メモを消去します。条件 "false に設定されている場合、セル メモは削除されません。 | 真 |
エレメントの内容
| |||
(なし) | |||
回答フォーマット
<?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 |
エレメントの内容
| |||
メッセージのテキスト。このテキストは、リクエストで指定されたロケールの言語になります (そのロケールがサポートされている場合)。テキストには、処理された行数や、エラーの原因となった特定の列や値などの可変情報を含めることもできます。 | |||