メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2023-06-23
為替レート タイプ

為替レート タイプ

URL エンドポイント

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/exchangeRateTypes
バージョン: v1
カテゴリ
メタデータの変更
説明
Adaptive Planning における為替レート タイプの取得/作成/更新
呼び出すために必要な権限
通貨 (CURRENCies)
リクエストに必要なパラメータ
該当なし

サポートされている HTTP バージョン

HTTP Verb
説明
GET
システムで使用可能なすべての為替レート タイプを取得します
GET
テナントのシステムで、コードが指定された為替レート タイプを取得します
POST
システムで選択可能な為替レート タイプに基づいて、為替レート タイプを挿入/更新します。
DELETE
指定された為替レート タイプ コードに基づいて、為替レート タイプを削除します

GET

リクエスト URI
/exchangeRateTypes
:
為替レート タイプを取得します。
テナントのシステムで使用可能なすべての為替レート タイプを取得します。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateTypes/A1

POST

リクエスト
/exchangeRateTypes
:
為替レート タイプを挿入または更新します。
為替レート タイプ コードに基づいて、Planning の為替レート タイプを挿入または更新します。
  • システムにコードが存在しない場合は、為替レート タイプを挿入してください。
  • 為替レート タイプ コードがシステムにすでに存在する場合は更新されます。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateTypes

回答

204 コンテンツなし
成功した応答は空白で、ステータス コードは 204 です。
400 不良のリクエスト
リクエストをサーバーで理解できませんでした。
例 
{
    "error": "Errors occurred while processing the request",
    "errors": [
            {
                 "error": "ABCD1 is a duplicate exchange rate type code in the request body. Exchange rate type code must be unique.",
                 "code": "PLN310002"
            },
            {
                 "error": "Abcd name is a duplicate exchange rate type name in the request body. Exchange rate type name must be unique.",
                 "code": "PLN310002"
            },
           {
                 "error": "Test Name is a duplicate exchange rate type name in the request body. Exchange rate type name must be unique.",
                 "code": "PLN310002"
           }
    ]
}
401 認証されていません
ユーザーが許可されていません。
例: 
{ "message": "Invalid credential", "status": 401 }

DELETE

リクエスト
/exchangeRateType/{code}
:
為替レート タイプを削除します。
ユーザーが定義した既存の為替レート タイプを削除します。外部為替レート タイプのマッピングが存在する場合はそれも削除されます。
予約されている 2 つの為替レート タイプは削除できません。これらは "月平均" と "月末" の為替レート タイプです。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateType/Xrate