Related Documentation
Get All Address Groups
Use this API to retrieve all address groups defined in Service Now.
URI
https://[host]/api/juniper/servicenow/address-group-management/addressGroups (HTTP method = GET)
Consumes
None
Produces
- application/vnd.juniper.servicenow.address-group-management.addressgroups+xml;version=1
- application/vnd.juniper.servicenow.address-group-management.addressgroups+json;version=1
Response Elements
Element | Type | Description |
|---|---|---|
uri | String | URI of the address group collection in Service Now |
size | Integer | Number of records in the collection |
addressGroup | An address group in the collection | |
uri | String | URI of the address group |
href | String | Link to the address group |
key | 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. |
devicecount | Integer | Number of devices associated with this address group. |
domainId | Integer | ID of the domain in which an address group is present |
Sample Output
Sample XML Output
<addressGroups size="1" uri="/api/juniper/servicenow/address-group-management/addressGroups">
<addressGroup href="/api/juniper/servicenow/address-group-management/addressGroups/10551296" key="10551296" uri="/api/juniper/servicenow/address-group-management/addressGroups/10551296">
<name>Juniper Networks Bangalore</name>
<address1>Plot No. 66</address1>
<address2>Bagmane Tech Park</address2>
<city>Bangalore</city>
<state>Bangalore</state>
<country>India</country>
<devicesCount>6</devicesCount>
<zipCode>560093</zipCode>
<domainId>10</domainId>
</addressGroup>
</addressGroups>
Sample JSON Output
{
"addressGroups": {
"@size": "1",
"@uri": "/api/juniper/servicenow/address-group-management/addressGroups",
"addressGroup": {
"@key": "10551296",
"@uri": "/api/juniper/servicenow/address-group-management/addressGroups/10551296",
"@href": "/api/juniper/servicenow/address-group-management/addressGroups/10551296",
"name": "Juniper Networks Bangalore",
"address1": " Plot No. 66",
"address2": "Bagmane Tech Park",
"city": "Bangalore",
"state": "Bangalore",
"country": "India",
"devicesCount": 6,
"zipCode": 560093,
"domainId":"10"
}
}
}
Response Status Code
Message | Description |
|---|---|
204 No Content | No address groups were found within Service Now. |
