2.7.4 ユーザーの設定情報の削除に必要な情報の取得
ユーザーの設定情報を削除するために必要な情報を取得します。
権限
User Management
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/services/UserCustomSettings/actions/clearUserCustomSetting
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{
"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 |
ユーザー名 |
ステータスコード
|
HTTPステータスコード |
Reason phrase |
説明 |
|---|---|---|
|
200 |
OK |
正常終了 |
|
401 |
Unauthorized |
ログイン権限がない |
|
403 |
Forbidden |
参照権限がない |
|
412 |
Precondition Failed |
サーバーが起動していない |
|
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[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"
} ]
}