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

別冊

アプリベンダー向け
標準インターフェイス仕様書
WPSC002 EDITION 1.1

2021 年 2 月

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

WPSC002-Ed.1.1 2021-02

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

WPSC002-Ed.1.1 2021-02

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

WPSC002-Ed.1.1 2021-02

- 目次 –
はじめに ........................................................................ 1
本ドキュメントの目的 ......................................................... 1
水道情報活用システム標準仕様のドキュメント.................................... 2
ドキュメント体系 .......................................................... 2
対象読者と役割 ............................................................ 3
本書の対象読者 ............................................................ 4
参考文献 ..................................................................... 5
用語の説明 ................................................................... 8
本ドキュメントの記載範囲 .................................................... 10
アプリケーション利用までに必要な事前準備 ....................................... 11
アプリケーション基本情報の登録申請 .......................................... 12
アプリケーション利用情報の取得と登録 ........................................ 13
鍵情報と電子証明書の取得と設定 .............................................. 15
アプリケーションの接続 ...................................................... 16
アプリケーションの切断 ...................................................... 17
アプリベンダー向け標準インターフェイス仕様 ..................................... 18
API 一覧 .................................................................... 18
プロトコル .................................................................. 20
HTTP(S)プロトコル ........................................................ 20
WebSocket(S)プロトコル ................................................... 24
セキュリティ ................................................................ 26
基本的な処理の流れ .......................................................... 27
アプリケーション接続 ..................................................... 27
アプリケーション切断 ..................................................... 28
データ操作(追加、変更、削除、参照) ....................................... 29
API 共通仕様 ................................................................ 40
メッセージ仕様 ........................................................... 40
インターフェイス詳細仕様(IoT ゲートウェイ) ...................................... 43
アプリケーション接続 API..................................................... 43
WPSC002-Ed.1.1 2021-02

アプリケーション切断 API..................................................... 47
マスタデータ参照 API ........................................................ 51
施設マスタデータ参照 API .................................................. 51
設備マスタデータ参照 API .................................................. 55
機器・計測項目マスタデータ参照 API ........................................ 58
即時取得 API ................................................................ 62
定周期監視実行 API .......................................................... 69
定周期監視一覧取得 API....................................................... 74
定周期監視停止 API .......................................................... 78
制御値設定 API .............................................................. 82
公開鍵証明書ファイル取得 API ................................................. 92
即時取得（蓄積）API ........................................................ 96
ドキュメント参照(AP)(デバイス)API ......................................... 100
ドキュメント登録操作(AP)(デバイス)API ..................................... 103
ドキュメント更新操作(AP)(デバイス)API ..................................... 106
ドキュメント削除操作(AP)(デバイス)API ..................................... 108
ファイル参照 API .......................................................... 110
ファイル登録操作 API ...................................................... 110
ファイル削除操作 API ...................................................... 110
インターフェイス詳細仕様(システムゲートウェイ)................................. 111
ドキュメント参照 API ....................................................... 111
ドキュメント登録操作 API.................................................... 114
ドキュメント更新操作 API.................................................... 116
ドキュメント削除操作 API.................................................... 118
ファイル参照 API ........................................................... 120
ファイル登録操作 API ....................................................... 122
ファイル削除操作 API ....................................................... 124
マスタデータ参照（システム）API ............................................ 126
公開鍵証明書ファイル取得 API ................................................ 129
データプロパティ仕様 .......................................................... 130
施設マスタのプロパティ仕様 ................................................. 130
設備マスタのプロパティ仕様 ................................................. 131
機器マスタのプロパティ仕様 ................................................. 132
計測項目マスタのプロパティ仕様 ............................................. 133

WPSC002-Ed.1.1 2021-02

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

1
WPSC002-Ed.1.1 2021-02

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

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

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

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

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

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

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

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

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

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

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

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

2
WPSC002-Ed.1.1 2021-02

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

3
WPSC002-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
WPSC002-Ed.1.1 2021-02

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

1

参考文献

ISO 8601

説明

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

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

MQTT Protocol

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

Specification

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
WPSC002-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
WPSC002-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
WPSC002-Ed.1.1 2021-02

