LearningSky.io

【 Cloud 】透過 Postman 操作 Azure Digital Twins - Relationship APIs

Archer -

內容

  • 學習目標
  • 前置準備作業
  • Twin Graph
  • 上傳 DTDL 與建麼 Twin
  • 新增 Parent 與 Child 關聯
  • 透過 ID 取得關聯資訊
  • 取得所有關聯資訊
  • 刪除關聯

學習目標

  • 如何透過 Postman 操作 Azure Digital Twins - Relationship APIs

前置準備作業

Twin Graph

  • 上傳 Parent DTDL 到 Azure Digital Twins 服務並建立 Parent Twin - room001
  • 上傳 Child DTDL 到 Azure Digital Twins 服務並建立 Child Twin - device001
  • 建立 Parent Twin 與 Child Twin 之間的關聯 - room001_to_device001

上傳 DTDL 與建立 Twin

Step 1. 上傳 Device DTDL 與建立 Device Twin

  • Device DTDL 資訊

Step 2. 上傳 Room DTDL 與建立 Room Twin

  • Room DTDL 資訊

新增 Parent 與 Child 關聯

Step 1. 建立關聯

  • 點選 +

  • 填寫 Request 資訊
    • Request Method 請選擇 PUT
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/PARENT-TWIN-NAME/relationships/RELATIONSHIP-ID?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 PARENT-TWIN-NAME 修改成所建立的 Parent Twin 名稱，本範例使用 room001
      • ㊟ 將 URL 中的 RELATIONSHIP-ID 修改成不重複且可識別的名稱，本範例使用 room001_to_device001
    • Request Body
      • 請點選 Body 頁籤 > 再點選 raw > 再點選 JSON > 在輸入框輸入下方資訊
      • ㊟ 將 $targetId 的值修改成 已建立的 Child Twin 的名稱，本範例為 device001
      • ㊟ 將 $relationshipName 的值修改成 所上傳的 Parent DTDL 中 @type 為 Relationship 的 name 值，本範例為 devices

  • 點選 Send

  • 執行結果

透過 ID 取得關聯資訊

Step 1. 取得關聯資訊

  • 點選 +

  • 填寫 Request 資訊
    • Request Method 請選擇 GET
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/PARENT-TWIN-NAME/relationships/RELATIONSHIP-ID?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 PARENT-TWIN-NAME 修改成所建立的 Parent Twin 名稱，本範例使用 room001
      • ㊟ 將 URL 中的 RELATIONSHIP-ID 修改成不重複且可識別的名稱，本範例使用 room001_to_device001

  • 點選 Send

  • 執行結果

取得所有關聯資訊

Step 1. 列出所有關聯資訊

  • 點選 +

  • 填寫 Request 資訊
    • Request Method 請選擇 GET
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/PARENT-TWIN-NAME/relationships?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 PARENT-TWIN-NAME 修改成所建立的 Parent Twin 名稱，本範例使用 room001

  • 點選 Send

  • 執行結果

刪除關聯

Step 1. 列出所有關聯資訊

  • 點選 +

  • 填寫 Request 資訊
    • Request Method 請選擇 DELETE
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/digitaltwins/PARENT-TWIN-NAME/relationships/RELATIONSHIP-ID?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 PARENT-TWIN-NAME 修改成所建立的 Parent Twin 名稱，本範例使用 room001
      • ㊟ 將 URL 中的 RELATIONSHIP-ID 修改成所立的關聯名稱，本範例使用 room001_to_device001

  • 點選 Send

  • 執行結果

Reference

GitHub

List of blogs