You are here

SkyVault Content Services 5.2 » Developer guide » API guide » Using the APIs

Using the APIs by Function

Provides API information based on what type of operation that should be executed.

This information groups the APIs based on what entity or function they operate on. For example, if you wanted to access a node, you would look under the Nodes section. If you are looking for a way to start workflows then you would go to the Workflow section.

References to code in different languages such as REST, Java, and JavaScript are also included.

  • Actions Actions are units of work that can be carried out on a node. Usually they are fired by Rules, so that, for example, when a piece of content is added (or removed) from a specific folder, it is transformed, tagged, or processed in some way.
  • Files and Folders Files (Documents) and Folders (Containers) are fundamental units within the repository. Developers often search for specific files and folders and process them. In addition Rules can be set on Folders that fire Actions when files are added or removed from a Folder.
  • Nodes The core data structure in the repository is called a node. Each piece of content in the repository has a corresponding node data structure to reference the content and metadata. Each node has a corresponding NodeRef uniquely identifying it in the repository.
  • People Users and groups are fundamental to a content management system, as they add and share content, are used to control permissions, create sites and interact with them and perform day to day functions relating to content.
  • Search Solr provides indexing of metadata and the plain text of content. This can be queried using various query languages, including Lucene and CMIS Query Language.
  • Sites Sites provide a way for users to collaborate around content. Content can be organized within sites, and access to sites controlled by the site managers.
  • Tags Tags are simple text labels that are attached to a piece of content, such as a folder, file, wiki page, discussion, event and so on. Each piece of content can have multiple tags. Folders also have a TagScope object which encapsulates information about the tags used on content in that folder. The TagScope object contains an array that lists Tags in count order. There are methods to find out how many times a particular tag is used.
  • Workflow The Activiti workflow engine is built into SkyVault Content Services. It also provides UI in SkyVault Share to allow you to create standard workflows and manage them. In addition, as a developer, you can create custom workflows and manage them programmatically.
Parent topic: Using the APIs

© 2017 TBS-LLC. All Rights Reserved.