用語の説明水道情報活用システム標準仕様で使用する用語の説明を以下に示す(表 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
WPSC002-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
WPSC002-Ed.1.1 2021-02

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

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

社会インフラ水道情報活用システム標準仕様では、
IoT ゲートウェイからデバイスに対して、制御信号などのデバイスの動作に係わる指示を送ることは想定していない。

10
WPSC002-Ed.1.1 2021-02

アプリケーション利用までに必要な事前準備
広域向けアプリケーションを開発し、そのアプリケーションが事業体で利用可能になるまでの事前準備を以下に示す(表 2-1)。
表 2-1:アプリケーション利用までに必要な事前準備
No

項目

内容
アプリケーション開発ベンダーが、プラットフォーマーに対し、広域向

アプリケーション1

基本情報の登録申請

けアプリケーションのアプリケーション基本情報を水道標準プラットフ
ォームに登録申請する。これにより、事業体がそのアプリケーションを利用申請できるようになる。

アプリケーション基本情報の内容は 2.1 節を参照。
アプリケーション開発ベンダーが、プラットフォーマーから取得した事

2

アプリケーション

業体の利用情報を広域向けアプリケーションに登録する。これにより、の利用情報の取得

事業体がアプリケーションを利用可能になる。

と登録
アプリケーション利用情報の内容は 2.2 節を参照。

アプリケーション開発ベンダーが、プラットフォーマーから取得した鍵3

鍵情報と電子証明書の取得と設定

情報と電子証明書を広域向けアプリケーションに設定する。
(通信暗号、相互認証、データの暗号化、電子書名の付与で利用)

鍵情報と電子証明書の取得の内容は 2.3 節を参照。

広域向けアプリケーションを水道標準プラットフォームに接続する。こ4

アプリケーション

れにより、アプリケーションが利用可能になる。

の接続
アプリケーション接続情報の内容は 2.4 節を参照。

アプリケーションを水道標準プラットフォームから切断する。これによ5

アプリケーション

り、水道標準プラットフォームからアプリケーションを切断する。

の切断
アプリケーション接続情報の内容は 2.5 節を参照。

11
WPSC002-Ed.1.1 2021-02

アプリケーション基本情報の登録申請
アプリケーション開発ベンダーが、プラットフォーマーに対し、広域向けアプリケーションのアプリケーション基本情報を水道標準プラットフォームに登録申請する。これにより、事業体がそのアプリケーションを利用申請できるようになる。
アプリケーション基本情報の項目を以下に示す(表 2-2)。
表 2-2: アプリケーション基本情報
No.

項目

内容
広域向けアプリケーションの ID。

1

アプリケーション ID

2

アプリケーション名称

広域向けアプリケーションの名称。

3

アプリケーションの説明

広域向けアプリケーションの機能の説明。

詳細は基本仕様書の 3.1.2 項を参照。

広域向けアプリケーションで、ユーザーがログインしていない
4

サービスアカウント要否

時に水道標準プラットフォームの標準インターフェイスをバッ
クグランドで動作させるか否かを指定。

12
WPSC002-Ed.1.1 2021-02

アプリケーション利用情報の取得と登録
アプリケーション開発ベンダーが、プラットフォーマーから取得した事業体の利用情報を広域向けアプリケーションに登録する。これにより、事業体がアプリケーションを利用可能になる。
アプリケーション利用情報の項目を以下に示す(表 2-3)。
表 2-3: アプリケーション利用情報
No.

項目

内容
広域向けアプリケーションの ID。

1

アプリケーション ID

前述(表 2-2)のアプリケーション ID と同一の文字列である必要
がある。

2

3

事業体 ID

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

アプリケーションを利用する事業体 ID。
基本仕様書の 3.1.2 項を参照
水道標準プラットフォームの FQDN 名。
アプリケーションがアプリベンダー向け標準インターフェイスを使用するために必要。
アプリケーションのトップページの URL。

4

アクセス先 URL

ユーザー/事業体がアプリケーションにアクセスするために必要。

5

認証レルム名認証の適用範囲を示すレルム名。

6

認証サーバーURL

認証サーバーの URL。

OpenID Connect※認証に用いられるクライアント ID。クライアン
7

認証クライアント ID

ト ID はシステム全体でユニークな文字列である必要がある。ア
プリケーション ID と利用事業体 ID を組み合わせた文字列とする。

8

認証リダイレクト URL

9

認証シークレット

OpenID Connect※認証プロトコルによって認証サーバーにログイ
ン、又はログアウト後にブラウザでリダイレクト先となる URL。

OpenID Connect※認証プロトコルで使用する鍵。

※: OpenID Connect は、広域向けアプリケーションのユーザー認証に使用されるアイデンティティ
連携プロトコルである。詳細については、CPS/IoT セキュリティ仕様書の 2.3 節を参照。

13
WPSC002-Ed.1.1 2021-02

水道標準プラットフォームが OpenID Connect 以外の認証方式も実装している場合、上記の表
2-3 以外の項目がアプリケーション利用情報に含まれている場合がある。

14
WPSC002-Ed.1.1 2021-02

鍵情報と電子証明書の取得と設定
アプリケーション開発ベンダーが、プラットフォーマーから取得した鍵情報と電子証明書を広域向けアプリケーションに設定する。
詳細は CPS/IoT セキュリティ仕様書の 2 章を参照。
なお証明書は、定期的に水道標準プラットフォームにて最新バージョンを更新するが、古いバージョンも一定期間保持する仕様となっている。アプリケーションやゲートウェイが初期取得時のバージョンのまま運用するか、定期的に最新バージョンに更新するかは、水道標
準プラットフォームの導入時に選択できる。

15
WPSC002-Ed.1.1 2021-02

アプリケーションの接続
広域向けアプリケーションを水道標準プラットフォームに接続する。これにより、アプリケ
ーションが利用可能になる。
アプリケーション接続では、アプリケーションから水道標準プラットフォームへ接続情報を登録する。登録する接続情報を以下に示す(表 2-4)。
表 2-4: アプリケーション接続情報
No.

名称

説明
水道標準プラットフォームが広域向けアプリケーションを一意に

1

アプリケーション ID

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

2

事業体 ID

アプリケーションを利用する事業体 ID。
基本仕様書の 3.1.2 項を参照

水道標準プラットフォームでは、アプリケーション接続で登録された情報からアプリケーシ
ョンを識別する。これにより水道標準プラットフォームは、当該アプリケーションが接続しても良いアプリケーションかどうかを判定する。水道標準プラットフォームに接続しても良いと判断された場合、アプリケーション接続情報を水道標準プラットフォームへ登録する。これにより、そのアプリケーションはユーザーから利用可能になる。水道標準プラットフォームに接続しても良いと判断されなかった場合、水道標準プラットフォームはそのアプリケーションの接続を拒絶し、ユーザーから利用することができない。
アプリケーション接続の詳細は後述の 3.4.1 項及び 4.1 節を参照。

16
WPSC002-Ed.1.1 2021-02

アプリケーションの切断
アプリケーションを水道標準プラットフォームから切断する。これにより、水道標準プラッ
トフォームからアプリケーションを切断する。
水道標準プラットフォームでは、アプリケーション切断で指定されたアプリケーションが接続済みかどうかを判定する。接続済みだった場合、そのアプリケーションの接続を無効にする。
接続済みではなかった場合、エラーを返却する。
アプリケーション切断の詳細は後述の 3.4.2 項及び 4.2 節を参照。

17
WPSC002-Ed.1.1 2021-02

アプリベンダー向け標準インターフェイス仕様
アプリベンダー向け標準インターフェイスに必要な以下の 3 つを示す。
・API 一覧
・プロトコル・基本的な処理の流れ

API 一覧
アプリベンダー向け標準インターフェイスの API の一覧を以下に示す。
表 3-1: API 一覧(IoT ゲートウェイ)
No.
1

2

3

用途

API 名

説明

アプリケーション接続

アプリケーションを水道標準プラットフォームに

アプリケー

API

接続する API。

ション利用

アプリケーション切断

アプリケーションを水道標準プラットフォームかAPI

ら切断する API。

マスタ参照

マスタデータ参照 API

施設マスタ、設備マスタ、機器マスタ等を参照する API。
計測対象データの現在値の監視要求を実行する

4

即時取得 APIAPI。本 API を実行すると、応答で計測対象デー
タの現在値を取得できる。

5

定周期監視実行 API
データ監視

計測対象データの定周期での監視要求を実行するAPI。

6

定周期監視一覧取得 API 現在実行中の定周期監視を一覧で取得する API。

7

定周期監視停止 API

現在実行中の定周期監視を停止する API。
ユーザ操作またはアプリケーション判断（インタ

8

データ制御

制御値設定 API

ーロックなど）により IoT ゲートウェイへ制御要求を通知し、IoT ゲートウェイによるデバイスの制御を依頼する API。

公開鍵証明書ファイル

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

取得 API

API。

9

データ保護

10

データ取得

即時取得（蓄積）API

ドキュメン

ドキュメント登録操作

ト操作（デバイス）API

11

定周期で取得した、PF 内に蓄積されている値を取得する命令を発行する API。

データベースにドキュメントの登録を行う API。

18
WPSC002-Ed.1.1 2021-02

No.

用途

API 名

説明

ドキュメント更新操作

データベースに蓄積されているドキュメントの更（デバイス）API新を行う API。

ドキュメント削除操作

データベースに蓄積されているドキュメントの削（デバイス）API除を行う API。

ファイル参照（デバイ

オブジェクトストレージに格納されているファイス）APIルもしくはファイルパスの一覧を取得する API。

ファイル操

ファイル登録操作（デオブジェクトストレージにファイルを登録する

作バイス）API

API。

ファイル削除操作（デオブジェクトストレージからファイルを削除するバイス）API

API。

12

13

14

15

16

表 3-2: API 一覧(システムゲートウェイ)
No.

用途

1

2

3

ドキュメント参照 API
ドキュメント登録操作

データベースからドキュメントの参照を行う
API。
データベースにドキュメントの登録を行う API。

API

ト操作

ドキュメント更新操作

データベースに蓄積されているドキュメントの更API新を行う API。

ドキュメント削除操作

データベースに蓄積されているドキュメントの削API除を行う API。

5

ファイル参照 API
ファイル操
作

7

7

説明

ドキュメン

4

6

API 名

ファイル登録操作 API

ファイル削除操作 API

マスタ参照

オブジェクトストレージに格納されているファイルもしくはファイルパスの一覧を取得する API。
オブジェクトストレージにファイルを登録するAPI。
オブジェクトストレージからファイルを削除する
API。

マスタデータ参照（シリソースマスタとデータ項目マスタから情報を取ステム）API

得する API。

19
WPSC002-Ed.1.1 2021-02

プロトコル
アプリベンダー向け標準インターフェイスで使用するプロトコルを以下に示す(表 3-3)。
表 3-3: アプリベンダー向け標準インターフェイスのプロトコル
No.

プロトコル

説明
広域向けアプリケーションから水道標準プラットフォームへ要求を行う

1

HTTP(S)

2

WebSocket(S)際に使用するプロトコル。SSL/TLS で暗号化されなければならない。
水道標準プラットフォームから広域向けアプリケーションへの通信を行う際に使用するプロトコル※。SSL/TLS で暗号化されなければならない。

※： 接続要求は広域向けアプリケーションから行う。

なお、データベースへの高トランザクション処理など、上記プロトコルでは対応困難な通信処理が発生する場合には、その処理に適したプロトコル（例えば ODBC 等）によって、前項の APIを暫定的に実装することを検討するものとする。

HTTP(S)プロトコル
広域向けアプリケーションと水道標準プラットフォーム間で使用する、HTTP(S)プロトコルの要求と応答を以下に示す(図 3-1)。

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

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

要求

応答

図 3-1: HTTP(S)プロトコルの要求と応答

アプリベンダー向け標準インターフェイスでは HTTP(S)プロトコルはアプリケーション接続、切断及びデータ操作の要求と応答で使用する。要求は広域向けアプリケーションが実施
し、応答は水道標準プラットフォームが実施する。
ベース URL は以下とし、ポート番号は 443 とする。

https://${水道標準プラットフォームのホスト名}

20
WPSC002-Ed.1.1 2021-02

水道標準プラットフォームのホスト名はプラットフォーマーが定義する。
以下では、アプリベンダー向け標準インターフェイスのデータ項目の HTTP(S)プロトコル
における設定方法を示す。各 API の詳細な設定方法は後述の 4. 5. 章を参照。

21
WPSC002-Ed.1.1 2021-02

アプリケーション接続、切断要求のデータ項目の設定内容「基本仕様書」に示すアプリケーション接続、切断要求のデータ項目の HTTP(S)プロトコルによる設定内容を以下に示す(図 3-2)。
POST /cps-platform/api/v1/{データ種別 ID}/ HTTP/1.1

HTTP リクエスト行

X-CPS-Operation: {操作種別 ID}
Content-type: {入出力形式※1}
Accept: {入出力形式※2}

HTTP リクエストヘッダ

X-CPS-Timestamp: {タイムスタンプ}... (その他の HTTP ヘッダ) ...

空行

{データ}

HTTP リクエストボディ※ 1:入力時の入出力形式を指定※ 2:出力時の入出力形式を指定

図 3-2: HTTP(S)プロトコルによるアプリケーション接続、切断要求のデータ項目の設定

アプリケーション接続、切断応答のデータ項目の設定内容「基本仕様書」に示すアプリケーション接続、切断応答のデータ項目の HTTP(S)プロトコルによる設定内容を以下に示す(図 3-3)。
HTTP/1.1 {実行結果コード} {実行結果説明文字列}

HTTP ステータス行

Content-type: {入出力形式 ※1}
X-CPS-Timestamp: {タイムスタンプ}

HTTP レスポンスヘッダ... (その他の HTTP ヘッダ) ...
空行

{データ}

HTTP レスポンスボディ※ 1:出力時の入出力形式を指定

図 3-3: HTTP(S)プロトコルによるアプリケーション接続、切断応答のデータ項目の設定

22
WPSC002-Ed.1.1 2021-02

データ操作要求のデータ項目設定内容
基本仕様書の表 4-8 に示すデータ操作要求のデータ項目の HTTP(S)プロトコルによる設定内容を以下に示す(図 3-4)。

POST /cps-platform/api/v1/{データ種別 ID}/ HTTP/1.1

HTTP リクエスト行

X-CPS-Operation: {操作種別 ID}
Authorization: {依頼元情報}
Content-type: {入出力形式※1}
HTTP リクエストヘッダ

Accept: {入出力形式※2}
X-CPS-Timestamp: {タイムスタンプ}... (その他の HTTP ヘッダ) ...

空行

{データ}

HTTP リクエストボディ※ 1:入力時の入出力形式を指定※ 2:出力時の入出力形式を指定

図 3-4: HTTP(S)プロトコルによるデータ操作要求のデータ項目設定

上記(図 3-4)に記載した依頼元情報の指定方法は、OpenID Connect による認証・認可を前提としている。
指定方法の詳細は 4.9 節を参照。
水道標準プラットフォームが OpenID Connect
以外の方式も提供している場合は、その方式に従い、Authorization ヘッダ以外の箇所で依頼元情報を指定してもよい。

23
WPSC002-Ed.1.1 2021-02

データ操作応答のデータ項目設定内容
基本仕様書の表 4-9 に示すデータ操作応答のデータ項目の HTTP(S)プロトコルによる設定内容を以下に示す(図 3-5)。

HTTP ステータス行

HTTP/1.1 {実行結果コード} {実行結果説明文字列}
Content-type: {入出力形式 ※1}
X-CPS-Timestamp: {タイムスタンプ}

HTTP レスポンスヘッダ... (その他の HTTP ヘッダ) ...
空行

{データ}

HTTP レスポンスボディ※ 1:出力時の入出力形式を指定

図 3-5: HTTP(S)プロトコルによるデータ操作応答のデータ項目設定

WebSocket(S)プロトコル
広域向けアプリケーションと水道標準プラットフォーム間で使用する、WebSocket(S)プロ
トコルの接続を以下に示す(図 3-6)。

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

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

接続

接続結果

繰り返し
受信(イベントデータ)

図 3-6: WebSocket(S)プロトコルの接続

24
WPSC002-Ed.1.1 2021-02

アプリベンダー向け標準インターフェイスでは WebSocket(S)プロトコルはイベントデータの受信に使用する。WebSocket(S)の接続は広域向けアプリケーションが実施する。イベント
データは、水道標準プラットフォームが送信し、広域向けアプリケーションが受信する。
イベントデータのデータ項目設定内容
基本仕様書の表 4-10 に示すイベントデータのデータ項目の WebSocket(S)プロトコルによる設定内容を以下に示す(図 3-7)。

WebSocket
ペイロードデータ{データ}

図 3-7: WebSocket(S)プロトコルによるイベントデータのデータ項目設定

25
WPSC002-Ed.1.1 2021-02

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

26
WPSC002-Ed.1.1 2021-02基本的な処理の流れ
本節では、アプリベンダー向け標準インターフェイスの基本的な処理の流れとして以下の 5つを示す。
・アプリケーション接続
・アプリケーション切断
・データ操作(参照)プル型
・データ操作(参照)プッシュ型
・データ操作(変更)プル型

アプリケーション接続
ユーザーが広域向けアプリケーションを利用するためには、広域向けアプリケーションは水道標準プラットフォームに接続する必要がある。
アプリケーション接続の詳細フローを以下に示す。

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

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

アプリケーション接続

アプリベンダー向け
標準インターフェイス(アプリケーション接続 API)

アプリケーションを識別、判定

アプリケーション接続情報を登録
接続結果

図 3-8: 詳細フロー (アプリケーション接続)

27
WPSC002-Ed.1.1 2021-02

アプリケーション切断
既に接続済みの広域向けアプリケーションを水道標準プラットフォームから切断するためには、広域向けアプリケーションはアプリケーション切断を実施する必要がある。
アプリケーション切断の詳細フローを以下に示す（図 3-9）。

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

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

アプリケーション切断
アプリケーションが接続済みかどうかを判定アプリベンダー向け
標準インターフェイス(アプリケーション切断 API)

当該アプリケーションのためのすべての処理を停止※接続済みアプリケーションの接続情報を無効化

切断結果※: 監視要求の停止や監視結果通知先 (WebSocket(S)) の切断など
図 3-9: 詳細フロー (アプリケーション切断)

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

28
WPSC002-Ed.1.1 2021-02

データ操作(追加、変更、削除、参照)
データ操作とは、ユーザーがデバイス・システム、外部サービスのデータをゲートウェイ、
水道標準プラットフォーム及び広域向けアプリケーションを介して操作する処理である。
データ操作(参照)には以下 3 つの処理がある。
・データ操作(参照)プル型
・データ操作(参照)プッシュ型
・データ操作(変更)プル型
また DB 操作、ファイル操作の処理として以下 4 つがある。
・DB 操作(追加/変更/削除)プル型
・DB 操作(参照)プル型
・ファイル操作(追加/変更/削除)プル型
・ファイル操作(参照)プル型

29
WPSC002-Ed.1.1 2021-02

データ操作(参照)プル型
IoT ゲートウェイを通してデータを取得する場合
IoT ゲートウェイを通してデータを取得するためには、即時取得 API を利用する。即時取得 API の詳細は、4.4 節を参照。
応答には監視結果通知先情報が連絡される。HTTP(S)プロトコルでは、WebSocket(S) URI
がそれに対応する。広域向けアプリケーションを利用して通知チャネル(WebSocket(S))に接続することで、そのチャネルを通してデータを非同期で受け取ることができるようになる。処理の流れを以下に示す（図 3-10）。
広域向け
アプリケーション

ユーザー

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

IoT
ゲートウェイ

デバイス

デ
ー
タ
参
照

デ
ー
タ
送
信

ログイン

利用可能なアプリケーション一覧

ロ
グ
イ
ン

利用アプリケーション実行

監
視
要
求
情
報
作
成
データの要求※1

アプリベンダーデ向けー標準インタータフェイス
監
視 データの要求応答
要 (監視結果通知先
求 情報を連絡)

要求を受
信機器ベンダー
向け標準インター
フェイス(デバイス)

データの表示

監
視
応
答
情
報
処
理

イベントデータ※2(プッシュ通信)

蓄
積
・
加
工
【凡例】
：標準化対象インターフェイス：標準化非対象インターフェイス※1: 即時取得 API。詳細は 4.4 節を参照。
※2: 即時取得 API の WebSocket(S)による接続。詳細は 4.4 節を参照。
図 3-10: データ操作(参照)プル型(IoT ゲートウェイからデータを即時取得する場合)

30
WPSC002-Ed.1.1 2021-02

システムゲートウェイを通してデータを取得する場合
システムゲートウェイを通してデータを取得するためには、ドキュメント参照 API を利用する。ドキュメント参照 API の詳細は、5.1 節を参照。
応答には監視結果通知先情報が連絡される。HTTP(S)プロトコルでは、WebSocket(S) URI
がそれに対応する。広域向けアプリケーションを利用して通知チャネル(WebSocket(S))に接続することで、そのチャネルを通してデータを非同期で受け取ることができるようになる。処理の流れを以下に示す（図 3-11）。
広域向け
アプリケーション

ユーザー

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

システム
ゲートウェイ

システム

デ
ー
タ
格
納

デ
ー
タ
送
信

ログイン

利用可能なアプリケーション一覧

ロ
グ
イ
ン

利用アプリケーション実行

監
視
要
求
情
報
作
成
データの要求※1

アプリベンダーデ向けー標準インタータフェイス
監視
要 データの要求応答
求 (監視結果通知先情報を連絡)

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

データの表示

監
視
応
答
情
報
処
理

イベントデータ※2(プッシュ通信)

デ
ー
タ
参
照

蓄
積
・
加
工
【凡例】
：標準化対象インターフェイス：標準化非対象インターフェイス※1: ドキュメント参照 API。詳細は 5.1 節を参照。
※2: ドキュメント参照 API の WebSocket(S)による接続。詳細は 5.1 節を参照。
図 3-11: データ操作(参照)プル型(システムゲートウェイからデータを即時取得する場合)

31
WPSC002-Ed.1.1 2021-02

データ操作(参照)プッシュ型
IoT ゲートウェイを通してデータを取得するためには、
定周期監視実行 API を利用する。
定周期監視実行 API の詳細は、4.5 節を参照。
応答には監視結果通知先情報が連絡される。HTTP(S)プロトコルでは、WebSocket(S) URI
がそれに対応する。広域向けアプリケーションを利用して通知チャネル(WebSocket(S))に接続することで、そのチャネルを通してデータを非同期で受け取ることができるようになる。処理の流れを以下に示す（図 3-12）。

32
WPSC002-Ed.1.1 2021-02

ユーザー

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

利用アプリケーション実行

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

IoT
ゲートウェイ

デバイス

監
視
要
求
情
報
作
成
プッシュ指示の要求※1

デ
ー
タ
監
視
要
求

アプリベンダー向け
標準インター
フェイス
プッシュ指示の応答(監視結果通知先情報を連絡)

デ
ー
タ
監
視
要
求

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

監
視
要
求
設
定

監視結果
通知先接続※2

デ
ー
タ
通
知
受
信
用
意

アプリベンダー向け
標準インター
フェイス
成功

監
視
結
果
通
知
先
接
続

IoT ゲートウェイでイベント発生毎に、監視結果通知先情報を通して広域向けアプリケーションにイベントデータを繰り返し通知

繰り返し

アプリベンダー向け
標準インターフェイス
監視※3
応 イベントデータ
答 (プッシュ通信)
情※3
報 イベントデータ
処 (プッシュ通信)
理

デ
ー
タ
受
信
・
蓄
積
加
工

デ
ー
タ
参
照

イベントデータ(プッシュ通信)

デ
ー
タ
送
信

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

33
WPSC002-Ed.1.1 2021-02

※1 : 定周期監視実行 API。詳細は 4.5 節を参照。
※2 : 定周期監視実行 API の WebSocket(S)による接続。詳細は 4.5 節を参照。
※3 : 定周期監視実行 API の WebSocket(S)によるデータ受信。詳細は 4.5 節を参照。
図 3-12: データ操作(参照)プッシュ型(IoT ゲートウェイからデータを定周期取得する場合)

34
WPSC002-Ed.1.1 2021-02

データ操作(変更)プル型
ユーザ操作またはアプリケーション判断（インターロックなど）により IoT ゲートウ
ェイを通してデバイスを制御する場合
処理の流れを以下に示す（図 3-13）。
広域向け
アプリケーション

ユーザー

ログイン
利用可能なアプリケーション一覧

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

IoT
ゲートウェイ

デバイス

ロ
グ
イ
ン

利用アプリケーション実行
制御データの要求

制御データ通知の表示

デバイスへ通知の表示

制御結果の表示

ア
プ
リ
ケ
ー
シ
ョ
ン
上
で
Ｉ
ｏ
Ｔ
ゲ
ー
ト
ウ
ェ
イ
へ
の
操
作
制
御

デ
をー
受タ
信通
知
制御データ
通知の応答

デバイスへ通知の応答

アプリベンダー向け
標準インター
フェイス

制御結果の応答

デ
ー
タ
受
付

加
工
デ
をバ
受イ
信ス
通
知

加
工
を制
受御
信結
果

加
工

デ
バ
イ
ス
送
信

制
御
開
始

結
果
受
信

制
御
完
了

機器ベンダー
向け標準インター
フェイス(デバイス)【凡例】：標準化対象インターフェイス：標準化非対象インターフェイス※: 制御値設定 API。詳細は 4.8 節を参照。
図 3-13: データ操作(変更)プル型(IoT ゲートウェイを通してデバイス制御する場合)

35
WPSC002-Ed.1.1 2021-02

DB 操作(登録/更新/削除)プル型
処理の流れを以下に示す（図 3-14）。

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

ユーザー

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

ログイン

ロ
グ
イ
ン

利用可能なアプリケーション一覧
利用アプリケーション実行

操
作
情
報
作
成
データの操作※

デ
ー
タ
操
作
要
求

結果の表示

アプリベンダー向け
標準インター
フェイス
結果の応答

デ
ー
タ
を
受
信
・
蓄
積

操
作
結
果
情
報
処
理

【凡例】
：標準化対象インターフェイス：標準化非対象インターフェイス※: ドキュメント登録操作 API。詳細は 5.2 節を参照。
図 3-14: DB 操作(登録/更新/削除)プル型

36
WPSC002-Ed.1.1 2021-02

DB 操作(参照)プル型
処理の流れを以下に示す（図 3-15）。

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

ユーザー

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

ログイン

ロ
グ
イ
ン

利用可能なアプリケーション一覧
利用アプリケーション実行

参
照
情
報
作
成
データの参照※

デ
ー
タ
参
照
要
求

結果の表示

アプリベンダー向け
標準インター
フェイス
結果の応答

デ
ー
タ
を
受
信
・
蓄
積

参
照
結
果
情
報
処
理

【凡例】
：標準化対象インターフェイス：標準化非対象インターフェイス※: ドキュメント参照 API。詳細は 5.1 節を参照。
図 3-15: DB 操作(参照)プル型

37
WPSC002-Ed.1.1 2021-02

ファイル操作(追加/変更/削除)プル型
処理の流れを以下に示す（図 3-16）。

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

ユーザー

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

ログイン

ロ
グ
イ
ン

利用可能なアプリケーション一覧
利用アプリケーション実行

操
作
情
報
作
成
ファイルの操作※

フ
ァ
イ
ル
操
作
要
求

結果の表示

アプリベンダー向け
標準インター
フェイス
結果の応答

フ
ァ
イ
ル
を
操
作
・
保
存

オブジェクトストレージ
対象ファイル

操
作
結
果
情
報
処
理

【凡例】
：標準化対象インターフェイス：標準化非対象インターフェイス※: ファイル登録操作 API。詳細は 5.6 節を参照。
図 3-16: ファイル操作(追加/変更/削除)プル型

38
WPSC002-Ed.1.1 2021-02

ファイル操作(参照)プル型
処理の流れを以下に示す（図 3-17）。

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

ユーザー

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

ログイン

ロ
グ
イ
ン

利用可能なアプリケーション一覧
利用アプリケーション実行

参
照
情
報
作
成
ファイルの参照※

フ
ァ
イ
ル
取
得
要
求

結果の表示

アプリベンダー向け
標準インター
フェイス
結果の応答

フ
ァ
イ
ル
を
参
照
・
取
得

オブジェクトストレージ
対象ファイル

参
照
結
果
情
報
処
理

【凡例】
：標準化対象インターフェイス：標準化非対象インターフェイス※: ファイル参照 API。詳細は 5.5 節を参照。
図 3-17: ファイル操作(参照)プル型

39
WPSC002-Ed.1.1 2021-02

API 共通仕様
メッセージ仕様
本項では、メッセージ仕様を記載する。
HTTP(S)のデータ記述仕様
HTTP(S)プロトコルでのデータの記述仕様を記載する。
データの記述仕様として以下に示すデータ書式を使用する（表 3-4)。
表 3-4: サポートするデータ書式一覧
No.

