Jump to

• Request
• Response
• Examples

Create File Applink

post

/documents/api/1.2/applinks/file/{fileId}

Create an applink for a specified file and a specified user.

You can grant the specified user the following roles:

• Viewer: Viewers can look at files and folders, but can't change things.
• Downloader: Downloaders can also download files and save them to their own computers.
• Contributor: Contributors can also modify files, update files, upload new files, and delete files.
• Manager: Managers can also modify files, update files, upload new files, delete, and share files.

Note:

To create an applink, the requester must have admin privileges for the file. That is, the requester must be the owner or have the manager role.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• fileId: string

  Globally unique identifier (GUID) for the folder.

Body ()

The request body defines the details of the create applink request. Bold indicates a required value.

Root Schema : ApplinkBody

Type: object

The request body defines the details of the create applink request. Bold indicates a required value.

Show Source

• assignedUser: string
  Identifier for the user. This can be a globally unique identifier (GUID) or some other identifier.
• role(optional): string
  Allowed Values: [ "viewer", "downloader", "contributor", "manager" ]

  Access level for the shared item (role keywords must be lowercase):

  • viewer (default)
  • downloader
  • contributor
  • manager

• userLocale(optional): string
  Locale used for the applink. Locale can affect how values, such as time, are represented.
• userTimeZone(optional): string
  Time zone used for the applink. The time zone can affect how time values are interpreted.

{
    "description":"<p>The request body defines the details of the create applink request. <b>Bold</b> indicates a required value.</p>",
    "properties":{
        "assignedUser":{
            "type":"string",
            "description":"Identifier for the user. This can be a globally unique identifier (GUID) or some other identifier."
        },
        "role":{
            "type":"string",
            "description":"<p>Access level for the shared item (role keywords must be lowercase):<ul><li>viewer (default)</li><li>downloader</li><li>contributor</li><li>manager</li></ul></p>",
            "enum":[
                "viewer",
                "downloader",
                "contributor",
                "manager"
            ]
        },
        "userLocale":{
            "type":"string",
            "description":"Locale used for the applink. Locale can affect how values, such as time, are represented."
        },
        "userTimeZone":{
            "type":"string",
            "description":"Time zone used for the applink. The time zone can affect how time values are interpreted."
        }
    },
    "required":[
        "assignedUser"
    ]
}

Example Request (application/json)

{
    "assignedUser":"U0EAA20910FAF3052ACB79E4T00000000001",
    "role":"contributor",
    "userLocale":"Dansk",
    "userTimeZone":"Canada/Pacific"
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : ApplinkResponse

Type: object

The response body includes information about the applink.

Show Source

• accessToken(optional): string
  This element provides access to the resource and expires after 15 minutes. You can refresh the access token any number of times within the time period defined by the refresh token (24 hours).
• appLinkID(optional): string
  This element uniquely identifies the resource.
• appLinkUrl(optional): string
  The URL of the resource.
• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• id(optional): string
  Globally unique identifier (GUID) for the shared item.
• refreshToken(optional): string
  This element enables you to request a new access token when the current access token expires. The refreshed token expires after 24 hours.
• role(optional): string
  Access level for the shared item.
• type(optional): string
  Item type applink.

{
    "description":"The response body includes information about the applink.",
    "properties":{
        "appLinkID":{
            "type":"string",
            "description":"This element uniquely identifies the resource."
        },
        "accessToken":{
            "type":"string",
            "description":"This element provides access to the resource and expires after 15 minutes. You can refresh the access token any number of times within the time period defined by the refresh token (24 hours)."
        },
        "appLinkUrl":{
            "type":"string",
            "description":"The URL of the resource."
        },
        "refreshToken":{
            "type":"string",
            "description":"This element enables you to request a new access token when the current access token expires. The refreshed token expires after 24 hours."
        },
        "role":{
            "type":"string",
            "description":"Access level for the shared item."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the shared item."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>applink</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Example Response (application/json)

{
    "appLinkID":"LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==",
    "accessToken":"GYrSN5zuj0kOTE4k_60bKvdkxx2-ARA546A2T77GtEOgoPZPGgKk126OeCn1w-Ij",
    "appLinkUrl":"http://www.example.com/documents/embed/link/app/LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==/fileview/DFD11F62E911327CB1F160F6T0000000000100000001",
    "refreshToken":"Yc_b_dE8V03eDTCmcmC1gi_y3LVJTPiZOSQDhuS_VWim9E_FRpLQGtEhgxCNbKTG",
    "role":"contributor",
    "id":"DFD11F62E911327CB1F160F6T0000000000100000001",
    "type":"applink",
    "errorCode":"0"
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Back to Top

Examples

The following example grants manager-level access to the specified user for the specified file.

POST .../applinks/file/DFD11F62E911327CB1F160F6T0000000000100000001

Request Header

None.

Request Body

{
    "assignedUser": "U0EAA20910FAF3052ACB79E4T00000000001",
    "role": "manager",
    "userLocale": "Japanese"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "accessToken": "GYrSN5zuj0kOTE4k_60bKvdkxx2-ARA546A2T77GtEOgoPZPGgKk126OeCn1w-Ij",
    "appLinkID": "LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==",
    "appLinkUrl": "http://www.example.com/documents/embed/link/app/LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==/fileview/DFD11F62E911327CB1F160F6T0000000000100000001",
    "errorCode": "0",
    "id": "DFD11F62E911327CB1F160F6T0000000000100000001",
    "refreshToken": "Yc_b_dE8V03eDTCmcmC1gi_y3LVJTPiZOSQDhuS_VWim9E_FRpLQGtEhgxCNbKTG",
    "role": "manager",
    "type": "applink"
}

Back to Top