Retrieving file metadata

Home

Retrieving file metadata

Retrieve an Atom document representation of the metadata for a file from your collection.
This method returns the Atom document containing the metadata associated with a file in a collection as opposed to a feed of the collection. To retrieve a feed, see Getting a feed of your collection. To retrieve the file itself, see Retrieving a file
See Authenticating requests for information about how to authenticate the request.

Atom API request details

Method URI Output representation Description
GET Construct the URI using the following syntax: /basic/anonymous/api/myuserlibrary/document/{document-id}/entry file Atom document Returns a public file without authenticating the request.
GET You can determine the URI in either of the following ways:

Value of the href attribute of the <link rel="edit"> element in the file's Document Atom entries.
Construct the URI using the following syntax: /basic/api/myuserlibrary/document/{document-id}/entry

file Atom document Returns an Atom document containing the metadata of a file from your collection. This request requires authentication.
Use this URI to retrieve the Atom document if you plan to update the document and return it using a PUT request.

{document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.
You can use one or more of these headers with the GET request.

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 (&).

Input parameters

Parameter Description
acls Specifies whether or not the permissions for each user should be displayed for each entry in the returned Atom document. This parameter takes a boolean value of either true or false. By default, the permission information is not returned.
identifier Indicates how the document is identified in the {document-id} variable segment of the Web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a File Atom entry. Specify "label" if the URL instead contains the value from the <td:label> element of a File Atom entry.
includeLibraryInfo Specifies whether the library information is returned. This parameter takes a boolean value of either true or false. By default, the library information is not returned.
includeNotification Specifies whether the authenticated user's notification setting is returned. This parameter takes a boolean value of either true or false. By default, the notification is not returned.
includePath Specifies whether the file path information is returned. This parameter takes a boolean value of either true or false. If true, adds an entry extension <td:path> showing the path to the object. By default, the file path information is not returned.
includeRecommendation Specifies whether the authenticated user's recommendation setting is returned. This parameter takes a boolean value of either true or false. By default, the recommendation information is not returned.
includeTags Specifies whether or not the tags associated with the file should be included in the returned Atom document. This parameter takes a boolean value of either true or false. By default, the tags are not returned.
versionUuid String. Specifies whether document properties should be overwritten with properties from the specified version. (See Document for which properties are changed/added)

Input

None.

Output

An Atom entry document containing the Atom document for the file. Returned HTTP Headers

HTTP/1.1 200 OK

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

Content-Type: application/atom+xml

Indicates that the document returned contains data in Atom format.

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	URI	Output representation	Description
GET	Construct the URI using the following syntax: /basic/anonymous/api/myuserlibrary/document/{document-id}/entry	file Atom document	Returns a public file without authenticating the request.
GET	You can determine the URI in either of the following ways: Value of the href attribute of the <link rel="edit"> element in the file's Document Atom entries. Construct the URI using the following syntax: /basic/api/myuserlibrary/document/{document-id}/entry	file Atom document	Returns an Atom document containing the metadata of a file from your collection. This request requires authentication. Use this URI to retrieve the Atom document if you plan to update the document 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
acls	Specifies whether or not the permissions for each user should be displayed for each entry in the returned Atom document. This parameter takes a boolean value of either true or false. By default, the permission information is not returned.
identifier	Indicates how the document is identified in the {document-id} variable segment of the Web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a File Atom entry. Specify "label" if the URL instead contains the value from the <td:label> element of a File Atom entry.
includeLibraryInfo	Specifies whether the library information is returned. This parameter takes a boolean value of either true or false. By default, the library information is not returned.
includeNotification	Specifies whether the authenticated user's notification setting is returned. This parameter takes a boolean value of either true or false. By default, the notification is not returned.
includePath	Specifies whether the file path information is returned. This parameter takes a boolean value of either true or false. If true, adds an entry extension <td:path> showing the path to the object. By default, the file path information is not returned.
includeRecommendation	Specifies whether the authenticated user's recommendation setting is returned. This parameter takes a boolean value of either true or false. By default, the recommendation information is not returned.
includeTags	Specifies whether or not the tags associated with the file should be included in the returned Atom document. This parameter takes a boolean value of either true or false. By default, the tags are not returned.
versionUuid	String. Specifies whether document properties should be overwritten with properties from the specified version. (See Document for which properties are changed/added)