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.

Copy and paste this wiki markup to link to this
article from another article in this wiki.