IoT PlatformAPI リファレンス(16.0_0 版)

All Rights Reserved, Copyright©FUJITSU LIMITED 2016-2024

＜改版履歴＞
版数
1.0 版
1.1 版

1.2 版

1.3 版
4_1.0 版

4_2.0 版

5.0_0 版

5.1_0 版

5.1_1 版

5.1_2 版

7.0_0 版

説明
初版
注釈の番号を振り直し(欠落を解消)
1.2 節にダイナミックリソースコントローラー(DRC)の参照先を記載
2.2 節を 2.2.1～2.2.5 に分割し、2.2.6 を追加
2.2 節に記載していた「リソース_Binary」に対する制約事項を削除
日本時間記載を全て UTC に変更
時刻凡例の「+0900」を全て「Z」に変更
2.3.1 節、2.4.1 節 SSL 通信にあたって TLS1.1 または TLS1.2 を使用すべきである旨を記載
2.5.1 節 MQTT における QoS に関する記載の追記
誤記の修正
リソースの検索における$orderby の記述を削除
2.1 節「各パラメータの最大・最小値」に関する追記
3.2 節 エラー応答追記
7.2 節 Body 文における last_modified の日時に関する記載追記
2.1 節 リソースパスの利用可能文字について修正
機能エンハンス
2.3.1 節、2.3.2 節 部分取得機能(Range Request)を追加
2.4 節「CORS(Cross-Domain Resource Sharing)対応」を追加
3.3 節、5.3 節 hierarchy_get 権の利用方法を追加
8.1 節、8.2 節 クライアント証明書関連事項を追加
8.1 節 hierarchy_get 権、hierarchy_put 権を追加
機能エンハンス
2.4 節、8.1 節、8.2 節 17 年夏以降エンハンスに関する記載を削除
2.2.7 節 通信頻度に対するシステム制限について を追加
第 11 章 システム格納データリファレンス を追加
機能エンハンス
3.1 節、3.4 節 csv/テキスト/バイナリ形式のデータ登録、およびデータ
登録時の圧縮送信を追加
3.3 節 配列形式に対する検索を追加
機能エンハンスに伴う記載内容の修正(2.1 節、付録 1)
機能エンハンス
2.1 節、2.4.1 節、3.1 節、3.4 節、3.5 節、4.1 節、11.3 節 要求とエラー情報との関連づけ機能を追加
2.1 節 skip 件数の最小値を変更
3.3 節 検索結果の並び替え機能を追加
2.3.1 節、2.5.1 節 サポートする TLS バージョンの変更
補記追加
3.1 節、3.2 節、3.3 節、3.4 節、3.5 節 クエリに対する補記を追加
誤記の修正
2.1 節 誤記の削除
11.3 節 誤記の修正
記載の追加
第 10 章 章タイトルの変更
10.1 節 Request における注意事項、Response における要求仕様を追加
10.3 節 リソース(転送)_JSON の API 呼出し仕様を追加
機能エンハンス
2.3.1 節、2.3.2 節、2.4.1 節、2.4.2 節 データ取得時の圧縮通信機能を追加

日付
2016/10/7
2016/11/1

2016/12/1

2017/1/12
2017/4/1

2017/8/1

2017/11/18

2018/3/17

2018/4/11

2018/6/13

2018/9/15

All Rights Reserved, Copyright©FUJITSU LIMITED 2016-2024

9.0_0 版
11.0_0 版

14.0_0 版
16.0_0 版

2.4.1 節、5.1 節、5.5 節 要求とエラー情報との関連づけ機能を追加
10.1 節 リーズンフレーズの要求を削除
11.3 節 失敗要因メッセージを追加
機能エンハンス
変更なし
仕様変更に関する追記
2.3.2 節 HTTP レスポンスの reason-phrase に関する注意書きを追記※以下の API 実行時は reason-phrase 付与されません。
第 5 章 リソース_Binary データ制御(REST)記載の全 API
第 7 章 リソース制御(REST)記載の全 API
第 8 章 アクセスコード制御(REST)記載の全 API
第 9 章 イベント制御(REST)記載の全 API
機能エンハンス
変更なし
ダイナミックリソースコントローラー（オンデマンドデータ収集）機能
削除にともなう修正

2019/8/22
2021/1/16

2022/4/1
2024/6/3

All Rights Reserved, Copyright©FUJITSU LIMITED 2016-2024

はじめに
このたびは「IoT Platformサービス（以下、本サービス）」をご検討いただき、誠にありがとうございます。
この「IoT Platform APIリファレンス（以下、本書）」は、本サービスをご契約いただいたお客様、またはご採用いただくお客様のための資料です。下記につきましてご了承くださいますよう、よろしくお願いいたします。
１． ご検討中のお客様は、本書を本サービスご採用可否のご判断のためにのみ、ご参照願います。
２． 本書および本書の内容について、第三者へご開示、ご提供にはならないようにお願いいたします。
３． 発行元の許可なく、本書の記載内容を複写、転写することを禁止します。
本書には本サービスをご採用いただくための重要な情報を記載しています。
ご契約いただいたお客様は、ご利用前に本書をよくお読みの上、本サービスをご利用ください。なお、本書は大切に保管してください。
ご採用いただけないお客様は、お客様の責任で本書をすみやかに廃棄願います。
本書の作成にあたって、細心の注意を払い可能な限り分かりやすい記載に努めていますが、本書の記述に誤りや欠落があっても弊社はいかなる責任も負わないものとします。本書及びその記述内容は予定なく変更される場合があります。
本書の内容の一部または全部を無断で複製・転載・改編しないでください。

免責事項について・本サービスのマニュアルに記載されていない操作を行なったことで思わぬ誤動作や、予期せぬ課金が発生した場合であっても一切の責任を追いかねます。
・本サービスの利用、または利用できなかったことにより万が一損害（業務の中断・データの破損/損失・事故などによる損害や第三者からの賠償請求の可能性を含む）が生じたとしても、責任を一切負いかねます。

All Rights Reserved, Copyright©FUJITSU LIMITED 2016-2024

＜用語＞
用語

説明

IoT

Internet of Things の略「モノのインターネット」と言われるが、「モノがインターネットプ
ロトコル（インターネット言語）でネットワークされている状態」の
こと。

REST

REpresentational State Transfer の略
複数のソフトウェア連携に適した設計原則を Web に適用したソフト
ウェアの設計様式を示す。
※特定の URL にパラメータを指定して HTTP でアクセスすると XML で記述されたメッセージが送られてくるような、呼び出しインターフェース（「RESTful API」と呼ばれる）。
本サービスでは XML ではなく JSON 形式で返信する。

MQTT

Message Queuing Telemetry Transport の略
MQTT とは、TCP/IP ネットワーク上の通信プロトコルで、多数の主体の間で短いメッセージを頻繁に送受信する用途に向いた軽量なプロ
トコル。M2M ネットワークや IoT（Internet of Things）分野での普及が見込まれている。ヘッダ部分が最小で 2 バイトと小さく、HTTP
で同様の通信を行う場合より、通信量や CPU 負荷・電力消費量などを数十分の一に抑える。

ダイナミックリソース
コントローラーDynamic Resource Controller
富士通の広域分散技術を用いた分散制御処理。データ収集においてトラフィックの変動に従い、限られたリソースの中で最適化した収集の実現を補佐する機能。

リソース
リソースデータ
アクセスコード

リソースデータの収集単位
１つのデータ
リソースを対象に設定する認可情報

備考

All Rights Reserved, Copyright©FUJITSU LIMITED 2016-2024

- 目次 第1章

第2章

第3章

第4章

第5章

第6章

第7章

第8章

はじめに ........................................................................................................................................ 3
本書の目的 ........................................................................................................................................ 3
ドキュメント構成 ............................................................................................................................. 3
全体共通事項 ................................................................................................................................. 4
各パラメータの最大・最小値 ........................................................................................................... 4
注意事項 ............................................................................................................................................ 8
API による課金について ........................................................................................................... 8
リソース、アクセスコード及びイベントの API 操作について................................................ 8
同一リソースに対する REST／MQTT の両立について........................................................... 9
リソース/アクセスコード/イベント制御インターフェースの登録・更新時の JSON キーについて
9
リソースパスについて ............................................................................................................... 9
リソース、アクセスコードおよびイベントの設定反映時間について ...................................... 9
通信頻度に対するシステム制限について ................................................................................. 9
REST(HTTP)共通事項........................................................................................................................ 10
Request.................................................................................................................................... 10
Response ................................................................................................................................. 10
CORS (Cross-Origin Resource Sharing)対応................................................................................ 12
Preflight Request.................................................................................................................... 12
本要求リクエスト .................................................................................................................... 14
MQTT 共通事項.................................................................................................................................. 14
Request.................................................................................................................................... 14
Response ................................................................................................................................. 16
リソース_JSON／リソース(転送)_JSON のデータ制御(REST) ..................................................... 18
リソース_JSON へのデータ登録／リソース（転送）_JSON によるデータ転送 .............................. 18
リソース_JSON のデータ参照 .......................................................................................................... 23
リソース_JSON のデータ検索 .......................................................................................................... 24
リソース_JSON のデータ更新 .......................................................................................................... 28
リソース_JSON のデータ削除 .......................................................................................................... 30
リソース_JSON／リソース(転送)_JSON へのデータ制御(MQTT) ................................................. 32
リソース_JSON へのデータ登録／リソース（転送）_JSON へのデータ転送 .................................. 32
リソース_JSON／リソース（転送）_JSON のデータ参照 ................................................................ 33
リソース_Binary データ制御(REST) ........................................................................................... 35
リソース_Binary へのデータ登録................................................................................................... 35
リソース_Binary のデータ参照 ...................................................................................................... 36
リソース_Binary のデータ検索 ...................................................................................................... 37
リソース_Binary のデータ更新 ...................................................................................................... 40
リソース_Binary のデータ削除 ...................................................................................................... 40
リソース_Binary データ制御(MQTT) ........................................................................................... 42
リソース_Binary へのデータ登録................................................................................................... 42
リソース_Binary のデータ参照 ...................................................................................................... 42
リソース制御(REST) .................................................................................................................... 44
リソースの登録 ............................................................................................................................... 44
リソースのメタデータ参照 ............................................................................................................. 45
リソースのメタデータ更新 ............................................................................................................. 48
リソースの削除 ............................................................................................................................... 48
アクセスコード制御(REST) ......................................................................................................... 50
アクセスコードの登録 .................................................................................................................... 50
アクセスコードの参照 .................................................................................................................... 52
アクセスコードの更新 .................................................................................................................... 54
アクセスコードの削除 .................................................................................................................... 55
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
1

イベント制御(REST) .................................................................................................................... 57
イベントの登録 ............................................................................................................................... 57
イベント情報の参照........................................................................................................................ 60
イベント情報の更新........................................................................................................................ 64
イベントの削除 ............................................................................................................................... 65
第 10 章 外部システム呼出しリファレンス .............................................................................................. 66
API 呼び出し（イベント機能） ...................................................................................................... 66
Email 送信（イベント機能） .......................................................................................................... 67
API 呼出し（リソース(転送)_JSON 機能） ..................................................................................... 67
第 11 章 システム格納データリファレンス .............................................................................................. 69
リコメンドリソース........................................................................................................................ 69
負荷リソース................................................................................................................................... 69
エラー収集用リソース .................................................................................................................... 70
付録１ Response エラー時のメッセージ一覧 ............................................................................................. 72
第9章

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-20222

第1章 はじめに
本書の目的
本書はIoT Platform（以下：本サービス）のご利用に際し、APIを利用しアプリケーションを開発する方向けの「APIリファレンス」です。
ドキュメント構成
サービスのご利用に際し、お客様を支援するための以下のマニュアルをご用意しております。
マニュアル名IoT Platform サービス詳細説明書

説明
本サービスのサービス仕様を説明しています。

IoT Platform ユーザーガイド

本サービスを利用したシステムを設計するにあたって、具体的な例を交えて設計指針の説明を行うマニュアルです。

IoT Platform API リファレンス

本サービスで提供するサービスを利用したアプリケーションを設計するための API のリファレンスマニュアルです。（本書）

IoT Platform サービスポータル操作マ
ニュアル

Web インターフェース機能(以下：サービスポータル)に関するマニュアルです。

Memo
リソース、アクセスコードなど本サービス全般の定義・考え方については、「IoT Platform サービスポー
タル操作マニュアル」第 3 章をご参照ください。
また、ダイナミックリソースコントローラーについては「IoT Platform ユーザーガイド」を参照ください。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-20223

第2章 全体共通事項
本サービスの保持するデータに対して、REST(HTTP)/MQTT にてアクセスすることによる操作が可能です。本
章ではその共通事項について説明します。
各パラメータの最大・最小値
表 1:外部インタフェース最大・最小値一覧に、REST(HTTP) のヘッダ、URI 及び MQTT の Topic において指定するパラメータの最大・最小値を説明します。
表 2:filter 条件詳細リソースデータ制御インタフェース 最大・最小値一覧に、REST(HTTP)にて検索時に指定する filter 条件の詳細パラメータの最大・最小値を説明します。
表 3: filter 条件詳細アクセスコード制御・イベント制御インタフェース 最大・最小値一覧に、API 操作
によりアクセスコードやイベントを登録・参照・更新・削除する時に指定する filter 条件の詳細パラメータの最大・最小値を説明します。
表 4: select 条件詳細リソースデータ制御インタフェース 最大・最小値一覧に、select 条件に指定する詳細パラメータの最大・最小値を説明します。
表 5: Body 部リソースデータ制御インタフェース最大・最小値一覧に、REST の Body や MQTT の Payload に展開されるリソースデータに記載するパラメータの最大・最小値を説明します。
表 1：外部インタフェース最大値・最小値一覧
パラメータ名リソースパス

拡張子
圧縮タイプ
アクセスコード

登録日時

説明

使用可能文字最小

リソースを一意に表現するためのパス。/(スラッシュ)区切
りで階層的に表現できます。
※先頭の「/」はリソースパスに含みません。

・半角英数字・「-」、「_」、「/」※「/-」、「/_」のように、先頭や「/」の後に「-」と「_」 2 文字は指定不可。
※「//」のように「/」の連続も不可

リソースデータのフォーマッ
json、csv、txt、bin
3 文字
トを表す拡張子
Body データを圧縮して送信す
gz のみ
2 文字
る際のデータの圧縮タイプ
外部 IF アクセスの権限を示す
半角英数字のみ
3 文字
識別子
登録対象データに付与する／付与された登録日時。
ISO8601(基本表記としてのミリ秒表現を使用)に従います
・半角英数字および、＋ or （20141225T103612.001Z な ・英字は日付と時刻の間の T と、 16 文字
ど）。
UTC を表す Z のみ許容します。
精度はミリ秒(ミリ秒を省略
した場合、0 ミリ秒とみなします)

最大
128 文字
（但しリソ
ース（転送
用）の場合
「_fwd」、
リソース_Binary の場合、「_bin」を含めて 128
字）
4 文字
2 文字
48 文字

24 文字

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
4

RETAINfilter 条件

top 件数skip 件数

選択 key

MQTT broker 側で本登録データを保持しておくかどうか。
true または false・true ：保持する
・false ：保持しない
処理対象を、<filter 条件>に一致するものに限定します。 後述の name,value に使用可能<filter 条件>は、「プロパテ な文字列に従います。
ィ名 演算子 条件値」とし、 ※value では、「’」（シングand or で複数定義できます。 ルクォーテーション）で囲った
登録日時を示すプロパティ名 ものを文字列、そうでないもの
として _date を使用できまを数値として扱います。
す。
検索結果として得られるデー
半角数字
タ数を限定します
検索結果として得られたデー
半角数字
タを指定件数分 skip します
Select 条件時の選択 key$select=<選択 key>
・後述の name に使用可能な文字<選択 key>で指定されたフィ
列に従います。
ールドのデータのみを返しま ・<選択 key>は「,」区切りで複す。
数指定できます。
<選択 key>は、JSON での name、例）
XML での要素名、属性名に相当 $select=data.no,data.name
します。

4 文字

5 文字

6 文字

256 文字1件

1000 件0件

100,000件

8 文字

256 文字Content-Type

Body の MIME タイプ

RFC2046、RFC6838、RFC4289、RFC6657 に従います。

0 文字

128 文字x-iotpf-request-id

リクエスト識別 ID%x21-%x7E（印字可能な US－ASCII）

0 文字

64 文字

%x21-%x7E（印字可能な US－ASCII）

1 文字

128 文字

-

-

1,000

x-iotpf-meta-data1,x-iotpf-meta-data2, リソースデータのメタデータ
x-iotpf-meta-data3

JSON 配列要素数

Body 文に JSON 配列を記載する際における配列要素数

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-20225表 2：filter 条件詳細リソースデータ制御インタフェース
パラメータ名説明

プロパティ名JSON 形式のリソースデータにおける name

条件値

比較演算子

論理演算子

JSON 形式のリソースデータにおける value に対する条件値

最大・最小値一覧

使用可能文字最小・「”」、「\(*1)」、「’」、「&」、「$」、「(」、「)」制御
コードを除く、全ての Unicode
文字(UTF-8)
・URI の非予約文字（「半角英数
字」、「-」、「.」、「_」、「~」）以外はパーセントエンコードす
ること。
1 文字
・先頭文字として「_」は使用不
可・name として「and」、 「or」、「eq」、 「ne」、 「lt」、「le」、「gt」、 「ge」は未対応。
・name が階層構造になっている場合は、<name>.<name>で表現する。深さは最大 15

最大128 文字・「”」、「\(*1)」、「’」,「＄」制御コードを除く、全ての 文字列の場合、最大 256 文字
Unicode 文字 (UTF-8)
・URI の非予約文字（「半角英数
字」、「-」、「.」、「_」、「~」） 整数の場合、以外はパーセントエンコードす-999999999999999～
る必要があります。
999999999999999
・「’」で囲ったものを文字列、そうでないものを数値として扱います。
実数の場合、・null は、値が存在しないこと 倍精度浮動小数点数を示します。

eq(等号)、ne(不等号)、gt(よeq、ne、gt、ge、lt、le のいず
り大きい)、ge(以上)、lt(よりれか小さい)、le(以下)
and(論理積)、or(論理和)。
論理演算子は「()」を使用して、(A eq 1 and B eq 1)or(A eq 2
and B eq 2)のような表現ができます。
and、or のいずれか
ただしこの場合、()内に()は定義できません。例えば、((A eq
1 and B eq 1)or(A eq 2 and Beq 2))and(C eq 1)は誤りにな
ります。

1回

8回
(出現回
数)

0回

8回
(出現回
数)

(*1) U+005C(REVERSE SOLIDUS)

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-20226表 3：filter 条件詳細アクセスコード制御・イベント制御インタフェース 最大・最小値一覧
パラメータ名プロパティ名説明
フィルタプロパティ名

使用可能文字

最小

最大_resource_path

各1回
(出現回
数)

各1回
(出現回
数)

・「”」、「\(*1)」、「’」,「＄」制御コードを除く、全てのUnicode 文字(UTF-8 ※1)
各プロパティ名に対する条件
・URI の非予約文字（「半角英数値。
文字列の場合、字」、「-」、「.」、「_」、「~」）startwith()による前方一致を
最大 256 文字
以外はパーセントエンコードす
使用可能。
ること
・文字列のみを対象とし、必ず「'」で囲う3回
eq(等号)
eq のみ
(出現回
数)
and(論理積)
2回※論理演算子が and のみである and のみ(出現回
ため、「()」は使用不可
数)

条件値

比較演算子

論理演算子

(*1) U+005C(REVERSE SOLIDUS)
表 4：select 条件詳細リソースデータ制御インタフェース
パラメータ名説明

選択 keyJSON 形式のリソースデータにおける name

選択 key の
複数指定<選択 key>は「,」区切りで複数指定可

最大・最小値一覧

使用可能文字最小・「”」、「\(*1)」、「'」、「&」、「$」、「(」、「)」制御コードを除く、全ての Unicode 文字(UTF-8※1)・URI の非予約文字（「半角英数字」、「-」、「.」、「_」、「~」）以
1 文字
外はパーセントエンコードすること・先頭文字として「_」は使用不可
・name が階層構造になっている場
合は、<name>.<name>で表現する。
深さは最大 15

