Skip to main content link. Accesskey S
  • Log In
  • Help
  • IBM Logo
  • Lotus Quickr wiki
  • All Wikis
  • All Forums
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • IBM Redbooks
Community Articles Product Documentation Learning Center IBM Redbooks This category Lotus Quickr 8.5 for WebSphere Portal Documentation Lotus Quickr 8.5.1 for Domino Documentation Lotus Quickr Connectors 8.5 Documentation Custom Search Scope...
Search
Community Articles > API Documentation > Documents Services
  • New Article
  • Share Show Menu▼
  • Subscribe Show Menu▼

About the Original Author

James A Riel
Contribution Summary:
  • Articles authored: 177
  • Articles edited: 208
  • Comments Posted: 36

Recent articles by this author

What's enhanced in Lotus Quickr Fix Pack 8.5.1.25 for Domino?
The IBM Lotus Quickr Fix Pack 8.5.1.25 for Domino release delivers several features highly requested by Quickr users:

Using the IBM Lotus Quickr 8.5 Connectors
Access the IBM Lotus QuIckr 8.5 Connectors help content.

Differences between version 8.2 and 8.5 of Lotus Quickr for Domino
The change in user interface architecture from Lotus Quickr version 8.2 to version 8.5 has resulted in some less obvious changes to functionality.

Administrator resources for Lotus Quickr 8.5.1 for Domino
The learning roadmap provides a number of resources, including demonstrations, product documentation, and education offerings, to help system administrators get started with IBM Lotus Quickr. Add your suggestions here.

Customizing a place in Lotus Quickr 8.5 for Domino
This video shows the various features of place customization.

Community articleDocuments Services

Added by James A Riel | Edited by IBM contributor Dana Liburdi on October 21, 2010 | Version 45
  • Edit
  • More Actions Show Menu▼
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars
expanded Abstract
collapsed Abstract
No abstract provided.
Tags: API
ShowTable of Contents
HideTable of Contents
  • 1 Document Services Overview
  • 2 Service Providers
  • 3 API Conventions
  • 4 Resources and Collections
  • 5 Operations
    • 5.1 Server Operations
    • 5.2 Library Operations
    • 5.3 Folder Operations
    • 5.4 Document Operations
    • 5.5 Draft Operations
    • 5.6 Document Type Operations
    • 5.7 Property Sheet Type Operations
    • 5.8 Comment Operations
    • 5.9 View Operations

Document Services Overview


The Document Services APIs allow other programs to be integrated with IBM Lotus Quickr document-oriented applications. Application programmers can use the API to build programs that use Lotus Quickr data to add new capabilities to the features provided by Lotus Quickr.

API programs and feed reader programs can also use the Atom syndication format to subscribe to various views of Lotus Quickr data to keep informed of updates and new content. In addition, new content can be created and existing content modified with the API.

Service Providers



The list of documented services providers and their supported component types is described in the following table according to the release the implementation was first introduced.
J2EE
Provider
Component Types
8.0
IBM Lotus Quickr Services for WebSphere Portal
Document Library
8.0
IBM Lotus Quickr Services for WebSphere Portal
Wiki
8.1.1
IBM Lotus Quickr Services for WebSphere Portal
Blog
8.1.1
IBM Lotus Quickr Services for Lotus Domino
Document Library
8.1.1
IBM FileNet Services for Lotus Quickr 1.0.0.0
Document Library
8.1.1
IBM Content Manager Services for Lotus Quickr 1.0.0.0
Document Library

  • NOTE: These services are technical preview for FileNet and Content Manager in Lotus Quickr 8.1.1.


API Conventions


  • API Versioning
  • Authentication
  • Permissions
  • Error Handling
  • HTTP Request Headers
  • Operation Tunneling
  • Character Validation
  • Editing Resources
  • Dates

Resources and Collections



