Créer un dispositif

POST

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

Ajouter un appareil à gérer.

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"
    }
  ]
}

Paramètres de demande

Nom	Obligatoire/facultatif	Type	Description
division_id		string	ID de la division
device_identifier		string	Identificateur de l'appareil. Ne doit pas être vide, 255 maximum. Doit être unique dans la division
device_profile_id	Obligatoire	string	ID du profil de l'appareil à utiliser comme modèle pour la création de l'appareil
fields		array	Groupe de champs
.. id		string	ID du champ (correspond à l'ID du champ du profil de l'appareil)
.. value		string	Valeur du champ. Obligatoire est défini par le profil de l'appareil. Max 1024 symboles

Paramètres de réponse

Nom	Type	Description
id	string	ID unique de l'appareil
account_id	string	ID de compte
division	object	Conteneur de la division
.. id	string	ID de la division
.. name	string	Nom de la division
device_identifier	string	Identificateur de l'appareil
device_profile	object	Conteneur de profil de l'appareil
.. id	string	ID du profil de l'appareil
.. name	string	Nom du profil de l'appareil
created	string	Date et heure de création (UTC)
updated	string	Date et heure de la dernière mise à jour (UTC)
status	string	Statut (Pour les appareils nouvellement créés, toujours ACTIF)
fields	array	Groupe de champs
.. id	string	ID du champ
.. name	string	Nom du champ (à partir du profil de l'appareil)
.. value	string	Valeur du champ
.. mandatory	boolean	Ce champ est-il obligatoire ? (vrai ou faux selon le profil de l'appareil)

Paramètres de demande

Paramètres de réponse

À propos de