Community articleShare 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 share.



Lists the elements in the Atom entry document of a share.

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 UPDATE
Unique identifier of the share formatted following the URN specification.
<td:uuid>
Ignored
Unique identifier of the share resource. Provide this value as the {share-id} when constructing share resource URLs. This value is created by the server when you create a share.
<title type="text">
Ignored
Title of this share in text format. The type attributes is optional; type="text" is the default and only format allowed.
<category scheme="tag:ibm.com,2006:td/type" term="share" label="share"/>
Required
Identifies a share Atom entry.
<link rel="alternate" type="text/html" href="alternate_url">
Ignored
A direct link to the share 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 share entry. The following operations are supported:
  • GET: Use the web address to obtain a full representation of the share 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 share entry. The following operations are supported:
  • GET: Use the web address to obtain a full representation of the share as an Atom entry document.

<link rel="enclosure" type="encl_mime_type" href="encl_url" length="encl_length">
Ignored
Use the web address in the href attribute to obtain the shared file's media. If the file is public, authentication is not required to use this address. The following operations are supported:
  • GET: Use the web address to obtain the file media.

<link rel="related" href="related_url">
Ignored
Use the web address in the href attribute to work with the shared file's document entry. If you are an owner, the following operations are supported:
  • GET: Use the web address to obtain a full representation of the file document as an Atom entry document.
  • PUT: Use the web address to update the file document.
  • DELETE: Use the web address to delete the file document, the associated media, and any shares for the file.

<summary type="text">
Optional
A summary text description of this share.
<td:sharedResourceType>
Ignored
Type of resource shared. This element is always set to document.
<td:sharePermission>
Optional
Permission given for this share. Possible values are View and Edit. The default is View. Returned only when sharedWhat is specified and direction=outbound.
<td:sharedWhat>
Required
The <td:uuid> of the shared resource's file document entry, suitable for use as part of API operation URLs.
<td:sharedWith>
Required
Who this resource has been shared with. Returned only when sharedWhat is specified and direction=outbound. See the table below for contents.
<td:documentOwner>
Ignored
Contains the name, snx:userid, and email (if exposed) of the owner of the shared document.
<updated>
Ignored
The date that the share was last updated, as defined in the Atom specification.
<published>
Ignored
The date this share was initially published, as defined in the Atom specification.
<author>
Ignored
The person who created the share.


Table 2. Contents of the <td:sharedWith> element
Element
How treated on input
Description
<td:sharedWithCount>
Ignored
Number of people that this resource has been shared with.
<td:user>
Required
Contains the name, snx:userid, and email (if exposed) of the user with whom this resource has been shared. Only snx:userid is required on input. Repeats for each user that this resource has been shared with.