> AquaLogic User Interaction Development Guide > About the Pathways API > Pathways API Search Query Parameters

AquaLogic User Interaction Development Guide

     Previous Next  Open TOC in new window   View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Pathways API Search Query Parameters

The Pathways API provides a set of standard query parameters to execute search queries.

Query Parameter Purpose Valid Values Default Value
order Defines the order of the search results.
  • "ASC" — Ascending
  • "DES" — Descending
 “DES” (Descending )
orderBy Designates result field for sorting.
  • "RANK"
  • "CONTENTTYPE"
  • "CONTENTURL"
  • "DESCRIPTION"
  • "DETAILSURL"
  • "LAST_MODIFIED
  • "NAME"
  • "PATH"
  • "PROJECT"
  • "PROJECTURL"
  • "TAGS"
 “RANK” (The search score for each item.)
tagCount Defines the maximum number of tags to return. (Applies only to tag queries.) int 50
startAt Offsets starting result within complete result set. 0 > int < total result count 1
resultCount Defines the maximum number of results to return. int > 0 10
query Establishes the search query itself. Any terms with the existing search syntax (everything)
viewId Limits result set to an existing View. Existing View ID (everyone)
resultType Limits result set to items of a particular type.
  • “ALL”
  • “DOCS_ONLY”
  • “USERS_ONLY”
 “ALL” (both documents and users)
onlyFavorites Limits result set to Favorites/Contacts. “true” or “false” “false”
kdFolders Limits result set to items in specific Knowledge Directory folders. Comma delimited list of folder IDs (all — no constraint)
adminFolders Limits result set to items in specific Administrative folders. Comma delimited list of folder IDs (all — no constraint)
collabProjects Limits result set to items in specific Collaboration projects. Comma delimited list of project IDs (all — no constraint)
newerThan Limits search result to items created since a specific date. URL-encoded short form date (“11/7/2007”) (all — no constraint)
objectTypes Restricts search to specific object types. Comma delimited list of any of the following strings:
  • AdminFolders
  • AuthenticationSources
  • CollabDiscussion
  • CollabDocument
  • CollabEvent
  • CollabMessage
  • CollabProject
  • CollabTask
  • Communities
  • CommunityPages
  • CommunityTemplates
  • ContentSources
  • ContentTypes
  • Crawlers
  • DocumentFolders
  • ExperienceDefinitions
  • ExternalOperations
  • FederatedSearches
  • Filters
  • Groups
  • Invitations
  • Jobs
  • PageTemplates
  • PortalDocuments
  • Portlets
  • PortletTemplates
  • ProfileSources
  • Properties
  • PublisherItems
  • RemoteServers
  • SnapshotQueries
  • Users
  • WebServices
  • FromUserPrefs (object types from Pathways user preferences)
  • FromAdminPrefs (object types pulled from Pathways admin preferences)
(all — no constraint)
propertyIDs Designates indexed properties by ID to include with each search result. Comma delimited property IDs (for example, “210,215” or “PT210,PT215”) ID, Name, Description, Folder, URL, Last Modified, Activity Rank
propertyNames Designates indexed properties by name to include with each search result. Comma delimited property names (for example, “Office,Sales+Region”) ID, Name, Description, Folder, URL, Last Modified, Activity Rank
Parent topic: About the Pathways API

  Back to Top      Previous Next