Updating a widget's information in a community.
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Updating a community widget.
Tags: commapi


To update a widget's information in a community, do a PUT to the widget's "self" link obtained from the widget's entry obtained from a previous request like Getting a list of the widgets in a community. The new values for the Widget's state are taken from the request body specified as an ATOM widget entry. The Widget's new state is returned as an ATOM Widget entry in the response. See Community widgets feed for details on the widget entry values.

 

Table 1. Request/Response Parameters

Request URL
Request Body
Response Body
Possible Errors
"self" link from the widget's entry
ATOM widget entry with new widget state values desired
Widget Entry of modified widget.
  • previous widget id doesn't exist (403)
  • 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
PUT /communities/service/atom/community/widgets "self" link from the widget's entry
Content Type: application/atom+xml
Name Type Optional Description
communityUuid
string No The UUID of the community you wish to update widget from.
widgetInstanceId
string Yes ID of specific widget required.
Output
Content Type: application/atom+xml
Code Description
403
previous widget id doesn't exist
500
Community id not found
500
Widget id not found