Jump to

• Request
• Response

Get Device Groups for Tree Grids

get

/api/device/Groups/readForTree

Gets the device groups in a format suitable for tree grids.

Request

Query Parameters

• node(required): string
  The node of the tree to get. You can specify root, the numerical ID, or the full tree path.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The list of device groups.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceGroupsReadForTree"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of device groups.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The list of device groups.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceGroupsReadForTree"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of device groups.

Show Source

• Array of: object deviceGroupsReadForTree

{
    "description":"The list of device groups.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceGroupsReadForTree"
    }
}

Nested Schema : deviceGroupsReadForTree

Type: object

Show Source

• DeviceGroupID: integer
  The device group ID.

  Example: 1
• DeviceGroupName: string
  The device group display name.

  Example: Nodes
• leaf: boolean
  Whether it is a leaf (true) or not (false).

  Example: false

{
    "type":"object",
    "properties":{
        "DeviceGroupID":{
            "$ref":"#/components/schemas/deviceGroupsRead/properties/DeviceGroupID"
        },
        "DeviceGroupName":{
            "$ref":"#/components/schemas/deviceGroupsReadById/properties/DeviceGroupName"
        },
        "leaf":{
            "description":"Whether it is a leaf (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":false
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top