The API defines a set of resources. Each documented resource type is described in the following section according to the release the resource was first introduced.
J2EE
Resource
Description
8.0
Comment
A resource that contains a free-form opinion about a related Document or Draft resource.
8.5
Document
A resource that exposes a set of metadata with an optional primary piece of associated media contents.
8.0
Draft
A resource that represents an unpublished document that is in a working state.
8.0
Folder
A collection that may contain resources of type Folder or Document that imposes a unique file-system mapped label for child content.
8.5
Library
Top level container for all content
8.5
Document Type
A resource that defines the starting template, behavior, and attributes applied to a Document.
8.1.1
Property Sheet Type
A resource that defines a user-defined set of extended attributes.
8.1.1
Sync
A resource that defines a content-replication request
8.1.1 QueryA resource that defines a dynamic query for document related content


Operations



Each operation is focused around a HTTP request to a specific URL endpoint. The following operations are supported. View the details for each operation for the set of supported HTTP headers and URL arguments as well as a example use of the API.


Server Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/introspection
GET
service document
Retrieve service document
8.1 /documents/feed GET atom feed (Document)Retrieve all documents
8.1.1
/sync/feed
POST
atom feed (Document)
Synchronize modified or deleted documents
8.1.1
/query/feed
POST
atom feed (Folder, Document, Draft, Document Type, Property Sheet Type)
Query content


Library Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/library/\{library-id\}/entry
GET
atom entry (Library)
Retrieve a library
8.0
/library/\{library-id\}/entry
PUT
atom entry (Library)
Update a library
8.0
/library/\{library-id\}/feed
GET
atom feed (Folder, Document)
Retrieve a list of content in a library
8.0
/library/\{library-id\}/feed
POST
atom entry (Folder)
Create a folder
8.0
/library/\{library-id\}/feed
POST
atom entry (Document)
Create a document
8.0
/library/\{library-id\}/feed
POST
atom entry (Page)
Create a document
8.0
/library/\{library-id\}/feed
POST
binary media contents
Create a document
8.1 /libraries/feed GET atom feed (Library) Retrieve list of libraries



