水道情報活用システム
基本仕様書

別冊

機器ベンダー向け
標準インターフェイス(システム)
仕様書
WPSC004 EDITION 1.1

2021 年 2 月

水道情報活用システム標準仕様研究会

WPSC004-Ed.1.1 2021-02

本書は、国立研究開発法人 新エネルギー・産業技術総合開発機構「IoT を活用した新産業モデ
ル創出基盤整備事業」における「水道 IoT の社会実装推進に向けた検討」、及び「高度なデー
タ活用を可能とする社会インフラ運営システムの開発」事業により作成されたものに、経済産業省補助事業（補助事業者：株式会社 JECC）「水道施設情報整備促進事業」により改定され、水道情報活用システム標準仕様研究会により改定されました。
WPSC004-Ed.1.1 2021-02

水道情報活用システム標準仕様研究会及び本ドキュメント(本使用許諾条件に添付されて提供されるドキュメントをいい、以下同じ)の原著作権者である国立研究開発法人新エネルギー・産業
技術総合開発機構、（以下「当研究会等」と総称します）は、以下の条件のもとで本ドキュメン
トを使用、複製および頒布することを無償で許諾します。本ドキュメントを使用、複製または頒布した場合には、以下の条件に同意したものとします。
1. 本ドキュメントの中に含まれる著作権表示および本使用許諾条件を、本ドキュメントの全部または一部を複製したものに表示してください。
2. 本ドキュメントを使用したサービスの提供を含め営利目的に本ドキュメントを使用することができますが、本ドキュメントのみを単独で販売することはできません。
3. 第４項に定める場合を除き、本ドキュメントを使用したサービスの提供に際して、事前の書面による当研究会等の許可なく、それらの宣伝、広告活動に当研究会等の名称を使用することはできません。
4. 本ドキュメントを使用して得られた結果を、形態を問わず、出版、発表において公表する場
合には、本ドキュメントと当研究会等の名称を引用等において明示してください。
5. 本ドキュメントは現状有姿で提供されるものであり、当研究会等は、本ドキュメントに関して、商品性および特定目的への適合性、エラー・バグ等の不具合のないこと、第三者の特許権、実用新案権、意匠権、商標権、著作権その他の知的財産権を侵害するものではないこと
を含め、明示たると黙示たるとを問わず、一切の保証を行わないものとします。また、当研究会等は、本ドキュメントの誤りの修正その他いかなる保守についても義務を負うものではありません。
6. 当研究会等は、本ドキュメントの使用または使用不能、複製、頒布、その他本ドキュメント
または本使用許諾条件の規定に関連して生じたいかなる損害(特別損害、間接損害、逸失利
益を含みますが、これに限りません)または第三者からのいかなる請求についても、法律上の根拠を問わず一切責任を負いません。当研究会等がかかる損害または請求の可能性について知らされていた場合も同様とします。
7. 本ドキュメントは、一般事務用、家庭用、通常の産業用等の一般的用途を想定して作成されているものであり、原子力施設における核反応制御、航空機自動飛行制御、航空交通管制、
大量輸送システムにおける運行制御、生命維持のための医療用機器、兵器システムにおけるミサイル発射制御など、極めて高度な安全性が要求され、仮に当該安全性が確保されない場
合、直接生命・身体に対する重大な危険性を伴う用途(以下「ハイセイフティ用途」という)を想定して作成されたものではなく、当該ハイセイフティ用途に要する安全性を確保する措置を施すことなく、本ドキユメントを使用しないものとします。また、ハイセイフティ用途に本ドキュメントを使用したことにより発生する、いかなる請求または損害賠償に対しても当研究会等は一切の責任を負わないものとします。

WPSC004-Ed.1.1 2021-02

- 目次 –

1. はじめに ........................................................................ 1
1.1 本ドキュメントの目的 ......................................................... 1
1.2 水道情報活用システム標準仕様のドキュメント.................................... 2
ドキュメント体系 .......................................................... 2
対象読者と役割 ............................................................ 3
本書の対象読者 ............................................................ 4
1.3 参考文献 ..................................................................... 5
1.4 用語の説明 ................................................................... 8
1.5 本ドキュメントの記載範囲 .................................................... 10
2. システムゲートウェイ利用までに必要な事前準備 ................................... 11
2.1 ゲートウェイ登録 ............................................................ 12
2.2 システム系データモデル登録 .................................................. 13
2.3 ゲートウェイ接続 ............................................................ 14
2.4 ゲートウェイ切断 ............................................................ 16
3. 機器ベンダー向け標準インターフェイス（システム）仕様 ............................ 17
3.1 インターフェイス一覧 ........................................................ 17
3.2 プロトコル .................................................................. 18
3.3 セキュリティ ................................................................ 23
3.4 データの分割送信 ............................................................ 24
3.5 基本的な処理の流れ .......................................................... 26
ゲートウェイ接続 ......................................................... 26
ゲートウェイ切断 ......................................................... 27
4. インターフェイス仕様 ........................................................... 28
4.1 ゲートウェイ接続インターフェイス ............................................ 29
4.2 ゲートウェイ切断インターフェイス ............................................ 35
4.3 要求データ取得共通インターフェイス .......................................... 40
4.4 定周期データ蓄積インターフェイス ............................................ 44
4.5 公開鍵証明書ファイル取得インターフェイス .................................... 56
WPSC004-Ed.1.1 2021-02

5. データプロパティ仕様 ........................................................... 60
5.1 データ蓄積(定周期)データのプロパティ仕様 .................................... 60
5.2 ゲートウェイ接続情報のプロパティ仕様 ........................................ 60
6. 機器ベンダー向け標準インターフェイス(システム) フォーマット例 ................... 61

WPSC004-Ed.1.1 2021-02

1. はじめに1.1 本ドキュメントの目的
本ドキュメントは、社会インフラ水道情報活用システム(以下、水道情報活用システム)標準
仕様における基本仕様書の別冊である。
基本仕様書では、水道情報活用システムを実現する基本仕様として、水道情報活用システムの全体構成と基本的に守るべきルール、標準インターフェイスを規定している。
本ドキュメントは、基本仕様書で規定した標準インターフェイスの一つである機器ベンダー
向け標準インターフェイス(システム)仕様を記載したドキュメントである。
本ドキュメントにより、システムゲートウェイ・システムベンダーが、システムゲートウェ
イを水道標準プラットフォームへ初期接続する際にどのような仕様で接続し、運用時にどのような仕様でデータの取得や追加などのデータ操作を行えばよいかを理解することを目的とする。

1
WPSC004-Ed.1.1 2021-02

1.2 水道情報活用システム標準仕様のドキュメント
ドキュメント体系
水道情報活用システム標準仕様のドキュメント体系を以下に示す（図 1-1）。

水道情報活用システム
基本仕様書(WPSC001)

アプリベンダー向け
標準インターフェイス
仕様書(WPSC002)
機器ベンダー向け
標準インターフェイス（デバイス）仕様書(WPSC003)
機器ベンダー向け
標準インターフェイス（システム）仕様書(WPSC004)

IoT ゲートウェイ
外部仕様書(WPSC009)

システムゲートウェイ
外部仕様書(WPSC010)

水道標準プラットフォーム
外部仕様書(WPSC005)

水道 CPS データ
プロファイル仕様書(WPSC006)

CPS/IoT セキュリティ
仕様書(WPSC007)ドキュメント名称/略称

初期情報設定シート(WPSC008)(ドキュメント番号)：水道情報活用システム
基本仕様書：水道情報活用システム
基本仕様書 別冊
：本書

マッピングベンダー向け
データ共有仕様書(WPSC011)

標準汎用インターフェイス
仕様書(WPSC012)

図 1-1: ドキュメント体系

2
WPSC004-Ed.1.1 2021-02

対象読者と役割
水道情報活用システム標準仕様の対象読者と役割を以下に示す。
① 事業体：
水道情報活用システム上のアプリケーションを利用して、デバイス・システムのデータを活用したサービスを享受する事業体。
② アプリケーション開発ベンダー：
水道情報活用システム上のアプリケーションを開発し、デバイス・システムのデータを活用したサービスを事業体に提供するベンダー。
③ システムゲートウェイ・デバイスベンダー：
水道情報活用システム上のシステムゲートウェイを開発し、デバイスのデータを水道
標準プラットフォームへ流通するベンダー。
④ システムゲートウェイ・システムベンダー：
水道情報活用システム上のシステムゲートウェイを開発し、各種台帳システムや料金システム等の業務システムのデータを水道標準プラットフォームへ流通するベンダー。
⑤ プラットフォーマー：水道情報活用システム上の水道標準プラットフォームを提供し、デバイス・システムのデータを流通するサービス提供および運営を行う第三者機関。
⑥ システムインテグレーター：
水道情報活用システム全体の設計を行い、アプリケーション開発ベンダーや IoT ゲー
トウェイ・デバイスベンダー、システムゲートウェイ・システムベンダーを統率し、水道情報活用システムを事業体に導入するベンダー。

3
WPSC004-Ed.1.1 2021-02

本書の対象読者
本書の対象読者を以下に示す（表 1-1)。
水道情報活用システム 基本仕様書は、(1)～(6)の対象読者が必ず参照すべきドキュメントである。その別冊の各仕様書は、読者の役割に応じて参照すべきドキュメントである。
表 1-1: 仕様書別対象読者
対象読者
ドキュメン

WPSC001

WPSC002

WPSC003(1)～(6)は 1.2.2 項参照

ドキュメント名称
ト番号

水道情報活用システム

基本仕様書

水道情報活用システム

基本仕様書

別冊

アプリベンダー向け標準インターフェイス仕様書
水道情報活用システム

基本仕様書

別冊

(1)

(2)

(3)

(4)

(5)

(6)

○

○

○

○

○

〇

－

○

－

－

○

〇

－

－

○

－

○

〇

－

－

－

○

○

〇

－

△

△

△

○

△

－

○

○

－

○

〇

－

○

○

○

○

〇

○

△

△

△

○

〇

－

－

○

－

－

〇

－

－

－

○

－

〇

△

○

－

△

－

〇

△

○

〇

－

△

〇

機器ベンダー向け標準インターフェイス(デバイス)仕様書
WPSC004

WPSC005

WPSC006

WPSC007

水道情報活用システム

WPSC009

WPSC010WPSC011

WPSC012

別冊

機器ベンダー向け標準インターフェイス(システム)仕様書
水道情報活用システム

