2.7.3 ユーザーの設定情報に対する操作一覧の取得
ユーザーの設定情報に対して実行できる操作の一覧を取得します。
権限
User Management
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/services/UserCustomSettings/actions
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":["...", ...] }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Action[] |
Actionのコレクション。Actionの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Action)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
操作名です。 |
href |
string |
操作の実行先URLです。 |
method |
string |
メソッド名です。 |
type |
string |
データのデータ形式です。 |
parameters |
anyType[] |
コレクション。空欄です。 |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET /Analytics/v1/services/UserCustomSettings/actions 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:36:59 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 38b785fe1f2c64401d1f55c39985a241d4e6079_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] { "data" : [ { "name" : "clearUserCustomSetting", "href" : "http://JP1OAServer:22015/Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ ] } ], "count" : 1 }