Big Data Integration ServerV1.7.0 EDI連携/DB連携編ユーザーズガイド

3.3.1 データ提供設定に関するAPI

3.3.1.1 データ提供設定変更機能API

指定された事業者の提供設定を新規作成または上書きします。上書きは削除を行った後に新規作成を行うことと等価です。

3.3.1.1.1 リクエストフォーマット

項目		値		備考
APIエンドポイント（相対URI）		/{companyId}/provide/{id}		{companyId} 企業識別子を下記の条件を満たす文字列で指定します 半角英数字(a～z、0～9) {id} データ提供設定毎に異なる一意の情報識別子を下記の条件を満たす文字列で指定します 半角英数字(a～z、0～9) ここで指定する値は、上書きや削除をする際に使用しますので記録してください
HTTPメソッド		PUT
HTTPリクエストヘッダ	Content-type	application/json; charset=UTF-8		取り扱うデータ形式
	tenantid	任意	テナントID	認証サービスで認証をする場合、本パラメータを指定します 認証サービスのテナントID
	userid	任意	ユーザーID	認証サービスで認証をする場合、本パラメータを指定します 認証サービスの利用者ID
	Authorization	任意	認証トークン	認証サービスで認証をする場合、本パラメータを指定します 認証サービスから取得したBearerトークン
	apikey	任意	APIキー	APIキーで認証をする場合、本パラメータを指定します システム管理者が指定したAPIキー
HTTPリクエストボディ	type	必須	データ連携のI/F種別（PUTによる上書きは不可）	"db"を指定します
	title	必須	情報タイトル（PUTによる上書きは不可）	文字列長：1～255文字で指定します
	db_connect_id	必須	DB接続設定識別子（PUTによる上書きは不可）	形式：半角英数字で指定します 文字列長：1～100文字で指定します
	table_id	必須	提供元テーブル識別子（提供設定）/ 格納先テーブル識別子（利用設定）（PUTによる上書きは不可）	形式：半角英数字、アンダーライン記号、ピリオド記号で指定します 文字列長：1～255文字で指定します
	store_api_param	必須	データ格納準備API、データアップロードAPIに渡すパラメータセット	以下のパラメータを指定します パラメータの詳細は“2.5 格納抽出API”を参照してください data_type src_location_code dst_location_code conv_rule_idまたはconv_rule_file_path

例)

curl -i -s -X PUT http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/{companyId}/provide/{id} \
-H "Content-Type:application/json; charset=UTF-8" \
-H 'tenantid:febtenant-sampleti-62' \
-H 'userid: user1' \
-H 'Authorization: Bearer auth-token' \
-d '{
  "type": "db",
  "title": "aのデータ",
  "db_connect_id": "1",
  "table_id": "triggertest.provide_trigger",
  "store_api_param": {
    "data_type": "10",
    "src_location_code": "1234567890123",
    "dst_location_code": "1234567890321",
    "conv_rule_file_path": "/var/tmp/store.any"
  }
}'

注) システム管理者から提供された情報を指定

ポイント

変換ルールについて

データ提供の場合、DBテーブルにINSERTされたレコードデータはCSV形式データファイルに変換され、その後に変換ルールが適用されます。そのため、データ提供者はEDI連携機能により“DBテーブル定義のCSV形式データファイル”から“情報区分コード(data_type)のデータフォーマット”に変換させる変換ルールを作成し、データ提供設定でその変換ルールを指定する必要があります。レコードデータのCSV形式データファイルは、以下のCOPYコマンドで取得されるデータフォーマットとします。PostgreSQLのCOPYコマンドの仕様については公式マニュアルを参照してください。

COPY {テーブル名} TO {出力先ファイルパス} WITH DELIMITER ‘,’;

運用前に、指定した変換ルールによってデータ変換が正しく実施されることを確認するために、疎通としてデータ提供用の業務DBにデータを投入し、データ利用者用の業務DBへデータが反映されることを確認してください。

3.3.1.1.2 レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200、異常時は後述
HTTPレスポンスヘッダ	Access-Control-Allow-Origin	*
	Content-Type	application/json; charset=utf-8
	Content-Length	データ長
	ETag	エンティティタグ
	Date	日付
	Connection	通信オプション
	Keep-Alive	タイムアウト値
HTTPレスポンスボディ	id	情報識別子
	provide_param	データ提供設定変更機能・データ提供設定照会機能で扱う情報	リクエストボディで指定した値が表示されます

例)

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
Content-Length: 281
ETag: W/"119-+ZyGVgBAmoAmpM7f27tkPl7ggow"
Date: Wed, 11 Jan 2023 02:26:33 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{"id":"id001","provide_param":{"type":"db","title":"aのデータ","db_connect_id":"1","table_id":"triggertest.provide_trigger","store_api_param":{"data_type":"10","src_location_code":"1234567890123","dst_location_code":"1234567890321","conv_rule_file_path":"/var/tmp/store.any"}}}

