Referencia de la API

Operación Bulk: Actualizar campos de Variables

Este endpoint actualiza los campos de Variable especificados en el cuerpo para múltiples Variables a la vez.

📘

Actualizando un solo campo

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

Solicitud HTTP

Para actualizar uno o más atributos específicos de una o más Variables, haz una petición PATCH a la siguiente URL:

HTTP MethodURL
PATCHhttps://api.netux.com/api/v2.0/variables/_/bulk/update/

Para actualizar uno o más atributos específicos de una o más Variables de un Device, haz una petición PATCH a la siguiente URL:

HTTP MethodURL
PATCHhttps://api.netux.com/api/v2.0/devices/<device_key>/variables/_/bulk/update

Parámetros de consulta

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

Parámetros de cuerpo

El cuerpo es un array que contiene objetos JSON correspondientes a Variables. Cada objeto de Variable puede contener los siguientes parámetros de cuerpo:

ParameterTypeRequired?Description
labelStringNoThe API label of Variable
nameStringNoName of the Variable
descriptionStringNoDescription of Variable
tagsString ArrayNoVariable tags
propertiesObjectNoVariable properties
iconStringNoIcon of Variable
unitStringNoUnit of Variable. Allowed values: raw (default) or synthetic
syntheticExpressionStringNoSynthetic Expression of Variable

Cabecera

ParameterTypeDescription
X-Auth-TokenStringAuthentication Token of account
X-Bulk-OperationBooleanNeed to be set to True for the bulk operation to work
Content-TypeString (application/json)Content type of body
$ curl -X PATCH 'https://api.netux.com/api/v2.0/variables/_/bulk/update/' \
 -H 'Content-Type: application/json' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
 -H 'X-Bulk-Operation: True' \
 -d '[
    {
        "id": "62e01b5eb5a1b0000e17148t",
        "description": "New Description"
    },
    {
        "id": "62e01b5eb5a1b0000e17148e",
        "tags": ["Colombia","Medellin"]
    },
    {
        "id": "62e01b5eb5a1b0000e17148b",
        "unit": "km/H"
    },
    {
        "id": "62e01b5eb5a1b0000e17148l",
        "name": "New Name"
    }
]'

Respuesta

Devuelve un Task Id del proceso asíncrono.

{
    "task": {
        "id": "5e1794561a9ca5651e6b59ec"
    }
}

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

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

{
    "detail": "Header `X-BULK-OPERATION` should be provided for bulk operation."
}