Manage Device Groups

Gets device group details and delete sdevice groups.

Gets the details of a device group.

Path Parameters

  • clientIdstringrequired

    Describes the clientId or partnerId of the tenant

  • resourceGroupIdstringrequired

    Resource group uuid

Responses

  • idstring

  • namestring

    Unique name for the device group. The device group is identified with this name.

  • entityTypestring

    Type of resources in a group. Example: DEVICE_GROUP, SNS

  • kbArticlesIdsarray of strings

    Knowledge base articleId to be attached to resouce groupId.

  • filterCriteriaobject

  • createdDatestring

  • updatedDatestring

  • parentobject

    Add a device group as child under an existing device group (parent). This field is mandatory while adding a child device group to parent device group.

Loading Examples...

Deletes a device group.

Notes

  • Deleting a device group indicates removing the device group name and details.
  • Resources under a deleted device group are retained and available in infrastructure APIs.
  • Deleting a parent device group deletes child device groups.

Path Parameters

  • clientIdstringrequired

    Describes the clientId or partnerId of the tenant

  • resourceGroupIdstringrequired

    Resource group uuid

Responses

200OK