Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Integration API Guide

Update Device Custom Property

This PUT API provides a way to modify the device properties of one or more devices.

Release Added 6.5.0
Input URL

https://<FSM-IP>/phoenix/rest/cmdbDeviceInfo/properties

Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method PUT
Request Body

The modified properties and the list of devices need to be specified in an XML file in the body. The XSD is File9_device_properties.xsd. Key fields are

  • ipAddr: the comma separated list of device access IP addresses for which properties have to be set

  • propertyName: the name of the property

  • propertyValue: the new value

Field

Type Description
Body Properties XML XML format can be obtained from - /rest/pub/cmdbDeviceInfo /properties
A sample XML example is Sample_Device_Custom_Property_Request_Body.xml.
Output When the request succeeds (HTTP response code 200), the properties are modified as defined in the request.

Update Device Custom Property

This PUT API provides a way to modify the device properties of one or more devices.

Release Added 6.5.0
Input URL

https://<FSM-IP>/phoenix/rest/cmdbDeviceInfo/properties

Input Credentials User name and password of Supervisor account, or Organization specific user name and password, Organization name.
HTTP Method PUT
Request Body

The modified properties and the list of devices need to be specified in an XML file in the body. The XSD is File9_device_properties.xsd. Key fields are

  • ipAddr: the comma separated list of device access IP addresses for which properties have to be set

  • propertyName: the name of the property

  • propertyValue: the new value

Field

Type Description
Body Properties XML XML format can be obtained from - /rest/pub/cmdbDeviceInfo /properties
A sample XML example is Sample_Device_Custom_Property_Request_Body.xml.
Output When the request succeeds (HTTP response code 200), the properties are modified as defined in the request.