アプリケーションのリスト
get
/essbase/rest/v1/applications
Essbaseアプリケーションのリストを返します。 接続の接続名およびアプリケーション名はオプションのパラメータです。
アプリケーション名のない接続名のみを指定した場合、このAPIはその名前付き接続を使用してすべてのアプリケーションをフェッチします。
接続名とアプリケーション名を指定した場合、このAPIは指定された接続を使用して指定されたアプリケーションをフェッチします。
必須フィールドのみを返すには、fields
パラメータを使用します。
制限: 応答でアプリケーション・ステータスが必要な場合、限度は<= 100です。< p>=>
要求
問合せパラメータ
- applicationNameForConnection(optional): string
接続用のアプリケーション名。
- connectionName(optional): string
接続名。
- fields(optional): string
レスポンス・フィールドに返されるフィールドのカンマ区切りリスト。 省略すると、すべてのフィールドが返されます。
- filter(optional): string
デフォルト値:
*
- limit(optional): integer(int32)
返されるアプリケーションの最大数。 デフォルトは50です。
デフォルト値:50
- offset(optional): integer(int32)
結果セットの先頭から除外するアプリケーションの数。 デフォルト値は0です。
デフォルト値:0
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200 レスポンス
OK
アプリケーション・リストが正常に返されました。
ネストされたスキーマ : アプリケーション
タイプ:
Show Source
object
- connectedUsersCount(optional): integer(int32)
- creationTime(optional): integer(int64)
- description(optional): string
- links(optional): array links
- modifiedBy(optional): string
- modifiedTime(optional): integer(int64)
- name(optional): string
- owner(optional): string
- role(optional): string
- startTime(optional): integer(int64)
- status(optional): string
- type(optional): string
許可される値:
[ "ASO", "BSO" ]
400 レスポンス
不正なリクエスト
アプリケーションの取得に失敗しました。
500 レスポンス
内部サーバー・エラー。
例
次の例では、Essbaseアプリケーションのリストを取得する方法を示します。
コール元のユーザーIDおよびパスワードは、properties.bat
で値が設定される変数です。
cURLコマンドを含むスクリプト
call ..\..\properties.bat ..\..\curl -X GET "http://192.0.2.1:443/essbase/rest/v1/applications?filter=*&offset=0&limit=50" -H "accept: application/json" -u %User%:%Password% -o output_listapps.json
レスポンス本体の例
JSON形式のレスポンス本文のコンテンツの例を次に示します:
{
"items": [
{
"name": "ASOSamp",
"owner": "admin",
"creationTime": 1572892960265,
"status": "stopped",
"type": "ASO",
"connectedUsersCount": 0,
"description": "",
"modifiedBy": "admin",
"modifiedTime": 1572892960000,
"role": "app_manager",
"links": [
{
"rel": "child",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp/databases",
"method": "GET"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp",
"method": "GET"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp",
"method": "DELETE"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp?action=Start",
"method": "PUT"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp?action=Stop",
"method": "PUT"
}
]
},
{
"name": "Sample",
"owner": "admin",
"creationTime": 1571317262832,
"status": "stopped",
"type": "BSO",
"connectedUsersCount": 0,
"description": "",
"modifiedBy": "admin",
"modifiedTime": 1571317262000,
"role": "app_manager",
"links": [
{
"rel": "child",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases",
"method": "GET"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample",
"method": "GET"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample",
"method": "DELETE"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample?action=Start",
"method": "PUT"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample?action=Stop",
"method": "PUT"
}
]
},
{
"name": "Sample_Dynamic",
"owner": "admin",
"creationTime": 1571317308132,
"status": "stopped",
"type": "BSO",
"connectedUsersCount": 0,
"description": "",
"modifiedBy": "admin",
"modifiedTime": 1571317308000,
"role": "app_manager",
"links": [
{
"rel": "child",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic/databases",
"method": "GET"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic",
"method": "GET"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic",
"method": "DELETE"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic?action=Start",
"method": "PUT"
},
{
"rel": "self",
"href": "http://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic?action=Stop",
"method": "PUT"
}
]
}
],
"offset": 0,
"limit": 50,
"count": 3,
"totalResults": 3,
"hasMore": false
}