移動先

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

複数のロケーション別名の取得

get

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

データベース上で定義されているロケーション別名について詳細を取得します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• applicationName: string

  ロケーション別名のターゲット・アプリケーション名。

• databaseName: string

  ロケーション別名のターゲット・データベース名。

• limit: integer(int32)

  返される最大ロケーション別名数。

• offset: integer(int32)

  結果セットの先頭から省略するアイテムの数。

• serverName: string

  ロケーション別名のターゲット・サーバー名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ロケーション別名が正常に返されました。

本体()

ルート・スキーマ : LocationAliasList

型: object

ソースの表示

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

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

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

型: array

ソースの表示

• 配列: object LocationAliasBean

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

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• aliasName: string

  ロケーション別名の名前。

• applicationLevelConnection: boolean

  ロケーション別名が保存された接続に基づいている場合、このパラメータは、接続がアプリケーション・レベルの場合はtrue、接続がグローバルに定義されている場合はfalseである必要があります。

• applicationName: string

  ロケーション別名が参照するデータベース/キューブのアプリケーション名。

• connectionName: string

  ロケーション別名が保存された接続に基づいている場合、接続の名前。

• databaseName: string

  ロケーション別名が参照するデータベースの名前。

• links: array links
• serverName: string

  ロケーション別名が保存された接続に基づいていない場合、ロケーション別名が参照するデータベース/キューブのEssbaseサーバー・ホスト名。

• userName: string

  ロケーション別名が保存された接続に基づいていない場合、serverNameへのログインを許可されているユーザーの名前。両方のキューブが同じEssbaseサーバー上にある場合はオプションです。

{
    "type":"object",
    "properties":{
        "aliasName":{
            "type":"string",
            "description":"<p>Name of the location alias.</p>"
        },
        "connectionName":{
            "type":"string",
            "description":"<p>If the location alias is based on a saved connection, the name of the connection.</p>"
        },
        "serverName":{
            "type":"string",
            "description":"<p>If the location alias is not based on a saved connection, the Essbase Server host name of the database/cube to which the location alias refers.</p>"
        },
        "userName":{
            "type":"string",
            "description":"<p>If the location alias is not based on a saved connection, the name of a user who is authorized to log in to <i>serverName</i>. Optional if both cubes are on the same Essbase Server.</p>"
        },
        "applicationName":{
            "type":"string",
            "description":"<p>Application name for the database/cube to which the location alias refers.</p>"
        },
        "databaseName":{
            "type":"string",
            "description":"<p>Name of the database to which the location alias refers.</p>"
        },
        "applicationLevelConnection":{
            "type":"boolean",
            "description":"<p>If the location alias is based on a saved connection, this parameter should be <b>true</b> if the connection is application-level, or <b>false</b> if the connection is globally defined.</p>"
        },
        "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/Basic/locationaliases?links=none" -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ {
    "aliasName" : "EasternDB",
    "serverName" : "https://myserver.example.com:9001/essbase/agent",
    "userName" : "",
    "applicationName" : "Eastern",
    "databaseName" : "Sales",
    "applicationLevelConnection" : false
  } ],
  "totalResults" : 1,
  "limit" : 1,
  "count" : 1
}

先頭に戻る