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

【 Cloud 】透過 Postman 操作 Azure Digital Twins - Model APIs
Photo by Jeremiah Berman / Unsplash

內容

  • 學習目標
  • 前置準備作業
  • 新增 Model - Binary File
  • 新增 Model - Raw JSON
  • 列出 Model 清單 - 列出簡易資訊
  • 列出 Model 清單 - 列出詳細資訊
  • 透過 Model ID 列出簡易資訊
  • 透過 Model ID 列出詳細資訊
  • 刪除 Model

學習目標

  • 如何透過 Postman 操作 Azure Digital Twins - Models API

前置準備作業

新增 Model - Binary File

Step 1. 在電腦端新增 device.json 檔案並輸入下方資訊

Step 2. 新增 Model

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 POST
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • Request Body
      • 請點選 Body 頁籤 > 再點選 binary > 再點選 Select File 選擇 Step 1device.json 檔案

---2021-12-02---10.28.22

---2021-12-02---10.57.58

---2021-12-02---10.59.21

  • 點選 Send

---2021-12-02---11.01.37

  • 執行結果

---2021-12-02---11.02.56

新增 Model - Raw JSON

Step 1. 新增 Model

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 POST
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
    • Request Body
      • 請點選 Body 頁籤 > 再點選 raw > 再點選 JSON > 在輸入框輸入下方資訊

---2021-12-02---10.28.22

---2021-12-02---10.57.58

---2021-12-02---11.06.52

  • 點選 Send

---2021-12-02---11.08.38

  • 執行結果

---2021-12-02---11.10.29

列出 Model 清單 - 列出簡易資訊

Step 1. 列出 Model 清單

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 GET
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name

---2021-12-02---10.28.22

---2021-12-02---11.17.38

  • 點選 Send

---2021-12-02---11.19.08

  • 執行結果

---2021-12-02---11.20.55

列出 Model 清單 - 列出詳細資訊

Step 1. 列出 Model 清單

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 GET
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models?includeModelDefinition=True&api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name

---2021-12-02---10.28.22

---2021-12-02---11.23.19--

  • 點選 Send

---2021-12-02---11.23.19

  • 執行結果

---2021-12-02---11.27.10

透過 Model ID 列出簡易資訊

Step 1. 透過 Model ID 列出資訊

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 GET
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models/MODEL-ID?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 MODEL-ID 修改成 DTDL 中 @id 的值,本範例為 dtmi:company:Device;1

---2021-12-02---10.28.22

---2021-12-02---11.35.33--

  • 點選 Send

---2021-12-02---11.35.33

  • 執行結果

---2021-12-02---11.37.42

透過 Model ID 列出詳細資訊

Step 1. 透過 Model ID 列出資訊

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 GET
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models/MODEL-ID?includeModelDefinition=True&api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 MODEL-ID 修改成 DTDL 中 @id 的值,本範例為 dtmi:company:Device;1

---2021-12-02---10.28.22

---2021-12-02---12.52.27--

  • 點選 Send

---2021-12-02---12.52.27

  • 執行結果

---2021-12-02---12.54.58

刪除 Model

Step 1. 刪除 Model

  • 點選 +

---2021-11-26---2.47.21

  • 填寫 Request 資訊
    • Request Method 請選擇 DELETE
    • Request URL 請在 Enter Request URL 的輸入框輸入 https://Adt-Host-Name/models/MODEL-ID?api-version=2020-10-31
      • ㊟ 將 URL 中的 Adt-Host-Name 修改成所建立的 Azure Digital Twins 所取得的 Host name
      • ㊟ 將 URL 中的 MODEL-ID 修改成 DTDL 中 @id 的值,本範例為 dtmi:company:Device;1

---2021-12-02---10.28.22

---2021-12-02---12.57.53--

  • 點選 Send

---2021-12-02---12.57.53

  • 執行結果

---2021-12-02---1.00.06

Reference

GitHub

List of blogs