COLMINA Platform APIリファレンス - FujitsuAPI のサービスを利用するためには、API...

© FUJITSU LIMITED 2018

IIDP1.1_M003

FUJITSU Cloud Service K5 COLMINA Platform

API リファレンス

(1.1.3 版)


＜改版履歴＞

版数説明日付

1.1.0 版初版 2017/12/22

1.1.1 版ワイルドカード検索対応 2018/2/28

1.1.2 版 API 検索性向上機能追加対応、記載見直し 2018/6/29

1.1.3 版機能改善(データ加工フロー管理及び定義編集) 2018/11/17


はじめに

このたびは「FUJITSU Cloud Service K5 COLMINA Platform（以下、本サービス）」をご検討いただ

き、誠にありがとうございます。

この「このたびは「FUJITSU Cloud Service K5 COLMINA Platform APIリファレンス（以下、本書）」

は、本サービスをご契約いただいたお客様、またはご採用いただくお客様のための資料です。下記につき

ましてご了承くださいますよう、よろしくお願いいたします。

１．ご検討中のお客様は、本書を本サービスご採用可否のご判断のためにのみ、ご参照願います。

２．本書および本書の内容について、第三者へご開示／ご提供にはならないようにお願いいたします。

３．発行元の許可なく、本書の記載内容を複写／転写することを禁止します。

本書には本サービスをご採用いただくための重要な情報を記載しています。

ご契約いただいたお客様は、ご利用前に本書をよくお読みの上、本サービスをご利用ください。なお、本

書は大切に保管してください。

ご採用いただけないお客様は、お客様の責任で本書をすみやかに廃棄願います。

本書の作成にあたって、細心の注意を払い可能な限り分かりやすい記載に努めていますが、本書の記述に

誤りや欠落があっても弊社はいかなる責任も負わないものとします。本書及びその記述内容は予定なく変

更される場合があります。

本書の内容の一部または全部を無断で複製・転載・改編しないでください。

免責事項について

・本サービスのマニュアルに記載されていない操作を行なったことで思わぬ誤動作や、予期せぬ課金が発生した

場合であっても一切の責任を負いません。

・本サービスの利用、または利用できなかったことにより万が一損害（業務の中断・データの破損/損失・事故

などによる損害や第三者からの賠償請求の可能性を含む）が生じたとしても、責任を一切負いません。


＜用語一覧＞

用語説明備考

COLMINA COLaborative MONOZUKURI INnovation Agent の略

富士通のものづくりデジタルプレイスを表します。

API Application Program Interface の略

Web サービス型の APIです。

http(s)を利用してネットワーク越しに処理を実行して結果を受け取る

仕組みです。

URI Uniform Resource Identifier の略

URI は http(s) や ftp などのスキームで始まり、コロン (:) による区

切りのあとにスキームごとに定義された書式によってリソースを示すこ

とができます。

REST REpresentational State Transfer の略

複数のソフトウェア連携に適した設計原則を Web に適用したソフトウ

ェアの設計様式です。

※特定の URL にパラメータを指定して HTTP でアクセスすると XML、

JSON などで記述されたメッセージが送られてくるような、呼び出しイ

ンタフェースと呼ばれています）。

本サービスでは XML ではなく JSON 形式で返信します。

JSON JSON(JavaScript Object Notation)は、軽量のデータ交換フォーマット

です。人間にとって読み書きが容易で、マシンにとっても簡単に解析や

生成を行える形式です。

HTTPS-POST HTTPS 通信で、データベースへデータの格納などを格納する場合に使

用します。データ量が多い場合、バイナリデータを送信したい場合、他

の人に見られたくない情報を送る場合に利用します。

FQDN Fully Qualified Domain Name の略

完全修飾ドメイン名の略で、ホスト名、ドメイン名(サブドメイン名)な

ど、すべてを省略せずに指定した記述形式です。

TLS

TLS1.2

Transport Layer Security の略

インターネットなどのコンピュータネットワークにおいてセキュリティ

を要求される通信を行うためのプロトコルです。主な機能として、通信

相手の認証、通信内容の暗号化、改竄の検出を提供します。

TLS1.2 は、暗号化方式に SHA-256(暗号化方式)が利用でき、認証付き

暗号を用いた方式が利用できます。COLMINA Platform では、TLS1.2

のみ通信を許可しています。

IoT Platform IoT 活用で必要となる機器や業務とのデータ送受信・蓄積と、主にリア

ルタイム系の判断／アクションの実行、および効率的なデータ収集を行

う分散機能を含む、IoT 専用クラウドサービスです。


- 目次 – 第 1章概要 ............................................................................................................................................... 1

本書の目的 .................................................................................................................................... 1 1.1.

ドキュメント ................................................................................................................................. 1 1.2.

第 2章全体共通事項 ................................................................................................................................. 2

各パラメータの最大・最小値 ....................................................................................................... 2 2.1.

注意事項 ........................................................................................................................................ 2 2.2.

APIによる課金、制限事項について ...................................................................................... 2 2.2.1.

サービス利用停止について ................................................................................................... 2 2.2.2.

データの一意性について ....................................................................................................... 3 2.2.3.

HTTPS-POST(CSV)共通事項 ............................................................................................................. 4 2.3.

Request(ドメイン名) ............................................................................................................. 4 2.3.1.

第 3章 API情報 ......................................................................................................................................... 5

CSVデータ登録 API........................................................................................................................ 6 3.1.

Request構造 .......................................................................................................................... 6 3.1.1.

URIデータ受信指定パラメータ ............................................................................................. 6 3.1.2.

HTTPヘッダ概要 ..................................................................................................................... 6 3.1.3.

URI指定パラメータ/HTTPヘッダ/Body概要情報データの内容制限 ................................... 7 3.1.4.

Body情報データの内容制限 ................................................................................................. 9 3.1.5.

処理結果コード(ステータスコード) ................................................................................... 10 3.1.6.

サンプルプログラムの内容 ................................................................................................. 10 3.1.7.

サンプルプログラムの実行方法とその結果 ........................................................................ 14 3.1.8.

JSONデータ登録 API .................................................................................................................... 15 3.2.

Request構造 ........................................................................................................................ 15 3.2.1.

URIデータ蓄積指定パラメータ ........................................................................................... 15 3.2.2.

HTTPヘッダ概要 ................................................................................................................... 15 3.2.3.

Body概要 .............................................................................................................................. 15 3.2.4.

APIリクエストサンプル ...................................................................................................... 15 3.2.5.

データレイク API の共通事項 ..................................................................................................... 16 3.3.

クエリ要素 ........................................................................................................................... 16 3.3.1.

検索条件の演算子 ................................................................................................................ 16 3.3.2.

検索条件に利用可能な要素 ................................................................................................. 16 3.3.3.

あいまい検索 ....................................................................................................................... 17 3.3.4.

注意事項 ............................................................................................................................... 18 3.3.5.

データレイク API（NoSQL） ........................................................................................................ 18 3.4.

NoSQLデータ取得 API ........................................................................................................... 18 3.4.1.

NoSQLデータ登録 API ........................................................................................................... 24 3.4.2.

NoSQLデータ更新 API ........................................................................................................... 28 3.4.3.

NoSQLデータ削除 API ........................................................................................................... 32 3.4.4.

データレイク API（RDB）............................................................................................................ 36 3.5.

RDBデータ取得 API .............................................................................................................. 36 3.5.1.

RDBデータ登録 API .............................................................................................................. 41 3.5.2.

RDBデータ更新 API .............................................................................................................. 45 3.5.3.

RDBデータ削除 API .............................................................................................................. 49 3.5.4.


1

第1章概要

本書の目的 1.1.

本書は FUJITSU Cloud Service K5 COLMINA Platform（以下：本サービス）のご利用に際し、API

を利用したアプリケーションを開発する方向けの「API リファレンス」です。

ドキュメント 1.2.

本サービスにおけるドキュメント構成を示します。

表 1.2 ドキュメント一覧

マニュアル名説明


サービス詳細説明書

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


ユーザーズガイド

本サービスを活用するアプリケーション設計・開発

を支援するマニュアルです。


データ可視化 powered by Intelligent Dashboard

リファレンスマニュアル

