Get Device Status
post
/config/sim/v2/devices/getDeviceStatus
records
Request
Supported Media Types
- application/json
- multipart/form-data
Root Schema : schema
Type:
Show Source
object-
include:
string
If specificied, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
serviceHostId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 1792)
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
object-
count:
integer
Number of records returned on this pageExample:
10 -
hasMore:
boolean
Indicates whether there are additional pages of recordsExample:
true -
items:
array items
Device Status records
-
limit:
integer
The maximum number of records returned on a pageExample:
10 -
offset:
integer
The page number of this data. Starts at 0.Example:
0 -
totalResults:
integer
Total number of records in the data setExample:
100
Nested Schema : items
Type:
arrayDevice Status records
Show Source
-
Array of:
object deviceStatus
Device Status record
Nested Schema : deviceStatus
Type:
objectDevice Status record
Show Source
-
calVersion:
string
CAL client versionExample:
108.1.4.16 -
clientVersion:
string
Simphony software versionExample:
19.5.0.0.299 -
hierUnitId:
integer
Unique hierarchy unit referenceExample:
100 -
lastReceivedTime:
string
The last time metrics were updatedExample:
2022-01-23T09:21:00 -
serviceHostId:
integer
Unique service host referenceExample:
244 -
serviceHostOverallStatus:
integer
Service Host health status (1 - healthy ; 0 - not healthy). Review status details for more information.Example:
1