API 使用マニュアル

PlantPulse Java API クライアントライブラリ(plantpulse-api)の完全な使用マニュアルです。13個のドメインサービスを通じて、サイト・資産・タグ・アラーム・作業指示など、Platformのすべてのマスタ/運用データにアクセスできます。

ライブラリの特徴

標準 REST — GET/POST/PUT/PATCH/DELETE メソッドを意味に合わせて使用
型 DTO — すべてのリクエスト・レスポンスが *RequestV5 / *ResponseV5 クラスに自動マッピング (JSONObject の手動パース不要)
タブ別 PATCH — タグのアラーム・メタデータ・計算・集計など、部分修正10種をサポート
13個のドメインサービス — system, site, customer, employee, product, asset, opc, tag, alarm, order, calendar, path, flow
安全なデフォルト値 — 失敗時に null または空リストを返却 (例外 throw なし)

このマニュアルは誰のためのものですか？ PlantPulse PlatformとJavaで連携する外部システム(MES, ERP, 自社ダッシュボードなど)を開発される方向けの本格的なリファレンスです。

領域	案内
初めて利用する場合	1. はじめに → 2. ドメインIDルール → 3. レスポンス形式・エラー処理の順でお読みください。
特定のドメインが必要な場合	下の目次から該当するサービス(例: Tag, Order)へ直接移動してください。
RESTを直接呼ぶ場合	エンドポイント全リストにURLとメソッドのマッピングがまとめられています。
ワークフローの例が必要な場合	統合例集でエンドツーエンドのシナリオを確認してください。
AIアシスタントを導入する場合	MCP サーバー — Claude などのクライアントがタグ・アラーム・資産を自然言語で照会し、アラーム確認まで行います。

エントリポイント: new APIClient_V5(proto, host, port, user, token, debug) → connect()
サービス 13個: client.system(), client.site(), client.customer(), client.employee(), client.product(), client.asset(), client.opc(), client.tag(), client.alarm(), client.order(), client.calendar(), client.path(), client.flow()
型 DTO 返却: すべてのメソッドが JSONObject の代わりに型クラス(SiteResponseV5, TagResponseV5 など)を返却
失敗時の安全なデフォルト値: create/update/get → null, list → 空リスト, delete/exists → false, count → 0
エラーレスポンス抽出: BaseServiceV5.getErrorCode(env), getErrorMessage(env), getHttpStatus(env) static メソッド
ドメインID検証: ドメインごとに定められた接頭辞をサーバーが検証します。層は接頭辞ではなく asset_type で判断します — ドメインIDルール
ベースパス: すべての呼び出しは /api/v5 下位エンドポイント