2.15.2 Collecting, into a CSV file, a list of events
This request collects, into a CSV file, a list of events.
Execution permission
Admin, Modify
API version
v1
Request format
POST http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV/invoke
Request body
The structure of the request body and the object attributes are as follows:Action
{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":["...", ...] }
Action (Type: Action)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of the execute an operation. |
href |
string |
URL of the execute an operation. |
method |
string |
Name of the method. |
type |
string |
Data format of the object. |
parameters |
anyType[] |
A list of ListGetParam objects necessary to execute an operation. For details about ListGetParam, see the table below. |
ListGetParam
{ "hqlFilter":"...", "hqlSort":"...", "page":"...", "pageSize":"..." }
ListGetParam (Type: ListGetParam)
Attribute |
Type |
Description |
---|---|---|
hqlFilter |
string |
filter |
hqlSort |
string |
Sort information |
page |
integer |
page number |
pageSize |
integer |
Size of The page |
Response body
The structure of the response body and the object attributes are as follows:Job
{ "instanceID":"...", "created":"...", "updated":"...", "completed":"...", "state":"...", "affectedResource":["...", ...], "result":["...", ...] }
Job (Type: Job)
Attribute |
Type |
Description |
---|---|---|
instanceID |
string |
Indicates the ID of the Instance. |
created |
string |
Indicates the date the object is generated in ISO 8601 format. |
updated |
string |
Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set. |
completed |
string |
Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set. |
state |
string |
One of the following values is set: "failed": The operation did not terminate normally. "success": The operation terminated normally. |
affectedResource |
string[] |
Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty. |
result |
anyType[] |
A list of CsvData objects. For details about CsvData, see the table below. |
CsvData
{ "data":"..." }
CsvData (Type: CsvData)
Attribute |
Type |
Description |
---|---|---|
data |
string |
The CSV data is stored. |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
400 |
Bad Request |
A format of request body is invalid. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No execute privilege. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] POST /Analytics/v1/services/Events/actions/getEventDataCSV/invoke HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Content-Type: application/json Accept-Language: ja Content-Length: 296 [Request Body] { "name" : "getNodesGraphDataCSV", "href" : "http://localhost:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ { "hqlFilter" : "", "hqlSort" : "", "page" : 1, "pageSize" : 0 } ] } [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 09:22:28 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50", "created" : "2016-11-22T11:53:42.188+09:00", "updated" : "2016-11-22T11:53:42.354+09:00", "completed" : "2016-11-22T11:53:42.354+09:00", "state" : "success", "affectedResource" : [ ], "result" : [ { "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"\n"#Event Information"\n..." } ] }