移動先

• リクエスト
• レスポンス
• 例

通貨設定の実行

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/currencySettings

データベースの通貨設定を更新します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

本体()

通貨設定。

ルート・スキーマ : CurrencySettings

型: object

ソースの表示

• categoryMemberName: string

  通貨データベースの場合、通貨カテゴリが定義されている勘定科目ディメンション

• conversionType: string
  指定可能な値: [ "division", "multiplication" ]
• conversionTypeMemberName: string

  通貨キューブ内で様々な通貨換算シナリオを利用できるようにする、オプションの通貨タイプ・ディメンション。通常、キューブには様々なシナリオ(実績、予算、予測など)用に様々な為替レートがあります。シナリオ間でデータ換算を行うには、使用するレートのタイプを選択します。

• countryMemberName: string

  通貨データベースの場合は、国ディメンション

• currencyDatabase: string

  通貨キューブ。メイン・キューブ・アウトラインのメンバーに通貨タグを割り当てると、Essbaseで通貨キューブが自動的に生成されます。Sample_Currencyアプリケーションでは、通貨キューブはXchgrateです。

• partitionMemberName: string

  オプション。通貨パーティションとして指定されたディメンションの名前。このディメンションには、ローカル値とベース値の両方のメンバーが含まれ、ユーザーが自分の通貨に入力したデータが保持されます。ローカル・データは、通貨換算計算スクリプトを使用して基本値に変換されます。

• timeMemberName: string

  通貨データベースの場合、時間ディメンション

{
    "type":"object",
    "properties":{
        "currencyDatabase":{
            "type":"string",
            "description":"<p>The currency cube. By assigning currency tags to members in the main cube outline, you enable Essbase to generate the currency cube automatically. In the Sample_Currency application, the currency cube is Xchgrate.</p>"
        },
        "conversionType":{
            "type":"string",
            "enum":[
                "division",
                "multiplication"
            ]
        },
        "conversionTypeMemberName":{
            "type":"string",
            "description":"<p>In a currency cube, the optional currency type dimension that enables different scenarios for currency conversion. Typically, a cube has different exchange rates for different scenarios, such as actual, budget, and forecast. To convert data between scenarios, you select which type of rate to use.</p>"
        },
        "countryMemberName":{
            "type":"string",
            "description":"<p>For currency databases, the country dimension.</p>"
        },
        "timeMemberName":{
            "type":"string",
            "description":"<p>For currency databases, the time dimension.</p>"
        },
        "categoryMemberName":{
            "type":"string",
            "description":"<p>For currency databases, the accounts dimension where currency categories are defined.</p>"
        },
        "partitionMemberName":{
            "type":"string",
            "description":"<p>Optional. The name of dimension designated as the currency partition. This dimension contains members for both local and base values, and holds the data that users input in their own currencies. The local data is converted to the base data using currency conversion calculation scripts.</p>"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

通貨設定が正常に更新されました。

本体()

ルート・スキーマ : schema

型: string

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbase REST APIを使用してメイン・キューブの通貨設定を変更する方法を示します。

サンプル通貨アプリケーションと、この例で使用されているようなキューブを構築するには、

1. Essbaseファイル・カタログで、LCM_Sample_Currency.zipをギャラリからユーザー・ディレクトリまたは共有ディレクトリにコピーします。

2. 「LCMのインポート」ジョブを実行して、アプリケーションおよびキューブを構築します。Sample.Interntlはメイン・キューブで、Sample.Xchgrateは通貨キューブです。

3. メインのサンプル・キューブであるInterntlはすでに設定されており、通貨キューブ(Xchgrate)がすでに存在します。ただし、独自のメイン・キューブを設定するには、このAPIエンドポイントを使用して、必須およびオプションの通貨設定を更新します。

4. 通貨換算の設定に関する残りの要件の詳細は、通貨アプリケーションの構成とその関連するトピックを参照してください。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Currency/databases/Interntl/currencySettings -H "Accept:application/json" -H "Content-Type: application/json" --data "@./currencySettings.json" -u %User%:%Password%

入力JSON

次の例は、currencySettings.jsonに含まれるペイロードの内容を示します:

{
  "currencyDatabase" : "Xchgrate",
  "conversionType" : "division",
  "conversionTypeMemberName" : "Act xchg",
  "countryMemberName" : "Market",
  "timeMemberName" : "Year",
  "partitionMemberName" : "Scenario"
}

先頭に戻る