基本仕様書

別冊

水道標準プラットフォーム外部仕様書
水道情報活用システム

基本仕様書

別冊

水道 CPS データプロファイル仕様書
水道情報活用システム

基本仕様書

別冊

CPS/IoT セキュリティ仕様書
水道情報活用システム
WPSC008

基本仕様書

基本仕様書

別冊

初期情報設定シート
水道情報活用システム

基本仕様書

別冊

IoT ゲートウェイ外部仕様書
水道情報活用システム

基本仕様書

別冊

システムゲートウェイ外部仕様書
水道情報活用システム

基本仕様書

別冊

マッピングベンダー向けデータ共有仕様書
水道情報活用システム

基本仕様書

別冊

標準汎用インターフェイス仕様書〇：必読、 △：必要に応じて読む、－：読まなくてもよい：本書

4
WPSC004-Ed.1.1 2021-02

1.3 参考文献
水道情報活用システム標準仕様を参照する際の参考文献を以下に示す(表 1-2)。
表 1-2: 参考文献
No.

1

参考文献

ISO 8601

説明

日付と時刻の表記について規定する ISO による国際規格。
URL※：https://www.iso.org/iso-8601-date-and-time-format.html

水道標準プラットフォームで利用するメッセージングプロトコルで

2

MQTT Protocol
Specification

ある MQTT について、OASIS により規定されたプロトコル仕様。

URL※：
http://public.dhe.ibm.com/software/dw/webservices/wsmqtt/mqtt-v3r1.html

認証プロトコルについて規定する、OpenID ファウンデーションによ3

OpenID Connect

るプロトコル仕様。
URL※：http://www.openid.or.jp/document/

4

OpenID Connect
Core 1.0

水道標準プラットフォームで利用するアイデンティティ連携プロト
コル仕様。
URL※：http://openid.net/specs/openid-connect-core-1_0.html

Hypertext Transfer Protocol(HTTP/1.1)について規定する IETF に5

RFC 2616

よる技術仕様。
URL※：https://tools.ietf.org/html/rfc2616

暗号化通信プロトコルである HTTP over TLS(本ドキュメントでは
6

RFC 2818「HTTP(S)」と表記)について規定する、IETF によるプロトコル仕様。
URL※：https://tools.ietf.org/html/rfc2818

5
WPSC004-Ed.1.1 2021-02

No.

参考文献

説明

セキュアな通信を行うためのプロトコルである Transport Layer
7

RFC 5246

Security(TLS)について規定する、IETF によるプロトコル仕様。
URL※：https://tools.ietf.org/html/rfc5246

水道標準プラットフォームで利用する通信プロトコルである
8

RFC 6455

WebSocket について、IETF により公開されたプロトコル仕様。
URL※：https://tools.ietf.org/html/rfc6455

OpenID Connect のベースである OAuth 2.0 のトークン仕様について
9

RFC 6750

規定する、IETF による技術仕様。
URL※：https://tools.ietf.org/html/rfc6750

HTTP/1.1 におけるセマンティクスとコンテンツについて規定する
10

RFC 7231

IETF による技術仕様。
URL※：https://tools.ietf.org/html/rfc7231

XML Encryption
11

Syntax andProcessing

XML Signature
12

Syntax andProcessing

XML 暗号について規定する W3C 勧告。
URL※：http://www.w3.org/TR/xmlenc-core1/

XML 署名について規定する W3C 勧告。
URL※：http://www.w3.org/TR/xmldsig-core2/※: 2017 年 7 月時点の URL を参考に記載

6
WPSC004-Ed.1.1 2021-02

その他、参考にする報告書を以下に示す。
経済産業省「平成２８年度ＩｏＴ推進のための社会システム推進事業（スマート工場実証事
業）報告書」
http://www.meti.go.jp/policy/mono_info_service/mono/smart_mono/H28SmartFactory_Dat
aProfile_Security_Report.pdf
http://www.meti.go.jp/policy/mono_info_service/mono/smart_mono/H28SmartFactory_Dat
aProfile_Security_Report_Attachment1.pdf
http://www.meti.go.jp/policy/mono_info_service/mono/smart_mono/H28SmartFactory_Dat
aProfile_Security_Report_Attachment2.pd
経済産業省「平成２８年度ＩｏＴ推進のための社会システム推進事業（社会インフラ分野でのＩｏＴ活用のための基盤整備実証プロジェクト）」
http://www.meti.go.jp/meti_lib/report/H28FY/000060.pdf
http://www.meti.go.jp/meti_lib/report/H28FY/000061.pdf
http://www.meti.go.jp/meti_lib/report/H28FY/000062.pdf

7
WPSC004-Ed.1.1 2021-02

1.4 用語の説明
水道情報活用システム標準仕様で使用する用語の説明を以下に示す(表 1-3)。
表 1-3: 用語の説明
No.

1

用語

AI

コンピュータを使って学習・推論・判断等、人間の知能(Artificial Intelligence)の働きを人工的に実現するもの。

API
2

説明

(Application Programming
Interface)

ソフトウェアコンポーネントが互いにやり取りするのに使用するインターフェイスの仕様。

CPS/IoT を活用して、デバイス・システムのデータを流通
3

水道情報活用システム

させ、データを活用した付加価値の高いサービスを提供するシステム。

4

DUNS Number

ダンアンドブラッドストリート（D&B）社が開発した 9 桁(Data Universal Numberingの企業識別コードのことで、世界の企業を一意に識別でSystem Number)

きる企業コーFQDN
5(Fully Qualified Domain
Name)

IANA
6

(Internet Assigned Numbers
Authority)

完全修飾ドメイン名。ホスト名とドメイン名などすべてを省略せずに指定した文字列。

IP アドレス・ドメイン名・ポート番号等の標準化・割り当て等インターネットに関連する番号を管理する組織。

国際的な流通標準化機関である GS1 が定める国際標準の
7

JAN コード

識別コードを設定するために必要となるコード。国際的(Japanese Article Number)には GS1 Company Prefix と呼ばれ、日本では最初の 2 桁が「45」又は「49」で始まる 9 桁又は 7 桁の番号。

MIME タイプ
8(Multipurpose Internet Mail
Extension)

IANA に登録されている、転送するデータの種類や形式を判別する為の識別子。

8
WPSC004-Ed.1.1 2021-02

No.

9

10

用語

TDB 企業コード(Teikoku Data Bank)

耐タンパー性説明
帝国データバンクが独自に取材・収集した企業情報に加え、各種公的情報を基に、1 社＝1 コードとして厳格に設定した数字 9 桁の企業識別コード。

非正規な手段による外部からの解析が容易に出来ないよ
う、データの読み取りや改ざんを防ぐ能力。

「平成 28 年度 IoT 推進のための社会システム推進事業
11

データプロファイル（スマート工場実証事業）」の成果物であり、水道情報
活用システム上でデータをやり取りする際のデータ流通
のルール。

12

パディング

決められたデータの長さに対してデータが短い場合に、データを追加してデータの長さを合わせる処理。

一般財団法人日本情報経済社会推進協会(JIPDEC)が一元的に管理する、企業を識別する業界横断的な企業コー
13

標準企業コード

ド。
企業を一意に識別できる 6 桁の企業識別コードと、各企業が採番、管理を行う 6 桁の枝番で構成される。
パケット通信において、データの転送先や転送経路など

14

ペイロードデータを制御するための情報を含むヘッダや、データの破損などを検査するトレーラなどの付加的情報を除いた、ユーザーが送信したいデータ本体。

15

メッセージダイジェスト

16

リダイレクト17

レルム名

任意の長さの文字列を固定長のビット列に変換するアルゴリズム。

ウェブサイトを訪れたユーザーを、自動的に他のウェブページに転送する処理。

それぞれのレルム(同一の認証ポリシーを適用する範囲)を識別する名称。

9
WPSC004-Ed.1.1 2021-02

1.5 本ドキュメントの記載範囲
本ドキュメントは、水道情報活用システムにおける標準インターフェイスの内、機器ベンダ
ー向け標準インターフェイス(デバイス)仕様を示す。
本ドキュメントの記載範囲を以下に示す(図 1-2)。

図 1-2: 本ドキュメントの記載範囲

10
WPSC004-Ed.1.1 2021-02

2. システムゲートウェイ利用までに必要な事前準備
システムゲートウェイが利用可能になるまでに、事前に準備する初期情報設定の項目を以下に示す（表 2-1:システムゲートウェイ利用までに必要な事前準備項目）。初期情報設定の全体の流れは、初期情報設定シートの水道情報活用システムの利用開始までの全体の流れを参照。
なお証明書は、定期的に水道標準プラットフォームにて最新バージョンを更新するが、古いバージョンも一定期間保持する仕様となっている。アプリケーションやゲートウェイが初期
取得時のバージョンのまま運用するか、定期的に最新バージョンに更新するかは、水道標準
プラットフォームの導入時に選択できる。
表 2-1:システムゲートウェイ利用までに必要な事前準備項目
No

項目

内容
事業体がプラットフォーマーに対し、システムゲートウェイのシ

1

ゲートウェイ登録

ステムゲートウェイ設定情報を水道標準プラットフォームに登録する。詳細は、2.1 節を参照。

2

システム系データモデ
ル登録

プラットフォーマーが、設置した機器などの情報を、システム
系データモデルとして水道標準プラットフォームに登録する。
詳細は、2.2 節を参照。

事業体が、システムゲートウェイを水道標準プラットフォームに3

ゲートウェイ接続

接続する。
詳細は、2.3 節、3.5.1 項、4.1 節を参照。

既に水道標準プラットフォームへ接続しているシステムゲート
4

ゲートウェイ切断

ウェイを水道標準プラットフォームから切断する。
詳細は、2.4 節、3.5.2 項、4.1（c） 節を参照。

11
WPSC004-Ed.1.1 2021-02

2.1 ゲートウェイ登録
システムゲートウェイを水道標準プラットフォームに接続するため、システムゲートウェイの情報を水道標準プラットフォームに登録する。情報が登録されていない場合、そのシステム
ゲートウェイを利用できない。
事業体は、ゲートウェイ登録申請を実施する。プラットフォーマーはゲートウェイ登録申請の内容に基づき必要な割り当てを行い、割り当てた情報を事業体へ返送する。事業体は、割り当て情報に基づき水道情報活用システムが利用できるようになる。
発行される設定情報を以下に示す(表 2-2)。ゲートウェイ登録申請については、初期情報設
定シートを参照。
表 2-2: ゲートウェイ登録情報
No.

