12.4. データストア

12.4.1. 一般情報

モジュール名 datastore
APIバージョン 2

以下の値は、Base64エンコードしてリクエストする必要があります。 また、レスポンスはBase64エンコードされたものになります。

  • メタバイナリ
  • タグ

12.4.2. 標準API

12.4.2.1. メタ情報の取得

データのメタ情報を取得します。

GET /nex/datastore/v2/metainfo/(data_id)

1つのデータ data_id のメタ情報を取得します。

パラメーター:

名前 内容
data_id メタ情報を取得するデータ ID。 必須
response 追加で取得する情報。下記表参照。カンマ区切りで複数指定可。

リクエスト例:

データ ID 10 のメタ情報を取得する。

GET /nex/datastore/v2/metainfo/10?response=meta_binary,tags,ratings HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfos length="1">
      <metainfo>
        <referred_count>0</referred_count>
        <meta_binary>bWV0YWJpbmFyeQ==</meta_binary>
        <cur_version>1</cur_version>
        <period>30</period>
        <created_time>2016-01-01T00:00:00Z</created_time>
        <size>10</size>
        <ratings length="1">
          <rating>
            <slot>0</slot>
            <count>1</count>
            <total_value>100</total_value>
            <initial_value>0</initial_value>
          </rating>
        </ratings>
        <update_permission>
          <recipient_ids length="0"/>
          <type>public</type>
        </update_permission>
        <type>0</type>
        <owner_id>100</owner_id>
        <status>none</status>
        <refer_data_id>0</refer_data_id>
        <tags length="2">
          <tag>dGFnMQ==</tag>
          <tag>dGFnMg==</tag>
        </tags>
        <access_permission>
          <recipient_ids length="0"/>
          <type>public</type>
        </access_permission>
        <prev_version>0</prev_version>
        <read_lock_id>0</read_lock_id>
        <expire_time>2016-01-01T00:00:00Z</expire_time>
        <referred_time>2016-01-01T00:00:00Z</referred_time>
        <name>name</name>
        <data_id>10</data_id>
        <updated_time>2016-01-01T00:00:00Z</updated_time>
        <flags length="1">
          <flag>none</flag>
        </flags>
      </metainfo>
    </metainfos>
  </datastore>
</nex>

meta_binary, tag にはURL SafeなBase64エンコードされた値が設定されます。

GET /nex/datastore/v2/metainfo

複数データのメタ情報を取得します。

パラメーター:

名前 内容
data_ids メタ情報を取得するデータ ID。カンマ区切りで複数指定可(最大100個)。 必須
response 追加で取得する情報。下記表参照。カンマ区切りで複数指定可。

response

内容
meta_binary メタバイナリ
tags タグ
ratings 評価

リクエスト例:

データ ID 10, 20, 30 のメタ情報を取得する。

GET /nex/datastore/v2/metainfo?data_ids=10,20,30 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfos length="3">
      <metainfo>
        <data_id>10</data_id>

        (省略)

      </metainfo>
      <metainfo>
        <data_id>20</data_id>

        (省略)

      </metainfo>
      <metainfo>
        <data_id>30</data_id>

        (省略)

      </metainfo>
    </metainfos>
  </datastore>
</nex>

12.4.2.2. メタ情報の変更

データのメタ情報を変更します。

原則、指定した情報のみ変更されますが、有効日数もしくは更新日時を変更した場合は有効期限も変更されます。

PUT /nex/datastore/v2/metainfo/(data_id)
POST /nex/datastore/v2/metainfo/(data_id)/put

1つのデータ data_id のメタ情報を変更します。

パラメーター:

名前 内容
data_id 変更するデータ ID。 必須

リクエストボディ:

