The IBM® CMIS for
Enterprise Content Management index page contains information about
the instance of IBM CMIS that
is deployed to your web application server.
The index page includes links to the service documents and information
about the URI templates and service collections that are defined for
the repositories on your Enterprise Content Management server. The
information depends on the type of
IBM CMIS application that is deployed
in your environment:
- On IBM FileNet® P8, the index
page describes how to interact with the object stores on your Content Engine server
- On IBM Content Manager Enterprise Edition, the index page describes
how to interact with the library servers on your Content Manager EE server
- On IBM Content
Manager OnDemand, the index
page describes how to interact with the folders on your OnDemand server
You can use the information about the index page to do these tasks:
- Interact with the OASIS CMIS web services binding or RESTful AtomPub
binding
- Develop an application by using an API framework, such as Apache
Chemistry API framework. The framework that you use depends on the
language in which you develop your application
When
IBM CMIS is properly
configured and deployed, you can access the index page at http://
host_name:
port/
context_root/index.jsp.
The default context root varies depending on the type of
IBM CMIS application that is deployed:
- IBM CMIS
for FileNet Content Manager: fncmis
- IBM CMIS
for Content Manager: cmcmis
- IBM CMIS
for Content Manager OnDemand: odcmis
The index page also includes links to the web services binding
information and the RESTful Atom Protocol (AtomPub) binding information
in the OASIS CMIS specification.
Service collection URLs
- Root folder collection
- Provides a feed that displays all of the folders and documents
that are in the root folder.
- Query collection
- Provides a feed of the objects that satisfy a predefined query.
- Checked out collection
- Provides a feed of the documents that are in the checked-out state
in the repository.
- Unfiled collection
- Provides a feed of the documents that are not filed in a folder
in the repository.
- Types children collection
- Provides a feed of the base object types, specifically, cmis:document
and cmis:folder.
URI templates
URI templates enable users
to insert values in a standardized URI to retrieve specific data,
such as a specific folder or document, from the repository.
The
OASIS specification defines the following URI templates:
- Object by ID (objectbyid) template
- Enables users to create a URI that can access a document or folder
by specifying the ID of the object.
- Object by path (objectbypath) template
- Enables users to create a URI that can access a document or folder
by specifying the path of the object.
- Query (query) template
- Enables users to create a URI to search for data in the repository
by specifying a CMIS query statement. The server returns a feed of
objects that correspond to the query that is provided.
- Type by ID (typebyid) template
- Enables users to create a URI to retrieve metadata about a type
(IBM FileNet P8 class). The server returns the class description information
in the CMIS format for a type, which includes all the property descriptions
that are defined for the specified type.
For more information, see section 3.6.1 URI Templates of the OASIS CMIS specification.