Documentation Center

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&time=1459244946886&target=forms&action=delete_form_instance&form_type=genforms&form_name=SavedSearches&instance_name=savedsearches-1459244947346-1459248605379&instance_id=savedsearches-1459244947346-1459248605379

Parameters

ParameterDescription
targetforms
actiondelete_form_instance
form_typeThis value is always genforms
form_nameThe system identifier of the form type that is being targeted for deletion, such as SavedSearches, genform1, or template.
instance_nameThe name of the instance to be deleted.
instance_idThe ID of the instance to be deleted.
idA session ID that is valid for this collection and publication combination.
bookThe name of the publication, such as PDMUNITTEST.
collectionThe name of the collection that the publication is registered in, such as default.
timeTo prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a time parameter that is based on the time at which the call is made.

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 with instance_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.