項目

説明
水道標準プラットフォームがシステムゲートウェ

1

ゲートウェイ ID

イを一意に識別するための識別子。詳細は、基本仕様書の 3.1.2 項を参照。

2

ゲートウェイ秘密鍵(TLS 用)相互認証や通信暗号に使用する秘密鍵

3

ゲートウェイ秘密鍵(データ保護用)

データ暗号や電子署名付与に使用する秘密鍵

4

ゲートウェイ証明書(TLS 用)

通信暗号に使用する証明書

5

ゲートウェイ証明書(データ保護用)

データ暗号に使用する証明書

水道標準プラットフォームルート証

水道標準プラットフォーム証明書の検証に使用す

明書

る証明書

アプリケーションルート証明書

アプリケーション証明書の検証に使用する証明書

6

7

8

水道標準プラットフォームのホスト
名

水道標準プラットフォームの FQDN 名。アプリケー
ションがアプリベンダー向け標準インターフェイスを使用するために必要。

12
WPSC004-Ed.1.1 2021-02

2.2 システム系データモデル登録
事業体がシステム系データモデル登録申請をプラットフォーマーに行い、プラットフォーマ
ーは申請書に記載された内容を水道標準プラットフォームに登録する。
システム系データモデル登録情報を以下に示す(表 2-3)。システム系データモデルの登録申請については、初期情報設定シートを参照。
表 2-3: システム系データモデル登録情報
No.

項目

1

システム ID

2

業務 ID

3

項目 ID

説明
システム系データモデルの詳細は、基本仕様書の 6
章を参照。

13
WPSC004-Ed.1.1 2021-02

2.3 ゲートウェイ接続
システムゲートウェイと水道標準プラットフォームを接続するため、システムゲートウェイ
起動時にシステムゲートウェイ接続インターフェイスを呼び出す。
ゲートウェイ接続では、システムゲートウェイから水道標準プラットフォームへ接続情報を登録する。登録する接続情報を以下に示す(表 2-4)。
表 2-4: ゲートウェイ接続情報
No.

名称

説明
水道標準プラットフォームがシステムゲートウェイを一意に識

1

ゲートウェイ ID

2

ゲートウェイ名

システムゲートウェイの名称

3

ゲートウェイ種別

システムゲートウェイの種別を表す文字列

4

事業体 ID

システムゲートウェイの所有者である事業体の ID

インターフェイスバー

サポートしている機器ベンダー向け標準インターフェイスのバ

ジョン

ージョン

5

6

対応データ種別 ID

別するための識別子。詳細は、基本仕様書の 3.1.2 項を参照。

サポートするデータ種別 ID。
詳細は、基本仕様書の 4.4.1 項を参照。
サポートするデータ種別のデータを一意に特定するプロパティ

7

対応データ種別プライ

名マリーキープロパティ

例：

名・データ種別が機器情報の場合は機器 ID
・データ種別が設備情報の場合は設備 ID
システムゲートウェイが水道標準プラットフォームに対して、送8プロトコル種別信時に使用する通信プロトコル
・HTTP(S)："HTTP"

9

アクセス先 URI

10

対応コンテンツタイプ

アクセス先の URI
システムゲートウェイがサポートする MIME タイプを指定する。
詳細は、基本仕様書の 4.4.5 項を参照。

水道標準プラットフォームでは、ゲートウェイ接続で登録された情報からシステムゲートウ
ェイを識別する。これにより水道標準プラットフォームは、当該システムゲートウェイが接続しても良いシステムゲートウェイかどうかを判定する。水道標準プラットフォームに接続しても良いと判断された場合、ゲートウェイ接続情報が水道標準プラットフォームに登録される。
これにより、そのシステムゲートウェイは水道標準プラットフォームと通信できる。水道標準
14
WPSC004-Ed.1.1 2021-02

プラットフォームに接続しても良いと判断されなかった場合、水道標準プラットフォームはそのシステムゲートウェイの接続を受けつけない。
ゲートウェイ接続の詳細は、3.5.1 項及び 4.1 節を参照。

15
WPSC004-Ed.1.1 2021-02

2.4 ゲートウェイ切断
既に接続しているシステムゲートウェイを水道標準プラットフォームから切断するためには、
ゲートウェイ切断インターフェイスを呼び出す。ゲートウェイ切断では、前述(表 2-4)の情報を指定して既に登録された情報を無効にする。その際、水道標準プラットフォームは、当該システムゲートウェイのためのすべての処理を停止する。
水道標準プラットフォームでは、ゲートウェイ切断で指定されたシステムゲートウェイが接続済みかどうかを判定する。接続済みだった場合、そのシステムゲートウェイの接続を無効にする。接続済みではなかった場合、エラーを返す。
ゲートウェイ切断の詳細は、3.5.2 項及び 4.1（c） 節を参照。

16
WPSC004-Ed.1.1 2021-02

3. 機器ベンダー向け標準インターフェイス（システム）仕様
本章では、機器ベンダー向け標準インターフェイス（システム）に必要な以下の 5 つを示す。
・インターフェイス一覧
・プロトコル・セキュリティ・データの分割送信
・基本的な処理の流れ

3.1 インターフェイス一覧
水道情報活用システムがサポートする機器ベンダー向け標準インターフェイス(システム)の一覧を以下に示す (表 3-1)。
表 3-1: インターフェイス一覧
No.

インターフェイス名1

ゲートウェイ接続インターフェイス

2

ゲートウェイ切断インターフェイス

3

4

5

説明
システムゲートウェイ接続を実行するインターフェ
イス
システムゲートウェイ切断を実行するインターフェ
イス

要求データ取得共通インターフェイ

定周期データ蓄積の要求を水道標準プラットフォー

ス

ムより取得する共通インターフェイス

定周期データ蓄積インターフェイス

定周期データ蓄積を実行するインターフェイス

公開鍵証明書ファイル取得インター

水道標準プラットフォーム証明書(データ保護用)をフェイス

取得するインターフェイス

各インターフェイスの詳細は、4 章を参照。

17
WPSC004-Ed.1.1 2021-02

3.2 プロトコル
接続方式の前提条件
不正アクセスを防ぐためにファイアウォール機能やパケットフィルタリング機能をもつ
ルータが間に設置されていることを前提とする。
接続方式を以下に示す(図 3-1)。

図 3-1:接続方式

18
WPSC004-Ed.1.1 2021-02

実装仕様のプロトコル
機器ベンダー向け標準インターフェイス(システム)で使用するプロトコルを以下に示す(表 3-2)。
表 3-2: 機器ベンダー向け標準インターフェイス(システム)のプロトコル
No.

用途

プロトコル

プロトコル説明
水道標準プラットフォームからシステムゲートウェイへデータ要

1

要求データ
取得

求を行う際に使用するプロトコル。
MQTT SSL

システムゲートウェイからアクセスし、水道標準プラットフォー
ムからのデータ要求を受信することが可能。
相互認証として TLS を使用。
システムゲートウェイから水道標準プラットフォームへデータ応

2

応答データ
送信

答を行う際に使用するプロトコル。
HTTP(S)

ゲートウェイ接続時に指定される「プロトコル種別」で切り分け。
ファイル等の容量の大きいデータ送信。
相互認証として TLS を使用。

MQTT
要求データ取得の接続手順
水道標準プラットフォームからのデータの要求を受信するための、MQTT の接続シーケン
スを以下に示す(図 3-2)。
システムゲートウェイから初期化時に接続する。接続したセッションを保持し、水道標
準プラットフォームから送信されるメッセージを MQTT サブスクライバーで受信する。
本項以降の MQTT の詳細フローにおいて、MQTT サブスクライバー、MQTT ブローカーの記
述は省略する。

水道標準プラットフォーム

システムゲートウェイ
MQTT
サブスクライバー

MQTT
ブローカー

接続

初期化

接続後、セッション保持システムゲートウェイ毎にトピックを指定データの要求MQTT サブスクライバー

図 3-2: MQTT の接続シーケンス（要求データ取得）

19
WPSC004-Ed.1.1 2021-02

ベース URL とトピックの形式は以下とし、ポート番号は 8883 とする。
MQTT ブローカーの URL
ssl://{水道標準プラットフォームのホスト名}:8883

MQTT サブスクライバーで指定するトピック/ {ゲートウェイ ID} /水道標準プラットフォームのホスト名はプラットフォーマーが定義する。
ヘッダ/ボディの定義
MQTT のデータ要求のヘッダとボディの設定箇所と形式を以下に示す(図 3-3)。MQTT では、プロトコルボティ部にデータ要求のヘッダとボティを XML 形式、又は JSON 形式で設定する。
プロトコル ヘッダ
プロトコル ボディ
ヘッダ
(XML or JSON 形式)
ボディ(XML or JSON 形式)
図 3-3： ヘッダ/ボディのプロトコル設定場所と形式(MQTT)20
WPSC004-Ed.1.1 2021-02

HTTP(S)
応答データ送信の接続手順
システムゲートウェイから水道標準プラットフォームへデータの応答送信するための、HTTP(S)の接続シーケンスを以下に示す(図 3-4)。

水道標準プラットフォーム

システムゲートウェイ

データの応答HTTP(S)リクエスト

HTTP(S)レスポンス

図 3-4： HTTP(S)の接続シーケンス（応答データ送信）ベース URL は以下とし、ポート番号は 443 とする。
https://${水道標準プラットフォームのホスト名}

水道標準プラットフォームのホスト名はプラットフォーマーが定義する。
ヘッダ/ボディの定義
HTTP(S)のデータ要求・データ応答のヘッダとボディの設定箇所と形式を以下に示す(図3-5)。HTTP(S)では、プロトコルヘッダ部にデータ要求のヘッダをプロトコル指定形式で設定し、プロトコルボディ部にデータ応答のボディ部を XML 形式、又は JSON 形式で設定する。

プロトコル ヘッダ
ヘッダ
(プロトコル指定形式)

プロトコル ボディ
ボディ
(XML or JSON 形式)

図 3-5： ヘッダ／ボディのプロトコル設定場所と形式(HTTP(S))

