Referencia de la API

Operación Bulk: Eliminar Variables

Este endpoint elimina múltiples Variables a la vez.

❗️

+++Atención+++

Este endpoint es extremadamente poderoso. Pero un gran poder conlleva una gran responsabilidad.

La eliminación de Variables NO puede deshacerse. Por favor, haz una copia de seguridad de todos los datos de las Variables antes de eliminar una o más Variables.

Solicitud HTTP

Para eliminar 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/delete/

Para eliminar una o más Variables en 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/delete

🚧

Es un POST

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

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 uno o más <variable_key>. Cada objeto <variable_key> puede contener los siguientes parámetros de cuerpo:

ParameterTypeDescription
variable_idStringThe id of the Variable

📘

<variable_key>

Recuerda que el <variable_key> tiene 2 formatos válidos:

  • <variable_id>: "6e3wef09da44fc8455a9cceb5aa"

  • JSON de <variable_id>: { "id": "1237809ca5pIhpjgc345fc" }

❗️

+++ATENCIÓN+++

Por favor, ten MUCHO cuidado al usar este endpoint, ¿por qué? Porque es posible borrar muchas Variables a la vez.

Te proponemos 1 alternativa segura:

  • Haz una petición de Obtener todas las Variables utilizando el parámetro de consulta fields=id. Esto devuelve un Array de los Ids de las Variables. Simplemente copia este Array y utilízalo en el cuerpo de este endpoint. Así te aseguras de que sólo se eliminan las Variables previstas en ese Array y no cualquier otra.

Cabecera

ParameterRequired?Description
X-Auth-TokenYesAuthentication Token of account
X-Bulk-OperationYesNeed to be set to True for the bulk operation to work
Content-TypeYesContent type of body
$ curl -X DELETE 'https://api.netux.com/api/v2.0/variables/_/bulk/delete/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
 -H 'Content-Type: application/json' \
 -H 'X-Bulk-Operation: True' \
 -d '[
  "6e309da44fc8455a9cceb5aa",
  {
    "id": "1237809ca5pIhpjgc345fc"
  }
]'

Respuesta

Devuelve un Task Id del proceso asíncrono.

{
  "task": {
    "id": "tyg54645501a9ca5714e7b098721"
  }
}

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