Folder Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/library/\{library-id\}/folder/\{folder-id\}/entry
GET
atom entry (Folder)
Retrieve a folder
8.0
/library/\{library-id\}/folder/\{folder-id\}/entry
PUT
atom entry (Folder)
Update a folder
8.0
/library/\{library-id\}/folder/\{folder-id\}/entry
DELETE
Delete a folder and all contained resources
8.0
/library/\{library-id\}/folder/\{folder-id\}/feed
GET
atom feed (Folder, (Document)
Retrieve a list of content in a folder
8.0
/library/\{library-id\}/folder/\{folder-id\}/feed
POST
atom entry (Folder)
Create a folder
8.0
/library/\{library-id\}/folder/\{folder-id\}/feed
POST
atom entry (Document)
Create a document
8.0 /library/\{library-id\}/folder/\{folder-id\}/feed POST binary media contents Create a document


Document Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/library/\{library-id\}/document/\{document-id\}/entry
GET
atom entry (Document)
Retrieve a document
8.0
/library/\{library-id\}/document/\{document-id\}/entry
PUT
atom entry (Document)
Update a document
8.0
/library/\{library-id\}/document/\{document-id\}/entry
DELETE
Delete a document and all contained resources
8.0
/library/\{library-id\}/document/\{document-id\}/feed
GET
atom feed (Comment, Version)
Retrieve a list of document related resources
8.0
/library/\{library-id\}/document/\{document-id\}/media
GET
binary of specified Document
Return binary content for document
8.0
/library/\{library-id\}/document/\{document-id\}/feed
POST
atom entry (Comment)
Create a comment


Draft Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/library/\{library-id\}/draft/\{draft-id\}/entry
GET
atom entry (Document)
Retrieve a draft
8.0
/library/\{library-id\}/draft/\{draft-id\}/entry
PUT
atom entry (Document)
Update a draft
8.0
/library/\{library-id\}/draft/\{draft-id\}/entry
DELETE
Delete a draft and all contained resources
8.0
/library/\{library-id\}/draft/\{draft-id\}/feed
GET
atom feed (Comment , Version)
Retrieve a list of draft related resources
8.0
/library/\{library-id\}/draft/\{draft-id\}/media
GET
binary of specified Document
Return binary content for document
8.0
/library/\{library-id\}/draft/\{draft-id\}/feed
POST
atom entry (Comment )
Create a comment


Document Type Operations
J2EE
URI
Method
Input/Output Format
Description
8.1.1
/library/\{library-id\}/documenttypes/\{documenttype-id\}/entry
GET
atom entry (Document Type)
Retrieve a document type
8.1.1
/library/\{library-id\}/documenttypes/\{documenttype-id\}/entry
PUT
atom entry (Document Type)
Update a document type
8.1.1
/library/\{library-id\}/documenttypes/\{documenttype-id\}/entry
DELETE
Delete a document type
8.1.1
/library/\{library-id\}/documenttypes/feed
POST
atom entry (Document Type)
Create a document type
8.1.1
/library/\{library-id\}/documenttypes/feed
GET
atom feed (Document Type)
Retrieve a list of document types



Property Sheet Type Operations
J2EE
URI
Method
Input/Output Format
Description
8.1.1
/library/\{library-id\}/propertysheettypes/\{propertysheettype-id\}/entry
GET
atom entry (Property Sheet Type)
Retrieve a property sheet type
8.1.1
/library/\{library-id\}/propertysheettypes/\{propertysheettype-id\}/entry
PUT
atom entry (Property Sheet Type)
Update a property sheet type
8.1.1
/library/\{library-id\}/propertysheettypes/\{propertysheettype-id\}/entry
DELETE
Delete a property sheet type
8.1.1
/library/\{library-id\}/propertysheettypes/feed
POST
atom entry (Property Sheet Type)
Create a property sheet type
8.1.1
/library/\{library-id\}/propertysheettypes/feed
GET
atom feed (Property Sheet Type)
Retrieve a list of property sheet types


Comment Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/library/\{library-id\}/document/\{document-id\}/comment/\{comment-id\}/entry
GET
atom entry (Comment )
Retrieve a comment.
8.0
/library/\{library-id\}/document/\{document-id\}/comment/\{comment-id\}/entry
PUT
atom entry (Comment )
Update comment.
8.0
/library/\{library-id\}/document/\{document-id\}/comment/\{comment-id\}/entry
DELETE
Delete a comment.
8.0
/library/\{library-id\}/document/\{document-id\}/comment/\{comment-id\}/media
GET
binary of specified Comment
Return binary content for comment.
8.0
/library/\{library-id\}/draft/\{draft-id\}/comment/\{comment-id\}/entry
GET
atom entry (Comment )
Retrieve a comment.
8.0
/library/\{library-id\}/draft/\{draft-id\}/comment/\{comment-id\}/entry
PUT
atom entry (Comment )
Update a comment.
8.0
/library/\{library-id\}/draft/\{draft-id\}/comment/\{comment-id\}/entry
DELETE
Delete a comment.
8.0
/library/\{library-id\}/draft/\{draft-id\}/comment/\{comment-id\}/media
GET
binary of specified Comment
Return binary content for comment.


View Operations
J2EE
URI
Method
Input/Output Format
Description
8.0
/library/\{library-id\}/view/\{view-id\}/feed
GET
atom feed (Document)
Retrieve documents from a view
8.0
/library/\{library-id\}/view/AllDocuments/feed
GET
atom feed (Document)
Retrieve all documents in a library
8.0
/library/\{library-id\}/view/WorkingDrafts/feed
GET
atom feed (Document)
Retrieve all working drafts in a library
8.0
/library/\{library-id\}/view/SubmittedDrafts/feed
GET
atom feed (Document)
Retrieve all submitted drafts in a library
8.0
/library/\{library-id\}/view/ReviewDrafts/feed
GET
atom feed (Document)
Retrieve all drafts to approve in a library
8.0
/library/\{library-id\}/view/CheckedOut/feed
GET
atom feed (Document)
Retrieve all checked out documents in a library
8.1.1 /library/\{library-id\}/views/feed GET atom feed (View) Retrieve a list of views

  • Edit
  • More Actions Show Menu▼


expanded Attachments (0)
collapsed Attachments (0)
Edit the article to add or modify attachments.
expanded Versions (42)
collapsed Versions (42)
Version Comparison     
VersionDateChanged by              Summary of changes
This version (45)Oct 21, 2010 12:28:32 AMDana Liburdi  IBM contributor
44Oct 20, 2010 11:54:42 PMDana Liburdi  IBM contributor
43Sep 17, 2010 2:37:29 PMKristopher T Stoddard  IBM contributor
42Sep 17, 2010 12:39:43 PMKristopher T Stoddard  IBM contributor
41Sep 17, 2010 9:56:20 AMKristopher T Stoddard  IBM contributor
37Sep 17, 2010 8:50:23 AMDave Langley  IBM contributor
36Sep 17, 2010 8:48:13 AMDave Langley  IBM contributor
34Sep 17, 2010 8:46:47 AMDave Langley  IBM contributor
34Sep 17, 2010 8:46:47 AMDave Langley  IBM contributor
33Sep 17, 2010 8:45:41 AMDave Langley  IBM contributor
32Sep 17, 2010 8:30:47 AMDave Langley  IBM contributor
31Sep 17, 2010 8:29:43 AMDave Langley  IBM contributor
30Sep 17, 2010 8:03:41 AMDave Langley  IBM contributor
29Sep 17, 2010 8:01:41 AMDave Langley  IBM contributor
28Jun 30, 2010 4:31:57 PMKristopher T Stoddard  IBM contributor
28Sep 17, 2010 7:54:16 AMDave Langley  IBM contributor
27Dec 11, 2009 10:46:39 AMJames A Riel  IBM contributor
27Sep 17, 2010 7:24:01 AMDave Langley  IBM contributor
26Oct 7, 2009 2:17:31 PMKristopher T Stoddard  IBM contributor
26Sep 17, 2010 5:49:15 AMDave Langley  IBM contributor
24Feb 18, 2009 11:53:03 AMGregory Melahn  IBM contributor
23Feb 16, 2009 11:31:11 AMGregory Melahn  IBM contributor
23Feb 16, 2009 11:31:11 AMGregory Melahn  IBM contributor
22Jan 27, 2009 4:04:41 PMCraig Lordan  IBM contributor
21Jan 20, 2009 5:04:52 PMGregory Melahn  IBM contributor
20Nov 4, 2008 8:03:51 AMJames A Riel  IBM contributor
19Oct 31, 2008 2:17:47 PMJames A Riel  IBM contributor
18Oct 31, 2008 1:21:39 PMJames A Riel  IBM contributor
17Oct 31, 2008 1:19:13 PMJames A Riel  IBM contributor
16Oct 31, 2008 9:36:22 AMJames A Riel  IBM contributor
15Oct 31, 2008 9:35:26 AMJames A Riel  IBM contributor
14Oct 31, 2008 9:29:58 AMJames A Riel  IBM contributor
13Oct 31, 2008 9:06:40 AMJames A Riel  IBM contributor
12Oct 30, 2008 8:57:45 AMJames A Riel  IBM contributor
11Oct 29, 2008 8:39:42 AMJames A Riel  IBM contributor
10Oct 29, 2008 7:47:43 AMJames A Riel  IBM contributor
9Oct 29, 2008 6:36:15 AMJames A Riel  IBM contributor
8Oct 28, 2008 12:26:33 PMJames A Riel  IBM contributor
7Oct 28, 2008 11:40:51 AMJames A Riel  IBM contributor
6Oct 28, 2008 11:36:19 AMJames A Riel  IBM contributor
5Oct 28, 2008 10:47:46 AMJames A Riel  IBM contributor
3Sep 17, 2008 7:26:19 AMJames A Riel  IBM contributor
expanded Comments (0)
collapsed Comments (0)
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedHelpAbout
  • IBM Collaboration Solutions wikis
  • IBM developerWorks
  • IBM Software support
  • Twitter LinkIBMSocialBizUX on Twitter
  • FacebookIBMSocialBizUX on Facebook
  • ForumsLotus product forums
  • BlogsIBM Social Business UX Blog
  • Community LinkIBM Collaboration Solutions
  • Wiki Help
  • Forgot user name/password
  • Wiki design feedback
  • Content feedback
  • About the wiki
  • About IBM
  • Privacy
  • Accessibility
  • IBM Terms of use
  • Wiki terms of use