Update form instance
This API call is made when a user has completed editing a form and wants to save it on the LiveContent S1000D server. The call accepts an instance ID, which indicates that the form has been edited. The client must form and send an XML post that containing all the form data.
Example API call
/servlets3/wietmsd?id=1459765901242&book=s1000d_bike_41&collection=default&target=forms&action=save_form&form_type=genforms&form_name=SavedSearches&instance_title=S1000DBIKE-AAA-D00-00-00-00-AA-042-A-A_2020-05-12-1736&instance_name=suspendsession-1589294193795-1589294212860&instance_id=suspendsession-1589294193795-1589294212860
&visibility=PUBLIC
Parameters
| Parameter | Description |
|---|---|
target | forms |
action | update_form |
form_type | This value is always genforms. |
form_name | The system identifier of the form type, such as SavedSearches, genform1, or template. |
instance_title | The instance title, such as NewSearch. |
instance_name | Name of the instance to update. |
instance_id | ID of the instance to update. |
visibility | Access level, such as PRIVATE, PUBLIC, or the like. |
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. |
XML post data
This API call requires XML post data to complete. An example of that XML data is given here. The XML post data is wrapped in a <form-data/> element and contains a single <cond/> element for each piece of data the user wants to save for the form. Each <cond/> can have multiple children, if there are multiple values associated with a single form field or entry.
<form-data>
<cond label='' id='form_title'>
<item>S1000DBIKE-AAA-D00-00-00-00-AA-042-A-A_2020-05-12-1736</item>
</cond>
<cond label='' id='ss_desc'>
<item>Bicycle%20-%20Description%20of%20function</item>
</cond>
</cond>
<cond label='' id='ss_docid'>
<item>S1000DBIKE-AAA-D00-00-00-00-AA-042-A-A</item>
</cond>
. . .
<cond label='Access%20Control' id='ss_visibility'>
<item label='Public'>PUBLIC</item>
</cond>
</form-data>
Returns
- On success
-
<RESULT> <STATUS>OK</STATUS> <FORMID>suspendsession-1589294193795-1589294212860</FORMID> </RESULT> - On failure
- Returns nothing