Documentation Center

List generic form instances

Generic forms are stored and referenced by an instance ID, matched with a form name. This API call returns a list of all of the instance IDs, form titles, and other form information for all of the instances saved under a specific form name, such as SavedSearches.

Example API call

/servlets3/wietmsd?id=1459152075302&book=s1000d_bike_41&collection=default&target=forms&action=get_form_instances&form_type=genforms&caller=rm&form_name=SavedSearches

Parameters

ParameterDescription
targetforms
actionget_form_instances
form_typeThis value is always genforms.
callerrm
form_nameThe system identifier of the form type, such as SavedSearches, genform1, or template.
idA session ID that is valid for this collection and publication combination.
book The name of the publication, such as s1000d_bike_41.
collectionThe name of the collection that the publication is registered in, such as default.

Returns

On success
An XML instance that shows the list of forms, of the specified type that are owned by the user. The instance ID for each form is stored in the @name attribute of the <instance/> element, while its human-readable title is stored in the element's text.

When form_name=SavedSearches, the list of Saved Searches is returned:

<form_instances form_type='genforms' form_name='SavedSearches'>
     <header/>
	         <body>
		             <instance name='savedsearches-1459152075302-1459152581728'>New Saved Search</instance>
		             <instance name='savedsearches-1459152075302-1459152867192'>Saved Search</instance>
	         </body>
</form_instances>
On failure
If no instances exist, the API call will return an XML instance:
<form_instances form_type='genforms' form_name='SavedSearches'>
     <noinstances/>
</form_instances>