Retrieve a version of a file 

Retrieve an Atom document representation of a version of a file from your library.

This method returns an Atom document containing the version. If you want to retrieve the file itself, see Retrieve a file

See Authenticating requests for information about how to authenticate the request.

Table 1. Atom API request details

Method URI Output representation Description
GET Construct the URI using the following syntax: /basic/api/myuserlibrary/document/{document-id}/version/{version-id}/entry version Atom document Returns an Atom document containing the version of the file from your library. This request requires authentication.


Note: {document-id} is the value of the <td:uuid> or <td:label> element in the Atom entry document of the file. {version-id} is the value of the <td:uuid> element in the version's Atom entry document.

You can use one or more of these headers with the GET request.

Table 2. 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 with the GET request. Separate multiple parameters with an ampersand (&).

Table 3. Input parameters

Parameter Description
acls Indicates whether permissions should be retrieved and returned with the version entry. Options are true or false. The default value is false.
identifier Indicates how the document is identified in the {document-id} variable segment of the web address. By default, the lookup operation is performed with the expectation that the URL contains the value from the <td:uuid> element of a document Atom entry, so the value uuid is used. Specify label if the URL instead contains the value from the <td:label> element of a document Atom entry.
inline Specifies whether the version content should be included in the content element of the returned Atom document. Options are true or false. The default value is false.


Input

None.


Output

An Atom entry document representing the version.

Returned HTTP headers

HTTP/1.1 200 OK

Content-Type: application/atom+xml

Error codes


Parent topic

Work with versions

Related reference
File version content


   

 

});