Load generic form instance XML
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call returns the XML document that represents the form instance and contains all of the values and information that a user has entered.
Example API call
/servlets3/wietmsd?id=1459152075302&book=s1000d_bike_41&collection=default&time=1459152073970&target=forms&action=get_form&form_type=genforms&form_name=SavedSearches&instance_name=savedsearches-1459152075302-1459152581728&instance_id=savedsearches-1459152075302-1459152581728
Parameters
| Parameter | Description |
|---|---|
target | forms |
action | get_form |
form_type | This value is always genforms. |
form_name | The system identifier of the form type, such as SavedSearches, genform1, or template. |
instance_name | Instance name, such as savedsearches-1459152075302-1459152581728 or genform1-1459244947346-1459246136762 |
instance_id | Instance name, such as savedsearches-1459152075302-1459152581728 or genform1-1459244947346-1459246136762 |
time | To 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. |
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-instance> <form-header> <form-id>savedsearches-1459152075302-1459152581728</form-id> <user>admin</user> <user-group>ADMINISTRATOR</user-group> <collection>default</collection> <book>s1000d_bike_41</book> <form-type>genforms</form-type> <form-name>SavedSearches</form-name> <visibility>PRIVATE</visibility> <last_update>03/28/2016 04:19:20 AM</last_update> <form-title>New Saved Search</form-title> </form-header> <form-data> <cond id="scope" label="Scope"> <item>topic_title:</item> </cond> <cond id="ignoreCase" label="Ignore Case"> <item>true</item> </cond> <cond id="wholeWords" label="Whole Words"> <item>false</item> </cond> <cond id="term1" label="Term 1"> <item/> </cond> <cond id="term2" label="Term 2"> <item/> </cond> <cond id="op" label="Search Operator"> <item/> </cond> <cond id="andCategories" label="And Categories"> <item>0</item> </cond> <cond id="branchLimit" label="Branch Search"> <item>0</item> </cond> <cond id="catBranchLimit" label="Categorical Branch Search"> <item>0</item> </cond> <cond id="tocParentId" label="TOC Branch ID"> <item>undefined</item> </cond> <cond id="advancedSearch" label="Advanced Search"> <item>0</item> </cond> <cond id="category" label="Search Category"> <item>topic_title</item> <cond id="topic" label="Search topic"> <item>attributed</item> </cond> </cond> </form-data> </form-instance> - On failure
- Returns nothing