2.10.3　グレードの一覧の取得

コンシューマーに含まれるグレードの一覧を取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Grades

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

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

Collections (Type: Collections)

属性	データ型	説明
data	Grade[]	Gradeのコレクション。Gradeの詳細は以下の表を参照ください。
pagination	Pagination	ページ情報。リソースが存在しない場合、このパラメータは表示されません。
count	int	条件に合致したデータの個数

data (Type: Grade)

属性	データ型	説明
gradeKey	string	グレードを識別するID。
name	string	グレードの名称。
displayOrder	int	グレードの優先順位。

pagination (Type: Pagination)

属性	データ型	説明
page	integer	ページ
pageSize	integer	ページサイズ
numPages	integer	ページの数
totalCount	integer	オブジェクトの数

ステータスコード

HTTPステータスコード	Reason phrase	説明
200	OK	正常終了
400	Bad Request	クエリパラメータ不正
401	Unauthorized	ログイン権限がない
403	Forbidden	参照権限がない
412	Precondition Failed	サーバーが起動していない
500	Internal Server Error	サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Grades 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 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 723cc9c7dbae3aa85bad85fc46d1bc9edb64d_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 410,
    "gradeKey" : "0",
    "name" : "Platinum",
    "displayOrder" : 0
  }, {
    "instanceID" : 413,
    "gradeKey" : "10",
    "name" : "Gold",
    "displayOrder" : 10
  }, {
    "instanceID" : 412,
    "gradeKey" : "20",
    "name" : "Silver",
    "displayOrder" : 20
  }, {
    "instanceID" : 411,
    "gradeKey" : "30",
    "name" : "Bronze",
    "displayOrder" : 30
  } ],
  "count" : 4
}

2.10.3 グレードの一覧の取得

2.10.3　グレードの一覧の取得