Jump to

• Request
• Response

Move or Copy Devices to a Different Group

put

/api/device/Groups/updateDevices

Moves or copies devices to a different group. To move, specify a source group in SourceDeviceGroupID. To copy, do not specify a source group.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Devices: array Devices
  The list of devices.
• id(required): integer
  The destination device group ID.
• SourceDeviceGroupID: integer
  The source device group ID. To move devices, specify an ID. To copy devices, do not use this parameter.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The destination device group ID.",
            "type":"integer"
        },
        "SourceDeviceGroupID":{
            "description":"The source device group ID. To move devices, specify an ID. To copy devices, do not use this parameter.",
            "type":"integer"
        },
        "Devices":{
            "$ref":"#/components/schemas/deviceGroups/properties/Devices"
        }
    }
}

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 SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The destination device group with the moved or copied devices.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceGroupsReadById"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

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

  Example: true

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

Nested Schema : type

Type: object

Show Source

• data: array data
  The destination device group with the moved or copied devices.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The destination device group with the moved or copied devices.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceGroupsReadById"
            }
        }
    }
}

Nested Schema : data

Type: array

The destination device group with the moved or copied devices.

Show Source

• Array of: object deviceGroupsReadById

{
    "description":"The destination device group with the moved or copied devices.",
    "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