Delete generic form instance
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call deletes a form instance by this ID pair.
Example API call
/servlets3/wietmsd?id=1459244947346&book=s1000d_bike_41&collection=default&target=forms&action=delete_form_instance&form_type=genforms&form_name=SavedSearches&instance_name=savedsearches-1459244947346-1459248605379&instance_id=savedsearches-1459244947346-1459248605379
Parameters
| Parameter | Description |
|---|---|
target | forms |
action | delete_form_instance |
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. |
instance_name | The name of the instance to be deleted. |
instance_id | The ID of the instance to be deleted. |
id | A session ID that is valid for this collection and publication combination. |
book | The name of the publication, such as PDMUNITTEST. |
collection | The name of the collection that the publication is registered in, such as default. |
Returns
- On success
-
This API call returns a list of all of the instance IDs, form titles, and other form information for all of the instances under a specific form name. As result, the selected generic form should be deleted and not listed in this list.
Example what is returned when form_name=SavedSearches.
Saved search withinstance_name='savedsearches-1459244947346-1459248605379'is deleted:<form_instances form_type='genforms' form_name='SavedSearches'> <header/> <body> <instance name='savedsearches-1459244947346-1459248593128'>Bike Search</instance> </body> </form_instances> - On failure
- Result of the Load Form Instance XML API call that demonstrates that the selected generic form was not deleted.