本サービスで提供する Intelligent Dashboard を利

用するための操作マニュアルです。


Smart ものづくり標準プロファイル対応データ

可視化サービスリファレンスマニュアル

本サービスで提供する Smart ものづくりを利用す

るための操作マニュアルです。


API リファレンス

本サービスで提供する API に関する情報です。(本

書)


2

第2章全体共通事項

本サービスは、工場等のデータ発生源で持つデータを、通信方式として HTTPS を利用して、COLMINA

Platform 上にデータを格納するためのインタフェースを提供するものです。本章では、まず API 利用の

共通事項について説明します。

API のサービスを利用するためには、API へのアクセス先を指定しますが、その指定は URI の形式で

指定します。URI の中で指定するパラメータの説明、使用可能文字、最大・最小値を以下に説明します。

各パラメータの最大・最小値 2.1.

パラメータ名説明使用可能文字最小最大

リソースパス URI アクセス情報を一意に表現す

るためのパス。/(スラッシュ)区切

りで階層的に表現できます。

・半角英数字

・「-」、「_」、「/」

※「/-」、「/_」のように、先頭

や「/」の後に「-」と「_」は

指定不可。 ※「//」のように

「/」の連続も指定できませ

ん。

2 文字 128 文字

テナント ID お客様テナントを識別する 8 文字

の識別子。COLMINA Platform の

テナント ID。

英数字のみ 8 文字 8 文字

注意事項 2.2.

APIによる課金、制限事項について 2.2.1.

本サービスでは、利用回数等によって、課金は変動せず、基本サービス機能として、随時利用可能な機

能となります。また、本サービスに深刻なダメージを与えるような集中利用があった場合、または、デー

タ受信に関する制限事項を定常的に超える場合は、本サービスへのアクセスを拒否する場合があります。

本サービスの制限事項の詳細は、「FUJITSU Cloud Service K5 COLMINA Platform サービス仕様書」の

制限事項をご参照ください。

サービス利用停止について 2.2.2.

本サービスは、K5 サービス全体のメンテナンス、COLMINA Platform のメンテナンスや緊急を要する

サービス停止時は、本 API サービスも利用することができません。利用した場合、実行プログラムの処理

結果コードが認証エラーや内部エラーとなる可能性があり、処理実行に失敗します。

サービスが利用できる期間や条件については、「サービス詳細説明書」に記載していますので、ご確認く

ださい。


3

データの一意性について 2.2.3.

登録するデータは、登録するデータを一意として決定するキー情報をもとに、アクセスすることになり

ます。そのため、データ登録 API でアクセスするテーブルは、主キーを持つテーブルである必要がありま

す。また、データ可視化 powered by Intelligent Dashboard（オプションサービス）で追加される逐次実

績テーブルのキー情報は以下の通りとなります。すでに格納済のキー情報と同じキー情報を利用して、再

度データ登録する場合、格納済のデータは上書きされます。ただし、１つのリクエスト内でキー重複が発

生している場合はエラーとなり、そのリクエスト内のデータすべて登録することができません。異なるリ

クエスト間でのキー重複のデータは上書きされます。

パラメータ名説明使用可能文字最小最大

TENANT_ID テナント ID

テナント単位に識別するための ID


PLACE_ID 場所 ID

工場（エリア、ライン、工程等）や組

織（部、課、グループ等）の階層を場

所として管理


TIME 時間

データが発生した時刻を現地時間で設

定

日付(年月日時分秒)1 23 文字 23 文字

DATA_SBT データ種別

格納されている１次、２次データの種

類を特定するコード(電力使用量、生産

量等)


DATA_CAT データ要素

格納されているデータ種別ごとのデー

タに対し、さらに要素を識別するため

の区分(例：エネルギー実績のうち、変

動分/固定分/生産比例分を識別する)


1 YYYY-MM-DD hh:mm:ss.SSS の形式に従います（例: 2017-09-20 14:25:18.003）。

以降の「送信日時」はすべて同一仕様です。* 秒とミリ秒の区切りは「.」です。本サービスがレスポン

スに格納する場合、UTC を用います。


4

HTTPS-POST(CSV)共通事項 2.3.

Request(ドメイン名) 2.3.1.

Parameters 値補足

FQDN https://<zone>.fujitsu.com/ FQDN 内の<zone>に入る値は、

「FUJITSU Cloud Service K5

COLMINA Platform 申込請書」の

「CSV データ送信時の格納先 URL」

「データ格納 RDB URL」「データ格

納 NoSQL URL」「JSON データ送信

時の格納先 URL」をご参照ください。

尚、各 URL と API の対応は下表をご

確認ください。

・https プロトコルのため、443/tcp ポートを使用(TLS1.2 のみ通信可)

申込み請書および変更申込請書に記載されている URL と API の対応表

URL 対応する API 補足

CSV データ送信時の格納先 URL CSV データ登録 API 3.1.節参照

JSON データ送信時の格納先 URL JSON データ登録 API 3.2.節参照

データ格納 NoSQL URL データレイク API（NoSQL） 3.4.節参照

データ格納 RDB URL データレイク API（RDB） 3.5.節参照


5

第3章 API 情報

本章は、COLMINA Platform 上で提供する API の内容について説明します。

API グループ API 名概要

データ登録 CSV データ登録 API 構造化データを登録する

JSON データ登録 API JSON データを登録する

データレイク API

（NoSQL）

NoSQL データ取得 API 検索条件と一致した非構造化データを取得する

NoSQL データ登録 API 一件の非構造化データを登録する

NoSQL データ更新 API 一件の非構造化データを更新する

NoSQL データ削除 API 検索条件と一致した非構造化データを削除する

データレイク API

（RDB）

RDB データ取得 API 検索条件と一致した構造化データを取得する

RDB データ登録 API 一件の構造化データを登録する

RDB データ更新 API 一件の構造化データを更新する

RDB データ削除 API 検索条件と一致した構造化データを削除する


6

CSVデータ登録 API 3.1.

CSV データ格納をするための API 情報を以下に示します。

Request構造 3.1.1.

Parameters 値

Method HTTPS-POST

URI データ受信 https://{FQDN}/{API 名}/v1/{テナント ID}/tables/{テーブル ID}

HTTP ヘッダ後述の HTTP ヘッダ参照

Body 受信データ

URIデータ受信指定パラメータ 3.1.2.

パラメータ名説明 M/O1

FQDN 2.3 節参照 M

API 名 csv 固定 M

テナント ID リソース所有テナントの識別子 M

テーブル ID 構造化データを登録する RDB テーブルの識別子 M

HTTPヘッダ概要 3.1.3.


ユーザー名 COLMINA Platform 利用のためのユーザー名 M

パスワード COLMINA Platform 利用のためのパスワード M

データ種別 csv (固定) M

データ長最大 500000[bytes](500[KB])までの数値指定 M

送信日時送信対象データに付与する送信日時 3・既に送信、リクエスト受信

日時のデータが存在するかどうかはチェックせず、追記を行いま

す。

M

フォーマットチェック実

施

フォーマットのチェックを実施する場合は true、実施しない場合

は false を指定

M

データヘッダ有無データのヘッダが存在するときは true、存在しない場合は false

を指定

M

オプション１任意項目１(必要に応じて設定) O

オプション２任意項目２(必要に応じて設定) O

オプション３任意項目３(必要に応じて設定) O

ポスト用エンティティ設

定

text/csv;charset=utf-8 M

1 M：必須、O：オプション 2 M：必須、O：オプション 3 YYYY-MM-DDTh:mm:ssTz の形式に従います。（例:2016-12-25T10:36:12+09:00）。精度はミリ秒(ミリ

秒を省略した場合、0 ミリ秒とみなします)




7

URI指定パラメータ/HTTPヘッダ/Body概要情報データの内容制限 1 3.1.4.

№ 項目名項目名英字項目説明属性ﾊﾞｲﾄ数設定値

URIに設定

1 FQDN - アクセス先情報文字列 128 2.3 章参照

(URI全体で 128バイト

まで)

2 API 名 - API 名文字列 40 csv(固定)

3 テナント ID - K5 利用者のテナ

ント ID

文字列 8 （利用者の入力）お客

