THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Note that except where noted, all methods require the requesting application to have a valid API key issued by the Wookie server administrator.
Widget Instances
See also strawman for 0.8.2 https://issues.apache.org/jira/browse/WOOKIE-34
An instance is identified using a combination of the following parameters:
...
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="bf642956beb18d1f-13a58c95-49fd4a85-93bb9ee3-a1926b28c59764e5dfee138c"><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="98e11ca007ee9ff9-fe3efaea-49eb42fa-9a189440-c49fc6507bda287fa57babac"><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. |