Referencia de la API

Operación Bulk: Actualizar todos los campos de Variables

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

Solicitud HTTP

Para actualizar todos los atributos de una o más Variables, haz una petición POST a la siguiente URL:

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

Para actualizar todos los atributos de una o más Variables de un Device, haz una petición POST a la siguiente URL:

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

🚧

Es un POST

Ten en cuenta que es una petición POST y no una petición PUT.

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 POST '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": "5dfa39ee1a9ca53020c69391",
        "label": "variable1",
        "name": "Variable 1",
        "description": "my variable 1",
        "tags": ["blue"],
        "properties": {},
        "icon": "trash",
        "unit": "meters"
    },
    ...
    {
        "id": "5dfa39ee1a9ca53020a894ed",
        "label": "variable3",
        "name": "Variable 3",
        "description": "my variable 3",
        "tags": ["yellow"],
        "properties": {},
        "icon": "trash",
        "unit": "meters"
    }
]'

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