要素名 親要素 内容
change   ルート要素。 必須
name change 名前。
type change データタイプ
period change 有効日数。
status change ステータス。下記表参照。
access_permission change 参照権限。子要素で設定。
update_permission change 更新権限。子要素で設定。
type access_permission, update_permission 権限の種類。下記表参照。
recipient_ids access_permission, update_permission 権限の保有者。 typespecifiedspecified_friend の場合、子要素 recipient_id で指定。
recipient_id recipient_ids 権限の保有者。複数指定可。
tags change タグ。子要素 tag で指定。
tag tags タグ。URL SafeなBase64エンコードをして指定。複数指定可(最大16個)。
meta_binary change メタバイナリ。URL SafeなBase64エンコードをして指定。
modify_updated_time change 更新日時を現在日時に更新する場合、 1 を指定。

status

内容
none 通常状態
pending 審査中
rejected 審査で却下された

access_permission/type, update_permission/type

内容
public 全体
friend フレンドのみ
specified 指定した相手のみ。 recipient_ids での指定が必要
private 自分のみ
specified_friend 指定したフレンドのみ。 recipient_ids での指定が必要

リクエスト例:

データ ID 10 のメタ情報を以下のように変更する。

  • 名前を”new name”にする
  • 参照権限を全体にする
  • タグを”tag”にする
PUT /nex/datastore/v2/metainfo/10 HTTP/1.1

<change>
  <name>new name</name>
  <access_permission>
    <type>public</type>
  </access_permission>
  <tags>
    <tag>dGFn</tag>
  </tags>
</change>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfo>
      <changed length="1" />
    </metainfo>
  </datastore>
</nex>
PUT /nex/datastore/v2/metainfo
POST /nex/datastore/v2/metainfo/put

複数データのメタ情報を変更します。

リクエストボディ:

要素名 親要素 内容
change   ルート要素。 必須
name change 名前。
type change データタイプ
period change 有効日数。
status change ステータス。上記表参照。
access_permission change 参照権限。子要素で設定。
update_permission change 更新権限。子要素で設定。
type access_permission, update_permission 権限の種類。上記表参照。
recipient_ids access_permission, update_permission 権限の保有者。 typespecifiedspecified_friend の場合、子要素 recipient_id で指定。
recipient_id recipient_ids 権限の保有者。複数指定可。
tags change タグ。子要素 tag で指定。
tag tags タグ。URL SafeなBase64エンコードをして指定。複数指定可(最大16個)。
meta_binary change メタバイナリ。URL SafeなBase64エンコードをして指定。
modify_updated_time change 更新日時を現在日時に更新する場合、 1 を指定。
param change 変更するデータ。複数指定可(最大100個)。 必須
data_id param 変更するデータ ID。 必須

リクエスト例:

データ ID 10, 20 のメタ情報を以下のように変更する。

  • 名前を”new name”にする
  • 更新権限をプリンシパルID 100のみにする
PUT /nex/datastore/v2/metainfo HTTP/1.1

<change>
  <name>new name</name>
  <update_permission>
    <type>specified</type>
    <recipient_ids>
      <recipient_id>100</recipient_id>
    </recipient_ids>
  </update_permission>
  <param>
    <data_id>10</data_id>
  </param>
  <param>
    <data_id>20</data_id>
  </param>
</change>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfo>
      <changed length="2" />
    </metainfo>
  </datastore>
</nex>

12.4.2.3. データの削除

データを削除します。

DELETE /nex/datastore/v2/data/(data_id)
POST /nex/datastore/v2/data/(data_id)/delete

1つのデータ data_id を削除します。

パラメーター:

名前 内容
data_id 削除するデータ ID。 必須

リクエスト例:

データ ID 10 のデータを削除する。

DELETE /nex/datastore/v2/data/10 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data>
      <deleted length="1" />
    </data>
  </datastore>
</nex>
POST /nex/datastore/v2/data/delete

複数のデータを削除します。

リクエストボディ:

要素名 親要素 内容
delete   ルート要素。 必須
param delete 削除するデータ。複数指定可(最大100個)。 必須
data_id param 削除するデータ ID。 必須

リクエスト例:

データ ID 10, 20 のデータを削除する。

POST /nex/datastore/v2/data/delete HTTP/1.1

