2.7.2　ユーザーの設定情報の設定

REST API実行ユーザーの設定情報を設定または上書きします。REST API実行ユーザー以外のユーザーの設定情報を設定することはできません。

権限

Admin, Modify, User Management

APIのバージョン

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/UserCustomSettings

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

{
        "guiDisplayParams":[{
            "screenKey":"...",
            "screenSettingValue":"..."
        },
        :
        ]
}

UserCustomSetting (Type: UserCustomSetting)

属性	データ型	説明
guiDisplayParams	GuiDisplayParam[]	ユーザーに設定されている画面表示設定のリスト

guiDisplayParams (Type: GuiDisplayParam)

属性	データ型	説明
screenKey	string	画面キー
screenSettingValue	string	画面設定値

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

{
        "instanceID":"...",
        "userName":"...",
        "guiDisplayParams":[{
            "screenKey":"...",
            "screenSettingValue":"..."
        },
        :
        ]
}

UserCustomSetting (Type: UserCustomSetting)

属性	データ型	説明
instanceID	long	ユーザーの設定情報のID
userName	string	ユーザー名
guiDisplayParams	GuiDisplayParam[]	ユーザーに設定されている画面表示設定のリスト

guiDisplayParams (Type: GuiDisplayParam)

属性	データ型	説明
screenKey	string	画面キー
screenSettingValue	string	画面設定値

ステータスコード

HTTPステータスコード	Reason phrase	説明
201	Created	正常終了
400	Bad Request	リクエストボディ形式不正
401	Unauthorized	ログイン権限がない
403	Forbidden	更新権限がない
412	Precondition Failed	サーバーが起動していない
500	Internal Server Error	サーバーサイドエラー

使用例

[Request Header]
POST 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: application/json, text/javascript, */*; q=0.01
Accept-Language: ja,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Content-Type: application/json; charset=utf-8
Authorization: HSSO a8325764f8fbf4b384a997f811c9e40cc81f3b6_Vlo8Y30Idg1+cQNsGHkUbQxzBA0=_V0810
X-Requested-With: XMLHttpRequest
Referer: http://localhost:22015/Analytics/main.htm
Content-Length: 12697
Cookie: JSESSIONID=00ACFB0B9CF2A67FD2724B793D244887
Connection: keep-alive

[Request Body]
{
  "guiDisplayParams":[
    {
      "screenKey":"dashboard.settings",
      "screenSettingValue":"{\"defs\":[{\"id\":\"AllResourcesStatusApplication\",\"data\"..."
    },{
      "screenKey":"dashboard.settings.autoRefresh",
      "screenSettingValue":"2"
    }
  ]
}

[Response Header]
HTTP/1.1 201 Created
Date: Tue, 31 Jul 2018 00:58:51 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a8325764f8fbf4b384a997f811c9e40cc81f3b6_Vlo8Y30Idg1+cQNsGHkUbQxzBA0=_V0810
Location: http://localhost:22015/Analytics/v1/objects/UserCustomSettings//0
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=98
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 12847

[Response Body]
{
  "instanceID" : 0,
  "userName" : "System",
  "guiDisplayParams" : [ {
    "screenKey" : "dashboard.settings.autoRefresh",
    "screenSettingValue" : "2"
  }, {
    "screenKey" : "dashboard.settings",
    "screenSettingValue" : "{\"defs\":[{\"id\":\"AllResourcesStatusApplication\",\"data\"...}"
  } ]
}

2.7.2 ユーザーの設定情報の設定

2.7.2　ユーザーの設定情報の設定