Skip to main content

Get the shared link template

GET /api/2.0/files/{fileId}/sharedlink/template

Returns a new unsaved link object to the file with the ID specified in the request.

Path parameters​

fileId​

type: string

File ID

Example: "string"

Request body​

isFolder​

type: boolean

Specifies if a link is to the shared folder or not

Example: true

Request example​

{
  "isFolder": true
}

Returns​

Shared link template. A request that is not authenticated returns 401.

SubjectId​

type: string

Example: "string"

SubjectName​

type: string

Example: "string"

type: string

Example: "string"

SubjectGroup​

type: boolean

Example: true

Owner​

type: boolean

Example: true

Share​

type: "None" | "ReadWrite" | "Read" | "Restrict" | "Varies" | "Review" | "Comment" | "FillForms" | "CustomFilter"

[0 - None, 1 - ReadWrite, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - FillForms, 8 - CustomFilter]

Example: "None"

LockedRights​

type: boolean

Example: true

DisableRemove​

type: boolean

Example: true

LinkSettings​

type: LinkSettingsWrapper

EntryType​

type: "Folder" | "File"

[1 - Folder, 2 - File]

Example: "Folder"

Inherited​

type: boolean

Example: true

Response example​

{
  "SubjectId": "string",
  "SubjectName": "string",
  "Link": "string",
  "SubjectGroup": true,
  "Owner": true,
  "Share": "None",
  "LockedRights": true,
  "DisableRemove": true,
  "LinkSettings": {
    "AutoDelete": true,
    "ExpirationDate": "string",
    "Expired": true,
    "Password": "string"
  },
  "EntryType": "Folder",
  "Inherited": true
}