Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get an Address Group by Address Group ID

 

This method returns a specific address group from within in Service Now.

URI

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

URI Parameters

Parameter

Type

Required

Description

id

Integer

Yes

ID of the address group to be retrieved

Consumes

None

Produces

  • application/vnd.juniper.servicenow.address-group-management.addressgroup+xml;version=1

  • application/vnd.juniper.servicenow.address-group-management.addressgroup+json;version=1

Response

Element

Type

Description

uri

String

URI of the address group

ID

Integer

ID of the address group

name

String

Name of the location, such as the business name.

address1 and address2

String

Address, such as street number and street name, to be associated with the device

city, state and zipCode

String

City, State and Zip Code of the address

createdBy

String

User who created this address group

creationTime

String

Date and time the address group was created

modifiedTime

String

Date and time the address group was last modified

devices

device

Collection of devices to which the address group is associated

href

String

Link to the collection of devices

size

Integer

Number of devices in the collection

device

device

A device in the collection

href

String

Link to the device

key

Integer

ID of the device

hostName

String

Hostname of the device associated with this address group

serialNumber

String

Serial number of the device associated with this address group

platform

String

Device platform associated with this address group

addressType

String

Specifies whether this address is a shipping address or business address.

Possible values:location, shipto or both.

  • location—Address is business address

  • shipto—Address is shipping address

  • both—Address is both business and shipping address

method

String

Method applicable to the address group

domainId

Integer

ID of the domain in which the address group is present

Sample Output

Sample XML Output

Sample JSON Output

Response Status Code

Message

Description

404 Not Found

  • Invalid address group ID.

  • No address group with this ID was found within Service Now.