<delete>
  <param>
    <data_id>10</data_id>
  </param>
  <param>
    <data_id>20</data_id>
  </param>
</delete>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data>
      <deleted length="2" />
    </data>
  </datastore>
</nex>

12.4.2.4. データの検索

データを検索します。

パラメーター:

名前 内容
type データタイプ。カンマ区切りで複数指定可。複数指定した場合は OR で検索します。
owner_ids オーナー ID。カンマ区切りで複数指定可。複数指定した場合は OR で検索します。
owner_type オーナータイプ。下記表参照。
name 名前。URLエンコードをして指定。
tags タグ。URL SafeなBase64エンコードをして指定。複数指定はカンマ区切りで、タグ毎にエンコードします。
created_after 作成日時の開始点(UNIX timestamp)。
created_before 作成日時の終了点(UNIX timestamp)。
updated_after 更新日時の開始点(UNIX timestamp)。
updated_before 更新日時の終了点(UNIX timestamp)。
sort ソート。下記表参照。
offset 取得開始位置。 any を指定すると、 sort をもとにした擬似的に無作為な順序になります。
limit 取得件数。最大10000。ただし、 offsetany の場合には最大20になります。
response レスポンスに含む追加データ。下記表参照。カンマ区切りで複数指定可。

owner_type

内容
anybody 全員
exclude_specified_ids owner_ids で指定した ID 以外

sort

デフォルトは昇順ソート。降順ソートには、名前の頭に’-‘を追加します。

名前 備考
data_id データ ID
size データサイズ
name 名前
type データタイプ
created_time 作成日時
updated_time 更新日時
owner_id オーナー ID

response

内容
meta_binary メタバイナリ
tags タグ
ratings 評価
url 有効期間30日のデータのURL

リクエスト例:

データタイプ 100 のデータを検索する。

GET /nex/datastore/v2/metainfo/search?type=100 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfos length="1" offset="0" total="100" total_type="exact">
      <metainfo>
        <data_id>10</data_id>
        <name>name</name>
        <owner_id>100</owner_id>
        <size>100</size>
        <type>100</type>
        <access_permission>
          <type>public</type>
          <recipient_ids length="0"/>
        </access_permission>
        <update_permission>
          <type>private</type>
          <recipient_ids length="0"/>
        </update_permission>
        <flags length="0"/>
        <period>30</period>
        <created_time>2013-01-01T00:00:00Z</created_time>
        <updated_time>2013-01-01T00:00:00Z</updated_time>
        <referred_time>2013-01-01T00:00:00Z</referred_time>
        <expire_time>2013-01-30T00:00:00Z</expire_time>
        <status>none</status>
        <referred_count>0</referred_count>
        <refer_data_id>0</refer_data_id>
      </metainfo>
    </metainfos>
  </datastore>
</nex>

meta_binary, tag にはURL SafeなBase64エンコードされた値が設定されます。

12.4.2.5. データのアップロード

12.4.2.5.1. アップロードの手順

12.4.2.5.1.1. 通常のデータ
  1. prepare でアップロード準備をします。 size にアップロードするデータのサイズをバイトで指定し、必要があれば他のパラメータを指定
  2. 成功するとデータのアップロード先などの情報が返ってくるので、それを元にデータをストレージサーバーへアップロード(multipart/form-dataで送る必要あり)
  3. 無事アップロードが完了したら、prepare で返ってきたデータ ID をパスに含め、complete
  4. 200が返ってきたら成功
12.4.2.5.1.2. メタバイナリのみ
  1. prepare でアップロード準備をします。 size は 0、 flagnot_use_storageserver とし、 meta_binary にアップロードするデータをURL SafeなBase64エンコードし指定
  2. 通常の場合と同様のxmlが返ってきたら成功。データ ID のみが設定されます
  3. complete は不要

12.4.2.5.2. アップロードの準備

データアップロードを準備します。

POST /nex/datastore/v2/data/prepare

リクエストボディ:

