API 使用マニュアル

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

ライブラリの特徴

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

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

領域	案内
はじめて利用する場合	1. はじめに → 2. ドメイン ID 規則 → 3. レスポンス形式・エラー処理の順にお読みください。
特定のドメインが必要な場合	下記の目次から該当サービス(例: Tag、Order)へ直接移動してください。
REST を直接呼び出す場合	エンドポイント全一覧に URL とメソッドのマッピングを整理しています。
ワークフロー例が必要な場合	統合サンプル集でエンドツーエンドのシナリオを確認してください。

エントリポイント: 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 の検証: SITE_、ASSET_、OPC_/API_、TAG_ の接頭辞を強制(サーバ側バリデータ)
ベースパス: すべての呼び出しは /api/v5 配下のエンドポイント