Product Documentation articleUpdate a folder: lq851
Added by IBM contributorRui BJ Yang | Edited by IBM contributorCraig Lordan on October 21, 2011 | Version 17
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars2 comments

Overview



This is the specification for applications that update a Folder resource.

URL endpoints



Perform a PUT operation on one of the following URL formats:

URL
Description
/library/{library-id}/folder/{folder-id}/entry
Update the specified folder

Authentication



This method requires authentication. The authenticated user must have 'Edit' or 'EditProperties' authority on the specified resource.

Arguments



The following HTTP headers maybe supported for this operation.

Header
Description
X-Method-Override
Tunnel a 'PUT' request over HTTP POST


Error Codes




Error Code
Description
Unknown
Returned when the cause of an error is unknown
AccessDenied
Returned when the cause of an error is due to a permission restriction
ItemNotFound
Returned when the cause of an error is related to a resource not being found


Example Request


The request is to update the folder's summary

POST /dm/atom/library/_Pplace2_RMain.nsf/folder/_Pplace2_RMain_F7F4DAB5FEAAF85FF4825785700212921/feed?noAuthHeader=true  HTTP/1.1
Host: example.com
Content-Type: application/atom+xml
X-Method-Override: PUT

<?xml version="1.0" encoding="utf-8"?>
 <a:entry xmlns:a="http://www.w3.org/2005/Atom">
  <title type="text">folder2</title>
  <category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"></category>
  <td:type>simplelist</td:type>
  <td:subtype></td:subtype>
  <summary type="text">add a summary</summary>
 </a:entry>



Example Response


The response contains info of this folder.

<?xml version="1.0" encoding="utf-8"?>
<entry xml:base="" xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <id>urn:lsid:ibm.com:quickr:_Pplace2_RMain_F7F4DAB5FEAAF85FF4825785700212921</id>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F7F4DAB5FEAAF85FF4825785700212921/entry" rel="self"/>
  <link href="LotusQuickr/place2/Main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F7F4DAB5FEAAF85FF4825785700212921/entry" rel="edit"/>
  <category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"/>
  <author>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <name>Testuser7</name>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <title type="text">folder2</title>
  <updated>2011-03-18T06:03:47Z</updated>
  <published>2011-03-18T06:03:47Z</published>
  <summary type="text">add a summary</summary>
  <td:created>2011-03-18T06:02:12Z</td:created>
  <author>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <name>Testuser7</name>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <td:modified>2011-03-18T06:03:47Z</td:modified>
  <td:modifier>
    <td:uri>CN=Testuser7%2FO=Notesdev%2FC=US</td:uri>
    <td:name>Testuser7</td:name>
    <td:email>Testuser7@us.ibm.com</td:email>
  </td:modifier>
  <content type="application/atom+xml" src="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F7F4DAB5FEAAF85FF4825785700212921/feed"/>
</entry>




Folder ACL



Folder ACL can be updated or reset by acls element. (Domino 8.5 only)

Element
Attribute
Values
Description
aclsactionupdateUpdate folder ACL using child elements


resetReset folder ACL


Example Request: Update the folder's ACL


The request is to update the folder's ACL.

POST /dm/atom/library/_Pplace2_RMain.nsf/folder/_Pplace2_RMain.nsf_F4EC8CD8D315A961E48257853002BB7C5/entry?acls=true&noAuthHeader=true HTTP/1.1
Host: example.com
Content-Type: application/atom+xml
X-Method-Override: PUT
<?xml version="1.0" encoding="utf-8"?>
 <a:entry xmlns:a="http://www.w3.org/2005/Atom">
  <category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"></category>
  <td:acls action="update">
   <td:contributor>
    <td:person>
     <td:dn>CN=domino testuser10,O=notesdev,C=US</td:dn>
     <name>domino testuser10</name>
    </td:person>
   </td:contributor>
    <td:editor>
     <td:person>
      <td:dn>CN=domino testuser9/O=notesdev/C=US</td:dn>
      <name>domino testuser9</name>
     </td:person></td:editor>
   </td:acls>
</a:entry>



Example Response: Update the folder's ACL


The response contains the folder information.

<entry xml:base="" xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <id>urn:lsid:ibm.com:quickr:_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5</id>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/entry" rel="self"/>
  <link href="LotusQuickr/place2/Main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/entry" rel="edit"/>
  <category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"/>
  <author>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <name>Testuser7</name>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <title type="text"></title>
  <updated>2011-03-18T06:13:33Z</updated>
  <published>2011-03-18T06:13:33Z</published>
  <summary type="text"></summary>
  <td:created>2011-03-14T07:57:30Z</td:created>
  <author>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <name>Testuser7</name>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <td:modified>2011-03-18T06:13:33Z</td:modified>
  <td:modifier>
    <td:uri>CN=Testuser7%2FO=Notesdev%2FC=US</td:uri>
    <td:name>Testuser7</td:name>
    <td:email>Testuser7@us.ibm.com</td:email>
  </td:modifier>
  <content type="application/atom+xml" src="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/feed"/>
</entry>


Example Request: Reset the folder's ACL


The request is to reset the folder's ACL, the folder becomes public.

POST /dm/atom/library/_Pplace2_RMain.nsf/folder/_Pplace2_RMain.nsf_F4EC8CD8D315A961E48257853002BB7C5/entry?acls=true&noAuthHeader=true HTTP/1.1
Host: example.com
Content-Type: application/atom+xml
X-Method-Override: PUT

<?xml version="1.0" encoding="utf-8"?>
<a:entry xmlns:a="http://www.w3.org/2005/Atom">
 <category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"></category>
 <td:acls action="reset"></td:acls>
</a:entry>



Example Response: Reset the folder's ACL


The response contains the folder information.

<entry xml:base="" xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
  <id>urn:lsid:ibm.com:quickr:_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5</id>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/entry" rel="self"/>
  <link href="LotusQuickr/place2/Main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/entry" rel="edit"/>
  <category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"/>
  <author>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <name>Testuser7</name>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <title type="text"></title>
  <updated>2011-03-18T06:22:11Z</updated>
  <published>2011-03-18T06:22:11Z</published>
  <summary type="text"></summary>
  <td:created>2011-03-14T07:57:30Z</td:created>
  <author>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <name>Testuser7</name>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <td:modified>2011-03-18T06:22:11Z</td:modified>
  <td:modifier>
    <td:uri>CN=Testuser7%2FO=Notesdev%2FC=US</td:uri>
    <td:name>Testuser7</td:name>
    <td:email>Testuser7@us.ibm.com</td:email>
  </td:modifier>
  <content type="application/atom+xml" src="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/feed"/>
</entry>




Albert wang commented on Nov 16, 2011

Re: Update a folder: lq851

hi, Eric:

there is no plan yet to enable QPAPI to do the folder update.

Eric Radloff commented on Nov 15, 2011

Re: Update a folder: lq851

Are there any plans to enable a similar functionality in the QPAPI/QPTOOL EXECUTE? Or is the only way to perform automated Folder ACL changes is to do so through HTTP?