exportActiveCurrencies
この API はユーザーのみをサポートします 概念: アクセス ルール API v22 以上
カテゴリ
| Metadata retrieval |
説明
| システムで設定されているすべての通貨の完全なリストのメタデータを返します。 |
起動に必要な権限
| なし (インスタンスに対して有効な認証情報である必要があります) |
リクエストに応じてパラメータが必要
| 認証情報 |
このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはシステムで設定されたすべての通貨の完全なセットを示す XML ドキュメントを返します。為替レートがまだ設定されていない場合でも、通貨は通貨の管理で通貨リストに追加されると「設定」されます。"複数通貨" 機能が有効になっていないインスタンスは、このリストで単一の通貨のみを返します。
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="exportActiveCurrencies" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
認証情報要素
| |||
タグ名
| 認証情報 | ||
説明
| すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功: | ||
要素の特性
| |||
特性名
| 必須 ？ | 値
| 例
|
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容
| |||
(なし) | |||
回答フォーマット
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <currencies seqNo="42"> <currency id="2" code="EUR" precision="4" isReportingCurrency="0" userDefined="0" description="Euro Member Countries, Euro" /> <currency id="3" code="EUR1" precision="4" isReportingCurrency="0" userDefined="1" description="User-defined Euro 1" /> <currency id="1" code="USD" precision="2" isReportingCurrency="1" userDefined="0" description="United States of America, Dollars" /> </currencies> </output> </response>
回答エレメント
| |||
タグ名
| response | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
成功 | あり | 真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | 真 |
廃止 | なし | レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。 | false |
エレメントの内容
| |||
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。 | |||
出力要素
| |
タグ名
| 出力 |
要素の特性
| |
(なし) | |
エレメントの内容
| |
必須の単一の通貨要素この 出力 ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。 | |
通貨要素
| |||
タグ名
| 通貨 | ||
説明
| 1 つまたは複数の通貨要素のコンテナです。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
連番 API v17 で追加されましたが、将来の使用のために予約されています。 | |||
エレメントの内容
| |||
1 つ以上の通貨要素 | |||
通貨要素
| |||
タグ名
| 通貨 | ||
説明
| exportActiveCurrencies API コールへの応答で返される単一通貨を表します。API v17 より前のバージョンの場合、"ユーザー定義" 特性またはユーザー定義通貨は表示されません。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
ID | あり | 通貨の内部システム ID 番号。この番号は通貨を一意に識別するために使用できますが、他の API コールでは使用されません。 | 1 |
code | あり | ISO 4217 基準で指定された 3 文字の通貨コード。 | usd |
小数部桁数 | あり | この通貨で金額を表示するときに使用される一般的な小数部桁数 (小数点以下の桁数) です。この小数部桁数は、表示タイプが "通貨" で、小数部桁数が "通貨の小数部桁数を使用" に設定されている科目にのみ使用されます。 | 2 |
isReportingCurrency | あり | 通貨が「レポートの任意の換算」で使用できるように管理者によって選択されているかどうか。True = 1、False = 0。 | 1 |
userDefined API v17 以上で使用可能 | あり | 通貨がユーザーによって作成されたかどうかTrue = 1、False = 0。 | 0 |
説明 | あり | 通貨の国と通貨の名称で構成される、通貨の基本的な説明。 | アメリカ合衆国、ドル |
エレメントの内容
| |||
(なし) | |||