API.Structures

  • The request for structure of user company
  • The request for add new structure tag
  • The request show entity of structure item
  • The request for save of structures

/api.structures

Get structures of user company

Is called without parameters.

In the case of a successful response will return a json object:

{
    "structures": {
        "devices_groups": [  // Array of available device groups. See [#/api.devices.groups](#c-groups)
        ],
        "devices_types":  [  // Array of available device types.
        ],
        "structures": [ // Array of available structures
        ],
        "tags": [ // Array tags of available structures
        ]
    }
}

For device groups see #/api.devices.groups

For device types see #/api.devices.types

/api.structures.tags.add

The request for add new structure tag

PARAMETERTYPEDESCRIPTION
structureIdInteger (required)The string of new structure tag.
entityString

The string of entity type. Available: [«devices», «users», «all»] — «all» is default


In the case of a successful response will return a json object:

{
    "structures": {
        "devices": [ // Array of ties devices
        ],
        "users": [ // Array of ties users
        ]
    },
    "users": { // uses in telemetric.app
    }
}

/api.structures.save

The request for save of structures.


PARAMETERTYPEDESCRIPTION
structuresArray [] (required)array of structures. See #/api.structures -> «structures» object


In the case of a successful response will return a json object:

{
    "result": [] // Array of structures.
}

See #/api.structures

Did this solve your problem?