REST API for Content Management 1.1

Get File Public Link

get

/documents/api/1.1/publiclinks/file/{fileId}

Return a list of the public links for a specified file.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: Type: string

Required: true

Globally unique identifier (GUID) for the file.

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about public links defined for the specified file.

Root Schema : FileLinksResponse

The response body includes information about public links defined for the specified file.

Properties

count: Type: string

The number of items listed on the page.
errorCode: Type: string

An error code of zero (0) indicates no errors.
id: Type: string

Globally unique identifier (GUID) for the file.
items: Type: array items

Additional Properties Allowed:

List of public links.
type: Type: string

Item type file.

Nested Schema : items

Type: array

List of public links.

Items

Type: object PublicLinkDefinition

Additional Properties Allowed:

Public link information.

Nested Schema : PublicLinkDefinition

Public link information.

Properties

assignedUsers: Type: string

The group of users who can use the link.
createdTime: Type: string

Date and time when the public link was created.
expirationTime: Type: string

Date and time when the public link expires.
lastModifiedTime: Type: string

Date and time when the public link was last modified.
linkID: Type: string

Globally unique identifier (GUID) for the public link.
linkName: Type: string

Name of the public link.
ownedBy: Type: object User

Additional Properties Allowed:

User information
password: Type: string

Password for the public link. Use a minimum of 8 characters and a maximum of 50 characters. Passwords are case-sensitive.
role: Type: string

Allowed Values: [ "viewer", "downloader", "contributor" ]

Access level for the shared item.
type: Type: string

Item type publiclink.

Nested Schema : User

User information

Properties

displayName: Type: string

The display name for the user.
id: Type: string

Globally unique identifier (GUID) for the user.
type: Type: string

Item type user.

Example application/json


{
    "count":"2",
    "id":"D1E1E9F089AC1EF8481E5B94T0000000000100000001",
    "type":"file",
    "errorCode":"0",
    "items":[
        {
            "linkID":"LDFD004B846DB106DB8B2906T0000000000100000001",
            "linkName":"MyFileLinkOne",
            "assignedUsers":"@everybody",
            "role":"contributor",
            "type":"publiclink",
            "createdTime":"2015-06-10T16:13:19Z",
            "lastModifiedTime":"2015-06-10T16:13:19Z",
            "expirationTime":"2017-01-01T00:00:01Z",
            "ownedBy":{
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "displayName":"User AA",
                "type":"user"
            }
        },
        {
            "linkID":"LF5E5F73A444FFB8924EF8ACT0000000000100000001",
            "linkName":"MyFileLinkTwo",
            "assignedUsers":"@everybody",
            "role":"contributor",
            "type":"publiclink",
            "createdTime":"2015-06-10T16:17:11Z",
            "lastModifiedTime":"2015-06-10T16:17:11Z",
            "ownedBy":{
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "displayName":"User AA",
                "type":"user"
            }
        }
    ]
}

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.

Examples

The following example returns information about public links defined for the specified file.

GET .../publiclinks/file/D1E1E9F089AC1EF8481E5B94T0000000000100000001

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "2",
    "errorCode": "0",
    "id": "D1E1E9F089AC1EF8481E5B94T0000000000100000001",
    "type": "file",
    "items": [
        {
            "type": "publiclink",
            "linkID": "LDFD004B846DB106DB8B2906T0000000000100000001",
            "linkName": "MyFileLinkOne",
            "ownedBy": {
                "displayName": "User AA",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "role": "contributor",
            "assignedUsers": "@everybody",
            "createdTime": "2015-06-10T16:13:19Z",
            "lastModifiedTime": "2015-06-10T16:13:19Z",
            "expirationTime": "2017-01-01T00:00:01Z"
        },
        {
            "type": "publiclink",
            "linkID": "LDF81E2BEDFDC8D8B3D2FB65T0000000000100000001",
            "linkName": "MyFileLinkTwo",
            "ownedBy": {
                "displayName": "User AA",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "role": "contributor",
            "assignedUsers": "@everybody",
            "createdTime": "2015-06-10T16:17:11Z",
            "lastModifiedTime": "2015-06-10T16:17:11Z"
        }
    ]
}