2.26.1 Collecting the information required to collect, into a CSV file, a list of events

This request collects the information required to collect, into a CSV file, a list of events.

Execution permission

Admin, Modify

API version

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "hqlFilter":"...",
            "hqlSort":"...",
            "page":"...",
            "pageSize":"..."
        },
        :
        ]
}

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	ListGetParam[]	A list of ListGetParam objects necessary to execute an operation. For details about ListGetParam, see the table below.

parameters (Type: ListGetParam)

Attribute	Type	Description
hqlFilter	string	filter
hqlSort	string	Sort information
page	integer	page number
pageSize	integer	Size of The page

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[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
  } ]
}