メインコンテンツまでスキップ

5. Site サービス

client.site() でアクセスします。サイト(工場)は資産階層の最上位ノードであり、すべての OPC・Asset・タグ・Order はサイトに所属します。

ID 規則: SITE_ プレフィックスが必須です。詳細は ドメイン ID 規則 を参照してください。

5.1 メソッド一覧

メソッド戻り値の型HTTPエンドポイント
create(SiteRequestV5)SiteResponseV5 または nullPOST/api/v5/site
update(site_id, SiteRequestV5)SiteResponseV5 または nullPUT/api/v5/site/{id}
delete(site_id)booleanDELETE/api/v5/site/{id}
get(site_id)SiteResponseV5 または nullGET/api/v5/site/{id}
list()List<SiteResponseV5>GET/api/v5/site
exists(site_id)booleanGET/api/v5/site/{id}/exists

5.2 SiteRequestV5 (リクエスト DTO)

フィールド必須説明
site_idStringSITE_ で始まる
site_nameStringサイト名
descriptionString-説明
lat / lngString-緯度・経度 (地図用)
company_idString-会社 ID (マルチテナンシー)

5.3 SiteResponseV5 (レスポンス DTO)

上記のリクエストフィールド + 次の追加フィールド:

フィールド説明
insert_date / update_dateString登録/更新時刻
total_area_countintサイトの Area 数
total_line_countintLine 数
total_equipment_countintEquipment 数
total_tag_countintタグ数

5.4 使用例

サイトの作成

import plantpulse.api.v5.dto.request.SiteRequestV5;
import plantpulse.api.v5.dto.response.SiteResponseV5;

SiteRequestV5 req = new SiteRequestV5();
req.setSite_id("SITE_DJ");
req.setSite_name("대전 1공장");
req.setDescription("주력 생산 공장");
req.setLat("36.3504");
req.setLng("127.3845");

SiteResponseV5 created = client.site().create(req);
if (created != null) {
System.out.println("등록 완료: " + created.getSite_id());
}

単件取得

SiteResponseV5 site = client.site().get("SITE_DJ");
if (site != null) {
System.out.println(site.getSite_name());
System.out.println("Area 수: " + site.getTotal_area_count());
System.out.println("Line 수: " + site.getTotal_line_count());
System.out.println("Equipment 수: " + site.getTotal_equipment_count());
System.out.println("Tag 수: " + site.getTotal_tag_count());
}

全件一覧

import java.util.List;

List<SiteResponseV5> sites = client.site().list();
for (SiteResponseV5 s : sites) {
System.out.println(s.getSite_id() + " — " + s.getSite_name());
}

サイトの更新

SiteRequestV5 update = new SiteRequestV5();
update.setSite_id("SITE_DJ"); // 동일하게 채워서 보내야 합니다
update.setSite_name("대전 1공장 (확장)");
update.setDescription("2026년 라인 증설 완료");

SiteResponseV5 updated = client.site().update("SITE_DJ", update);

存在確認

if (client.site().exists("SITE_DJ")) {
// ...
}

サイトの削除

⚠️ サイトを削除する前に、そのサイトに属するすべての Asset・OPC・タグ・Order を先に削除する必要があります。そうしない場合、E1200 (CONFLICT) が応答され、false が返されます。

boolean ok = client.site().delete("SITE_OLD");
if (!ok) {
System.err.println("삭제 실패 — 하위 리소스 존재 가능");
}

5.5 活用シナリオ

シナリオ — サイト別 KPI ダッシュボード

for (SiteResponseV5 site : client.site().list()) {
String siteId = site.getSite_id();

// 사이트별 자산 통계는 SiteResponseV5에 이미 포함됨
int eqCount = site.getTotal_equipment_count();
int tagCount = site.getTotal_tag_count();

// 사이트별 OPC 수
long opcCount = client.opc().countBySite(siteId);

System.out.printf("%s — Equipment %d, Tag %d, OPC %d%n",
site.getSite_name(), eqCount, tagCount, opcCount);
}

次のステップ