2.7.5 Deleting the Custom Settings of a User

This API request deletes the custom settings of the specified user.

Execution permission

User Management

API version

Request format

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

Request body

The structure of the request 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

Response body

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

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	Indicates the ID of the Instance.
created	string	Indicates the date the object is generated in ISO 8601 format.
updated	string	Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.
completed	string	Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.
state	string	One of the following values is set: "failed": The operation did not terminate normally. "success": The operation terminated normally.
affectedResource	string[]	Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.
result	anyType[]	A list of objects. No value is set.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	A format of request body is invalid.
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]
POST /Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke 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
Content-Length: 58

[Request Body]
{
  "parameters": [
    {
      "userName": "System"
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:37:11 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1cfc6a016c968938dfd84aebbf07a38b7a24639_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]
{
  "instanceID" : "e34ef37d-95f8-48ea-a7f1-7208971134bb",
  "created" : "2019-09-06T18:37:11.681+09:00",
  "updated" : "2019-09-06T18:37:11.745+09:00",
  "completed" : "2019-09-06T18:37:11.745+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}