Downloading a file

Home

Downloading a file

Download a file from your file collection programmatically.
See Authenticating requests for information about how to authenticate the request.
Atom API request details
Method Resource address Output representation Description
GET Construct the URI using the following syntax: /basic/anonymous/api/myuserlibrary/document/{document-id}/media binary media Returns a public file without authenticating the request.
GET
Determine the resource address in either of the following ways:
Value of the href attribute of the <link rel="edit-media"> element in the file's Document Atom entries.
Construct the address using the following URL:
/basic/api/myuserlibrary/document/{document-id}/media
where {document-id} is the <td:uuid> or <td:label> element of the document entry.
binary media
Returns a file from your collection. This request requires authentication.
Use this URI to retrieve the binary data if you plan to update and return it using a PUT request.
You can use one or more of these headers.

Input headers

Parameter Description
If-Modified-Since Used to validate the local cache of the feed and entry documents retrieved previously. If the feed or entry has not been modified since the specified date, HTTP response code 304 (Not Modified) is returned.
If-None-Match Contains an ETag response header sent by the server in a previous request to the same URL. If the ETag is still valid for the specified resource, HTTP response code 304 (Not Modified) is returned.

You can use one or more of these input parameters. Separate multiple parameters with an ampersand (&).

Input parameters

Parameter Description
identifier String. Indicates the identifier used in the document segment of the Web address. Options are uuid or label. Uses the UUID as the identifier by default.
logDownload Specifies whether to log this file download. Options are true or false. By default, it does log the download.

Input

None.

Output

Binary content of the file. If active content filtering is enabled, and the file is an HTML file, it is filtered. Returned HTTP Headers

HTTP/1.1 200 OK

Indicates that the file entry was successfully created. If an error occurs, this header will contain one of the error codes below.

Error codes

HTTP/1.1 401 Unauthorized
HTTP/1.1 404 Not Found

Working with files

Related reference

File content

+
Search Tips | Advanced Search

Method	Resource address	Output representation	Description
GET	Construct the URI using the following syntax: /basic/anonymous/api/myuserlibrary/document/{document-id}/media	binary media	Returns a public file without authenticating the request.
GET	Determine the resource address in either of the following ways: Value of the href attribute of the <link rel="edit-media"> element in the file's Document Atom entries. Construct the address using the following URL: /basic/api/myuserlibrary/document/{document-id}/media where {document-id} is the <td:uuid> or <td:label> element of the document entry.	binary media	Returns a file from your collection. This request requires authentication. Use this URI to retrieve the binary data if you plan to update and return it using a PUT request.

Parameter	Description
If-Modified-Since	Used to validate the local cache of the feed and entry documents retrieved previously. If the feed or entry has not been modified since the specified date, HTTP response code 304 (Not Modified) is returned.
If-None-Match	Contains an ETag response header sent by the server in a previous request to the same URL. If the ETag is still valid for the specified resource, HTTP response code 304 (Not Modified) is returned.

Parameter	Description
identifier	String. Indicates the identifier used in the document segment of the Web address. Options are uuid or label. Uses the UUID as the identifier by default.
logDownload	Specifies whether to log this file download. Options are true or false. By default, it does log the download.