Page History

GET {wookie}/widgetinstances

Not supported.

Get or Create instance

POST {wookie}/widgetinstances {params:instance_params}

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="02d4b19f472ad425-aa074ccd-4af04f6d-a5788770-dc36c640546132f1aa0933d8"><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>

GET {wookie}/services {?locale=language_tag}

Returns an XML document containing all services and any widgets associated with the service category. If a locale is specified, the returned information is localized, for example widget titles, descriptions, license information will be in the specified language where available.

GET {wookie}/services/{service_name} {?locale=language_tag}

Returns an XML representation of the service specified by service_name and all the widgets associated with it. If a locale is specified, the returned information is localized, for example widget titles, descriptions, license information will be in the specified language where available.

POST {wookie}/services/ {param:name}

Creates a new service with the name provided using the name parameter. If there is already a service with this name, a http 409 (conflict) error is returned. This method requires authentication using a widgetadmin role, e.g. using HTTP Basic authentication.

PUT {wookie}/services/{service_name} {param:name}

Renames the service specified by service_name with the new name given by the name parameter. This method requires authentication using a widgetadmin role, e.g. using HTTP Basic authentication.

DELETE {wookie}/services/{service_name}

Deletes the service specified by service_name. This method requires authentication using a widgetadmin role, e.g. using HTTP Basic authentication.

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="2a50e34306324806-25a7eca2-4bdf4fc5-a132af62-624f3535d5f3615ff3e1a332"><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.