Partially defined share link object.
UrlstringOptional
Uri of where the shared object can be viewed
ExpirationDatedatetimeOptional
Date and time when the share link expires. Required when creating a new share link (must be set to a future date). Can be in the past when updating a share link. Sortable
AllowNativeDownloadbooleanOptional
Only applies for shared documents. True if the document can be downloaded in native format as part of the terms of being shared. Sortable
AllowPdfDownloadbooleanOptional
Only applies for shared documents. True if the document can be downloaded in PDF format as part of the terms of being shared. Sortable
PreviewBehaviorstringOptional
Behavior when user navigates to URL for a shared document (does not apply to a shared folder). Possible values are: Preview, DownloadNative, DownloadPdf, DownloadInline. Filterable and sortable
CreatedBystringOptional
Username of the user that created the share link
UpdatedBystringOptional
Username of the user that last updated the share link
CreatedDatedatetimeOptional
Date and time that the share link was created. Sortable
UpdatedDatedatetimeOptional
Date and time that the share link was last updated. Sortable
HrefstringOptional
Uri where the object can be retrieved.
FolderobjectOptional
Folder shared by the share link. Folder or Document is required when creating a new share link, but not both. Will be null if the share link is for a document
DocumentobjectOptional
Document shared by the share link. Document or Folder is required when creating a new share link, but not both. Will be null if the share link is for a folder
Response
OK
UrlstringOptional
Uri of where the shared object can be viewed
ExpirationDatedatetimeOptional
Date and time when the share link expires. Required when creating a new share link (must be set to a future date). Can be in the past when updating a share link. Sortable
AllowNativeDownloadbooleanOptional
Only applies for shared documents. True if the document can be downloaded in native format as part of the terms of being shared. Sortable
AllowPdfDownloadbooleanOptional
Only applies for shared documents. True if the document can be downloaded in PDF format as part of the terms of being shared. Sortable
PreviewBehaviorstringOptional
Behavior when user navigates to URL for a shared document (does not apply to a shared folder). Possible values are: Preview, DownloadNative, DownloadPdf, DownloadInline. Filterable and sortable
CreatedBystringOptional
Username of the user that created the share link
UpdatedBystringOptional
Username of the user that last updated the share link
CreatedDatedatetimeOptional
Date and time that the share link was created. Sortable
UpdatedDatedatetimeOptional
Date and time that the share link was last updated. Sortable
HrefstringOptional
Uri where the object can be retrieved.
FolderobjectOptional
Folder shared by the share link. Folder or Document is required when creating a new share link, but not both. Will be null if the share link is for a document
DocumentobjectOptional
Document shared by the share link. Document or Folder is required when creating a new share link, but not both. Will be null if the share link is for a folder