データ書式

MIME タイプ

1

JSON

application/json

2

XMLapplication/xml

ただし、API によってはどちらか一方のデータ書式のみを使用する。各 API で使用しているデータ書式は、各 API 仕様を参照。
各データ書式の MIME タイプを HTTP ヘッダ (Content-type ヘッダ及び Accept ヘッダ)に指定する必要がある。
各データ書式でのデータの記述仕様を以下に示す。

40
WPSC002-Ed.1.1 2021-02

JSON データ書式でのデータ記述仕様①単一のデータの記述仕様
JSON データ書式でデータを記述する場合は、各プロパティ名をキーとして JSON オブジ
ェクトでデータを表現する。
JSON データ書式でエラー情報(3.5.1 項の(2)を参照)を記述する例{"message": "ID not found."}②データの配列の記述仕様
JSON データ書式でデータの配列を記述する場合は、JSON 配列でデータを表現する。
JSON データ書式でエラー情報(3.5.1 項の(2)を参照)の配列を記述する例[{"message": "ID not found."},{"message": "Invalid StartDatetime."},{"message": "X-CPS-dataTypeId not specified."}]41
WPSC002-Ed.1.1 2021-02

XML データ書式でのデータ記述仕様①単一のデータの記述仕様
XML データ書式でデータを記述する場合は、プロパティ名を要素としてデータを表現する。
XML データ書式でエラー情報(3.5.1 項の(2)を参照)を記述する例<?xml version="1.0" encoding="UTF-8" standalone="true"?><message>ID not found.</message>②データの配列の記述仕様
XML データ書式でデータの配列を記述する場合は、"collection"という名称の要素をルート要素とし、その子要素としてプロパティ名を複数記述することでデータを表現する。
XML データ書式でエラー情報(3.5.1 項の(2)を参照)の配列を記述する例<?xml version="1.0" encoding="UTF-8" standalone="true"?><collection><message>ID not found.</message><message>Invalid StartDatetime.</message><message>X-CPS-dataTypeId not specified.</message></collection>

エラー情報
エラー情報のデータ名は "error" である。
エラー情報のプロパティ仕様を以下に示す（表 3-5）。
表 3-5: エラー情報(データ名: error)のプロパティ仕様
No.

データ名

1

メッセージ

プロパティ

内容

名

message

エラーの内容を示すメッセー
ジ型

例

string

ID not found.

(エラー発生時
2

エラー詳細

detail

エラーの詳細説明

stringのデバックトレース等の文字列)

42
WPSC002-Ed.1.1 2021-02

インターフェイス詳細仕様(IoT ゲートウェイ)
本章では、IoT ゲートウェイに関連する各 API に対して以下の 2 つを示す。
・HTTP(S)プロトコルでの要求と応答のデータ項目設定
・WebSocket(S)プロトコルでのイベントデータのデータ項目設定
ただし API によっては使用する項目が異なる。

アプリケーション接続 API
アプリケーション接続 API を以下に示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
アプリケーション接続 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)でアプリケーション接続情報を広域向けアプリケーションから水道標準プラッ
トフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-1: HTTP(S)リクエストのパラメーター（アプリケーション接続 API）
No

種

(データ項目)

.

別

名称

1

HTTP メソッドクエパス（URL）

ト
行

4

5

任意/

書式

不要
“POST”固定

必須

文 字
列

dataTypeId}/connection/(X-CPS-dataTypeId"0000000100000000"

必須

文 字
列

を指定)

ス
3

説明

/api/v1/{X-CPS-

リ
2

必須/

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

必須

文字コード

utf-8

必須

ヘ

要 求す るデ ータ の種 別から ”接 続情 報

ッ(0000000100000000)”を指定。データ種別

ダ (データ種別 ID)

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

X-CPS-dataTypeId

URL パスの X-CPS-dataTypeId にデータ種

必須

文 字
列
文 字
列

文 字
列

別 ID を指定。
("0000000100000000"を指定)

43
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
アプリケーション接続に対する操作の種

6(操作種別 ID)類(追加(POST))を指定。操作種別 ID は、

X-CPS-Operation

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

必須

文 字
列

("POST"を指定)
7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定

必須

文 字
列

入力時の入出力形式(入力形式)

8

Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定必須・"application/xml"

文 字列

・"application/json"
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定必須・"application/xml"

文 字列

・"application/json"(タイムスタンプ)

10

11

12

X-CPS-Timestamp
ボ (リクエスト)デ request
ィISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須(生成日時(リクエスト時刻)を指定)

文 字列

ボディ包括タグ（事業体 ID）

アプリケーション接続情報を指定

companyId

詳細は後述の 6.1 節を参照

必須

文 字
列

44
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)でアプリケーション接続の通信結果を水道標準プラットフォームから広域向けアプリケーションに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-2: HTTP(S)レスポンスのパラメーター（アプリケーション接続 API）
No

種

(データ項目)

.

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ン
ス(実行結果コード)
Status Code

行

書式

不要

レ

ポ
1

必須/

果コード
・処理成功：200 固定

必須

・処理失敗：500 番台

文 字列

・接続不可：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation"NULL"固定不要"NULL"固定

不要

文 字
列
文 字
列

リクエストで指定した Accept の内容
4(出力形式)"application/xml"

Content-type

または

必須

文 字
列

"application/json"(タイムスタンプ)

5

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

文 字列

ボ 【処理成功の時】
デ(レスポンス)ィ

response

ボディ包括タグ（ 接 続 先 URI （ 即時 監視））
6

accessUrl

アプリケーション接続で広域アプリケー
ション が WebSocket と接続する ための（ 接 続 先 URI （ 制御 操 URL。
作））

必須

文 字
列

accessUrlControl

45
WPSC002-Ed.1.1 2021-02

No

種(データ項目).

別名称【処理失敗の時】（メッセージ）
message（エラー詳細）

必須/
説明

任意/

書式

不要
任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に

必須

準拠する。

文 字
列

detail【接続不可の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に（エラー詳細）

必須

文 字
列

準拠する。

detail46
WPSC002-Ed.1.1 2021-02

アプリケーション切断 API
アプリケーション切断 API を以下に示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
アプリケーション切断 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)でアプリケーション切断情報を広域向けアプリケーションから水道標準プラッ
トフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-3: HTTP(S)リクエストのパラメーター（アプリケーション切断 API）
No

種

(データ項目)

.

別

名称

1

HTTP メソッドクエパス（URL）

ト
行

4

5

任意/

書式

不要
“POST”固定

必須

文 字
列

dataTypeId}/disconnect/(X-CPS-dataTypeId"0000000100000000"

必須

文 字
列

を指定)

ス
3

説明

/api/v1/{X-CPS-

リ
2

必須/

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

必須

文字コード

utf-8

必須

ヘ

要 求す るデ ータ の種 別から ”接 続情 報

ッ(0000000100000000)”を指定。データ種別

ダ (データ種別 ID)

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

X-CPS-dataTypeId

URL パスの X-CPS-dataTypeId にデータ種

必須

文 字
列
文 字
列

文 字
列

別 ID を指定。
("0000000100000000"を指定)
アプリケーション接続に対する操作の種
6(操作種別 ID)類(追加(POST))を指定。操作種別 ID は、

X-CPS-Operation

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

必須

文 字
列

("DELETE"を指定)

47
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
入力時の入出力形式(入力形式)

7

Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定必須・"application/xml"

文 字列

・"application/json"
出力時の入出力形式(出力形式)

8

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定必須・"application/xml"

文 字列

・"application/json"(タイムスタンプ)

9

10

11

12

X-CPS-Timestamp
ボ (リクエスト)デ request
ィISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須(生成日時(リクエスト時刻)を指定)

文 字列

ボディ包括タグ(アプリケーション ID)
applicationId

アプリケーション接続情報を指定（事業体 ID）

詳細は後述の 6.1 節を参照

必須

文 字
列

companyId

48
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)でアプリケーション接続の通信結果を水道標準プラットフォームから広域向けアプリケーションに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-4: HTTP(S)レスポンスのパラメーター（アプリケーション切断 API）
No

種

(データ項目)

.

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ン
ス(実行結果コード)
Status Code

行

書式

不要

レ

ポ
1

必須/

果コード
・処理成功：200 固定

必須

・処理失敗：500 番台

文 字
列・未接続エラー：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation"NULL"固定不要"NULL"固定

不要

文 字
列
文 字
列

リクエストで指定した Accept の内容
4(出力形式)"application/xml"

Content-type

または

必須

文 字
列

"application/json"(タイムスタンプ)

5

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

ボ 【処理成功の時】
デ(レスポンス)ィ

response【処理失敗の時】（メッセージ）6

message（エラー詳細）

空文字

必須

文 字
列

文 字
列

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に

必須

準拠する。

文 字
列

Detail【接続不可の時】

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

（メッセージ）

アプリベンダー向け標準インターフェイ

messageス仕様書 項 3.5.1「メッセージ仕様」に

必須

文 字
列

49
WPSC002-Ed.1.1 2021-02

No

種(データ項目).

別名称（エラー詳細）

必須/
説明

任意/

書式

不要
準拠する。

detail50
WPSC002-Ed.1.1 2021-02

マスタデータ参照 API
施設マスタ、設備マスタ、機器マスタ、計測項目マスタのマスタデータを参照する API を示す。
表 4-5: データ種別に対応する API の一覧
No.

データ種別名対応 API

1

施設マスタ

施設マスタデータ参照 API

2

設備マスタ

設備マスタデータ参照 API

3

機器マスタ

4

計測項目マスタ

機器・計測項目マスタデータ参照 API

施設マスタデータ参照 API

HTTP(S)プロトコルでの要求と応答のデータ項目設定
施設マスタデータ取得 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)でデータ参照のリクエストを広域向けアプリケーションから水道標準プラット
フォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4.3.1-1: HTTP(S)リクエストのパラメーター（施設マスタデータ参照 API）
No

種

(データ項目)

.

別

名称

1

HTTP メソッド
リ

2

ク
エ

説明

任意/

パス（URL）“POST”固定

必須{X-CPS-dataTypeId}は参照するデータに対必須応するデータ種別 ID

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

必須

utf-8

必須

行
4

5

文字コード

書式

不要

/api/v1/{X-CPS-dataTypeId}/

ス
3

必須/

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

施設マスタデータ参照(0100000100000001)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文 字
列
文 字
列
文 字
列
文 字
列

文 字
列

を参照

51
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
操作種別 ID の項目一覧から以下を指定

6(操作種別 ID)

・参照(GET)X-CPS-Operation

操作種別 ID は、基本仕様書の 4.4.2 項を参

必須

文 字
列

照("GET"を指定)
7(依頼元情報)RFC6750 に準拠した OpenID Connect アクセ

Authorization

ストークンを指定

必須

文 字
列

入力時の入出力形式(入力形式)

8

Content-type

IANA に登録された以下のいずれかの MIME タ
イプを指定

必須

・"application/xml"

文 字列

・"application/json"
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME タ
イプを指定

必須

・"application/xml"

文 字列

・"application/json"(タイムスタンプ)

10

X-CPS-Timestamp
ボ (リクエスト)デ request

11

ィISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須(生成日時(リクエスト時刻)を指定)

文 字列

ボディ包括タグ(事業体 ID)

施設を所有する事業体の ID

companyId

基本仕様書の 3.1.2 項を参照

(施設 ID)

施設 ID。水道標準プラットフォーム内で一facilityId意。基本仕様書の 3.1.2 項を参照

必須

任意

文 字
列
文 字
列

52
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)でデータ参照要求の通信結果を水道標準プラットフォームから広域向けアプリ
ケーションに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4.3.1-2: HTTP(S)レスポンスのパラメーター（施設マスタデータ参照 API）
No

種

(データ項目)

.

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・処理失敗：500 番台

必須

・不正要求：400 固定

文

字

列

・AP 未接続：404 固定（指定したリソースが見つからない）（マスタデータ情報 0 件）
ヘ
2

ッ
ダ

(出力形式)
Content-type(タイムスタンプ)

3

X-CPS-Timestamp
ボ (レスポンス)
デ responseィ(施設)
facility

4

リクエストで指定した Accept の内容"application/xml" または必須"application/json"
ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

取得件数分、繰り返し設定する

必須

施設 ID。水道標準プラットフォーム内でfacilityId

一意。基本仕様書の 3.1.2 項を参照

prefectureId(市区町村 ID)
cityId

字

列

文

字

列

ボディ包括タグ(施設 ID)(都道府県 ID)

文

必須

施設が存在する都道府県の ID
総務省の「都道府県コード及び市区町村コ 必須ード」を参照施設が存在する市区町村の ID
総務省の「都道府県コード及び市区町村コ 必須ード」を参照。

(事業体 ID)

施設を所有する事業体の ID

companyId

基本仕様書の 3.1.2 項を参照

必須

文

字

列
文

