Represents the device view with information about the managed network elements. It provides device information such as device name, device type, ip address, software type, version, and also provides the reachability and management status.
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/Devices
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Response Parameters
adminStatus
String
|
Represents the current admin status of the device.
|
clearedAlarms
int
|
The number of cleared alarms against this device.
|
collectionDetail
String
|
A detailed status of inventory collection
|
collectionTime
Date
|
Time of inventory collection
|
creationTime
Date
|
The timestamp when the instance of the device was created.
|
criticalAlarms
int
|
The number of critical alarms against this device.
|
deviceId
Long
|
An internal id to recognize the device, which is the id of the associated management network element associated with this device.
|
deviceName
String
|
|
deviceType
String
|
|
informationAlarms
int
|
The number of information alarms against this device.
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available.
|
location
String
|
The system location of the device.
|
majorAlarms
int
|
The number of major alarms against this device.
|
managementStatus
LifecycleStateEnum
|
Represents the current management state of the network element: managed, unmanaged, under maintenance, and so on. This state is modified by events in the network and network management system, and also by user request.
Allowed values:
- UNKNOWN
- ADDED_ININITIALSTATE
- MANAGED_BUT_NEVERSYNCHRONIZED
- MANAGED_AND_SYNCHRONIZED
- MANAGED_BUT_OUTOFSYNC
- MANAGED_BUT_LOSSOFCONNECTIVITY
- PREPROVISIONED
- UNMANAGED
- INSERVICE_MAINTENANCE
- MANAGED_BUT_INCOMPLETE
- MANAGED_BUT_AGENTSHUTTINGDOWN
- MANAGED_PREPARINGFORMAINTENANCE
- MANAGED_BUT_DUPLICATE
- MANAGED_BUT_CONFLICTINGCREDENTIALS
- MANAGED_BUT_SYNCHRONIZING
- UNMANAGED_UNLICENSED
- IN_SERVICE
- OUT_OF_SERVICE
- OUT_OF_SERVICE_FOR_MAINTENANCE
- SYNC_DISABLED
- QUARANTINED
|
manufacturerPartNr
String[]
|
The manufacturer part numbers that make up the device chassis.
|
minorAlarms
int
|
The number of minor alarms against this device.
|
productFamily
String
|
The product family of this device.
|
reachability
ReachabilityStateEnum
|
Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element.
Allowed values:
- UNKNOWN
- REACHABLE
- UNREACHABLE
- AGENT_UNREACHABLE
- AGENT_UNLOADED
- PING_REACHABLE
- PING_UNREACHABLE
|
softwareType
String
|
A string that identifies the specific type of software that is installed. For example, Cisco IOS or Linux.
|
softwareVersion
String
|
The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field.
|
warningAlarms
int
|
The number of warning alarms against this device.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v1/data/Devices/15
<?xml version="1.0" ?>
<queryResponse type="Devices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Devices/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="devicesDTO" type="Devices" url="https://localhost/webacs/api/v1/data/Devices/15">
<devicesDTO displayName="String value" id="15" uuid="String value">
<collectionDetail>String value</collectionDetail>
<collectionTime>2019-08-20T09:00:56.981Z</collectionTime>
<creationTime>2019-08-20T09:00:56.982Z</creationTime>
<deviceId>15</deviceId>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>String value</ipAddress>
<location>String value</location>
<managementStatus>UNKNOWN</managementStatus>
<productFamily>String value</productFamily>
<reachability>UNKNOWN</reachability>
<softwareType>String value</softwareType>
<softwareVersion>String value</softwareVersion>
<adminStatus>String value</adminStatus>
<clearedAlarms>1</clearedAlarms>
<criticalAlarms>1</criticalAlarms>
<informationAlarms>1</informationAlarms>
<majorAlarms>1</majorAlarms>
<manufacturerPartNrs>
<manufacturerPartNr>String value</manufacturerPartNr>
</manufacturerPartNrs>
<minorAlarms>1</minorAlarms>
<warningAlarms>1</warningAlarms>
</devicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/Devices/15.json
{
"queryResponse" : {
"@type" : "Devices",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Devices\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "devicesDTO",
"@type" : "Devices",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Devices\/15",
"devicesDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"collectionDetail" : "String value",
"collectionTime" : "2019-08-20T09 : 00 : 56.981Z",
"creationTime" : "2019-08-20T09 : 00 : 56.982Z",
"deviceId" : 15,
"deviceName" : "String value",
"deviceType" : "String value",
"ipAddress" : "String value",
"location" : "String value",
"managementStatus" : "UNKNOWN",
"productFamily" : "String value",
"reachability" : "UNKNOWN",
"softwareType" : "String value",
"softwareVersion" : "String value",
"adminStatus" : "String value",
"clearedAlarms" : 1,
"criticalAlarms" : 1,
"informationAlarms" : 1,
"majorAlarms" : 1,
"manufacturerPartNrs" : {
"manufacturerPartNr" : "String value"
},
"minorAlarms" : 1,
"warningAlarms" : 1
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/Devices
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
adminStatus
String
|
Represents the current admin status of the device.
|
clearedAlarms
int
|
The number of cleared alarms against this device.
|
collectionDetail
String
|
A detailed status of inventory collection
|
collectionTime
Date
|
Time of inventory collection
|
creationTime
Date
|
The timestamp when the instance of the device was created.
|
criticalAlarms
int
|
The number of critical alarms against this device.
|
deviceId
Long
|
An internal id to recognize the device, which is the id of the associated management network element associated with this device.
|
deviceName
String
|
|
deviceType
String
|
|
informationAlarms
int
|
The number of information alarms against this device.
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available.
|
location
String
|
The system location of the device.
|
majorAlarms
int
|
The number of major alarms against this device.
|
managementStatus
LifecycleStateEnum
|
Represents the current management state of the network element: managed, unmanaged, under maintenance, and so on. This state is modified by events in the network and network management system, and also by user request.
Allowed values:
- UNKNOWN
- ADDED_ININITIALSTATE
- MANAGED_BUT_NEVERSYNCHRONIZED
- MANAGED_AND_SYNCHRONIZED
- MANAGED_BUT_OUTOFSYNC
- MANAGED_BUT_LOSSOFCONNECTIVITY
- PREPROVISIONED
- UNMANAGED
- INSERVICE_MAINTENANCE
- MANAGED_BUT_INCOMPLETE
- MANAGED_BUT_AGENTSHUTTINGDOWN
- MANAGED_PREPARINGFORMAINTENANCE
- MANAGED_BUT_DUPLICATE
- MANAGED_BUT_CONFLICTINGCREDENTIALS
- MANAGED_BUT_SYNCHRONIZING
- UNMANAGED_UNLICENSED
- IN_SERVICE
- OUT_OF_SERVICE
- OUT_OF_SERVICE_FOR_MAINTENANCE
- SYNC_DISABLED
- QUARANTINED
|
manufacturerPartNr
String[]
|
The manufacturer part numbers that make up the device chassis.
|
minorAlarms
int
|
The number of minor alarms against this device.
|
productFamily
String
|
The product family of this device.
|
reachability
ReachabilityStateEnum
|
Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element.
Allowed values:
- UNKNOWN
- REACHABLE
- UNREACHABLE
- AGENT_UNREACHABLE
- AGENT_UNLOADED
- PING_REACHABLE
- PING_UNREACHABLE
|
softwareType
String
|
A string that identifies the specific type of software that is installed. For example, Cisco IOS or Linux.
|
softwareVersion
String
|
The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field.
|
warningAlarms
int
|
The number of warning alarms against this device.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v2/data/Devices/15
<?xml version="1.0" ?>
<queryResponse type="Devices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/Devices/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="devicesDTO" type="Devices" url="https://localhost/webacs/api/v2/data/Devices/15">
<devicesDTO displayName="String value" id="15" uuid="String value">
<collectionDetail>String value</collectionDetail>
<collectionTime>2019-08-20T09:00:56.988Z</collectionTime>
<creationTime>2019-08-20T09:00:56.988Z</creationTime>
<deviceId>15</deviceId>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>String value</ipAddress>
<location>String value</location>
<managementStatus>UNKNOWN</managementStatus>
<productFamily>String value</productFamily>
<reachability>UNKNOWN</reachability>
<softwareType>String value</softwareType>
<softwareVersion>String value</softwareVersion>
<adminStatus>String value</adminStatus>
<clearedAlarms>1</clearedAlarms>
<criticalAlarms>1</criticalAlarms>
<informationAlarms>1</informationAlarms>
<majorAlarms>1</majorAlarms>
<manufacturerPartNrs>
<manufacturerPartNr>String value</manufacturerPartNr>
</manufacturerPartNrs>
<minorAlarms>1</minorAlarms>
<warningAlarms>1</warningAlarms>
</devicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/Devices/15.json
{
"queryResponse" : {
"@type" : "Devices",
"@requestUrl" : "https://localhost/webacs/api/v2/data/Devices/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "devicesDTO",
"@type" : "Devices",
"@url" : "https://localhost/webacs/api/v2/data/Devices/15",
"devicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "String value",
"clearedAlarms" : 1,
"collectionDetail" : "String value",
"collectionTime" : 1566291656988,
"creationTime" : 1566291656988,
"criticalAlarms" : 1,
"deviceId" : 15,
"deviceName" : "String value",
"deviceType" : "String value",
"informationAlarms" : 1,
"ipAddress" : "String value",
"location" : "String value",
"majorAlarms" : 1,
"managementStatus" : "UNKNOWN",
"manufacturerPartNrs" : {
"manufacturerPartNr" : [ "String value" ]
},
"minorAlarms" : 1,
"productFamily" : "String value",
"reachability" : "UNKNOWN",
"softwareType" : "String value",
"softwareVersion" : "String value",
"warningAlarms" : 1
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/Devices
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Updated
Since v3 version:
- API does not contain alarm counts to improve performance.
- The attribute 'collectionStatus' was added.
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of manufacturer part numbers.
Response Parameters
adminStatus
String
|
Represents the current admin status of the device.
|
collectionDetail
String
|
A detailed status of inventory collection
|
collectionStatus
InventoryCollectionStatusEnum
|
Last inventory collection status
Allowed values:
- COMPLETED
- MAJORCOMPLETED
- COLLECTIONFAILURE
- PARTIALCOLLECTIONFAILURE
- SNMPCONNECTIVITYFAILED
- WRONGCLICREDENTIALS
- WRONGHTTPCREDENTIALS
- SYNCHRONIZING
- MAJORSYNCHRONIZING
- MINORSYNCHRONIZING
- SNMPUSERAUTHENTICATIONFAILED
- NOLICENSE
- ADDINITIATED
- DELETEINPROGRESS
- PINGUNREACHABLE
- SPT_ONLY
- IN_SERVICE_MAINTENANCE
- IN_SERVICE
|
collectionTime
Date
|
Time of inventory collection
|
creationTime
Date
|
The timestamp when the instance of the device was created.
|
deviceId
Long
|
An internal id to recognize the device, which is the id of the associated management network element associated with this device.
|
deviceName
String
|
|
deviceType
String
|
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available.
|
location
String
|
The system location of the device.
|
managementStatus
LifecycleStateEnum
|
Represents the current management state of the network element: managed, unmanaged, under maintenance, and so on. This state is modified by events in the network and network management system, and also by user request.
Allowed values:
- UNKNOWN
- ADDED_ININITIALSTATE
- MANAGED_BUT_NEVERSYNCHRONIZED
- MANAGED_AND_SYNCHRONIZED
- MANAGED_BUT_OUTOFSYNC
- MANAGED_BUT_LOSSOFCONNECTIVITY
- PREPROVISIONED
- UNMANAGED
- INSERVICE_MAINTENANCE
- MANAGED_BUT_INCOMPLETE
- MANAGED_BUT_AGENTSHUTTINGDOWN
- MANAGED_PREPARINGFORMAINTENANCE
- MANAGED_BUT_DUPLICATE
- MANAGED_BUT_CONFLICTINGCREDENTIALS
- MANAGED_BUT_SYNCHRONIZING
- UNMANAGED_UNLICENSED
- IN_SERVICE
- OUT_OF_SERVICE
- OUT_OF_SERVICE_FOR_MAINTENANCE
- SYNC_DISABLED
- QUARANTINED
|
manufacturerPartNr
String[]
|
The manufacturer part numbers that make up the device chassis.
|
productFamily
String
|
The product family of this device.
|
reachability
ReachabilityStateEnum
|
Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element.
Allowed values:
- UNKNOWN
- REACHABLE
- UNREACHABLE
- AGENT_UNREACHABLE
- AGENT_UNLOADED
- PING_REACHABLE
- PING_UNREACHABLE
|
softwareType
String
|
A string that identifies the specific type of software that is installed. For example, Cisco IOS or Linux.
|
softwareVersion
String
|
The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v3/data/Devices/15
<?xml version="1.0" ?>
<queryResponse type="Devices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/Devices/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="devicesDTO" type="Devices" url="https://localhost/webacs/api/v3/data/Devices/15">
<devicesDTO displayName="String value" id="15" uuid="String value">
<collectionDetail>String value</collectionDetail>
<collectionTime>2019-08-20T09:00:57.001Z</collectionTime>
<creationTime>2019-08-20T09:00:57.001Z</creationTime>
<deviceId>15</deviceId>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>String value</ipAddress>
<location>String value</location>
<managementStatus>UNKNOWN</managementStatus>
<productFamily>String value</productFamily>
<reachability>UNKNOWN</reachability>
<softwareType>String value</softwareType>
<softwareVersion>String value</softwareVersion>
<adminStatus>String value</adminStatus>
<collectionStatus>COMPLETED</collectionStatus>
<manufacturerPartNrs>
<manufacturerPartNr>String value</manufacturerPartNr>
<manufacturerPartNr>Another string value</manufacturerPartNr>
</manufacturerPartNrs>
</devicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/Devices/15.json
{
"queryResponse" : {
"@type" : "Devices",
"@requestUrl" : "https://localhost/webacs/api/v3/data/Devices/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "devicesDTO",
"@type" : "Devices",
"@url" : "https://localhost/webacs/api/v3/data/Devices/15",
"devicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "String value",
"collectionDetail" : "String value",
"collectionStatus" : "COMPLETED",
"collectionTime" : "2019-08-20T09:00:57.001Z",
"creationTime" : "2019-08-20T09:00:57.001Z",
"deviceId" : 15,
"deviceName" : "String value",
"deviceType" : "String value",
"ipAddress" : "String value",
"location" : "String value",
"managementStatus" : "UNKNOWN",
"manufacturerPartNrs" : {
"manufacturerPartNr" : [ "String value", "Another string value" ]
},
"productFamily" : "String value",
"reachability" : "UNKNOWN",
"softwareType" : "String value",
"softwareVersion" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/Devices
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Updated
Since v4 version:
- API uses a ManufacturerPartNr collection to represent manufacturer part numbers that make up the device chassis.
- The 'adminStatus' attribute type was changed from String to DeviceAdminStatusEnum.
Response Parameters
adminStatus
DeviceAdminStatusEnum
|
Represents the current admin status of the device.
Allowed values:
- UNMANAGED
- MANAGED
- MAINTENANCE
|
collectionDetail
String
|
A detailed status of inventory collection
|
collectionStatus
InventoryCollectionStatusEnum
|
Last inventory collection status
Allowed values:
- COMPLETED
- MAJORCOMPLETED
- COLLECTIONFAILURE
- PARTIALCOLLECTIONFAILURE
- SNMPCONNECTIVITYFAILED
- WRONGCLICREDENTIALS
- WRONGHTTPCREDENTIALS
- SYNCHRONIZING
- MAJORSYNCHRONIZING
- MINORSYNCHRONIZING
- SNMPUSERAUTHENTICATIONFAILED
- NOLICENSE
- ADDINITIATED
- DELETEINPROGRESS
- PINGUNREACHABLE
- SPT_ONLY
- IN_SERVICE_MAINTENANCE
- IN_SERVICE
|
collectionTime
Date
|
Time of inventory collection
|
creationTime
Date
|
The timestamp when the instance of the device was created.
|
deviceId
Long
|
An internal id to recognize the device, which is the id of the associated management network element associated with this device.
|
deviceName
String
|
|
deviceType
String
|
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available.
|
location
String
|
The system location of the device.
|
managementStatus
LifecycleStateEnum
|
Represents the current management state of the network element: managed, unmanaged, under maintenance, and so on. This state is modified by events in the network and network management system, and also by user request.
Allowed values:
- UNKNOWN
- ADDED_ININITIALSTATE
- MANAGED_BUT_NEVERSYNCHRONIZED
- MANAGED_AND_SYNCHRONIZED
- MANAGED_BUT_OUTOFSYNC
- MANAGED_BUT_LOSSOFCONNECTIVITY
- PREPROVISIONED
- UNMANAGED
- INSERVICE_MAINTENANCE
- MANAGED_BUT_INCOMPLETE
- MANAGED_BUT_AGENTSHUTTINGDOWN
- MANAGED_PREPARINGFORMAINTENANCE
- MANAGED_BUT_DUPLICATE
- MANAGED_BUT_CONFLICTINGCREDENTIALS
- MANAGED_BUT_SYNCHRONIZING
- UNMANAGED_UNLICENSED
- IN_SERVICE
- OUT_OF_SERVICE
- OUT_OF_SERVICE_FOR_MAINTENANCE
- SYNC_DISABLED
- QUARANTINED
|
manufacturerPartNr
ManufacturerPartNr[]
|
The device chassis details.
|
name
String
|
|
partNumber
String
|
|
serialNumber
String
|
|
|
productFamily
String
|
The product family of this device.
|
reachability
ReachabilityStateEnum
|
Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element.
Allowed values:
- UNKNOWN
- REACHABLE
- UNREACHABLE
- AGENT_UNREACHABLE
- AGENT_UNLOADED
- PING_REACHABLE
- PING_UNREACHABLE
|
softwareType
String
|
A string that identifies the specific type of software that is installed. For example, Cisco IOS or Linux.
|
softwareVersion
String
|
The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v4/data/Devices/15
<?xml version="1.0" ?>
<queryResponse type="Devices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/Devices/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="devicesDTO" type="Devices" url="https://localhost/webacs/api/v4/data/Devices/15">
<devicesDTO displayName="String value" id="15" uuid="String value">
<collectionDetail>String value</collectionDetail>
<collectionTime>2019-08-20T09:00:57.015Z</collectionTime>
<creationTime>2019-08-20T09:00:57.015Z</creationTime>
<deviceId>15</deviceId>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>String value</ipAddress>
<location>String value</location>
<managementStatus>UNKNOWN</managementStatus>
<productFamily>String value</productFamily>
<reachability>UNKNOWN</reachability>
<softwareType>String value</softwareType>
<softwareVersion>String value</softwareVersion>
<adminStatus>UNMANAGED</adminStatus>
<collectionStatus>COMPLETED</collectionStatus>
<manufacturerPartNrs>
<manufacturerPartNr>
<name>String value</name>
<partNumber>String value</partNumber>
<serialNumber>String value</serialNumber>
</manufacturerPartNr>
<manufacturerPartNr>
<name>Another string value</name>
<partNumber>Another string value</partNumber>
<serialNumber>Another string value</serialNumber>
</manufacturerPartNr>
</manufacturerPartNrs>
</devicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/Devices/15.json
{
"queryResponse" : {
"@type" : "Devices",
"@requestUrl" : "https://localhost/webacs/api/v4/data/Devices/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "devicesDTO",
"@type" : "Devices",
"@url" : "https://localhost/webacs/api/v4/data/Devices/15",
"devicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "UNMANAGED",
"collectionDetail" : "String value",
"collectionStatus" : "COMPLETED",
"collectionTime" : "2019-08-20T09:00:57.015Z",
"creationTime" : "2019-08-20T09:00:57.015Z",
"deviceId" : 15,
"deviceName" : "String value",
"deviceType" : "String value",
"ipAddress" : "String value",
"location" : "String value",
"managementStatus" : "UNKNOWN",
"manufacturerPartNrs" : {
"manufacturerPartNr" : [ {
"name" : "String value",
"partNumber" : "String value",
"serialNumber" : "String value"
}, {
"name" : "Another string value",
"partNumber" : "Another string value",
"serialNumber" : "Another string value"
} ]
},
"productFamily" : "String value",
"reachability" : "UNKNOWN",
"softwareType" : "String value",
"softwareVersion" : "String value"
}
} ]
}
}