属性 | 説明 | 値型 | 制約 |
|---|---|---|---|
name | 名前。RDBで言うところのTable名相当 | String | required, unique, 1～30文字 |
description | 説明 | String | 0～300文字 |
version | オプティミスティック同時実行制御用のversion。サーバ側で採番される | Integer | required |
GET http://(server):(port)/(webapp)/qtypes/(name)
パスパラメータ | 説明 |
|---|---|
{name}パスパラメータ | name |
ヘッダ/ボディ | 説明 |
|---|---|
ETagヘッダ | バージョン情報 |
ボディ | JSON形式のQTypeデータ |
上記は正常時のレスポンスです。異常時の場合は例外情報が出力されます。
例
リクエスト例
http://(server):(port)/(webapp)/qtypes/パソコン001
GET http://(server):(port)/(webapp)/qtypes?(クエリパラメータ)...
クエリパラメータ | 説明 | 値型 | 制約等 |
|---|---|---|---|
type | 処理結果として返却するもの。 RECORDS=結果配列を返却, COUNT=結果総数を返却, RECORDANDCOUNT=結果配列/総数を返却 | Enum | default=RECORDS |
limitRange | 結果配列の取得範囲。1～ 例){"start":1,"end":10} | Range<Integer> | default=1～10, 100間隔未満, 開始/終了逆転不可 |
nameRanges | name範囲配列 例)[{"start":"パソコン001","end":"パソコン999"}] | List<Range<String>> | 100文字以下, 5配列以下 |
sortOrders | ソートオーダ配列。 NAME=name昇順, NAME_DESC=name降順 例)["NAME"] | List<Enum> | default=なし(不定), 5配列以下 |
ヘッダ/ボディ | 説明 |
|---|---|
ボディ | JSON形式の検索結果オブジェクト。recordsは「List<QType>」です。 |
上記は正常時のレスポンスです。異常時の場合は例外情報が出力されます。
例
リクエスト例
http://(server):(port)/(webapp)/qtypes?type=RECORDSANDCOUNT&limitRange={"start":1,"end":10}& nameRanges=[{"start":"パソコン001","end":"パソコン999"}]&sortOrders=["NAME"]