File folder content
Lists the elements in the Atom entry document of a folder.All elements are in the http://www.w3.org/2005/Atom namespace, except those that are prefixed as follows:
td
In the urn:ibm.com/td namespace.
snx
In the http://www.ibm.com/xmlns/prod/sn namespace.
Table 1. File folder elements
Element How treated on input Description <id> Ignored Unique identifier of a file folder. <title type="text"> Required Title of this folder in text format. The type attribute is optional; type="text" is the default and only format allowed. <td:label> Optional A short text label used to identify the file folder in API operation resource addresses. If you do not provide a value for this element, the server assigns a label to the folder based on the folder title. <td:uuid> Optional Unique identifier of the folder resource. Provide this value as the {collection-id} when constructing folder resource URLs. This value is created by the server when you create a folder. <category scheme="tag:ibm.com,2006:td/type" term="collection" label="collection"/> Required Identifies a file folder Atom entry. <link rel="alternate" type="text/html" href="alternate_url"> Ignored A direct link to the folder within the Files web application. Operations supported on the value of the href attribute:
- GET HTML for display in browser
<link rel="self" type="application/atom+xml" href="self_url"> Ignored Use the web address in the href attribute to obtain an Atom entry document containing a complete representation of this file folder. The following operations are supported:
- GET: Use the web address to obtain a full representation of the file folder as an Atom entry document.
<link rel="edit" type="application/atom+xml" href="edit_url"> Ignored Use the web address in the href attribute to obtain an Atom entry document containing a complete representation of this file folder. The following operations are supported:
- GET: Use the web address to obtain a full representation of the file folder as an Atom entry document.
- PUT: Use the web address to update this folder.
- DELETE: Use the web address to delete this folder.
<summary type="text"> Optional A summary text description of this file folder. <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item"> Ignored Total number of items in this folder. <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/user"> Ignored Total number of people with whom this folder has been shared. <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/group"> Ignored Total number of groups with whom this folder has been shared. <td:modified> Optional The date that the folder was last updated, as defined in the Atom specification. <td:created> Optional The date that the folder was created, as defined in the Atom specification. <updated> Ignored The date that the file folder was last updated, as defined in the Atom specification. <published> Ignored The date this file folder was initially published, as defined in the Atom specification. <td:modifier> Optional The person who last modified the folder. <author> Ignored The person who created the file folder. <content type="text"> Ignored Contains a link to the folder feed. <td:visibility> Optional Specifies the membership model of the folder. Options are: public or private.
Parent topic
Files Atom entry typesRelated reference
Create a file folder
Retrieve a file folder
Update a file folder
Delete a file folder
});