Last Updated: 1/22/2020 12:11:03 AM
Get devices with given customers
Request
HTTP Request
GET /SMPI/{version}/service/wfbss/api/customers/computers
Parameters
Name |
Type |
Description |
Validation |
|---|---|---|---|
|
Optional Parameters |
|||
cids |
string |
A list of customer IDs separated by comma. |
At least one customer ID must be specified, and no more than 10. |
page |
integer |
Page number |
1 to max. If not set, default is 1. |
limit |
integer |
Number of devices per page |
1 to 100. If not set, default is 100. |
HTTP Request Example
Get devices of all your customers (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/computers
Get devices of all your customers (page 2 and 50 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/computers?page=2&limit=50
Get devices of specific customers (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/computers?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3
Request Body
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"paging": {
"total": 2,
"limit": 100,
"page": 1
},
"customers": [
{
"total": 2,
"id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C",
"eid": "05ACB83A-E709-47B5-98C1-6CEA25476536",
"computers": [
{
"ipaddr": "97.0.168.192",
"gid": 1,
"type": 1,
"name": "Computer_031b1d0ecb52c74b8a08c7261299ca19",
"cid": "031b1d0ecb52c74b8a08c7261299ca19"
},
{
"ipaddr": "46.0.168.192",
"gid": 1,
"type": 1,
"name": "Computer_04c5d02490fdc843b7c578daf6fc5c6a",
"cid": "04c5d02490fdc843b7c578daf6fc5c6a"
}
]
}
]
}
Name |
Type |
Description |
Length |
|---|---|---|---|
paging.total |
integer |
The total number of devices |
|
paging.limit |
integer |
The number of devices per page |
1 to 100 |
paging.page |
integer |
page number |
1 to max |
customers[].id |
string |
Customer ID |
GUID |
customers[].eid |
string |
For internal use only |
GUID |
customers[].total |
integer |
The number of devices belonging to the customer |
|
customers[].computers[].gid |
integer |
Group ID |
|
customers[].computers[].ipaddr |
string |
Device IP address |
|
customers[].computers[].type |
integer |
Device type |
1 = windows desktop, 2 = windows server, 3 = mac desktop, 4 = mac server, 5 = android, and 6 = ios |
customers[].computers[].name |
string |
Device name |
|
customers[].computers[].cid |
string |
Device ID |