2.7.5　ユーザーの設定情報の削除

指定されたユーザーの設定情報を全て削除します。

権限

User Management

APIのバージョン

リクエスト形式

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

リクエストボディー

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

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

Action (Type: Action)

属性	データ型	説明
name	string	操作名です。
href	string	操作の実行先URLです。
method	string	メソッド名です。
type	string	データのデータ形式です。
parameters	UserCustomSetting[]	操作実行時に必要なUserCustomSettingのコレクション。UserCustomSettingの詳細は以下の表を参照ください。

parameters (Type: UserCustomSetting)

属性	データ型	説明
userName	string	ユーザー名

レスポンスボディー

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

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

Job (Type: Job)

属性	データ型	説明
instanceID	string	インスタンスのIDを示します。
created	string	オブジェクトの生成日付を示します。ISO8601形式です。
updated	string	オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。
completed	string	処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。
state	string	以下の値が設定されます。 “failed”: 操作が正常終了しなかったことを示します。 “success”: 操作が正常終了したことを示します。
affectedResource	string[]	操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。
result	anyType[]	実行結果のコレクション。空欄です。

ステータスコード

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

使用例

[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" : [ ]
}

2.7.5 ユーザーの設定情報の削除

2.7.5　ユーザーの設定情報の削除