移動先

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

起動設定の取得

get

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

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

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

起動の設定が正常に返されました。

本体()

ルート・スキーマ : startup

型: object

ソースの表示

• allowUsersToStartDatabase: boolean

  ユーザーにキューブの直接起動、またはキューブ起動が必要なリクエストの結果としての起動を可能または不可能にします。デフォルトはtrueです。

• startDatabaseWhenApplicationStarts: boolean

  アプリケーションの起動時にキューブを自動的に起動します。デフォルトはtrueです。allowUsersToStartDatabaseもtrueの場合のみ適用できます。

{
    "type":"object",
    "properties":{
        "allowUsersToStartDatabase":{
            "type":"boolean",
            "description":"<p>Enable or disable users from starting the cube, either directly, or as a result of requests requiring the cube to be started. The default is <b>true</b>.</p>"
        },
        "startDatabaseWhenApplicationStarts":{
            "type":"boolean",
            "description":"<p>Automatically start the cube when the application starts. The default is <b>true</b>. Applicable only when allowUsersToStartDatabase is also <b>true</b>.</p>"
        }
    },
    "xml":{
        "name":"startup"
    }
}

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/startup" -H "accept: application/json"-u %User%:%Password%

レスポンス本体の例

{
  "startup": {
    "allowUsersToStartDatabase": true,
    "startDatabaseWhenApplicationStarts": true
  }
}

先頭に戻る