移動先

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

ユーザー・プリファレンスの取得

get

/essbase/rest/v1/preferences

ユーザー・プリファレンスを取得します。この操作では、このリリースで使用可能な様々なプリファレンスへのリンクが返されます。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

プリファレンスが正常に返されました。

本体()

ルート・スキーマ : Preference

型: object

ソースの表示

• links: array links

{
    "type":"object",
    "properties":{
        "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"
        }
    }
}

先頭に戻る

例

次の例では、Essbaseの現在のユーザー・プリファレンスへのリンクを取得する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/preferences -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "links" : [ {
    "rel" : "grid",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/preferences/grid",
    "method" : "GET"
  } ]
}

先頭に戻る