21
WPSC004-Ed.1.1 2021-02基本的な処理の流れとプロトコルの関係
機器ベンダー向け標準インターフェイス(システム)では、基本仕様書の 4.1 節に記載されている水道標準プラットフォームとシステムゲートウェイ間のデータ要求、データ応答の基本的な処理の流れの仕様として、データ要求のプロトコルを MQTT(サブスクライバー)、デー
タ応答のプロトコルを MQTT(パブリッシャー)、又は HTTP(S)(リクエストとレスポンス)とする。
応答するプロトコルの選択は、システムゲートウェイが対応する「ゲートウェイ接続情報のプロパティ」として、ゲートウェイ接続時に水道標準プラットフォームへ通知し、水道標
準プラットフォームから応答された「プロトコル種別」にて切り分ける。
データ要求、データ応答の基本的な処理の流れとプロトコルの関係を以下に示す(図 3-6)。

基本的な処理の流れ
水道標準
プラットフォーム

デ
ー
タ
を
参
照
・
取
得

プロトコルによる具体的な処理の流れ

システム
ゲートウェイ

水道標準
プラットフォーム

システム
ゲートウェイ

データの要求データの要求機器ベンダー
向け標準インター
フェイス(システム)(デバイス)

MQTT サブスクライバー

デ
ー
タ
参
照

機器ベンダー
向け標準インター
フェイス(システム)「)

データの応答

デ
ー
タ
を
参
照
・
取
得

【凡例】
：標準化対象インターフェイス

デ
ー
タ
参
照

HTTP(S)HTTP(S)リクエスト
HTTP(S)レスポンス

データの応答図 3-6: 基本的な処理の流れとプロトコルの関係

22
WPSC004-Ed.1.1 2021-02

3.3 セキュリティ
データの漏えいや改ざんを防ぐためには、正しい接続元・接続先との通信が必要である。システムゲートウェイと水道標準プラットフォームの間において、通信の開始時に双方で通信相手の正当性を確認（相互認証）し、通信経路を暗号化する。相互認証と通信経路の暗号化は、
水道標準プラットフォームをサーバー、システムゲートウェイをクライアントとして、SSL/TLSの仕様に従って実施する。詳細は、CPS/IoT セキュリティ仕様書の 2.2 節を参照。
通信経路の盗聴だけでなく、水道情報活用システム内での盗聴を防ぐためには、通信経路の暗号化に加えて、データそのものを暗号化する事を検討する必要がある。重要なデータを暗号化することで、流通する経路や一次保存の環境に依らず、データの機密性を確保することが可能となる。また、通信途中でデータの改ざんを検知できるようにするために、やり取りするデータに電子署名を付与し、受信側で検証する仕組みを実装することが望ましい。詳細は、CPS/IoT
セキュリティ仕様書の 2.4 節を参照。また、識別子(ID)や暗号化に利用する鍵情報については、
耐タンパー性を持つ領域に格納し、外部からの不正アクセスや改ざんを防止することで、セキ
ュリティを向上させることが望ましい。

23
WPSC004-Ed.1.1 2021-02

3.4 データの分割送信システムゲートウェイは、メモリ等リソースが限定されることを想定し、水道標準プラット
フォームに送信するデータ量が大きい場合、送信データを分割して送信可能とする。分割数はデータバイト数・レコード数等データ種別毎に決まった方法で決定する。元データを 2 分割して送信する例を以下に示す(図 3-7)。
広域向け
アプリケーション

機器ベンダー
向け標準インター
フェイス(システム)(デバイス)

④
分割データ
(1)
分割データ
(2)

デ
ー
タ
を
参
照
・
取
得
・
結
合

システム
ゲートウェイ

水道標準

プラットフォーム

データの要求MQTT サブスクライバー

②

データ分割
【通番 3 桁-総数 3 桁】
001-002

ヘッダ １/2

データの応答 1/2

デ
ー
タ
を
参
照
・
取
得

①
元データ

ボディ(1)
データ参
照

分割データ(1)

分割データ(2)③

データの応答 2/2

ヘッダ 2/2
ボディ(2)【凡例】：標準化対象インターフェイス【データ応答：HTTP(S)】

データの応答HTTP(S)リクエスト
HTTP(S)レスポンス

図 3-7: データの分割送信【分割送信の流れ】①元データを送信するサイズに分割する。
②分割数(1/2)と分割データ(1)を水道標準プラットフォームに送信する。水道標準プラッ
トフォームは、分割数(1/2)と分割データ(1)を広域向けアプリケーションに送信する。
③分割数(2/2)と分割データ(2)を水道標準プラットフォームに送信する。水道標準プラッ

24
WPSC004-Ed.1.1 2021-02

トフォームは、分割数(2/2)と分割データ(2)を広域向けアプリケーションに送信する。
④広域向けアプリケーションは、分割数が(2/2)の場合は終了と判断し、分割データを結合する。

25
WPSC004-Ed.1.1 2021-02

3.5 基本的な処理の流れ
本節では、機器ベンダー向け標準インターフェイスの基本的な処理の流れとして以下の 4 つを示す。
・ゲートウェイ接続
・ゲートウェイ切断
・データ操作(参照)プル型
・データ操作(参照)プッシュ型

ゲートウェイ接続
システムゲートウェイは、ゲートウェイ接続情報を水道標準プラットフォームに送信して水
道標準プラットフォームとの接続を確立する。接続によりシステムゲートウェイが提供するデータが水道標準プラットフォームから利用可能となる。
HTTP(S)を使用したゲートウェイ接続の詳細フローを以下に示す(図 3-8)。

広域向け
アプリケーションシステム
ゲートウェイ

水道標準
プラットフォーム

システム

システムゲートウェイ起動

ゲートウェイ接続情報の取得

ゲ
ー
ト
ウ
ェ
イ
接
続

ゲートウェイ接続
HTTP(S)リクエスト
HTTP(S)レスポンス

ゲートウェイ接続情報の送信

接続結果
機器ベンダー向け
標準インターフェイス(システム)【凡例】：標準化対象インターフェイス

図 3-8: 詳細フロー(ゲートウェイ接続)

26
WPSC004-Ed.1.1 2021-02

ゲートウェイ切断
既に接続済みのシステムゲートウェイは、ゲートウェイ切断情報を水道標準プラットフォー
ムに送信して、水道標準プラットフォームとの接続を切断する。切断によりシステムゲートウ
ェイが提供するデータが水道標準プラットフォームから利用不可となる。
HTTP(S)を使用したゲートウェイ切断の詳細フローを以下に示す(図 3-9)。

広域向け
アプリケーション

水道標準
プラットフォーム

ゲ
ー
ト
ウ
ェ
イ
接
続

システム
ゲートウェイシステム

ゲートウェイ切断
HTTP(S)リクエスト
HTTP(S)レスポンス

ゲートウェイ切断情報の送信

切断結果
機器ベンダー向け
標準インターフェイス(システム)

システムゲートウェイ終了【凡例】：標準化対象インターフェイス

図 3-9: 詳細フロー(ゲートウェイ切断)

なお、本フローによるものではなく、何らかの異常発生時に水道標準プラットフォーム側との接続が切断されてしまった場合は、再度 3.5.1 のフローにより再接続する必要がある。また切断されてしまった時点から、再度 3.5.1 のフローにより再接続するまでの間に取得すべきだ
ったデータの再送は行われない。

27
WPSC004-Ed.1.1 2021-02

4. インターフェイス仕様
本章では、水道情報活用システムがサポートする各インターフェイスについて以下を示す。
・HTTP(S)プロトコルにおける要求と応答の詳細フローとパラメーター
・MQTT プロトコルにおけるデータ要求の詳細とパラメーター
但し、インターフェイスによっては指定するデータ項目が異なる。

28
WPSC004-Ed.1.1 2021-02

4.1 ゲートウェイ接続インターフェイス
ゲートウェイ接続インターフェイスはゲートウェイ接続を通知する。ゲートウェイ接続ではHTTP(S)プロトコルを利用する。
ゲートウェイ接続における詳細フローとパラメーター
HTTP(S)の詳細フロー及びパラメーターを示す。
詳細フロー
ゲートウェイ接続の詳細フローを以下に示す(図 4-1)。

広域向け
アプリケーション

水道標準
プラットフォーム

システム
ゲートウェイシステム

システムゲートウェイ起動
ゲートウェイ接続データの取得

ゲ
ー
ト
ウ
ェ
イ
接
続

ゲートウェイ接続
HTTP(S)リクエスト(ゲートウェイ接続)
HTTP(S)レスポンス(ゲートウェイ接続の通信結果)

ゲートウェイ接続情報の送信

接続結果
機器ベンダー向け
標準インターフェイス(システム)【凡例】：標準化対象インターフェイス

図 4-1: ゲートウェイ接続の詳細フローリクエスト（要求情報）のパラメーター
HTTP(S)でゲートウェイ接続情報をシステムゲートウェイから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す(表 4-1)。
表 4-1: HTTP(S)リクエストのパラメーター（ゲートウェイ接続）

No.
1
2
3

種

(データ項目)

別

名称

リ
ク
エ
ス

HTTP メソッド
パス（URL）
プロトコルバージョン

必須/
説明

任意/

書式

不要
“POST”固定"/cps-platform/sbi/v1/system_info/"

固定"HTTP1.1"固定

必須

文字列

必須

文字列

必須

文字列

29
WPSC004-Ed.1.1 2021-02

No.

4

種

(データ項目)

別

名称

ト
行

文字コード

必須/
説明

任意/

書式

不要
utf-8

必須

文字列

必須

文字列

定する。
基本仕様書の 4.4.2 項を参照。 必須

文字列

データ種別 ID の項目一覧から"接続情5(データ種別 ID)

報"を指定する。基本仕様書の 4.4.1 項

X-CPS-dataTypeIdを参照。
(0000000100000000 を指定)

(操作種別 ID)

6

7

X-CPS-Operation

ヘ
ッ

8

ダ

(依頼元情報)X-CPS-Source-ID

操作種別 ID の項目一覧から"GET"を指(“POST”を指定)
(なし)

不要

文字列

必須

文字列

月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列(入力形式)

以下を指定。

Content-type

・"application/xml;charset=utf-8"
ISO8601 拡張形式の文字列(要求時刻)(タイムスタンプ)

9

X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01

01-23T12:34:56.000+09:00(生成日時(リクエスト時刻)を指定)(要求 ID)10

X-CPS-monitoringRequestId

(なし)

不要

文字列

必須

文字列

XML 形式の為、必須。

11