「,」

-

最大

128 文字

10 回
(出現回
数)

(*1) U+005C(REVERSE SOLIDUS)

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-20227表 5：Body 部リソースデータ制御インタフェース最大・最小値一覧
パラメータ名

説明

使用可能文字Body 部に記載できる文字（Bulk Insert 機能利用時）--

Body 部に記載できる文字

name

JSON 形式のリソースデータにおける name

JSON 形式のリソースデータにおける valuevalue

JSON 形式の配列であること

最小

最大

0 Byte16Mbyte（JSON をBSON 形式
に変換し
た場合の
サイズ）

拡張子に応じた内容であること
・json または省略の場合
JSON 形式・csv の場合
csv ファイル形式
0 Byte・txt の場合
テキストファイル形式
・bin の場合
任意のバイト列・「”」、「\(*1)」、「’」、「&」、「$」、「(」、「)」制御コードを除く、全ての Unicode 文字(UTF-8)
・先頭文字として「_」は使用不可
1 文字
・name として「and」、「or」、「eq」、「ne」、 「lt」、「le」、 「gt」、「ge」は未対応(検索不可)。
・name の階層の深さは最大 15256kbyte
(圧縮送
信時は伸
長後のサ
イズ)

128 文字

文字列の場合、・「”」、「\(*1)」、「’」,「＄」 0～Body 部としての制御コードを除く、全ての Unicode 最大長文字(UTF-8)
・「”」で囲ったものを文字列、 整数の場合、そうでないものを数値として扱い -999999999999999～999999999999999
ます。
・null は、値が存在しないことを示します。
・true/false は、bool 値であることを示します。

実数の場合、
倍精度浮動小数点数(ただし、表示形
式は必ずしも保証されません)(*1) U+005C(REVERSE SOLIDUS)
注意事項
API による課金について
本サービスでは、リソース ID 数、API、SSL やイベントの利用回数に応じて従量課金させて頂きます。
リソース、アクセスコード及びイベントの API 操作について
リソース、アクセスコード及びイベントの追加・参照・更新・削除を API 操作するためには、予め create、delete、list 権を持ったリソース及びアクセスコードが必要です。また、API 操作できるのは、create、delete、
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-20228list 権を持ったアクセスコードが指定するリソースパス配下のみです。
リソース及びアクセスコードの API 操作を行う場合、予めサービスポータルより、上階層のリソース及びア
クセスコードの登録をお願いします。
同一リソースに対する REST／MQTT の両立について「リソース_JSON」では、REST で登録したリソースデータを MQTT にて SUBSCRIBE により参照することができます。
但し、「リソース_Binary」においては REST で登録したリソースデータを MQTT にて SUBSCRIBE により参照することはできません。
リソース/アクセスコード/イベント制御インターフェースの登録・更新時の JSON キーについて

本ドキュメントに記載した JSON キー以外のキーは使用不可とし、使用された場合は 400 応答します。
また、他の制御インターフェースにおいて必要ない JSON キーが設定されていた場合も、400 応答しま
す。例えば、「リソース_JSON」においてリソースデータを登録する際に、リクエストの Body に“fwd_info”
キーを設定すると“fwd_info”は「リソース(転送)_JSON」に必要な設定であるため 400 応答されます。

リソースパスについて
リソースパスは以下のように定義しています。
・「リソース_JSON」：<お客様任意>・「リソース(転送)_JSON」：_fwd/<お客様任意>
先頭の「_fwd/」制御文字も含みリソースパスとします。
・「リソース_Binary」：_bin/<お客様任意>
先頭の「_bin/」制御文字も含みリソースパスとします。
リソース、アクセスコードおよびイベントの設定反映時間について
サービスポータルや制御 API 操作にてリソース、アクセスコードおよびイベントの追加/変更/削除を実施した後、実施内容が利用できるようになるまで、最大 5 分程度の時間がかかります。(なお、この時間は将来のエンハンス等において変更される可能性があります。)
通信頻度に対するシステム制限について
通信頻度が一定時間目安を超えた場合、すべてのリクエストがエラー返却またはデータ破棄されます。これらの事象の発生は下記から確認することができます。本事象となった場合には、通信頻度の調整、または
料金プランの変更をご検討ください。
通信手段
REST(HTTP)

発生する事象
エラー返却

MQTT

データ破棄

確認する方法HTTP レスポンスにより確認できます。
429 Too Many Requests の場合に発生しています。
エラーログ蓄積機能により確認できます。
“trigger”:“MP”, “error_factor_message”:“Failed to
execute publishing resource data, in the system internal
processing.”となるエラーログ蓄積の場合に発生しています。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
9

REST(HTTP)共通事項
RequestParameters
Base URL⚫
⚫
⚫

値
http://<zone>.fujitsu.com
https://<zone>.fujitsu.com

補足<zone>に入る値はご契約後の通知内
容に従ってください。

http の場合は 80/tcp ポートを使用
https の場合は 443/tcp ポートを使用(TLS1.2 に対応）
注)
➢ URL のパス部(「?」より前の部分)は、パーセントエンコードが不要になります。(パーセン
トエンコード不可)

Headers
Authorization

値
Bearer <アクセスコード>

Accept-Encoding

gzip

Range

補足
アクセスコードはサービスポータ
ルにて設定した値
取得データ（ペイロード）の gzip
圧縮受信を希望する場合に指定
データの一部のみ取得を希望する
場合に指定※複数範囲を指定した場合は、マルチパートで応答します。

M/O(*1)MO(*2)

bytes=<先頭位置>O(*3)
bytes=<先頭位置>-<末尾位置>
bytes=-<サイズ>※コンマ区切りにより複数範囲の指定が可能(*1) M：必須、O：オプション(*2) 3.2 リソース_JSON のデータ参照、および 3.3 リソース_JSON のデータ検索のみで利用できます。
(*3) 5.2 リソース_Binary のデータ参照 のみで利用できます。
Response
Status-Code Reason-Phrase(*1)
200
OK
201
Created204
No Content

206
400
401
403
404
405
408
409
411
412
413

Partial content
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Request Time-out
Conflict
Length Required
Precondition Failed
Payload Too Large

説明
成功、リソースデータ作成の成功
リソース、アクセスコード、イベント作成の成功
以下の何れかに該当・リソースデータ参照時において、リソースは存在するが該当するリソースデータが存在しない・リソースの削除において、削除成功
・メタデータ・アクセスコード・イベント参照時において、各種情報が存在しない（将来変更する場合があります。）
・メタデータ・アクセスコード・イベント削除時において、削除成功
部分取得の成功
リクエストデータに不正値があります
リソースへのアクセス権がありません
アクセス権がありません
リソースが存在しません
該当のメソッドタイプは許可されていません
リクエストタイムアウトです
他のリソースと競合しています
サーバアクセスを拒否しました（Content-Lengh 指定なし）
サーバアクセスを拒否しました（リクエスト条件が不正)サーバアクセスを拒否しました（リクエストボディサイズ
がサーバ許容範囲超越）
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
10

414
415

URI Too Long
Unsupported Media Type

416

Requested Range Not
Satisfiable
Misdirected Request
LockedToo Many Requests
SSL Certificate Error
SSL Certificate
Required
HTTP Request Sent to
HTTPS PortInternal Server Error
Not Implemented

421
423
429
495
496

サーバアクセスを拒否しました（URI が長い）
サーバアクセスを拒否しました（未サポート
Content-Type）
サーバアクセスを拒否しました(Range 要求の値が不正)

レスポンスを生成できないサーバに送信されました
リソースがロックされています
契約上のトラフィック上限を超えています
無効なクライアント証明書を受信しました
クライアントからクライアント証明書が送付されません
でした
497
HTTPS リクエストポートにて HTTP リクエストを受信しました
500
サーバ側の問題による失敗です501
サーバで未サポートリクエストのメソッドが送信されました
502
Bad Gateway
ゲートウェイサーバが起動していません
503
Service Unavailable
一時的にアクセスできません
504
Gateway Time-out
ゲートウェイサーバが時間内にレスポンスを返せません
でした(*1) 以下の API 実行時は付与されません。
第 5 章 リソース_Binary データ制御(REST)記載の全 API
第 7 章 リソース制御(REST)記載の全 API
第 8 章 アクセスコード制御(REST)記載の全 API
第 9 章 イベント制御(REST)記載の全 API
Headers
値
Content-Encoding gzip

補足
取得データ（ペイロード）が gzip 圧縮伝送された場合に限り付与します。(*1)
Content-Length
Body サイズ(byte)
Content-Range<先頭位置>-<末尾位置>/<全体長> 206 応答にて付与します。Range 要求において複数範囲を指定するとマルチパート応答となり、それぞれのパートに付与します。
(*1) 3.2 リソース_JSON のデータ参照、および 3.3 リソース_JSON のデータ検索の Request にて
Accept-Encoding が指定され、かつ取得したデータの圧縮前のサイズが 1024byte を超える場合に付与します。
1. エラー時は以下の形式で詳細情報を設定する
Headers
Content-Type値
application/jsonまたはapplication/json; charset=UTF-8

補足固定

1. Body{"errors": [{"message": "<メッセージ>","<任意の name>": "<任意の value>"}]}

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202211

パラメータ名
メッセージ
任意の name

値
エラーの詳細情報
エラーの付加情報の name

任意の value <任意の name>に応じた value(*1) M：必須、O：オプション

補足―
エラーに応じて任意の name を設定―

M/O(*1)
M
O
O

エラー時は Body に詳細情報が設定されます。詳細情報については、付録 1 を参照してください。

