2.7.4 Collecting Information Necessary for Deleting the Custom Settings of a User

This API request collects information necessary to delete the custom settings of a user.

Execution permission

User Management

API version

Request format

GET http[s]://host:port/Analytics/version/services/UserCustomSettings/actions/clearUserCustomSetting

Request body

Not applicable.

Response body

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

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "userName":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the execute an operation.
href	string	URL of the execute an operation.
method	string	Name of the method.
type	string	Data format of the object.
parameters	UserCustomSetting[]	A list of UserCustomSetting objects necessary to execute an operation. For details about UserCustomSetting, see the table below.

parameters (Type: UserCustomSetting)

Attribute	Type	Description
userName	string	User name

Status codes

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

Example code

[Request Header]
GET /Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:37:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO e81125df712d954ea361376cc1bcbb72131e30_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "clearUserCustomSetting",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "userName" : "System"
  } ]
}