Information about a file or folder that has been shared.
name | data type | description |
---|---|---|
access | Access | The access granted to the recipient. |
comment | string | Note entered by the sharer. |
days_to_expire | number | 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 | number | 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 | number | ID of the share. |
permalinks | array of Link | The shared item's public URLs. |
recipient | ShareRecipient | Reference to the recipient of the shared item. |
shared_entity | EntityId | Reference to the shared item. |
sharer | LongIdLinkPair | A reference to the user who shared the item. |
sharing_date | number | The date the item was shared. |
Properties inherited from BaseRestObject |
||
href | string | The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest). |
links | array of Link | Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs) |
Example
{ "permalinks" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ], "comment" : "...", "sharer" : { "id" : 12345, "href" : "..." }, "sharing_date" : 12345.0, "days_to_expire" : 12345, "expiration" : 12345.0, "id" : 12345, "recipient" : { "email" : "...", "type" : "...", "id" : 12345, "href" : "..." }, "shared_entity" : { "type" : "...", "id" : 12345, "href" : "..." }, "role" : "...", "access" : { "role" : "...", "sharing" : { "external" : true, "internal" : true, "all_internal" : true, "all_external" : true, "public" : true, "public_link" : true, "grant_reshare" : true }, "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }, "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }