Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Getting information about the system

You can obtain information about the system.

Getting system information

You can obtain information about system settings, such as the time zone and locale.

Execution permission

Admin, Modify, User Management

Request line
GET baseURL/v1/objects/SystemProperties
Request body

Not applicable.

Response bodyThe structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

anyType[]

A list of SystemProperty objects. For details about SystemProperty, see the table below.

pagination

Pagination

Page information. This parameter is displayed only when the relevant resource exists.

count

int

Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute

Type

Description

page

integer

Page.

pageSize

integer

Size of page.

numPages

integer

Number of pages.

totalCount

integer

Number of objects.

SystemProperty

{
        "type":"...",
        "value":"..."
}

SystemProperty (Type: SystemProperty)

Attribute

Type

Description

type

enum

Type of the system information

(For details about the valid values, see the table SystemPropertyType in List of enumerators.)

value

string

Value of the system information

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/objects/SystemProperties
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 03 Aug 2016 02:01:33 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a61560c2eac97b0564aec48d2883daf39c0dfdf_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_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]
{
  "data" : [ {
    "type" : "GroupDescriptionTemplate",
    "value" : "Company:\r\nSystem: \r\nTel:\r\nAddress:\r\nContact Person:\
  }, {
    "type" : "SystemTimeZone",
    "value" : "Asia/Tokyo"
  }, {
    ...........
  } ],
  "count" : 13
}