Address Group Management REST API Overview
You can associate address locations, such as a ship-to address, to a device. The ship-to address is used by Service Now to inform the Juniper Networks logistics team where to deliver a part or device when an RMA request is generated.
The address-group-management resources are available under https://[host]/api/juniper/servicenow for associating locations to a device.
URI
https://[host]/api/juniper/servicenow/address-group-management (HTTP method = GET)
Produces
- application/vnd.juniper.servicenow.address-group-management+xml;version=1
- application/vnd.juniper.servicenow.address-group-management+json;version=1
Sample Output
Sample XML Output
<servicenow-address-group-management>
<collection href="/api/juniper/servicenow/address-group-management/addressGroups" rel="Address groups"/>
<collection href="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups" rel="End Customer Address groups"/>
<method href="/api/juniper/servicenow/address-group-management/addressGroups/create" rel="Create Address Group"/>
</servicenow-address-group-management>
 | Note: endCustomerAddressGroups is displayed only when Service now is in Mode. |
Sample JSON Output
{
"servicenow-address-group-management": {
"collection": [
{
"@href": "/api/juniper/servicenow/address-group-management/addressGroups",
"@rel": "Address groups"
},
{
"@href": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups",
"@rel": "End Customer Address groups"
}
],
"method": {
"@href": "/api/juniper/servicenow/address-group-management/addressGroups/create",
"@rel": "Create Address Group"
}
}
}
| Note: endCustomerAddressGroups is displayed only when Service now is in Mode. |
The address group management service provides the following APIs:
- Get All Address Groups
- Get an Address Group by Address Group ID
- Create an Address Group
- Modify an Address Group
- Associate Devices to an Address Group
- Remove Devices from an Address Group
- Get All End Customer Address Groups
- Get End Customer Address Groups by ID
