cdp.config.list
The cdp.config.list command is used to list the configured CDPs.
Requires Org-Admin rights.
TR50 Request
{
"cmd" : {
"command": "cdp.config.list",
"params": {
"offset": 0,
"limit": 10,
"sort": "+name"
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
offset | Integer | The starting list offset, used for pagination. Defaults to 0 if not specified. | |
limit | Integer | Limits the number of results returned. Defaults to 2000. | |
sort | String | sort is an optional parameter that defines the sort order of the result set. It allows to arrange the list in either ascending(+) or descending(-) order. It is possible to sort cdp.config.list in the following categories:
|
TR50 Response
If the command is sent successfully a success message and a list of configured CDPs is returned. Otherwise, an error and error message will be returned.
The result array will contain additional configuration information specific to the CDP type. The list of CDP configuration fields is available via cdp.config.desc.
{
"cmd": {
"success": true,
"params": {
"count": 1,
"result: [
{
"id": "55914c7c74e00c48b400001b",
"name": "Jasper CDP",
"status": "synchronized",
"error": "",
"connections": 0,
"carrier": "AT&T",
"type": "jasper",
"username": "demo@devicewise.com",
"licenseKey": "licensekey",
"ratePlans": [
"RatePlan0",
"RatePlan1"
],
"createdBy": "user@ilstechnology.com",
"createdOn": "2015-06-29T09:47:40.09-04:00",
"updatedBy": "user@ilstechnology.com",
"updatedOn": "2015-06-29T09:47:40.09-04:00"
}
]
}
}
}
Response Parameters
Name
|
Type
|
Description
|
---|---|---|
count | Integer | The total number of matching things. |
result | Array | The array of CDP objects. |
Result Array Object
Name
|
Type
|
Description
|
---|---|---|
id | String | The id of the CDP. |
name | String | The name of the CDP. |
status | String | The synchronization status of the CDP. |
error | String | Any error messages associated with the CDP synchronization. |
connections | Integer | The number of connections associated with the CDP. |
carrier | String | The cellular carrier. |
type | String | The CDP type. |
locked | Boolean | If set to true, only super-ops users are able to modify this config. |
createdBy | String | The email address of the user who created the CDP. |
createdOn | String | The date and time that the CDP was created. |
updatedBy | String | The email address of the user who last updated the CDP. |
updatedOn | String | The date and time that the CDP was updated. |