CORS (Cross-Origin Resource Sharing)対応
Web ブラウザでは、同一生成源ポリシー (Same-Origin Policy) によって Web ページを生成したドメイン
以外への REST (HTTP) リクエストは基本的にはできません。IoT Platform では、安全にクロスドメインアクセスを許可する仕組みとして CORS (Cross-Origin Resource Sharing)(*1) に対応しています。
(*1) W3C にて規定されています。(http://www.w3.org/TR/cors/)
CORS 仕様に準じてクロスドメインアクセスを行う際の通信手順には、以下の 2 種類があります。
➢ 直接、クロスドメインアクセスするリクエスト（本要求リクエスト）を送信する手順。
➢ Preflight Request（クロスドメインアクセスが可能か否かを確認するリクエスト）を送信し、そのレスポンスを受けた後に改めてクロスドメインアクセスするリクエスト（本要求リクエスト）を送信する手順。
なお、CORS 対応は REST(HTTP)アクセスに限り動作します。サービスポータルへのアクセスには動作しませんのでご注意ください。
Preflight Request
RequestMethodOptions値-

補足-

Headers
OriginAccess-Control-Request-Method値<オリジンサーバのドメイン>
POST、PUT、GET、DELETE のいずれかAccess-Control-Request-Headers

Authorization
Content-TypeRange
x-iotpf-meta-data1
x-iotpf-meta-data2
x-iotpf-meta-data3
x-iotpf-request-id
Accept-Encoding補足
本 要 求 の REST (HTTP)
で使用するメソッドを指定してください。
下記参照ください。
下記参照ください。
下記参照ください。

M/O(*1)
M
M

下記参照ください
下記参照ください

O
O

M
O
O
O

(*1) M：必須、O：オプション➢

Access-Control-Request-Headers の補足事項について
 複数ヘッダを指定する場合は、「，」(コンマ) で区切って指定します。
 Content-Type は、本要求リクエストが以下となる場合に必要です。
1. リソースの登録（7.1 節）
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202212

➢

2. リソースのメタデータ更新（7.3 節）
3. アクセスコードの登録（8.1 節）
4. アクセスコードの更新（8.3 節）
5. イベントの登録（9.1 節）
6. イベント情報の更新（9.3 節）
7. リソース_JSON へのデータ登録／リソース（転送）_JSON によるデータ転送（3.1 節）
8. リソース_JSON のデータ更新（3.4 節）
9. リソース_Binary へのデータ登録（5.1 節）
 x-iotpf-meta-data1、x-iotpf-meta-data2、x-iotpf-meta-data3、Range は、本要求リクエストが以下となる場合に必要です。
1. リソース_Binary データ制御(REST)（第 5 章）
 x-iotpf-request-id は、本要求リクエストが以下となる場合に必要です。
1. リソース_JSON へのデータ登録／リソース（転送）_JSON によるデータ転送（3.1 節）
2. リソース_JSON のデータ更新（3.4 節）
3. リソース_JSON のデータ削除（3.5 節）
4. リソース_Binary へのデータ登録(5.1 節)
5. リソース_Binary のデータ削除(5.5 節)
 Accept-Encoding は、本要求リクエストが以下となる場合に必要です。
1. リソース_JSON のデータ参照（3.2 節）
2. リソース_JSON のデータ検索（3.3 節）
サービスポータルにて CORS が有効と設定されている場合において、Origin ヘッダが付与され、かつ必須ヘッダが付与されていない場合は、エラー応答 (400) を返します。

Body
なし

値
-

補足
-

Response
Status-Code
2.3.2 節を参照

Reason-Phrase-

説明-

Headers
Access-Control-Allow-Origin

値*

Access-Control-Allow-Methods
Access-Control-Allow-Headers

OPTIONS,POST,PUT,GET,DELETE
Authorization
Content-TypeRange
x-iotpf-meta-data1
x-iotpf-meta-data2
x-iotpf-meta-data3
x-iotpf-request-id

補足
固定（全てのオリジンを許可しま
す）
固定
固定
固定
リ ソ ー ス _Binary デ ー タ 制 御(REST)時
リ ソ ー ス _Binary デ ー タ 制 御(REST)時

リ ソ ー ス _JSON ／ リ ソ ー ス ( 転送)_JSON のデータ制御(REST)、リ
ソース_Binary データ制御(REST)時
Accept-Encoding
リ ソ ー ス _JSON ／ リ ソ ー ス ( 転送)_JSON のデータ制御(REST)時
Access-Control-Max-Age
86400
固定（24 時間）
➢ Access-Control-Request-Headers に複数ヘッダを指定する場合は「，」（コンマ）で区切って指定しま
す。
Body

値

補足
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
13

ボディ

成功：なし
失敗：あり（失敗エラー情報）-

本要求リクエスト
CORS を利用する場合の、通常リクエストとの差分を以下に示します。その他の共通事項は 2.3 節を参照ください。
Request
クロスドメインアクセスする場合の Request には、以下のヘッダを付与してください。
Headers値
補足
Origin<オリジンサーバのドメイン>(*1) M：必須、O：オプション
Response
Headers
Access-Control-Allow-Origin

値*

Access-Control-Expose-Headers

M/O(*1)M

補足
固定（全てのオリジンを許可します）
CORS リクエストに対して許可した場合に限り付与します。
※ CORS 機能は、サービスポータル
から利用するか否かの設定ができます。利用する場合に限り CORS リ
クエストを許可します。
固定
CORS リクエストに対して許可した場合に限り付与します。

LocationContent-Length
Content-Range
x-iotpf-meta-data1
x-iotpf-meta-data2
x-iotpf-meta-data3
Content-Encoding

MQTT 共通事項
本サービスでは、MQTT v3.1 をサポートしています。

⚫

Request
MQTT ブローカーアドレス
MQTT ブローカーアドレス<zone>.fujitsu.com

ポート番号1883/TCP<zone>.fujitsu.com
8883/TCP⚫ <zone>に入る値はご契約後の通知内容に従ってください。
⚫ SSL/TLS は TLS1.2 に対応しています。

⚫

利用可能なメッセージタイプ
メッセージタイプ値
予約済み
0
CONNECT
1
CONNACK
2
PUBLISH
3
PUBACK
4

SSL/TLS○

説明
予約済み
クライアントからサーバへの接続要求
接続確認応答メッセージ発行
PUBLISH の確認応答（QoS=1）

利用可否
×
○
△(送信不可)○○All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
14

PUBREC
PUBRELPUBCOMP
SUBSCRIBE
SUBACKUNSUBSCRIBE
UNSUBACKPINGREQPINGRESPDISCONNECT
予約済み⚫

PUBLISH の確認応答（QoS=2,part1）
PUBLISH の解放要求（QoS=2,part2）
PUBLISH の解放応答（QoS=2,part3）
購読要求
SUBSCRIBE 確認応答
購読解除要求UNSUBSCRIBE 確認応答
PING 要求PING 応答
切断通知
予約済

固定ヘッダ設定値
Parameters値

補足

DUP フラグ

0 or 1 を任意に設定できます。 0:初回メッセージ
1:再送メッセージ

QoS フラグ

0 or 1 or 2 を任意に設定でき 0:最高一回ます。
1:最低一回
但し、セッション断を跨いだ場 2:正確に一回合において、1 or 2 を設定していても 0 と同等の効果となります。
※ MQTT クライアント～ブローカー間の QoS であり、エンド～
エンドではありません。
0 or 1 を任意に設定できます。 0:MQTT broker で最新情報を保持しない
1:保持するRETAIN フラグ

⚫

5
6
7
8
9
10
11
12
13
14
15

○
○
○
○
△(送信不可)○△(送信不可)◯△(送信不可)○×

適用対象のメッセージタイプ
PUBLISH
PUBREL
SUBSCRIBEUNSUBSCRIBE
PUBLISH
SUBSCRIBE

PUBLISH

可変ヘッダ設定値
Parameters値

補足

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

MQIsdp3

固定
固定

User name フラグ
Password フラグ
Will RETAIN
Will QoSWill フラグ
Clean Session フラグ
キープアライブ・
タイマー

1
1
0
0
0
1
1 秒以上
1800 秒以下

トピック名<アクセスコード>/v1/<Tenant
ID>/< リ ソ ー ス

固定
固定
固定
固定
固定
固定
1800 秒より大きい値もしくは 0 秒を設定した場合、
エラー(0x05:接続拒否)
として切断
―

適用対象の
メッセージタイプ
CONNECT
CONNECT
CONNECT
CONNECT
CONNECT
CONNECT
CONNECT
CONNECT
CONNECTPUBLISH
SUBSCRIBEUNSUBSCRIBE

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202215

パス> (*1)(*1) <アクセスコード>の部分は、アクセス可否の判定のために利用します。適切な<アクセスコード>が設定されている場合、/v1/<Tenant ID>/<リソースパス>の部分が一致すれば MQTT クライアント間でメッセー
ジ交換をすることができます。

⚫

ペイロード設定値⚫ CONNECT
Parameters
クライアント識別子
User Name

値
クライアントを一意に識別する文字列
ユーザ名

最大長
23 文字
10 文字

補足
クライアントごとに重複なく設定してください。
ご契約後の通知内容に従ってください。
（テナント ID 固定）
サービスポータルより設定

Password
パスワード
12 文字
⚫ PUBLISH
 リソースデータ登録メッセージ⚫ SUBSCRIBE
 購読対象のトピックのリスト⚫ トピック名は「<アクセスコード>/v1/<Tenant ID>/<リソースパス>」とします。
⚫ UNSUBSCRIBE 購読解除対象のトピックのリスト⚫ トピック名は「<アクセスコード>/v1/<Tenant ID>/<リソースパス>」とします。
⚫

MQTT のトピック名におけるワイルドカードについて
以下のパターンのワイルドカード表現に対応しています。未対応のワイルドカード表現を使用した
SUBSCRIBE/UNSUBSCRIBE メッセージを受信した場合、エラーとしてコネクションを切断します。

No
１

パターン
< ア ク セ ス コ ー ド >/v1/<Tenant
ID>/#

説明
<Tenant ID>のテナント内の全てのリソースパス

2< ア ク セ ス コ ー ド >/v1/<Tenant
ID>/DC/aaa/#

リソースパスの前方一致

3< ア ク セ ス コ ー ド >/v1/<Tenant リソースパスの部分一致
DC/aaa/Tokyo
ID>/DC/+/Tokyo 「<アクセスコード>/v1/<Tenant ID>/」は必須とします。
 以下のワイルドカードパターンには対応していません。
⚫ 「＋」が複数出現する⚫ 「#」と「+」の組み合わせ⚫ 最後に「+」が出現する⚫

マッチするリソースパスの例
DC/
DC/aaa/Tokyo
DC/bbb/Tokyo/1
DC/aaa/Fukuoka/1
DC/bbb/Fukuokaなど全て。
DC/aaaDC/aaa/Tokyo
DC/aaa/Fukuoka/1

Response
固定ヘッダ⚫ 特になし⚫ 可変ヘッダ
Parameters
接続戻りコード

値
0: 接続許可補足―

適用対象のメッセージタイプ
CONNACKAll Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
16

1: 接続拒否(プロトコルバージョン許容不可)
2: 接続拒否(識別子拒否)
3: 接続拒否(サーバ使用不可)
4: 接続拒否(ユーザ名/パスワードが不正)
5: 接続拒否(権限なし)⚫

ペイロード⚫ 特になしAll Rights Reserved,Copyright©FUJITSU LIMITED 2016-202217

第3章 リソース_JSON／リソース(転送)_JSON のデータ制御(REST)
リソース_JSON 及びリソース(転送)_JSON の制御が行える REST のインターフェースの一覧を以下に示します。
表 6：データ蓄積／参照インターフェース一覧
プロト
コル
REST

種別

用途

リ ソ ー ス _JSONへのデータ登録／
リソース(転送)_JSON によるデータ転送

リソースに対して新たにデータを登録（転送）します。
3.1 章[オプション]
リソース_JSON の場合：・なし： 本サービスでの受信日時でデータを登録
・日時指定： 指定された日時でデータを登録
・Bulk Insert フラグ指定： Bulk Insert でデータを登録※Bulk Insert とは一回の API 起動で複数のデータを登録することを指します。
リソース(転送)_JSON の場合：・なし：本サービスにおいて、限定された URL に対してデータを転送します。URL を指定しない場合、MQTT Broker 連携のみ機能します。
リソースに登録済みのデータを参照します。
3.2 章[オプション]・なし： 最新データを返します。
・日時指定： 指定日時のデータを返します。
リソースに登録済みのデータを、条件を指定して検索します。検 3.3 章
索結果として、HIT した登録済みデータそれぞれに、本サービスにおいて管理する登録日時情報を付加した上でデータを返します。
[オプション]・QUERY にて、検索条件を指定できます。
リソースに登録済みのデータを更新します。
3.4 章[オプション]
・新登録日時を指定： データの更新とともに、登録日時を変更します。
・なし： データの更新のみを行い、登録日時は変更しません。
リソースに登録済みのデータを削除します。
3.5 章[オプション]・QUERY にて、削除条件を指定できます。

リソースデータの参照

リソースデータの検索

リソースデータの更新

リソースデータの削除

章

リソース_JSON へのデータ登録／リソース（転送）_JSON によるデータ転送
RequestParameters
Method
URI
データ蓄積

値
PUT
<Base URL>/v1/<Tenant ID>/<リソースパス>.<拡張子>.<圧縮タイプ>?$date=<
登録日時>&$retain=<RETAIN>&$bulk=<Bulk Insert フラグ>&$charset=<Body データ文字コード>&$skip=<Body データ削除指定行>&$numconv=<数値変換>
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202218

データ転送Headers
Body<Base URL>/v1/<Tenant ID>/_fwd/<リソースパス>.<拡張子>.<圧縮タイプ>?$date=<登録日時>&$retain=<RETAIN>&$charset=<Body データ文字コード>&$skip=<Body データ削除指定行>&$numconv=<数値変換>
2.3.1 節 参照
登録対象データMemo
IoT Platform のデータ登録では、「存在するリソースにデータを格納する」という考え方から、Methodに PUT を使用する仕様です。リソースへの POST Method は「リソースの作成(7.1 リソースの登録)」にて使われます。

 URI パラメータ
パラメータ名説明
M/O(*1)
Base URL
2.3.1 節 参照
M
Tenant ID
リソース所有テナントの識別子
M
リソースパス
データ登録対象のリソースパス
M
拡張子
以下のいずれかを指定します。省略時は「.」を含め省略し、この場 O合は json が指定されたものとみなします。
・json
・csv
・txt
・bin
圧縮タイプ
Body データを圧縮して送信する際の圧縮タイプを以下で指定します。 O
省略時は「.」を含め省略し、この場合は Body データが無圧縮とみな
します。
・gz
登録日時
登録対象データに付与する登録日時(*2)
O
省略可($date=含む)で、省略時は本サービスでのリクエスト受信日時を採用します。
・既に指定登録日時のデータが存在するかどうかはチェックせず、追記を行います。
RETAINMQTT broker 側で本登録データを保持しておくかどうか。
O・true ：保持する
・false ：保持しない
false 時は、省略可($retain=含む)※Bulk Insert 指定時は、RETAIN が指定されても無視します。
Bulk Insert フラグ
Bulk Insert（１度に複数リクエストを送信すること。
）を実行するか O
否かを指定します。拡張子が json、または省略の場合に限り有効です。
・none：Bulk Insert しません・single_resource_path：単一リソースに対して Bulk Insert を実行しますnone 時は省略可($bulk=含む)
Body データ文字コーBody データの文字コードを指定します。拡張子が csv、txt の場合に O
ド限り有効です。
・utf-8：UTF-8・shift_jis ：Shift-JIS
utf-8 時は省略可($charset=含む)
Body データ削除指定
Body データの先頭から削除する行数を指定します。拡張子が csv の O
行
場合に限り有効です。省略することができ($skip=含む)、この場合は
行削除を行いません。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
19

数値変換

Body データ中の数値を文字列に変換するか否かを指定します。拡張 O
子が csv の場合に限り有効です。
・true：数値変換します。
・false ：数値変換しません。
true 時は省略可($numconv=含む)(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。以降の「登録日時」はすべて同一仕様です。
秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービス
がレスポンスに格納する場合、UTC を用います。
1. URI パラメータのクエリに対し、上記一覧に記載がなく、かつ本章の他の要求（参照、検索、更新、削除）にて許容しているものを指定した場合には、エラーとならず無視します。許容されていないものは、解析失敗としてエラー応答します。

 HTTP ヘッダ
Headers
Content-Typex-iotpf-request-id

値・拡張子が json または省略の場合
application/json; charset=UTF-8
・拡張子が csv の場合
text/csv; charset=<charset><charset>は以下のいずれか。
・UTF-8
・Shift_JIS
・拡張子が txt の場合
text/plain; charset=<charset><charset>は以下のいずれか
・UTF-8
・Shift_JIS
・拡張子が bin の場合
Body の MIME タイプ
・圧縮タイプが gz の場合(拡張子は任意)
application/gzip またはapplication/x-gzip
リクエスト識別 ID(任意文字列)(*2)

補足
固定

M/O(*1)
O

本サービス内および通信先の影響でリクエストが欠損した場合に出力するエラー情報に利用されます。エラ
ー情報は 11.3 節を参照ください。

O(*1) M：必須、O：オプション(*2) 値に「-」のみが設定された場合は、ヘッダ設定無しと扱います。
Body (拡張子が json または省略の場合)
1. 共通事項➢ メンバーの順序性は保証せず、登録時の並びで参照できるとは限りません。
➢ 重複した name を持つメンバは保存しません。
➢ JSON 配列の最大要素数は 1000 個です。
2. <Bulk Insert フラグ>なし または none の場合➢ JSON 形式の登録対象のデータとして、配列([ ])での開始は許容しません。
3. <Bulk Insert フラグ> が single_resource_path の場合
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
20➢

各リソースデータを以下の JSON オブジェクトとし、JSON 配列形式で複数格納できます。
Parameters
形式
説明
最大長
M/O(*1)_date
日時(*2) 登録日時
24 文字
O
・設定されていなければ、クエリス
トリングの<登録日時>を設定します。クエリストリングの<登録日時>も設定されていなければ受信日時を設定します。
_data
文字列
登録対象のリソースデータ本体
全体の最大サイズに従M(JSON 形式)
う(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。以降の「登録日時」はすべて同一仕様です。
秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービス
がレスポンスに格納する場合、UTC を用います。

登録データ例：[{“_date”:“ 20160717T131520Z”,“_data”: {“name1”:“value1”}},{“_date”:“20160717T131521Z”,“_data”:{“name1”:“value1”}}]➢Bulk Insert フラグありの API は Bulk Insert フラグなしの API 料金と比較して高額となります。詳細はご契約時のサービスメニューをご参照ください。
➢ Bulk Insert にて登録したデータに対してイベント処理は行いません。
➢ Bulk Insert にて登録したデータは MQTT Subscriber に通知されません。
Body (拡張子が csv の場合)
1. CSV 形式を JSON 形式に変換して格納します。変換後のデータ形式を以下に示します。
name : “csv”
value : 2 重配列形式。
2. CSV フォーマットは RFC4180 に準ずる形式にしてください。
➢ CSV の区切り文字「,(コンマ)」の直前/直後にある「”(ダブルクォーテーション)」は削除されます。
➢ CSV 中の改行コードは“CR LF”、“LF”に対応しています。
3. CSV 中の各データは以下のように解釈します。
➢ 数字(小数点を含む)または指数表記であり、かつ$numconv=false の場合数値と解釈します。指数表記時、仮数部と指数部の間の記号は“e”または“E”です。
➢ true、または false の場合
bool 値と解釈します。
➢ 上記以外の場合
文字列と解釈します。$charset=shit_jis が指定された場合は文字コードが Shift-JIS
であるとし、UTF-8 に変換します。
※ 実際の Body 中の文字コードによらず、Shift-JIS 文字として UTF-8 へ変換します。
4. Body 先頭に UTF-8 を示すバイトオーダーマーク(BOM)が付与されていた場合、削除されます。
5. 転送リソースによる転送、イベント発生時の付与データ、および MQTT Subscriber への通知
は、JSON 形式に変換されたデータが通知されます。
6. 以下に変換例を示します。
Body データ(CSV 形式)
node-a, true, 10.1
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
21





node-b, false, 20.0
格納データ(JSON 形式){"csv": [["node-a",
true,
10.1
],
[
"node-b",false,
20]]}
Body (拡張子が txt の場合)
1. テキスト形式を JSON 形式に変換して格納します。変換後のデータ形式を以下に示します。
name : “txt”
value : 文字列
2. $charset=shit_jis が指定された場合は文字コードが Shift_JIS であるとし、UTF-8 に変換します。
※実際の Body 中の文字コードによらず、Shift-JIS 文字として UTF-8 へ変換します。
3. Body 先頭に UTF-8 を示すバイトオーダーマーク(BOM)が付与されていた場合、削除されます。
4. 転送リソースによる転送、イベント発生時の付与データ、および MQTT Subscriber への通知
は、JSON 形式に変換されたデータが通知されます。
5. 以下に変換例を示します。
Body データ(テキスト形式)#include <stdio.h>
int main(int argc, char **argv){
printf(“Hello, World!!\n”);}
格納データ(JSON 形式){"txt": "#include <stdio.h>\r\n\r\nint main(int argc, char*argv)\r\n{\r\n\tprintf(\"Hello, World!!\\n\";\r\n}\r\n"}Body (拡張子が bin の場合)
1. バイナリ形式を JSON 形式に変換して格納します。変換後のデータ形式を以下に示します。
name : “bin”
value : Base64 形式の文字列
2. 転送リソースによる転送、イベント発生時の付与データ、および MQTT Subscriber への通知
は、JSON 形式に変換されたデータが通知されます。
3. 以下に変換例を示します。
Body データ(バイナリ形式)
1234567890
格納データ(JSON 形式){"bin": "MTIzNDU2Nzg5MA=="}All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202222Body の圧縮送信
1. 圧縮タイプに gz を指定した場合は、Body データを gzip にて圧縮し送信することができます。
データ伸長し、拡張子に応じて JSON 形式に変換した後に格納します。
2. 処理可能な最大データ長は、伸長後のデータ長で判断します。
3. 転送リソースによる転送、イベント発生時の付与データ、および MQTT Subscriber への通知
は、伸長および JSON 形式に変換されたデータが通知されます。

2. Response 正常応答時
Parameters
Status-Code
HeadersBody

値
200 OK2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

リソース_JSON のデータ参照

RequestParameters
値
MethodGET
URI
最新データの参照 <Base URL>/v1/<Tenant ID>/<リソースパス>/_present.<拡張子>?<QUERY>
過去データの参照 <Base URL>/v1/<Tenant ID>/<リソースパス>/_past(<登録日時>).<拡張子(*1)>?<QUERY>
Headers
2.3.1 節 参照
Bodyなし(*1) <登録日時>のデータが複数存在した場合、全てのデータを返却します。
 URI パラメータ
パラメータ名説明
M/O(*1)
Base URL
2.3.1 節 参照
M
Tenant ID
リソース所有テナントの識別子
M
リソースパス
データ参照対象のリソースパス
M
登録日時
参照対象データの登録日時(*2)。
M
拡張子
以下を指定。省略時は「.」を含め省略します。
O
・json
QUERY
参照条件（後述）。省略時(?含む)は、条件なし(全て)として扱います。 O(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.」、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えてください。本サービスがレスポンスに格納する場合、UTC を用います。
1. URI パラメータのクエリに対し、上記一覧に記載がなく、かつ本章の他の要求（登録、検索、更新、削除）にて許容しているものを指定した場合には、エラーとならず無視します。許容されていないものは、解析失敗としてエラー応答します。
 QUERY 一覧
書式
説明$select=<選択 <選択 key>で指定されたフィールドのデータのみを返します。
key>
・<選択 key>は、JSON での name、XML での要素名、属性名に相当し、登録デ
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202223

ータ内の任意の key を指定できます。フィールドの階層は「.」で表現します。
・<選択 key>は「,」区切りで複数指定できます。
・本サービスの管理データである、_date/_resource_path/_data は<選択key>に使用できません。
例）$select=sensor.id,sensor.name,sensor.data.temp
3. Response 正常応答時
Parameters
Status-Code
Headers
Content-Type
Body

値
200 OK<拡張子>に従った MIME タイプ。
・json の場合： application/json; charset=UTF-8
一致したリソースデータBody
以下の形式で、複数の登録済みデータを返却します。
Name
Value
_resource_path 対象データのリソースパス_date
対象データの登録日時(*1)_data
JSON 形式の登録済みのデータ(*1) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.」、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えてください。本サービスがレスポンスに格納する場合、UTC を用います。


エラー応答時
1. 参照対象のリソースが存在しなかった場合、404 Not Found を返します。
2. 条件に一致したリソースデータが存在しなかった場合、204 No Content を返します。
3. 条件に一致したリソースデータ数が 2 以上でデータサイズの合計が 16MB を超える場合、または、一致したリソースデータ数が 1000 を超える場合、400 Bad Request を返します。
4. その他エラーについては、2.3.2 節参照

リソース_JSON のデータ検索
RequestParameters
値
MethodGET
URI
データ本 <Base URL>/v1/<Tenant ID>/<リソースパス(/$all 利用可)>/_past.<拡張子体の取得 >?<QUERY>(*1)
HIT 数の<Base URL>/v1/<Tenant ID>/<リソースパス(/$all 利用取得可)>/_past/_count?<QUERY>Headers
2.3.1 節 参照
Bodyなし(*1) 検索結果として得られるデータの順番は、<リソースパス>および<登録日時>でソートします。
 URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照

M/O(*1)M
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202224

Tenant ID
リソースパス(/$all
利用可)
拡張子

リソース所有テナントの識別子
検索対象のリソースパス。記述方法は後述します。

M
M

以下を指定。省略時は「.」を含め省略します。
O
・json
QUERY
検索条件（後述）。省略時(?含む)は、条件なし(全て)として扱いま Oす。
(*1) M：必須、O：オプション
1. URI パラメータのクエリに対し、上記一覧に記載がなく、かつ本章の他の要求（登録、参照、更新、削除）にて許容しているものを指定した場合には、エラーとならず無視します。許容されていないものは、解析失敗としてエラー応答します。

<リソースパス(/$all 利用可)>の記述方法
1. 1)リソースパスをフルパスで指定：➢ 指定したリソースパスのリソースデータを返却します。
2. 2)リソースパスの途中までを指定し、その後ろに「/$all」を付加：➢ 指定したパス配下全てのリソースパスのリソースデータを返却します。
➢ 例➢ 「AX」「A/B」「A/B/C」の３つのリソースが存在する状態で、「A/$all」を指定した
場合、「A/B」および「A/B/C」の２つのリソースを対象とします。

Memo
対象テナント内全てのリソース_JSON を対象とした検索は以下で指定できますが、検索母数が多い場
合タイムアウトするため非推奨です。
<テナント ID>/$all/_past$all にて複数のリソースパスを対象にする場合、リクエストの Authorization ヘッダに格納するアクセスコードは、以下のいずれかを使用する必要があります。
1. 対象リソースパス全てに read 権を持つアクセスコードを使用する。
➢ １つでも read 権のないリソースパスを含む場合、エラー応答( 401 Unauthorized )します。
2. 対象リソースパスの上位パスに hierarchy_get 権を持つアクセスコードを使用する。
➢ hierarchy_get 権を利用する際の$all 指定は、リソースパスの途中までを指定し、その後ろに「$all」を付加してください。
➢ 「$all」のみが指定された場合、hieraachy_get 権は利用されず、read 権のみが利用されます。1 つでも read 権のないリソースパスを含む場合、エラー応答( 401
Unauthorized )します。

 QUERY 一覧
書式$filter=<filter 条件>$top=n$skip=n$select=<選択 key>説明<filter 条件>に一致するもののみを返すよう、結果を限定します。
<filter 条件>は、「プロパティ名 演算子 条件値」とし、and or で複数定義可能です。使用可能な演算子、プロパティ名は後述します。
検索結果として得られるデータを n 件に限定します。最大取得件数は 1000件です。
検索結果として得られたデータを n 件 skip します。検索結果として得られるデータの順番は、第一ソート key：<リソースパス>、第二ソート key：<登録日時>でソートします。
<選択 key>で指定されたフィールドのデータのみを返します。
・<選択 key>は、JSON での name に相当し、登録データ内の任意の name を指定可能です。フィールドの階層は「.」で表現します。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202225

・<選択 key>は「,」区切りで複数指定できます。
・_date/_resource_path/_data は<選択 key>に使用できません。
例）$select=sensor.no,sensor.name,sensor.data.temp$orderby=<ソート key>
検索結果の並べ替え方式を指定します。
<ソート順>
・<ソート key>は、並べ替え基準となる情報を指定します。以下のいずれかが指定可能です。
_resource_path_date
・<ソート順>は、並べ替え順を指定します。以下のいずれかが指定可能です。
asc : 昇順で並べ替えを行います。
desc : 降順で並べ替えを行います。
・<ソート key>と<ソート順>との間は、半角スペースを置きます。
・<ソート key> <ソート順>のペアは、「,」区切りで複数指定できます。
・指定されなかった<ソート key>における並べ替え順は不定です。
・$orderby が指定されなかった場合は、以下が指定されたものとして動作します。
$orderby=_resource_path asc,_date desc
1. /_count が指定された場合、$top、$skip、$select、$orderby は無視します。（$filter のみ併用可能）
 filter 条件の演算子
演算子 説明例eq
等号/temperature?$filter=Owner eq ‘Tom’ne
不等号/temperature?$filter=Owner ne nullgt
より大きい
/temperature?$filter=Floor1.Value gt 1000
ge
以上
/temperature?&$filter=Floor1.Value ge 1000ltより小さい
/temperature?$filter=Floor1.Value lt 1000
le以下
/temperature?$filter=Floor1.Value le 1000
and
論理積
/temperature?$filter=Floor1.Value ge 1000 and Owner eq ‘Tom’or
論理和/temperature?$filter=Id eq 2 or Id eq 1
1. null は、値が存在しないことを示します。
2. データの name が階層構造になっている場合は、<name>.<name>で表現します。
3. (A eq 1 and B eq 1)or(A eq 2 and B eq 2)のような表現も可能です。
➢ ただしこの場合、()内に()は定義できません。例えば、((A eq 1 and B eq 1)or(A eq 2
and B eq 2))and(C eq 1)はエラーとなります。
4. 正規表現によるマッチングには対応していません。
5. 文字列はシングルクォートで囲みます。シングルクォートで囲まないものは数値とみなします。
6. JSON 配列の内容を指定する場合は、<name>.<配列 index>で表現します。配列 index は数字です。
例：
検索対象データ{“Owners”:[“Taro”,“Jiro”]}
filter 条件指定例$filter=Owners.0 eq ‘Taro’➢

配列内にオブジェクト構造があり、かつ name が数字のみで構成されている場合、配列
index 指定と name の識別ができない場合があります。下記例を参考に配列 index と nameの双方を指定してください。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202226

検索対象データ例：① {“data”:[{“0”:“Taro”},{“0”:“Jiro”}]}② {“data”:[{“0”:“Jiro”},{“0”:“Taro”}]}③ {“data”:{“0”:“Taro”}}
検索例：
filter 指定条件適合するデータ$filter=data.0 eq ‘Taro’①、②、③$filter=data.1.0 eq ‘Taro’② filter 条件に利用可能なプロパティ名
プロパティ名 説明
備考
_date
登録日時
検索対象データの登録日時(*1)※_date で条件指定する登録日時についてはシングルクォー
トを使って囲みません。
任意の name
登録データに含まれる URI の非予約文字（「半角英数字」、
「-」、
「.」、
「_」
、
「~」以外)
任意の nameはパーセントエンコードしてください。
(*1) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えてください。本サービスがレスポンスに格納する場合、UTC を用います。
4. Response[データ本体(リソースデータ)の取得]
 正常応答時
Parameters
Status-Code
Headers
Content-Type
Body

値
200 OK
application/json; charset=UTF-8
一致したリソースデータ

1. Body➢ 以下の形式で、複数の登録済みデータを返却します。形式は<拡張子>に従います。
Name
Value
_resource_path 対象データのリソースパス_date
対象データの登録日時(*1)_data<拡張子>に従った形式の、登録済みのデータ。
(*1) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z な
ど）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区
切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えてください。本サービスがレスポンスに格納する場合、UTC を用います。
➢



対象リソースに検索条件に合致するデータが存在しない場合、そのリソースに関するデータは返却しません。

エラー応答時
1. 対象のリソースが存在しなかった場合、404 Not Found を返します。
2. 条件に一致するリソースデータが存在しなかった場合、204 No Content を返します。
3. 条件に一致したリソースデータ数が 2 以上でデータサイズの合計が 16MB を超える場合、または、一致したリソースデータ数が 1000 を超える場合、400 Bad Request を返します。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202227

➢

この時、エラーレスポンスに受付可能な top 数として、acceptable_top=n を Body に格納します。
4. その他エラーについては、2.3.2 節を参照ください。
[HIT 数の取得]
 正常応答時
Parameters
Status-Code
Headers
Content-Type
Body

値
200 OK
text/plain
一致したリソースデータ数

1. Body➢ 一致したリソースデータ数をそのまま返却します。


エラー応答時については、2.3.2 節を参照ください。

リソース_JSON のデータ更新
RequestParameters
MethodURI
過去データの更新(*1)値
PUT<Base URL>/v1/<Tenant ID>/<リソースパス>/_past(<登録日時(旧)>).<拡張子>.<圧縮タイプ>?$newdate=<登録日時(新)> &$charset=<Body データ文字コード>&$skip=<Body データ削除指定行>&$numconv=<数値変換>
Headers
2.3.1 節 参照
Body
更新対象データ(*1) 同じ登録日時を持つデータが複数存在した場合、ひとつのみ更新(どのデータになるかは不定)されます。
 URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
リソースパス
データ更新対象のリソースパス
拡張子

圧縮タイプ

登録日時(旧)
登録日時(新)Body データ文字コード

M/O(*1)
M
M
M

以下のいずれかを指定します。省略時は「.」を含め省略し、この場 O合は json が指定されたものとみなします。
・json
・csv
・txt
・bin
Body データを圧縮して送信する際の圧縮タイプを以下で指定しまOす。省略時は「.」を含め省略し、この場合は Body データが無圧縮とみなします。
・gz
更新対象データの登録日時(*2)
M
更新後の登録日時(*2)
O
省略可($newdate=含む)で、省略時は登録日時を更新しません。
・既に指定登録日時のデータが存在するかどうかはチェックせず、
上書きを行います。
Body データの文字コードを指定します。拡張子が csv、txt の場合 Oに限り有効です。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
28

・utf-8：UTF-8・shift_jis ：Shift-JIS
utf-8 時は省略可($charset=含む)
Body データ削除指定 Body データの先頭から削除する行数を指定します。拡張子が csv の O
行
場合に限り有効です。省略することができ($skip=含む)、この場合は行削除を行いません。
数値変換
Body データ中の数値を文字列に変換するか否かを指定します。拡張 O
子が csv の場合に限り有効です。
・true：数値変換します。
・false ：数値変換しません。
true 時は省略可($numconv=含む)(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えてください。本サービスがレスポンスに格納する場合、UTC を用います。
⚫ URI パラメータのクエリに対し、上記一覧に記載がなく、かつ本章の他の要求（登録、参照、検索、削除）にて許容しているものを指定した場合には、エラーとならず無視します。許容されていないものは、解析失敗としてエラー応答します。
 HTTP ヘッダ
Headers
Content-Typex-iotpf-request-id

値・拡張子が json または省略の場合
application/json; charset=UTF-8
・拡張子が csv の場合
text/csv; charset=<charset><charset>は以下のいずれか。
・UTF-8
・Shift_JIS
・拡張子が txt の場合
text/plain; charset=<charset><charset>は以下のいずれか
・UTF-8
・Shift_JIS
・拡張子が bin の場合
Body の MIME タイプ
・圧縮タイプが gz の場合(拡張子は任意)
application/gzip またはapplication/x-gzip
リクエスト識別 ID(任意文字列)(*2)

説明
固定

M/O(*1)
O

本サービス内およびO
通信先の影響でリク
エストが欠損した場合に出力するエラー
情報に利用されます。
エラー情報は 11.3 節
を参照ください。

(*1) M：必須、O：オプション(*2) 値に「-」のみが設定された場合は、ヘッダ設定無しと扱います。

Body
拡張子に従った形式の、登録対象のデータです。詳細は 3.1 節を参照ください。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
29

➢



JSON の場合、配列([ ])での開始は許容しません。

Response
正常応答時

Parameters
Status-Code
HeadersBody

値
200 OK2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

リソース_JSON のデータ削除
RequestParameters
値
MethodDELETE
URL
過去データの削除 <Base URL>/v1/<Tenant ID>/<リソースパス>/_past?<QUERY>Headers
2.3.1 節、および下記参照
Body
なし

URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
リソースパス
データ削除対象のリソースパス
QUERY
削除条件（後述）。
(*1) M：必須、O：オプション


M/O(*1)
M
M
M
M

HTTP ヘッダ

Headersx-iotpf-request-id

値
リクエスト識別 ID(任意文字列)(*2)

説明
本サービス内の影
響でリクエストが欠損した場合に出力するエラー情報に利用されます。
エラー情報は 11.3
節を参照ください。

M/O(*1)
O(*1) M：必須、O：オプション(*2) 値に「-」のみが設定された場合は、ヘッダ設定無しと扱います。

QUERY 一覧
書式
$filter=<filter 条件>

説明<filter 条件>に一致するもののみを削除するよう、結果を限定します。
<filter 条件>は、「プロパティ名 演算子 条件値」とし、and or で複数定義可能です。使用可能な演算子、プロパティ名は後述します。
1. URI パラメータのクエリに対し、上記一覧に記載がなく、かつ本章の他の要求（登録、参照、検索、更新）にて許容しているものを指定した場合には、エラーとならず無視します。許容されていないものは、解析失敗としてエラー応答します。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
30





filter 条件の演算子
3.3 節を参照ください。

filter 条件に利用可能なプロパティ名
3.3 節を参照ください。

Response
正常応答時

Parameters
Status-Code
HeadersBody

値
200 OK2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
31

第4章 リソース_JSON／リソース(転送)_JSON へのデータ制御(MQTT)
リソース_JSON 及びリソース(転送)_JSON の制御が行える MQTT のインターフェースの一覧を以下に示します。

表 7：データ蓄積／参照インターフェース一覧
プロト
コル
MQTT

種別

用途

章

リソース
へのデー
タ登録

リソースに対して新たにデータを追加登録（転送）します。
[オプション]・なし： 本サービスでの受信日時でデータを登録
・日時指定： 指定された日時でデータを登録
リソースに登録されるデータを参照します。

4.1 章

リソース
データの
参照

4.2 章

リソース_JSON へのデータ登録／リソース（転送）_JSON へのデータ転送
RequestParameters値
メッセージタイプ
PUBLISH
Topic データ蓄積<アクセスコード>/v1/<Tenent ID>/<リソースパス>
データ転送<アクセスコード>/v1/<Tenent ID>/_fwd/<リソースパス>
他固定ヘッダおよび可変ヘッダ
2.5.1 節 参照
ペイロード
本サービスヘッダ用および、登録対象データ
ペイロード内先頭の「---IoT-PF<CRLF>」以降を本サービス用ヘッダとします。
Header 名と値は「＜Header 名＞： <値><CRLF>」形式で記述します。
本サービス用ヘッダの終了「<CRLF><CRLF>」にて判定するものとし、[<CRLF>]は、Header のものを含みます。
本サービス用ヘッダは省略することができます。

本サービス用ヘッダ
Headers値
M/O(*1)
Date<登録日時>
O
x-iotpf-request-id<リクエスト識別 ID(任意文字列)>(*2)O(*1) M：必須、O：オプション(*2) 本サービス内の影響でリクエストが欠損した場合に出力するエラー情報に利用されます。エラー情報
は 11.3 節を参照ください。
パラメータ
パラメータ名説明
M/O(*1)
アクセスコード
アクセス権限を表す文字列。管理者から入手します。
M
Tenant ID
リソース所有テナントの識別子
M
リソースパス
データ登録対象のリソースパス
M
登録日時
登録対象データに付与する登録日時(*2)。
O
省略可で、省略時は本サービスでのリクエスト受信日時を採用しまAll Rights Reserved,Copyright©FUJITSU LIMITED 2016-202232

す。
・既に指定登録日時のデータが存在するかどうかはチェックせず、上書きを行います。
リクエスト識別 ID 本サービス内および通信先の影響でリクエストが欠損した場合に出力 O
するエラー情報に利用されます。エラー情報は 11.3 節を参照ください。
値に「-」のみが設定された場合は、設定無しと扱います。
(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。




登録対象のデータ
1. JSON 形式の任意のデータ➢ 配列([ ])での開始は許容しません。
➢ メンバーの順序性は保証せず、登録時の並びで参照できるとは限りません。
➢ 重複した name を持つメンバは保存しません。

Response
QoS レベルに応じたメッセージ(なし/PUBACK メッセージ/PUBREC メッセージ)

リソース_JSON／リソース（転送）_JSON のデータ参照
MQTT でのリソースデータの参照では、SUBSCRIBE メッセージを使用します。
対象の Topic（リソースパス）を SUBSCRIBE しておくことで、以下のメッセージを MQTT PUBLISH にて受信することが可能です。
プロトコル
操作
SUBSCRIBE による受信
Retain オプション
REST
リソースデータの登録○(*1)○
リソースデータの参照
×―
リソースデータの更新
×―
リソースデータの削除
×―
MQTT
リソースデータの登録○○
リソースデータの参照
×―(*1) Bulk Insert にて登録されたデータは、MQTT PUBLISH にて受信することはできません。
RequestParameters
メッセージタイプ
固定ヘッダおよび
可変ヘッダ
ペイロード


パラメータ
パラメータ名アクセスコード
Tenant ID
リソースパス

値
SUBSCRIBE
2.5.1 節 参照
Topic 名「<アクセスコード>/v1/<Tenant ID>/<リソースパス>」
または「<アクセスコード>/v1/<Tenant ID>/_fwd/<リソースパス>のリスト

説明
アクセス権限を表す文字列。管理者から入手します。
リソース所有テナントの識別子
データ登録対象のリソースパス

M/O(*1)
M
M
M

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202233

(*1) M：必須、O：オプション
Response

SUBACK メッセージ

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
34

第5章 リソース_Binary データ制御(REST)
リソース_Binary に対するデータ蓄積／リソースのデータ参照インターフェース一覧を以下に示します。
表 8：データ蓄積／参照インターフェース一覧
プロト
コル
REST

種別

用途

章

リソース
へのデー
タ登録

リソースに対して新たにデータを追加登録します。
[オプション]・なし： 本サービスでの受信日時でデータを登録
・日時指定： 指定された日時でデータを登録
リソースに登録済みのデータの実体を参照します。
[オプション]・なし： 最新データを返します
・日時指定： 指定日時のデータを返します
リソースに登録済みのデータを、条件を指定して検索します。検索結果
として、HIT した登録済みデータの情報を返します。
（検索できるのはメタデータのみです。登録したデータの実体は検索できません。
）[オプション]・QUERY にて、検索条件を指定できます
リソースに登録済みのデータを削除します[オプション]・QUERY にて、削除条件を指定できます

5.1 章

リソース
データの
参照
リソース
データの
検索

リソース
データの
削除


5.2 章

5.3 章

5.5 章

REST／MQTT の連携動作ついて「リソース_Binary」
においては REST で登録したリソースデータを MQTT の SUBSCRIBE により参照することはできません。

リソース_Binary へのデータ登録
RequestParameters
Method
URI
データ蓄積
Headers
Body

値
PUT<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>?$date=<登録日時>
2.3.1 節 及び、下記を参照ください。
登録対象データMemo
IoT Platform のデータ登録では、「存在するリソースにデータを格納する」という考え方から、Methodに PUT を使用する仕様です。リソースへの POST Method は「リソースの作成(7.1 リソースの登録)」にて使われます。

URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
リソースパス
データ登録対象のリソースパス
登録日時
登録対象データに付与する登録日時(*2)。

M/O(*1)
M
M
M
O

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202235

省略できます($date=含む)。省略時は本サービスにおけるリク
エスト受信日時を採用します。

すでに指定登録日時のデータが存在する場合、上書き登録を行います。
(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。
HTTP ヘッダ
Headers
Content-Type

値
Body の MIME タイプ

x-iotpf-meta-data1
x-iotpf-meta-data2
x-iotpf-meta-data3

任意のメタデータ

x-iotpf-request-id

リクエスト識別 ID(任意文字列)(*2)

補足
各リソースデータのメタデータとして管理し、レスポンスに付与します
各リソースデータのメタデータとして管理し、レスポンスに付与しますM/O(*1)
O

本サービス内の影響でリク
エストが欠損した場合に出力するエラー情報に利用されます。エラー情報は 11.3
節を参照ください。

OO(*1) M：必須、O：オプション(*2) 値に「-」のみが設定された場合は、ヘッダ設定無しと扱います。




Body
1. 登録対象のデータ。
➢ 最大サイズ： 100MB➢ REST にて登録した Binary データは、MQTT では参照できません。

Response
正常応答時

Parameters
Status-Code
Headers
Body


値
200
2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

リソース_Binary のデータ参照

RequestParameters
MethodURI
最新データの参照
過去データの参照
Headers値
GET<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>/_present<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>/_past(<登録日時>)
2.3.1 節 参照
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
36

Body

なし


URI パラメータ
パラメータ名説明
M/O(*1)
Base URL
2.3.1 節参照
M
Tenant ID
リソース所有テナントの識別子
M
リソースパス
データ参照対象のリソースパス
M
登録日時
参照対象データの登録日時(*2)。
M(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。
Response
正常応答時

Parameters
Status-Code
Headers

field nameContent-Typex-iotpf-meta-data1
x-iotpf-meta-data2
x-iotpf-meta-data3
Body(*1) M：必須、O：オプション


値
説明
200
成功(全体取得)
206
成功(部分取得)
Value
Body の MIME タイプ。
リソースデータ登録時に指定した値を設定します。
リソースデータ登録時に指定しなかった場合、「application/octet-stream」を設定します。
メタデータ。
リソースデータ登録時に設定した場合に付与します。

M/O(*1)
M

O

データ本体

エラー応答時
1. 参照対象のリソースが存在しなかった場合、404 を返します。
2. 条件に一致したリソースデータが存在しなかった場合、204 を返します。
3. その他エラーについては、2.3.2 節を参照ください。

リソース_Binary のデータ検索
RequestParameters
MethodURI
データリストの取得(*1)
HIT 数の取得

値
GET<Base URL>/v1/<Tenant ID>/_bin/<リソースパス($all 利用可)>/_past?<QUERY><Base URL>/v1/<Tenant ID>/_bin/<リソースパス($all 利用可)>/_past/_count?<QUERY>Headers
2.3.1 参照
Body
なし(*1) 検索結果として得られるデータの順番は、<登録日時>でソートします。


URI パラメータ
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202237

パラメータ名
Base URL
Tenant ID
リソースパス
QUERY

説明
2.3.1 節 参照
リソース所有テナントの識別子
検索対象のリソースパス。記述方法は後述します。
検索条件（後述）。省略時(?含む)は、条件なし(全て)として扱います。
(*1) M：必須、O：オプション

M/O(*1)M
M
M
O<リソースパス(/$all 利用可)>の記述方法
1. 1)リソースパスをフルパスで指定：➢ 指定したリソースパスのリソースデータ情報を返却します。
2. 2)リソースパスの途中までを指定し、その後ろに「/$all」を付加：➢ 指定したパス配下全てのリソースパスのリソースデータ情報を返却します。
➢ 例➢ 「AX」「A/B」「A/B/C」の３つのリソースが存在する状態で、「A/$all」を指定した場
合、「A/B」および「A/B/C」の２つのリソースを対象とします。
➢ 対象テナント内の全ての Binary リソースを対象にする場合、次の通り設定します。
➢ <テナント ID>/_bin/$all/_past$all にて複数のリソースパスを対象にする場合、リクエストの Authorization ヘッダに格納する
アクセスコードは、以下のいずれかを使用する必要があります。
1. 対象リソースパス全てに read 権を持つアクセスコードを使用する。
➢ １つでも read 権のないリソースパスを含む場合、エラー応答( 401 )します。
2. 対象リソースパスの上位パスに hierarchy_get 権を持つアクセスコードを使用する。
➢ hierarchy_get 権を利用する際の$all 指定は、リソースパスの途中までを指定し、その後ろに「$all」を付加してください。
➢ 「$all」のみが指定された場合、hieraachy_get 権は利用されず、read 権のみが利用されます。1 つでも read 権のないリソースパスを含む場合、エラー応答( 401 )します。


QUERY 一覧
書式
説明
$filter=<filter <filter 条件>に一致するもののみを返すよう、結果を限定します。
条件><filter 条件>は、「プロパティ名 演算子 条件値」とし、and で複数定義可能。
使用可能な演算子、プロパティ名は後述します。
$top=n
検索結果として得られるデータを n 件に限定します。
最大取得件数は 1000 件です。
検索結果として得られたデータを n 件 skip します。検索結果として得られるデー$skip=nタの順番は、第一ソート key：<リソースパス>、第二ソート key：<登録日時>でソートします。
1. /_count が指定された場合、$top、$skip は無視する（$filter のみ併用可能）
filter 条件の演算子
演算子
説明
例
eq
等号
/image?$filter=_date eq 20160101T000000.001Z
gt
より大きい/image?$filter=_date gt 20160101T000000.001Z
ge
以上/image?$filter=_date ge 20160101T000000.001Z
lt
より小さい/image?$filter=_date lt 20160101T000000.001Zle以下/image?$filter=_date le 20160101T000000.001Z
and論理積/image?$filter=_date ge 20160101T000000.001Z and _date le20160529T101010.001Z
1. and は上記例ののように、一度のみ使用できます。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202238


filter 条件に利用可能なプロパティ名
プロパティ名
説明
備考
_date
登録日時
検索対象データの登録日時(*1)※_date で条件指定する登録日時についてはシングルクォートで囲みません(*1) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。
Response[データリストの取得]

正常応答時

Parameters
Status-Code
Headers
Content-Type
Body

値
200
application/json; charset=UTF-8
一致したリソースデータのメタデータ情報

1. Body➢ 以下の形式で、複数の登録済みデータの情報を JSON 形式で返却します。
Name
name
content_type

Value
リソースデータの名前。URI のパスで表現。
_bin/<リソースパス>/_past(<登録日時>)
リソースデータの MIME タイプ。
リソースデータ登録時に指定した Content-Type を設定。リソースデータ登録時に未指定の場合は、「application/octet-stream」を設定します

M/O(*1)
M
M(*1) M：必須、O：オプション➢



対象リソースに検索条件に合致するデータが存在しない場合、そのリソースに関するデータは返却しません

エラー応答時
1. 対象のリソースが存在しなかった場合、404 を返します。
2. 条件に一致するリソースデータが存在しなかった場合、204 を返します
3. 条件に一致したリソースデータ数が 1000 を超える場合、400 を返します。
➢ この時、エラーレスポンスに受付可能な top 数として、acceptable_top=n を Body に格納します
4. その他エラーについては、2.3.2 節参照[HIT 数の取得]

正常応答時
Parameters
Status-Code
Headers
Content-Type
Body

値
200
text/plain; charset=UTF-8
一致したリソースデータ数
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
39

1. Body➢ 一致したリソースデータ数をそのまま返却します。


エラー応答時については、2.3.2 節を参照ください。

リソース_Binary のデータ更新
リソース_Binary を更新するためのインターフェースはありません。
ただし、5.1 節にあるリソース_Binary のデータ登録を用い、既に登録をした同時刻を指定して登録することにより、上書き更新が可能です。

リソース_Binary のデータ削除
RequestParameters
MethodURI 過去データの削除

値
DELETE<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>/_past?<QUERY>HeadersBody

2.3.1 節 参照
なし


URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
リソースパス
データ削除対象のリソースパス
QUERY
削除条件（後述）。
(*1) M：必須、O：オプション

HTTP ヘッダ
Headersx-iotpf-request-id

値
リクエスト識別 ID(任意文字列)(*2)

M/O(*1)
M
M
M
M

補足
本サービス内の影響でリク
エストが欠損した場合に出力するエラー情報に利用されます。エラー情報は 11.3
節を参照ください。

M/O(*1)
O(*1) M：必須、O：オプション(*2) 値に「-」のみが設定された場合は、ヘッダ設定無しと扱います。

QUERY 一覧
書式
$filter=<filter 条件>

説明<filter 条件>に一致するもののみを削除するよう、結果を限定します。
<filter 条件>は、「プロパティ名 演算子 条件値」とし、and で複数定義できます。使用可能な演算子、プロパティ名は後述します。

filter 条件の演算子
3.3 節 参照

filter 条件に利用可能なプロパティ名
3.3 節 参照
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202240Response
正常応答時
Parameters
Status-Code
Headers
Body


値
200
2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
41

第6章 リソース_Binary データ制御(MQTT)
リソース_Binary へのデータ蓄積／リソースのデータ参照インターフェース一覧を以下に示します。
表 9：データ蓄積／参照インターフェース一覧
プロト
コル
MQTT

種別

用途

章

リソースへのデータ登録
リソースデータの参照

リソースに対して新たにデータを追加登録します。
リソースに登録されるデータを参照します。

6.1 章
6.2 章

リソース_Binary へのデータ登録
RequestParameters
メッセージタイプ
Topic
他固定ヘッダおよび可変ヘッダ
ペイロード

値
PUBLISH<アクセスコード>/v1/<Tenent ID>/_bin/<リソースパス>
2.5.1 節 参照
登録対象データ
パラメータ
パラメータ名説明
アクセスコード
アクセス権限を表す文字列。管理者から入手します。
Tenant ID
リソース所有テナントの識別子
リソースパス
データ登録対象のリソースパス(*1) M：必須、O：オプション


M/O(*1)
M
M
M

登録対象のデータ
1. 最大サイズ： 16MB

Response
QoS レベルに応じたメッセージ(なし/PUBACK メッセージ/PUBREC メッセージ)

リソース_Binary のデータ参照
MQTT でのリソースデータの参照では、SUBSCRIBE メッセージを使用します。
対象の Topic（リソースパス）を SUBSCRIBE しておくことで、以下のメッセージを MQTT PUBLISH にて受信することが可能です。
※REST IF にて登録した Binary データは、MQTT では参照できません。
プロトコル
操作
SUBSCRIBE
Retain
による受信
オプション
REST
リソースデータの登録
×―
リソースデータの参照
×―
リソースデータの更新
×―
リソースデータの削除
×―
MQTT
リソースデータの登録○○
リソースデータの参照
×―
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202242


RequestParameters
メッセージタイプ
固定ヘッダおよび
可変ヘッダ
ペイロード

値
SUBSCRIBE
2.5.1 節 参照
Topic 名「<アクセスコード>/v1/<Tenent ID>/_bin/<リソースパス>」のリスト


パラメータ
パラメータ名説明
アクセスコード
アクセス権限を表す文字列。管理者から入手する。
Tenant ID
リソース所有テナントの識別子
リソースパス
データ登録対象のリソースパス(*1) M：必須、O：オプション


M/O(*1)
M
M
M

Response

SUBACK メッセージ

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202243

第7章 リソース制御(REST)
リソース制御が行えるインターフェースの一覧を以下に示します。
リソース制御 API を利用するにはリソース及びアクセスコードをサービスポータルにて事前に設定する必要があります。2.2 節を参照願います。
表 10：リソース制御インターフェース一覧
種別
リソースの登録

リソースのメタデータ参照

リソースのメタデータ更新
リソースの削除

用途
リソースを新規に登録する。
[オプション]・Body なし： リソースのみ作成
・Body にメタデータ格納：
リソース登録時にメタデータの初期設定を行う
リソースのメタデータを参照する。
[オプション]・リソースパスの一部を$all で指定：
指定パス配下のリソースのメタデータを返す
リソースのメタデータを更新する。
[オプション]なし
リソースを削除する。
[オプション]
なし

章
7.1 章

7.2 章

7.3 章

7.4 章

リソースの登録
RequestParameters
Method
URI
JSON

蓄積

値
POST
<Base URL>/v1/<Tenant ID>/<リソースパス>

転送<Base URL>/v1/<Tenant ID>/_fwd/<リソースパス>

BinaryHeaders
Body<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>
2.3.1 節 および下記参照
メタデータ


URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
リソースパス
登録対象のリソースパス(*1) M：必須、O：オプション


M/O(*1)
M
M
M

HTTP ヘッダ

Headers
Content-Type値
application/json; charset=UTF-8

補足
固定

M/O(*1)OAll Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
44

(*1) M：必須、O：オプションBody
次の通り、JSON 形式でメタデータを格納することでメタデータの初期化ができます。

Parameters
resource
retention_period

説明
最大長
開始タグ
―
リソースデータの保存期間(日)9999
・設定されていない場合、保存期間は1 日とします。
・値の範囲は 1～9999
fwd_info
―
O(*3)
転送先情報
―
http
―
M
HTTP の転送先情報―
methodstringM“GET”,“POST”,“PUT”,“DELETE”, 7 文字
“HEAD”,“OPTIONS”,“TRACE”のいずれかuristring
M
URI。
256 文字“http://～”または“https://～”
basic_auth_id
stringO
Basic 認証用の ID
20 文字
basic_auth_pass string
O
Basic 認証用のパスワード
20 文字
header_fields―
O
HTTP ヘッダ―(配列)(配列の要素は最大 10 個)
field_namestringM
ヘッダフィールド名。
“：”は含みませ 20 文字ん。
field_value
stringM
上記ヘッダフィールドに格納する値
512 文字(*1) M：必須、O：オプション。各子要素の M/O は、親要素を設定した場合の要否を表します。
(*2) リソース_JSON、リソース_Binary の場合に限り有効です。
(*3) 対象リソースが JSON 形式の転送リソースの場合のみ設定できます。


形式
―
数値

M/O(*1)M
O(*2)

Response
正常応答時

Parameters
Status-Code
Headers
Location値
201<Base URL>/v1/<Tenant ID>/<リソースパス>
or<Base URL>/v1/<Tenant ID>/_fwd/<リソースパス>
or<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>
なし

Body


エラー応答時については 2.3.2 節を参照ください。

リソースのメタデータ参照

RequestParameters
MethodURI
データリスト
の取得

JSON

蓄積

値
GET
<Base URL>/v1/<Tenant ID>/<リソースパス(/$all)>/_resources?<QUERY>
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
45

転送
バイナリ
HIT 数の取得

JSON

蓄積
転送

バイナリ
Headers
Body<Base URL>/v1/<Tenant ID>/_fwd/<リソースパス(/$all)>/_resources?<QUERY><Base URL>/v1/<Tenant ID>/_bin/<リソースパス(/$all)>/_resources?<QUERY><Base URL>/v1/<Tenant ID>/< リ ソ ー ス パ ス (/$all)>/_resources/_count?<QUERY><Base URL>/v1/<Tenant ID>/_fwd/<リソースパス(/$all)>/_resources/_count?<QUERY><Base URL>/v1/<Tenant ID>/_bin/<リソースパス(/$all)>/_resources/_count?<QUERY>
2.3.1 節 参照
なし


URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
QUERY
参照条件（後述）。省略時(?含む)は、条件なし(全て)として扱う。
(*1) M：必須、O：オプション


M/O(*1)
M
M
O<リソースパス(/$all)>の記述方法
1. リソースパスをフルパスで指定：➢ 指定したリソースパスのメタデータを返却します。
2. リソースパスの途中までを指定し、その後ろに「/$all」を付加：➢ 指定したパス配下全てのリソースパスのメタデータを返却します。
➢ 例
➢ 「A」
「AX」
「A/B」
「A/B/C」の 4 つのリソースが存在する状態で、「A/$all」を指定した場合、「A/B」および「A/B/C」の２つのリソースを対象とします。
➢ 各リソース種別の全てのリソースパスを対象にする場合、次の通り設定します。
➢ リソース_JSON：<テナント ID>/$all/_resources➢ リソース(転送)_JSON：<テナント ID>/_fwd/$all/_resources➢ リソース_Binary：<テナント ID>/_bin/$all/_resources※異なるリソース種別のリソースパスを一度に参照することはできません。


QUERY 一覧
書式
説明
$top=n
検索結果として得られるデータを n 個に限定します(最大値は 1,000)$skip=n
検索結果として得られたデータを n 件 skip します。検索結果として得られるデータの順番は、リソースパスにてソートします。
1. /_count が指定された場合、$top、$skip は無視する


Response[データリストの取得]

正常応答時

Parameters
Status-Code
Headers
Content-Type
Body

値
200
application/json; charset=UTF-8
対象リソースのメタデータ(複数)All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
46

1. Body➢ 次の通り、各リソースのメタデータを JSON オブジェクトとし、JSON 配列形式で複数格納します。
➢ 各リソースの情報は、リソースパスでソートします（昇順）Parameters
形式
M/O(*1) 説明最大長resources
―
M
開始タグ
―
resource_path
stringM
リソースパス
128 文字retention_period
数値O
リソースデータの保存期間9999
・設定されていない場合、保存期間は 1日とします。
・値は 1~9999 とします。
last_modified
日時M
最新データの<登録日時>(*2)(*3)
20 文字
fwd_info
―
O(*4)
転送先情報
―
http
―
M
HTTP の転送先情報―
methodstringM“GET”,“POST”,“PUT”,“DELETE”, 6 文字
“HEAD”,“OPTIONS”,“TRACE”のいずれか。
uri
string
M
URI。
256 文字“http://～”または“https://～”
basic_auth_id
stringO
Basic 認証用の ID
20 文字
basic_auth_pass string
O
Basic 認証用のパスワード
20 文字
header_fields―
O
HTTP ヘッダ―(配列)(配列の要素は最大 10 個まで設定できます)field_namestringM
ヘッダフィールド名。
“：”は含まない。 20 文字
field_value
stringM
上記ヘッダフィールドに格納する値
512 文字(*1) M：必須、O：オプション。各子要素の M/O は、親要素を設定した場合の有無を表します。
(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン
指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。
(*3) リソースデータ登録／更新にて<登録日時>を指定できるため、サーバの最終更新日時と最新データの<登録日時>は一致しないケースがあります。
(*4) 対象リソースが JSON 形式の転送リソースの場合のみ設定します。
➢

パラメータに設定値がない場合、そのパラメータはレスポンスに格納されません。
➢ リソース内にデータが存在しない場合、last_modified パラメータも格納されません。
➢ リクエストの Authorization ヘッダに指定されるアクセスコードが、対象となるリソー
スへの list 権持っていない場合、参照することはできません。
エラー応答時1. 条件に一致するリソースが１つも存在しなかった場合、404 を返します。
2. 条件に一致したリソース数が 1000 を超える場合、400 を返します。このときのエラーレスポ
ンスの Body 部に、受付可能な top 数として acceptable_top=<n>を格納します。
3. その他エラーについては、2.3.2 節を参照ください。

[HIT 数の取得]

正常応答時
Parameters
Status-Code
Headers
Content-Type値
200text/plain
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
47

Body



一致したリソース数
1. Body➢ 一致したリソース数をそのまま返却します。
➢ リクエストの Authorization ヘッダに格納したアクセスコードが list 権限を持たないリソースは、カウント対象としません。
エラー応答時については、2.3.2 節を参照ください。

リソースのメタデータ更新
RequestParameters
値
Method
PUT
URI
JSON
蓄積
<Base URL>/v1/<Tenant ID>/<リソースパス>/_resources
転送
バイナリ
Headers
Body<Base URL>/v1/<Tenant ID>/_fwd/<リソースパス>/_resources<Base URL>/v1/<Tenant ID>/_bin/<リソースパス>/_resources
2.3.1 節 および下記参照
メタデータ


URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
リソース所有テナントの識別子
リソースパス
メタデータ更新対象のリソースパス(*1) M：必須、O：オプション

HTTP ヘッダ
Headers
値
Content-Typeapplication/json; charset=UTF-8(*1) M：必須、O：オプション


M/O(*1)
M
M
M

補足
固定

M/O(*1)O

Body
1. 7.1 節を参照ください。
2. 対象リソースのメタデータを、更新データで全て上書きします。
➢ 更新前に設定パラメータとして A,B が登録されており、更新で A だけを指定した場合、Bは削除指示と判断して B を削除します。

Response
正常応答時

Parameters
Status-Code
Headers
Body


値
200
2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

リソースの削除
RequestParameters
Method値
DELETEAll Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
48

URI

JSON

蓄積

転送
バイナリ
Headers
Body<Base URL>/v1/<Tenant ID>/<リソースパス><Base URL>/v1/<Tenant ID>/_fwd/<リソースパス><Base URL>/v1/<Tenant ID>/_bin/<リソースパス>
2.3.1 節 参照
なし


URI パラメータ
パラメータ名説明
Base URL
2.3.1 節参照
Tenant ID
リソース所有テナントの識別子
リソースパス
削除対象のリソースパス(*1) M：必須、O：オプション


M/O(*1)
M
M
M

Response
正常応答時

Parameters
Status-Code
Headers
Body


値
204
2.3.2 節 参照
なし

エラー応答時1. 削除対象リソースにアクセスコードが紐付いていた場合削除できません。この場合、423 を返却します。
2. その他エラーについては 2.3.2 節を参照ください。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
49

第8章 アクセスコード制御(REST)
アクセスコード制御のインターフェースを以下に示します。プロトコルは全て REST(HTTP)とします。
表 11：アクセスコード制御インターフェース一覧
種別
アクセスコードの登録

アクセスコード情報の参照

アクセスコード情報の更新

アクセスコードの削除

用途
アクセスコードを新規登録します。
[オプション]なし
アクセスコードの情報を参照(検索)します。
[検索オプション]・アクセスコード指定
・リソースパス指定（前方一致検索可）
アクセスコードの情報を更新します。
[オプション]なし
アクセスコードを削除します。
[オプション]
なし

章
8.1 章

8.2 章

8.3 章

8.4 章

アクセスコードの登録
RequestParameters
MethodURIHeaders
Body

値
POST
<Base URL>/v1/<Tenant ID>/_access_codes/<Access Code>2.3.1 節、及び下記を参照ください。
アクセスコード情報
URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
対象テナントの識別子
Access Code
アクセスコード(*1) M：必須、O：オプション

HTTP ヘッダ
Headers
値
Content-Typeapplication/json; charset=UTF-8(*1) M：必須、O：オプション

M/O(*1)
M
M
M

補足
固定

M/O(*1)M

Body： アクセスコード情報
次の通り、JSON 形式でアクセスコード情報を登録します。
Parameters
形式
M/O(*1) 説明
access_code―
M
開始タグ
permissions―M
権限情報
ip_filter
string O
サービスポータルで定義したアクセス

最大長
―
―
35 文字

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
50

(配列)

resource_operations
resource_path
operations―(配列)
stringM

制限(アクセスコード)設定の IP アド
レス範囲情報を指定してください。未
定義の IP アドレス範囲情報を設定した場合、エラーレスポンス(400)を返却します。
・[“開始 IP アドレス”,“終了 IP アドレス”]の形式で２つの IP アドレスを指定できます。
・1 つの IP アドレスを設定する場合、開始 IP アドレスと終了 IP アドレスを同じアドレスにしてください。
・「開始 IP アドレス＞終了 IP アドレス
(IP アドレスを 32bit とみなして比較
した場合)」となる設定はできません。
リソースに紐づく権限情報M

リソースパス

string(配列)

M

128 文字“hierarchy_get”、“hierarchy_put”、 72 文字“create”、“read”、“update”、“delete”、“list”のいずれか。配列で複数指定できます。
certification_info―O
クライアント証明書情報
certification
string M
クライアント証明書
10000 文字・PEM 形式「-----BEGIN CERTIFICATE-----」,「-----END CERTIFICATE-----」を含めてください。また、改行コードは「\n」
として登録してください。
certificate_usage
string M
クライアント証明書の利用用途。
4 文字
以下を指定してください。
・auth：クライアント認可で使用する。
protocols
string O
プロトコル指定情報
29 文字
(配列)
“http”、“https”、“mqtt”、“mqtts”のいずれか。配列で複数指定できます。
(*1) M：必須、O：オプション。各子要素の M/O は、親要素を設定した場合の要否を表します。
1. 権限割り当てのないアクセスコード情報の登録はエラーとします。
➢ すなわち、resource_operations に 1 つ以上の resource_path、operations を設定する必要があります。最大 1000 組設定できます。
➢ 設定可能な権限設定パターンを以下の表に示します。
権限パターン create read,
update,deletelist
hierarchy_get(*1)
hierarchy_put(*1)
1
○
○
○
○
○
2
○
○
○
○
3
○
○
○
○
4
○
○
○
5
○
○
○
6
○
○
7
○
○
8
○
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
51

9
○
○
10
○
11
○
(*1) どちらか、または両方の権限を設定できます。
2. create/delete/list/hierarchy_get/hierarchy_put は、指定したリソースパス配下全てのリ
ソースパスへの権限として扱います。
3. create/delete/list/hierarchy_get/hierarchy_put 権を、階層の異なるパスに設定した場合、より上位パスの権限に従って動作します。
➢ 例：
リソースパス「A/B」に create,delete,list,hierarchy_get.hierarchy_put 権、リソースパス「A/B/C」に list 権のみを設定した場合、リソースパス「A/B/C/D」には、create,delete,list,hierarychy_get,hierarchy_put が可能
4. certification_info を設定する場合には、certification、certificate_usage の両方の設定が必ず必要です。ない場合にはエラー応答(400)を返します。
5. protocols の設定について、以下に説明します。
パターン
動作“protocols”のメンバなし
全てのプロトコルが指定されたものと解釈します。
“protocols”のメンバは存在する フォーマットエラーとしてエラー応答(400)しまが、値がない。
す。
・”protocols”:[ ]・”protocols”:[“”]



Response
正常応答時

Parameters
Status-Code
Headers
Location
Body


値
201
<Base URL>/v1/<Tenant ID>/_access_codes/<Access Code>なし

エラー応答時については、2.3.2 節を参照ください。

アクセスコードの参照

RequestParameters
値
MethodGET
URI データリ <Base URL>/v1/<Tenant ID>/_access_codes/<Access Code>?<QUERY>
ストの取得
HIT 数の <Base URL>/v1/<Tenant ID>/_access_codes/<Access Code>/_count?<QUERY>
取得
Headers
2.3.1 節 参照
Body
なし

URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照

M/O(*1)M
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
52

Tenant ID
対象テナントの識別子
M
QUERY
検索条件（後述）。省略時(?含む)は、条件なし(全て)として扱います。 O(*1) M：必須、O：オプションQUERY 一覧
書式
$filter=<filter 条件>

説明<filter 条件>に一致するもののみを返すよう、結果を限定します。
<filter 条件>は、「プロパティ名 演算子 条件値」とし、and で複数定義可
能。使用可能な演算子、プロパティ名は後述します。
$top=n
検索結果として得られるデータを n 件に限定します。最大は 1000 件まで指定できます。
$skip=n
検索結果として得られたデータを n 件 skip します。検索結果として得られるデータの順番は、アクセスコードでソートします。
1. /_count が指定された場合、$top、$skip は無視します。
（$filter のみ併用可能）
filter 条件の演算子
演算子
説明
例
eq
等号
$filter=_resource_path eq ‘hoge’filter 条件に利用可能なプロパティ名
プロパティ名説明
備考_resource_path
リソースパス 「/」も含めてパーセントエンコードは不要です
filter 条件のサポート関数
Function
説明 例
bool startswith(string
前方 $filter=startswith(_resource_path, ’hoge’) eq true
p0, string p1)
一致
1. false 指定は未対応です。
2. $filter 条件直下で_resource_path eq hoge と指定されたときは完全指定となり、
startswith()を利用して指定された際は前方一致指定となります。


Response[データリストの取得]

正常応答時

Parameters
Status-Code
Headers
Content-Type
Body

値
200
application/json; charset=UTF-8
一致したアクセスコード情報

1. Body➢ 次の通り、各アクセスコードの情報を JSON オブジェクトとし、JSON 配列形式で複数格納します。
➢ 各アクセスコード情報は、アクセスコード(access_code)でソートします。
（昇順）
Parameters
形式
説明
最大長
access_codes
―
開始タグ
―
(配列)
access_code
string
アクセスコード
48 文字
permissions―
権限情報―
ip_filter
string
アクセス制限定義を行う許可 IP アドレスの範
35 文字
(配列)
囲情報。[“開始 IP アドレス”,“終了 IP アド
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
53

resource_operations
resource_path
operations―(配列)
stringレス”]の形式で２つの IP アドレスを指定します。
リソースに紐づく権限情報
リソースパス

128 文字“hierarchy_get”、“hierarchy_put”、
72 文字“create”、“read”、“update”、“delete”、“list”のいずれか。配列で複数指定できます。
certification_info―
クライアント証明書情報
certification
string
クライアント証明書
10000 文字・PEM 形式「-----BEGIN CERTIFICATE-----」, 「-----END
CERTIFICATE-----」を含みます。また、改行コ
ードは「\n」として表示されます。
certificate_usage
string
クライアント証明書の利用用途。
4 文字
以下を指定してください。
・auth：クライアント認可で使用する。
protocols
stringプロトコル指定情報
29 文字
(配列)
“http”、“https”、“mqtt”、“mqtts”のいず
れか。配列で複数指定できます。
➢ パラメータに設定値がない場合、レスポンスにはパラメータそのものを格納しません。
➢ リクエストの Authorization ヘッダに格納したアクセスコードの権限を超える権限を持つアクセスコードは、レスポンスに格納しません。
➢ アクセスコード登録時に“protocols”の指定が無かった場合には、“protocols”は通知されません。
string(配列)

エラー応答時1. 条件に一致するアクセスコード情報が存在しなかった場合、404 を返します。
2. Authorization ヘッダのアクセスコードが登録されていない場合、401 を返します。
3. 条件に一致したアクセスコード情報数が 1000 を超える場合、400 を返します。
➢ この時、エラーレスポンスに受付可能な top 数として、acceptable_top=n を Body に格納します。
4. その他エラーについては、2.3.2 節を参照ください。

[HIT 数の取得]

正常応答時
Parameters
Status-Code
Headers
Content-Type
Body

値
200
text/plain
一致したアクセスコード数

1. Body➢ 一致したアクセスコード数をそのまま返却➢ リクエストの Authorization ヘッダに格納したアクセスコードの権限を超える権限を持つアクセスコードは、カウント対象としません
エラー応答時については、2.3.2 節を参照ください。
アクセスコードの更新
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
54


RequestParameters
MethodURIHeaders
Body

値
PUT<Base URL>/v1/<Tenant ID>/_access_codes/<Access Code>2.3.1 節 および下記参照
アクセスコード情報
URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
対象テナントの識別子
Access Code
アクセスコード(*1) M：必須、O：オプション

HTTP ヘッダ
Headers
値
Content-Typeapplication/json; charset=UTF-8(*1) M：必須、O：オプション


M/O(*1)
M
M
M

補足
固定

M/O(*1)M

Body： アクセスコード情報
1. 8.1 節を参照ください。
2. 対象のアクセスコード情報を、更新データで全て上書きします。
➢ 更新前に設定パラメータとして A,B が登録されており、更新で A だけを指定した場合、Bは削除指示と判断して B を削除します。

Response
正常応答時

Parameters
Status-Code
Headers
Body


値
200
2.3.2 節 参照
なし

エラー応答時については、2.3.2 節を参照ください。

アクセスコードの削除RequestParameters
MethodURIHeaders
Body

値
DELETE<Base URL>/v1/<Tenant ID>/_access_codes/<Access Code>2.3.1 節 参照
なし


URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
対象テナントの識別子

M/O(*1)
M
M

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
55

Access Code
アクセスコード(*1) M：必須、O：オプション
M

Response
正常応答時

Parameters
Status-Code
Headers
Body


値
204
2.3.2 節 参照
なし

エラー応答時1. 削除対象のアクセスコードがイベントに紐付いていた場合、アクセスコード削除不可とし、ステータスコード 423 と、紐付いてるイベント ID を返します。
2. その他エラーについては 2.3.2 節を参照ください。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
56

第9章 イベント制御(REST)
イベント制御のインターフェースを以下に示します。プロトコルは全て REST(HTTP)とします。
表 12：イベント制御インターフェース一覧
種別
イベントの登録

イベント情報の参照

イベント情報の更新

イベントの削除

用途
イベントを新規登録します。
[オプション]なし
イベントの情報を参照(検索)します。
[検索オプション]・イベント ID 指定
・リソースパス指定（前方一致検索可）
イベントの情報を更新します。
[オプション]なし
イベントを削除します。
[オプション]
なし

章
9.1 章

9.2 章

9.3 章

9.4 章

イベントの登録
RequestParameters
MethodURIHeaders
Body

値
POST
<Base URL>/v1/<Tenant ID>/_events
2.3.1 節、および下記を参照ください
イベント情報
URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
対象テナントの識別子(*1) M：必須、O：オプション

HTTP ヘッダ
Headers
値
Content-Typeapplication/json; charset=UTF-8(*1) M：必須、O：オプション

M/O(*1)M
M

補足
固定

M/O(*1)M

Body： イベント情報
次の通り、JSON 形式でイベント情報を登録する。
Parameters
形式
M/O(*1) 説明
event
―
M
開始タグ
conditions―
M
イベント条件targets―M
対象
resource_path
string M
対象のリソースパス

最大長
―
―
―
128 文字All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
57

operations

string(配列)

Mread_access_code

stringM

notification_condition
start_time

O
O(*2)

O(*4)

終了日時または、時刻(*3)

20 文字

body_conditions

―
日時ま
たは時
刻
日時ま
たは時
刻
―

バイナリデータへの操作の場合は対象リソースパ
スを“_bin/”から設定してください。
対象のリソースデータ操
33 文字
作（アクセスコードのアクセス権とは異なります。
）
・通常のリソースの場合、[“create”,“update”]
を指定してください。
・リソース_Binary の場合、
“create”
を指定してください。
対象リソースパスの read48 文字
権または hierarchy_get 権を持つアクセスコード
通知条件―
開始日時または、時刻(*3) 20 文字O―

path_typestringM

pathstringM

comparing_operator

stringM

value

stringまたは
数値M

データボディ条件
Binary リソースに対しては設定不可
path の形式“JSONPath”のみ指定できます
ボディ要素を指定するた
めのパス
比較演算子
“eq”(＝),“ne”(≠),“gt”(>),“ge”(≧),“lt”(<),“le”(≦),“substring_of”(部分一致)のいずれか。(*5)
比較対象の値。

end_time

8 文字

1902 文字12 文字

文字列の場合、
1～128 文字整数の場合、-2,147,483,648～2,147,483,647

awake_condition―

O

イベント抑止解除条件。
Binary リソースに対しては設定できません。
※本設定を行うと、実数の場合、
整数部分 10 桁、小数部分 5 桁―

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
58

body_conditions
path_type―stringMM

pathstringM

comparing_operator

stringM

value

stringまたは
数値

M

notification_condition
を満たしイベント通知実施後、イベント抑止状態になります。イベント抑止状
態を解除するための条件をここで設定してください。
データボディ条件
path の形式。
”JSONPath”のみ指定できます。
ボディ要素を指定するためのパス比較演算子。
“eq”(＝),“ne”(≠),“gt”(>),“ge”(≧),“lt”(<),“le”(≦),“substring_of”(部分一致)のいずれか。(*5)
比較対象の値。

―
8 文字

1902 文字12 文字

文字列の場合、
1～128 文字整数の場合、-2,147,483,648～2,147,483,647

notification
httpmethod―(*6)―
stringM
OM

uristringMbasic_auth_id
basic_auth_pass
header_fields

OOO

field_namestringstring―(配列)
stringfield_value

stringM

string

O

body

M

通知内容
HTTP 通知設定“GET”,“POST”,“PUT”,“DELETE”,“HEAD”,“OPTIONS”,“TRACE”の
いずれか。
URI。
“http://～”または“https://～”
Basic 認証用の ID
Basic 認証用のパスワード
HTTP ヘッダ(配列の要素は最大 10 個)
ヘッダフィールド名。
“：”
は含みません。
上記ヘッダフィールドに格納する値
ボディに格納する値
省略時はイベントのトリガとなったリソースデー
タ本体・イベント ID・イベ
ント発生日時・対象リソー
スパス

実数の場合、
整数部分 10 桁、小数部分 5 桁――
7 文字

256 文字

20 文字
20 文字
―
20 文字
512 文字1024 文字All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
59

smtp
―
O
SMTP 通知設定―
send_tostring M
通知先 E メールアドレス
256 文字subjectstring O
件名
256 文字body
string M
本文
140 文字(*1) M：必須、O：オプション。各子要素の M/O は、親要素を設定した場合の要否を表します。
(*2) start_time と end_time の片方のみを設定することはできません。また、両設定値は日時または、時刻のどちらかに揃える必要があります。
(*3) 日時指定の場合は、ISO8601 に従ってください（20141225T103612Z など）。また、精度は秒まで指定可能です。時刻指定の場合は ISO8601 から年月日の情報を削ったものとなります（T103612Z など）。精度
は同様に秒までです。タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えてください。
(*4) start_time と end_time の片方のみを指定することはできません。また、両設定値は日時または、時刻のどちらかに揃える必要があります。
(*5) value が数値の場合は、eq, ne, gt, ge, lt, le が指定できます。value が文字列の場合は eq, ne,substring_of が指定できます。文字列の比較においては大文字小文字の区別を行います。
(*6) notification 配下には、http か smtp いずれかの設定が必要です。


Response
正常応答時

Parameters
値
Status-Code201
Headers
Location<Base URL>/v1/<Tenant ID>/_events/<Event ID>
Bodyなし
1. Location には作成したイベントの URI を格納します。


エラー応答時については 2.3.2 節を参照ください。

イベント情報の参照
RequestParameters
MethodURI
Event ID 指定による参照

値
GET<Base URL>/v1/<Tenant ID>/_events/<Event ID>

QUERY による検索
Headers
Body<Base URL>/v1/<Tenant ID>/_events?<QUERY><Base URL>/v1/<Tenant ID>/_events/_count?<QUERY>
2.3.1 節 参照
なし

データリストの取得
HIT 数の取得


URI パラメータ
パラメータ名説明
M/O(*1)
Base URL
2.3.1 節 参照
M
Tenant ID
対象テナントの識別子
M
Event ID
イベントの IDO・省略時（「/events」）は対象テナントの全てのイベントを対象とします。
(「/events/」の書き方は許容しません。)
QUERY
検索条件（後述）。省略時(?含む)は、条件なし(全て)として扱う。
O(*1) M：必須、O：オプションQUERY 一覧
書式
$filter=<filter 条件>

説明<filter 条件>に一致するもののみを返すよう、結果を限定します。<filter
条件>は、「プロパティ名 演算子 条件値」とし、and で複数個を定義する
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
60

ことができます。使用可能な演算子、プロパティ名は後述します。
$top=n
検索結果として得られるデータを n 件に限定します。最大取得件数は 1000件です。
$skip=n
検索結果として得られたデータを n 件 skip します。検索結果として得られるデータの順番は EventID でソートされます。
1. /_count が指定された場合$top、$skip は無視されます（$filter のみ併用できます）

filter 条件の演算子
演算子
説明
例
eq
等号
$filter=_resource_path eq ‘hoge’filter 条件に利用可能なプロパティ名
プロパティ名説明
備考_resource_path
リソースパス「/」も含めてパーセントエンコード不要
filter 条件のサポート関数
Function
説明例bool startswith(string p0, 前方一致
$filter=startswith(_resource_path, ’hoge’) eq true
string p1)
1. false 指定は未対応です。
2. $filter 条件直下で_resource_path eq hoge と指定されたときは完全指定となり、
startswith()を利用して指定された際は前方一致指定となります。


Response[Event ID 指定での参照 または データリストの取得]

正常応答時

Parameters
Status-Code
Headers
Content-Type
Body

値
200
application/json; charset=UTF-8
一致したイベント情報

1. Body➢ 次の通り、各イベントの情報を JSON オブジェクトとし、JSON 配列形式で複数格納します。
（太字：イベント登録時との差分）➢ 各イベント情報はイベント ID(event_id)で昇順にてソートされます。
Parameters
形式
M/O(*1) 説明
最大長events―M
開始タグ―
event_idstring M
イベント ID
12 文字
conditions―
M
イベント条件―targets―M
対象―
resource_path
string M
対象のリソースパス
128 文字operations
string M
対象のリソースデータ操作 33 文字(配列)
・JSON リソースの場合、「[“create”,“update”]」 を指定してください。
・Binary リソースの場合、「“create”」を指定してください。
read_access_code
string M
対象リソースパスの read 権 48 文字
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
61

―
日時ま
たは時
刻
日時ま
たは時
刻
―
stringOOまたは hierarchy_get 権を持つアクセスコード
通知条件
開始日時または、時刻

O

終了日時または、時刻

20 文字

O
M

―
8 文字

path

stringM

comparing_operator

stringM

value

stringまたは
数値M

データボディ条件
path の形式。
“JSONPath”を指定してください。
ボディ要素を指定するためのパス比較演算子。
“eq”(＝),“ne”(≠),“gt”(>),“ge”(≧),“lt”(<),“le”(≦),“substring_of”(部分一致)のいずれか。
比較対象の値。

notification_condition
start_time

end_timebody_conditions
path_type―
20 文字

1902 文字12 文字

文字列の場合、
1～128 文字整数の場合、-2,147,483,648～2,147,483,647

awake_condition―O―
stringOM

pathstringM

comparing_operator

stringM

value

stringM

body_conditions
path_type

イベント抑止解除条件※本設定を行うと、
notification_condition を
満たしイベント通知実施
後、イベント抑止状態になります。イベント抑止状態を解除するための条件をここで設定します。
データボディ条件
path の形式。
“JSONPath”を指定してくだい。
ボディ要素を指定するためのパス比較演算子。
“eq”(＝),“ne”(≠),“gt”(>),“ge”(≧),“lt”(<),“le”(≦),“substring_of”(部分一致)のいずれか。
比較対象の値。

実数の場合、
整数部分 10 桁、小数部分 5 桁――
8 文字

1902 文字12 文字

文字列の場合、All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
62

または
数値

1～128 文字整数の場合、-2,147,483,648～2,147,483,647

notification
httpmethod――stringM
OM

uristringMbasic_auth_id
basic_auth_pass
header_fields

stringstring―(配列)
stringO
O
O

field_name

通知内容
HTTP 通知設定“GET”,“POST”,“PUT”,“DELETE”,“HEAD”,“OPTIONS”,“TRACE”のい
ずれか。
URI。
“http://～”または“https://～”
Basic 認証用の ID
Basic 認証用のパスワード
HTTP ヘッダ

実数の場合、
整数部分 10 桁、小数部分 5 桁――
7 文字

256 文字

20 文字
20 文字
―

ヘッダフィールド名。
“：” 20 文字は含みません。
field_value
string M
上記ヘッダフィールドに格 512 文字
納する値
body
string O
ボディに格納する値。
1024 文字
省略時はイベントのトリガとなったリソースデータ本
体・イベント ID・イベント
発生日時・対象リソースパ
ス。
smtp
―
O
SMTP 通知設定―
send_tostring M
通知先 E メールアドレス
256 文字subjectstring O
件名
256 文字body
string M
本文
140 文字(*1) M：必須、O：オプション。各子要素の M/O は、親要素を設定した場合の有無を表します。
➢
➢



M

パラメータに設定値がない場合、レスポンスにはパラメータそのものを格納しません。
リクエストの Authorization ヘッダに格納したアクセスコードが、list 権を持たないリソースに対するイベント情報は、レスポンスに格納しません。

エラー応答時1. 条件に一致するイベント情報が存在しなかった場合、404 を返します。
2. 条件に一致したイベント数が 1000 を超える場合、400 を返します。
➢ この時、エラーレスポンスに受付可能な top 数として、acceptable_top=n を Body に格納します。
3. その他エラーについては、2.3.2 節を参照ください。

[HIT 数の取得]
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
63



正常応答時

Parameters
Status-Code
Headers
Content-Type
Body

値
200
text/plain
一致したリソースデータ数

1. Body➢ 一致したイベント数をそのまま返却します。
➢ リクエストの Authorization ヘッダに格納したアクセスコードが、list 権を持たないリソースに対するイベントは、カウント対象としません。


エラー応答時については、2.3.2 節を参照ください。

イベント情報の更新
RequestParameters
値
MethodPUT
URI<Base URL>/v1/<Tenant ID>/_events/<Event ID>
Headers
2.3.1 節 および下記参照
Body
イベント情報
URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
対象テナントの識別子
Event ID
イベント ID(*1) M：必須、O：オプション

HTTP ヘッダ
Headers
値
Content-Typeapplication/json; charset=UTF-8(*1) M：必須、O：オプション


M/O(*1)
M
M
M

補足
固定

M/O(*1)M

Body： イベント情報
1. 9.1 節を参照。
2. 対象のイベント情報を、更新データで全て上書きします。
➢ 更新前に設定パラメータとして A,B が登録されており、更新で A だけを指定した場合、Bは削除指示と判断して B を削除します。

Response
正常応答時

Parameters
Status-Code
HeadersBody

値
200
2.3.2 節 参照
なし
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202264

エラー応答時については 2.3.2 節を参照ください。

イベントの削除
RequestParameters
値
MethodDELETE
URI<Base URL>/v1/<Tenant ID>/_events/<Event ID>
Headers
2.3.1 節 参照
Body
なし

URI パラメータ
パラメータ名説明
Base URL
2.3.1 節 参照
Tenant ID
対象テナントの識別子
Event ID
イベント ID(*1) M：必須、O：オプション


M/O(*1)
M
M
M

Response
正常応答時

Parameters
Status-Code
Headers
Body


値
204
2.3.2 節 参照
なし

エラー応答時については 2.3.2 節を参照ください。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
65

第10章 外部システム呼出しリファレンス
本サービスの以下の機能では、外部システムの呼出しを行います。本章では、呼出しにおける動作仕様について説明します。
API 呼出し（イベント機能）
Email 送信（イベント機能）API 呼出し（リソース(転送)_JSON 機能）
API 呼び出し（イベント機能）
イベントにおけるアクション内容として「API 呼び出し」を選択した際に呼び出される API の内容を以下に示します。
RequestParameters
MethodURIHeaders値＜イベントにおいて指定されたメソッド＞＜イベントにおいて指定された URI＞
Host: ＜イベントにおいて指定された URI に含まれるホスト名＞＜イベントにおいて指定されたヘッダ名＞:＜イベントにおいて指定されたヘッダ値＞(複数)

認証 ID、認証パスワードをいれた場合：
Authorization: Basic ＜認証 ID:認証パスワードを Base64 エンコードした値＞
Body
ボディに値を設定した場合：ボディに設定した値
ボディに値を設定しなかった場合：JSON 形式で表 13 のデータを格納(注) 基本的には HTTP/1.1 仕様に沿った要求を発行しますが、お客様の設定内容やシステムの実装により
HTTP 仕様を逸脱する場合があります。問題が発生した場合は弊社までご相談ください。
表 13：イベント通知データとして格納される JSON データ
Nameevent_iddateresource_path
operationvalue
イベント ID
イベント判定を行った日時(*1)
イベントに使われたリソースパス
リソースパスに対して行った制御内容
create は登録、update は更新を意味する
body
リソースパスに対して登録または更新された際の Body 文(*1) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。
イベント ID が「123456789abc」、イベント判定を行った日時が日本時間 2016 年 3 月 1 日 0 時 0 分 0 秒、
リソースパスには「Printer/1F/Printer」が指定されており、Body 文に「{"temperature" : 24}」を登録した
場合、イベントの送信される Body 文の例を以下に示します。
{"event_id" : "123456789abc","date" : "20160301T000000.000Z","resource_path" : "Printer/1F/Printer","operation" : "create","body " :{All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
66

"temperature" : 24}}
Response
HTTP メッセージフォーマット形式を満たしてください。ステータスラインのみを必要とします。
以下に、ステータスコードに対する処理仕様を示します。
ステータスコード
2xx
408, 503, 504, 509
応答未受信
上記以外

判断
受付成功
受付失敗

リトライ
しない
する

受付失敗

しない

Email 送信（イベント機能）
イベントにおいてアクション内容として「Email」を選択した際に送信されるメールの内容を以下に示します。
Parameters
値
To
イベントにおいて指定されたメールアドレス
Fromeventinfo@<zone>.fujitsu.com(*1)
Return-Pathiot-system-info@ml.css.fujitsu.com
Subject
イベントにおいて指定された件名
Body
Content-Type
text/plain; charset=UTF-8
本体
イベントにおいて指定された本文
添付Content-Type
text/plain; charset=UTF-8; name=eventinfo.txt
本体
JSON 形式で 表 13 のデータを格納(*1) ドメイン名の<zone>はサービス提供システムに依存します。ご契約後の通知内容に従って下さい。
API 呼出し（リソース(転送)_JSON 機能）
リソース(転送)_JSON を利用した際に呼び出される API の内容を以下に示します。

RequestParameters
MethodURIHeaders値＜リソース(転送)_JSON において指定されたメソッド＞＜リソース(転送)_JSON において指定された URI＞
Host: ＜リソース(転送)_JSON において指定された URI に含まれるホスト名＞＜リソース(転送)_JSON において指定されたヘッダ名＞:＜リソース(転送)_JSON において指定されたヘッダ値＞ (複数)

認証 ID、認証パスワードをいれた場合：
Authorization: Basic ＜認証 ID:認証パスワードを Base64 エンコードした値＞
Body
リソース(転送)_JSON に格納したデータ(注) 基本的には HTTP/1.1 仕様に沿った要求を発行しますが、お客様の設定内容やシステムの実装により
HTTP 仕様を逸脱する場合があります。問題が発生した場合は弊社までご相談ください。
Response
HTTP メッセージフォーマット形式を満たしてください。ステータスラインのみを必要とします。
以下に、ステータスコードに対する処理仕様を示します。
ステータスコード判断

リトライ
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
67

2xx408, 503, 504, 509
応答未受信
上記以外

受付成功
受付失敗

しない
する

受付失敗

しない

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
68

第11章 システム格納データリファレンス
本サービスでは、システムが自律的にリソースに格納するデータがあります。本章では、格納されるデータの形式や内容について説明します。

リコメンドリソース
ダイナミックリソースコントローラーにより、ゲートウェイ装置が参照するリコメンド値を JSON 形式で格納します。
リコメンドリソース名

サービスポータルから設定

Parameters
recommend_value
recommend_parameter

形式
stringstringM/O(*1)
M
M

説明
リコメンド値（"ON"または"OFF"）
リコメンド引数（サービスポータルにおける分散設定において設定した引数。
但し、本サービスのシステム負荷が極めて大きい場合、"ALM"が入ります）

エッジコンピューティング条件の引数が「recommend is on」である場合において、リコメンド値が「ON」に変化した際にリコメンドリソースに格納される JSON データ例を以下に示します。
{"recommend_value" : "ON”
"recommend_parameter" : "recommend is on"}

負荷リソース
ダイナミックリソースコントローラーが、API アクセスの負荷計測結果を JSON 形式で格納します。
負荷リソース名

サービスポータルから設定

Parameterstps

形式
stringM/O(*1)M

bps

stringM

説明
お客様テナントに対する負荷データ(tps)[transaction/second]
お客様テナントに対する負荷データ(bps)[bit/second](*1) M：必須、O：オプション
10tps、10,000bps の場合において、負荷リソースに格納される JSON データの例を以下に記載します。
{"tps" : "10","bps" : "10000"}

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202269エラー収集用リソース
エラーログ蓄積機能が、本サービス内および通信先の影響でリクエストが欠損した場合のエラー情報を格納します。該当時刻近辺の処理結果を確認し対応ください。
エラー収集用リソース名_errorParameterscollection_first_time
collection_last_time
errorsM/O(*1)
M
M
M

説明
エラー収集期間の開始時刻
エラー収集期間の終了時刻
エラー情報

triggerresource_path

形式
日時(*2)
日時―(配列)
stringstringM
M

data_registration_time

日時O

event_idstringOerror_factor_message
number_of_times

string数値

M
M

request_id

string の配列
stringO

失敗要因が設定されます。
エラーが発生したリソースパス。エラー収集
期間内の最も古い情報のリソースパスが設定されます。
リソースデータ登録時刻。失敗要因がイベントの場合のみ設定されます。
イベント ID。失敗要因がイベントの場合のみ設定されます。
失敗要因メッセージ。下記参照ください。
エラー収集期間内で失敗要因と失敗要因メッセージが同一であったものの回数。
エラー発生となった要求にて指定した
x-iotpf-request-id の値が設定されます。
エラー情報登録失敗の場合に下記が設定されます。
・エラー発生回数過多により reqeust_id 内
容が未記録：'request_id' was not able tobe registered because of so many numbers.

messageO(*1) M：必須、O：オプション(*2) ISO8601(基本表記としてのミリ秒表現を使用)に従います（20141225T103612.001Z など）。精度はミリ秒(ミリ秒を省略した場合、0 ミリ秒とみなします)です。秒とミリ秒の区切りは「.]、タイムゾーン指定は「±hhmm」形式で省略時は「Z」を添えます。本サービスがレスポンスに格納する場合、UTC を用います。
error_factor_message に記載される失敗要因メッセージの一覧を以下に記載します。
trigger
Transfer
Resource
Transfer
Resource
Transfer
Resource
Transfer
Resource
Event

失敗要因メッセージ
It failed in the transmission of
forwarding data. (IoT-PF internal error)
It failed in the transmission of
forwarding data. (Forwarding parameter
error)
It failed in the transmission of
forwarding data. (Connection error(HTTP))
It failed in the transmission of
forwarding data. (Connection error(TCP))
Event connection failed.

Event

Event transmission retry over. code=408

説明
転送失敗：システム内要因により失敗しました。
転送失敗：転送設定情報の不備により失敗しました。
転送失敗：通信エラー(HTTP)により失敗しま
した。
転送失敗：通信エラー(TCP)により失敗しま
した。
イベント送信失敗：イベント送信先への接続に失敗しました。
イベント送信失敗：イベント送信が、レスポ
ンスコード 408 により再送しましたが、再送

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
70

EventEvent transmission failed. code=404

Event

Event transmission retry over. code=503

Event

Event transmission failed. code=500

Event
Event

Event Send Request was rejected due to
inflow regulation.
Fail to send SMTP mail.

Event

Retry out to send SMTP mail.

MQTT
BrokerFailed to execute publishing resource
data, in the system internal processing.

MQTT
ParserFailed to execute publishing resource
data, in the system internal processing.

MQTT
ParserFailed to execute publishing resource
data, in invalid data format.

MQTT
ParserFailed to execute publishing resource
data, in message payload length error.

回数オーバーにより失敗しました。
イベント送信失敗：イベント送信が、レスポ
ンスコード 404 で失敗しました。
イベント送信失敗：イベント送信が、レスポ
ンスコード 503 により再送しましたが、再送
回数オーバーにより失敗ました。
イベント送信失敗：イベント送信が、レスポ
ンスコード 500 により失敗しました。
イベント送信失敗：要求過負荷によりイベン
ト送信に失敗しました。
イベント送信失敗：システム内要因により、イベント送信(メール送信)に失敗しました。
イベント送信失敗：メールサーバとの通信異常が発生し、イベント送信(メール送信)に失敗しました。
MQTT データ格納失敗：内部処理においてデー
タ喪失が発生し、リソースデータの格納に失敗しました。
MQTT データ格納失敗：内部処理においてデー
タ喪失が発生し、リソースデータの格納に失敗しました。
MQTT データ格納失敗：登録データ(ペイロード JSON/登録日時/リクエスト識別 ID 等)が仕様に準じていない形式のため、データの格納に失敗しました。
MQTT データ格納失敗：登録データ（ペイロード長）が不正のため、データの格納に失敗しました。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
71

付録１

Response エラー時のメッセージ一覧

ここでは、API 要求がエラーとなった場合に Body 文に通知される内容を説明します。エラーは以下の形式で通知されます。
フィールド名値

errors.message

エラー文

errors.acceptable_top

レスポンスの Body サイズが 16MB 以内となる top 数（エラーコードが"number of response-data is larger than 1000"または,"response size is larger than 16MB"の場合のみ）

Body 文の例を以下に記載します。
{ “errors”: [{ “message”: “response size is larger than 16MB”,“acceptable_top”: 100}]}
errors.message に記載されるエラーの Body 文内容の一覧を以下に記載します。
HTTP レスポン
ス

エラーの Body 文内容

503 Service
Unavailable

予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf エラーメッセージをヘルプデスク
is temporally unavailable.[11007]"}]} までご連絡願います。

503 Service
Unavailable
503 Service
Unavailable
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
503 Service
Unavailable

対処方針

予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11009]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf エラーメッセージをヘルプデスク
is temporally unavailable.[11010]"}]} までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11011]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11013]"}]}
へまでお願い致します。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11016]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11017]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11022]"}]}
までご連絡願います。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
72

