share Data Type

Information about a file or folder that has been shared.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs wrapped by description
access access element 0/1   The access granted to the recipient.
comment string element 0/1   Note entered by the sharer.
days_to_expire int element 0/1   Days until the share expires. This is the initial value set by the sharer, not necessarily the current number of days remaining. When posting a share with days_to_expire to the REST API, the server calculates the expiration date and sets expiration accordingly
expiration dateTime element 0/1   Date and time when the share expires. When posting a share to the REST API, only one of days_to_expire and expiration should be specified.
id long element 0/1   ID of the share.
permalink link element 0/unbounded permalinks The shared item's public URLs.
recipient shareRecipient element 0/1   Reference to the recipient of the shared item.
shared_entity entityId element 0/1   Reference to the shared item.
sharer longIdLinkPair element 0/1   A reference to the user who shared the item.
sharing_date dateTime element 0/1   The date the item was shared.
Properties inherited from baseRestObject
href string element 0/1   The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded links Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<share>
  <permalinks>
    <permalink>
      <href>...</href>
      <rel>...</rel>
    </permalink>
  </permalinks>
  <comment>...</comment>
  <sharer>
    <id>...</id>
    <href>...</href>
  </sharer>
  <sharing_date>...</sharing_date>
  <days_to_expire>...</days_to_expire>
  <expiration>...</expiration>
  <id>...</id>
  <recipient>
    <email>...</email>
    <type>...</type>
  </recipient>
  <shared_entity>
    <type>...</type>
    <id>...</id>
    <href>...</href>
  </shared_entity>
  <access>
    <role>...</role>
    <sharing>
      <external>...</external>
      <internal>...</internal>
      <all_internal>...</all_internal>
      <all_external>...</all_external>
      <public>...</public>
      <public_link>...</public_link>
      <grant_reshare>...</grant_reshare>
    </sharing>
    <href>...</href>
    <links>
      <link/>
    </links>
  </access>
  <href>...</href>
  <links>
    <link>
      <href>...</href>
      <rel>...</rel>
    </link>
  </links>
</share>