Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Information About a Device Group

 

Use this API to retrieve information about a device group, including devices that are a part of the device group.

URI

https://[host]/api/juniper/servicenow/device-group-management/deviceGroup/{id} (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

id

Integer

Yes

ID of the device group for which information is to be retrieved

Consumes

None

Produces

  • application/vnd.juniper.servicenow.device-group-management.devicegroup+xml;version=2

  • application/vnd.juniper.servicenow.device-group-management.devicegroup+json;version=2

Response

Element

Type

Description

uri

String

URI of the device group

deviceGroupName

String

Device group name

isDefault

Boolean

Specifies if the device group is the default device group

Possible values:

  • true—The device group is the default group.

  • false—The device group is not the default device group.

domainId

Integer

ID of the domain to which the device group is assigned

organization

organization

Organization to which the device group is assigned

href

String

Link to the organization

id

Integer

ID of the organization

deviceGroupId

Integer

ID of the device group

name

String

Organization name

devices

devices

Collection of devices assigned to the device group

href

String

Link to the collection of devices assigned to the device group

size

Integer

Number of devices in the device group

device

device

Device assigned to the device group

href

String

Link to the device

key

Integer

ID of the device

hostName

String

Device hostname

policies

policies

Collection of auto submit policies assigned to the device group

href

String

Link to the collection of auto submit policies assigned to the device group

size

Integer

Number of auto submit policies in the device group

policy

policy

Auto submit policy assigned to the device group

href

String

Link to the auto submit policy

key

Integer

ID of the auto submit policy

policyName

String

Name of the auto submit policy

rel

String

Description of an operation that can be performed on this resource.

domainId

Integer

ID of the domain in which the device group is created

method

method

Methods applicable to the device

href

String

Link to the method applicable for the device group

Sample Output

Sample XML Output

Sample JSON Output

Response Status Code

Message

Description

404 Not Found

Invalid device group identifier specified. No device group found.