Xml 宣言文"<?Xml version="1.0" encording="utf-8"?>"固定(ゲートウェイ接続プロパテ

12

XML 形式を指定

XML 形

ィ)

式のみ

accessInformation

13
14

15

16

ボ

(ゲートウェイ ID)

デ

gwId

ィ

(ゲートウェイ名)

ゲートウェイ ID を設定

ゲートウェイ名を設定

gwName(ゲートウェイ種別)
gwKind

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

以下を指定。
・システムゲートウェイの場合："SystemGw"(事業体ＩＤ)

ゲートウェイが所属する事業体 ID を

corporationId

設定
30

WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

(インターフェイスバー ゲートウェイで利用可能な GW 向け標

17

18

ジョン)

準インターフェイスのバージョンを

ifVersion

設定(対応データ種別)

ゲートウェイで利用可能なデータ種

dataTypeId

別 ID をカンマ区切りで設定(対応データ種別

19

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

プラ データ種別のデータを一意に特定す

イマリーキープロパティ るプロパティ名を設定
名)
dataTypeKey
システムゲートウェイが水道標準プ

20(プロトコル種別)

ラットフォームに対して、送信する

protocol

時の通信プロトコルを指定。
・HTTP(S)："HTTP"

21
22(アクセス先 URI)

"NULL"固定accessUrl(対応コンテンツタイプ)

ゲートウェイで利用可能なコンテン

contentType

ツタイプをカンマ区切りで設定

31
WPSC004-Ed.1.1 2021-02

レスポンス(応答情報)のパラメーター
HTTP(S)でゲートウェイ接続の通信結果を水道標準プラットフォームからシステムゲ
ートウェイに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-2 HTTP(S)レスポンスのパラメーター（ゲートウェイ接続）
No.

種(データ項目)

別

名称

レ

ポ

(ステータスコード)

ン

Status Codeス

(データ種別 ID)
X-CPS-dataTypeId(操作種別 ID)

3

X-CPS-Operation(依頼元情報)4
5

X-CPS-Source-ID
ヘ
ッ

書式

不要

異常(不正要求):400
異常(登録されていない GW):401

必須

文字列

"0000000100000000"固定

必須

文字列

"POST"固定必須

文字列"NULL"固定

不要

文字列

必須

文字列

必須

文字列

不要

文字列

異常(指定したリソースが見つから(出力形式)

リクエスト時の「出力コンテンツ種

Content-type

別」で指定した内容
ISO8601 拡張形式の文字列(要求時

ダ

6

任意/

ない):404)

行

2

説明

正常終了:202

ス

1

必須/

刻)
(タイムスタンプ)

東京(UTC+09:00)における 2017 年 01

X-CPS-Timestamp

月 23 日の 12 時 34 分 56 秒の例：
2017-01-23T12:34:56.000+09:00(生成日時(レスポンス日時)を指定)(要求 ID)

7

X-CPS-monitoringRequestId)【正常の時】(Xml 宣言文)

ボ

8

デ
ィ

(ゲートウェイ接続プロパ"NULL"固定XML 形式の為、必須"<?Xml version="1.0" encording="utf-8"?>"固定XML 形式を指定

XML 形
式のみ

文字列

ティ)
accessInformation(ゲートウェイ ID)

ゲートウェイ ID を設定

gwId

必須

文字列

32
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/
不要

(ゲートウェイ名)

ゲートウェイ名を設定

gwName(ゲートウェイ種別)
gwKind

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

以下を指定。
・システムゲートウェイの場合："SystemGw"(事業体ＩＤ)

ゲートウェイが所属する事業体 ID を

corporationId

設定(インターフェイスバージ

ゲートウェイで利用可能な GW 向け標

ョン)

準インターフェイスのバージョンを

ifVersion

設定(対応データ種別)

ゲートウェイで利用可能なデータ種

dataTypeId

別 ID をカンマ区切りで設定(対応データ種別

書式

プライ

マリーキープロパティ名)

データ種別のデータを一意に特定するプロパティ名を設定

dataTypeKey
ゲートウェイ接続のリクエスト時に通知し、水道標準プラットフォーム(プロトコル種別)に登録された通信プロトコルを設

protocol

定。
・MQTT："MQTT"・HTTP(S)："HTTP"(アクセス先 URI)

ゲートウェイが通常の用途でサブス

accessUrl

クライブする接続先( ア ク セ ス 先 URI[ 通常])default(アクセス先 URI[制御専ゲートウェイがデバイスに対する制用])

御操作の用途でサブスクライブする

control

接続先(対応コンテンツタイプ)

ゲートウェイで利用可能なコンテン

contentType

ツタイプをカンマ区切りで設定【異常の時】

9(Xml 宣言文)

XML 形式の為、必須"<?Xml version="1.0" encording="utf-8"?>"固定

XML 形
式のみ

文字列

33
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
任意のエラーメッセージ。

(メッセージ)・アプリベンダー向け標準インター

message

フェイス仕様書 項 4.10.1「メッセー

必須

文字列

ジ仕様」に準拠する。

34
WPSC004-Ed.1.1 2021-02

4.2 ゲートウェイ切断インターフェイス
ゲートウェイ切断インターフェイスはゲートウェイ切断を通知する。
ゲートウェイ切断では HTTP(S)プロトコルを利用する。
ゲートウェイ切断における詳細フローとパラメーター
HTTP(S)の詳細フロー及びパラメーターを示す。
詳細フロー
ゲートウェイ切断の詳細フローを以下に示す(図 4-2)。

広域向け
アプリケーション

水道標準
プラットフォーム

システム
ゲートウェイシステム

システムゲートウェイ終了処理

ゲ
ー
ト
ウ
ェ
イ
切
断

ゲートウェイ切断
HTTP(S)リクエスト(ゲートウェイ切断)
HTTP(S)レスポンス(ゲートウェイ切断の通信結果)

ゲートウェイ切断情報の送信

切断結果
システムゲートウェイ終了

機器ベンダー向け
標準インターフェイス(システム)【凡例】：標準化対象インターフェイス

図 4-2: ゲートウェイ切断の詳細フローリクエスト（要求情報）のパラメーター
HTTP(S)でゲートウェイ切断情報をシステムゲートウェイから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-3: HTTP(S)リクエストのパラメーター（ゲートウェイ切断）

No.
1
2
3
4

種

(データ項目)

別

名称

リ
ク
エ
ス
ト
行

HTTP メソッド
パス（URL）

必須/
説明

任意/

書式

不要
“POST”固定"/cps-platform/sbi/v1/system_info/"

固定

必須

文字列

必須

文字列

プロトコルバージョン"HTTP1.1"固定

必須

文字列

文字コード

utf-8

必須

文字列

35
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
データ種別 ID の項目一覧から"接続情5(データ種別 ID)

報"を指定する。基本仕様書の 4.4.1 項

X-CPS-dataTypeId

を参照。

必須

文字列

必須

文字列

不要

文字列

必須

文字列

月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列(0000000100000000 を指定)
操作種別 ID の項目一覧から"DELETE"

6(操作種別 ID)を指定する。基本仕様書の 4.4.2 項を

X-CPS-Operation

参照。
(“DELETE”を指定)

7
8

ヘ(依頼元情報)ッ

X-CPS-Source-ID

ダ(入力形式)

以下を指定。

Content-type

・"application/xml;charset=utf-8"(なし)

ISO8601 拡張形式の文字列(要求時刻)(タイムスタンプ)

9

X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01

01-23T12:34:56.000+09:00(生成日時(リクエスト時刻)を指定)(要求 ID)10

X-CPS-monitoringRequestId

(なし)

不要

XML 形式の為、必須

11Xml 宣言文"<?Xml version="1.0" encording="utf-8"?>"固定(ゲートウェイ接続プロパテ

12

XML 形
式のみ

文字列

文字列

XML 形式を指定

ィ)

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

accessInformation

13
14

15

16

ボ

(ゲートウェイ ID)

デ

gwId

ィ

(ゲートウェイ名)

ゲートウェイ ID を設定

ゲートウェイ名を設定

gwName(ゲートウェイ種別)
gwKind以下を指定。
・システムゲートウェイの場合："SystemGw"(事業体ＩＤ)

ゲートウェイが所属する事業体 ID を

corporationId

設定

36
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

(インターフェイスバー ゲートウェイで利用可能な GW 向け標

17

18

ジョン)

準インターフェイスのバージョンを

ifVersion

設定(対応データ種別)

ゲートウェイで利用可能なデータ種

dataTypeId

別 ID をカンマ区切りで設定(対応データ種別

19

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

プラ データ種別のデータを一意に特定す

イマリーキープロパティ るプロパティ名を設定
名)
dataTypeKey
水道標準プラットフォームを通信す

20(プロトコル種別)るプロトコルを指定

protocol・MQTT："MQTT"・HTTP(S)："HTTP"

21
22(アクセス先 URI)

"NULL"固定accessUrl(対応コンテンツタイプ)

ゲートウェイで利用可能なコンテン

contentType

ツタイプをカンマ区切りで設定

37
WPSC004-Ed.1.1 2021-02

レスポンス(応答情報)のパラメーター
HTTP(S)でゲートウェイ切断の通信結果を水道標準プラットフォームからシステムゲ
ートウェイに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-4: HTTP(S)レスポンスのパラメーター（ゲートウェイ切断）

No.

種(データ項目)

別

名称

レ

ポ

(ステータスコード)

ン

Status Codeス

(データ種別 ID)
X-CPS-dataTypeId(操作種別 ID)

3

X-CPS-Operation(依頼元情報)4
5

X-CPS-Source-ID
ヘ
ッ

書式

不要

異常(不正要求):400
異常(登録されていない GW):401

必須

文字列

"0000000100000000"固定

必須

文字列

"DELETE"固定

必須

文字列

"NULL"固定

不要

文字列

必須

文字列

必須

文字列

不要

文字列

異常(指定したリソースが見つから(出力形式)

リクエスト時の「出力コンテンツ種

Content-type

別」で指定した内容
ISO8601 拡張形式の文字列(要求時

ダ

6

任意/

ない):404)

行

2

説明

正常終了:202

ス

1

必須/

刻)
(タイムスタンプ)

東京(UTC+09:00)における 2017 年 01

X-CPS-Timestamp

月 23 日の 12 時 34 分 56 秒の例：
2017-01-23T12:34:56.000+09:00(生成日時(レスポンス日時)を指定)(要求 ID)

7

X-CPS-monitoringRequestId)【正常の時】

