Read or list content widget objects. (See API authentication for general information how to use these APIs.)
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
id |
String |
No |
Identifier of a content widget. |
|
siteGroupId |
String |
No |
Identifier of a site group. |
|
fullHistory |
Boolean |
No |
If false, do not include the fields |
Either 'id' or 'siteGroupId' must be specified, but not both. If 'siteGroupId' is specified, all widget objects belonging to this site group are retrieved.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Object |
Array of widget objects . |
If 'id' was specified in the request, this array contains at most one element.
Example
$ cx.py /widget '{ "id": "0ab24abee9a85d869b29f46c83714461b0fe05f7" }'
{
"widgets": [
{
"siteGroupId": "9222300742653756873",
"id": "0ab24abee9a85d869b29f46c83714461b0fe05f7",
"description": "My first content widget",
"lastUpdatedBy": "ivar.rummelhoff@cxense.com",
"lastUpdatedAt": "2013-08-21T12:43:37.901Z",
"settings": {
"type": "basic",
"size": 5,
"contentId": "74732be6b5b79f0953f6606870aad034369ed528"
}
}
]
}