字

列
文

字

列

文

字

列
文

字

列

53
WPSC002-Ed.1.1 2021-02

No

種(データ項目).

別名称(施設名称)
facilityName

必須/
説明

任意/

書式

不要
施設の名称

任意

文

字

列

54
WPSC002-Ed.1.1 2021-02

設備マスタデータ参照 API

HTTP(S)プロトコルでの要求と応答のデータ項目設定
施設マスタデータ取得 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)でデータ参照のリクエストを広域向けアプリケーションから水道標準プラット
フォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4.3.2-1: HTTP(S)リクエストのパラメーター（設備マスタデータ参照 API）
No

種

(データ項目)

.

別

名称

1

HTTP メソッド
リ

2

ク
エ

説明

任意/

パス（URL）“POST”固定

必須{X-CPS-dataTypeId}は参照するデータに対必須応するデータ種別 ID

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

必須

utf-8

必須

行
4

5

文字コード

書式

不要

/api/v1/{X-CPS-dataTypeId}/

ス
3

必須/

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

設備マスタデータ参照(0100000200000001)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文 字
列
文 字
列
文 字
列
文 字
列

文 字
列

を参照
操作種別 ID の項目一覧から以下を指定
6(操作種別 ID)

・参照(GET)X-CPS-Operation

操作種別 ID は、基本仕様書の 4.4.2 項を参

必須

文 字
列

照("GET"を指定)
7(依頼元情報)RFC6750 に準拠した OpenID Connect アクセ

Authorization

ストークンを指定

必須

文 字
列

入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME タ
イプを指定
・"application/xml"

必須

文 字
列

・"application/json"

55
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME タ
イプを指定

必須

・"application/xml"

文 字列

・"application/json"(タイムスタンプ)

10

X-CPS-Timestamp
ボ (リクエスト)デ request

11

ィISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須(生成日時(リクエスト時刻)を指定)

文 字列

ボディ包括タグ(事業体 ID)

施設を所有する事業体の ID

companyId

基本仕様書の 3.1.2 項を参照

(設備 ID)

設備 ID。水道標準プラットフォーム内で一equipmentId意。基本仕様書の 3.1.2 項を参照

必須

任意

文 字
列
文 字
列

56
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)でデータ参照要求の通信結果を水道標準プラットフォームから広域向けアプリ
ケーションに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4.3.2-2: HTTP(S)レスポンスのパラメーター（設備マスタデータ参照 API）
No

種

(データ項目)

.

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・処理失敗：500 番台

必須

・不正要求：400 固定

文

字

列

・AP 未接続：404 固定（指定したリソースが見つからない）（マスタデータ情報 0 件）
ヘ
2

ッ
ダ

(出力形式)
Content-type(タイムスタンプ)

3

X-CPS-Timestamp
ボ (レスポンス)
デ responseィ(設備)
equipment

4

リクエストで指定した Accept の内容"application/xml" または必須"application/json"
ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

取得件数分、繰り返し設定する

必須

設備 ID。水道標準プラットフォーム内でequipmentId

一意。基本仕様書の 3.1.2 項を参照

(施設 ID)

施設 ID。水道標準プラットフォーム内でfacilityId

一意。基本仕様書の 3.1.2 項を参照

(設備区分コード)

設備の区分を表すコード値

equipmentCode

基本仕様書の 4.5.3 項を参照

(事業体 ID)

施設を所有する事業体の ID

companyId

基本仕様書の 3.1.2 項を参照

equipmentName

字

列

文

字

列

ボディ包括タグ

(設備 ID)(設備名称)

文

設備の名称

必須

必須

必須

必須

任意

文

字

列
文

字

列
文

字

列
文

字

列
文

字

列
文

字

列

57
WPSC002-Ed.1.1 2021-02

機器・計測項目マスタデータ参照 API

HTTP(S)プロトコルでの要求と応答のデータ項目設定
施設マスタデータ取得 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)でデータ参照のリクエストを広域向けアプリケーションから水道標準プラット
フォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4.3.3-1: HTTP(S)リクエストのパラメーター（設備マスタデータ参照 API）
No

種

(データ項目)

.

別

名称

1

HTTP メソッド
リ

2

ク
エ

説明

任意/

パス（URL）“POST”固定

必須{X-CPS-dataTypeId}は参照するデータに対必須応するデータ種別 ID

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

必須

utf-8

必須

行
4

5

文字コード

書式

不要

/api/v1/{X-CPS-dataTypeId}/

ス
3

必須/

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

設備マスタデータ参照(0100000300000001)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文 字
列
文 字
列
文 字
列
文 字
列

文 字
列

を参照
操作種別 ID の項目一覧から以下を指定
6(操作種別 ID)

・参照(GET)X-CPS-Operation

操作種別 ID は、基本仕様書の 4.4.2 項を参

必須

文 字
列

照("GET"を指定)
7(依頼元情報)RFC6750 に準拠した OpenID Connect アクセ

Authorization

ストークンを指定

必須

文 字
列

入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME タ
イプを指定
・"application/xml"

必須

文 字
列

・"application/json"

58
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME タ
イプを指定

必須

・"application/xml"

文 字列

・"application/json"(タイムスタンプ)

10

X-CPS-Timestamp
ボ (リクエスト)デ request
ィ11

ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須(生成日時(リクエスト時刻)を指定)

文 字列

ボディ包括タグ(事業体 ID)

施設を所有する事業体の ID

companyId

基本仕様書の 3.1.2 項を参照

(機器 ID)

機器 ID。水道標準プラットフォーム内で一machineId意。基本仕様書の 3.1.2 項を参照

(設備 ID)

設備 ID。水道標準プラットフォーム内で一equipmentId意。基本仕様書の 3.1.2 項を参照

必須

任意

任意

文 字
列
文 字
列
文 字
列

59
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)でデータ参照要求の通信結果を水道標準プラットフォームから広域向けアプリ
ケーションに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4.3.3-2: HTTP(S)レスポンスのパラメーター（機器・計測項目マスタデータ参照 API）
No

種

(データ項目)

.

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・処理失敗：500 番台

必須

・不正要求：400 固定

文

字

列

・AP 未接続：404 固定（指定したリソースが見つからない）（マスタデータ情報 0 件）
ヘ
2

ッ
ダ

(出力形式)
Content-type(タイムスタンプ)

3

X-CPS-Timestamp
ボ (レスポンス)
デ responseィ(機器計測項目)
machineMeasurement

4

リクエストで指定した Accept の内容"application/xml" または必須"application/json"
ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

取得件数分、繰り返し設定する

必須

機器 ID。水道標準プラットフォーム内でmachineId

一意。基本仕様書の 3.1.2 項を参照

(設備 ID)

設備 ID。水道標準プラットフォーム内でequipmentId

一意。基本仕様書の 3.1.2 項を参照

(機器区分コード)

機器の区分を表すコード値

machineCode

基本仕様書の 4.5.3 項を参照

(事業体 ID)

施設を所有する事業体の ID

companyId

基本仕様書の 3.1.2 項を参照

machineName

字

列

文

字

列

ボディ包括タグ(機器 ID)(機器名称)

文

機器の名称

必須

必須

必須

必須

任意

文

字

列
文

字

列
文

字

列
文

字

列
文

字

列
文

字

列

60
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

計測値区分コード

measurementCode

基本仕様書の 5.3.5 項を参照

measurementNumber(計測項目名称)
measurementName(現在値/履歴値)
valueType(アクセス制限)
accessPermission

書式

不要(計測値区分コード)(計測項目番号)

任意/

必須

計測項目番号

必須

計測項目の名称

任意

計測値の種別1 の場合、現在値

必須

2 の場合、履歴値
1 の場合、読み取り専用
2 の場合、書き込み専用
3 の場合、読み書き可能

必須

文

字

列
文

字

列
文

字

列
文

字

列

文

字

列

61
WPSC002-Ed.1.1 2021-02

即時取得 API
即時取得 API は IoT ゲートウェイから値を即時取得する命令を発行する API である。即時取得 API で取得するデータ種別を以下に示す。
表 4-6: 即時取得できるデータの種類一覧
No.

取得データ種別
計測分類コード※

1

取得内容

名称
現在値

IoT ゲートウェイが取得する現在のデバイスの計測値

履歴値

IoT ゲートウェイが取得する現在のデバイスの履歴値

計測（D1）
2

状態値

3

（現在値）
状態（D2）

状態値

4

（履歴値）
異常値

5

（現在値）
異常（D3）

異常値

6

（履歴値）

IoT ゲートウェイが取得する現在の状態値
IoT ゲートウェイが取得する過去の状態値
取得条件に過去時間を指定することで履歴値の取得が可能
IoT ゲートウェイが取得した現在の異常値
IoT ゲートウェイが取得した過去の異常値
取得条件に過去時間を指定することで履歴値の取得が可能※計測分類コードは。基本仕様書（表 4-20）を参照
HTTP(S)プロトコルでの要求と応答のデータ項目設定
即時取得 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-7: HTTP(S)リクエストのパラメーター（即時取得 API）
No

種

(データ項目)

.

別

名称

1

リ HTTP メソッド

必須/
説明

任意/

書式

不要
“POST”固定

必須

文字列

62
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/
不要

ク

/api/v1/{X-CPS-dataTypeId}/gw/

エ パス（URL）{X-CPS-dataTypeId}は参照するデータにス

対応するデータタイプ ID

3ト プロトコルバージョン

4

2

5

書式

必須

文字列

"HTTP1.1"固定

必須

文字列

行 文字コード

utf-8

必須

文字列

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

監視要求(即時)(0200000100000000)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・ゲートウェイに蓄積されているデータ 必須

文字列

を参照
・操作種別IDの項目一覧から以下を指定

6(操作種別 ID)
X-CPS-Operation

参照(GET)・操作種別 ID は、基本仕様書の 4.4.2

項を参照("GET "を指定)

7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定
入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"
出力時の入出力形式

9(出力形式)
Accept

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"

1011(データ取得先情報)(Acquisition)(タイムスタンプ)
X-CPS-Timestamp

以下のいずれかを設定。

を取得する場合："GW"

ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須

文字列

(生成日時(リクエスト時刻)を指定)

63
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/
不要

ボ

監視要求（即時）の詳細

デ

データプロファイルのディレクションに

ィ

記載する。

12

書式

(データ)

水道 CPS データプロファイル仕様書のData

2.4 節を参照。

必須

文字列

データ暗号化及び電子署名の付与は、CPS/IoT セキュリティ仕様書の 2.4 節を参照。

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-8: HTTP(S)レスポンスのパラメーター（即時取得 API）
No

種

(データ項目)

.

別

名称

1

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

"NULL"固定不要

文字列"NULL"固定不要

文字列"NULL"固定不要

文字列・AP 未接続：404 固定（指定したリソースが見つからない）
2

3

4

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation(依頼元情報)Authorization

64
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
リクエストで指定した Accept の内容

5(出力形式)"application/xml"

Content-type

または

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

"application/json"(タイムスタンプ)

6

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(レスポンス時刻)を指定)

ボ 【処理成功の時】
デ(レスポンス)ィ

response(監視要求 ID)
monitoringRequestId【処理失敗の時】（メッセージ）
message（エラー詳細）ボディ包括タグ

監視要求を一意に示す ID
任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に準拠する。

detail8【不正要求の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に（エラー詳細）準拠する。

detail【AP 未接続の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書（エラー詳細）項 3.5.1「メッセージ仕様」に準拠する。

detailWebSocket(S)による即時取得データの受信方法
本節の API で要求した即時取得の結果(データプロファイル)は、WebSocket(S)を通して受信することができる。
WebSocket(S)を利用して、データプロファイルを受信する方法を以下に示す。

65
WPSC002-Ed.1.1 2021-02

WebSoket(S)の接続情報
WebSocket(S)の接続先 URL は機器ベンダー向け標準インターフェイス（デバイス）仕様
項 2.3 「ゲートウェイ接続」のレスポンスで通知される「アクセス先 URL」の値である。
広域向けアプリケーションはこの URL に WebSocket(S)で接続することでデータプロファ
イルをイベントデータとして受信可能になる。
WebSocket(S)接続時に指定する接続情報を以下に示す。
表 4-9: WebSocket(S)接続時に指定する接続情報
No.

種別(データ項目)

必須/

名称

任意

書式

内容
RFC6750 に準拠した OpenID Connect アク1

ヘッダ

Authorization

必須

※

文字列

セストークンを指定
認証スキーマには"Bearer"を指定

クエリパラ

2

メーター

OpenID Connect によるアクセス制限につaccess_token

必須

※

文字列

いては、CPS/IoT セキュリティ仕様書の2.3 節を参照※: Authorization ヘッダと access_token クエリパラメーターはどちらか一方が必須。
両方を指定する必要はない。
WebSocket(S)接続時の接続結果を以下に示す。
表 4-10: WebSocket(S)接続時の接続結果
No.

実行結果

説明

コード

備考

1

101

成功

WebSocket(S)接続開始

2400 番台失敗 (不正要求)

WebSocket(S)接続不可

3500 番台失敗 (処理失敗)

WebSocket(S)接続不可

WebSoket(S)による受信データ
WebSocket(S)による受信データを以下に示す。
表 4-11:即時取得 API の WebSocket(S)受信データ
No.

種(データ項目)

別

名称

プ
1

ロ
ト

必須/
説明

書式

不要
XML 形式の場合、必須。

Xml 宣言文任意/"<?xml version="1.0"
encoding="utf-8"?>" 固定

Xml 形
式のみ

文字列

66
WPSC002-Ed.1.1 2021-02

No.

2

3

種

(データ項目)別名称

コ(インターフェイス包括タグ)

ル

CPS-IfElement

ボ(ヘッダ包括タグ)

デ

CPS-IfHeader

ィ
4

必須/
説明

任意/

書式

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

ヘッダ包括タグ
データ種別 ID を指定。

(データ種別 ID)

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

X-CPS-dataTypeId

・監視要求(即時)：

必須

文字列

必須

文字列

必須

文字列

必須

文字列

"0200000100000000"

5(操作種別 ID)
X-CPS-Operation

操作種別 ID が指定される。
基本仕様書の 4.4.2 項を参照。
・即時監視要求："GET"ID 種別、アプリケーション ID が指6(依頼元情報)定される。

X-CPS-Source-ID

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

7(入出力形式)"application/xml;charset=utf-8" 固Content-type

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

通番 3 桁-総数 3 桁

必須/

記載例:002-003

任意

文字列

データ分割については、機器ベンダ
ー向け標準インターフェイス(デバイス)仕様書の 3.4 項を参照。
ISO8601 拡張形式の文字列(要求時9(タイムスタンプ)
X-CPS-Timestamp

刻)
YYYY-MM-DDThh:mm:ss.SSSZ

必須

文字列

監視要求を一意に示す ID

必須

文字列

送信元のゲートウェイ ID

必須

文字列

(生成日時(リクエスト時刻)を指
定)

10

11

(監視要求 ID)
X-CPS-monitoringRequestId(ゲートウェイ ID)
X-CPS-GatewayId

67
WPSC002-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
正常終了:0

12(実行結果コード)

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

X-CPS-Result

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

必須

文字列

必須

文字列

その他異常:999
13

CPS-IfBody

ボディ包括タグ
即時監視データのデータプロファ

14

(データ)
Data

イル
詳細は、水道 CPS データプロファイ
ル仕様書の 2.4.1 項、2.4.2 項を参照。

