Jump to

• Request
• Response
• Examples

Get Folder Public Link

get

/documents/api/1.2/publiclinks/folder/{folderId}

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

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• folderId: string
  Globally unique identifier (GUID) for the folder.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : FolderLinksResponse

Type: object

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

Show Source

• count(optional): string
  The number of items listed on the page.
• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• id(optional): string
  Globally unique identifier (GUID) for the folder.
• items(optional): array items
  List of public links.
• type(optional): string
  Item type folder.

{
    "description":"The response body includes information about public links defined for the specified folder.",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of items listed on the page."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "description":"List of public links.",
            "items":{
                "$ref":"#/definitions/PublicLinkDefinition"
            }
        }
    }
}

Nested Schema : items

Type: array

List of public links.

Show Source

• Array of: object PublicLinkDefinition
  Public link information.

{
    "type":"array",
    "description":"List of public links.",
    "items":{
        "$ref":"#/definitions/PublicLinkDefinition"
    }
}

Nested Schema : PublicLinkDefinition

Type: object

Public link information.

Show Source

• assignedUsers(optional): string
  The group of users who can use the link.
• createdTime(optional): string
  Date and time when the public link was created.
• expirationTime(optional): string
  Date and time when the public link expires.
• lastModifiedTime(optional): string
  Date and time when the public link was last modified.
• linkID(optional): string
  Globally unique identifier (GUID) for the public link.
• linkName(optional): string
  Name of the public link.
• ownedBy(optional): object User
  User information
• password(optional): string
  Password for the public link. Use a minimum of 8 characters and a maximum of 50 characters. Passwords are case-sensitive.
• role(optional): string
  Allowed Values: [ "viewer", "downloader", "contributor" ]

  Access level for the shared item.
• type(optional): string
  Item type publiclink.

{
    "description":"Public link information.",
    "properties":{
        "linkID":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the public link."
        },
        "linkName":{
            "type":"string",
            "description":"Name of the public link."
        },
        "assignedUsers":{
            "type":"string",
            "description":"The group of users who can use the link."
        },
        "role":{
            "type":"string",
            "description":"Access level for the shared item.",
            "enum":[
                "viewer",
                "downloader",
                "contributor"
            ]
        },
        "password":{
            "type":"string",
            "description":"Password for the public link. Use a minimum of 8 characters and a maximum of 50 characters. Passwords are case-sensitive."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>publiclink</code>."
        },
        "createdTime":{
            "type":"string",
            "description":"Date and time when the public link was created."
        },
        "expirationTime":{
            "type":"string",
            "description":"Date and time when the public link expires."
        },
        "lastModifiedTime":{
            "type":"string",
            "description":"Date and time when the public link was last modified."
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        }
    }
}

Nested Schema : User

Type: object

User information

Show Source

• displayName(optional): string
  The display name for the user.
• id(optional): string
  Globally unique identifier (GUID) for the user.
• loginName(optional): string
  The login name for the user.
• type(optional): string
  Item type user.

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

Example Response (application/json)

{
    "count":"2",
    "id":"F4E111D0D0645CD368453C2BT0000000000100000001",
    "type":"folder",
    "errorCode":"0",
    "items":[
        {
            "linkID":"LF31C09DE51854DBBDA37A90T0000000000100000001",
            "linkName":"hasSecondLink",
            "assignedUsers":"@everybody",
            "role":"viewer",
            "type":"publiclink",
            "createdTime":"2015-06-02T19:30:37Z",
            "lastModifiedTime":"2015-06-02T19:30:37Z",
            "ownedBy":{
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "displayName":"User AA",
                "type":"user"
            }
        },
        {
            "linkID":"LF5E5F73A444FFB8924EF8ACT0000000000100000001",
            "linkName":"hasFirstLink",
            "assignedUsers":"@serviceinstance",
            "role":"contributor",
            "type":"publiclink",
            "createdTime":"2015-06-10T16:15:37Z",
            "lastModifiedTime":"2015-06-10T16:15:37Z",
            "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

Folder ID is not found.

Back to Top

Examples

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

GET .../publiclinks/folder/F4E111D0D0645CD368453C2BT0000000000100000001

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "2",
    "errorCode": "0",
    "id": "F4E111D0D0645CD368453C2BT0000000000100000001",
    "type": "folder",
    "items": [
        {
            "type": "publiclink",
            "linkID": "LF31C09DE51854DBBDA37A90T0000000000100000001",
            "linkName": "hasSecondLink",
            "ownedBy": {
		            "displayName": "User AA",
		            "loginName": "userAALoginName",
		            "id": "U0EAA20910FAF3052ACB79E4T00000000001",
		            "type": "user"
            },
            "role": "viewer",
            "assignedUsers": "@everybody",
            "createdTime": "2015-06-02T19:30:37Z",
            "lastModifiedTime": "2015-06-02T19:30:37Z"
        },
        {
            "type": "publiclink",
            "linkID": "LF5E5F73A444FFB8924EF8ACT0000000000100000001",
            "linkName": "hasFirstLink",
            "ownedBy": {
		            "displayName": "User AA",
		            "loginName": "userAALoginName",
		            "id": "U0EAA20910FAF3052ACB79E4T00000000001",
		            "type": "user"
            },
            "role": "contributor",
            "assignedUsers": "@serviceinstance",
            "createdTime": "2015-06-10T16:15:37Z",
            "lastModifiedTime": "2015-06-10T16:15:37Z"
        }
    ]
}

Example 2

The following example returns succesfully, but the folder ID has no public links.

GET .../publiclinks/file/F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "0",
    "errorCode": "0",
    "id": "F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F",
    "type": "folder"
}

Example 3

The following example returns an error because the folder ID is invalid.

GET .../publiclinks/folder/FDDD745706AEC8BD04260B2F45B3E9DD64907CA0D19F

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 404

JSON Response

{
    "count": "0",
    "errorCode": "-16",
    "errorKey": "!csUnableToRetrieveSharedLinkInfo!csSecurityValidationFailed!csFldDoesNotExist,FDDD745706AEC8BD04260B2F45B3E9DD64907CA0D19F!csUnprivilegedSystemError",
    "errorMessage": "Failed to retrieve shared link information. Security validation failed. 'FDDD745706AEC8BD04260B2F45B3E9DD64907CA0D19F' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "errorType": "folder",
    "id": "FDDD745706AEC8BD04260B2F45B3E9DD64907CA0D19F",
    "title": "Failed to retrieve shared link information. Security validation failed. 'FDDD745706AEC8BD04260B2F45B3E9DD64907CA0D19F' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Back to Top