API.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

Parameter Type Description
tagTitle String 100 (required) The string of new structure tag.

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

{
    "result": 0 // The ID for new structure tag or 0
}

/api.structures.show.entity

The request ties of entities from any structure ID

Parameter Type Description
structureId Integer (required) The string of new structure tag.
entity String 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 nekta.cloud
    }
}

/api.structures.save

The request for save of structures.

Parameter Type Description
structures Array [] (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