THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
- api_key: The key issued to a particular application
- shareddatakey: The key generated by an application representing a specific context (e.g. a page, post, section, group or other identified context)
- userid: An identifier (typically a hash rather than a real user Id) issued by an application representing the current viewer of the widget instance
- widgetid: The URI of the widget this is an instance of (optional, see servicetype below)
- servicetype: Where an individual widget is not requested by URI as above, this parameter should contain the category of widget to be instantiated, e.g. "chat"
- locale: The preferred locale of the widget, expressed using a BCP47 Language Tag
Action | Request | Example Response | Description | ||
|---|---|---|---|---|---|
| GET {wookie}/widgetinstances |
| Not supported. | ||
Get or Create instance | POST {wookie}/widgetinstances {params:instance_params} | <widgetdata> | Either creates a new instance for the given parameters, or retrieves an already-created instance. If a new instance is successfully created, the response has a HTTP status code of 201; if an instance if successfully retrieved, a status code of 200 is returned. | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d3dd76c39a91c277-954bdde6-4ce34d56-aab5ade3-b029634fa5d4f53de05b3bfd"><ac:plain-text-body><![CDATA[ |
| PUT {wookie}/widgetinstances {params:instance_params, action, [cloneshareddatakey]} |
| Either stop, resume, or clone an instance, depending on the content of the action parameter. If the action is "clone", a shared data key for the clone must be provided using the "cloneshareddatakey" parameter. | ]]></ac:plain-text-body></ac:structured-macro> |
...
Action | Request | Example | Description | ||
|---|---|---|---|---|---|
| GET {wookie}/properties |
| Not supported. | ||
| GET {wookie}/properties {params: instance_params, propertyname} |
| Returns the value of the specified property for the specified instance. | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d7ee93760eaeda12-24f2d047-4ec64d1b-99eda821-a30811c833f4a08a38b50fbf"><ac:plain-text-body><![CDATA[ |
| POST {wookie}/properties {params: instance_params, propertyname, propertyvalue, [is_public=true]} |
| Sets a property for the specified instance. If is_public=true is set, the property set is a Shared Data entry; otherwise it is a Preference. | ]]></ac:plain-text-body></ac:structured-macro> |
| PUT {wookie}/properties {params: instance_params, propertyname, propertyvalue} |
| Updates the value of the specified property of the specified Widget Instance. | ||
| DELETE {wookie}/properties {params: instance_params, propertyname} |
| Deletes a property. This method returns a 404 status code if there is no matching property. |