8

ボ
デ

9

ィ

(Xml 宣言文)【異常の時】(Xml 宣言文)"NULL"固定XML 形式の為、必須。
"<?Xml version="1.0" encording="utf-8"?>"固定

Xml 形
式のみ

文字列

XML 形式の為、必須。
"<?Xml version="1.0" encording=

必須

文字列

"utf-8"?>"固定38
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
任意のエラーメッセージ。

(メッセージ)・アプリベンダー向け標準インター

message

フェイス仕様書 項 4.10.1「メッセー

必須

文字列

ジ仕様」に準拠する。

39
WPSC004-Ed.1.1 2021-02

4.3 要求データ取得共通インターフェイス
要求データ取得共通インターフェイスは、アプリケーションから要求される定周期データ蓄積の要求内容を水道標準プラットフォームから MQTT トピックとしてサブスクライバーされてシステムゲートウェイへ通知される共通インターフェース。
要求データ取得における詳細フローとパラメータ
定周期データ蓄積の要求データの取得における MQTT サブスクライバーの詳細フロー及びパラメーターを以下に示す。
詳細フロー
要求データ取得の詳細フローを以下に示す(図 4-3: MQTT の接続シーケンス（要求デー
タ受信）)。
また、データの分割送信時の要求データ取得の詳細フローについては、3.4 を参照。

水道標準プラットフォーム

システムゲートウェイ
MQTT
サブスクライバー

MQTT
ブローカー

接続

初期化

接続後、セッション保持システムゲートウェイ毎にトピックを指定データの要求MQTT サブスクライバー

図 4-3: MQTT の接続シーケンス（要求データ受信）

要求データの取得パラメーター① MQTT 接続パラメーター(トピック)
MQTT の接続パラメーターを以下に示す。
表 4-5: MQTT の接続パラメーター
No.

項目

内容

1

ブローカー

ssl://{水道標準プラットフォームのホスト名}：ポート番号2

データ要求 トピック/{ゲートウェイ ID}/

3

文字コード

utf-8

40
WPSC004-Ed.1.1 2021-02

② MQTT サブスクライバー(要求データ取得)
MQTT サブスクライバーとして水道標準プラットフォームからシステムゲートウェイ
へ通知される要求データを以下に示す（表 4-6: MQTT サブスクライバー（要求データ取得）のパラメーター）。
表 4-6: MQTT サブスクライバー（要求データ取得）のパラメーター
No.

種(データ項目)

別

名称

必須/
説明

任意/
不要

XML 形式の場合、必須
1

Xml 宣言文

XML 形"<?xml version="1.0"

式のみ

encoding="utf-8"?>" 固定(インターフェイス包括タグ)

2

CPS-IfElement(ヘッダ包括タグ)

3

CPS-IfHeader
プ

4

ロ
ト

5

ボ
デ

文字列

インターフェイス包括タグ

ヘッダ包括タグ
データ種別 ID が指定される。

(データ種別 ID)

基本仕様書の 4.4.1 項を参照。

X-CPS-dataTypeId

・データ蓄積(定周期)：

必須

文字列

必須

文字列

必須

文字列

必須

文字列

"0200000700000000"

コ
ル

書式

操作種別 ID が指定される。
(操作種別 ID)

基本仕様書の 4.4.2 項を参照。

X-CPS-Operation

・定周期データ蓄積開始："GET"・定周期データ蓄積停止："DELETE"

ィID 種別、アプリケーション ID が指6(依頼元情報)定される。

X-CPS-Source-ID

基本仕様書の 4.4.3 項を参照。
("03-[アプリケーション ID]")
IANA に 登 録 さ れ た MIME タ イ プ

7(入出力形式)

application/xml を指定。

Content-type

以下を指定。
・"application/xml;charset=utf-8"

41
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
・1 回目の要求時には指定不要。
・データを分割した場合は必須と8(データ分割)X-CPS-Data-Split

し、以下を指定する。
通番 3 桁-総数 3 桁

記載例:002-

003

必須/
任意

文字列

データ分割については、3.4 節参照。
ISO8601 拡張形式の文字列(要求時
刻)
9(タイムスタンプ)

東京(UTC+09:00)における 2017 年

X-CPS-Timestamp

01 月 23 日の 12 時 34 分 56 秒の例：

必須

文字列

2017-01-23T12:34:56.000+09:00(生成日時を指定)

10(要求 ID)
X-CPS-monitoringRequestId

定周期データ蓄積の開始要求時に
指定。

要求時
に必須

要求を一意に示す ID

文字列

ボディ包括タグ
11

CPS-IfBody※2 回目以降のデータ分割要求の場合は、本タグと内包のデータタグは不要。
要求データのデータプロファイル

12

(データ)

詳細は、水道 CPS データプロファイ

Data

ル仕様書の 2.4.1 項、2.4.2 項を参

必須

文字列

照。

42
WPSC004-Ed.1.1 2021-02

要求データの判別フローと要求の振り分け
MQTT トピックより取得したサブスクライバーのデータ（要求データ）より、要求の判別
フロー処理と、要求の振り分けを以下に示す（図 4-4: 要求データの判別フローと要求の
振り分け）
。

要求データ

要求(定周期)

データ種別

"GET"

"DELETE"
操作種別 ID

データ蓄積開始

データ蓄積停止

図 4-4: 要求データの判別フローと要求の振り分け

43
WPSC004-Ed.1.1 2021-02

4.4 定周期データ蓄積インターフェイス
定周期データ蓄積開始インターフェイスは、データ操作(参照)プッシュ型を使用する。
定周期データ蓄積インターフェイスにおける詳細フローとパラメーター
定周期データ蓄積のプッシュ指示の要求、プッシュ指示の応答、イベントデータにおける
MQTT/HTTP(S)の詳細フロー及びパラメーターを示す。
詳細フロー
定周期データ蓄積の詳細フローを以下に示す（図 4-5: 定周期データ蓄積の詳細フロー）。

44
WPSC004-Ed.1.1 2021-02

ユーザー

広域向け
アプリケーションシステム
ゲートウェイ

水道標準
プラットフォーム

システム

プッシュ指示の要求
MQTT サブスクライバー

データ保護用公開鍵
証明書ファイル取得

データ要求したアプリケーションのアプリケーション証明書を保持していた場合は処理をスキップ

HTTP(S)リクエスト
HTTP(S) レスポンス
データ

機器ベンダー
向け標準インターフェイス(システム)

要求データ保護用公開鍵 署
証明書ファイル取得 名

HTTP(S)リクエスト
HTTP(S) レスポンス

検
証
・
復
号

プッシュ指示の応答

上水道共通プラットフォームのサーバー証明書を保持していた場合は処理をスキップ

HTTP(S)HTTP(S)リクエスト
HTTP(S)レスポンス

loop

デ
ー
タ
送
信

一
次
デ
ー
タ
蓄
積

機器ベンダー
向け標準インターフェイス(システム)

デ
ー
タ
受
信
・
蓄
積

イベントデータ
HTTP(S)リクエスト
HTTP(S)レスポンス(プッシュ通信)

暗
号
化
・
署
名
生
成

HTTP(S)【凡例】：標準化対象インターフェイス：標準化非対象インターフェイス

図 4-5: 定周期データ蓄積の詳細フロー

要求データ取得のパラメーター
MQTT サブスクライバーにより、要求データを取得する。
45
WPSC004-Ed.1.1 2021-02

4.3 要求データ取得共通インターフェイスを参照。
HTTP(S)(プッシュ指示の応答)のパラメーター
定周期データ蓄積データを水道標準プラットフォームへ応答する場合に使用するプロト
コルは、HTTP(S)の場合がある。
以下は、ゲートウェイ接続インターフェイスのレスポンスのパラメータの「プロトコル
種別：protocol」を参照し、HTTP(S)によるデータ応答のパラメータを記載する。

① HTTP(S)リクエスト(プッシュ指示の応答) のパラメーター
HTTP(S)でプッシュ指示の応答をシステムゲートウェイから水道標準プラットフォー
ムに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す(表 4-7)。
表 4-7: HTTP(S)リクエストのパラメーター（定周期データ蓄積/プッシュ指示の応答）

No.
1
2
3
4

種

(データ項目)

別

名称

リ
ク
エ
ス
ト
行

HTTP メソッド
パス（URL）

必須/
説明

任意/

書式

不要
“POST”固定"/cps-platform/sbi/v1/accumulate/result_data/"固定

必須

文字列

必須

文字列

プロトコルバージョン"HTTP1.1"固定

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

データ種別 ID の項目一覧から"データ5(データ種別 ID)

蓄積(定周期) "を指定する。基本仕様

X-CPS-dataTypeId

書の 4.4.1 項を参照。
(0200000700000000 を指定)
操作種別 ID の項目一覧から

6

ヘッ(操作種別 ID)定 周 期 デ ー タ 蓄 積 は "GET" を 指 定 すX-CPS-Operation

る。
基本仕様書の 4.4.2 項を参照。

ダ

7

ID 種別の項目一覧から"ID 種別"、"ア(依頼元情報)プリケーション ID "を指定する。基本

X-CPS-Source-ID

仕様書の 4.4.3 項を参照。
("03-0000"固定)

8(入力形式)
Content-type"application/xml"固定46
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
ISO8601 拡張形式の文字列(要求時刻)

9(タイムスタンプ)
X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01
月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列

01-23T12:34:56.000+09:00
生成日時(リクエスト時刻)を指定

10(要求 ID)
X-CPS-monitoringRequestId

要求を一意に示す ID

不要

文字列

必須

文字列

正常終了:0

11(実行結果コード)

不正業務アクティビティ有り:1

X-CPS-Result

データプロファイル生成異常:101
その他異常:999

47
WPSC004-Ed.1.1 2021-02

