Documentation Center

Upload zip and prepare incremental update

Incremental updates can be applied manually by uploading a Zip file through this API call. The Zip file is sent to the server, usually using an HTML form field that is set to type file. There are other methods of how to post this file data to the API call. On the server side, the Zip is unpacked and verified. A message is returned to the caller, indicating if the server is ready to proceed to install the update, or if the zip was rejected and the operation has failed.

Example API call

/servlets3/wietmsd?id=1459754561359&uniqid=1459754560082&book=bike&collection=default&target=update&action=prepare_updates

Parameters

ParameterDescription
targetupdate
actionprepare_updates
uniqidTo 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.
idA session ID that is valid for this collection and publication combination.
book The name of the publication, such as bike.
collectionThe name of the collection that the publication is registered in, such as default.

XML Post Data

Information about the package to update. For example:
Content-Disposition: form-data; name="FILE_NAME"; filename="C:\ProgramData\XyEnterprise\LiveContent\publications\bike\update_xml_03\update_xml_03.zip"
Content-Type: application/x-zip-compressed

Returns

On success
A message that is set in the info.xml file inside Incremental Update .zip:
<response message="Please wait while updates are being installed" status="success">
  <body>
    <message message="Please wait while updates are being installed">
    </message>
  </body>
</response>
On failure
<response message="Zip file not found." status="error" >
  <body>
    <message message="Zip file not found." />
  </body>
</response>