移動先

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

データベースのリスト

get

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

データベースのリストを返します。データベースをリストする接続の名前の指定はオプションです。接続名が指定されている場合は、指定されたアプリケーションで作成された接続を使用してデータベース・リストをフェッチします。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

問合せパラメータ

• applicationNameForConnection: string

  データベースをリストするアプリケーションの名前。

• connectionName: string

  接続名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

データベース・リストが正常に返されました。

本体()

ルート・スキーマ : CubeList

型: 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/Cube"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

• 配列: object Cube

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

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

  trueの場合、アプリケーションはEssbase Webインタフェースではなく、Essbase Administration Services (EAS) Liteで管理されます。EAS Liteは、Essbase 21c独立デプロイメントにのみ使用可能な制限付きオプションの代替物として使用できます。

• inspectDBAllowed: boolean
• links: array links
• modifiedBy: string
• modifiedTime: integer(int64)
• name: string
• owner: string
• startStopDBAllowed: boolean
• startTime: integer(int64)
• status: string
• type: string
  指定可能な値: [ "ASO", "BSO", "CURRENCY" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "creationTime":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedBy":{
            "type":"string"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ASO",
                "BSO",
                "CURRENCY"
            ]
        },
        "applicationRole":{
            "type":"string"
        },
        "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. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.</p>"
        },
        "startStopDBAllowed":{
            "type":"boolean"
        },
        "inspectDBAllowed":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

レスポンス本体の例

{
  "items" : [ {
    "name" : "Basic",
    "application" : "Sample",
    "owner" : "admin",
    "creationTime" : 1663198643123,
    "status" : "started",
    "startTime" : 1663814542677,
    "type" : "BSO",
    "description" : "",
    "modifiedBy" : "admin",
    "modifiedTime" : 1663814710916,
    "applicationRole" : "app_manager",
    "startStopDBAllowed" : true,
    "inspectDBAllowed" : true,
    "dbVariablesSetting" : {
      "showVariables" : true,
      "updateVariables" : true
    }
  } ]
}

先頭に戻る