Delete all generic form Instances of one type
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call deletes all forms that a user owns that of a specific type.
Example API call
/servlets3/wietmsd?id=1459154149530&book=s1000d_bike_41&collection=default&target=forms&action=delete_all_form_instances&form_type=genforms&form_name=SavedSearches
Parameters
| Parameter | Description |
|---|---|
target | forms |
action | delete_all_form_instances |
form_type | This value is always genforms. |
form_name | The system identifier of the form type that is being targeted for deletion, such as SavedSearches, genform1, or template. |
id | A session ID that is valid for this collection and publication combination. |
book | The name of the publication, such as s1000d_bike_41. |
collection | The name of the collection that the publication is registered in, such as default. |
Returns
- On success
-
<form_instances form_type='genforms' form_name='SavedSearches'> <noinstances/> </form_instances> - On failure
-
Result of the Load Form Instance XML API call that demonstrates that generic form was not deleted, for example:
<form_instances form_type='genforms' form_name='SavedSearches'> <header/> <body> <instance name='savedsearches-1459152075302-1459152581728'>New Saved Search</instance> </body> </form_instances>