File collection content

Home

File collection content

Lists the elements in the Atom entry document of a collection. 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.

File collection elements

Element How treated on input Description
<id> Ignored Unique identifier of a file collection.
<title type="text"> Required Title of this collection 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 collection in API operation resource addresses. If you do not provide a value for this element, the server assigns a label to the collection based on the collection title.
<td:uuid> Optional Unique identifier of the collection resource. Provide this value as the {collection-id} when constructing collection resource URLs. This value is created by the server when you create a collection.
<category scheme="tag:ibm.com,2006:td/type" term="collection" label="collection"/> Required Identifies a file collection Atom entry.
<link rel="alternate" type="text/html" href="alternate_url"> Ignored A direct link to the collection 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 collection. The following operations are supported:

GET: Use the Web address to obtain a full representation of the file collection 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 collection. The following operations are supported:

GET: Use the Web address to obtain a full representation of the file collection as an Atom entry document.
PUT: Use the Web address to update this collection.
DELETE: Use the Web address to delete this collection.

<summary type="text"> Optional A summary text description of this file collection.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item"> Ignored Total number of items in this collection.
<td:modified> Optional The date that the collection was last updated, as defined in the Atom specification.
<td:created> Optional The date that the collection was created, as defined in the Atom specification.
<updated> Ignored The date that the file collection was last updated, as defined in the Atom specification.
<published> Ignored The date this file collection was initially published, as defined in the Atom specification.
<td:modifier> Optional The person who last modified the collection.
<author> Ignored The person who created the file collection.
<content type="text"> Ignored Contains a link to the collection feed.
<td:visibility> Optional Specifies the membership model of the collection. Options are: public or private.

Files Atom entry types

Related reference

Create a file collection
Retrieving a file collection
Updating a file collection
Delete a file collection

+
Search Tips | Advanced Search

Element	How treated on input	Description
<id>	Ignored	Unique identifier of a file collection.
<title type="text">	Required	Title of this collection 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 collection in API operation resource addresses. If you do not provide a value for this element, the server assigns a label to the collection based on the collection title.
<td:uuid>	Optional	Unique identifier of the collection resource. Provide this value as the {collection-id} when constructing collection resource URLs. This value is created by the server when you create a collection.
<category scheme="tag:ibm.com,2006:td/type" term="collection" label="collection"/>	Required	Identifies a file collection Atom entry.
<link rel="alternate" type="text/html" href="alternate_url">	Ignored	A direct link to the collection 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 collection. The following operations are supported: GET: Use the Web address to obtain a full representation of the file collection 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 collection. The following operations are supported: GET: Use the Web address to obtain a full representation of the file collection as an Atom entry document. PUT: Use the Web address to update this collection. DELETE: Use the Web address to delete this collection.
<summary type="text">	Optional	A summary text description of this file collection.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item">	Ignored	Total number of items in this collection.
<td:modified>	Optional	The date that the collection was last updated, as defined in the Atom specification.
<td:created>	Optional	The date that the collection was created, as defined in the Atom specification.
<updated>	Ignored	The date that the file collection was last updated, as defined in the Atom specification.
<published>	Ignored	The date this file collection was initially published, as defined in the Atom specification.
<td:modifier>	Optional	The person who last modified the collection.
<author>	Ignored	The person who created the file collection.
<content type="text">	Ignored	Contains a link to the collection feed.
<td:visibility>	Optional	Specifies the membership model of the collection. Options are: public or private.