URL
GET https://{api-url}/api/v2/tenants/{tenantId}/deviceGroups/{deviceGroupId}/childs/search
Sample URLs
https://{api-url}/api/v2/tenants/client_10/deviceGroups/DGP-46f180ed-5ab8-45e2-a06b-e902f53a2b3c/childs/search?pageNo=1&pageSize=100&isDescendingOrder=true&sortName=id
Parameters
Field | Default Value |
---|---|
pageNo={pageNo} | 1 |
pageSize={pageSize} | 100 |
isDescendingOrder={true/false} | true |
sortName={field} | id |
queryString={queryString} | NA |
NA indicates that the value is not applicable.
Status code
200 OK
Sample responses
These are two sample responses showing the retrieval of child resources and device groups within a parent device group:
{
"results": [{
"id": "DGP-bc92ea8e-f3cd-476e-a736-a8e606d43207",
"name": "Network Devices",
"createdDate": "2017-08-09T09:52:26+0000",
"updatedDate": "2017-08-09T09:52:26+0000",
"type": "DEVICE_GROUP",
"entityType": "DEVICE_GROUP"
},
{
"id": "e6d7e7a5-a410-47fe-a99d-33323b700d04",
"name": "dot-exp-bos-045.massdot.trans.internal",
"type": "DEVICE",
"resourceType": "VMWAREHOST",
"hostName": "",
"resourceName": "dot-exp-bos-045.massdot.trans.internal",
"aliasName": ""
},
{
"id": "e14dae78-b68a-4179-98db-02eab5feeea7",
"name": "dot-exp-bos-039.massdot.trans.internal",
"type": "DEVICE",
"resourceType": "VMWAREHOST",
"hostName": "",
"resourceName": "dot-exp-bos-039.massdot.trans.internal",
"aliasName": ""
},
{
"id": "4b53d84c-760a-49cb-a904-47271aed9091",
"name": "dot-exp-bos-022.massdot.trans.internal",
"type": "DEVICE",
"resourceType": "VMWAREHOST",
"hostName": "",
"resourceName": "dot-exp-bos-022.massdot.trans.internal",
"aliasName": ""
},
],
"totalResults": 4,
"orderBy": "id",
"pageNo": 1,
"pageSize": 100,
"totalPages": 1,
"nextPage": false,
"previousPageNo": 0,
"descendingOrder": true
}
{
"results": [
{
"id": "fcc492e9-64df-4ef0-b1b7-82167d87d4b4",
"name": "arn:aws:sns:us-east-1:290642135901:cloudtrail-sns",
"type": "SNS"
},
{
"id": "57778bb1-a294-450a-93e4-4371a74ac39f",
"name": "arn:aws:sns:us-east-1:290642135901:onboa-demo-sns",
"type": "SNS"
},
{
"id": "f7f247e2-3461-4ff1-bfdb-65ee2124c6c3",
"name": "arn:aws:sns:us-east-1:290642135901:alarm-notifications-topic",
"type": "SNS"
}
],
"totalResults": 3,
"orderBy": "id",
"pageNo": 1,
"pageSize": 100,
"totalPages": 1,
"nextPage": false,
"previousPageNo": 0,
"descendingOrder": true
}