68
WPSC002-Ed.1.1 2021-02定周期監視実行 API
定周期監視を実行する API を以下に示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
定周期監視実行 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報) のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-12: HTTP(S)リクエストのパラメーター（定周期監視実行 API）
必須/

No

種

(データ項目)

.

別

名称

1

リ HTTP メソッド

“POST”固定

説明

任意/

書式

不要
必須

文字列

ク

/api/v1/{X-CPS-dataTypeId}/start/

エ パス（URL）{X-CPS-dataTypeId}は参照するデータに 必須

文字列ス

対応するデータタイプ ID

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

必須

文字列

4

行 文字コード

utf-8

必須

文字列

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

監視要求(定周期)(0200000200000000)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文字列

必須

文字列

必須

文字列

必須

文字列

2

5

を参照
・操作種別IDの項目一覧から以下を指定

6(操作種別 ID)
X-CPS-Operation

参照(GET)・操作種別 ID は、基本仕様書の 4.4.2

項を参照("GET "を指定)

7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定
入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"

69
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・"application/xml"
・"application/json"
以下のいずれかを設定。

(データ取得先情報)

10(Acquisition)・プラットフォームに蓄積されているデータを取得する場合："PF"・ゲートウェイに蓄積されているデータを取得する場合(タイムスタンプ)

11

12

X-CPS-Timestamp："GW"

ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(リクエスト時刻)を指定)

ボ

監視要求（定周期）の詳細

デ

データプロファイルのディレクションに

ィ

記載する。

(データ)

水道 CPS データプロファイル仕様書のData

2.4 節を参照。

データ暗号化及び電子署名の付与は、CPS/IoT セキュリティ仕様書の 2.4 節を参照。

70
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で応答情報の通信結果を水道標準プラットフォームから広域向けアプリケーションに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-13: HTTP(S)レスポンスのパラメーター（定周期監視実行 API）
No

種

(データ項目)

.

別

名称

1

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文 字
列

・AP 未接続：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation(依頼元情報)4

Authorization"NULL"固定不要"NULL"固定不要"NULL"固定

不要

文 字
列
文 字
列
文 字
列

リクエストで指定した Accept の内容
5(出力形式)"application/xml"

Content-type

または

必須

文 字
列

"application/json"(タイムスタンプ)

6

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

文 字列

ボ 【処理成功の時】

7

デ(レスポンス)ィ

response

ボディ包括タグ(監視要求 ID)

定周期監視の要求 ID を格納する。

monitoringRequestId"{【監視要求 ID】}"(結果通知 URL)
notificationUrl【処理失敗の時】

必須

監視結果を含んだプロファイルを通知す
る WebSocket(S)の URL を格納する。

必須"{【URL】}"
任意のエラーメッセージ。

必須

文 字
列
文 字
列
文 字

71
WPSC002-Ed.1.1 2021-02

No

種(データ項目).

別名称（メッセージ）
message

必須/
説明

任意/

書式

不要
アプリベンダー向け標準インターフェイ

列ス仕様書 項 3.5.1「メッセージ仕様」に準拠する。

【不正要求の時】
任意のエラーメッセージ。
（メッセージ）

アプリベンダー向け標準インターフェイ

messageス仕様書 項 3.5.1「メッセージ仕様」に

必須

文 字
列

準拠する。
【AP 未接続の時】
任意のエラーメッセージ。
（メッセージ）

アプリベンダー向け標準インターフェイ

messageス仕様書 項 3.5.1「メッセージ仕様」に

必須

文 字
列

準拠する。

WebSocket(S)による定周期監視データの受信方法
本節の API で要求した定周期監視の結果(データプロファイル)は、WebSocket(S)を通して受信することができる。
WebSocket(S)を利用して、データプロファイルを受信する方法を以下に示す。
WebSoket(S)の接続情報
WebSocket(S)の接続先 URL は前述（表 4-13）のレスポンスで通知される「結果通知 URL(notificationUrl)」の値である。
広域向けアプリケーションはこの URL に WebSocket(S)で接続することでデータプロファ
イルをイベントデータとして受信可能になる。
WebSocket(S)接続時に指定する接続情報を以下に示す。

72
WPSC002-Ed.1.1 2021-02

表 4-14: WebSocket(S)接続時に指定する接続情報
No.

種別(データ項目)

必須/

名称

任意

書式

内容
RFC6750 に準拠した OpenID Connect アク1

ヘッダ

Authorization

必須

※

文字列

セストークンを指定
認証スキーマには"Bearer"を指定

クエリパラ

2

メーター

OpenID Connect によるアクセス制限につaccess_token

必須

※

文字列

いては、CPS/IoT セキュリティ仕様書の2.3 節を参照※: Authorization ヘッダと access_token クエリパラメーターはどちらか一方が必須。
両方を指定する必要はない。
WebSocket(S)接続時の接続結果を以下に示す。
表 4-15: WebSocket(S)接続時の接続結果
No.

実行結果

説明

コード

備考

1

101

成功

WebSocket(S)接続開始

2400 番台失敗 (不正要求)

WebSocket(S)接続不可

3500 番台失敗 (処理失敗)

WebSocket(S)接続不可

WebSoket(S)による受信データ
WebSocket(S)による受信データを以下に示す。
表 4-16:定周期監視実行 API の WebSocket(S)受信データ
No.

種別

必須/

(データ項目)

説明

名称

任意/

書式

不要
定周期監視結果
データプロファイルを指定
監視結果はデータプロファイルのトラン
ザクションに記載されている

WebSocket
1

ペイロード
データ

(データ)
なし

データプロファイルについては、水道 CPS

必須

文字列

データプロファイル仕様書の 2.3 節を参照。
データ暗号化及び電子署名の付与は、CPS/IoT セキュリティ仕様書の 2.4 節を参照。

73
WPSC002-Ed.1.1 2021-02定周期監視一覧取得 API
定周期監視一覧を取得する API を以下に示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
定周期監視一覧取得 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報) のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-17: HTTP(S)リクエストのパラメーター（定周期監視一覧取得 API）
No

1

種

(データ項目)

別

名称

必須/
説明

“POST”固定ク/api/v1/{X-CPS-dataTypeId}/エ パス（URL）(X-CPS-dataTypeId

ス

を指定)

3

ト プロトコルバージョン

4

5

書式

不要

リ HTTP メソッド

2

任意/

必須

文字列

"0200000300000000" 必須

文字列"HTTP1.1"固定

必須

文字列

行 文字コード

utf-8

必須

文字列

ヘ

要求するデータの種別から”監視要求一ッ (データ種別 ID)

覧(0200000300000000)”を指定。

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文字列

操作種別 ID は、基本仕様書の 4.4.2 項を 必須

文字列

を参照。
操作種別 ID の項目一覧から以下を指定

6(操作種別 ID)
X-CPS-Operation

・参照(GET)

参照("GET"を指定)

7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定

必須

文字列

必須

文字列

入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"

74
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定

必須

文字列

必須

文字列

必須

文字列

・"application/xml"
・"application/json"(タイムスタンプ)

10

X-CPS-Timestamp
ボ

11

デ
ィ

(リクエスト)requestISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(リクエスト時刻)を指定)

空文字

75
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で応答情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-18: HTTP(S)レスポンスのパラメーター（定周期監視一覧取得 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

"NULL"固定不要

文字列"NULL"固定不要

文字列"NULL"固定

不要

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation(依頼元情報)4

Authorization

リクエストで指定した Accept の内容
5(出力形式)"application/xml"

Content-typeまたは"application/json"(タイムスタンプ)

6

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(レスポンス時刻)を指定)

ボ 【処理成功の時】
デ(レスポンス)ィ

response

ボディ包括タグ(定周期監視一覧)
7

ConstantCycleMonitorin

取得件数分、繰り返し設定する

gList(アプリケーション
ID)applicationId

定周期監視開始要求を行ったアプリケー
ションを特定する ID。

76
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/
不要

(ユーザ ID)

定周期監視開始要求を行ったユーザを特userId定する ID。

(監視要求 ID)
monitoringRequestId

定周期監視内容を特定する要求 ID。

(結果通知 URL)

監視結果を含んだプロファイルを通知す

notificationUrl

る WebSocket(S)の URL を指定する。

【処理失敗の時】（メッセージ）
message（エラー詳細）

書式

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書

項 3.5.1「メッセージ仕様」に準拠する。

detail【不正要求の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に（エラー詳細）準拠する。

detail【AP 未接続の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書（エラー詳細）項 3.5.1「メッセージ仕様」に準拠する。

detail77
WPSC002-Ed.1.1 2021-02定周期監視停止 API
定周期監視を停止する API を以下に示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
定周期監視停止 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。

リクエスト(要求情報) のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-19: HTTP(S)リクエストのパラメーター（定周期監視停止 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/
不要

リ HTTP メソッド

“POST”固定ク/api/v1/{X-CPS-dataTypeId}/stop/

エ パス（URL）{X-CPS-dataTypeId}は参照するデータにス

対応するデータタイプ ID

3ト プロトコルバージョン

4

2

5

書式

必須

文字列

必須

文字列

"HTTP1.1"固定

必須

文字列

行 文字コード

utf-8

必須

文字列

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

監視要求(定周期)(0200000200000000)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文字列

操作種別 ID は、基本仕様書の 4.4.2 項を 必須

文字列

を参照
操作種別 ID の項目一覧から以下を指定

6(操作種別 ID)
X-CPS-Operation

・削除(DELETE)

参照("DELETE "を指定)

7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定

必須

文字列

必須

文字列

入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"

78
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・"application/xml"
・"application/json"(タイムスタンプ)

10

11

12

13

X-CPS-Timestamp
ボ (リクエスト)デ request
ィ(監視要求 ID)
monitoringRequestId

ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(リクエスト時刻)を指定)
ボディ包括タグ

定周期監視内容を特定する要求 ID。

(結果通知 URL)

監視結果を含んだプロファイルを通知す

notificationUrl

る WebSocket(S)の URL を指定する。

79
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で応答情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-20: HTTP(S)レスポンスのパラメーター（定周期監視停止 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

"NULL"固定不要

文字列"NULL"固定不要

文字列"NULL"固定

不要

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation(依頼元情報)4

Authorization

リクエストで指定した Accept の内容
5(出力形式)"application/xml"

Content-typeまたは"application/json"(タイムスタンプ)

6

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(レスポンス時刻)を指定)

ボ 【処理成功の時】
デ(レスポンス)ィ

response【処理失敗の時】

7

空文字

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書（メッセージ）

項 3.5.1「メッセージ仕様」に準拠する。

message80
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

【不正要求の時】
任意のエラーメッセージ。
（メッセージ）

アプリベンダー向け標準インターフェイ

messageス仕様書 項 3.5.1「メッセージ仕様」に

必須

文字列

必須

文字列

準拠する。
【AP 未接続の時】
任意のエラーメッセージ。
（メッセージ）

アプリベンダー向け標準インターフェイ

messageス仕様書

項 3.5.1「メッセージ仕様」に準拠する。

81
WPSC002-Ed.1.1 2021-02制御値設定 API
ユーザ操作またはアプリケーション判断（インターロックなど）により IoT ゲートウェイに対してデバイス制御操作を要求する API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
制御値設定 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-21: HTTP(S)リクエストのパラメーター（制御値設定 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/
不要

リ HTTP メソッド

“POST”固定ク/api/v1/{X-CPS-dataTypeId}/エ パス（URL）{X-CPS-dataTypeId}は参照するデータにス

対応するデータタイプ ID

3ト プロトコルバージョン

4

2

5

書式

必須

文字列

必須

文字列

"HTTP1.1"固定

必須

文字列

行 文字コード

utf-8

必須

文字列

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

制御操作(0200000600000000)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文字列

必須

文字列

必須

文字列

必須

文字列

を参照
・操作種別IDの項目一覧から以下を指定

6(操作種別 ID)
X-CPS-Operation

変更(PUT)・操作種別 ID は、基本仕様書の 4.4.2

項を参照("PUT "を指定)

7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定
入力時の入出力形式

8(入力形式)
Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"

82
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定

必須

文字列

必須

文字列

必須

文字列

・"application/xml"
・"application/json"(タイムスタンプ)

10

11

X-CPS-Timestamp

ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(リクエスト時刻)を指定)

ボ

制御操作の要求デ

データプロファイルのディレクションに

ィ

記載する。
(データ)

水道 CPS データプロファイル仕様書のData

2.4 項を参照。
データ暗号化及び電子署名の付与は、CPS/IoT セキュリティ仕様書の 2.4 節を参照。

83
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-22: HTTP(S)レスポンスのパラメーター（制御値設定 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文

字

列

・AP 未接続：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation(依頼元情報)4

Authorization"NULL"固定不要"NULL"固定不要"NULL"固定

不要

文

字

列
文

字

列
文

字

列

リクエストで指定した Accept の内容
5(出力形式)"application/xml"

Content-type

または

必須

文

字

列

"application/json"(タイムスタンプ)

6

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

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

文

字

列

ボ 【処理成功の時】
デ(レスポンス)ィResponse
制御要求 ID

7(controlRequestId)【処理失敗の時】（メッセージ）
message

ボディ包括タグ

制御要求を一意に示す ID

必須

文

字

列

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書

項 3.5.1「メッセージ仕様」

必須

文

字

列

84
WPSC002-Ed.1.1 2021-02

No

種(データ項目)別名称（エラー詳細）

必須/
説明

任意/

書式

不要
に準拠する。

detail【不正要求の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に（エラー詳細）

必須

文

字

列

準拠する。

detail【AP 未接続の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書（エラー詳細）項 3.5.1「メッセージ仕様」

必須

文

字

列

に準拠する。

detail85
WPSC002-Ed.1.1 2021-02

WebSocket(S)による制御値設定データの受信方法
本節の API で要求した制御値設定の結果(データプロファイル)は、WebSocket(S)を通して受信することができる。
WebSocket(S)を利用して、データプロファイルを受信する方法を以下に示す。
WebSoket(S)の接続情報
WebSocket(S)の接続先 URL は機器ベンダー向け標準インターフェイス（デバイス）仕様
項 2.3 「ゲートウェイ接続」のレスポンスで通知される「アクセス先 URL」の値である。
広域向けアプリケーションはこの URL に WebSocket(S)で接続することでデータプロファ
イルをイベントデータとして受信可能になる。
WebSocket(S)接続時に指定する接続情報を以下に示す。
表 4-23: WebSocket(S)接続時に指定する接続情報
No.

種別(データ項目)

必須/

名称

任意

書式

内容
RFC6750 に準拠した OpenID Connect アク1

ヘッダ

Authorization

必須

※

文字列

セストークンを指定
認証スキーマには"Bearer"を指定

クエリパラ

2

メーター

OpenID Connect によるアクセス制限につaccess_token

必須

※

文字列

いては、CPS/IoT セキュリティ仕様書の2.3 節を参照※: Authorization ヘッダと access_token クエリパラメーターはどちらか一方が必須。
両方を指定する必要はない。
WebSocket(S)接続時の接続結果を以下に示す。
表 4-24: WebSocket(S)接続時の接続結果
No.

実行結果

説明

コード

備考

1

101

成功

WebSocket(S)接続開始

2400 番台失敗 (不正要求)

WebSocket(S)接続不可

3500 番台失敗 (処理失敗)

WebSocket(S)接続不可

