ページの先頭行へ戻る
Interstage AR Processing Server V1.0.1 リファレンスガイド
FUJITSU Software

2.1.6 QEntity

2.1.6.1 データ構造

属性

説明

値型

制約

qtypeName

QAttributeと同じ

同左

同左

id

id。サーバ側で採番される

Long

required, 同一qtypeNameでunique

version

QTypeと同じ

同左

同左

2.1.6.2 主キーによる特定API

Method/URL
GET http://(server):(port)/(webapp)/qentities/(qtypename)/(id)
リクエスト

パスパラメータ

説明

{qtypename}パスパラメータ

QAttributeと同じ

{id}パスパラメータ

id

レスポンス

ヘッダ/ボディ

説明

ETagヘッダ

QTypeと同じ

ボディ

JSON形式のQEntityデータ

上記は正常時のレスポンスです。異常時の場合は例外情報が出力されます。

http://(server):(port)/(webapp)/qentities/パソコン001/922337203685477580

2.1.6.3 検索API

Method/URL
GET http://(server):(port)/(webapp)/qentities?(クエリパラメータ)...
リクエスト

クエリパラメータ

説明

値型

制約等

type

QTypeと同じ

同左

同左

limitRange

QTypeと同じ

同左

同左

qtypeNameRanges

QAttributeと同じ

同左

同左

idRanges

id範囲配列

例)[{"start":100,"end":200}]

List<Range<Long>>

5配列以下

sortOrders

ソートオーダ配列。

QTYPENAME=qtypeName昇順, QTYPENAME_DESC=qtypeName降順, ID=id昇順, ID_DESC=id降順

例)["QTYPENAME","ID"]

List<Enum>

default=なし(不定), 5配列以下

レスポンス

ヘッダ/ボディ

説明

ボディ

QTypeと同じ。recordsは「List<QEntity>」となる。

上記は正常時のレスポンスです。異常時の場合は例外情報が出力されます。

リクエスト例

http://(server):(port)/(webapp)/qentities?type=RECORDSANDCOUNT&limitRange={"start":1,"end":10}&qtypeNameRanges=[{"start":"パソコン001","end":"パソコン999"}]&idRanges=[{"start":100,"end":200},{"start":300,"end":400}]&sortOrders=["QTYPENAME","ID"]

2.1.6.4 登録API

Method/URL
POST http://(server):(port)/(webapp)/qentities
リクエスト

ヘッダ/ボディ

説明

ボディ

JSON形式のQEntityデータ

id/versionには値をセットする必要はありません。登録時、サーバで新規採番されます。

レスポンス

ヘッダ/ボディ

説明

ETagヘッダ

QTypeと同じ

ボディ

JSON形式の登録後QEntityデータ

注意

クライアントオーサリングを併用で行う場合、arpoiarmk_defaultに対して追加できるQEntity数は一つのシナリオ当りにつき100以下にする必要があります。

2.1.6.5 削除

Method/URL
DELETE http://(server):(port)/(webapp)/qentities/(qtypename)/(id)
リクエスト

ヘッダ/パス/ボディ

説明

If-Matchヘッダ

QTypeと同じ

{qtypename}パスパラメータ

QAttributeと同じ

{id}パスパラメータ

id

レスポンス

ヘッダ/ボディ

説明

ボディ

QTypeと同じ

注意

QEntityを削除すると、削除したQEntityを親に持つQValueがすべて削除されます。