要素名 親要素 内容
prepare   ルート要素。 必須
size prepare アップロードするデータのサイズ。 必須
name prepare 名前。
owner_id prepare データのオーナーとなるプリンシパル ID。
type prepare データタイプ。初期値= 0
meta_binary prepare メタバイナリ。URL SafeなBase64エンコードをして指定。
flags prepare フラグ。子要素 flag で指定。
flag flags フラグ。下記表参照。複数指定可。
period prepare 有効日数。初期値= 90
refer_data_id prepare 関連付けるデータ ID。
access_permission prepare 参照権限。
update_permission prepare 更新権限。
type access_permission, update_permission 権限の種類。下記表参照。
recipient_ids access_permission, update_permission 権限の保有者。 typespecifiedspecified_friend の場合、子要素 recipient_id で指定。
recipient_id recipient_ids 権限の保有者。複数指定可。
tags prepare タグ。子要素 tag で指定。
tag tags タグ。URL SafeなBase64エンコードをして指定。複数指定可(最大16個)。
rating_init_params prepare 評価初期化パラメーター。子要素で指定。
param rating_init_params 評価初期化する各パラメーター。複数指定可(最大16個)。
slot param 評価スロット。
flags param 評価オプションフラグ。子要素 flag で指定。
flag flags 評価オプションフラグ。下記表参照。複数指定可。
initial_value param 評価の初期値。
range_min param 評価の最小値。
range_max param 評価の最大値。
lock param 重複ロック。子要素で指定。
type lock ロックの種類。下記表参照。
period_hour lock ロックを解除する時刻。 typeperiod の場合に有効。
period_duration lock ロックの期間。 typeinternal の場合はロックする秒数、 period の場合は日数。
persistence_init_param prepare 永続化パラメータ。子要素で指定。
slot persistence_init_param 永続化に使用するスロット。
delete_last_object persistence_init_param 以前のデータを削除するか、 1 (True)または 0 (False)で指定。

owner_id を指定しない場合は、公式ユーザーのプリンシパル ID (111) が使用されます。

flags/flag

内容
none 設定なし
need_review 管理者によるデータレビューが必要
period_from_last_referred データの参照、更新時に有効期限を延長する
use_notification_on_post データアップロード時に受信者に対して通知する
not_use_storageserver メタバイナリのみのデータでストレージサーバーは使用しない

access_permission/type, update_permission/type

内容
public 全体
friend フレンドのみ
specified 指定した相手のみ
private 自分のみ
specified_friend 指定した相手でかつ自分とフレンド関係にある

rating_init_params/param/flags/flag

内容
modifiable 変更可能にする
round_minus 加減算の結果負数になる場合0に丸める
disable_self_rating 自己評価をできなくする

rating_init_params/param/lock/type

内容
none 重複ロックをしない
interval 間隔によるロック
period 期限によるロック
permanent 永久ロック

リクエスト例:

100バイトのデータのアップロード準備をする。

POST /nex/datastore/v2/data/prepare HTTP/1.1

<prepare>
  <size>100</size>
</prepare>

レスポンスボディ:

要素名 親要素 内容
data   ルート要素。
data_id data データ ID。complete時に指定します。メタバイナリのみのアップロードでは、この値のみ設定されます。
url data ストレージサーバーへのリクエストURL。https://でリクエストします。
request_header data ストレージサーバーへのリクエストヘッダ。
date request_header 日付。
post_param data ストレージサーバーへのリクエストパラメータ。
policy post_param ポリシー。
AWSAccessKeyId post_param アクセスキー。
signature post_param シグネチャ。
key post_param データの場所を示すキー。
acl post_param アクセスコントロール。

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data>
      <url>dev.example.org/</url>
      <request_header>
        <date>Wed, 01 Jan 2013 00:00:00 GMT</date>
      </request_header>
      <post_param>
        <policy>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</policy>
        <AWSAccessKeyId>XXXXXXXXXXXXXXXXXXXX</AWSAccessKeyId>
        <signature>XXXXXXXXXXXXXXXXXXXX</signature>
        <key>XXXXXXXXXXXXXXXXXXXX</key>
        <acl>private</acl>
      </post_param>
      <data_id>10</data_id>
    </data>
  </datastore>
