Retrieving a widget from a community.
Added by IBM contributorIBM | Edited by Claudia R Elbourn on July 7, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

To get a widget's information from a community, do a GET to on the widget's "self" link obtained from the widget's entry obtained from a previous request like "Getting a list of widgets in a community".
Tags: commapi

The Widget's state is returned as an ATOM Widget entry in the response.

Table 1. Request/Response Parameters

Request URL
Request Body
Response Body
Possible Errors
"self" link from the widget's entry
ignored
Widget Entry of widget.
  • Community id not found: (500)
  • Widget id not found: (500)

 

Related Pages

Parent with ATOM entry documentation: Working with community widgets

 

Input
Method URI Description
GET /communities/service/atom/community/widgets "self" link from the widget's entry
Name Type Optional Description
communityUuid
string No The UUID of the community you wish to retrieve widget from.
widgetInstanceId
string Yes ID of specific widget required.
Output
Content Type: application/atom+xml
Code Description
500
Community id not found
500
Widget id not found