移動先

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

アプリケーションの取得

get

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

指定された名前のアプリケーションの詳細を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

問合せパラメータ

• role: boolean

  役割。

  デフォルト値: false

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

アプリケーションの詳細が正常に返されました。

本体()

ルート・スキーマ : Application

型: object

ソースの表示

• connectedUsersCount: integer(int32)

  アプリケーションに現在接続されているユーザー数。

• creationTime: integer(int64)
• description: string
• easManagedApp: boolean

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

• inspectAppAllowed: boolean
• links: array links
• modifiedBy: string
• modifiedTime: integer(int64)
• name: string
• owner: string
• role: string
• startStopAppAllowed: boolean

  少なくとも読取り権限を持つユーザーがアプリケーションを起動できる場合はtrue。

• startTime: integer(int64)
• status: string
• type: string
  指定可能な値: [ "ASO", "BSO", "CURRENCY" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "creationTime":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedBy":{
            "type":"string"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ASO",
                "BSO",
                "CURRENCY"
            ]
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "connectedUsersCount":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of users currently connected to the application.</p>"
        },
        "role":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "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>"
        },
        "startStopAppAllowed":{
            "type":"boolean",
            "description":"<p><b>true</b> if users who have at least read permission can start the application.</p>"
        },
        "inspectAppAllowed":{
            "type":"boolean"
        }
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

ネストされたスキーマ : 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/Facility?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "name" : "Facility",
  "owner" : "admin",
  "creationTime" : 1661570700487,
  "status" : "stopped",
  "type" : "BSO",
  "connectedUsersCount" : 0,
  "description" : "",
  "modifiedBy" : "admin",
  "modifiedTime" : 1661570700487,
  "startStopAppAllowed" : true,
  "inspectAppAllowed" : true,
  "appVariablesSetting" : {
    "showVariables" : true,
    "updateVariables" : true
  }
}

先頭に戻る