BazeField Services

<back to all web services

DeviceInfoGetRequest

Configuration API
Requires Authentication
The following routes are available for this service:
GET, POST/configuration/objects/{ObjectIds}/devices
DeviceInfoGetRequest Parameters:
NameParameterData TypeRequiredDescription
ObjectIdspathList<string>No
DeviceInfoGetResponse Parameters:
NameParameterData TypeRequiredDescription
DevicesformDictionary<int, DeviceInfoEntity>No
DeviceInfoEntity Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringNo
NameformstringNo
LoadOrderformintNo
NodeIdformGuidNo
NodeNameformstringNo
ProtocolIdformintNo
ProtocolNameformstringNo
ConnectionStringformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /configuration/objects/{ObjectIds}/devices HTTP/1.1 
Host: monitoring.ox2.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	objectIds: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	devices: 
	{
		0: 
		{
			id: 0,
			description: String,
			name: String,
			loadOrder: 0,
			nodeName: String,
			protocolId: 0,
			protocolName: String,
			connectionString: String
		}
	}
}