Guías

Preguntas frecuentes

Suggest Edits

¿Por qué mi petición devuelve todos los objetos (Devices, Variables,...) aunque ponga un filtro en los parámetros de la consulta?

📘

Sintaxis de parámetros de consulta no válida

En caso de que la sintaxis de tu parámetro de consulta no sea válida, el parámetro de consulta será ignorado. Por lo tanto, esto puede hacer que se devuelvan todos los objetos.

¿Por qué no funciona mi llamada API Bulk?

👍

Cabecera X-Bulk-Operation

Lo más probable es que hayas olvidado añadir la cabecera X-Auth-Operation=True.

¿Dónde puedo obtener más información sobre los endpoints?

📘

Método HTTP OPTIONS

Siempre es posible ejecutar una petición OPTIONS a un endpoint. Esto devuelve un objeto JSON detallado con todos los atributos e información adicional, como por ejemplo si el atributo es obligatorio o de sólo lectura.

// Devuelve información adicional sobre este endpoint
OPTIONS https://api.netux.com/api/v2.0/devices/

{
    "name": "Device List",
    "description": "",
    "renders": [
        "application/json"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "POST": {
            "url": {
                "type": "field",
                "required": false,
                "read_only": true,
                "label": "Url"
            },
            "id": {
                "type": "string",
                "required": false,
                "read_only": true,
                "label": "Id"
            },
            "organization": {
                "type": "nested object",
                "required": false,
                "read_only": false,
                "label": "Organization",
                "children": {
                    "url": {
                        "type": "field",
                        "required": false,
                        "read_only": true,
                        "label": "Url"
                    },
                    "id": {
                        "type": "string",
                        "required": true,
                        "read_only": false,
                        "label": "Id"
                    },
                    ...
                }
            },
            "label": {
                "type": "string",
                "required": false,
                "read_only": false,
                "label": "Label",
                "max_length": 200
            },
            "properties": {
                "type": "nested object",
                "required": false,
                "read_only": false,
                "label": "Properties",
                "children": {
                    "_icon": {
                        "type": "string",
                        "required": false,
                        "read_only": false,
                        "label": " icon"
                    },
                    "_color": {
                        "type": "string",
                        "required": false,
                        "read_only": false,
                        "label": " color"
                    },
                    ...
                }
            },
            "isActive": {
                "type": "boolean",
                "required": false,
                "read_only": false,
                "label": "Isactive"
            },
            ...
        }
    }
}

Updated about 2 years ago

What’s Next