移動先

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

アプリケーションのリスト

get

/essbase/rest/v1/applications

Essbaseアプリケーションのリストを返します。接続名、および接続のアプリケーション名はオプションのパラメータです。

接続名のみを指定しアプリケーション名を指定しなかった場合、このAPIでは、指定された接続を使用してすべてのアプリケーションがフェッチされます。

接続名とアプリケーション名を指定した場合、このAPIでは、指定された接続を使用して、指定されたアプリケーションがフェッチされます。

必要なフィールドのみを返すには、fieldsパラメータを使用します。

制限: レスポンスでアプリケーション・ステータスが必要な場合は、制限が100以下である必要があります。

リクエスト

問合せパラメータ

• applicationNameForConnection: string

  接続のアプリケーション名。

• connectionName: string

  接続名。

• fields: string

  レスポンス・フィールドで返されるフィールドのカンマ区切りリスト。省略した場合は、すべてのフィールドが返されます。

• filter: string
  デフォルト値: *
• limit: integer(int32)

  返される最大アプリケーション数。デフォルトは50です。

  デフォルト値: 50
• offset: integer(int32)

  結果セットの先頭から省略するアプリケーションの数。デフォルト値は0です。

  デフォルト値: 0

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

アプリケーション・リストが正常に返されました。

本体()

ルート・スキーマ : ApplicationList

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Application"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object Application

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

ネストされたスキーマ : 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?filter=*&offset=0&limit=50&links=none" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "items": [
    {
      "name": "ASOSamp",
      "owner": "admin",
      "creationTime": 1572892960265,
      "status": "stopped",
      "type": "ASO",
      "connectedUsersCount": 0,
      "description": "",
      "modifiedBy": "admin",
      "modifiedTime": 1572892960000,
      "role": "app_manager",
      "startStopAppAllowed": "true",
      "inspectAppAllowed": "true",
      "appVariablesSetting": {
         "showVariables": true,
         "updateVariables": true
       }
    },
    {
      "name": "Sample",
      "owner": "admin",
      "creationTime": 1571317262832,
      "status": "stopped",
      "type": "BSO",
      "connectedUsersCount": 0,
      "description": "",
      "modifiedBy": "admin",
      "modifiedTime": 1571317262000,
      "role": "app_manager",
      "startStopAppAllowed": "true",
      "inspectAppAllowed": "true",
      "appVariablesSetting": {
         "showVariables": true,
         "updateVariables": true
       }
    },
    {
      "name": "Sample_Dynamic",
      "owner": "admin",
      "creationTime": 1571317308132,
      "status": "stopped",
      "type": "BSO",
      "connectedUsersCount": 0,
      "description": "",
      "modifiedBy": "admin",
      "modifiedTime": 1571317308000,
      "role": "app_manager",
      "startStopAppAllowed": "true",
      "inspectAppAllowed": "true",
      "appVariablesSetting": {
         "showVariables": true,
         "updateVariables": true
       }
    }
  ],
  "offset": 0,
  "limit": 50,
  "count":  3,
  "totalResults":  3,
  "hasMore": false
}

先頭に戻る