様の COLMINA

Platform テナント ID

4 テーブル ID 構造化データを登

録する RDB テー

ブルの識別子

文字列 40 （利用者の入力）デー

タを格納する対象のテ

ーブル ID

HTTPヘッダ

ヘッダ

4 コンテンツ

タイプ

Content-T

ype

HTTPヘッダの形式文字列 37 “Content-Type:

text/csv;

charset=utf-8”固定

5 ユーザー名 uid 送信を実行するユ

ーザー名

文字列 30 （利用者の入力）ユー

ザー名

6 パスワード userPassw

ord

送信を実行するユ

ーザー名に対する

パスワード

文字列 32 （利用者の入力）ユー

ザー名に対するパスワ

ード

暫定パスワードは設定

(機能利用)できません

7 データ種別 receive_da

ta_type

データ送信するボ

ディのファイル種

別

文字列 20 （利用者の入力）"csv"

固定

8 データ長 receive_da

ta_length

データ送信するデ

ータの長さ

数値 10 （利用者の入力）デー

タのデータ長[byte]

最大 500,000[bytes]

(500[KB])までの数値

指定

9 送信日時 send_date

time

リクエストの送信

日時 2

日付 29 （利用者の入力）リク

エスト送信日時

10 フォーマットチ

ェック実施

format_ch

eck_flg

データのフォーマ

ットチェック実施

フラグ

文字列 5 （利用者の入力）true:

実施する、false: 実施し

ない

11 データヘッダ有 receive_da データのヘッダ有文字列 5 （利用者の入力）true:

1 データの内容制限

・値はすべて二重引用符「"」で囲みます。二重引用符を値に含めるときは重ねて表現します。「""」

・カラムの区切り文字はカンマ「,」です。

・プログラム内で区切り文字として利用するため、「","」を値に含めることはできません。「"",""」も

利用できません。 2 YYYY-MM-DDThh:mm:ssTz の形式に従います。（例:2016-12-25T10:36:12+09:00）。精度はミリ秒(ミ

リ秒を省略した場合、0 ミリ秒とみなします)




8

無 ta_with_h

eader

無フラグヘッダあり、false: ヘッ

ダなし

12 任意項目１ option_1 任意項目文字列 256 （利用者の入力）必要

に応じて設定

13 任意項目２ option_2 任意項目文字列 256 （利用者の入力）必要

に応じて設定

14 任意項目３ option_3 任意項目文字列 256 （利用者の入力）必要

に応じて設定

ボディ

15 送信データ receive_da

ta

外部データ受信イ

ンタフェースへ渡

すデータ

文字列 5000

00

（利用者の入力）CSV形

式の登録対象データ 1

最大 500,000[bytes]

(500[KB])までのデー

タ

レスポンス

16 ステータス

コード

status_cod

e

API の応答ステー

タスコード

数値 3 （システムにて設定）

HTTP のステータスコ

ード

ヘッダ

17 コンテンツ

タイプ

Content-T

ype

レスポンスボディ

の形式

文字列 16 （システムにて設定）

"application/json"固定

ボディ

18 受信便 No receive_no 一意の受信便 No 文字列 32 （システムにて設定）

送信データの状況を問

い合わせるための一意

の ID

19 処理結果コード result_cod

e

処理結果の詳細コ

ード


データ受信の結果コー

ド

20 メッセージ message 処理結果のメッセ

ージ


結果コードに紐づく詳

細メッセージ





利用できません。


9

Body情報データの内容制限 1 3.1.5.

Body 情報の定義は、利用者が登録したテーブル定義の内容に準拠します。

尚、利用者が登録したテーブル定義の日時項目は属性に応じた形式での設定が必要となります。

次の表は Intelligent Dashboard サービス（オプション）で追加される逐次実績テーブルの定義情報で

す。


Body

1 テナント ID TENAN

T_ID

K5 利用者のテナント

ID

英数字の

み

8 テナント単位に識

別するための ID

2 場所 ID PLACE_

ID

工場（エリア、ライン、

工程等）や組織（部、

課、グループ等）の階

層を場所として管理

英数字の

み

24 例：CJP01AK1

3 時間 TIME データが発生した時

刻を現地時間で設定2

日付 23 例：2017-09-20

14:25:18.003

4 データ種別 DATA_S

BT

格納されている１次、

２次データの種類を

特定するコード(電力

使用量、生産量等)

英数字の

み

20 例：SB201, SB605

5 データ要素 DATA_C

AT

格納されているデー

タ種別毎のデータに

対し、要素を識別する

ための区分(例：エネ

ルギー実績のうち、変

動分/固定分/生産比

例分を識別する)

英数字の

み

20 例：101, 201

6 値 VALUE 計測値、演算値等数値（符

号あり、

小数含

む）

15

0 ～

999999999999.99

9

小数点以下は 3 桁

7 単位区分 UNIT_K

BN

単位に対し一意に採

番される ID

英数字の

み

3 例：1

8 文字列値 TEXT_V

ALUE

文字列値、メッセー

ジ、伝文等

任意デー

タ

256

9 予備項目 1(数値) SPARE_

NUM_IT

EM1

数値用予備項目任意デー

タ

32

10 予備項目 2(数値) SPARE_ 数値用予備項目任意デー 32





利用できません。 2 YYYY-MM-DD hh:mm:ss.SSS の形式に従います（例: 2017-09-20 14:25:18.003）。

但し、利用者が登録したテーブル定義の日時項目は以下の形式に従います。

属性が timestamp(タイムゾーン無)型：YYYY-MM-DD hh:mm:ss[.SSS]（例：2017-09-20 14:25:18.003）

属性が timestamptz(タイムゾーン有)型：YYYYMMDDThhmmss[.SSS]Z または

YYYYMMDDThhmmss[.SSS]±hhmm

（例：20170920T142518.003Z または 20170920T142518.003+0900）


10

NUM_IT

EM2

タ

11 予備項目 3(数値) SPARE_

NUM_IT

EM3

数値用予備項目任意デー

タ

32

12 予備項目 1(文字列) SPARE_

TXT_ITE

M1

文字列用予備項目任意デー

タ

32


TXT_ITE

M2


タ

32


TXT_ITE

M3


タ

32

処理結果コード(ステータスコード) 3.1.6.

項

番

ステータスコードとその概要処理結果コード処理結果コードの内容

1 200：正常 I00 正常

2 400：引数不正 E10 データ形式エラー

E11 文字コードエラー

E12 0 件エラー

E13 項目数エラー

E14 型エラー

E15 桁数エラー

E16 NULL エラー

E17 定義値エラー

3 401：認証エラー E50 認証エラー

4 500：内部エラー E30 SQL 接続例外

E40 ファイル IO エラー

サンプルプログラムの内容 3.1.7.

データ格納のための登録情報サンプルと、その処理結果(正常例、異常例)を以下に示します。

サンプルは Java プログラムで示しています。

サンプル Java プログラムは、以下の内容で構成しています。

・SampleSrc.java (Java メインプログラム)

・ProxySetting.java (Java メインプログラムのサブプログラム)

・run.bat (Java コンパイルの Windows バッチプログラム)

SampleSrc.java (Javaメインプログラム) 3.1.7.1.

import java.time.*;

import java.io.*;

import java.net.*;

import java.security.SecureRandom;

import java.time.OffsetDateTime;

import java.time.format.DateTimeFormatter;

import javax.net.ssl.*;

