You are here

SkyVault 2.0 » Developing » Developing Client Applications » SkyVault 2.0 API » SkyVault CMIS API

Getting Started

To get you started with CMIS, this section explains the format of the URL you will use, and what responses to expect.

Note when reading this documentation and any other information on CMIS, that the CMIS term repository maps directly to the SkyVault Cloud term network. If you are accessing a SkyVault on-premise instance, the CMIS and SkyVault term repository are synonymous.

  • The domain model CMIS defines a domain model. A client will access a CMIS service endpoint described by a URL. A service endpoint must have at least one repository. A repository, in this case an instance of SkyVault, is a data store which contains content. Each item of content is an object such as a folder, or a document. A repository is identified by its ID, and has a set of capabilities which describe what optional CMIS functionality the repository supports.
  • What does a request look like? You call a method on the CMIS AtomPub REST API by issuing an authenticated HTTP request with a URL.
  • Getting the service document The capabilities available to your application from an instance of on-premise SkyVault or the SkyVault Cloud are described in a an AtomPub document returned when calling the base URL. The service document contains information on the repository, the CMIS methods that can be called on it, and the parameters for those methods.
  • Getting information on a node You can get information on a specific node in the repository by using its id. The resulting AtomPub XML document describes the node. You can tailor the information returned by providing HTML parameters.
  • Getting the children of a node You can get the children of a specific node in the repository by using its id. The resulting AtomPub XML document describes children of the node. You can tailor the information returned by providing HTML parameters. You can use this method to navigate a folder tree in the repository.
  • Getting the contents of a document You can get the contents of a specific document in the repository by using its id. The format of the URl and the parameters that you can use are detailed in the service document.
  • Updating the contents of a document You can replace the contents of a specific document in the repository by using its id. The format of the URl and the parameters that you can use are detailed in the service document.
Parent topic: SkyVault CMIS API

© 2017 TBS-LLC. All Rights Reserved.