Retrieve a file attachment 

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

This method returns an Atom document containing the file attachment. 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}/attachment/{attachment-id}/entry attachment Atom document Returns an Atom document containing the file attachment from your library. This request requires authentication.

Use this URI to retrieve the Atom document if you plan to update the attachment and return it using a PUT request.


Note: {document-id} is the value of the <td:uuid> or <td:label> element in the Atom entry document of the file with the attachment. {attachment-id} is the value of the <td:uuid> or <td:label> elements in the attachment'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 this input parameter with the GET request.

Table 3. Input parameters

Parameter Description
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 the 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.


Input

None.


Output

An Atom entry document containing the Atom document for the file attachment.

Returned HTTP headers

HTTP/1.1 200 OK

Content-Type: application/atom+xml

Error codes


Parent topic

Work with file attachments programmatically

Related reference
File attachment content


   

 

});