public class SampleSrc{


11

public static void main(String args[]) {

System.setProperty("jdk.tls.trustNameService","false");

try {

// Web-APIの URL

String targetUrl ="https://データ送信時の格納先 URL の FQDN を指定します

/csv/v1/テナント IDを指定します/tables/テーブル IDを指定します";

// Web-APIの認証ユーザ ID

String userId = "ユーザー名(COLMINA送信用) を指定します";

// Web-APIの認証パスワード

String pass = "ユーザー名(COLMINA送信用) のパスワードを指定します";

//CSVヘッダーの有無

boolean headerFlg = true;

//フォーマットチェック実施フラグ

boolean chkFlg = true;

// プロキシ設定が必要な場合(不要な場合は以下の 1 行をコメントアウトして

ください)

setProxy("プロキシ認証ユーザー名を指定します","プロキシ認証パスワード

を指定します","プロキシサーバを指定します","プロキシサーバのポート番号を指定します");

LocalDateTime ldt = LocalDateTime.now();

DateTimeFormatter pattern = DateTimeFormatter.ofPattern("yyyy-MM-dd

hh:mm:ss.SSS");

//CSVのヘッダ

String header =

"\"tenant_id\",\"place_id\",\"time\",\"data_sbt\",\"data_cat\",\"value\",\"unit_kbn\",\"text_v

alue\",\"spare_num_item1\",\"spare_num_item2\",\"spare_num_item3\",\"spare_txt_item1\",\"spare

_txt_item2\",\"spare_txt_item3\"\n";

StringBuilder line = new StringBuilder();

//CSVのボディ

for (int i = 0;i<2;i++){

ldt = ldt.plusMinutes(2);

line.append("\"TN100002\",\"CJP01TSGS1\",\"" +

pattern.format(ldt) +

"\",\"S1EVT\",\"MSG\",\"\",\"\",\"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAa\",\"\",\"\",\"\",\"\",\"\

",\"\"\n");

line.append("\"TN100002\",\"CJP01TRG\",\"" +

pattern.format(ldt) +

"\",\"S1EVT\",\"MSG\",\"\",\"\",\"AAAAAAAAAAAAAAAAAAAAAAa\",\"\",\"\",\"\",\"\",\"\",\"\"\n");

}

// データ送信

String body = header+line.toString();

URI 情報の

の設定

ヘッダ情報

の設定

登録データ

の設定(Body)


12

try {

System.out.println("sendHttp start");

URL urlObj = new URL(targetUrl);

HttpURLConnection con = (HttpURLConnection)

urlObj.openConnection();

con.setDoOutput(true);

// ヘッダ設定

con.setRequestMethod("POST");

con.setRequestProperty("Content-type", "text/csv");

con.setRequestProperty("uid", userId);

con.setRequestProperty("userPassword", pass);

con.setRequestProperty("receive_data_type", "csv");

con.setRequestProperty("receive_data_length",

String.valueOf(body.length()));

con.setRequestProperty("send_datetime",

DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(OffsetDateTime.now()));

con.setRequestProperty("receive_data_with_header",

String.valueOf(headerFlg));

con.setRequestProperty("format_check_flg",

String.valueOf(chkFlg));

// ボディを設定

OutputStream out = con.getOutputStream();

out.write(body.getBytes());

out.flush();

out.close();

System.out.println("sendHttp end .http_status="+

con.getResponseCode());

InputStream in = null;

if(con.getResponseCode() != 200){

in = con.getErrorStream();

} else {

in = con.getInputStream();

}

try (ByteArrayOutputStream os = new ByteArrayOutputStream();){

byte[] buffer = new byte[0xFFFF];

for (int len; (len = in.read(buffer)) != -1;){

os.write(buffer, 0, len);

}

os.flush();

System.out.println("response="+ os.toString());

}

} catch (Exception e) {

System.out.println("sendHttp error:"+ e);

e.printStackTrace();


13

}

} catch (Throwable t){

t.printStackTrace();

}

}

public static void setProxy(String id,String pass,String proxyHost,String proxyPort) {

ProxySetting fjp = new ProxySetting(proxyHost,proxyPort);

fjp.init(id, pass);

System.out.println("Proxy setting");

}

}

ProxySetting.java (Javaメインプログラムのサブプログラム) 3.1.7.2.

import java.net.Authenticator;

import java.net.PasswordAuthentication;

import java.util.Objects;

public class ProxySetting extends Authenticator {

private String proxyId = null;

private String pass = null;

public ProxySetting(String proxyHost,String proxyPort){

System.setProperty("proySet" , "true");

System.setProperty("proxyHost", proxyHost);

System.setProperty("proxyPort", proxyPort);

// 認証付きプロキシへの接続を有効化

System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");

}

public void init(String proxyId,String pass){

if( Objects.isNull(proxyId) || Objects.isNull(pass)){

throw new IllegalArgumentException("Proxy id or Pass is null");

}

this.proxyId = proxyId;

this.pass = pass;

setDefault(this);

}

protected PasswordAuthentication getPasswordAuthentication() {

return new PasswordAuthentication(proxyId, pass.toCharArray());

}

}

run.bat (Javaコンパイルの Windows バッチプログラム) 3.1.7.3.

※プロキシサーバ経由でインターネットアクセスする場合は、プロキシサーバとそのポート番号


14

を設定してください。

C:\java1.8\bin\javac *.java -d .\classes

pause

C:\java1.8\bin\java -cp .\classes SampleSrc

pause

サンプルプログラムの実行方法とその結果 3.1.8.

実行方法(Windows DOSプロンプト) 3.1.8.1.

C:\Users\Owner\ iidp_webapi_sample> run.bat

※クライアントに Java のコンパイル環境(JDK)が必要です。

処理結果例(正常) 3.1.8.2.

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8

{空行}

{

"receive_no": " 201708091710000999TNANT9999900001",

"result_code": "I00",

"message":""

}

処理結果例(異常) 3.1.8.3.

HTTP/1.1 401 401

Content-Type: application/json; charset=utf-8

{空行}

{

"receive_no": null,

"result_code": "E50",

"message":"id=\"MIID101E204\" mes=\"Error response : fail to authentication :

user_id=TNANT99999_apiuser001\""

}

入力


15

JSONデータ登録 API 3.2.

JSON データ格納をするための API 情報を以下に示します。

Request構造 3.2.1.

Parameters 値

Method PUT

URI データ蓄積 https:// {FQDN}/{リソースパス}


Body 登録対象データ

URIデータ蓄積指定パラメータ 3.2.2.


FQDN 「FUJITSU Cloud Service K5 COLMINA Platform 申込請書」

の「データ格納 IoT URL」を記載

M

リソースパスアクセス先リソースパス

（COLMINA ポータルのデータ受信設定（非構造化データ）で作

成したリソースパスを指定）

M

HTTPヘッダ概要 3.2.3.


Authorization Bearer { COLMINA ポータルのデータ受信設定（非構造化データ）

で作成したアクセスコード}

M

Range COLMINA Platform では使用不可のため省略してください。 O

Content-Type application/json; charset=UTF-8 固定 O

Body概要 3.2.4.

メンバーの順序性は保証せず、登録時の並びで参照できるとは限りません。

重複した name を持つメンバーは保存しません。

JSON 配列の最大要素数は 1,000 個です。

JSON 形式の登録対象のデータとして、配列([ ])での開始は許容しません。

インデックス設定 key の値が BSON 型で 1,024byte を超過するデータは保存しません。

APIリクエストサンプル 3.2.5.

(１) API リクエストサンプル

例）"colmina/core/XXX"というリソースを COLMINAポータルで新規登録し、"YYY"のアクセスコードと紐づ

けた場合

$ curl -i -k -X PUT 'https://{FQDN}/v1/ITNUM1SAMPLE-001/colmina/core/XXX' -H 'Content-Type:

application/json; charset=UTF-8' -H 'Authorization: Bearer YYY' -d '{ JSONデータ }'

HTTP/1.1 200 OK

1 M：必須、O：オプション 2 M：必須、O：オプション


16

データレイク APIの共通事項 3.3.

クエリ要素 3.3.1.

API で使用されるクエリは以下のとおりです。

クエリ要素説明備考

$top 取得件数検索条件に該当するデータの先頭からの取得件数

$skip スキップ件数検索条件に該当するデータの先頭からのスキップ件数

$filter 検索条件データの検索条件

$orderby ソート順指定取得データのソート順

$count 件数取得検索条件に該当するデータ件数を取得

クエリ要素の併用可否は以下のとおりです。

クエリ要素 $top #skip $filter $orderby $count

$top － ○ ○ ○ ×

$skip ○ － ○ ○ ×

$filter ○ ○ － ○ ○

$orderby ○ ○ ○ － ×

$count × × ○ × －

・併用可：○ 併用不可：×

併用不可なものが同時に指定された場合、優先度の高いクエリ要素のみ実行されます。

優先順位は$filter、$count、$orderby、$skip、$top の順です。

$count は値に false が設定された場合は未設定時と同じ扱いになります。

検索条件の演算子 3.3.2.

$filter クエリ要素で指定できる検索条件には以下の演算子を利用できます。

項番演算子説明例

1 eq 等号 $filter=owner eq 'Tom'

2 ne 不等号 $filter=owner ne null

3 gt より大きい $filter=value gt 100

4 ge 以上 $filter=value ge 100

5 lt より小さい $filter=value lt 100

6 le 以下 $filter=value le 100

7 and 論理積 $filter=value ge 100 and owner eq 'Tom'

8 or 論理和 $filter=value ge 100 or owner eq 'Tom'

上記以外の演算子は使用できません。

※ただし、優先順位を表す「（」、「）」についてはデータレイク API(NoSQL)でのみ使用可

$filter クエリの右辺に指定する値は、URL エンコード(パーセントエンコード)が必要です。

検索条件に利用可能な要素 3.3.3.

比較式の左辺には以下の要素が利用できます。

項番要素名説明備考

1 _date 登録日時検索対象レコードの登録日時、ISO8601 形式

「YYYYMMDDThhmmss.SSSZ」に従います

引用符「'」で囲みません

2 任意の項目名登録データの項目 URI の非予約文字以外はパーセントエンコー

ドを実施します

※非構造化テーブル操作のみ

key が階層構造になっている場合は、"."（ピ

リオド）を区切り文字に使用して

「Floor.Value」のように指定します。深さは


17

最大 15

3 _id ドキュメントのオブ

ジェクト ID

※非構造化テーブル

操作のみ

比較式の右辺は引用符「'」で囲みます

4 _resource_path リソースパス文字列

※非構造化テーブル

操作のみ

比較式の右辺は引用符「'」で囲みます

比較式の右辺には以下の要素が利用できます。

項番要素名説明備考

1 _date 登録日時検索対象レコードの登録日時

2 任意の項目名登録データの項目 URI の非予約文字以外はパーセントエンコー


3 null NULL 値 NULL 値に対しては等号不等号以外の演算子

は使用できません

4 '任意の値' 文字列引用符「'」で囲みます

引用符そのものを記述する場合は二つ重ねて

「''」設定します

URI の非予約文字以外はパーセントエンコー


5 任意の日時日時リテラル引用符「'」で囲みません

タイムゾーン付項目の場合は ISO8061 基本形

式「YYYYMMDDThhmmss.SSSZ」に従いま

す

タイムゾーンなし形式の場合は

YYYY-MM-DD hh:mm:ss[.SSS]形式に従いま

す

6 任意の数値数値リテラル引用符「'」で囲みません

URI の非予約文字以外はパーセントエンコー


あいまい検索 3.3.4.

クエリ要素$filter を利用して、前方一致/後方一致/部分一致のあいまい条件で検索を行うことができます。

あいまい検索時は、$filter の値フィールドにワイルドカード(*)を指定します。

利用可能な演算子

"eq" , "ne" の 2 つの演算子が利用できます。

※”eq" , "ne" を用いたあいまい検索の論理式を "and" , "or" で結合した複合条件の検索も可能

利用可能な要素/値

$filter の値フィールドに文字列(シングルクォートで囲む)を指定する場合のみワイルドカード(*)を指

定することができます。ワイルドカード(*)は、値フィールドの先頭もしくは末尾のみに指定可能です。

※先頭もしくは末尾の"*"はワイルドカードとみなし、途中の"*"は文字列とみなします

値フィールドに"*"のみが指定された場合、以下の動作となります。

・"*", "**" ：すべてのデータにマッチする

・"***" ：文字列中に「*」を含むデータにマッチする

注意事項


18

非構造化テーブル操作 API にてシステムにより自動付与するフィールドのうち、"_id", "_date" を要

素名に指定するあいまい検索は未対応です。

指定した場合、ステータスコード 400 を応答します。

前方一致/後方一致/部分一致のあいまい検索実行時間は、検索条件が同一の場合、部分一致/後方一致

より前方一致のほうが、検索時間が短くなります。

注意事項 3.3.5.

非構造化テーブル操作または構造化テーブル操作の API 実行間隔が短時間となった場合、稀に処理結果

コード（ステータスコード）として 401 もしくは 500 が返却されることがあります。この場合、再度該当

のリクエストを実行してください。

データレイク API（NoSQL） 3.4.

NoSQLデータ取得 API 3.4.1.

検索条件と一致した非構造化データを取得するための API 情報を以下に示します。

Request構造 3.4.1.1.

Parameters 値

Method GET

URI データ受信 https://{FQDN}/v1/{API 種別}/{データソース種別}/{テナント ID}/{リソース

パス}