</nex>

12.4.2.5.3. アップロードの完了

データアップロードを完了します。

POST /nex/datastore/v2/data/complete/(data_id)

パラメーター:

名前 内容
data_id 完了するデータ ID。 必須

リクエストボディ:

要素名 親要素 内容
complete   ルート要素。
owner_id complete データのオーナーとなるプリンシパル ID。

owner_id を指定しない場合は、公式ユーザーのプリンシパル ID (111) が使用されます。

リクエスト例:

prepareでデータ ID 10 と返されたデータのアップロードを完了する。

POST /nex/datastore/v2/data/complete/10 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK

12.4.2.6. URLの取得

GET /nex/datastore/v2/urlinfo/(data_id)

1つのデータ data_id のURLを取得します。

パラメーター:

名前 内容
data_id URLを取得するデータ ID。 必須
period URLの有効日数。初期値= 30

リクエスト例:

データ ID 10 のURLを取得する。

GET /nex/datastore/v2/urlinfo/10 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <urlinfos length="1">
      <urlinfo>
        <data_id>10</data_id>
        <url>dev.example.org</url>
      </urlinfo>
    </urlinfos>
  </datastore>
</nex>
GET /nex/datastore/v2/urlinfo

複数のデータのURLを取得します。

パラメーター:

名前 内容
data_ids URLを取得するデータ ID。カンマ区切りで複数指定可(最大100個)。 必須
period URLの有効日数。初期値= 30

リクエスト例:

データ ID 10, 20, 30 のURLを取得する。

GET /nex/datastore/v2/urlinfo?data_ids=10,20,30 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <urlinfos length="3">
      <urlinfo>
        <data_id>10</data_id>
        <url>dev1.example.org</url>
      </urlinfo>
      <urlinfo>
        <data_id>20</data_id>
        <url>dev2.example.org</url>
      </urlinfo>
      <urlinfo>
        <data_id>30</data_id>
        <url>dev3.example.org</url>
      </urlinfo>
    </urlinfos>
  </datastore>
</nex>

12.4.2.7. パスワードの取得

GET /nex/datastore/v2/passwordinfo/(data_id)

1つのデータ data_id のパスワードを取得します。

パラメーター:

名前 内容
data_id パスワードを取得するデータ ID。 必須

リクエスト例:

データ ID 10 のパスワードを取得する。

GET /nex/datastore/v2/passwordinfo/10 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <passwordinfos length="1">
      <passwordinfo>
        <access_password>XXXXXXXXXXXXXXXXXXXX</access_password>
        <update_password>XXXXXXXXXXXXXXXXXXXX</update_password>
        <data_id>10</data_id>
      </passwordinfo>
    </passwordinfos>
  </datastore>
</nex>
GET /nex/datastore/v2/passwordinfo

複数のデータのパスワードを取得します。

パラメーター:

名前 内容
data_ids パスワードを取得するデータ ID。カンマ区切りで複数指定可(最大100個)。 必須

リクエスト例:

データ ID 10, 20, 30 のパスワードを取得する。

GET /nex/datastore/v2/passwordinfo?data_ids=10,20,30 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <passwordinfos length="3">
      <passwordinfo>
        <access_password>XXXXXXXXXXXXXXXXXXXX</access_password>
        <update_password>XXXXXXXXXXXXXXXXXXXX</update_password>
        <data_id>10</data_id>
      </passwordinfo>
      <passwordinfo>
        <access_password>YYYYYYYYYYYYYYYYYYYY</access_password>
        <update_password>YYYYYYYYYYYYYYYYYYYY</update_password>
        <data_id>20</data_id>
      </passwordinfo>
      <passwordinfo>
        <access_password>ZZZZZZZZZZZZZZZZZZZZ</access_password>
        <update_password>ZZZZZZZZZZZZZZZZZZZZ</update_password>
        <data_id>30</data_id>
      </passwordinfo>
    </passwordinfos>
  </datastore>
