Publish Data REST API
Cloud Integration HubのPublish Data REST APIを使用して、データトランザクションをCloud Integration Hubパブリケーションリポジトリのトピックに直接パブリッシュします。
Publish Data APIを使用すると、APIを使用してトピックにデータを直接パブリッシュするパブリケーションでデータをパブリッシュできます。Data IntegrationタスクをトリガするパブリケーションにAPIを使用することはできません。
API経由でデータをパブリッシュするには、Cloud Integration Hubの[パブリケーション]ページからAPIのURLをコピーします。
注: プライベートパブリケーションリポジトリを使用する場合、パブリケーションリポジトリサービスが実行するSecure Agentまたはパブリケーションリポジトリのポート番号を変更すると、APIのURLもそれに従い変更されます。この場合、APIユーザーおよび新しいURLのコンシューマに、必ず通知するようにします。
- 要求ヘッダー
- 要求に次のヘッダーを含めます。
Accept - application/json
Content-Type - application/json
- UTF-8文字エンコードをサポートする(例えば、テーブル名およびカラム名に日本語の文字を使用する)には、要求に次のヘッダーを含めます。
Accept-Charset: charset=utf-8
Content-Type: application/json;charset=utf-8
- 要求構文
- トピックにデータを直接パブリッシュするには、次の構文を使用します。
{
"<table_name>":
[
{"<column_name>":"<data>"}
]
}
トピックテーブルの名前は英文字またはアンダースコアで開始する必要があり、ASCIIの英数字およびアンダースコアのみを含めることができます。名前はCloud Integration Hubリポジトリ内で一意でなければなりません。
例:
{
"Sales":
[
{"Opportunity_Name":"string”,"Opportunity_Owner_Id":"string"}
],
"Orders":
[
{"Account_Name":"string","Account_Id":"string","OrderId": "string"}
]
}
- DATETIMEフィールド
- パブリッシュ先のトピックにDATETIMEフィールドが含まれている場合、DATETIME値に次の形式を使用する必要があります: yyyy-MM-dd HH:mm:ss.SSS。
Publish Data REST APIアクションの応答
Cloud Integration HubのPublish Data REST APIを使用してデータを直接トピックにパブリッシュすると、Cloud Integration Hubは、REST APIの応答で実行したアクションの応答コードを返します。
REST APIを使用してデータをパブリッシュすると、次の応答コードのいずれかを返します。
- •SUCCESS。Cloud Integration Hubはデータを正常にパブリッシュしました。ステータスメッセージには、Cloud Integration Hubが生成するパブリケーションイベントのイベントID、受け入れられた行の数、および正常に処理された行の数が含まれます。
- •FAILED。Cloud Integration Hubはデータをパブリッシュできませんでした。
注: データをPublish Data REST API経由でプライベートパブリケーションリポジトリにパブリッシュし、パブリケーションリポジトリサービスにアクセスできなかったために失敗した場合、Cloud Integration Hubは呼び出し元のアプリケーションにエラーを返し、エラーイベントを作成しません。
トピックのSwagger構造(Publish Data REST API)
Publish Data REST APIは、パブリケーションがデータをパブリッシュするトピックのSwagger構造を返します。
Swagger構造を表示するには、Cloud Integration Hubの[パブリケーション]ページから構造のURLをコピーします。