12.7. ユーティリティ

12.7.1. 一般情報

モジュール名 utility
APIバージョン 1

12.7.2. アプリケーション向けの設定値の管理

12.7.2.1. 設定インデックスの取得

GET /nex/utility/v1/application_setting/setting_index/integer

整数設定値が登録されている設定インデックスを取得します。

リクエスト例:

GET /nex/utility/v1/application_setting/setting_index/integer HTTP/1.1

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <setting_indexes length="2">
      <setting_index>0</setting_index>
      <setting_index>1</setting_index>
    </setting_indexes>
  </utility>
</nex>

12.7.2.2. 指定された設定インデックスの設定値の取得

GET /nex/utility/v1/application_setting/integer/(setting_index)

指定された設定インデックスに登録されている整数設定値を取得します。

リクエスト例:

GET /nex/utility/v1/application_setting/integer/0 HTTP/1.1

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <settings length="2">
      <setting>
        <setting_index>0</setting_index>
        <value>10</value>
        <key>0</key>
        <description>desc-00</description>
      </setting>
      <setting>
        <setting_index>0</setting_index>
        <value>20</value>
        <key>1</key>
        <description>desc-01</description>
      </setting>
    </settings>
  </utility>
</nex>

12.7.2.3. 全ての設定値を取得

GET /nex/utility/v1/application_setting/integer

登録されている全ての整数設定値を取得します。

リクエスト例:

GET /nex/utility/v1/application_setting/integer HTTP/1.1

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <settings length="3">
      <setting>
        <setting_index>0</setting_index>
        <value>10</value>
        <key>0</key>
        <description>desc-00</description>
      </setting>
      <setting>
        <setting_index>0</setting_index>
        <value>20</value>
        <key>1</key>
        <description>desc-01</description>
      </setting>
      <setting>
        <setting_index>1</setting_index>
        <value>-1</value>
        <key>0</key>
        <description>desc-01</description>
      </setting>
    </settings>
  </utility>
</nex>

12.7.2.4. 設定値の登録

PUT /nex/utility/v1/application_setting/integer
POST /nex/utility/v1/application_setting/integer/put

整数設定値を登録します。 指定した設定インデックスとキーにすでに設定が登録されている場合は、設定値を上書きします。

リクエストボディ

要素名 親要素 内容
change   ルート要素。 必須
param change 登録するデータを指定する。複数指定可。 必須
setting_index param 設定インデックス。 必須
key param キー。 必須
value param 値。 必須
description param 説明。 必須

リクエスト例:

PUT /nex/utility/v1/application_setting/integer HTTP/1.1

<change>
  <param>
    <setting_index>0</setting_index>
    <key>0</key>
    <value>10</value>
    <description>desc-00</description>
  </param>
  <param>
    <setting_index>0</setting_index>
    <key>1</key>
    <value>20</value>
    <description>desc-01</description>
  </param>
  <param>
    <setting_index>1</setting_index>
    <key>0</key>
    <value>-1</value>
    <description>desc-01</description>
  </param>
</change>

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <settings>
      <changed length="3"/>
    </settings>
  </utility>
</nex>

length は登録された設定の数。

12.7.2.5. 設定インデックスを指定した設定値の削除

POST /nex/utility/v1/application_setting/integer/(setting_index)/delete

指定された設定インデックスに登録された整数設定値を削除する。

リクエストボディ:

要素名 親要素 内容
delete   ルート要素。 必須
param change 登録するデータを指定する。複数指定可。 必須
key param キー。 必須

リクエストボディでキーを指定した場合は、そのキーの整数設定値のみを削除する。 リクエストボディが空の場合は、指定された設定インデックスに登録された全ての整数設定値を削除する。

リクエスト例:

POST /nex/utility/v1/application_setting/integer/0/delete HTTP/1.1

<delete>
  <param>
    <key>0</key>
  </param>
  <param>
    <key>1</key>
  </param>
</delete>

レスポンス例:

HTTP/1.1 200 OK

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

12.7.2.6. 全ての設定値の削除

DELETE /nex/utility/v1/application_setting/integer
POST /nex/utility/v1/application_setting/integer/delete

全ての整数設定値を削除する。

リクエスト例:

DELETE /nex/utility/v1/application_setting/integer HTTP/1.1

レスポンス例:

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <settings>
      <deleted length="3"/>
    </settings>
  </utility>
</nex>

12.7.2.7. 指定された設定インデックスの既存設定値をクリアしてから設定値を登録

POST /nex/utility/v1/application_setting/integer/(setting_index)/replace

指定された設定インデックスに登録されている既存の整数設定値をクリアしてから、設定値を登録する。

リクエストボディ

要素名 親要素 内容
change   ルート要素。 必須
param change 登録するデータを指定する。複数指定可。 必須
setting_index param 設定インデックス。URL 中の設定インデックスと異なる値を指定した場合はエラーになる。指定しなかった場合は URL 中の設定インデックスを対象とする。
key param キー。 必須
value param 値。 必須
description param 説明。 必須

リクエスト例:

POST /nex/utility/v1/application_setting/integer/0/replace HTTP/1.1

<change>
  <param>
    <setting_index>0</setting_index>
    <key>0</key>
    <value>-1</value>
    <description>desc-00</description>
  </param>
</change>

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <settings>
      <deleted length="2"/>
      <set length="1"/>
    </settings>
  </utility>
</nex>

deleted はクリアされた設定の数で、length は登録された設定の数。

12.7.2.8. 全ての既存設定値をクリアしてから設定値を登録

POST /nex/utility/v1/application_setting/integer/replace

既存の全ての整数設定をクリアしてから、設定値を登録する。

リクエストボディ

要素名 親要素 内容
change   ルート要素。 必須
param change 登録するデータを指定する。複数指定可。 必須
setting_index param 設定インデックス。 必須
key param キー。 必須
value param 値。 必須
description param 説明。 必須

リクエスト例:

POST /nex/utility/v1/application_setting/integer/replace HTTP/1.1

<change>
  <param>
    <setting_index>0</setting_index>
    <key>0</key>
    <value>-1</value>
    <description>desc-00</description>
  </param>
  <param>
    <setting_index>1</setting_index>
    <key>0</key>
    <value>-10</value>
    <description>desc-10</description>
  </param>
</change>

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <settings>
      <deleted length="3"/>
      <set length="2"/>
    </settings>
  </utility>
</nex>

deleted はクリアされた設定の数で、length は登録された設定の数。

12.7.3. 共通API

共通 API では URL 中のバージョン指定は不要です。

12.7.3.1. バージョン情報の取得

バージョン情報を取得します。

GET /nex/utility/version

レスポンス例:

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

<?xml version="1.0" encoding="UTF-8"?>
<nex>
  <utility>
    <ngs_version>3.9.0.</ngs_version>
    <api_version>1</api_version>
  </utility>
</nex>

ngs_versoin

NGSのバージョンを表す文字列で、フォーマットは「(メジャーバージョン).(マイナーバージョン).(マイクロバージョン).(パッチバージョン)」になります。 パッチバージョンは通常は空文字で、個別タイトル向けの特別版ではイニシャルコードが設定されます。