| GET, POST | /configuration/objects/{ObjectIds}/devices |
|---|
"use strict";
export class DeviceInfoEntity {
/** @param {{id?:number,description?:string,name?:string,loadOrder?:number,nodeId?:string,nodeName?:string,protocolId?:number,protocolName?:string,connectionString?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
description;
/** @type {string} */
name;
/** @type {number} */
loadOrder;
/** @type {string} */
nodeId;
/** @type {string} */
nodeName;
/** @type {number} */
protocolId;
/** @type {string} */
protocolName;
/** @type {string} */
connectionString;
}
export class DeviceInfoGetResponse {
/** @param {{devices?:{ [index: number]: DeviceInfoEntity; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {{ [index: number]: DeviceInfoEntity; }} */
devices;
}
export class DeviceInfoGetRequest {
/** @param {{objectIds?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string[]} */
objectIds;
}
JavaScript DeviceInfoGetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}