HTTP クエリ後述の HTTP クエリ参照

URIデータ受信指定パラメータ 3.4.1.2.



API 種別 core 固定 M

データソース種別 nosql 固定 M


リソースパスアクセス先リソースパス M

HTTPヘッダ概要 3.4.1.3.


認証情報 Basic 認証の認証情報 M

API キークライアントアプリを識別するための API キー M

HTTPクエリ概要 3.4.1.4.


取得件数検索条件に該当するデータの先頭からの取得件数 O

スキップ件数検索条件に該当するデータの先頭からのスキップ件数 O

検索条件データの検索条件 O

ソート順指定取得データのソート順 O

件数取得検索条件に該当するデータ件数を取得 O

3 M：必須、O：オプション 4 M：必須、O：オプション 5 M：必須、O：オプション


19

URI指定パラメータ/HTTPヘッダ/ HTTPクエリ概要情報データの内容制限 3.4.1.5.


URIに設定



まで)

2 API 種別 - API 種別文字列－ core(固定)

3 データソース種別 - アクセス先リソー

スの種類

文字列－ nosql(固定)


ント ID


様の COLMINA


5 リソースパス - アクセス先データ

ベース情報

文字列 117 （利用者の入力）

{データベース名}/{コ

レクション名}6

リクエスト

ヘッダ

6 認証情報 Authoriz

ation

Basic 認証の認証

情報

文字列－（利用者の入力）

Basic {ユーザーID:パ

スワードを Base64 エ

ンコードした文字列}

7 API キー X-Api-Ke

y

クライアントアプ

リを識別する為の

の API キー

文字列－（利用者の入力）お客

様の COLMINA

Platform 契約時に発行

された API キー

クエリ

8 取得件数 $top 検索条件に該当す

るデータの先頭か

らの取得件数

数値 5 （利用者の入力）

1～20,000

9 スキップ件数 $skip 検索条件に該当す


らのスキップ件数


1～2,147,483,647

10 検索条件 $filter

データの検索条件文字列 1894 （利用者の入力）

検索条件を指定、

“要素演算子値7”の

セットで記述。

and/or で複数記述可。

「（」、「）」で条件式に

優先度を指定する記述

可8。

省略時は検索条件なし

として動作する

要素に指定する key は

6 COLMINA ポータルのデータ受信設定（非構造化データ）で作成したリソースパス

データベース名：core / smpf 7 _date 項目の場合は ISO8601 基本形式「YYYYMMDDThhmmss.SSSZ」に従います

（例: 20170920T142518.000Z）。 8 「（」、「）」は入れ子構造の指定も可、内側の括弧から順に評価されます。

入れ子構造で指定する場合、最大 5 階層までの指定を許容します。


20

インデックスが設定さ

れている key の指定を

推奨9。

11 ソート順指定 $orderby 取得データのソー

ト順


ソート順を指定、

“ソート対象 key スペ

ースソート順”で記

述。

ソート対象 key には任

意のフィールドを指定

可。

ソート対象 key に指定

可能な key は１つ（複

数指定は不可）。

ソート順で指定できる

のは“asc”(昇順)又は”

desc”（降順）のみ。

許容外を指定した場合

は NG 応答

ソート対象に指定する

key はインデックスが

設定されている key の

指定を推奨10。

省略時は

$orderby=_date asc と

して動作する

12 件数取得 $count 検索条件に該当す

るデータ件数を取

得


true/false を指定可能、

true 指定時に件数を取

得する。

省略時は$count=false


レスポンス

13 ステータス

コード

status_co

de


タスコード



