Retrieving file metadata
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 30, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Retrieve an Atom document representation of the metadata for a file from your library.

This method returns the Atom document containing the metadata associated with a file in a library.

Note: {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.

To use the public endpoint, which does not require authentication, use /files/{auth}/api in the url.

Input
Method URI Description
GET /files/{auth}/api/myuserlibrary/document/{document-id}/entry
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: /{auth}/api/myuserlibrary/document/{document-id}/entry
Returns an Atom document containing the metadata of a file from your library. This request requires authentication.
Note: Use this URI to retrieve the Atom document if you plan to update the document and return it using a PUT request.
Name Type Optional Description
document-id
string No {document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.
auth
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
Name Type Optional Description
acls
boolean Yes 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
string Yes 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
boolean Yes 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
boolean Yes 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
boolean Yes 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
boolean Yes 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.
The API includes the link <link href="https://apps.na.collabserv.com/files/basic/api/library/23eb5f20-2b48-3dd8-958f-3df60a050301/document/bec6b277-49cb-44ef-bbc4-e66c0c283822/recommendation/3216/entry" rel="recommendation"></link> if you have liked the FIle
includeTags
boolean Yes 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 Yes String. Specifies whether document properties should be overwritten with properties from the specified version. (See Document for which properties are changed/added)
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.
Authorization
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(twatson@us.ibm.com:password).
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • bearer
  • basic
Output
Content Type: application/json
Code Description
200
Indicates that the file entry was successfully found and returned. If an error occurs, this header will contain one of the error codes below.
401
Unauthorized.
403
Forbidden.
404
Not Found.
References