2.7.1 Acquiring a List of Custom Settings of a User

This REST API request acquires a list of custom settings specified by the user executing the request.

Execution permission

Admin, Modify, User Management

API version

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "userName":"...",
            "guiDisplayParams":[{
                "screenKey":"...",
                "screenSettingValue":"..."
            },
            :
            ]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	UserCustomSetting[]	A list of UserCustomSetting objects. For details about UserCustomSetting, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions.

data (Type: UserCustomSetting)

Attribute	Type	Description
instanceID	long	ID of User Custom Setting
userName	string	User name
guiDisplayParams	GuiDisplayParam[]	List of GUI display parameters set by the user

guiDisplayParams (Type: GuiDisplayParam)

Attribute	Type	Description
screenKey	string	screen key
screenSettingValue	string	setting value for the screen display

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	page
pageSize	integer	Size of the pages
numPages	integer	Number of the pages
totalCount	integer	Number of the objects

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[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
}