3.3.1.1.3 HTTPステータスコード

HTTPステータスコード	利用場面
200	データ提供設定情報の新規作成または上書きが成功した。
400	リクエストがAPIリファレンスに準拠していない。
401	統合認証基盤の認証に失敗しました。認証情報に誤りがある。
403	統合認証情報基盤の認証には成功しましたが、認可処理に失敗した。指定したcompanyIdが存在しないか、権限を持っていない。
405	許可されていないHTTPメソッドが指定されている。
500	サーバで予期せぬエラーが発生した。
503	サーバで一時的にAPIの処理を行うことができない。
504	リクエスト処理の実行中にタイムアウトした。

3.3.1.1.4 メッセージボディ

HTTPステータスコード	メッセージボディ
200	リソースの内容を表示する。
400/500番台	エラーコードと説明文を表示する。

3.3.1.1.5 エラーメッセージ

形式

分類	内容
code	エラーの詳細な種類
message	エラーメッセージ本文

例)

{
  "code": "001",
  "message": "The request did not conform to API reference."
}

エラーリスト

HTTPステータスコード	エラーコード	内容	意味
400	001	The request did not conform to API reference.	リクエストがAPIリファレンスに準拠していませんでした
401	002	The account was failed to authorize.	アカウントの認証に失敗しました
403	003	The account was not allowed to request the API.	アカウントはAPIのリクエストを許可されていませんでした
405	005	The HTTP method was not allowed.	HTTPメソッドは許可されていません
500	006	Internal server error occured.	内部サーバエラーが発生しました
503	007	The request could not be processed temporarily.	リクエストを一時的に処理できませんでした
504	008	Gateway Timeout	リクエストがタイムアウトしました

3.3.1.2 データ提供設定削除機能API

指定された事業者のデータ提供設定を削除します。

3.3.1.2.1 リクエストフォーマット

項目		値		備考
APIエンドポイント（相対URI）		/{companyId}/provide/{id}		{companyId} 企業識別子を下記の条件を満たす文字列で指定します 半角英数字(a～z、0～9) {id} データ提供設定毎に異なる一意の情報識別子を下記の条件を満たす文字列で指定します 半角英数字(a～z、0～9)
HTTPメソッド		DELETE
HTTPリクエストヘッダ	tenantid	任意	テナントID	認証サービスで認証をする場合、本パラメータを指定します 認証サービスのテナントID
	userid	任意	ユーザーID	認証サービスで認証をする場合、本パラメータを指定します 認証サービスの利用者ID
	Authorization	任意	認証トークン	認証サービスで認証をする場合、本パラメータを指定します 認証サービスから取得したBearerトークン
	apikey	任意	APIキー	APIキーで認証をする場合、本パラメータを指定します システム管理者が指定したAPIキー

例)

curl -i -s -X DELETE http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/{companyId}/provide/{id} \
-H 'tenantid:febtenant-sampleti-62' \
-H 'userid: user1' \
-H 'Authorization: Bearer auth-token'

注) システム管理者から提供された情報を指定

3.3.1.2.2 レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時204、異常時は後述
HTTPレスポンスヘッダ	Access-Control-Allow-Origin	*
	Date	日付
	Connection	通信オプション
	Keep-Alive	タイムアウト値

例)

HTTP/1.1 204 No Content
Access-Control-Allow-Origin: *
Date: Wed, 11 Jan 2023 02:30:23 GMT
Connection: keep-alive
Keep-Alive: timeout=5

3.3.1.2.3 HTTPステータスコード

HTTPステータスコード	利用場面
204	データ提供設定情報の削除に成功した。
400	リクエストがAPIリファレンスに準拠していない。
401	統合認証基盤の認証に失敗した。認証情報に誤りがある。
403	統合認証情報基盤の認証には成功したが、認可処理に失敗した。指定したcompanyIdが存在しないか、権限を持っていない。
404	サーバがリクエストされたリソースを発見できない。指定したidに誤りがある。
405	許可されていないHTTPメソッドが指定されている。
500	サーバで予期せぬエラーが発生した。
503	サーバで一時的にAPIの処理を行うことができない。
504	リクエスト処理の実行中にタイムアウトした。

3.3.1.2.4 メッセージボディ

HTTPステータスコード	メッセージボディ
204	リクエストが成功したことをHTTPステータスで表示
400/500番台	エラーコードと説明文を表示する。

3.3.1.2.5 エラーメッセージ

形式

分類	内容
code	エラーの詳細な種類
message	エラーメッセージ本文

例)

{
  "code": "001",
  "message": "The request did not conform to API reference."
}

エラーリスト

