2.7.1 ユーザーの設定情報一覧の取得
REST API実行ユーザーに設定されている設定情報の一覧を取得します。
権限
Admin, Modify, User Management
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/UserCustomSettings
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "instanceID":"...", "userName":"...", "guiDisplayParams":[{ "screenKey":"...", "screenSettingValue":"..." }, : ] }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
UserCustomSetting[] |
UserCustomSettingのコレクション。UserCustomSettingの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: UserCustomSetting)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
ユーザーの設定情報のID |
userName |
string |
ユーザー名 |
guiDisplayParams |
GuiDisplayParam[] |
ユーザーに設定されている画面表示設定のリスト |
guiDisplayParams (Type: GuiDisplayParam)
属性 |
データ型 |
説明 |
---|---|---|
screenKey |
string |
画面キー |
screenSettingValue |
string |
画面設定値 |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET http://localhost:22015/Analytics/v1/objects/UserCustomSettings HTTP/1.1 Host: localhost:22015 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Firefox/52.0 Accept: */* Accept-Language: null, ja,en-US Accept-Encoding: gzip, deflate Authorization: Basic c3lzdGVtOm1hbmFnZXI= Content-Type: application/json Cookie: JSESSIONID=00ACFB0B9CF2A67FD2724B793D244887 Connection: keep-alive [Response Header] HTTP/1.1 200 OK Date: Tue, 31 Jul 2018 01:11:10 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 1ef367971b91c5a6d0af1c4ab214df556f56d8bb_Vlo8Y30Idg1+cQNsGHkUbQxzBA0=_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Content-Type: application/json Content-Length: 12904 [Response Body] { "data" : [ { "instanceID" : 0, "userName" : "System", "guiDisplayParams" : [ { "screenKey" : "dashboard.settings.autoRefresh", "screenSettingValue" : "1" }, { "screenKey" : "dashboard.settings", "screenSettingValue" : "{\"defs\":[{\"id\":\"AllResourcesStatusApplication\",\"data\"...}" } ] } ], "count" : 1 }