Hitachi

JP1 Version 11 JP1/Operations Analytics REST API Reference Guide


2.15.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

v1

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:

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

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
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data": [{
    "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
    }],
    "count": 1
 }]
}