WebSoket(S)による受信データ
WebSocket(S)による受信データを以下に示す。
制御値設定 API 実行時には、アプリケーションへは、3 種類の WebSocket(S)情報が通知される。
以下に、アプリケーションへ返却される通知情報の種類を示す。
86
WPSC002-Ed.1.1 2021-02

表 4-25: 制御操作時の通知情報の種類
No.
1

2

3

通知タイミング
IoT ゲートウェイへの制御操作送達完了時
デバイスへの制御操作送
達完了時
デバイスの制御操作完了
時

内容
IoT ゲートウェイが制御要求を受信したことの通知

IoT ゲートウェイがデバイスへ制御要求したことの通知

デバイスから制御操作が完了したことの通知

表 4-26:制御値設定 API(IoT ゲートウェイへの制御操作送達完了時)の WebSocket(S)受信データ

No.

種(データ項目)別名称

1Xml 宣言文

必須/
説明

任意/
不要

XML 形式の場合、必須。

Xml 形"<?xml version="1.0"

式 の 文字列

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

2

3

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

CPS-IfHeader

ロ
4

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

ヘッダ包括タグ
データ種別 ID を指定。

(データ種別 ID)

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

コ

X-CPS-dataTypeId

・制御操作：

ル

5

み

ト

ボ
デ
ィ

書式

必須

文字列

必須

文字列

必須

文字列

必須

文字列

"0200000600000000"(操作種別 ID)
X-CPS-Operation

操作種別 ID が指定される。
基本仕様書の 4.4.2 項を参照。
・即時監視要求："GET"ID 種別、アプリケーション ID が指定

6(依頼元情報)される。

X-CPS-Source-ID

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

7(入出力形式)
Content-type"application/xml;charset=utf-8" 固定

87
WPSC002-Ed.1.1 2021-02

No.

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要
・1 回目の要求時には指定不要。
・データを分割した場合は必須とし、以下を指定する。

8(データ分割)X-CPS-Data-Split

通番 3 桁-総数 3 桁

必須/

記載例:002-003

任意

文字列

データ分割については、機器ベンダー
向け標準インターフェイス(デバイス)
仕様書の 3.4 項を参照。

9

10(タイムスタンプ)
X-CPS-Timestamp(監視要求 ID)
X-CPS-monitoringRequestId

ISO8601 拡張形式の文字列(要求時刻)
YYYY-MM-DDThh:mm:ss.SSSZ

必須

文字列

必須

文字列

必須

文字列

必須

文字列

(生成日時(リクエスト時刻)を指定)
監視要求を一意に示す ID
正常終了:0

11(実行結果コード)

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

X-CPS-Result

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

12
13

CPS-IfBody(制御要求送信結果)
resultボディ包括タグ
OK、NG

88
WPSC002-Ed.1.1 2021-02

表 4-27:制御値設定 API(デバイスへの制御操作送達完了時)の WebSocket(S)受信データ

No.

種(データ項目)別名称

1Xml 宣言文

必須/
説明

任意/
不要

XML 形式の場合、必須。

Xml 形"<?xml version="1.0"

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

2

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

3

CPS-IfHeader

書式

文字列

み

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

ヘッダ包括タグ
データ種別 ID を指定。

4

(データ種別 ID)

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

X-CPS-dataTypeId

・制御操作：

必須

文字列

必須

文字列

必須

文字列

必須

文字列

"0200000600000000"

5プ(操作種別 ID)ロ

X-CPS-Operation

ト
コ
6

ル
ボ

ィ

基本仕様書の 4.4.2 項を参照。
・制御値設定要求："PUT"ID 種別、アプリケーション ID が指定(依頼元情報)される。

X-CPS-Source-ID

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

デ7

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

(入出力形式)
Content-type"application/xml;charset=utf-8" 固定

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

通番 3 桁-総数 3 桁

必須/

記載例:002-003

任意

文字列

データ分割については、機器ベンダー
向け標準インターフェイス(デバイス)
仕様書の 3.4 項を参照。

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

ISO8601 拡張形式の文字列(要求時刻)
YYYY-MM-DDThh:mm:ss.SSSZ

必須

文字列

(生成日時(リクエスト時刻)を指定)

89
WPSC002-Ed.1.1 2021-02

No.

種

(データ項目)別

名称(制御要求 ID)

10

X-CPS-controlRequestId

必須/
説明

任意/

書式

不要
制御要求を一意に示す ID

必須

文字列

必須

文字列

必須

文字列

正常終了:1
11(実行結果コード)

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

X-CPS-Result

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

12

CPS-IfBody

ボディ包括タグ
制御値設定監視データのデータプロフ

13

(データ)

ァイル

Data

詳細は、水道 CPS データプロファイル
仕様書の 2.4.1 項、2.4.2 項を参照。

表 4-28:制御値設定 API(デバイスの制御操作完了時)の WebSocket(S)受信データ

No.

種(データ項目)別名称

1Xml 宣言文

必須/
説明

任意/
不要

XML 形式の場合、必須。

Xml 形"<?xml version="1.0"

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

2

3

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

ロ

CPS-IfHeader

ト4

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

ヘッダ包括タグ
データ種別 ID を指定。

(データ種別 ID)

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

ル

X-CPS-dataTypeId

・制御操作：

ボ

5

ィ

文字列

み

コ

デ

書式

必須

文字列

必須

文字列

必須

文字列

"0200000600000000"(操作種別 ID)
X-CPS-Operation

操作種別 ID が指定される。
基本仕様書の 4.4.2 項を参照。
・制御値設定要求："PUT"ID 種別、アプリケーション ID が指定

6(依頼元情報)される。

X-CPS-Source-ID

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

No.

7

種

(データ項目)別名称(入出力形式)
Content-type

必須/
説明

任意/

書式

不要
"application/xml;charset=utf-8" 固定

必須

文字列

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

通番 3 桁-総数 3 桁

必須/

記載例:002-003

任意

文字列

データ分割については、機器ベンダー
向け標準インターフェイス(デバイス)
仕様書の 3.4 項を参照。

9

10(タイムスタンプ)
X-CPS-Timestamp(制御要求 ID)
X-CPS-controlRequestId

ISO8601 拡張形式の文字列(要求時刻)
YYYY-MM-DDThh:mm:ss.SSSZ

必須

文字列

必須

文字列

必須

文字列

必須

文字列

(生成日時(リクエスト時刻)を指定)
制御要求を一意に示す ID
正常終了:2

11(実行結果コード)

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

X-CPS-Result

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

12

CPS-IfBody

ボディ包括タグ
制御値設定監視データのデータプロフ

13

(データ)

ァイル

Data

詳細は、水道 CPS データプロファイル
仕様書の 2.4.1 項、2.4.2 項を参照。

91
WPSC002-Ed.1.1 2021-02

公開鍵証明書ファイル取得 API
データ保護用の公開鍵証明書ファイルを取得する API を以下に示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
データ保護公開鍵証明書ファイル取得 API の HTTP(S)プロトコルでの要求と応答のデータ
項目設定を以下に示す。
リクエスト(要求情報) のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す
表 4-29: HTTP(S)リクエストのパラメーター（公開鍵証明書ファイル取得 API）
No

種

(データ項目)別名称

1

HTTP メソッド
リ

2

ク
エ

説明

任意/

パス（URL）“POST”固定

必須{X-CPS-dataTypeId}は参照するデータに必須

対応するデータタイプ ID

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

必須

utf-8

必須

行
4

文字コード
ヘ
ッ

5

ダ

書式

不要

/api/v1/{X-CPS-dataTypeId}/

ス
3

必須/

文 字
列
文 字
列
文 字
列
文 字
列

・要求するデータの種別から以下を指定(データ種別 ID)
X-CPS-dataTypeId

データ保護公開鍵証明書ファイル(0200000500000000)

必須

データ種別 ID は、基本仕様書の 4.4.1 項

文 字
列

を参照
操作種別 ID の項目一覧から以下を指定

6(操作種別 ID)
X-CPS-Operation

・参照(GET)
操作種別 ID は、基本仕様書の 4.4.2 項を 必須
参照

文 字
列

("GET"を指定)
7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定

必須

文 字
列

92
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要
入力時の入出力形式(入力形式)

8

Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定必須・"application/xml"

文 字列

・"application/json"(出力形式)

9

Accept(公開鍵バージョン ID)

10

PublicKeyVersionId(タイムスタンプ)

11

12

X-CPS-Timestamp
ボ (リクエスト)デ request
ィ

出力時の入出力形式
IANA に登録された MIME タイプを指定

必須"application/octet-stream"固定
取得対象の公開鍵証明書のバージョン番号を設定。設定されていない場合、最新バ 任意ージョン番号の公開鍵証明書を取得
ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須(生成日時(リクエスト時刻)を指定)

文 字
列

文 字
列

文 字
列

ボディ包括タグ
以下のいずれかを指定
・アプリケーションの場合：

13

(データ)

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

Data・水道標準プラットフォームの証明書情

必須

文 字
列

報を取得する場合："{0000}"固定93
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) パラメーター
HTTP(S)で応答情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-30: HTTP(S)レスポンスのパラメーター（公開鍵証明書ファイル取得 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

"NULL"固定不要

文字列"NULL"固定不要

文字列"NULL"固定

不要

文字列

必須

文字列

必須

文字列

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）2

3

ヘ (データ種別 ID)
ッ X-CPS-dataTypeId
ダ (操作種別 ID)
X-CPS-Operation(依頼元情報)4

Authorization

・処理成功時："application/octet-stream"固定(出力形式)

5

Content-type

・処理失敗/不正要求/AP 未接続時：
リクエストで指定した Accept の内容"application/xml"
または"application/json"

6(公開鍵バージョン ID)

取得した公開鍵証明書のバージョン番号

PublicKeyVersionIdを設定(タイムスタンプ)

7

X-CPS-Timestamp

ISO8601 に従って応答時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(レスポンス時刻)を指定)

ボ 【処理成功の時】
8

デ

(データ)

ィ

Data
【処理失敗の時】

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

必須

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

必須

バイナ
リ
文字列

94
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

(メッセージ)

アプリベンダー向け標準インターフェイ

messageス仕様書（エラー詳細）に準拠する。

項 3.5.1「メッセージ仕様」

detail【不正要求の時】(メッセージ)
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に(エラー詳細)

必須

文字列

必須

文字列

準拠する。

detail【AP 未接続の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書（エラー詳細）項 3.5.1「メッセージ仕様」に準拠する。

detail95
WPSC002-Ed.1.1 2021-02

即時取得（蓄積）API即時取得（蓄積）API は、定周期で取得した、PF 内に蓄積されている値を取得する命令を発行する API である。即時取得（蓄積）API で取得するデータ種別を以下に示す。
表 4-31: 即時取得できるデータの種類一覧
No.

1

取得データ種別
計測分類コード※
計測（D1）

2

履歴値

状態値

状態（D2）

3

（履歴値）

異常値

異常（D3）

取得内容

名称

（履歴値）

IoT ゲートウェイが取得する現在のデバイスの履歴値
IoT ゲートウェイが取得する過去の状態値
取得条件に過去時間を指定することで履歴値の取得が可能
IoT ゲートウェイが取得した過去の異常値
取得条件に過去時間を指定することで履歴値の取得が可能※計測分類コードは。基本仕様書（表 4-20）を参照
HTTP(S)プロトコルでの要求と応答のデータ項目設定
即時取得 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-32: HTTP(S)リクエストのパラメーター（即時取得 API）
必須/

No

種

(データ項目)

.

別

名称

1

リ HTTP メソッド

“POST”固定ク/api/v1/{X-CPS-dataTypeId}/gw/

エ パス（URL）{X-CPS-dataTypeId}は参照するデータにス

対応するデータタイプ ID

3ト プロトコルバージョン

4

2

5

説明

任意/

書式

不要
必須

文字列

必須

文字列

"HTTP1.1"固定

必須

文字列

行 文字コード

utf-8

必須

文字列

ヘ

・要求するデータの種別から以下を指定

ッ (データ種別 ID)

監視要求(即時)(0200000100000000)

ダ X-CPS-dataTypeId

データ種別 ID は、基本仕様書の 4.4.1 項

必須

文字列

を参照

96
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要
・操作種別IDの項目一覧から以下を指定(操作種別 ID)

6

X-CPS-Operation

参照(GET)・操作種別 ID は、基本仕様書の 4.4.2

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・プラットフォームに蓄積されているデー 必須

文字列

項を参照
("GET "を指定)

7(依頼元情報)RFC6750 に準拠した OpenID Connect アク

Authorization

セストークンを指定
入力時の入出力形式(入力形式)

8

Content-type

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"
出力時の入出力形式(出力形式)

9

Accept

IANA に登録された以下のいずれかの MIME
タイプを指定・"application/xml"
・"application/json"(データ取得先情報)

10(Acquisition)(タイムスタンプ)

11

12

X-CPS-Timestamp

以下のいずれかを設定。

タを取得する場合："PF"ISO8601 に従って要求時刻を指定
YYYY-MM-DDThh:mm:ss.SSSZ

必須

文字列

必須

文字列

(生成日時(リクエスト時刻)を指定)

ボ

監視要求（即時）の詳細

デ

データプロファイルのディレクションに

ィ

記載する。

(データ)

水道 CPS データプロファイル仕様書の 2.4

Data

節を参照。

データ暗号化及び電子署名の付与は、CPS/IoT セキュリティ仕様書の 2.4 節を参照。

97
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-33: HTTP(S)レスポンスのパラメーター（即時取得 API）
No

種

(データ項目)

.

別

名称

1

必須/
説明

任意/
不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン

(実行結果コード)・処理成功：200 固定

ス

Status Code・処理失敗：404 固定

行

書式

必須

文字列

"NULL"固定不要

文字列"NULL"固定不要

文字列"NULL"固定

不要

文字列

必須

文字列

必須

文字列

文字列

・不正要求：400 固定
・AP 未接続：404 固定（指定したリソースが見つからない）

2

3

ヘ

(データ種別 ID)ッ

X-CPS-dataTypeId

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

Authorization

リクエストで指定した Accept の内容
5(出力形式)"application/xml"

Content-typeまたは"application/json"(タイムスタンプ)

6

X-CPS-Timestamp

YYYY-MM-DDThh:mm:ss.SSSZ(生成日時(レスポンス時刻)を指定)

ボ【処理成功の時】

デ(データ)

詳細は、水道 CPS データプロファイル仕様 必須

ィ

Data

書の 2.4.1 項、2.4.2 項を参照。

【処理失敗の時】7

ISO8601 に従って応答時刻を指定（メッセージ）
message（エラー詳細）即時監視データのデータプロファイル

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイス仕様書 項 3.5.1「メッセージ仕様」に

必須

文字列

必須

文字列

準拠する。

detail【不正要求の時】

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

98
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

.

別

名称

必須/
説明

任意/

書式

不要

（メッセージ）

アプリベンダー向け標準インターフェイ

messageス仕様書 項 3.5.1「メッセージ仕様」に（エラー詳細）準拠する。

detail【AP 未接続の時】（メッセージ）
message

任意のエラーメッセージ。
アプリベンダー向け標準インターフェイ
ス仕様書（エラー詳細）項 3.5.1「メッセージ仕様」

必須

文字列

に準拠する。

detail99
WPSC002-Ed.1.1 2021-02

