Product Documentation articleFolder: lq851
Added by IBM contributorTao YT Yan | Edited by IBM contributorCraig Lordan on October 21, 2011 | Version 20
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.
Tags: API

Overview



Create a folder
Delete a folder and all contained resources
Retrieve a folder
Retrieve a list of contents in a folder
Update a folder

Description

A collection that may contain resources of type Folder or Document that imposes a unique file-system mapped label for child content.

Entry Elements

All elements are in XML namespace "http://www.w3.org/2005/Atom", except as noted.

All elements prefixed td are in the XML namespace "urn:ibm.com/td".

Each element can appear only once, except as noted.



Tag
Required
Description
link rel="self"YIdentifies a resource equivalent to the containing element. as defined in Atom spec.
link rel= "alternate"YIdentifies an alternate version of the resource described by the containing element. as defined in Atom spec.
link rel= "edit"NIdentifies the resource that is editable.
id
Y
unique identifier of a resource, as defined in Atom spec
author
Y
The feed author or entry author, the one who creates the resource. If the resource is systemic, the author field could be blank
title
Y
The title of feed or entry
published
N
The last modified date of entry
updated
N
The last modified date of feed or entry
summary
Y
The abstract of feed or entry
td:created
Y
The created date of entry
td:modified
Y
The modified date of entry
td:modifier
Y
The last editor of the entry
category
Y
It indicates entry type, including page/document/draft/draftpage/folder.
content
N
The link points to document's attachment, folder feed or page feed.
td:acls
N
ACL of the folder or the document. Returned by folder or document entry.
td:reader
N
An acl role. Folder reader. Document reader.
td:group
N
Stands for a group. Similar tag is td:person. td:group includes uri, td:dn and name.
td:person
N
Stands for a person. Similar tag is td:group. td:person includes uri, td:dn and name.
td:dn
N
Distinguished name of a person or a group.
name
Y
The display name of a person or a group.
td:contributor
N
An acl role. Folder author. Document author.
td:editor
N
An acl role. Folder editor.
td:manager
N
An acl role. Folder manager.
td:type
N
Specify folder type when creating folder. The type could be simple list, tabbed, slide show.
td:subtype
N
Only used for folder to differentiate different types of folders. Currently available values: h_List(list), h_Forum(forum). User can also provide customized value when create customized folder.
td:trashid
Y
unique identifier of a resource in trash

Example



<entry xml:base="http://example.cn.ibm.com/" 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:_Papiplace1_RMain_F71E3FD6E9A1BE5DD4825785500117B48</id>
<link href="dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FG_2dXdJXhVEXtI/entry" rel="self"/>
<link href="LotusQuickr/apiplace1/Main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FG_2dXdJXhVEXtI/entry" rel="edit"/>
<category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"/>
<author>
<uri>uid=SusanAdams261%2Fou=Users%2Fl=Westford%2Fst=Massachusetts%2Fc=US%2Fou=Lotus%2Fo=Software%20group%2Fdc=ibm%2Fdc=com</uri>
<name>Susan Adams261</name>
<email></email>
</author>
<title type="text">folder</title>
<updated>2011-03-16T06:43:41Z</updated>
<published>2011-03-16T06:43:41Z</published>
<summary type="text">this is folder</summary>
<td:created>2011-03-16T03:10:56Z</td:created>
<td:modified>2011-03-16T06:43:41Z</td:modified>
<td:type>simplelist</td:type>
<td:subtype></td:subtype>
<td:modifier>
<td:uri>uid=SusanAdams261%2Fou=Users%2Fl=Westford%2Fst=Massachusetts%2Fc=US%2Fou=Lotus%2Fo=Software%20group%2Fdc=ibm%2Fdc=com</td:uri>
<td:name>Susan Adams261</td:name>
<td:email></td:email>
</td:modifier>
<content type="application/atom+xml" src="dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FG_2dXdJXhVEXtI/feed"/>
</entry>