Jump to

• Request
• Response

Create a Device Group

post

/api/device/Groups

Creates a new device group.
The minimum required properties in the request body are:

• DeviceGroupName
• ParentDeviceGroupID
• Devices

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/deviceGroups"
        }
    ],
    "required":[
        "DeviceGroupName",
        "ParentDeviceGroupID",
        "Devices"
    ]
}

Nested Schema : schema

Type: object

Show Source

• DeviceGroupName: string
  The device group name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

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

  Example: 1
• Remove: boolean
  Whether to remove the device from other device groups (1 for true) or not (0 for false).

  Example: 0

{
    "properties":{
        "DeviceGroupName":{
            "description":"The device group name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Root"
        },
        "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"
                    }
                }
            }
        },
        "Remove":{
            "description":"Whether to remove the device from other device groups (<b>1</b> for true) or not (<b>0</b> for false).",
            "type":"boolean",
            "example":0
        }
    }
}

Nested Schema : Devices

Type: array

The list of devices.

Show Source

• 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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new device group.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceGroupsReadById"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new device group.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceGroupsReadById"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the new device group.

Show Source

• Array of: object deviceGroupsReadById

{
    "description":"The properties of the new device group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceGroupsReadById"
    }
}

Nested Schema : deviceGroupsReadById

Type: object

Show Source

• 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"
}

Nested Schema : Devices

Type: array

The list of devices.

Show Source

• 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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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"
        }
    }
}

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

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

Nested Schema : items

Type: object

An error.

Back to Top