Documentation Center

Load document attachment list

This API call allows the client to load an XML instance that contains the list of attachments associated with a given user and document. This list is limited to those attachments that the current user can see, either those the user created or public attachments to the document.

Example API call

/servlets3/wietmsd?id=1520980553210&book=s1000d_bike_41&collection=default&target=attach&action=attach_list&docid=S1000DBIKE-AAA-D00-00-00-00-AA-041-A-A&user_name=admin

Parameters

ParameterDescription
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.
targetattach
actionattach_list
docidThe @DOCUMENT_ID attribute on the <DOCUMENT/> that is being opened.
user_nameThe user whose documents are to be listed.

Returns

On success
<RESULTS>
     <STATUS>OK</STATUS>
     <DATA>
          <ATTACH-DIR>/servlets3/wietmsd/working/attachments/admin/files/</ATTACH-DIR>
          <ATTACH-LIST>
               <ATTACH-ITEM USERNAME="admin" ORIGINAL_FILENAME="imaage.PNG" FILENAME="att_1524557135745_1524558358628.PNG" VISIBILITY="PRIVATE" ID="1524557135745_1524558358628"/> 
          </ATTACH-LIST> 
     </DATA> 
</RESULTS>
On failure
<response status="error" message="Invalid EID and document ID." />