</nex>

12.4.2.8. データの評価

12.4.2.8.1. データの評価

データを評価します。

PUT /nex/datastore/v2/metainfo/(data_id)/ratings/(slot)
POST /nex/datastore/v2/metainfo/(data_id)/ratings/(slot)/put

1つのデータ data_id を、評価スロット slot を使用し評価します。

パラメーター:

名前 内容
data_id 評価するデータ ID。 必須
slot 使用する評価スロット。 必須

リクエストボディ:

要素名 親要素 内容
rate   ルート要素。 必須
rating_value rate 評価値。 必須

リクエスト例:

データ ID 10 を、評価スロット 0 を使用し、100 と評価する。

PUT /nex/datastore/v2/metainfo/10/ratings/0 HTTP/1.1

<rate>
  <rating_value>100</rating_value>
</rate>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfo>
      <ratings>
        <rating>
          <slot>0</slot>
          <count>1</count>
          <initial_value>0</initial_value>
          <total_value>100</total_value>
          <data_id>10</data_id>
        </rating>
      </ratings>
    </metainfo>
  </datastore>
</nex>
PUT /nex/datastore/v2/metainfo/ratings
POST /nex/datastore/v2/metainfo/ratings/put

複数のデータ・評価スロットを評価します。

リクエストボディ:

要素名 親要素 内容
rate   ルート要素。 必須
param rate 評価するデータ・スロット。複数指定可(最大100個)。 必須
data_id param 評価するデータ ID。 必須
slot param 使用する評価スロット。 必須
rating_value param 評価値。 必須
principal_id rate 評価者となるユーザーのプリンシパル ID。指定がない場合、公式ユーザーのプリンシパル ID (111) が使用されます。

リクエスト例:

以下の通り評価する。

  • データ ID 10・評価スロット 0 を、100と評価
  • データ ID 20・評価スロット 0 を、200と評価
  • データ ID 20・評価スロット 1 を、210と評価
PUT /nex/datastore/v2/metainfo/ratings HTTP/1.1

<rate>
  <param>
    <data_id>10</data_id>
    <slot>0</slot>
    <rating_value>100</rating_value>
  </param>
  <param>
    <data_id>20</data_id>
    <slot>0</slot>
    <rating_value>200</rating_value>
  </param>
  <param>
    <data_id>20</data_id>
    <slot>1</slot>
    <rating_value>210</rating_value>
  </param>
</rate>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfo>
      <ratings>
        <rating>
          <slot>0</slot>
          <count>1</count>
          <initial_value>0</initial_value>
          <total_value>100</total_value>
          <data_id>10</data_id>
        </rating>
        <rating>
          <slot>0</slot>
          <count>1</count>
          <initial_value>0</initial_value>
          <total_value>200</total_value>
          <data_id>20</data_id>
        </rating>
        <rating>
          <slot>1</slot>
          <count>1</count>
          <initial_value>0</initial_value>
          <total_value>210</total_value>
          <data_id>20</data_id>
        </rating>
      </ratings>
    </metainfo>
  </datastore>
</nex>

12.4.2.8.2. 評価のリセット

DELETE /nex/metainfo/(data_id)/ratings
POST /nex/metainfo/(data_id)/ratings/delete

1つのデータ data_id の評価をリセットします。

パラメーター:

名前 内容
data_id 評価をリセットするデータ ID。 必須

リクエスト例:

データ ID 10 の評価をリセットする。

DELETE /nex/datastore/v2/metainfo/10/ratings HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfo>
      <ratings>
        <reset length="1" />
      </ratings>
    </metainfo>
  </datastore>
</nex>
POST /nex/metainfo/ratings/delete

複数のデータの評価をリセットします。

リクエストボディ:

