建立裝置

POST
https://one.digicert.com/iot/api/v1/device

新增要管理的裝置。

bash
{
  "division_id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
  "device_identifier": "New Device",
  "device_profile_id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
  "fields": [
    {
      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
      "value": "mandatory value"
    },
    {
      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
      "value": "optional value"
    }
  ]
}
201 Created
{
  "id": "64c02969-3890-4da8-a5ef-b574fd72887e",
  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
  "division": {
    "id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
    "name": "Mock Division 1"
  },
  "device_identifier": "New Device",
  "device_profile": {
    "id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
    "name": "Device Profile"
  },
  "created": "2020-04-22T07:13:20Z",
  "updated": "2020-04-22T07:13:20Z",
  "status": "ACTIVE",
  "fields": [
    {
      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
      "name": "Mandatory Field",
      "value": "mandatory value",
      "mandatory": true
    },
    {
      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
      "name": "Optional Field",
      "value": "optional value",
      "mandatory": false
    }
  ]
}
400 Bad Request
{
  "errors": [
    {
      "code": "invalid_input",
      "message": "Device with division fd5faa1e-623a-47a9-831b-b9397c33395f and identifier New Device already exist"
    }
  ]
}

要求參數

名稱 必填/選填 類型 說明
division_id string 分區 ID
device_identifier string 裝置識別碼。不應空白,最大 255 個。在分區內應是唯一的。
device_profile_id 必填 string 作為建立裝置的範本的裝置設定檔的 ID
fields array 欄位陣列
.. id string 欄位的 ID (對應裝置設定檔欄位 ID)
.. value string 欄位的值。由裝置設定檔定義為必填。最多 1024 個符號

回應參數

名稱 類型 說明
id string 裝置唯一 ID
account_id string 帳戶 ID
division object 分區容器
.. id string 分區 ID
.. name string 分區名稱
device_identifier string 裝置識別碼
device_profile object 裝置設定檔容器
.. id string 裝置設定檔 ID
.. name string 裝置設定檔名稱
created string 建立的日期和時間 (UTC)
updated string 最後更新日期和時間 (UTC)
status string 狀態 (新建立的裝置一定是 ACTIVE)
fields array 欄位陣列
.. id string 欄位 ID
.. name string 欄位名稱 (來自裝置設定檔)
.. value string 欄位值
.. mandatory boolean 欄位是否必填?(根據裝置檔為 true 或 false)