移動先

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

別名のリスト

get

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

指定されたアプリケーションおよびデータベースに関連付けられている別名表を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• aliasTableName: string

  別名表名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

別名表が正常に返されました。

本体()

ルート・スキーマ : Result

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

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: object

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

ソースの表示

• string

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

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/Basic/aliases -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ "Default", "Long Names", "ChineseNames", "JapaneseNames", "RussianNames", "GermanNames" ],
  "count" : 6
}

先頭に戻る