Jump to

• Request
• Response

Set Currency Settings

post

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

Updates the currency settings for the database.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Body ()

Currency settings.

Root Schema : CurrencySettings

Type: object

Show Source

• categoryMemberName(optional): string

  For currency databases, the accounts dimension where currency categories are defined.

• conversionType(optional): string
  Allowed Values: [ "division", "multiplication" ]
• conversionTypeMemberName(optional): string

  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.

• countryMemberName(optional): string

  For currency databases, the country dimension.

• currencyDatabase(optional): string

  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.

• partitionMemberName(optional): string
• timeMemberName(optional): string

  For currency databases, the time dimension.

{
    "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Currency settings updated successfully.

Body ()

Root Schema : schema

Type: string

500 Response

Internal Server Error.

Back to Top