> AquaLogic User Interaction Development Guide > About the Pathways API > Pathways API Interfaces

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 Interfaces

The Pathways API includes a collection of interfaces for accessing and managing items, users, views, tags, and saved searches.

Function URL (Interface) HTTP Method Method Parameters
Retrieve the version of the Pathways API. /pathways/api/version GET  
Retrieve suggested tags. /pathways/api/suggest/[tag-prefix] GET  
Retrieve tags created after a specific date. /pathways/api/tags/created-after GET date=[encoded date]
Retrieve tags applied to a specific item. /pathways/api/item/[id]/tags GET  
Remove a tag from a specific item. /pathways/api/item/[id]/tag DELETE 
<soc:PTagList 
xmlns:soc="http://social.bea.com/pathways">    
<tag>
  <value>TagToRemove</value>
</tag>
</soc:PTagList>
Add a tag to a specific item. /pathways/api/item/[id]/tag POST 
<soc:PTagList 
xmlns:soc="http://social.bea.com/pathways">    
<tag>
  <value>TagToAdd</value>
</tag>
</soc:PTagList>
Retrieve a tag cloud for a search /pathways/api/tags/[viewid]
[viewid] must be one of the following:
  • “my” for the current user's tags
  • “ev” for everyone's tags
  • a custom view ID
GET Search query. For a list of query parameters, see Pathways API Search Query Parameters.
Retrieve the list of saved searches. /pathways/api/savedsearches GET  
Retrieve the details of an existing saved search. /pathways/api/savedsearch/[id] GET  
Remove an existing saved search /pathways/api/savedsearch/[id] DELETE  
Edit an existing saved search. /pathways/api/savedsearch/[id] PUT 
<soc:PSavedSearchesList 
xmlns:soc="http://social.bea.com/pathways">  
<savedSearch>
  <created>2007-10-09T16:58:16.593-07:00</created>
  <dailyEmail>false</dailyEmail>
  <ownerId>PTPORTAL:1:1</ownerId>
  <queryString>Tabloid News</queryString>
  <rssFormat>false</rssFormat>
</savedSearch>
</soc:PSavedSearchesList>
Create a new saved search. /pathways/api/savedsearch POST 
<soc:PSavedSearchesList 
xmlns:soc="http://social.bea.com/pathways">  
<savedSearch>
  <created>2007-10-09T16:58:16.593-07:00</created>
  <dailyEmail>false</dailyEmail>
  <ownerId>PTPORTAL:1:1</ownerId>
  <queryString>Tabloid News</queryString>
  <rssFormat>false</rssFormat>
</savedSearch>
</soc:PSavedSearchesList>
Get the list of existing views. /pathways/api/views GET  
Get the details of a specific view. /pathways/api/view/[id] GET  
Remove an existing view. /pathways/api/view/[id] DELETE  
Edit an existing view. /pathways/api/view/[id] PUT 
<soc:PViewDetail 
xmlns:soc="http://social.bea.com/pathways">
  <members>PTPORTAL:1:203</members>
  <name>Marketing view</name>
  <published>true</published>
  <subscribers>PTPORTAL:1:203,PTPORTAL:1:204,PTPORTAL:1:1</subscribers>
</soc:PViewDetail>
Create a new view. /pathways/api/view POST Expressed in XML payload.name=[view name]members=[comma separated list of user/group ids]subscribers=[comma separated list of user/group ids]
Get a list of items. /pathways/api/items GET Search query. For a list of query parameters, see Pathways API Search Query Parameters.
Get details of a specific item. /pathways/api/item/[ptsource]/[id] GET  
Retrieve the favorite state for an item or contact state for a user. /pathways/api/isfavorite/[id] GET  
Modify the favorite state for an item or contact state for a user. /pathways/api/isfavorite/[id] PUT 
<soc:PIsItemFavorite 
xmlns:soc="http://social.bea.com/pathways">
  <result>true</result>
</soc:PIsItemFavorite>
Get a list of experts. /pathways/api/people GET Search query. For a list of query parameters, see Pathways API Search Query Parameters.
Get details of a specific expert. /pathways/api/people/[id] GET  
Get access privileges for a specific user. /pathways/api/privileges GET  
PUT and DELETE methods can be overloaded by using a POST method with specific headers to resolve issues with browser support for asynchronous PUT and DELETES.
  • X-HTTP-Method-Override: PUT can be used in a POST request header to signal that a PUT operation is intended.
  • X-HTTP-Method-Override: DELETE can be used in a POST request header to signal that a DELETE operation is intended.
All requests should include the parameter format=XML.
Parent topic: About the Pathways API

  Back to Top      Previous Next