• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceGroupsReadById"
                    }
                }
            }
        }
    ]
}

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful get operation.",
    "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"
}

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceGroupsReadById"
            }
        }
    }
}

• Array of: object deviceGroupsReadById

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceGroupsReadById"
    }
}

• DeviceGroupID: integer
  The device group ID.

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

  Example: Nodes
• Devices: array Devices
  The list of devices.
• ParentDeviceGroupID: integer
  The device group ID of the parent group.

  Example: 1

{
    "properties":{
        "DeviceGroupName":{
            "description":"The device group display name.",
            "type":"string",
            "example":"Nodes"
        },
        "DeviceGroupID":{
            "description":"The device group ID.",
            "type":"integer",
            "example":"2"
        },
        "ParentDeviceGroupID":{
            "description":"The device group ID of the parent group.",
            "type":"integer",
            "example":"1"
        },
        "Devices":{
            "description":"The list of devices.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DeviceID":{
                        "type":"integer",
                        "example":"1"
                    },
                    "DeviceName":{
                        "type":"string",
                        "example":"router.example.com"
                    }
                }
            }
        }
    },
    "type":"object"
}

• Array of: object items

{
    "description":"The list of devices.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DeviceID":{
                "type":"integer",
                "example":"1"
            },
            "DeviceName":{
                "type":"string",
                "example":"router.example.com"
            }
        }
    }
}

• DeviceID: integer
  Example: 1
• DeviceName: string
  Example: router.example.com

{
    "type":"object",
    "properties":{
        "DeviceID":{
            "type":"integer",
            "example":"1"
        },
        "DeviceName":{
            "type":"string",
            "example":"router.example.com"
        }
    }
}

• 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":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

• Array of: object items
  An error.

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