FAQ

Frequently Asked Questions

Why does my request return all objects (devices, variables,...) even though I put a filter in the query parameters?

πŸ“˜

Invalid Query Parameter Syntax

In case your query parameter syntax is invalid, the query parameter will be ignored. Hence it can lead to all objects being return.

Why doesn't my bulk API call work?

πŸ‘

X-Bulk-Operation Header

Most likely you forgot to add the X-Auth-Operation=True header.

Where can I get more information about the endpoints?

πŸ“˜

HTTP Method OPTIONS

It's always possible to run an OPTIONS request to an endpoint. This returns a detailed JSON object with all attributes and additional information, such as if the attribute is required or read_only.

//Returns additional information about this endpoint
OPTIONS https://industrial.api.ubidots.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"
            },
            ...
        }
    }
}