② HTTP(S)レスポンス(プッシュ指示の応答(通信結果)のパラメーター
HTTP(S)でデータ応答の通信結果を水道標準プラットフォームからシステムゲート
ウェイに返却する。
その際の HTTP(S)レスポンスのパラメーターを以下に示す(表 4-8)。
表 4-8: HTTP(S)レスポンスのパラメーター（定周期データ蓄積/プッシュ指示の応答）
No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
正常終了:202(ステータスコード)

1

Status Code

異常(不正要求):400
異常(認識されていない):401

必須

文字列

"0200000700000000"固定

必須

文字列

"GET"固定必須

文字列

03-[アプリケーション ID]を指定

必須

文字列

"application/xml"固定

必須

文字列

月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列

異常(指定したリソースが見つからない):404(データ種別 ID)

2

3

4

5

プ

X-CPS-dataTypeId

ロ(操作種別 ID)ト

X-CPS-Operation

コ(依頼元情報)ル

X-CPS-Source-ID

ヘ(入出力形式)ッContent-typeダ

6

ISO8601 拡張形式の文字列(応答時刻)(タイムスタンプ)
X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01

01-23T12:34:56.000+09:00(生成日時(レスポンス時刻)を指定)

7(要求 ID)
X-CPS-monitoringRequestId

要求 ID を指定。

必須

文字列

48
WPSC004-Ed.1.1 2021-02

HTTP(S)(データ蓄積(定周期))のパラメーター
水道標準プラットフォームへ応答する場合に使用するプロトコルは、HTTP(S)である。以下は、ゲートウェイ接続インターフェイスのレスポンスのパラメータの「プロトコル種別：
protocol」を参照し、HTTP(S)によるデータ応答のパラメータを記載する。

① HTTP(S)リクエスト(イベントデータ)のパラメーター
HTTP(S)でイベントデータをシステムゲートウェイから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す(表 4-9)。
表 4-9: HTTP(S)リクエストのパラメーター（定周期データ蓄積イベントデータ）

No.
1
2
3
4

種

(データ項目)

別

名称

リ
ク
エ
ス
ト
行

HTTP メソッド
パス（URL）

必須/
説明

任意/

書式

不要
“POST”固定"/cps-platform/sbi/v1/accumulate/result_data/"固定

必須

文字列

必須

文字列

プロトコルバージョン"HTTP1.1"固定

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

データ種別 ID の項目一覧から"データ5(データ種別 ID)

蓄積(定周期) "を指定する。基本仕様

X-CPS-dataTypeId

書の 4.4.1 項を参照。
(0200000700000000 を指定)

ヘ

6

ッ
ダ

操作種別 ID の項目一覧から(操作種別 ID)定 周 期 デ ー タ 蓄 積 は "GET" を 指 定 すX-CPS-Operation

る。
基本仕様書の 4.4.2 項を参照。
ID 種別の項目一覧から"ID 種別"、"ア7(依頼元情報)プリケーション ID "を指定する。基本

X-CPS-Source-ID

仕様書の 4.4.3 項を参照。
("03-[アプリケーション ID]"を指定)

49
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
以下のいずれかを指定。
【XML 形式の場合】
・"application/xml;charset=utf-8"

8(入力形式)【JSON 形式(暗号化なし)の場合】

Content-type

・"application/json"

必須

文字列

【JSON 形式(暗号化有りの場合)】
・"application/jose"（ただし BODY 部全てではなく、必要な部分のみ暗号化する）

・データを分割しない場合は指定不要。
(データ分割)9

X-CPS-Data-Split

・データを分割した場合は必須とし、以下を指定する。

必須/
任意

通番 3 桁-総数 3 桁
記載例:002-003
データ分割については、3.4 節参照。
ISO8601 拡張形式の文字列(要求時刻)(タイムスタンプ)

10

X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01
月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列

01-23T12:34:56.000+09:00
生成日時(リクエスト時刻)を指定(要求 ID)

11

X-CPS-monitoringRequestId

要求を一意に示す ID

不要

文字列

正常終了:0

12(実行結果コード)

不正業務アクティビティ有り:1

X-CPS-Result

データプロファイル生成異常:101

必須

では文
字列

その他異常:999
XML 形式の場合のみ、必須

13

ボ

Xml 宣言文

14

式のみ

encording="utf-8"?>"固定

デ
ィ

XML 形

"<?Xml version="1.0"

(データ)
Data

文字列

蓄積対象データのプロパティ
詳細は、水道 CPS データプロファイル 必須

文字列

仕様書の 2.4.1 項、2.4.2 項を参照。

50
WPSC004-Ed.1.1 2021-02

② HTTP(S)レスポンス(イベントデータの通信結果)
HTTP(S)でイベントデータの通信結果を水道標準プラットフォームからシステムゲ
ートウェイに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す(表4-10)。
表 4-10: HTTP(S)レスポンスのパラメーター（定周期データ蓄積イベントデータ）
No種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
正常終了:202/(ステータスコード)

1

Status Code

異常(不正要求):400
異常(認識されていない):401

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

任意

文字列

生成日時(レスポンス時刻)を指定

必須

文字列

リクエスト時の要求 ID が格納

必須

文字列

（なし）

不要

文字列

異常(指定したリソースが見つからない):404

2

3
ヘ
4

ッ
ダ

(データ種別 ID)

リクエスト時のデータが格納

X-CPS-dataTypeId"0200000700000000"固定(操作種別 ID)

リクエスト時のデータが格納

X-CPS-Operation“GET”固定(依頼元情報)リクエスト時のデータが格納

X-CPS-Source-ID"03-[アプリケーション ID]"を指定(入出力形式)

5

Content-type

6

X-CPS-Data-Split"[通番 3 桁数字]-[総数 3 桁数字]"(要求 ID)
X-CPS-monitoringRequestId

9【正常時の時】
なし【異常の時】
ボデ・"application/xml;charset=utf-8"
リクエスト時のデータが格納

X-CPS-Timestamp8

以下を指定。

(データ分割)(タイムスタンプ)

7

リクエスト時のデータが格納(Xml 宣言文)

ィXML 形式の場合のみ、必須

XML 形"<?Xml version="1.0"式のみ

encording="utf-8"?>"固定

文字列

任意のエラーメッセージ。
(メッセージ)・アプリベンダー向け標準インター

message

フェイス仕様書 項 4.10.1「メッセー

必須

文字列

ジ仕様」に準拠する。
51
WPSC004-Ed.1.1 2021-02

定周期データ蓄積停止インターフェイスにおける詳細フローとパラメーター
定周期データ蓄積停止のプッシュ指示の要求、プッシュ指示の応答における HTTP(S)の詳
細フロー及びパラメーターを示す。
詳細フロー
定周期データ蓄積停止のプッシュ指示の要求とプッシュ指示の応答の詳細フローを以下に示す(図 4-6)。

広域向け
アプリケーション

水道標準
プラットフォーム

操作種別 ID で”DELETE”を指定システム
ゲートウェイシステム

プッシュ指示の要求
MQTT サブスクライバー(プッシュ指示の要求)

停止要求受信後
イベントデータ送信
は停止

HTTP(S)の場合
デ
ー
タ
要
求

デ
ー
タ

プッシュ指示の応答
HTTP(S)リクエスト(プッシュ指示の応答)

署
名
検
証
・
復
号

HTTP(S)レスポンス(プッシュ指示の応答の通信結果)

要
求

【凡例】
：標準化対象インターフェイス

図 4-6: 定周期データ蓄積の停止要求詳細フロー

要求データ取得のパラメーター
MQTT サブスクライバーにより、要求データを取得する。
4.3 要求データ取得共通インターフェイスを参照。

52
WPSC004-Ed.1.1 2021-02

HTTP(S)(プッシュ指示の応答（停止結果）)のパラメーター
水道標準プラットフォームへ応答する場合に使用するプロトコルは、HTTP(S)と MQTT の場合がある。以下は、ゲートウェイ接続インターフェイスのレスポンスのパラメータの「プロトコル種別：protocol」を参照し、HTTP(S)によるデータ応答のパラメータを記載する。

① HTTP(S)リクエスト(プッシュ指示の応答(停止結果)のパラメーター
HTTP(S)でプッシュ指示（停止）の応答をシステムゲートウェイから水道標準プラット
フォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す(表4-11: HTTP(S)リクエストのパラメーター（定周期データ蓄積(停止結果))。
表 4-11: HTTP(S)リクエストのパラメーター（定周期データ蓄積(停止結果)

No.
1
2
3
4

種

(データ項目)

別

名称

リ
ク
エ
ス
ト
行

HTTP メソッド
パス（URL）

必須/
説明

任意/

書式

不要
“POST”固定"/cps-platform/sbi/v1/accumulate/result_data/"固定

必須

文字列

必須

文字列

プロトコルバージョン"HTTP1.1"固定

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

データ種別 ID の項目一覧から"データ5(データ種別 ID)

蓄積(定周期)"を指定する。基本仕様

X-CPS-dataTypeId

書の 4.4.1 項を参照。
(0200000700000000 を指定)
操作種別 ID の項目一覧から"DELETE"

6

ヘ
ッ(操作種別 ID)を指定する。基本仕様書の 4.4.2 項を

X-CPS-Operation

参照。
(“DETELE”を指定)

ダ

7

ID 種別、アプリケーション ID が指定(依頼元情報)される。

X-CPS-Source-ID

基本仕様書の 4.4.3 項を参照。
("03-[アプリケーション ID]")

8(入力形式)
Content-type"application/xml"固定53
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
ISO8601 拡張形式の文字列(要求時刻)(タイムスタンプ)

9

X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01
月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列

01-23T12:34:56.000+09:00
生成日時(リクエスト時刻)を指定(要求 ID)10

X-CPS-monitoringRequestId

要求 ID を指定。

必須

文字列

必須

文字列

正常終了:0

11(実行結果コード)

不正業務アクティビティ有り:1

X-CPS-Result

データプロファイル生成異常:101
その他異常:999② HTTP(S)レスポンス(プッシュ指示の応答(停止結果)のパラメーター
HTTP(S)でデータ応答の通信結果を水道標準プラットフォームからシステムゲート
ウェイに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す(表4-12: HTTP(S)レスポンスのパラメーター（定周期データ蓄積(停止)）)。
表 4-12: HTTP(S)レスポンスのパラメーター（定周期データ蓄積(停止)）No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
正常終了:202(ステータスコード)

1

Status Code34

異常(認識されていない):401

必須

文字列

"0200000700000000"固定

必須

文字列

"DETELE"固定

必須

文字列

"03-0000"を指定

必須

文字列

異常(指定したリソースが見つからない):404ヘ
2

異常(不正要求):400

ッ(データ種別 ID)ダ

X-CPS-dataTypeId(操作種別 ID)
X-CPS-Operation(依頼元情報)X-CPS-Source-ID

54
WPSC004-Ed.1.1 2021-02

No

種(データ項目).

別名称(入出力形式)

5

Content-type

必須/
説明

任意/

書式

不要
以下のいずれかを指定。
・"application/xml;charset=utf-8"

必須

文字列

月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列・"application/json"
ISO8601 拡張形式の文字列(応答時刻)(タイムスタンプ)

6

X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01

01-23T12:34:56.000+09:00
生成日時(レスポンス時刻)を指定(要求 ID)

7

X-CPS-monitoringRequestId

リクエストで指定した要求 ID が格納
XML 形式の場合のみ、必須

8

Xml 宣言文

デ
9

ィ

XML 形

"<?Xml version="1.0"式のみ

encording="utf-8"?>"固定

ボ

必須

文字列

文字列

任意のエラーメッセージ。
(メッセージ)・アプリベンダー向け標準インターフ

messageェイス仕様書 項 4.10.1「メッセージ

必須

文字列

仕様」に準拠する。

55
WPSC004-Ed.1.1 2021-02

4.5 公開鍵証明書ファイル取得インターフェイス
公開鍵証明書ファイル取得インターフェイスは、水道標準プラットフォーム証明書、又はア
プリケーション証明書ファイルの取得を行う。
公開鍵証明書ファイル取得インターフェイスでは HTTP(S)プロトコルを利用する。
公開鍵証明書ファイル取得における詳細フローとパラメーター
HTTP(S)の詳細フロー及びパラメーターを示す。
詳細フロー
公開鍵証明書ファイル取得の詳細フローを以下に示す(図 4-7: 公開鍵証明書ファイル
取得の詳細フロー)。

広域向け
アプリケーション

水道標準
プラットフォーム

取
得
要
求
の
応
答

システム

HTTP(S)リクエスト(公開鍵証明書ファイル取得要求)

HTTP(S)レスポンス(公開鍵証明書ファイルの応答)

機器ベンダー向け
標準インターフェイス(システム)

取
得
要
求
の
送
信

【凡例】
：標準化対象インターフェイス

図 4-7: 公開鍵証明書ファイル取得の詳細フローリクエスト(要求情報)のパラメーター
HTTP(S)でデータ保護用公開鍵証明書ファイル取得情報をシステムゲートウェイから
水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 4-13 HTTP(S)リクエストのパラメーター（公開鍵証明書ファイル取得））。
表 4-13 HTTP(S)リクエストのパラメーター（公開鍵証明書ファイル取得）
No.
1

種

(データ項目)別名称

リ

HTTP メソッド

必須/
説明

任意/

書式

不要
“POST”固定

必須

文字列

56
WPSC004-Ed.1.1 2021-02

No.

2
3
4

種

(データ項目)

別

名称

ク
エ
ス
ト
行

パス（URL）

必須/
説明

任意/

書式

不要
"/cps-platform/sbi/v1/certificate/"

固定

必須

文字列

プロトコルバージョン"HTTP1.1"固定

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

定する。
基本仕様書の 4.4.2 項を参照。 必須

文字列

データ種別 ID の項目一覧から"データ5(データ種別 ID)

保護公開鍵証明書ファイル "を指定

X-CPS-dataTypeId

する。基本仕様書の 4.4.1 項を参照。
(0200000500000000 を指定)

(操作種別 ID)

6

X-CPS-Operation

操作種別 ID の項目一覧から"GET"を指(“GET”を指定)
ID 種別の項目一覧から"ID 種別"、"ゲ

7

ヘ
ッ
ダ

8

(依頼元情報)ートウェイ ID "を指定する。基本仕様

X-CPS-Source-ID

書の 4.4.3 項を参照。

必須

文字列

必須

文字列

月 23 日の 12 時 34 分 56 秒の例：2017- 必須

文字列(“04-[ゲートウェイ ID]”を指定)(入力形式)

以下をいずれかを指定。

Content-type

・"application/xml;charset=utf-8"
ISO8601 拡張形式の文字列(要求時刻)(タイムスタンプ)

9

X-CPS-Timestamp

東京(UTC+09:00)における 2017 年 01

01-23T12:34:56.000+09:00(生成日時(リクエスト時刻)を指定)(要求 ID)10

X-CPS-monitoringRequestId

(なし)

不要

XML 形式の場合のみ、必須

11

Xml 宣言文"<?Xmlversion="1.0"

encording="utf-8"?>"固定

文字列

件を指定。

デ

12

式のみ

データ保護用公開鍵証明書の取得条

ボ

ィ

XML 形

文字列

(取得条件)
certificateRequestId

・水道標準プラットフォームの場
合：

必須

文字列

"0000"を指定
・アプリケーションの場合"[アプリケーション ID]"を指定
57
WPSC004-Ed.1.1 2021-02

レスポンス(応答情報)のパラメーター
HTTP(S)でデータ保護用公開鍵証明書ファイル取得の通信結果を水道標準プラットフ
ォームからシステムゲートウェイに返却する。その際の HTTP(S)レスポンスのパラメー
ターを以下に示す（表 4-14 HTTP(S)レスポンスのパラメーター（公開鍵証明書ファイル
取得））。
表 4-14 HTTP(S)レスポンスのパラメーター（公開鍵証明書ファイル取得）
No.

種(データ項目)

別

名称

レ

ポ

(ステータスコード)

ン

Status Codeス

(データ種別 ID)
X-CPS-dataTypeId(操作種別 ID)

3

X-CPS-Operation(依頼元情報)

4

任意/

書式

不要

異常(不正要求):400
異常(認識されていない):401

必須

文字列

"0200000500000000"固定

必須

文字列

"GET"固定必須

文字列

04-[ゲートウェイ ID]を指定

必須

文字列

必須

文字列

必須

文字列

異常(指定したリソースが見つからない):404)

行

2

説明

正常終了:202

ス

1

必須/

X-CPS-Source-ID

【正常時】
ヘ

5

ッ
ダ

・application/octet-stream を指定(出力形式)【異常時】

Content-type

以下を指定。
・"application/xml;charset=utf-8"

ISO8601 拡張形式の文字列(要求時
刻)

6(タイムスタンプ)

東京(UTC+09:00)における 2017 年 01

X-CPS-Timestamp

月 23 日の 12 時 34 分 56 秒の例：
2017-01-23T12:34:56.000+09:00(生成日時(レスポンス日時)を指定)

58
WPSC004-Ed.1.1 2021-02

No.

種

(データ項目)別名称(要求 ID)

7

X-CPS-monitoringRequestId

必須/
説明

任意/

書式

不要

"NULL"固定不要

データ保護公開鍵証明書バイナリ

必須

文字列

【正常の時】(証明書情報)Certificate Information

ボ

8

デ
ィ

【異常の時】(Xml 宣言文)

XML 形式の場合のみ、必須"<?Xml version="1.0" encording="utf-8"?>"固定

バイナ
リ

XML 形
式のみ
文字列

任意のエラーメッセージ。
(メッセージ)・アプリベンダー向け標準インター

message

フェイス仕様書 項 4.10.1「メッセー必須ジ仕様」に準拠する。

59
WPSC004-Ed.1.1 2021-02

5. データプロパティ仕様
各データ種別のプロパティ仕様を以下に記載する。

5.1 データ蓄積(定周期)データのプロパティ仕様
データのプロパティ仕様は、水道 CPS データプロファイル仕様書を参照。
データ蓄積(定周期)データのプロパティ仕様は、水道 CPS データプロファイル仕様書を参照。

5.2 ゲートウェイ接続情報のプロパティ仕様
ゲートウェイ接続情報のプロパティ仕様を以下に示す(表 5-1)。
表 5-1: ゲートウェイ接続情報のプロパティ仕様
No.

XML

1

accessInformation

名称

型

内容

2

gwId

ゲートウェイ ID

Stringゲートウェイ ID

3

gwNameゲートウェイ 名Stringゲートウェイ名

例"02012345
6789""SystemGW-1"

ゲートウェイの種別を表す文字列。
4

gwKindゲートウェイ種別Stringシステム"SystemGw

ゲートウェイ:“SystemGw”"

シ ス テ ム ゲ ー ト ウ ェイ:”IoTGw”

5

6

corporationId

ifVersion

事業体 ID

インターフェイ
スバージョン

Stringゲートウェイの所有者である事業体の Id

"DUNS714005993-001"

サポートしている機器ベン
String

ダー向け標準インターフェ

1.00

イスのバージョン
サポートするデータ種別

7

dataTypeId

対応データ種別ID

ID。基本仕様書に記載されてStringいるデータ種別 ID に対応する値。基本仕様書の 4.4.1 項"00000001
00000000"を参照。
8

dataTypeKey

対応データ種別
プライマリー

Stringサポートするデータ種別の"facility

データを一意に特定するプ

Id"

60
WPSC004-Ed.1.1 2021-02

キープロパティ

ロパティ名。

名

複数ある場合は、カンマで区切る。
ゲートウェイが水道標準プ

9protocolプロトコル種別

String

ラットフォームに対して、送信時に使用する通信プロト
コル。

10

accessUrl

アクセス先 URI

String

空欄"MQTT"or"HTTP"""

ゲートウェイがサポートす11

contentType

対応コンテンツタイプ

Stringるコンテンツタイプ一覧

applicati

複数項目がある場合は、カン

on/xmlマで区切る。

6. 機器ベンダー向け標準インターフェイス(システム) フォーマット例
定周期データ蓄積のデータ送信データフォーマット例 (HTTP(S))
HTTP(S)で定周期データ蓄積する際のイベントデータのメッセージ例を以下に示す(図6-1)。

POST /sbi/v1/results_data/ HTTP/1.1 ← リクエスト メソッド
Host:www.******.***← データ種別X-CPS-dataTypeId: 0200000700000000← 操作種別 ID
X-CPS-Operation: GET← 依頼元情報X-CPS-Source-ID: 03-0000
Content-type: application/xml;charset=utf-8 ← 入出力形式← データ分割X-CPS-Data-Split: 001-001← タイムスタンプ
X-CPS-Timestamp: 2017-05-09T14:25:36.302Z← 要求 ID
X-CPS-monitoringRequestId: REQ00005← 実行結果コード
X-CPS-Result: 0
空白行<?xml version="1.0" encoding="utf-8"?>
水道 CPS データプロファイル仕様書の 2.4 節を参照

HTTP
プロトコル
ヘッダ

HTTP
プロトコル
ボディ

図 6-1: 定周期データ蓄積のデータの応答フォーマット例 (HTTP(S))- 以上 -

61
WPSC004-Ed.1.1 2021-02