デバイスを作成する

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	ステータス (新規作成のデバイスでは、常時有効)
fields	array	フィールドのアレイ
.. id	string	フィールド ID
.. name	string	フィールド名 (デバイスプロフィールより)
.. value	string	フィールド値
.. mandatory	boolean	フィールドは必須ですか？(デバイスプロフィールによって真または偽)

申請パラメータ

応答パラメータ

案内