Community articleFile content
Added by IBM contributorIBM on June 23, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Lists the elements in the Atom entry document of a file. The elements in this entry represent the media link entry for a file and contain links to media which is the binary data of the file.



Lists the elements in the Atom entry document of a file. The elements in this entry represent the media link entry for a file and contain links to media which is the binary data of the file.

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 elements
Element
How treated on input
Description
<id>
Required on PUT request.
Unique identifier of a file formatted following the URN specification.
<td:uuid>
Optional
Unique identifier of a file. Provide this value as the {document-id} when constructing the resource from which to retrieve a file and its metadata. This ID is created by the server when you post a file.
<title type="text">
You must provide a value for this element or for <td:label> on POST request.
Title of the file in text format. The type attribute is optional; type="text" is the default and only format allowed. On a POST, providing a title is recommended. It is not recommended on a PUT request.
<td:label>
You must provide a value for this element or for <title> on POST request.
A short text label used to identify the file in API operation resource addresses. The server assigns a label if one is not provided.
<category scheme="tag:ibm.com,2006:td/type" term="document" label="document"/>
Ignored
Identifies a document Atom entry.
<category term="tag_word"/>
Optional
Represents a tag on the file. This element is repeated for each tag.
<link rel="alternate" type="text/html" href="alternate_url">
Ignored
A direct link to the file within the Files web application. Operations supported on the value of the href attribute:
  • GET: Use the web address to view the file in HTML format.

<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 Atom representation of this file. The following operation is supported:
  • GET: Use the web address to obtain metadata information of the file 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 get an Atom entry document containing a complete representation of this file. If you are an owner of the file, the following operations are supported:
  • GET: Use the web address to obtain a full representation of the file as an Atom entry document.
  • PUT: Use the web address to update this file.
  • DELETE: Use the web address to delete this file.

<link rel="edit-media" href="edit-media-url">
Ignored
Use the web address in the href attribute to obtain the document's media. If you are a wiki owner, the following operations are supported:
  • GET: Use the web address to obtain the media.
  • PUT: Use the web address to update the media.

<link rel="enclosure" href="encl_url" type="<mime_type_of_file>" length="encl_length">
Ignored
Use the web address in the href attribute to obtain the binary content of the file. If the file is public, authentication is not required to use this address. The following operation is supported:
  • GET: Use the web address to obtain the media.

<link rel="replies" type="application/atom+xml" href="replies_url" thr:count="replies_count">
Ignored
Use the web address in the href attribute to obtain an Atom feed of the comments on this file.
<summary type="text">
Optional
A summary text description of this file.
<content type="<mime_type_of_file>" src="src_url">
Optional
Provides access the document's media. The following operation is supported:
  • GET: Use the web address to obtain the media.

<td:visibility>
Optional
Specifies the membership model of the file. Options are public or private. The default is private.
<td:notification>
Optional
Indicates whether the currently authenticated user wants to receive notifications as people edit the document. Options are on or off.
<td:versionUuid>
Ignored
Unique version identifier.
<td:versionLabel>
Ignored
Incremental version number, starting at 1.
<td:documentVersionUuid>
Ignored
The versionUuid of the document that this version is based on.
<td:documentVersionLabel>
Ignored
The versionLabel of the document that this version is based on.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/comment">
Ignored
Total number of comments to this file.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/hit">
Ignored
Total number of views of this file.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/anonymous_hit">
Ignored
Total number of anonymous views of this file.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/attachments">
Ignored
Total number of attachments to this file.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/versions">
Ignored
Total number of versions of this file.
<td:modified>
Optional
The date that the binary data of the file was last updated, as defined in the Atom specification. Most of the views in the user interface use this value to sort the view content by default.
<updated>
Ignored
The date that the metadata of the file was last updated, as defined in the Atom specification.
<published>
Ignored
The date this file was initially published, as defined in the Atom specification.
<td:modifier>
Optional
The person who last modified the file.
<author>
Ignored
The person who created the file. This is often the collection owner, but can also be an administrator.