移動先

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

アプリケーションの一般設定の取得

get

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

指定されたアプリケーションの一般設定を返します。expandパラメータを使用するとその他の設定を取得できます。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

問合せパラメータ

• expand: string

  一般設定のみを表示するには(これがデフォルト)、noneを使用します。使用可能なその他のオプションとしては、startup、securityおよびallがあります。

  デフォルト値: none

  指定可能な値: [ "none", "startup", "security", "all" ]

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

一般アプリケーション設定が正常に返されました。拡張設定を取得するためのリンク、および設定を編集するためのリンクが含まれています。

本体()

ルート・スキーマ : settings

型: object

ソースの表示

• general: object general

  起動、データ・ロックの有効期限、EAS管理対象アプリケーション、LROファイルの最大サイズに関するオプションなどの、一般的なアプリケーション設定。

• links: array links
• security: object security

  アプリケーションのセキュリティ設定。

• startup: object startup

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

{
    "type":"object",
    "properties":{
        "general":{
            "$ref":"#/definitions/AppGeneralSettings"
        },
        "startup":{
            "$ref":"#/definitions/AppStartupSettings"
        },
        "security":{
            "$ref":"#/definitions/AppSecuritySettings"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"settings"
    }
}

ネストされたスキーマ : general

型: object

起動、データ・ロックの有効期限、EAS管理対象アプリケーション、LROファイルの最大サイズに関するオプションなどの、一般的なアプリケーション設定。

ソースの表示

• description: string

  アプリケーションの説明。

• easManagedApp: boolean

  trueの場合、アプリケーションはEssbase Webインタフェースではなく、Essbase Administration Services (EAS) Liteで管理されます。EAS Liteでアプリケーションに接続する前に、そのアプリケーションをEAS管理対象アプリケーションとして設定する必要があります。Essbase Webインタフェースは、現時点のすべてのプラットフォーム機能をサポートする最新の管理インタフェースですが、EAS Liteは、Essbase 21c独立デプロイメントにのみ使用可能な制限付きオプションの代替物として使用できます。

• logLevelAsString: string

  ログ・レベル。INFO、WARN、ERROR、FATALまたはDEBUG。

• maxAttachmentFileSizeInKbs: integer(int64)

  リンク・レポート・オブジェクト(LRO)の添付ファイルの最大ファイル・サイズ。デフォルトはありません。システム・リソースの制限を除いて、最小値または最大値はありません。

• pendingCacheSizeLimitInMbs: integer(int64)

  集約ストレージ・キャッシュの増加可能な最大サイズ。集約ストレージ・キャッシュは、この制限に達するまで動的に増加します。この設定は、アプリケーションを再起動した後に有効になります。ASODEFAULTCACHESIZE構成プロパティが使用されている場合、この設定は無視されます。

• timeoutOnDataBlockLocks: integer(int64)

  データ・ブロックのロックをSmart View (または他のグリッド・クライアント)ユーザーが保持できる最大の時間間隔。クライアントのデータ・ブロック・ロックがタイムアウト間隔よりも長く保持された場合、Essbaseはロックを解除し、トランザクションがロールバックされます。デフォルトの間隔は60分です。この設定は、アプリケーション内のすべてのデータベースに影響します。

{
    "type":"object",
    "description":"<p>General application settings, including options for startup, expiration of locks on data, EAS-managed applications, and maximum LRO file sizes.</p>",
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>Description of the application.</p>"
        },
        "logLevelAsString":{
            "type":"string",
            "description":"<p>Log level. INFO, WARN, ERROR, FATAL, or DEBUG.</p>"
        },
        "easManagedApp":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. Before you can connect to an application in EAS Lite, you must set it as an EAS managed application. The Essbase web interface is the modern administration interface that supports all current platform features, but EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.</p>"
        },
        "timeoutOnDataBlockLocks":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Maximum time interval that locks on data blocks can be held by Smart View (or other grid client) users. When a client data-block lock is held for more than the time out interval, Essbase removes the lock and the transaction is rolled back. The default interval is 60 minutes. This setting affects all databases in the application.</p>"
        },
        "maxAttachmentFileSizeInKbs":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Maximum file size for Linked Reporting Object(LRO) attachments. There is no default. There is no minimum or maximum value, excepting limitations imposed by your system resources.</p>"
        },
        "pendingCacheSizeLimitInMbs":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Maximum size to which the aggregate storage cache may grow. The aggregate storage cache grows dynamically until it reaches this limit. This setting takes effect after you restart the application. This setting is ignored if ASODEFAULTCACHESIZE configuration property is in use.</p>"
        }
    },
    "xml":{
        "name":"general"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : security

型: object

アプリケーションのセキュリティ設定。

ソースの表示

• allowCommands: boolean

  trueの場合、十分な権限を持つすべてのユーザーが、アプリケーションのデータベース(キューブ)にリクエストを実行できます。デフォルトでは、コマンドは使用可能になっています。falseに設定した場合、管理者を含むいずれのユーザーのリクエストも許可されません。falseの設定は、発行者のセッションの間のみ有効です。false設定は即時有効になり、現在ログインしているユーザーと、発行者のセッション中に後からログインするユーザーに影響します。

• allowConnects: boolean

  trueの場合、十分な権限を持つすべてのユーザーが、アプリケーションのデータベース(キューブ)に接続できます。デフォルトでは、接続は有効になっています。falseの場合、アプリケーション・マネージャより低い権限を持つユーザーは、キューブを起動することも、キューブの起動が必要な接続を実行することもできません。

• allowUpdates: boolean

  trueの場合、十分な権限を持つすべてのユーザーが、アプリケーションのデータベース(キューブ)にリクエストを実行できます。デフォルトでは、更新は有効になっています。falseに設定した場合、更新は、発行者のセッションの間継続して禁止されます。

{
    "type":"object",
    "description":"<p>Application security settings.</p>",
    "properties":{
        "allowCommands":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users with sufficient permissions can make requests to the database (cube) in the application. By default, commands are enabled. If set to <b>false</b>, no requests are permitted by any user including administrators. The <b>false</b> setting remains in effect only for the duration of the issuer's session. The <b>false</b> setting takes effect immediately, and affects users who are currently logged in, as well as users who log in later during the issuer's session.</p>"
        },
        "allowConnects":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users with sufficient permissions can make connections to the database (cube) in the application. By default, connections are enabled. If <b>false</b>, no user with a permission lower than Application Manager can start the cube nor make connections that require the cube to be started.</p>"
        },
        "allowUpdates":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users with sufficient permissions can make requests to the databases (cube) in the application. By default, updates are enabled. If set to <b>false</b>, updates are not permitted, lasting for the duration of the issuer's session.</p>"
        }
    },
    "xml":{
        "name":"security"
    }
}

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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?expand=all&links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "general" : {
    "description" : "Application description",
    "logLevelAsString" : "INFO",
    "timeoutOnDataBlockLocks" : 60,
    "maxAttachmentFileSizeInKbs" : 0,
    "pendingCacheSizeLimitInMbs" : 0,
    "easManagedApp" : true
  },
  "startup" : {
    "allowUsersToStartApplication" : true,
    "startApplicationWhenServerStarts" : true
  },
  "security" : {
    "allowCommands" : true,
    "allowConnects" : true,
    "allowUpdates" : true
  }
}

先頭に戻る