Files API 

---

The Files application of Lotus® Connections enables teams to create a shared repository of files. The Files API allows application programs to add files to a collection and to read and modify existing files.

Files implements the following APIs:

Subscription

Files implements the Atom Syndication Format (Atom 1.0) to serve Atom feeds that you can use in your applications to search for and retrieve files added to a collection by the people in your organization. The format documented here is what feed readers use to discover new or updated files.

Publishing

Files implements the Atom Publishing Protocol to enable you to programmatically manipulate files. Files provides a service document and some category documents. The service document contains the currently authenticated user's collections and feeds. You can use the publishing APIs in your applications to perform actions, such as adding a file to a collection. When interacting with collections to which you have owner access, you can add a file or update and delete any file. When interacting with collections to which you have Author access, you can add a file or update and delete the files that you authored.

Retrieving the Files service document
The first step you must perform if you plan to update resources made available through the Atom APIs is to retrieve the service document for the application.

Getting Files feeds
Use the Atom subscription API to retrieve resources from the Files application.

Working with files
Using the Atom Publishing Protocol, also known as AtomPub, you can get feeds of the files in a collection and can create, update, or delete files and their associated metadata.

Working with folders
Using the Atom Publishing Protocol, also known as AtomPub, you can get a feed of file folders, and can create, update, or delete a folder. Files can be associated with multiple folders or removed from association with a folder.

Working with shares
Using the Atom Publishing Protocol, also known as AtomPub, you can get feeds of shares. Shares capture instances in which a file has been shared between people. You can also use the API to retrieve, create, or delete file shares.

Working with comments
Using the Atom Publishing Protocol, also known as AtomPub, you can get feeds of the comments associated with files and can create, update, or delete comments.

Working with files in the trash
Using the Atom Publishing Protocol, also known as AtomPub, you can get a feeds of the files in your recycle bin and can retrieve, restore, and purge files from the trash.

Working with versions
Using the Atom Publishing Protocol, also known as AtomPub, you can create, delete, or download a version of a file, and compare two versions.

Working with file attachments programmatically
Using the Atom Publishing Protocol, also known as AtomPub, you can create, update, or delete attachments.

Working with pinned files
Using the Atom Publishing Protocol, also known as AtomPub, you can pin a file or remove a pin from a file.

Working with pinned folders
Using the Atom Publishing Protocol, also known as AtomPub, you can pin a folder or remove the pin from a folder.

Moderating community files and comments programmatically
Use the Atom Publishing Protocol, also known as AtomPub, to moderate community files and comments.

Files Atom entry types
Lists the Atom entry types that can appear in feeds produced by the Files API or in an Atom Entry document produced or sent to the API.

Parent topic: Lotus Connections APIs