You are here

SkyVault Community Edition 201704 » Developer guide » API guide » SkyVault Community Edition API Reference » JavaScript API » Scripting API

Classification API

The Classification API has two parts: manipulating classifications, and manipulating the categories they contain.
A root level classification object is provided to return category nodes. The CategoryNode objects returned from the methods are extended from the standard JavaScript ScriptNode model to include category manipulation.
  • createRootCategorycreateRootCategory(aspect, name) creates a root category.
  • getAllCategoryNodesgetAllCategoryNodes(aspect) gets an array of all the category nodes in the given classification.
  • getAllClassificationAspectsgetAllClassificationAspects() gets all the aspects that define a classification. An array of aspect QNames in prefix:localName form is returned.
  • getCategorygetCategory(catRef) returns a category node.
  • getCategoryUsagegetCategoryUsage(aspect, maxCount) returns categories with the most number of objects. The number of categories returned is specified in maxCount.
  • getRootCategoriesgetRootCategories(aspect) returns an array of root category nodes for a given classification.
  • CategoryNode API The CategoryNode objects returned from the classification object methods are extended from the standard JavaScript ScriptNode model.
Parent topic: Scripting API

© 2017 TBS-LLC. All Rights Reserved.