Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Remove Devices from an Address Group

 

Use this API to you remove one or more devices from an address group.

URI

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

URI Parameters

Parameter

Type

Required

Description

id

Integer

Yes

ID of the address group from which devices are to be removed

Consumes

  • application/vnd.juniper.servicenow.address-group-management.devices+xml;version=1; charset=UTF-8

  • application/vnd.juniper.servicenow.address-group-management.devices+json;version=1; charset=UTF-8

Request Elements

Element

Type

Description

device

device

Device to be removed from the address group

href

String

Link to the address group

addressType

String

Type of address

Possible values:

  • 0—Address is a location address

  • 1—Address is a ship-to address

  • 2—Address applies to both the location and ship-to addresses

Produces

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

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

Response Elements

Element

Type

Description

status

String

Status of the remove devices from address group job

desc

String

Description of the job status

keys

key

colleciton of device IDs

key

Integer

ID of a device

exceptions

exception

Collection of exceptions that occurred during the job

exception

exception

An exception

severity

String

Severity of the exception

Possible values:

  • ERROR

  • WARN

code

String

Code for the exception

desc

String

Description of the exceptioni

keys

key

Collection of device IDs for which the exception was raised

key

Integer

ID of the device for which the exception was raised

Sample Input

Sample XML Input

Sample JSON Input

Sample Output

Sample XML Output

Sample JSON Output

Response Status Code

Message

Description

404 Not Found

Address group ID not found in Service Now.

SN-1007

Address type is not valid.

SN-1000

Specified devices are not valid.

SN-1008

Device is not associated with the address group.