ード

ヘッダ

14 コンテンツ

タイプ

Content-

Type


の形式


件数取得時：

"text/plain;

charset=UTF-8"(固定)

データ取得時：

"application/json;


15 コンテンツサイ

ズ

Content-

Length


のサイズ


ボディのデータ長

9 インデックスが未設定の key を指定する場合、データ検索に時間がかかる可能性があります 10 インデックスが未設定の key をソート対象に指定し、対象のデータサイズが 32MB を超過した場合は

ステータスコード 400 を応答します


21

[byte]

Transfer-Encoding ヘ

ッダ指定時は省略され

る

ボディ

16 レスポンス情報11 検索結果文字列 1677

7216

（システムにて設定）

件数取得時：

取得した件数

データ取得時：

取得した非構造化デー

タ JSON 文字列

17 エラーメッセー

ジ12

処理が失敗した場

合のメッセージ

文字列－（システムにて設定）

処理失敗要因の JSON

レスポンスボディレスポンス情報

一度に取得できるデータは、最大 20,000 件まで、もしくは最大 16MB まで。

取得対象データが上記を超えるような場合、ステータスコード 400 を応答します。

取得データは、以下規則により半角スペースが付与された形式で返却されます。

・key の前

・key:value の間の ":" の前後

・オブジェクト間の "," の後

・オブジェクトの末尾 ( "}" の前)

ソート順指定クエリ($orderby)の指定方法により、取得データの並び順は以下のようになる。

ソート順指定方法取得データの並び順

orderby 未指定 _date の昇順。

_date の値が同じ場合、データ登録順の昇順。

対象 key：_date

ソート順：昇順

date の昇順。

_date の値が同じ場合、データ登録順の昇順。

対象 key：_date

ソート順：降順

date の降順。

_date の値が同じ場合、データ登録順の降順。

対象 key：_date 以外

ソート順：昇順

指定 key の昇順。

指定 key の値が同じ場合、データ登録順の昇順。

対象 key：_date 以外

ソート順：降順

指定 key の降順。

指定 key の値が同じ場合、

指定 key にインデックスが設定されている場合は

データ登録順の降順

指定 key にインデックスが未設定の場合はデータ

登録順の昇順

システムにより自動付与するフィールド 3.4.1.6.

取得したデータにはデータ登録時に自動付与された以下フィールドが付与されます。

項番ステータスコードとその概要

_id ドキュメントのオブジェクト ID。一意な ID が自動付与される

_date COLMINA PF にリクエストデータが受信した時刻。UTC 時刻 ISO8601 形式

11 エラーメッセージとどちらか一方が設定される。 12 レスポンス情報とどちらか一方が設定される。


22

（UTC ミリ秒精度)

_resource_path COLMINA ポータルのデータ受信設定（非構造化データ）で作成したリソースパ

ス

処理結果コード(ステータスコード) 3.4.1.7.

項番ステータスコードとその概要処理結果コード処理結果コードの内容

1 200：正常 200 正常終了

2 400：引数不正 400 リクエスト情報に誤りがあった場

合

3 401：認証エラー 401 認証失敗（アクセストークンの有効

期限切れを含む）

API キー認証失敗

4 403：権限エラー 403 リソースへのアクセス権限なし

5 404：リソース未検出 404 アクセス先のリソースが存在しな

い

該当テナントで契約されていない

サービスへのアクセス

6 408：リクエストタイムアウト 408 リクエストは受け付けたがリクエ

スト情報が受信できなかった場合

7 429：レート制限 429 一時的な大量アクセスが発生

API コール数が規定値に到達

8 500：内部エラー 500 内部エラーが発生した場合

9 502：不正なゲートウェイ 502 COLMINA プラットフォーム内の

ネットワーク異常を検知した場合

10 503：サービス利用不可 503 COLMINA プラットフォームが高

負荷な状態またはメンテナンスに

より一時的に利用できない状態の

場合

11 504：ゲートウェイタイムアウト 504 COLMINA プラットフォーム内の

ネットワークまたはサーバの異常

を検知した場合

APIリクエストサンプルとその結果 3.4.1.8.


$ curl -X GET

‘https://{FQDN}/v1/core/nosql/{tenant_id}/core/mil-a?$top=100&$filter=_date+ge+20170701T000

000.000Z&$orderby=_date+asc' -H 'X-Api-Key:{API キー}' -H 'Authorization:Basic {Base64エンコ

ードされた認証情報}' -i -s

(２) 処理結果例(正常・件数)

(３) 処理結果例(正常・実データ)

2

[

{ "_id" : "58b92bd46f425bea07bbde67",

"_date" : "20170701T110000.123Z",

"_resource_path" : "colmina/core/mil-a",

"key1" : "value1"

} ,

{ "_id" : "58b92bd46f425bea07bbde68",


23

(４) 処理結果例(異常)

"_date" : "20170701T110000.456Z",

"_resource_path" : "colmina/core/mil-a",

"key2" : "value2"

}

]

{

"errors":[

{

"message":"Resource Data DB operation timeout. " ,

"code": "MIID703W001"

}

]

}


24

NoSQLデータ登録 API 3.4.2.

一件の非構造化データを登録するための API 情報を以下に示します。


Parameters 値

Method POST


パス}













コンテンツタイプリクエストボディの形式 M

コンテンツサイズリクエストボディのサイズ M




25

URI指定パラメータ/HTTPヘッダ/ Body概要情報データの内容制限 3.4.2.4.


URIに設定



まで)



スの種類



ント ID


様の COLMINA



ベース情報




リクエスト

ヘッダ


ation


情報





7 コンテンツタイ

プ

Content-

Type

リクエストボディ

の形式


"application/json;

charset=UTF-8" ( 固

定)


ズ

Content-

Length


のサイズ

数値 10 （利用者の入力）ボデ

ィのデータ長[byte]


y



の API キー


様の COLMINA



ボディ

10 登録データ－ JSON 形式の登録

データ


コレクションに登録さ

れる非構造化データ

JSON 形式、

ドキュメントIDは自動

採番されます

レスポンス

11 ステータス

コード

status_co

de


タスコード



ード

ヘッダ

12 コンテンツ

タイプ

Content-

Type


の形式


"application/json;



データベース名：core / smpf


26


ズ

Content-

Length


のサイズ



[byte]



る

ボディ


ジ16





リクエストボディの登録データ

以下を含む JSON形式のデータの登録は未対応です。

ボディに指定した場合、ステータスコード 400 を応答します。

・key の先頭が"$"

・key に"."（ピリオド）を含む

・key に null 文字を含む

・インデックス設定 key の値が BSON 型で 1,024byte を超過



1 201：正常 201 正常終了

2 400：引数不正 400 リクエスト情報に誤りがあった場合

3 401：認証エラー 401 認証失敗（アクセストークンの有効期

限切れを含む）



5 404：リソース未検出 404 アクセス先のリソースが存在しない

該当テナントで契約されていないサ

ービスへのアクセス

6 408：リクエストタイムアウト 408 リクエストは受け付けたがリクエス

ト情報が受信できなかった場合




9 502：不正なゲートウェイ 502 COLMINA プラットフォーム内のネ

ットワーク異常を検知した場合

10 503：サービス利用不可 503 COLMINA プラットフォームが高負

荷な状態またはメンテナンスにより

一時的に利用できない状態の場合

11 504：ゲートウェイタイムアウト 504 COLMINA プラットフォーム内のネ

ットワークまたはサーバの異常を検

知した場合

16 正常終了時は設定されません。


27



$ curl -X POST 'https://{FQDN}/v1/core/nosql/{tenant_id}/core/mil-a' -H 'Content-Type:

application/json; charset=UTF-8' -H 'X-Api-Key:{APIキー}' -H 'Authorization:Basic {Base64エン

コードされた認証情報}' -d '{ JSON データ }' -i -s

(２) 処理結果例(正常)

なし

(３) 処理結果例(異常)

{"errors":

[

{



}

]

}


28

NoSQLデータ更新 API 3.4.3.

一件の非構造化データを更新するための API 情報を以下に示します。


Parameters 値

Method PUT


パス}


















29



URIに設定



まで)



スの種類



ント ID


様の COLMINA