要素名 親要素 内容
reset   ルート要素。 必須
param reset 評価をリセットするデータ。複数指定可(最大100個)。 必須
data_id param 評価をリセットするデータ ID。 必須

リクエスト例:

データ ID 10, 20 の評価をリセットする。

POST /nex/datastore/v2/metainfo/ratings/delete HTTP/1.1

<reset>
  <param>
    <data_id>10</data_id>
  </param>
  <param>
    <data_id>20</data_id>
  </param>
</reset>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <metainfo>
      <ratings>
        <reset length="2" />
      </ratings>
    </metainfo>
  </datastore>
</nex>

12.4.2.9. データの永続化

12.4.2.9.1. 永続化情報の取得

データの永続化情報を取得します。

GET /nex/datastore/v2/persistenceinfo/(principal_id)/(slot)

principal_id の永続化スロット slot の永続化情報を取得します。

パラメーター:

名前 内容
principal_id 取得する永続化情報を持つプリンシパル ID。 必須
slot 取得する永続化スロット。 必須

リクエスト例:

プリンシパル ID 100 の、永続化スロット 0 にある情報を取得する。

GET /nex/datastore/v2/persistenceinfo/100/0 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <persistenceinfos length="1">
      <persistenceinfo>
        <principal_id>100</principal_id>
        <data_id>10</data_id>
        <slot>0</slot>
      </persistenceinfo>
    </persistenceinfos>
  </datastore>
</nex>
GET /nex/datastore/v2/persistenceinfo

複数スロットの永続化情報を取得します。

パラメーター:

名前 内容
principal_id 取得する永続化情報を持つプリンシパル ID。 必須
slots 取得する永続化スロット。カンマ区切りで複数指定可(最大16個)。 必須

リクエスト例:

プリンシパル ID 100 の、永続化スロット 0, 1, 2 にある情報を取得する。

GET /nex/datastore/v2/persistenceinfo?principal_id=100&slots=0,1,2 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <persistenceinfos length="1">
      <persistenceinfo>
        <principal_id>100</principal_id>
        <data_id>10</data_id>
        <slot>0</slot>
      </persistenceinfo>
      <persistenceinfo>
        <principal_id>100</principal_id>
        <data_id>11</data_id>
        <slot>1</slot>
      </persistenceinfo>
      <persistenceinfo>
        <principal_id>100</principal_id>
        <data_id>12</data_id>
        <slot>2</slot>
      </persistenceinfo>
    </persistenceinfos>
  </datastore>
</nex>

12.4.2.9.2. データの永続化

データを永続化します。

PUT /nex/datastore/v2/persistenceinfo/(principal_id)/(slot)
POST /nex/datastore/v2/persistenceinfo/(principal_id)/(slot)/put

principal_id の永続化スロット slot を使用し、データを永続化します。

パラメーター:

名前 内容
principal_id 永続化させるプリンシパル ID。 必須
slot 永続化に使用するスロット。 必須

リクエストボディ:

要素名 親要素 内容
perpetuate   ルート要素。 必須
data_id perpetuate 永続化するデータのデータ ID。 必須
delete_last_object perpetuate 以前のデータを削除するか、 1 (True)または 0 (False)で指定。初期値= 1

リクエスト例:

データ ID 10 のデータを、プリンシパル ID 100 の永続化スロット 0 を使用し、永続化する。

PUT /nex/datastore/v2/persistenceinfo/100/0 HTTP/1.1

<perpetuate>
  <data_id>10</data_id>
</perpetuate>

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <persistenceinfo>
      <perpetuated length="1" />
    </persistenceinfo>
  </datastore>
</nex>

12.4.2.9.3. データの非永続化

永続化データを非永続化します。

DELETE /nex/datastore/v2/persistenceinfo/(principal_id)/(slot)
POST /nex/datastore/v2/persistenceinfo/(principal_id)/(slot)/delete

principal_id の永続化スロット slot にある永続化データを非永続化します。

パラメーター:

