Update device fields

PUT

https://one.digicert.com/iot/api/v1/device/{device_identifier}?division_id={division_id}

Update field values for an existing device. Device name and ID cannot be changed.

generic

{
  "fields": [
    {
      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
      "value": "updated mandatory value"
    },
    {
      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
      "value": "updated 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-24T09:23:21Z",
  "status": "ACTIVE",
  "fields": [
    {
      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
      "name": "Mandatory Field",
      "value": "updated mandatory value",
      "mandatory": true
    },
    {
      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
      "name": "Optional Field",
      "value": "updated optional value",
      "mandatory": false
    }
  ]
}

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_input",
      "message": "Device with division fd5faa1e-623a-47a9-831b-b9397c33395f and identifier Old Device does not exist"
    }
  ]
}

Endpoint path parameters

Name	Req/Opt	Description
device_identifier	required	Device name.
division_id	required	Division ID.

Request parameters

Name	Req/Opt	Type	Description
fields	defined in device profile	array	Array of fields that describe device attributes and settings.
.. id	-	string	Existing field ID as defined in device profile.
.. value	-	string	New field value. Character limit: 1024

Response parameters

Name	Type	Description
id	string	Unique device ID created for the new device.
account_id	string	Account ID.
division	object	Division container.
.. id	string	Division ID.
.. name	string	Division name.
device_identifier	string	Unique device name.
device_profile	object	Device profile container.
.. id	string	Device profile ID.
.. name	string	Device profile name.
created	string	Date and time (UTC) device was created.
updated	string	Date and time (UTC) device was last updated.
status	string	Device status.
fields	array	Array of fields that describe device attributes and settings.
.. id	string	Unique field ID.
.. name	string	Field name.
.. value	string	Field value.
.. mandatory	boolean	Whether or not the field is required, based on the device profile.

Endpoint path parameters

Request parameters

Response parameters

Über