ベース情報



レクション名}19/{オブ

ジェクト ID20}/

リクエスト

ヘッダ


ation


情報






プ

Content-

Type


の形式


"application/json;

charset=UTF-8" ( 固

定)


ズ

Content-

Length


のサイズ




y



の API キー


様の COLMINA



ボディ

10 更新データ－ JSON 形式の更新

データ


コレクションで更新さ

れる非構造化データ

JSON 形式

レスポンス

11 ステータス

コード

status_co

de


タスコード



ード

ヘッダ

12 コンテンツ

タイプ

Content-

Type


の形式


"application/json;


13 コンテンツサイ Content- レスポンスボディ数値 10 （システムにて設定）


データベース名：core / smpf 20 データ登録時に自動採番された_id を設定します。


30

ズ Length のサイズボディのデータ長

[byte]



る

ボディ


ジ21





リクエストボディの更新データ

以下を含む JSON形式のデータの登録は未対応です。

ボディに指定した場合、ステータスコード 400 を応答します。

・keyの先頭が"$"

・keyに"."（ピリオド）を含む

・keyに null文字を含む

・インデックス設定 keyの値が BSON型で 1024byteを超過



31



1 204：正常 204 正常終了

2 400：引数不正 400 リクエスト情報に誤りがあった場

合

3 401：認証エラー 401 認証失敗（アクセストークンの有

効期限切れを含む）



5 404：リソース未検出 404 アクセス先のリソースが存在しな

い

該当テナントで契約されていない

サービスへのアクセス

6 408：リクエストタイムアウト 408 リクエストは受け付けたがリクエ

スト情報が受信できなかった場合

7 409：競合 409 他のリクエストによってドキュメ

ントの操作ができない




10 502：不正なゲートウェイ 502 COLMINA プラットフォーム内

のネットワーク異常を検知した場

合

11 503：サービス利用不可 503 COLMINA プラットフォームが

高負荷な状態またはメンテナンス

により一時的に利用できない状態

の場合

12 504：ゲートウェイタイムアウト 504 COLMINA プラットフォーム内

のネットワークまたはサーバの異

常を検知した場合



$ curl -X PUT 'https://{FQDN}/v1/core/nosql/{tenant_id}/core/mil-a/201707031230-edge0001' -H

'Content-Type: application/json; charset=UTF-8' -H 'X-Api-Key:{APIキー}' -H

'Authorization:Basic {Base64エンコードされた認証情報}' -d '{ JSONデータ }' -i -s


なし


{"errors":

[

{



}

]

}


32

NoSQLデータ削除 API 3.4.4.

検索条件と一致した非構造化データを削除するための API 情報を以下に示します。


Parameters 値

Method DELETE


パス}
















検索条件データの検索条件 M



33



URIに設定



まで)



スの種類



ント ID


様の COLMINA



ベース情報




リクエスト

ヘッダ


ation


情報






y



の API キー


様の COLMINA



クエリ

8 検索条件 $filter データの検索条件文字列 1894 （利用者の入力）




and/or で複数記述可

「（」、「）」で条件式に

優先度を指定する記述

可27。

要素に指定する key は

インデックスが設定さ

れている key の指定を

推奨28。

レスポンス

9 ステータス

コード

status_

code


タスコード



ード


データベース名：core / smpf 26 _date 項目の場合は ISO8601 形式「YYYYMMDDThhmmss.SSSZ」に従います

（例: 20170920T142518.000Z）。 27 「（」、「）」は入れ子構造の指定も可、内側の括弧から順に評価されます。

入れ子構造で指定する場合、最大 5 階層までの指定を許容します。 28 インデックスが未設定の key を指定する場合、データ検索に時間がかかる可能性があります


34

ヘッダ

10 コンテンツ

タイプ

Conte

nt-Ty

pe


の形式


"application/json;


11 コンテンツサイズ Conte

nt-Le

ngth


のサイズ



[byte]



る

ボディ

12 エラーメッセージ29 処理が失敗した場





項

番


1 204：正常 204 正常終了







該当テナントで契約されていないサ

ービスへのアクセス

6 408：リクエストタイムアウト 408 リクエストは受け付けたがリクエス

ト情報が受信できなかった場合

7 409：競合 409 他のリクエストによってドキュメン

トの操作ができない




10 502：不正なゲートウェイ 502 COLMINA プラットフォーム内のネ

ットワーク異常を検知した場合

11 503：サービス利用不可 503 COLMINA プラットフォームが高負

荷な状態またはメンテナンスにより

一時的に利用できない状態の場合

12 504：ゲートウェイタイムアウト 504 COLMINA プラットフォーム内のネ

ットワークまたはサーバの異常を検

知した場合



$ curl -X DELETE 'https://{FQDN}/v1/core/nosql/{tenant_id}/core/mil-a/?$filter=_date+lt+



35

20170701T000000.000Z' -H 'X-Api-Key:{APIキー}' -H 'Authorization:Basic {Base64エンコードされ

た認証情報}' -i -s


なし


{"errors":

[

{



}

]

}


36

データレイク API（RDB） 3.5.

RDBデータ取得 API 3.5.1.

検索条件と一致した構造化データの一覧を取得するための API 情報を以下に示します。


Parameters 値

Method GET


パス}







データソース種別 rdb 固定 M







データ形式取得されるデータの形式、JSON 又は CSV を選択できます O



取得件数検索条件に該当するデータの先頭からの取得件数 O

スキップ件数検索条件に該当するデータの先頭からのスキップ件数 O

検索条件データの検索条件 O

ソート順指定取得データのソート順 O

件数取得検索条件に該当するデータ件数を取得 O



37



URIに設定



まで)



スの種類

文字列－ rdb(固定)


ント ID


様の COLMINA



ベース情報


{データベース名}/{ス

キーマ名}/{テーブル

ID}

データベース名:cii00

固定

スキーマ名:sc + テナ

ント ID(※) + 00

※テナント IDに含まれ

る英大文字は英小文字

に読み替える

リクエスト

ヘッダ


ation


情報






y



の API キー


様の COLMINA



8 データ形式 Accept 取得されるデータ

の形式


JSON 形式の場合：

"application/json"

CSV 形式の場合：

"text/csv"

省略時は JSON 形式と

して動作する

クエリ

9 取得件数 $top 検索条件に該当す


らの取得件数


1～20,000

省略時は上限なしとし

て動作する

10 スキップ件数 $skip 検索条件に該当す


らのスキップ件数


1～2,147,483,647

省略時は$skip=0 とし

て動作する



38





省略時は検索条件なし


12 ソート順指定 $orderby 取得データのソー

ト順


ソート順を指定、

“ソート対象 key スペ

ースソート順”で記

述。

ソート順で指定できる

のは“asc”(昇順)又は”

desc”（降順）のみ。

許容外を指定した場合

は NG 応答。

省略時は

$orderby=_date asc と

して動作する

13 件数取得 $count 検索条件に該当す

るデータ件数を取

得


true/false を指定可能、

true 指定時に件数を取

得する。

省略時は$count=false


レスポンス

14 ステータス

コード

status_co

de


タスコード



ード

ヘッダ

15 コンテンツ

タイプ

Content-

Type


の形式


データ件数取得時：

"text/plain;

charset=UTF-8"

JSON 形式指定時：

"application/json;

charset=UTF-8"

CSV 形式指定時：

"text/csv;

charset=UTF-8"


ズ

Content-

Length


のサイズ



[byte]

33日時項目の場合は利用者が登録したテーブル定義により以下の形式に従います。




（例：20170920T142518.003Z または 20170920T142518.003+0900）


39



る

ボディ

17 レスポンス情報34 －検索結果文字列－（システムにて設定）

件数取得時：

取得した件数

JSON 形式指定時：

検索条件に該当したデ

ータの配列

CSV 形式指定時：

検索条件に該当したデ

ータ35

18 データ <項目名> JSON 形式指定時

のみ、レコードの

オブジェクト


項目名がキー、項目値36

を値のプロパティを持

つ


ジ37

errors 処理失敗要因のエ

ラー情報


JSON 形式の配列

20 メッセージ message 処理失敗要因のエ

ラーメッセージ


処理失敗要因のエラー

