Referencia de la API

Actualizar todos los campos de un Device

Este endpoint actualiza todos los campos del Device especificado en el cuerpo.

📘

Actualizando un solo campo

Para actualizar sólo un campo de un Device, utiliza el método PATCH con los parámetros que necesitan cambiarse.

Solicitud HTTP

Para actualizar todos los campos de un Device, haz una petición PUT a la siguiente URL:

HTTP MethodURL
PUThttps://api.netux.com/api/v2.0/devices/<device_key>/

Parámetros de ruta

ParameterTypeDescription
device_keyStringThe id or label of the Device, label should use the prefix ~

Parámetros de consulta

ParameterTypeUseDescription
tokenStringAuthenticationAuthentication Token can optionally be sent as a query parameter.

Parámetros de cuerpo

ParametersTypeRequired?Default ValueDescription
labelStringYesN/A (required)The API label of Device
nameStringNoSame as labelName of Device
descriptionStringNo""Description of Device
tagsString ArrayNo[]Device tags
propertiesObjectNo{}Device properties
organization<organization_key>NonullKey of Organization (id or label)

Cabecera

ParameterRequired?Description
X-Auth-TokenYesAuthentication Token of account

📘

Objeto properties

Ten en cuenta que todos los atributos dentro del atributo properties tienen un guión bajo _ como prefijo.

$ curl -X PATCH 'https://api.netux.com/api/v2.0/devices/<device_key>/' \
 -H 'Content-Type: application/json' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
 -d '{
    "properties": {
        "_location_fixed": {
        	"lat": 6.2486,
        	"lng": 75.5742
        }
    },
    "description": "My first Device",
    "label": "first-device",
    "name": "First Device",
    "organization": "af92e4c82bf1d39cc21882f5b",
    "tags": ["first"]
}'

Respuesta

Devuelve un objeto Device del Device actualizado.

{
    "properties": {
        "_location_fixed": {
        	"lat": 6.2486,
        	"lng": 75.5742
        }
    },
    "createdAt": "2019-11-25T19:35:08.975270Z",
    "description": "change description",
    "id": "6e309da44fc8455a9cceb5aa",
    "isActive": true,
    "label": "first-device",
    "lastActivity": null,
    "name": "First Device",
    "organization": {
        "id": "af92e4c82bf1d39cc21882f5b",
        "label": "my-first-customer",
        "name": "My First Customer",
        "url": "http://api.netux.com/api/v2.0/organizations/af92e4c82bf1d39cc21882f5b"
    },
    "tags": ["first"],
    "url": "http://api.netux.com/api/v2.0/devices/6e309da44fc8455a9cceb5aa",
    "variables": "http://api.netux.com/api/v2.0/devices/6e309da44fc8455a9cceb5aa/variables",
    "variablesNumber": 1
}

{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}

{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}