2.26.2　イベントの一覧をCSVで取得

イベントの一覧をCSVで取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

POST http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV/invoke

リクエストボディー

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

{
        "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	ページサイズ

レスポンスボディー

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

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

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	CsvData[]	実行結果のCsvDataのコレクション。CsvDataの詳細は以下の表を参照ください。

result (Type: CsvData)

属性	データ型	説明
data	string	CSVデータが格納されます。

ステータスコード

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/Events/actions/getEventDataCSV/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 292

[Request Body]
{
  "name" : "getEventDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "hqlFilter" : "",
    "hqlSort" : "dateTime DESC",
    "page" : 1,
    "pageSize" : 100
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 04:40:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 352df2998a8291f9ee75bb5f4c4ecd6a03581_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" : "83458bae-a082-4333-8628-73f2efd35436",
  "created" : "2019-09-12T13:40:05.248+09:00",
  "updated" : "2019-09-12T13:40:09.585+09:00",
  "completed" : "2019-09-12T13:40:09.585+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : "#JP1/Operations Analytics,115000,UTF-8 (BOM)\n#Event Information\n#2019-09-12T13:40:09.585+0900\n#Event ID,.........."
  } ]
}

2.26.2 イベントの一覧をCSVで取得

2.26.2　イベントの一覧をCSVで取得