2.26.1 イベントの一覧をCSVで取得するために必要な情報の取得
イベントの一覧をCSVで取得するために必要な情報の取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":[{ "hqlFilter":"...", "hqlSort":"...", "page":"...", "pageSize":"..." }, : ] }
Action (Type: Action)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
操作名です。 |
href |
string |
操作の実行先URLです。 |
method |
string |
メソッド名です。 |
type |
string |
データのデータ形式です。 |
parameters |
ListGetParam[] |
操作実行時に必要なListGetParamのコレクション。ListGetParamの詳細は以下の表を参照ください。 |
parameters (Type: ListGetParam)
属性 |
データ型 |
説明 |
---|---|---|
hqlFilter |
string |
フィルタ情報 |
hqlSort |
string |
ソート情報 |
page |
integer |
取得ページ |
pageSize |
integer |
ページサイズ |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET /Analytics/v1/services/Events/actions/getEventDataCSV HTTP/1.1 Host: JP1OAServer:22015 User-Agent: curl/7.63.0 Accept: application/json Accept-Language: ja Authorization: Basic c3lzdGVtOm1hbmFnZXI= [Response Header] HTTP/1.1 200 OK Date: Thu, 12 Sep 2019 03:10:39 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO a28b1e307e4652f1330af49f93fdced13792_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" : "getEventDataCSV", "href" : "http://JP1OAServer:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ { "hqlFilter" : "", "hqlSort" : "", "page" : 1, "pageSize" : 0 } ] }