メッセージ

21 コード code 処理失敗要因のエ

ラーメッセージ ID


例：

“MIID702W016”


項

番


1 200：正常 200 正常終了







該当テナントで契約されていないサー

ビスへのアクセス

6 406：許容外 406 サポートされていないレスポンスのデ

ータ形式

7 408：リクエストタイムアウト 408 リクエストは受け付けたがリクエスト

情報が受信できなかった場合

34 エラーメッセージとどちらかが設定されます。 35 CSV データはヘッダなし、カンマ「,」区切り、二重引用符「"」括りの形式になります。


属性が timestamp(タイムゾーン無)型：YYYY-MM-DD hh:mm:ss.SSS（例：2017-09-20 14:25:18.003）

属性が timestamptz(タイムゾーン有)型：YYYYMMDDThhmmss.SSSZ（例：20170920T142518.003Z） 37 レスポンス情報とどちらかが設定されます。


40




10 503：サービス利用不可 503 COLMINAプラットフォームが高負荷

な状態またはメンテナンスにより一時

的に利用できない状態の場合

11 504：ゲートウェイタイムアウト 504 COLMINAプラットフォーム内のネッ

トワークまたはサーバの異常を検知し

た場合



$ curl -X GET

'https://{FQDN}/v1/core/rdb/{tenant_id}/cii00/sc{tenant_id}00/tiid604_usercreatexxx?$top=100&

$filter=col1+ge+20170701T000000.000Z&$orderby=col1+asc' -H 'X-Api-Key:{APIキー}' -H

'Authorization:Basic {Base64エンコードされた認証情報}' -i -s

(２) 処理結果例(正常・件数)

2

(３) 処理結果例(正常・実データ(CSV))

"20170901T000000.000Z","valA2","20170101T000000.000Z"

"20171001T000000.000Z","valB2","20170101T000000.000Z"

(４) 処理結果例(正常・実データ(JSON))

[

{

"col1": "20170901T000000.000Z",

"col2": "valA2",

"reg_datetime": "20170101T000000.000Z"

},

{

"col1": "20171001T000000.000Z",

"col2": "valB2",

"reg_datetime": "20170101T000000.000Z"

}

]

(５) 処理結果例(異常)

{

"errors":[

{

"message":"Records are more than 20,000",

"code":"MIID702W016"

}

]

}


41

RDBデータ登録 API 3.5.2.

一件の構造化データを登録するための API 情報を以下に示します。


Parameters 値

Method POST


パス}


















42



URIに設定



まで)



スの種類



ント ID


様の COLMINA



ベース情報




ID}


固定


ント ID(※) + 00



に読み替える

リクエスト

ヘッダ


ation


情報






プ

Content-

Type


の形式


"application/json;



ズ

Content-

Length


のサイズ




y



の API キー


様の COLMINA



ボディ

10 登録値 <項目名> 登録するレコード

のオブジェクト

文字列－（利用者の入力）登録

する JSON 形式の文字

列、項目名がキーで項

目値40を値のプロパテ


属性が timestamp(タイムゾーン無)型：YYYY-MM-DD hh:mm:ss.SSS（例：2017-09-20 14:25:18.003）

属性が timestamptz(タイムゾーン有)型：YYYYMMDDThhmmss.SSSZ または

YYYYMMDDThhmmss.SSS±hhmm

（例：20170920T142518.003Z または 20170920T142518.003+0900）


43

ィを持つ

レスポンス

11 ステータス

コード

status_co

de


タスコード



ード

ヘッダ

12 コンテンツ

タイプ41

Content-

Type


の形式


"application/json;



ズ42

Content-

Length


のサイズ



[byte]



る

ボディ


ジ43


ラー情報







メッセージ




例：

“MIID702W016”


項

番


1 201：正常 201 正常終了











7 409：競合 409 同じレコード ID を持つドキュメント

が存在する




41 正常終了時は設定されません。 42 正常終了時は設定されません。 43 正常終了時は設定されません。


44






た場合



$ curl -X POST

'https://{FQDN}/v1/core/rdb/{tenant_id}/cii00/sc{tenant_id}00/tiid604_usercreatexxx' -H

'Content-Type: application/json; charset=UTF-8' -H 'X-Api-Key:{APIキー}' -H 'Authorization:Basic

{Base64 エンコードされた認証情報}' -d '{ JSONデータ }' -i -s


なし


{

"errors": [

{

"message": "No such table:TABLE_X",


}

]

}


45

RDBデータ更新 API 3.5.3.

一件の構造化データを更新するための API 情報を以下に示します。


Parameters 値

Method PUT


パス}


















46



URIに設定



まで)



スの種類



ント ID


様の COLMINA



ベース情報




ID}


固定


ント ID(※) + 00



に読み替える

リクエスト

ヘッダ


ation


情報






プ

Content-

Type


の形式


"application/json;



ズ

Content-

Length


のサイズ




y



の API キー


様の COLMINA



ボディ

10 登録値 <項目名> 更新するレコード

のオブジェクト

文字列－（利用者の入力）更新

する JSON 形式の文字

列、項目名がキーで項

目値46を値のプロパテ





（例：20170920T142518.003Z または 20170920T142518.003+0900）


47

ィを持つ

レスポンス

11 ステータス

コード

status_co

de


タスコード



ード

ヘッダ

12 コンテンツ

タイプ47

Content-

Type


の形式


"application/json;



ズ48

Content-

Length


のサイズ



[byte]



る

ボディ


ジ49


ラー情報







メッセージ




例：

“MIID702W016”


項

番


1 204：正常 204 正常終了











7 409：競合 409 他のリクエストによってドキュメント

の操作ができない






48






た場合



$ curl -X PUT

'https://{FQDN}/v1/core/rdb/{tenant_id}/cii00/sc{tenant_id}00/tiid604_usercreatexxx' -H

'Content-Type: application/json; charset=UTF-8' -H 'X-Api-Key:{APIキー}' -H 'Authorization:Basic

{Base64 エンコードされた認証情報}' -d '{ JSONデータ }' -i -s


なし


{

"errors": [

{

"message": "No such table:TABLE_X",


}

]

}


49

RDBデータ削除 API 3.5.4.

検索条件と一致した構造化データを削除するための API 情報を以下に示します。


Parameters 値

Method DELETE


パス}
















検索条件データの検索条件 M



50



URIに設定



まで)



スの種類



ント ID


様の COLMINA



ベース情報




ID}


固定


ント ID(※) + 00



に読み替える

リクエスト

ヘッダ


ation


情報






y



の API キー


様の COLMINA



クエリ






レスポンス

9 ステータス

コード

status_co

de


タスコード







（例：20170920T142518.003Z または 20170920T142518.003+0900）


51

ード

ヘッダ

10 コンテンツ

タイプ54

Content-

Type


の形式


"application/json;



ズ55

Content-

Length


のサイズ



[byte]



る

ボディ


ジ56


ラー情報







メッセージ




例：

“MIID702W016”


項

番


1 204：正常 204 正常終了


3 401：認証エラー 401 認証失敗（アクセストークンの有効期限

切れを含む）








7 409：競合 409 他のリクエストによってドキュメント

の操作ができない




10 503：サービス利用不可 503 COLMINA プラットフォームが高負荷



11 504：ゲートウェイタイムアウト 504 COLMINA プラットフォーム内のネッ




52

た場合

注意事項 3.5.4.7.

削除するデータが Intelligent Dashboardの集計対象期間に含まれる場合、データの不整合が発生する可

能性があります。



$ curl -X DELETE

'https://{FQDN}/v1/core/rdb/{tenant_id}/cii00/sc{tenant_id}00/tiid604_usercreatexxx?$filter=c

ol1+lt+20170701T000000.000Z' -H 'X-Api-Key:{API キー}' -H 'Authorization:Basic {Base64 エンコー

ドされた認証情報}' -i -s


なし


{

"errors": [

{

"message": "No such table: tiix999_t_table_name ",


}

]

}

以上

COLMINA Platform APIリファレンス - FujitsuAPI のサービスを利用するためには、API...

Documents

Transcript of COLMINA Platform APIリファレンス - FujitsuAPI のサービスを利用するためには、API...