ドキュメント参照(AP)(デバイス)API
水道標準プラットフォームに蓄積されたデバイスデータの参照を行う API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント参照(AP)(デバイス)API の HTTP(S)プロトコルでの要求と応答のデータ項目
設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-34: HTTP(S)リクエストのパラメーター（ドキュメント参照(AP)(デバイス)API）No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

1

リ HTTP メソッド

“GET”固定

必須

文字列

2

ク パス（URL）/api/v1/dev/documents/reference/

必須

文字列

3

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

必須

文字列

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

ス
4

ト 文字コード行

5

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクッ Authorization

セストークンを指定

ダ

IANA に登録された以下の MIME タイプを指6(出力形式)
Accept定・"application/json"

ボ (設備 ID)

検索条件として使用。設備 ID が一致する

デ equipmentId

ドキュメント情報を取得

ィ

検索条件として使用。結果日時が指定さ(結果日時（From）)
resultTimeFrom

7(結果日時（To）)
resultTimeTo

れた値以上のドキュメント情報を取得。
YYYY-MM-DDThh:mm:ss.sssZ 形式
検索条件として使用。結果日時が指定された値以下のドキュメント情報を取得。
YYYY-MM-DDThh:mm:ss.sssZ 形式(ページ番号)

ページネーションでの取得対象のページ

pageNum

を指定

100
WPSC002-Ed.1.1 2021-02

No

種(データ項目)別名称(ページ毎の件数)
countEachPage

必須/
説明

任意/

書式

不要
ページネーションでの 1 ページ毎のデー
タ件数を指定(件数を多くすると応答時間

必須

文字列

が増すため 1 ページ 100 件以下を推奨)

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-35: HTTP(S)レスポンスのパラメーター（ドキュメント参照(AP)(デバイス)API）No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

1

ス

HTTP ステータスコード(RFC2616、

ポ (実行結果コード)

RFC7231)に従った、要求に対する実行結

ン Status Code

果コード

ス

・処理成功：200 固定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

ドキュメントを一意に識別する ID

必須

文字列

ドキュメント情報(1 件分)

必須

文字列

行
ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ responseィ3"application/json"

ボディ包括タグ(検索結果総件数)

検索結果のドキュメント情報の総件数を

searchResultTotalCount

設定(検索結果件数)

検索結果のうち指定されたページ内のドsearchResultCount

キュメント情報の件数を設定(検索結果)
searchResult(オブジェクト ID)
objectId(ドキュメント情報)
documentData

取得件数分、繰り返し設定する
検索結果のドキュメント情報の内容を設
定101
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

(監視要求 ID)
monitoringReques

監視要求を一意に示す ID

必須

文字列

データプロファイルのバージョン

任意

文字列

必須

文字列

tId
(プロファイルバージョン)
ProfileVersion(業務アクティビ
ティ)Activity

データプロファイルの業務アクティビテ
ィ
詳細は、水道 CPS データプロファイル仕様書の 2.3 項（簡易版）を参照。

102
WPSC002-Ed.1.1 2021-02

ドキュメント登録操作(AP)(デバイス)API
水道標準プラットフォームにデバイスデータを蓄積する API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント登録操作(AP)(デバイス)API の HTTP(S)プロトコルでの要求と応答のデータ
項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-36: HTTP(S)リクエストのパラメーター（ドキュメント登録操作(AP)(デバイス)API）No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

1

リ HTTP メソッド

“POST”固定

必須

文字列

2

ク パス（URL）/api/v1/dev/documents/registration/

必須

文字列

3

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

必須

文字列

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

任意

文字列

ス
4

ト 文字コード行

5

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクセスッ Authorization

トークンを指定ダ

入力時の入出力形式

6(入力形式)
Content-type(出力形式)

7

Acceptボ (リクエスト)デ request
ィ8

IANA に登録された以下の MIME タイプを指定
・"application/json"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"
ボディ包括タグ(登録情報)

登録件数分、繰り返し設定する

registrationData

登録するドキュメント情報の内容を設定(監視要求 ID)
monitoringReques

監視要求を一意に示す ID

tId

103
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

(プロファイルバージョン)

データプロファイルのバージョン

任意

文字列

(業務アクティビ

データプロファイルの業務アクティビティ

ティ)

詳細は、水道 CPS データプロファイル仕様書 必須

文字列

Activityの 2.3 項（簡易版）を参照。

ProfileVersion

104
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-37: HTTP(S)レスポンスのパラメーター（ドキュメント登録操作(AP)(デバイス)API）No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

1

ス

HTTP ステータスコード(RFC2616、

ポ (実行結果コード)

RFC7231)に従った、要求に対する実行結

ン Status Code

果コード

ス

・処理成功：200 固定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

行
ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ responseィ
3(登録件数)
registrationCount(オブジェクト ID)
objectId"application/json"

ボディ包括タグ

登録したドキュメント情報の件数を設定
登録件数分、繰り返し設定する
登録したドキュメント情報のオブジェク
ト ID を設定

105
WPSC002-Ed.1.1 2021-02

ドキュメント更新操作(AP)(デバイス)API
水道標準プラットフォームに蓄積されたデバイスデータを更新する API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント更新操作(AP)(デバイス)API の HTTP(S)プロトコルでの要求と応答のデータ
項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-38: HTTP(S)リクエストのパラメーター（ドキュメント更新操作(AP)(デバイス)API）
No

1

種

(データ項目)別名称

リ

HTTP メソッド

エ パス（URL）
ス

3
4
5

ト
行

任意/

“PUT”固定ト ID}/{オブジェクト ID}はドキュメントを一意に示

文字列

必須

文字列

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

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

更新するドキュメント情報の内容を設定

必須

文字列

監視要求を一意に示す ID

必須

文字列

ッ Authorization

トークンを指定ダ

入力時の入出力形式(入力形式)
Content-Type(出力形式)
Acceptボ (リクエスト)デ request
ィ

必須

す ID

RFC6750 に準拠した OpenID Connect アクセス

7

書式

不要

ヘ (依頼元情報)

6

8

説明

/api/v1/dev/documents/update/{オブジェク

ク
2

必須/

(更新情報)
updateData

IANA に登録された以下の MIME タイプを指定
・"application/json"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"
ボディ包括タグ(監視要求 ID)
monitoringRequestId

106
WPSC002-Ed.1.1 2021-02

No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

(プロファイルバージョン)

データプロファイルのバージョン

任意

文字列

(業務アクティビ

データプロファイルの業務アクティビティ

ティ)

詳細は、水道 CPS データプロファイル仕様書 必須

文字列

Activityの 2.3 項（簡易版）を参照。

ProfileVersion

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-39: HTTP(S)レスポンスのパラメーター（ドキュメント更新操作(AP)(デバイス)API）No

種(データ項目)

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・不正要求：400 固定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

（指定されたオブジェクト ID の
ID 生成規則が合っていない）
・処理失敗：404 固定（更新件数 0 件の場合）

ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ response3ィ

(更新件数)
updateCount"application/json"

ボディ包括タグ「1」固定(オブジェクト ID)

更新したドキュメントのオブジェクト ID

objectId

を設定

107
WPSC002-Ed.1.1 2021-02

ドキュメント削除操作(AP)(デバイス)API
水道標準プラットフォームに蓄積されているデバイスデータの削除を行う API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント削除操作(AP)(デバイス)API の HTTP(S)プロトコルでの要求と応答のデータ
項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す。
表 4-40: HTTP(S)リクエストのパラメーター（ドキュメント削除操作(AP)(デバイス)API）No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

1

リ HTTP メソッド

“POST”固定

必須

文字列

2

ク パス（URL）/api/v1/dev/documents/deletion/

必須

文字列

3

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

必須

文字列

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

削除するドキュメントのオブジェクト ID を 必須

文字列

ス
4

ト 文字コード行

5

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクセスッ Authorization

トークンを指定ダ

入力時の入出力形式

6(入力形式)
Content-Type(出力形式)

7

Acceptボ (リクエスト)デ request

8ィ(オブジェクト ID)
objectId

IANA に登録された以下の MIME タイプを指定
・"application/json"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"
ボディ包括タグ
削除件数分、繰り返し設定する

設定

108
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す。
表 4-41: HTTP(S)レスポンスのパラメーター（ドキュメント削除操作(AP)(デバイス)API）No

種(データ項目)

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・不正要求：400 固定

必須

文字列

必須

文字列

必須

文字列

削除したドキュメントのオブジェクト ID 必須

文字列（指定されたオブジェクト ID の
ID 生成規則が合っていない）
・処理失敗：404 固定（削除件数 0 件の場合）

ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ responseィ3(削除件数)
deletingCount(オブジェクト ID)
objectId"application/json"

ボディ包括タグ

削除したドキュメント情報の件数を設定削除した件数分、繰り返し設定する

を設定

109
WPSC002-Ed.1.1 2021-02

ファイル参照 API
システムゲートウェイの「ファイル参照 API」と IF 仕様は同じである。詳細は 5.5 章参照。
FQDN は IoT ゲートウェイを指定する事が出来る。

ファイル登録操作 API
システムゲートウェイの「ファイル登録操作 API」と IF 仕様は同じである。詳細は 5.6 章参照。FQDN は IoT ゲートウェイを指定する事が出来る。

ファイル削除操作 API
システムゲートウェイの「ファイル削除操作 API」と IF 仕様は同じである。詳細は 5.7 章参照。FQDN は IoT ゲートウェイを指定する事が出来る。

110
WPSC002-Ed.1.1 2021-02

インターフェイス詳細仕様(システムゲートウェイ)
本章では、システムゲートウェイに関連する各 API に対して以下を示す。
・HTTP(S)プロトコルでの要求と応答のデータ項目設定

ドキュメント参照 API
データベースからドキュメントの参照を行う API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント参照 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-1）。
表 5-1: HTTP(S)リクエストのパラメーター（ドキュメント参照 API）
No

1

種

(データ項目)別名称

リ

HTTP メソッド

エ パス（URL）
ス

3
4
5

6

ト
行

説明

任意/

書式

不要
“GET”固定

必須

文字列

必須

文字列

/api/v1/sys/documents/reference/{ リ ソ

ク
2

必須/

ース ID}/{リソース ID}はドキュメントの格納先を一意に示す ID

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

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

ドキュメント情報の検索条件番号を設定

必須

文字列

検索条件の検索値を設定（第 1 条件用）

任意

文字列

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクッ Authorization

セストークンを指定

ダ

出力時の入出力形式(出力形式)

IANA に登録された以下の MIME タイプを指Accept定・"application/json"

ボ (検索条件番号)11

デ searchCriteriaNumberィ (検索パラメータ 1)
searchParameter1

111
WPSC002-Ed.1.1 2021-02

No

種(データ項目)別名称(検索パラメータ 2)
searchParameter2(検索パラメータ 3)
searchParameter3(検索パラメータ 4)
searchParameter4(検索パラメータ 5)
searchParameter5

必須/
説明

任意/

書式

不要
検索条件の検索値を設定（第 2 条件用）

任意

文字列

検索条件の検索値を設定（第 3 条件用）

任意

文字列

検索条件の検索値を設定（第 4 条件用）

任意

文字列

検索条件の検索値を設定（第 5 条件用）

任意

文字列

112
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-2）。
表 5-2: HTTP(S)レスポンスのパラメーター（ドキュメント参照 API）
No

種

(データ項目)

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・処理失敗：404 固定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

ドキュメントを一意に識別する ID

必須

文字列

リソース ID に対応した任意のデータ形式

必須

文字列

・不正要求：400 固定
・AP 未接続：404 固定（指定したリソースが見つからない）（ドキュメントデータ情報 0 件）

ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ responseィ3"application/json"

ボディ包括タグ(検索結果件数)

検索結果のドキュメント情報の件数を設

searchResultCount定(検索結果)
searchResult(オブジェクト ID)
objectId(ドキュメント情報)
documentData

取得件数分、繰り返し設定する
検索結果のドキュメント情報の内容を設
定113
WPSC002-Ed.1.1 2021-02

ドキュメント登録操作 API
データベースにドキュメントの登録を行う API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント登録操作 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-3）。
表 5-3: HTTP(S)リクエストのパラメーター（ドキュメント登録操作 API）
No

1

種

(データ項目)別名称

リ

HTTP メソッド

エ パス（URL）
ス

3
4
5

ト
行

任意/

“POST”固定

ース ID}/{リソース ID}はドキュメントの格納先を一意

文字列

必須

文字列

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

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

ッ Authorization

トークンを指定ダ

入力時の入出力形式(入力形式)
Content-type(出力形式)
Acceptボ (リクエスト)デ requestィ

必須に示す ID

RFC6750 に準拠した OpenID Connect アクセス

7

書式

不要

ヘ (依頼元情報)

6

8

説明

/api/v1/sys/documents/registration/{リソ

ク
2

必須/

IANA に登録された以下の MIME タイプを指定
・"application/json"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"
ボディ包括タグ(登録情報)

登録件数分、繰り返し設定する

registrationData

登録するドキュメント情報の内容を設定

114
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-4）。
表 5-4: HTTP(S)レスポンスのパラメーター（ドキュメント登録操作 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）
ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ responseィ3(検索結果件数)
registrationCount(オブジェクト ID)
objectId"application/json"

ボディ包括タグ

登録したドキュメント情報の件数を設定
登録件数分、繰り返し設定する
登録したドキュメント情報のオブジェク
ト ID を設定

115
WPSC002-Ed.1.1 2021-02

ドキュメント更新操作 API
データベースに蓄積されているドキュメントの更新を行う API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント更新操作 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-5）。
表 5-5: HTTP(S)リクエストのパラメーター（ドキュメント更新操作 API）
No

種

(データ項目)別名称

1

HTTP メソッド

エ パス（URL）
ス

4
5“PUT”固定{リソース ID}はドキュメントの格納先を一意に示す ID

文字列

必須

文字列

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

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

ッ Authorization

トークンを指定ダ

入力時の入出力形式(入力形式)
Content-Type(出力形式)
Acceptボ (リクエスト)デ request
ィ

必須

す ID

RFC6750 に準拠した OpenID Connect アクセス

7

8

不要

ヘ (依頼元情報)6

書式{オブジェクト ID}はドキュメントを一意に示

ト
3

任意/

ID}/{オブジェクト ID}/

ク

行

説明

/api/v1/sys/documents/update/{ リ ソ ー ス

リ

2

必須/

(更新情報)
updateData

IANA に登録された以下の MIME タイプを指定
・"application/json"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"
ボディ包括タグ

更新するドキュメント情報の内容を設定

116
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-6）。
表 5-6: HTTP(S)レスポンスのパラメーター（ドキュメント更新操作 API）
No

種

(データ項目)

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・処理失敗：404 固定

必須

文字列

必須

文字列

必須

文字列

必須

文字列

・不正要求：400 固定
・AP 未接続：404 固定（指定したリソースが見つからない）（更新件数 0 件の場合）

ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ response3ィ

(更新件数)
updateCount"application/json"

ボディ包括タグ「1」固定(オブジェクト ID)

更新したドキュメントのオブジェクト ID

objectIdを設定

117
WPSC002-Ed.1.1 2021-02

ドキュメント削除操作 API
データベースに蓄積されているドキュメントの削除を行う API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ドキュメント削除操作 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-7）。
表 5-7: HTTP(S)リクエストのパラメーター（ドキュメント削除操作 API）
No

1

種

(データ項目)別名称

リ

HTTP メソッド

エ パス（URL）
ス

3
4
5

ト
行

任意/

“POST”固定ID}/{リソース ID}はドキュメントの格納先を一意

