移動先

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

計算設定の取得

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/calculation

指定されたデータベースの計算設定を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

計算の設定を正常に取得しました。

本体()

ルート・スキーマ : calculation

型: object

ソースの表示

• aggregateMissingValues: boolean

  trueの場合は、通常のキューブ統合に伴い#MISSING値を集約します。デフォルトはfalseです(不足値は集約されない)。

• createBlocksOnEquations: boolean

  定数割当計算式でデータ・ブロックを強制的に作成します(疎ディメンションの場合のみ有効)。trueの場合は、ブロックが作成されます。

• twoPassCalculation: boolean

  完全計算の実行時に2パス計算が強制適用されます(2パス計算が有効になっている場合はtrue)

{
    "type":"object",
    "properties":{
        "aggregateMissingValues":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, aggregate #MISSING values along with the regular cube consolidation. The default is false (missing values are not aggregated).</p>"
        },
        "createBlocksOnEquations":{
            "type":"boolean",
            "description":"<p>Force creation of data blocks on constant assignment calc equations (only valid for sparse dimensions). If true, blocks are created.</p>"
        },
        "twoPassCalculation":{
            "type":"boolean",
            "description":"<p>Force two pass calculation when running a full calculation (<b>true</b> if two pass calculation is enabled)</p>"
        }
    },
    "xml":{
        "name":"calculation"
    }
}

400 レスポンス

不正なリクエスト

計算設定の取得に失敗しました。アプリケーション名またはデータベース名が正しくない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、キューブの計算設定を取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/calculation" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "calculation": {
    "aggregateMissingValues": false,
    "createBlocksOnEquations": false,
    "twoPassCalculation": false
  }
}

先頭に戻る