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 要素 - バージョンが指定されていない場合、エラーが発生します。
- シート要素 - シート要素が指定されていない場合、"要求に応じて再計算" オプションを持つすべてのシートは、指定されたバージョンの最上位レベルで再計算されます。この場合、組織は無視されます。
- 組織要素
- 組織が指定されていない場合、シートは指定されたバージョンの最上位組織で再計算されます。
- ユーザーが指定された組織へのアクセス権を持っていない場合、エラーが発生します。
- 組織とその子孫について、シートが特定のバージョンで再計算されます。
認証情報要素
| |||
タグ名
| 認証情報 | ||
説明
| すべての API 呼び出しに単一の値を含める必要があります credentials 要素を使用して、API を呼び出したユーザーを識別する。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功: | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、期間名、日付形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容
| |||
(なし) | |||
バージョン要素
| |||
タグ名
| バージョン | ||
説明
| リクエストされたデータの受信に使用するバージョンを示します。呼び出しごとにバージョンを指定する必要があります。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
名前 | なし | バージョンの名前。 | デフォルト構造 |
ID | なし | バージョンの IDID は、名前が存在しない場合にのみ考慮されます。 | 4 |
エレメントの内容
| |||
(なし) | |||
シート要素
| |||
タグ名
| シート | ||
説明
| 名前または ID によってシートが定義されました | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
名前 | なし | シートの名前 | 経費キューブ |
ID | なし | シートの IDID は、名前が存在しない場合にのみ考慮されます。 | 1 |
エレメントの内容
| |||
(なし) | |||
組織要素
| |||
タグ名
| level | ||
説明
| 名前または ID により定義された組織 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
名前 | なし | 組織の名前 | 法人プラン |
ID | なし | 組織の ID。組織は名前が存在しない場合にのみ考慮されます。 | 1 |
エレメントの内容
| |||
(なし) | |||
回答フォーマット
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> </response>
回答エレメント
| |||
タグ名
| response | ||
説明
| 名前または ID により定義された組織 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
成功 | あり | "true" または "false"。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | true |
エレメントの内容
| |||
単一のオプション メッセージ要素 | |||
メッセージ要素
| |||
タグ名
| メッセージ | ||
説明
| 1 つ以上のコンテナ メッセージ要素 | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
1 つ以上 メッセージ要素 | |||
メッセージ要素
| |||
タグ名
| message | ||
説明
| システムから呼び出し元に送り返されるメッセージを表します。メッセージは、リクエストが成功しない場合のエラー メッセージ、リクエストが成功した場合の警告メッセージ、成功した場合の確認メッセージに使用されます。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
キー | なし | キーを入力すると、特定のメッセージやメッセージのタイプを識別することができ、クライアント プログラムにおけるエラーの記録と復旧の自動化に役立ちます。メッセージの言語が変わってもキーはリクエストのロケールの中で変更されません。また、単語の調整や用語の変更によってキーが将来変更される可能性も低いです。 | invalid-attributevalueid |
エレメントの内容
| |||
| |||