URL
GET https://{api-url}/api/v2/tenants/{tenantId}/patches/compliance/{complianceId}/deviceGroups
Sample URLs
To retrieve device groups attached to a patch compliance:
https://{api-url}/api/v2/tenants/client_16/patches/compliance/PCMP-f9d7474c-11ec-44d4-9060-64a62825b9b3/deviceGroups
To retrieve device groups attached to a patch compliance with pagination:
https://{api-url}/api/v2/tenants/client_16/patches/compliance/PCMP-f9d7474c-11ec-44d4-9060-64a62825b9b3/deviceGroups?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=name
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value
. - Space characters must be URL-encoded.
Parameters
The parameters are optional:
Field | Default Value |
---|---|
pageNo={pageNo} | 1 |
pageSize={pageSize} | 100 |
isDescendingOrder={true/false} | true |
sortName={field} | name |
Sample response
{
"results": [{
"id": "1011",
"uniqueId": "DGP-6f0f8fa6-480d-45a1-9acd-e261647860e1",
"name": "Windows Device Group-SJ",
"description": "Procurement division Windows devices",
"client": {
"id": 16,
"uniqueId": "client_16",
"name": "Logix",
"activated": true
}
},
{
"id": "1076",
"uniqueId": "DGP-cd55439b-eb44-4b68-a8b1-3e787df39191",
"name": "Linux Device Group-CA",
"description": "Maintenance division Linux devices",
"client": {
"id": 16,
"uniqueId": "client_16",
"name": "Logix",
"activated": true
}
},
{
"id": "1077",
"uniqueId": "DGP-3d12eb46-d0ec-4825-a247-0fc87726a73d",
"name": "Linux Device Group",
"description": "",
"client": {
"id": 16,
"uniqueId": "client_16",
"name": "Logix",
"activated": true
}
},
{
"id": "1075",
"uniqueId": "DGP-468b2466-0d94-444f-82bf-367c5d5b891e",
"name": "Critical Windows Devices",
"description": "High priority devices",
"client": {
"id": 16,
"uniqueId": "client_16",
"name": "Logix",
"activated": true
}
}
],
"totalResults": 4,
"orderBy": "name",
"pageNo": 1,
"pageSize": 10,
"totalPages": 1,
"nextPage": false,
"previousPageNo": 0,
"descendingOrder": true
}