Skip to main content

We've Moved!

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

Getting information about a consumer grade

You can obtain a list of grade information that includes details such as grade names and grade priorities.

Getting a list of grades

You can obtain a list of grade information, such as grade names and grade priorities.

Execution permission

Admin, Modify

Request line
GET baseURL/v1/objects/Grades
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 Grade objects. For details about Grade, 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.

Grade

{
        "gradeKey":"...",
        "name":"...",
        "displayOrder":"..."
}

Grade (Type: Grade)

Attribute

Type

Description

gradeKey

string

ID of the grade

name

string

Name of the grade

displayOrder

int

Priority of the grade

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A query parameter is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

503

Service Unavailable

Analyzer detail view server communication error.

Example code
[Request Header]
GET /Analytics/v1/objects/Grades
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:00:50 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" : [ {
    "instanceID" : "grade#Platinum",
    "gradeKey" : "10",
    "name" : "Platinum",
    "displayOrder" : 10
  }, {
    "instanceID" : "grade#Bronze",
    "gradeKey" : "40",
    "name" : "Bronze",
    "displayOrder" : 40
  }, {
    "instanceID" : "grade#Gold",
    "gradeKey" : "20",
    "name" : "Gold",
    "displayOrder" : 20
  }, {
    "instanceID" : "grade#Silver",
    "gradeKey" : "30",
    "name" : "Silver",
    "displayOrder" : 30
  } ],
  "count" : 4
}