HTTPステータスコード	エラーコード	内容	意味
400	001	The request did not conform to API reference.	リクエストがAPIリファレンスに準拠していませんでした
401	002	The account was failed to authorize.	アカウントの認証に失敗しました
403	003	The account was not allowed to request the API.	アカウントはAPIのリクエストを許可されていませんでした
404	004	The resource could not be found.	リソースが見つかりませんでした
405	005	The HTTP method was not allowed.	HTTPメソッドは許可されていません
500	006	Internal server error occured.	内部サーバエラーが発生しました
503	007	The request could not be processed temporarily.	リクエストを一時的に処理できませんでした
504	008	Gateway Timeout	リクエストがタイムアウトしました

3.3.1.3 データ提供設定照会機能API

指定された事業者のデータ提供設定を取得します。

3.3.1.3.1 リクエストフォーマット

項目		値		備考
APIエンドポイント（相対URI）		/{companyId}/provide/{id}		{companyId} 企業識別子を下記の条件を満たす文字列で指定します 半角英数字(a～z、0～9) {id} データ提供設定毎に異なる一意の情報識別子を下記の条件を満たす文字列で指定します 半角英数字(a～z、0～9) {id}を指定しない場合、{companyId}で指定した事業者の全てのデータ提供設定を取得します
HTTPメソッド		GET
HTTPリクエストヘッダ	Content-type	application/json; charset=UTF-8		取り扱うデータ形式
	tenantid	任意	テナントID	認証サービスで認証をする場合、本パラメータを指定します 認証サービスのテナントID
	userid	任意	ユーザーID	認証サービスで認証をする場合、本パラメータを指定します 認証サービスの利用者ID
	Authorization	任意	認証トークン	認証サービスで認証をする場合、本パラメータを指定します 認証サービスから取得したBearerトークン
	apikey	任意	APIキー	APIキーで認証をする場合、本パラメータを指定します システム管理者が指定したAPIキー

例)

curl -i -s -X GET http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/{companyId}/provide/{id} \
-H "Content-Type:application/json; charset=UTF-8" \
-H 'tenantid:febtenant-sampleti-62' \
-H 'userid: user1' \
-H 'Authorization: Bearer auth-token'

注) システム管理者から提供された情報を指定

3.3.1.3.2 レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時200、異常時は後述
HTTPレスポンスヘッダ	Access-Control-Allow-Origin	*
	Content-Type	application/json; charset=utf-8
	Content-Length	データ長
	ETag	エンティティタグ
	Date	日付
	Connection	通信オプション
	Keep-Alive	タイムアウト値
HTTPレスポンスボディ	id	情報識別子
	provide_param	データ提供設定変更・照会機能で扱う情報	リクエストボディで指定した値が表示されます

例)

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
Content-Length: 281
ETag: W/"119-qKmmMfxpH+UUGDmGxCT8jY1gTmM"
Date: Wed, 11 Jan 2023 02:29:26 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{"id":"id001","provide_param":{"type":"db","title":"aのデータ","table_id":"triggertest.provide_trigger","db_connect_id":"1","store_api_param":{"data_type":"10","src_location_code":"1234567890123","dst_location_code":"1234567890321","conv_rule_file_path":"/var/tmp/store.any"}}}

3.3.1.3.3 HTTPステータスコード

HTTPステータスコード	利用場面
200	データ提供設定情報の照会に成功した。
400	リクエストがAPIリファレンスに準拠していない。
401	統合認証基盤の認証に失敗しました。認証情報に誤りがある。
403	統合認証情報基盤の認証には成功したが、認可処理に失敗した。指定したcompanyIdが存在しないか、権限を持っていない。
405	許可されていないHTTPメソッドが指定されている。
500	サーバで予期せぬエラーが発生した。
503	サーバで一時的にAPIの処理を行うことができない。
504	リクエスト処理の実行中にタイムアウトした。

3.3.1.3.4 メッセージボディ

HTTPステータスコード	メッセージボディ
200	リソースの内容を表示する。
400/500番台	エラーコードと説明文を表示する。

3.3.1.3.5 エラーメッセージ

形式

分類	内容
code	エラーの詳細な種類
message	エラーメッセージ本文

例)

{
  "code": "001",
  "message": "The request did not conform to API reference."
}

エラーリスト

HTTPステータスコード	エラーコード	内容	意味
400	001	The request did not conform to API reference.	リクエストがAPIリファレンスに準拠していませんでした
401	002	The account was failed to authorize.	アカウントの認証に失敗しました
403	003	The account was not allowed to request the API.	アカウントはAPIのリクエストを許可されていませんでした
405	005	The HTTP method was not allowed.	HTTPメソッドは許可されていません
500	006	Internal server error occured.	内部サーバエラーが発生しました
503	007	The request could not be processed temporarily.	リクエストを一時的に処理できませんでした
504	008	Gateway Timeout	リクエストがタイムアウトしました