Community articleDownloading a file attachment
Added by IBM contributorIBM on March 25, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Download a file attachment from your library programmatically.



Download a file attachment from your library programmatically.

See Authenticating requests for information about how to authenticate the 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.

You can use the following input parameter.

Input

None.

Output

Binary content of the file.

Input
Method URI Description
GET /files/basic/api/myuserlibrary/document/{document-id}/attachment/{attachment-id}/media/{attachment-label} Returns a file attachment from your library. This request requires authentication.
Use this URI to retrieve the binary data if you plan to update and return it using a PUT request.
Name Type Optional Description
document-id
string Yes {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
string Yes {attachment-id} is the value of the <td:uuid> or <td:label> elements in the attachment's Atom entry document.
Name Type Optional Description
identifier
string Yes 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.
Name Type Optional Description
If-Modified-Since
string Yes 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
string Yes 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.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the file attachment was successfully downloaded. If an error occurs, this header contains one of the error codes.
401
Unauthorized.
403
Forbidden.
404
Not Found.