名前 内容
principal_id 非永続化させるプリンシパル ID。 必須
slots 非永続化に使用するスロット。 必須

リクエストボディ:

POST時のみ使用できます。

要素名 親要素 内容
unperpetuate   ルート要素。
delete_last_object unperpetuate 非永続化したデータを削除するか、 1 (True)または 0 (False)で指定。初期値= 0

リクエスト例:

プリンシパル ID 100 の永続化スロット 0 にある永続化データを、非永続化する。

DELETE /nex/datastore/v2/persistenceinfo/100/0 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <persistenceinfo>
      <unperpetuated length="1" />
    </persistenceinfo>
  </datastore>
</nex>

12.4.2.10. データコード文字列の変換

12.4.2.10.1. データコード文字列をデータ ID に変換する

GET /nex/datastore/v2/data_code/code_to_id/(data_code_string)

data_code_string をデータ ID に変換します。

パラメーター:

名前 内容
data_code_string 変換するデータコード文字列。 必須
key チェックサム算出用の鍵。指定しない場合はサーバーのアクセスキーを使用します。

リクエスト例:

データコード文字列 2WGVF71 のデータ ID を取得する。

GET /nex/datastore/v2/data_code/code_to_id/2WGVF71 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data_codes length="1">
      <data_code>
        <data_code_string>2WGVF71</data_code_string>
        <data_id>1000000</data_id>
      </data_code>
    </data_codes>
  </datastore>
</nex>
GET /nex/datastore/v2/data_code/code_to_id

複数のデータコード文字列をデータ ID に変換します。

パラメーター:

名前 内容
data_code_strings 変換するデータコード文字列。カンマ区切りで複数指定可(最大 100 個)。 必須
key チェックサム算出用の鍵。指定しない場合はサーバーのアクセスキーを使用します。

リクエスト例:

データコード文字列 2WGVF71,2VHJ5NN のデータコード文字列を取得する。

GET /nex/datastore/v2/data_code/code_to_id?data_code_strings=2WGVF71,2VHJ5NN HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data_codes length="2">
      <data_code>
        <data_code_string>2WGVF71</data_code_string>
        <data_id>1000000</data_id>
      </data_code>
      <data_code>
        <data_code_string>2VHJ5NN</data_code_string>
        <data_id>1000001</data_id>
      </data_code>
    </data_codes>
  </datastore>
</nex>

12.4.2.10.2. データ ID をデータコード文字列に変換する

GET /nex/datastore/v2/data_code/id_to_code/(data_id)

data_id をデータコード文字列に変換します。

パラメーター:

名前 内容
data_id 変換するデータ ID。 必須
key チェックサム算出用の鍵。指定しない場合はサーバーのアクセスキーを使用します。

リクエスト例:

データ ID 1000000 のデータコード文字列を取得する。

GET /nex/datastore/v2/data_code/id_to_code/1000000 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data_codes length="1">
      <data_code>
        <data_code_string>2WGVF71</data_code_string>
        <data_id>1000000</data_id>
      </data_code>
    </data_codes>
  </datastore>
</nex>
GET /nex/datastore/v2/data_code/id_to_code

複数のデータ ID をデータコード文字列に変換します。

パラメーター:

名前 内容
data_ids 変換するデータ ID。カンマ区切りで複数指定可(最大 100 個)。 必須
key チェックサム算出用の鍵。指定しない場合はサーバーのアクセスキーを使用します。

リクエスト例:

データ ID 1000000,1000001 のデータコード文字列を取得する。

GET /nex/datastore/v2/data_code/id_to_code?data_ids=1000000,1000001 HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK
Content-Type:  text/xml;charset=utf-8

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <datastore>
    <data_codes length="2">
      <data_code>
        <data_code_string>2WGVF71</data_code_string>
        <data_id>1000000</data_id>
      </data_code>
      <data_code>
        <data_code_string>2VHJ5NN</data_code_string>
        <data_id>1000001</data_id>
      </data_code>
    </data_codes>
  </datastore>
</nex>