503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error

予期せぬ内部異常を検出しました。
エラーメッセージをヘルプデスクまでご連絡願います。
システム高負荷の場合に発生する{"errors":[{"message":"[SEARCH] iot-pf ことがあります。検索範囲を絞ってis temporally unavailable.[11028]"}]} 再実施することを推奨します。
{"errors":[{"message":"[CREATE] No
Connection.[11027]"}]}

システム高負荷の場合に発生する{"errors":[{"message":"[SEARCH] iot-pf
ことがあります。検索範囲を絞ってis temporally unavailable.[11030]"}]}
再実施することを推奨します。
システム高負荷の場合に発生する{"errors":[{"message":"[SEARCH] iot-pf 可能性があります。検索範囲を絞っ
is temporally unavailable.[11031]"}]} て再実施することを推奨します。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[SEARCH] iot-pf
エラーメッセージをヘルプデスク
internal error.[11032]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[SEARCH] iot-pf
エラーメッセージをヘルプデスク
internal error.[11034]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[SEARCH] iot-pf
エラーメッセージをヘルプデスク
internal error.[11036]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[SEARCH] iot-pf
エラーメッセージをヘルプデスク
internal error.[11037]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[SEARCH] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11039]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[SEARCH] No
エラーメッセージをヘルプデスク
Connection.[11040]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf エラーメッセージをヘルプデスク
is temporally unavailable.[11041]"}]} までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11043]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf エラーメッセージをヘルプデスク
is temporally unavailable.[11044]"}]} までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11045]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11047]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11049]"}]}
までご連絡願います。
{"errors":[{"message":"[UPDATE] iot-pf 予期せぬ内部異常を検出しました。
internal error.[11050]"}]}
エラーメッセージをヘルプデスク
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202273

までご連絡願います。
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
500 Internal
Server Error
503 Service
Unavailable
503 Service
Unavailable
503 Service
Unavailable
400 Bad Request

400 Bad Request
503 Service
Unavailable
400 Bad Request
400 Bad Request
400 Bad Request

予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11051]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[UPDATE] No
エラーメッセージをヘルプデスク
Connection.[11052]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11053]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11055]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11056]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11057]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11059]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11061]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
internal error.[11062]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[11063]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[REMOVE] No
エラーメッセージをヘルプデスク
Connection.[11064]"}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[12003]"}]}
までご連絡願います。
Body 文に記載がありません。Body{"errors":[{"message":"[CREATE] main
文が正しく記載されているか確認
data is required."}]}
してください。
Body 文が大きすぎます。データ{"errors":[{"message":"[CREATE] mainを分割するなど Body 文を小さくしdata is too large."}]}てください。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"[CREATE] iot-pf
エラーメッセージをヘルプデスク
is temporally unavailable.[12006]"}]}
までご連絡願います。
{"errors":[{"message":"[CREATE] url
URL の指定が誤っています。URL
format error."}]}を見なおしてください。
{"errors":[{"message":"[CREATE] query URL に"?"が複数存在します。クエ
num invalid."}]}
リを見なおしてください。
{"errors":[{"message":"[CREATE] query クエリが長すぎます。クエリを見な
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202274

too large."}]}{"errors":[{"message":"[CREATE] url
400 Bad Request
unescape error."}]}
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
503 Service
Unavailable
400 Bad Request

400 Bad Request
503 Service
Unavailable
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request

おしてください。
URL の指定が誤っています。URL を見なおしてください。
アクセスコードが誤っています。
{"errors":[{"message":"[CREATE] access
正しいアクセスコードが記載されcode is wrong."}]}ているか確認してください。
{"errors":[{"message":"[CREATE]
x-iotpf-request-id の内容が不正
x-iotpf-request-id format error."}]}です。
{"errors":[{"message":"[SEARCH] url
URL の指定が誤っています。URL を
format error."}]}
見なおしてください。
{"errors":[{"message":"[SEARCH] query URL に"?"が複数存在します。クエ
num invalid."}]}
リを見なおしてください。
{"errors":[{"message":"[SEARCH] query クエリが長すぎます。クエリを見な
too large."}]}
おしてください。
{"errors":[{"message":"[SEARCH] url
URL の指定が誤っています。URL を
unescape error."}]}
見なおしてください。
アクセスコードが誤っています。
{"errors":[{"message":"[SEARCH] access
正しいアクセスコードが記載されcode is wrong."}]}ているか確認してください。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"iot-pf is
エラーメッセージをヘルプデスク
temporally unavailable.[12026]"}]}
までご連絡願います。
Body 文に記載がありません。Body{"errors":[{"message":"[UPDATE] main
文が正しく記載されているか確認
data is required."}]}
してください。
Body 文が大きすぎます。データを{"errors":[{"message":"[UPDATE] main
分割するなど Body 文を小さくしてdata is too large."}]}ください。
予期せぬ内部異常を検出しました。
{"errors":[{"message":"iot-pf is
エラーメッセージをヘルプデスク
temporally unavailable.[12029]"}]}
までご連絡願います。
{"errors":[{"message":"[UPDATE] url
URL の指定が誤っています。URL を
format error."}]}
見なおしてください。
{"errors":[{"message":"[UPDATE] query URL に"?"が複数存在します。クエ
num invalid."}]}
リを見なおしてください。
{"errors":[{"message":"[UPDATE] query クエリが長すぎます。クエリを見な
too large."}]}
おしてください。
{"errors":[{"message":"[UPDATE] url
URL の指定が誤っています。URL を
unescape error."}]}
見なおしてください。
アクセスコードが誤っています。
{"errors":[{"message":"[UPDATE] access
正しいアクセスコードが記載されcode is wrong."}]}ているか確認してください。
{"errors":[{"message":"[UPDATE]
x-iotpf-request-id の内容が不正
x-iotpf-request-id format error."}]}です。
{"errors":[{"message":"[REMOVE] url
URL の指定が誤っています。URL を
format error."}]}
見なおしてください。
{"errors":[{"message":"[REMOVE] query URL に"?"が複数存在します。クエ
num invalid."}]}
リを見なおしてください。
{"errors":[{"message":"[REMOVE] query クエリが長すぎます。クエリを見な
too large."}]}
おしてください。
{"errors":[{"message":"[REMOVE] url
URL の指定が誤っています。URL を
unescape error."}]}
見なおしてください。
All Rights Reserved,Copyright©FUJITSU LIMITED 2016-202275

最新削除(_present)にも関わらず、クエリが指定されています。クエリを除いて実行してください。
過去のデータの削除(_past)にも関{"errors":[{"message":"[REMOVE] query
400 Bad Request
わらず、クエリが指定されていませis required. for past."}]}ん。クエリを指定してください。
アクセスコードが誤っています。
{"errors":[{"message":"[REMOVE] access
400 Bad Request
正しいアクセスコードが記載されcode is wrong."}]}ているか確認してください。
{"errors":[{"message":"[REMOVE]
x-iotpf-request-id の内容が不正
400 Bad Request
x-iotpf-request-id format error."}]}です。
{"errors":[{"message":"Number of
アクセス頻度がシステム許容値を429 Too Manyrequest per second has exceeded maximum 越えています。アクセス頻度を見直Requests
usage limit of service contract."}]}
してください。
{"errors":[{"message":"fail to get
指定された圧縮形式の情報が異常
400 Bad Request
decompressed data size."}]}です。
{"errors":[{"message":" decompressed
伸長後のデータ長が大きすぎます。
400 Bad Request
data is too large."}]}
対象アクセスコードに紐づいたイ{"errors":[{"message":" request access ベントが存在しています。
423 Locked
code has event. "}]}
イベントの紐付けを解除してください。
対象アクセスコードに紐付いたイ{"errors":[{"message":" request access
423 Locked
ベントが存在しているため、readcode can't read event."}]}
権を削除できません。
対象アクセスコードに紐付いた分{"errors":[{"message":" request access 散ポリシーが存在しています。
423 Locked
code has dispersion policy."}]}
分散ポリシーの紐付けを解除してください。
対象アクセスコードに紐付いたリ
コメンドリソースが存在していま{"errors":[{"message":" request access
423 Lockedす。
code has recommend resource."}]}
リコメンドリソースの紐付けを解除してください。
対象アクセスコードに紐付いた分{"errors":[{"message":" request access
423 Locked
散ポリシーが存在しているため、code can't update dispersion policy."}]}
update 件を削除できません。
{"errors":[{"message":" request access 対象アクセスコードに紐付いたリ
423 Locked
code can't update recommend
コメンドリソースが存在している
resource."}]}
ため、update 件を削除できません。
対象アクセスコードとリソースに紐付いたイベントが存在していま{"errors":[{"message":" request access
423 Lockedす。
code and resource have event."}]}
イベントの紐付けを解除してくだ
さい。
予期せぬ内部異常を検出しました。
503 Service{"errors":[{"message":" iot-pf Service
エラーメッセージをヘルプデスク
Unavailable
Unavailable."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":" iot-pf internal
エラーメッセージをヘルプデスク
Server Error
error."}]}
までご連絡願います。
{"errors":[{"message":"[REMOVE] query
400 Bad Request
must not be exists. for present"}]}All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
76

404 Not Found
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
404 Not Found
404 Not Found
404 Not Found
404 Not Found
404 Not Found
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request

400 Bad Request

400 Bad Request
400 Bad Request{"errors":[{"message":" Reload
予期せぬ内部異常を検出しました。
configuration to fail to read
エラーメッセージをヘルプデスク
config."}]}
までご連絡願います。
{"errors":[{"message":" tenant id is
テナント ID が指定されていませrequired. "}]}ん。
{"errors":[{"message":" access code is アクセスコードが指定されていま
requred. "}]}
せん。
{"errors":[{"message":" input parameter リソースパスの重複があります。
error. : resource_path is duplicated.
(resourcepath=[リソースパス])"}]}{"errors":[{"message":" parameter
パラメータに重複があります。
duplication. "}]}{"errors":[{"message":" request access 指定されたアクセスコードがすでcode already exists. "}]}に存在しています。
{"errors":[{"message":" request
指定されたリソースパスは存在しresource path does not exist. :ません。
ResourcePath= [リソースパス]"}]}{"errors":[{"message":" resource path 対象のリソース ID が登録されていnot found. "}]}
ません。
{"errors":[{"message":" access code not 検索条件に一致するアクセスコー
found. "}]}
ドがみつかりませんでした。
{"errors":[{"message":" event not
検索条件に一致するイベントがみ
found. "}]}
つかりませんでした。
{"errors":[{"message":" target resource 対象リソースが見つかりません。
not found. "}]}{"errors":[{"message":" tenant ID not 該当するテナント ID が見つかりまfound. "}]}
せん。
{"errors":[{"message":" event id is
イベント ID が指定されていませrequired. "}]}ん。
{"errors":[{"message":" URL FORMAT
正しいリクエスト URL ではありま
ERROR"}]}
せん。
{"errors":[{"message":" Incorrect
アクセスコード検索条件に誤りがaccess code search conditions. "}]}あります。
{"errors":[{"message":" Incorrect event イベント検索条件に誤りがありま
code search conditions. "}]}
す。
{"errors":[{"message":" Incorrectfilter 条件に誤りがあります。
filter condition. "}]}{"errors":[{"message":" input parameter top 条件に誤りがあります。
is error. : incorrect top condition "}]}{"errors":[{"message":" input parameter skip 条件に誤りがあります。
is error. : incorrect skip condition "}]}{"errors":[{"message":" Request data
リクエストデータの内容に誤りがformat error. "}]}あります。
{"errors":[{"message":" Number of
１リクエストで登録可能なリソー
resource path is over for one request. スパスの制限を超えています。
(resourcePathSize=[リソースパス個数])"}]}{"errors":[{"message":" input parameter アクセスコード権限情報が不足しerror is required. : permissions"}]}ています。
{"errors":[{"message":" input parameter リソース権限の情報が不足していerror is required. : resource_path and ます。
operations in resource_operations"}]}All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
77

400 Bad Request

400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request{"errors":[{"message":" input parameter
error is required. : resource_path ofresource_operations"}]}{"errors":[{"message":" input parameter
error is required. : operations ofresource_operations"}]}{"errors":[{"message":" input parameter
error is required. : conditions"}]}{"errors":[{"message":" input parameter
error is required. : targets"}]}{"errors":[{"message":" input parameter
error is required. : resource_path oftargets"}]}{"errors":[{"message":" input parameter
error is required. : operations oftargets"}]}{"errors":[{"message":" input parameter
error is required. : read_access_code oftargets"}]}{"errors":[{"message":" input parameter
error is required. : path_type of
notification_condition"}]}{"errors":[{"message":" input parameter
error is required. : path ofnotification_condition"}]}{"errors":[{"message":" input parameter
error is required. : comparing_operatorof notification_condition"}]}{"errors":[{"message":" input parameter
error is required. : value of
notification_condition"}]}{"errors":[{"message":" input parameter
error is required. : path_type of
awake_condition"}]}{"errors":[{"message":" input parameter
error is required. : path of
awake_condition"}]}{"errors":[{"message":" input parameter
error is required. : comparing_operatorof awake_condition"}]}{"errors":[{"message":" input parameter
error is required. : value of
awake_condition"}]}{"errors":[{"message":" input parameter
error is required. : notification smtp or
http"}]}{"errors":[{"message":" input parameter
error is required. : send_to of smtp
notification"}]}{"errors":[{"message":" input parameter
error is required. : body of smtp
notification"}]}

リソース権限のリソースパスが不足しています。
リソース権限のアクセス権が不足しています。
イベント条件が不足しています。
イベント対象が不足しています。
イベント対象のリソースパスが不足しています。
対象のリソースデータ操作が不足しています。
対象リソースパスの read 権をもつ
アクセスコードが不足しています。
通知条件の path 形式が不足しています。
通知条件のボディ要素を指定する
リソースパスが不足しています。
通知条件の比較演算子が不足しています。
通知条件の比較対象の値が不足しています。
抑止条件の path 形式が不足しています。
抑止条件のボディ要素を指定する
リソースパスが不足しています。
抑止条件の比較演算子が不足しています。
抑止条件の比較対象の値が不足しています。
通知内容の指定が不足します。
通知内容の通知先 e メールアドレ
スが不足しています。
通知内容の通知 e メールの本文が不足しています。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
78

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request
400 Bad Request
403 Forbidden
401
Unauthorized
401
Unauthorized
401
Unauthorized
400 Bad Request

400 Bad Request

400 Bad Request
403 Forbidden
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request{"errors":[{"message":" input parameter
error is required. : method of httpnotification"}]}{"errors":[{"message":" input parameter
error is required. : uri of httpnotification"}]}{"errors":[{"message":" input parameter
error is required. : field_name andfield_value of http notification"}]}{"errors":[{"message":" input parameter
error is required. : filed_name of httpnotification"}]}{"errors":[{"message":" input parameter
error is required. : filed_value of httpnotification"}]}{"errors":[{"message":" input parameter
error is required. : notification"}]}{"errors":[{"message":" Authorization
accesscode is required."}]}{"errors":[{"message":" Authorization
error. (AccessCode=[アクセスコード],
NG_ResoucePath=[リソースパス])"}]}{"errors":[{"message":" Client
authorization error. (AccessCode=[アクセスコード])"}]}{"errors":[{"message":" Protocol
authorization error. (AccessCode=[アクセスコード])"}]}{"errors":[{"message":" input parameter
error. : incorrect access code
operations"}]}{"errors":[{"message":" request
ipfilter does not exist. (tenanatId=[テナント ID], startIpAddr=[IP アドレス],
endIpAddr=[IP アドレス])"}]}{"errors":[{"message":" hit data islarger than limit.
(acceptable_top=1000)"}]}{"errors":[{"message":" Authorization
accesscode format error."}]}{"errors":[{"message":" Fail to url
decode(utf-8)."}]}{"errors":[{"message":" URL format
error. : Url Path is required."}]}{"errors":[{"message":" URL format
error. : Incorrect protocol"}]}{"errors":[{"message":" URL format
error. : incorrect url path"}]}{"errors":[{"message":" URL format
error. : incorrect url path start"}]}{"errors":[{"message":" URL format
error. : tenant id format error."}]}

通知内容の HTTP Method が不足しています。
通知内容の URI が不足しています。
通知内容のヘッダフィールドが不足しています。
通知内容のヘッダフィールド名が不足しています。
通知内容のヘッダフィールドの値が不足しています。
通知内容が不足しています。
アクセスコードが指定されていません。
指定されたアクセスコードで権限のないリソースが含まれています。
アクセスコードで認可されていな
いクライアントからのアクセスです。
アクセスコードで認可されていな
いプロトコルでのアクセスです。
アクセスコードのアクセス権の組合せが不正です。
指定されたアクセス制限設定がありません。
検索されたデータが 1000 件を超えています。
アクセスコードの形式に誤りがあります。
不正な文字コードのデータが含まれています。
URL パスが必要です。
不正なプロトコルが指定されています。
URL パスが不正です。
URL パスが不正な文字で始まっています。
テナント ID の形式が正しくありません。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
79

400 Bad Request
400 Bad Request
400 Bad Reqeust
400 Bad Request
400 Bad Request
400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request{"errors":[{"message":" URL format
error. : input _access_codes or_events."}]}{"errors":[{"message":" URL format
error. : unnecessary query is input"}]}{"errors":[{"message":" URL format
error. : access code format error."}]}{"errors":[{"message":" URL format
error. : input _counts."}]}{"errors":[{"message":" URL format
error. : event id format error."}]}{"errors":[{"message":" input parameter
error. : incorrect access code name's
string length"}]}{"errors":[{"message":" input parameter
error. : incorrect access code
discription's string length"}]}{"errors":[{"message":" input parameter
error. : number of ipfilter is larger
than 5."}]}{"errors":[{"message":" input parameter
error. : start ipaddress format
error"}]}{"errors":[{"message":" input parameter
error. : end ipaddress format error"}]}{"errors":[{"message":" input parameter
error. : ipfilter format error."}]}{"errors":[{"message":" input parameter
error. : incorrect ipfilter range"}]}{"errors":[{"message":" input parameter
error. : operations format error. (NGOperation kind=[アクセス権])"}]}{"errors":[{"message":" input parameter
error. : operation is duplicated."}]}{"errors":[{"message":" input parameter
error. : resource path format error."}]}{"errors":[{"message":" input parameter
error. : incorrect event name's string
length"}]}{"errors":[{"message":" input parameter
error. :event description's string
length"}]}{"errors":[{"message":" input parameter
error. : event target operations format
eror."}]}{"errors":[{"message":" input parameter
error. : inccorect
notification_condition's start_time or
end_time (start_time=[日時],
end_time=[日時])"}]}{"errors":[{"message":" input parameter
error. : cannot be set to body conditions

URL の指定が正しくありません。
不要なクエリが指定されています。
アクセスコードの形式が正しくありません。
HIT 数の取得の URL 指定が正しくありません。
イベント ID の形式が正しくありません。
アクセスコード名の長さが正しくありません。
アクセスコードの説明の長さが正
しくありません。
5 個以上のアクセス制限が指定されています。
アクセス制限の IP アドレスの形式
が正しくありません。
アクセス制限の IP アドレスの形式
が正しくありません。
アクセス制限の指定形式が正しくありません。
アクセス制限の指定形式が正しくありません。
アクセス権の指定形式が正しくありません。
同じアクセス権が重複して指定されています。
リソースパスの指定形式に誤りがあります。
イベント名の文字列長が正しくありません。
イベントの説明文の文字列長が正
しくありません。
リソース操作の指定形式に誤りがあります。

イベント判定日時の指定形式に誤りがあります。
リソース_Binary に対してイベント
条件が指定されています。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
80

400 Bad Request
400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Reuqest

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Request

400 Bad Reuqest

400 Bad Request

400 Bad Request

400 Bad Request
400 Bad Request

to binary resource."}]}{"errors":[{"message":" input parameter
error. : access code format error."}]}{"errors":[{"message":" input parameter
error. : incorrect path_type of
notification condition"}]}{"errors":[{"message":" input parameter
error. : incorrect path_type's string
length of notification condition"}]}{"errors":[{"message":" input parameter
error. : comparing_operator ofnotification condition(comparing_operator=[比較条件])"}]}{"errors":[{"message":" input parameter
error. : comparing operator format error(comparing_operator=[比較演算子])"}]}{"errors":[{"message":" input parameter
error. : incorrect path_type of awake
condition"}]}{"errors":[{"message":" input parameter
error. : incorrect path's string lengthof awake condition"}]}{"errors":[{"message":" input parameter
error. : comparing_operator of awake
condition (comparing_operator=[比較条件])"}]}{"errors":[{"message":" input parameter
error. : incorrect comparing operator of
awake condition (comparing_operator=[比較演算子])"}]}{"errors":[{"message":" input parameter
error. : incorret send_to's length of
smtp notification"}]}{"errors":[{"message":" input parameter
error. : incorret body's length of smtp
notification"}]}{"errors":[{"message":" input parameter
error. : incorret subject's length of
smtp notification"}]}{"errors":[{"message":" input parameter
error. : incorrect method of httpnotification"}]}{"errors":[{"message":" input parameter
error. : incorrect uri's length of httpnotification"}]}{"errors":[{"message":" input parameter
error. : number of header fields islarger than 10"}]}{"errors":[{"message":" input parameter
error. : incorrect field_name's lengthof http notification"}]}{"errors":[{"message":" input parameter

アクセスコードの指定形式に誤りがあります。
通知条件の path_type の指定形式に誤りがあります。
通知条件の path_type の文字列長が正しくありません。
通知条件の比較条件の指定形式に誤りがあります。
通知条件の比較条件の比較演算子に誤りがあります。
抑止条件の指定形式に誤りがあります。
抑止条件の path の指定文字列長が正しくありません。
抑止条件の比較条件の指定形式に誤りがあります。

抑止条件の比較条件の比較演算子に誤りがあります。
通知内容の連絡先 E メールアドレ
スの形式に誤りがあります。
通知内容の E メール本文の形式に誤りがあります。
通知内容の E メール件名の形式に誤りがあります。
通知内容の HTTP メソッドの指定形
式に誤りがあります。
通知内容の URL 指定形式の文字列長が正しくありません。
通知内容のヘッダフィールドが 11個以上指定されています。
通知内容のヘッダフィールドの指定形式の文字列長が正しくありません。
通知内容のヘッダフィールドの指All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
81

400 Bad Request

400 Bad Request

400 Bad Request
400 Bad Reuqest
400 Bad Request

400 Bad Request
400 Bad Request
500 Internal
Server Error
503 Service
Unavailable
400 Bad Request

403 Forbidden

400 Bad Request
401
Unauthorized
400 Bad Request

400 Bad Request

400 Bad Request
400 Bad Request
400 Bad Request

error. : incorrect field_value's lengthof http notification"}]}{"errors":[{"message":" input parameter
error. : incorrect basic_auth_id's
length of http notification"}]}{"errors":[{"message":" input parameter
error. : incorrect basic_auth_pass's
length of http notification"}]}{"errors":[{"message":" input parameter
error. : certification info format
error."}]}{"errors":[{"message":" input parameter
error. :protocols format error."}]}{"errors":[{"message":" input parameter
error. : certification file is too large.
Size=[サイズ]"}]}{"errors":[{"message":" input parameter
error. : certification format error.([証明書形式文字列] is required)"}]}{"errors":[{"message":" input parameter
error. : protocols is duplicated."}]}{"errors":[{"message":" certification
file parse error.([エラー番号])"}]}{"errors":[{"message":"[12401]
transfer resource is temporarily
unavailable"}]}{"errors":[{"message":" input parameter
error. : incorrect body's length of httpnotification"}]}{"errors":[{"message":" Ip filter NG.
(tenantId=[テナント ID], accessCode=[アクセスコード], srcIp=[要求元 IP アドレス])"}]}{"errors":[{"message":" request httpheader error. (Header:[ヘッダ内容])"}]}{"errors":[{"message":" Authorization
error. (AccessCode=[アクセスコード])"}]}{"errors":[{"message":" input parameter
error. : uri of http notification format
error."}]}{"errors":[{"message":" input parameter
error. : field_name length of httpnotification format error."}]}{"errors":[{"message":" input parameter
error. : incorrect body_conditions of
awake condition"}]}{"errors":[{"message":" URL format
error. : access code is necessary."}]}{"errors":[{"message":"[12990] Illigal
put data."}]}

定形式の文字列長が正しくありません。
通知内容の HTTP ベーシック認証 IDの文字列長が正しくありません。
通知内容の HTTP ベーシック認証パスワードの文字列長が正しくありません。
証明書の指定形式に誤りがあります。
プロトコルの指定形式に誤りがあります。
証明書のサイズがシステム許容値を越えています。
証明書の形式に誤りがあります。
プロトコルの指定に重複があります。
予期せぬ内部異常を検出しました。
エラーメッセージをヘルプデスクまでご連絡願います。
転送リソースが一時的に利用できません。しばらく待ってから再度ご利用ください。
通知内容のボディ長が正しくありません。
アクセス制限設定により、アクセスを拒否しています。
HTTP ヘッダ内容に誤りがあります。
アクセスコードに誤りがあります。
通知内容の HTTP Method の指定形式に誤りがあります。
通知内容の HTTP Method の指定文字
列長が正しくありません。
抑止条件の body_conditions の指定形式に誤りがあります。
URL にアクセスコードが指定されていません。
パラメータ指定に誤りがあります。

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
82予期せぬ内部異常を検出しました。
{"errors":[{"message":"[11901] Fail to
エラーメッセージをヘルプデスク
loadCollection."}]}
までご連絡願います。
{"errors":[{"message":"[12992]
予期せぬ内部異常を検出しました。
503 Service
Abnormality occurred by PUT
エラーメッセージをヘルプデスク
Unavailable
processing."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11903] Fail to
エラーメッセージをヘルプデスク
Server Error
create CommonData."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11904] Fail to
エラーメッセージをヘルプデスク
Server Error
get socket(PUT)."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11905] Fail to
エラーメッセージをヘルプデスク
Server Error
send PreProcess(PUT)."}]}
までご連絡願います。
{"errors":[{"message":"[12980] Illigal
400 Bad Request
パラメータ指定に誤りがあります。
delete data."}]}
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11911] Fail to
エラーメッセージをヘルプデスク
Server Error
loadCollection."}]}
までご連絡願います。
{"errors":[{"message":"[12912]
予期せぬ内部異常を検出しました。
503 Service
Abnormality occurred by DELETE
エラーメッセージをヘルプデスク
Unavailable
processing."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11913] Fail to
エラーメッセージをヘルプデスク
Server Error
create CommonData."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11914] Fail to
エラーメッセージをヘルプデスク
Server Error
get socket(DELETE)."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11915] Fail to
エラーメッセージをヘルプデスク
Server Error
send PreProcess(DELETE)."}]}
までご連絡願います。
{"errors":[{"message":"[12920] Illigal
400 Bad Request
パラメータ指定に誤りがあります。
get data."}]}
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11921] Fail to
エラーメッセージをヘルプデスク
Server Error
loadCollection."}]}
までご連絡願います。
{"errors":[{"message":"[12922]
予期せぬ内部異常を検出しました。
503 Service
Abnormality occurred by GET
エラーメッセージをヘルプデスク
Unavailable
processing."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11923] Fail to
エラーメッセージをヘルプデスク
Server Error
create CommonData."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11924] Fail to
エラーメッセージをヘルプデスク
Server Error
get socket(GET)."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11925] Fail to
エラーメッセージをヘルプデスク
Server Error
send PreProcess(GET)."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11935] Fail to
エラーメッセージをヘルプデスク
Server Error
send PreProcess."}]}
までご連絡願います。
500 Internal
Server Error

All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
83

予期せぬ内部異常を検出しました。
エラーメッセージをヘルプデスクまでご連絡願います。
予期せぬ内部異常を検出しました。
503 Service{"errors":[{"message":"[11937] Service
エラーメッセージをヘルプデスク
Unavailable
Unavailable.."}]}
までご連絡願います。
予期せぬ内部異常を検出しました。
500 Internal{"errors":[{"message":"[11938]Internal
エラーメッセージをヘルプデスク
Server Error
Server Error."}]}
までご連絡願います。
503 Service{"errors":[{"message":"[12900] Before システム初期化処理中です。しばら
Unavailable
start service(for initialization)."}]} く待ってから再度ご利用ください。
{"errors":[{"message":"[12906]Number
アクセス頻度がシステム許容値を429 Too Manyof request per second has exceeded
越えています。アクセス頻度を見直Requests
maximum usage limit of service
してください。
contract."}]}
予期せぬ内部異常を検出しました。
503 Service{"errors":[{"message":"[11937] Service
エラーメッセージをヘルプデスク
Unavailable
Unavailable.."}]}
までご連絡願います。
取得データ件数が、1,001 以上とな{"errors":[{"message":"number ofる(top オプションなし)参照リクエ
response-data is larger than
400 Bad Request
ストです。
1000","acceptable_top": [top 値指定可能
acceptable_top の値に従い top 数
数]}]}を指定し直してください。
取得データ量が、16MB より大とな{"errors":[{"message":"response size isる参照リクエストです。
400 Bad Request larger than 16MB","acceptable_top":
acceptable_top の値に従い top 数[top 値指定可能数]}]}を指定し直してください。
{"errors":[{"message":"number of
処理負荷の高いクエリが多数同時
503 Service
concurrent request for heavy queriesに要求されています。同時要求数をUnavailable
exceeded the maximum usage limit."}]} 減らしてください。
408 Request
Timeout{"errors":[{"message":"[11936] RESTConnection Error."}]}All Rights Reserved,Copyright©FUJITSU LIMITED 2016-2022
84