移動先

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

アプリケーションの起動設定の取得

get

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

指定されたアプリケーションの起動設定を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

起動の設定を正常に取得しました。

本体()

ルート・スキーマ : startup

型: object

アプリケーションの起動設定。

ソースの表示

• allowUsersToStartApplication: boolean

  trueの場合、少なくとも読取り権限を持つすべてのユーザーがアプリケーションをロード(起動)できます。スタートアップはデフォルトで使用可能になっています。

• startApplicationWhenServerStarts: boolean

  trueの場合、Essbaseサーバーの起動時に、自動的にアプリケーションが起動します。デフォルトでは、自動スタートアップは使用不可になっています。

{
    "type":"object",
    "description":"<p>Application startup settings.</p>",
    "properties":{
        "allowUsersToStartApplication":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users who have at least read permission can load (start) the application. Startup is enabled by default.</p>"
        },
        "startApplicationWhenServerStarts":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the application starts automatically when Essbase Server starts. By default, autostartup is disabled.</p>"
        }
    },
    "xml":{
        "name":"startup"
    }
}

400 レスポンス

不正なリクエスト

起動設定の取得に失敗しました。アプリケーション名が正しくない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseアプリケーションの起動関連設定を取得する方法を示します。

この例では、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/settings/startup?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "startup" : {
    "allowUsersToStartApplication" : true,
    "startApplicationWhenServerStarts" : true
  }
}

先頭に戻る