Categories in Search API responses
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The atom:category elements contained within an atom:entry element convey information about the categories associated with that entry. This article explains the categories used in Search API responses.
Tags: api, search

The atom:category elements contained within an atom:entry element convey information about the categories associated with that entry. This article explains the categories used in Search API responses.

There are four categorization schemes explicitly used by Search:

  • http://www.ibm.com/xmlns/prod/sn/accesscontrolled which will be referred to, for convenience, as the "AccessControlled" category in this article
  • http://www.ibm.com/xmlns/prod/sn/component which will be referred to, for convenience, as the "Component" category in this article
  • http://www.ibm.com/xmlns/prod/sn/doctype which will be referred to, for convenience, as the "DocType" category in this article
  • http://www.ibm.com/xmlns/prod/sn/type which will be referred to, for convenience, as the "Type" category in this article


The case in which a categorization scheme is not specified by Search will be referred to as the "Tag" category in this article.

AccessControlled


The AccessControlled category represents the access control category the search result is associated with. There are two possible values for the term attribute:

  • private
  • public

Component


The component category represents the 'Source' facet of the facets taxonomy the search result is associated with. The possible term attribute values include:
  • activities
  • activities:activity
  • activities:bookmark
  • activities:community_activity
  • activities:entry
  • activities:explicit_membership_community_activity
  • activities:section
  • activities:task
  • blogs
  • blogs:comment
  • blogs:main
  • blogs:entry
  • blogs:ideationblogs
  • blogs:ideationblogs:comment
  • blogs:ideationblogs:ideationblog
  • blogs:ideationblogs:idea
  • calendar
  • communities
  • communities:calendar
  • communities:feed
  • communities:entry
  • communities:bookmark
  • dogear
  • ecm_files
  • files
  • forums
  • forums:category
  • forums:forum
  • forums:topic
  • profiles
  • status_updates
  • wikis
  • wikis:file
  • wikis:page
  • wikis:wiki


Possible term attribute values also include all of the above list with the prefix of "communities:" except for communities, communities:bookmark, communities:feed, communities:entry, dogear and profiles.

Each of the above term attribute values can be used as the value of a scope parameter request to the Search API. They can also be used as a category path, after the appropriate transformation (replace the separator ":" with "/" and prefix with "Source/"), in the values attribute of a constraint. Some examples:

  • scope=forums:forum
  • constraint={"type":"category","values":["Source/activities/activity","Source/forums/forum"]}
  • constraint={"type":"category","values":["Source/activities","Source/dogear","Source/wikis","Source/status_updates"]}


DocType


The DocType category represents the 'DocType' taxonomy categories the search result is associated with.

Tag


The Tag category represents what tags the search result is associated with. The term attribute value of the category element specifies the relevant tag.

Type


The Type category element will always have a term attribute value of "search" in a Search API response.