文字列

必須

文字列

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

必須

文字列

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

削除するドキュメントのオブジェクト ID を 必須

文字列

ッ Authorization

トークンを指定ダ

入力時の入出力形式(入力形式)
Content-Type(出力形式)
Acceptボ (リクエスト)デ requestィ

必須に示す ID

RFC6750 に準拠した OpenID Connect アクセス

7

書式

不要

ヘ (依頼元情報)

6

8

説明

/api/v1/sys/documents/deletion/{リソース

ク
2

必須/

(オブジェクト ID)
objectId

IANA に登録された以下の MIME タイプを指定
・"application/json"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"
ボディ包括タグ
削除する件数分、繰り返し設定する

設定

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
118
WPSC002-Ed.1.1 2021-02

ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-8）。
表 5-8: HTTP(S)レスポンスのパラメーター（ドキュメント削除操作 API）
No

種

(データ項目)

別

名称

説明

任意/

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ス
行

(実行結果コード)
Status Code

書式

不要

レ

ン
1

必須/

・処理成功：200 固定
・処理失敗：404 固定

必須

文字列

必須

文字列

削除したドキュメントのオブジェクト ID 必須

文字列・不正要求：400 固定
・AP 未接続：404 固定（指定したリソースが見つからない）（削除件数 0 件の場合）

ヘ
2

ッ
ダ

(出力形式)
Content-Typeボ (レスポンス)
デ response3ィ(オブジェクト ID)
objectId"application/json"

ボディ包括タグ
削除した件数分、繰り返し設定する

を設定

119
WPSC002-Ed.1.1 2021-02

ファイル参照 API
オブジェクトストレージに格納されているファイルもしくはファイルパスの一覧を取得する
API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定ファイル参照 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-9）。
表 5-9: HTTP(S)リクエストのパラメーター（ファイル参照 API）
No

種

(データ項目)別名称

1

HTTP メソッド

必須/
説明

任意/

書式

不要
“GET”固定

必須

文字列

必須

文字列

/api/v1/sys/files/{リソース ID}/{オブジェ2リクト ID}

ク{リソース ID}はドキュメントの格納先を一意

エ パス（URL）に示す IDス{オブジェクト ID}はドキュメントを一意に示ト

す ID。「フォルダ」もしくは「フォルダ+ファ

行

イル名」を「/」区切りで設定

3

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

必須

文字列

4

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

5

6

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクセスッ Authorization

トークンを指定ダ

ファイルを取得する場合は(出力形式)
Accept「application/octet-stream」を設定指定されたフォルダ配下に存在するファイルのパスの一覧を取得する場合は「application/json」を設定

120
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-10）。
表 5-10: HTTP(S)レスポンスのパラメーター（ファイル参照 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）
ヘ
ッ
2

ダ

ファイルを取得する場合は(出力形式)
Content-Type「application/octet-stream」を設定指定されたフォルダ配下に存在するファ
イルのパスの一覧を取得する場合は「application/json」を設定

ボディ

出力形式が「application/octet-stream」
(データ)
data

の場合、取得したファイルのバイナリデー
タを設定

任意

出力形式が「application/json」の場合、

バ イ ナ
リ

null を設定

3(レスポンス)

出力形式が「application/octet-stream」

responseの場合、省略

任意

文字列

任意

文字列

取得件数分、繰り返し設定する
出力形式が「application/json」の場合、(ファイルパス)指定されたフォルダ配下に存在するファfilepath

イルのパスを設定（フォルダ+ファイル名）
出力形式が「application/octet-stream」の場合、省略121
WPSC002-Ed.1.1 2021-02

ファイル登録操作 API
オブジェクトストレージにファイルを登録する API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ファイル登録操作 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-11）。
表 5-11: HTTP(S)リクエストのパラメーター（ファイル登録操作 API）
No

種

(データ項目)別名称

1

HTTP メソッド

必須/
説明

任意/

書式

不要
“PUT”固定

必須

文字列

必須

文字列

/api/v1/sys/files/{リソース ID}/{オブジェ2リクト ID}

ク{リソース ID}はドキュメントの格納先を一意

エ パス（URL）に示す IDス{オブジェクト ID}はドキュメントを一意に示ト

す ID。「フォルダ+ファイル名」を「/」区切

行

りで設定

3

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

必須

文字列

4

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

5

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクセスッ Authorization

トークンを指定ダ

入力時の入出力形式

6

Content-Type(出力形式)

7

Acceptボ

8(入力形式)

デ
ィ

(データ)
data

IANA に登録された以下の MIME タイプを指定
・"application/octet-stream"
出力時の入出力形式
IANA に登録された以下の MIME タイプを指定
・"application/json"

保存するファイルのバイナリデータ

任意

バ イ ナ
リ

122
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-12）。
表 5-12: HTTP(S)レスポンスのパラメーター（ファイル登録操作 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

"application/json"

必須

文字列

空文字

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）
ヘ
2

ッ
ダ
ボ

3

デ
ィ

(出力形式)
Content-Type(レスポンス)
response

123
WPSC002-Ed.1.1 2021-02

ファイル削除操作 API
オブジェクトストレージからファイルを削除する API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
ファイル削除操作 API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-13）。
表 5-13: HTTP(S)リクエストのパラメーター（ファイル削除操作 API）
No

種

(データ項目)別名称

1

HTTP メソッド

必須/
説明

任意/

書式

不要
“DELETE”固定

必須

文字列

必須

文字列

/api/v1/sys/files/{リソース ID}/{オブジェ2リクト ID}

ク{リソース ID}はドキュメントの格納先を一意

エ パス（URL）に示す IDス{オブジェクト ID}はドキュメントを一意に示ト

す ID。「フォルダ+ファイル名」を「/」区切

行

りで設定

3

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

必須

文字列

4

文字コード

utf-8

必須

文字列

必須

文字列

必須

文字列

5

6

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクセスッ Authorization

トークンを指定ダ

出力時の入出力形式(出力形式)
Accept

IANA に登録された以下の MIME タイプを指定
・"application/json"

124
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-14）。
表 5-14: HTTP(S)レスポンスのパラメーター（ファイル削除操作 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

"application/json"

必須

文字列

空文字

必須

文字列

・AP 未接続：404 固定（指定したリソースが見つからない）
ヘ
2

ッ
ダ
ボ

3

デ
ィ

(出力形式)
Content-Type(レスポンス)
response

125
WPSC002-Ed.1.1 2021-02

マスタデータ参照（システム）API
リクエストパラメータで指定された情報を条件に、リソースマスタとデータ項目マスタから情報を取得する API を示す。
HTTP(S)プロトコルでの要求と応答のデータ項目設定
マスタデータ参照（システム）API の HTTP(S)プロトコルでの要求と応答のデータ項目設定を以下に示す。
リクエスト(要求情報)のパラメーター
HTTP(S)で要求情報を広域向けアプリケーションから水道標準プラットフォームに送信する。その際の HTTP(S)リクエストのパラメーターを以下に示す（表 5-15）。
表 5-15: HTTP(S)リクエストのパラメーター（マスタデータ参照（システム）API）
No

種(データ項目)

別

名称

必須/
説明

任意/

書式

不要

1

リ HTTP メソッド

“GET”固定

必須

文字列

2

ク パス（URL）/api/v1/sys/masters/

必須

文字列

3

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

必須

文字列

utf-8

必須

文字列

必須

文字列

必須

文字列

必須

文字列

基本仕様書の 6.2.1 項を参照

必須

文字列

基本仕様書の 6.2.2 項を参照

必須

文字列

ス
4

ト 文字コード行

5

6

ヘ (依頼元情報)

RFC6750 に準拠した OpenID Connect アクッ Authorization

セストークンを指定

ダ

出力時の入出力形式(出力形式)

IANA に登録された以下の MIME タイプを指Accept定・"application/json"11

ボ (事業体 ID)

施設を所有する事業体の ID

デ company_id

基本仕様書の 3.1.2 項を参照

ィ (システム区分コード)
system_kubun_code(業務区分コード)
business_kubun_code

126
WPSC002-Ed.1.1 2021-02

レスポンス(応答情報) のパラメーター
HTTP(S)で要求情報の通信結果を水道標準プラットフォームから広域向けアプリケーシ
ョンに返却する。その際の HTTP(S)レスポンスのパラメーターを以下に示す（表 5-16）。
表 5-16: HTTP(S)レスポンスのパラメーター（ドキュメント参照 API）
No

1

種

(データ項目)

別

名称

必須/
説明

任意/

書式

不要

レ

HTTP ステータスコード(RFC2616、ス

RFC7231)に従った、要求に対する実行結

ポ

果コード

ン (実行結果コード)

・処理成功：200 固定

ス Status Code・処理失敗：404 固定

行・不正要求：400 固定

必須

文字列

必須

文字列

リソースマスタ登録年月日時分秒の降順 必須

文字列・AP 未接続：404 固定（指定したリソースが見つからない）
ヘ
2

ッ
ダ
ボ
デ
ィ

(出力形式)
Content-type(レスポンス)
response(リソース ID)
resource_id(リソース論理名)
resource_logical_name(リソース物理名)
resource_physical_name3"application/json"

マスタデータの件数分、設定するでソートして設定
ドキュメントの格納先を一意に示す ID

必須

文字列

リソースの名称（論理）

必須

文字列

リソースの名称（物理）

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

(リソースマスタ登録年
月日時分秒)

リソースマスタに登録した年月日時分秒

resource_master_regist

YYYY-MM-DDThh:mm:ss.sssZ

ration_date_time(データ項目)

ドキュメント内のデータ項目の件数分、

data_items

設定する(データ項目番号)

データ項目毎に一意に割りあてている番

data_item_number

号

(項番)
No

データ項目毎に自由設定している項番

127
WPSC002-Ed.1.1 2021-02

No

種(データ項目)別名称(階層)
hierarchy

必須/
説明

任意/

書式

不要
データ項目の階層

必須

文字列

データ項目名（論理）

必須

文字列

データ項目名（物理）

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

必須

文字列

(データ項目論理名)
data_item_logical_n
ame(データ項目物理名)
data_item_physical_
name
データ項目のデータ型
01：String(データ型)
data_type

02：日付（String）
03：Integer
04：Double
05：Boolean
06：Object(データ項目区分)
data_item_kubun(必須フラグ)required_flag

基本仕様書の 6.2.3 項を参照
データ項目の必須/任意を表すフラグ
0：必須ではない
1：必須
該当データ項目が繰り返しか否かを表す(繰り返しフラグ)

フラグ

recurring_flag

0：繰り返さない
1：繰り返す(暗号化要否フラグ)
encryption_necessit
y_flag

該当データ項目の暗号化要否を表すフラグ
0：暗号化否1：暗号化要128
WPSC002-Ed.1.1 2021-02

公開鍵証明書ファイル取得 API
IoT ゲートウェイの「公開鍵証明書ファイル取得 API」と IF 仕様は同じである。詳細は 4.9章参照。FQDN はシステムゲートウェイを指定する事が出来る。

129
WPSC002-Ed.1.1 2021-02

データプロパティ仕様
この章では、前述(4.3 章)の各種 API で使用するデータのプロパティ仕様を記載する。

施設マスタのプロパティ仕様
施設マスタのプロパティ仕様を以下に示す(表 6-1)。
表 6-1: 施設マスタのプロパティ仕様
No.

データ名

内容

型

例

テナント ID。水道標準プラットフ
1

テナント ID

ォーム内で一意stringT01

stringF0000000321

string

TDB-999999999-

string131091string130001string○○浄水場

基本仕様書の 3.1.2 項を参照

施設 ID。水道標準プラットフォー
2

施設 ID

ム内で一意
基本仕様書の 3.1.2 項を参照

3

事業体 ID施設を所有する事業体の ID
基本仕様書の 3.1.2 項を参照

施設が存在する市区町村の ID
4

市区町村 ID

総務省の「都道府県コード及び市区町村コード」を参照。

施設が存在する都道府県の ID
5

都道府県 ID

総務省の「都道府県コード及び市区町村コード」を参照

6

施設名

施設の名称

130
WPSC002-Ed.1.1 2021-02

設備マスタのプロパティ仕様
設備マスタのプロパティ仕様を以下に示す(表 6-2)。
表 6-2: 設備マスタのプロパティ仕様
No.

データ名

内容

型

例

テナント ID。水道標準プラットフ
1

テナント ID

ォーム内で一意stringT01

string

E0000000321

string

TDB-999999999-

stringF0000000321

stringE001

基本仕様書の 3.1.2 項を参照

設備 ID。水道標準プラットフォー
2

設備 ID

ム内で一意
基本仕様書の 3.1.2 項を参照

3

事業体 ID

4

施設 ID

5

設備区分コード

6

設備名

施設を所有する事業体の ID
基本仕様書の 3.1.2 項を参照

この設備が所属する施設マスタ(表6-1 を参照)の施設 ID

設備の区分を表すコード値
基本仕様書の 4.5.3 項を参照

設備の名称

string○○監視制御設備131
WPSC002-Ed.1.1 2021-02

機器マスタのプロパティ仕様
機器マスタのプロパティ仕様を以下に示す(表 6-3)。
表 6-3: 機器マスタのプロパティ仕様
No.

データ名

内容

型

例

テナント ID。水道標準プラットフ
1

テナント ID

ォーム内で一意stringT01

string

M0000000321

string

E0000000321

string

TDB-999999999-

StringF0000000321

stringM0001

string○○設置

基本仕様書の 3.1.2 項を参照
機器 ID。水道標準プラットフォー
2

機器 ID

ム内で一意
基本仕様書の 3.1.2 項を参照

3

設備 ID

4

事業体 ID

5

施設 ID

6

機器区分コード

7

機器名

この機器が所属する設備マスタ(表6-2 を参照)の設備 ID

施設を所有する事業体の ID
基本仕様書の 3.1.2 項を参照

この設備が所属する施設マスタ(表6-1 を参照)の施設 ID

機器の区分を表すコード値
基本仕様書の 4.5.3 項を参照

機器の名称

132
WPSC002-Ed.1.1 2021-02

計測項目マスタのプロパティ仕様
計測項目マスタのプロパティ仕様を以下に示す(表 6-4)。
表 6-4: 計測項目マスタのプロパティ仕様
No.

データ名

内容

型

例

テナント ID。水道標準プラットフ
1

テナント ID

ォーム内で一意stringT01

string

E0000000321

string

M0000000321

stringV0001

000

基本仕様書の 3.1.2 項を参照

2

設備 ID

3

機器 ID

この計測項目が所属する設備マスタ(表 6-2 を参照)の設備 ID

この計測項目が所属する機器マスタ(表 6-3 を参照)の機器 ID

計測値区分コー

計測値区分コードド

基本仕様書の 5.3.5 項を参照

5

計測項目番号

計測項目番号

string

6

OPCUA タグ名

PLC のキー名

string4

SapporoWaterPla
nt_Signal.No1

計測値の種別7

現在値/履歴値

1 の場合、現在値

string1string1string○○水位2 の場合、履歴値
1 の場合、読み取り専用
8

読み書きフラグ

2 の場合、書き込み専用
3 の場合、読み書き可能

9

計測項目名

計測項目の名称- 以上 -133
WPSC002-Ed.1.1 2021-02