Application Favorites REST services

Use these REST services to retrieve application favorites.

Main entry points

Templates:: <portal host>:<portal port>/<portal context root>/mycontenthandler/ai/templates?mode=download
Applications:: <portal host>:<portal port>/<portal context root>/mycontenthandler/ai/applications?mode=download
Application-Favorites:: <portal host>:<portal port>/<portal context root>/mycontenthandler/ai/application-favorites?mode=download (since V6.1.5)

Possible failure return codes

HTTP 400: Malformed syntax. Please check the Portal logs and fix your input data.
HTTP 401: Unauthorized access. Please make sure you have the right to access the resource and/or check your login data.
HTTP 403: Forbidden. Please make sure you have the right to access the resource and/or check your login data.
HTTP 404: Not found. The requested resource does not exist on the server, please check the URL.
HTTP 500: Internal server error. Please check the Portal logs.

Depending on your system environment, there may be additional failure response codes. If needed, check with your administrator.

Table 1. Retrieve application-favorites

Description URL HTTP Method Input Type Return Code Return Type Links Supported URL Parameters
Loads the feed of all application-favorites entries available in the system for the current user application favorites entry point GET - HTTP 200 application/atom+xml

ca:rel="user-profile"

Link to user profile data of the linked user of the application favorites.

ca:rel="application"

Link to application data of the linked application of the application favorites.

-

Table 1. Retrieve application-favorites
Description	URL	HTTP Method	Input Type	Return Code	Return Type	Links	Supported URL Parameters
Loads the feed of all application-favorites entries available in the system for the current user	application favorites entry point	GET	-	HTTP 200	application/atom+xml	ca:rel="user-profile" Link to user profile data of the linked user of the application favorites. ca:rel="application" Link to application data of the linked application of the application favorites.	-

Return data example:

<?xml version="1.0" encoding="UTF-8"?>
<atom:feed
   xml:base="http://localhost:10040/wps/mypoc/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites"
   xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0"
   xmlns:app="http://www.w3.org/2007/app"
   xmlns:atom="http://www.w3.org/2005/Atom"
   xmlns:ca="http://www.ibm.com/xmlns/prod/composite-applications/v1.0"
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
   xmlns:portal="http://www.ibm.com/xmlns/prod/websphere/portal/v6.0.1/portal-model" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <atom:author>
      <atom:name>WebSphere Portal/6.1.0.3</atom:name>
   </atom:author>
   <atom:title>WebSphere Portal Application Infrastructure Feed</atom:title>
   <atom:link
      href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites"
      rel="self" type="application/atom+xml"/>
   <atom:id>ai:application-favorites</atom:id>
   <atom:updated>2009-09-25T12:27:28.625Z</atom:updated>
   <atom:entry>
      <atom:id>ai:application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1</atom:id>
      <atom:title xml:lang="en">New application title</atom:title>
      <atom:summary xml:lang="en">New application description</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="edit" type="application/atom+xml"/>
      <atom:link ca:rel="application"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/applications/1F_AESU3F54007AE0IOJUVMU40003"
         rel="related" type="application/atom+xml"/>
      <atom:link ca:rel="user-profile"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/um/secure/users/profiles/9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:28.359Z</atom:updated>
      <atom:content type="application/xml">
         <ca:application-favorite
            ca:app-id="1F_AESU3F54007AE0IOJUVMU40003" ca:user-id="9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"/>
      </atom:content>
   </atom:entry>
   <atom:entry>
      <atom:id>ai:application-favorites/1F_AESU3F54007AE0IOJUVMU40041-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1</atom:id>
      <atom:title xml:lang="en">Project beta</atom:title>
      <atom:summary xml:lang="en">Application for project beta</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40041-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40041-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="edit" type="application/atom+xml"/>
      <atom:link ca:rel="application"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/applications/1F_AESU3F54007AE0IOJUVMU40041"
         rel="related" type="application/atom+xml"/>
      <atom:link ca:rel="user-profile"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/um/secure/users/profiles/9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:28.359Z</atom:updated>
      <atom:content type="application/xml">
         <ca:application-favorite
            ca:app-id="1F_AESU3F54007AE0IOJUVMU40041" ca:user-id="9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"/>
      </atom:content>
   </atom:entry>
</atom:feed>

Table 2. Retrieve application-favorite

Description URL HTTP Method Input Type Return Code Return Type Links Supported URL Parameters
Loads the feed of a specific application-favorites feed Provided by ca:rel="favorite" link of corresponding application ATOM entry GET - HTTP 200 application/atom+xml

ca:rel="user-profile"

Link to user profile data of the linked user of the application favorites.

ca:rel="application"

Link to application data of the linked application of the application favorite.

-

Table 2. Retrieve application-favorite
Description	URL	HTTP Method	Input Type	Return Code	Return Type	Links	Supported URL Parameters
Loads the feed of a specific application-favorites feed	Provided by ca:rel="favorite" link of corresponding application ATOM entry	GET	-	HTTP 200	application/atom+xml	ca:rel="user-profile" Link to user profile data of the linked user of the application favorites. ca:rel="application" Link to application data of the linked application of the application favorite.	-

Return data example:

<?xml version="1.0" encoding="UTF-8"?>
<atom:feed
   xml:base="http://localhost:10040/wps/mypoc/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
   xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0"
   xmlns:app="http://www.w3.org/2007/app"
   xmlns:atom="http://www.w3.org/2005/Atom"
   xmlns:ca="http://www.ibm.com/xmlns/prod/composite-applications/v1.0"
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
   xmlns:portal="http://www.ibm.com/xmlns/prod/websphere/portal/v6.0.1/portal-model" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <atom:author>
      <atom:name>WebSphere Portal/6.1.0.3</atom:name>
   </atom:author>
   <atom:title>WebSphere Portal Application Infrastructure Feed</atom:title>
   <atom:link
      href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
      rel="self" type="application/atom+xml"/>
   <atom:id>ai:application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1</atom:id>
   <atom:updated>2009-09-25T12:27:28.750Z</atom:updated>
   <atom:entry>
      <atom:id>ai:application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1</atom:id>
      <atom:title xml:lang="en">New application title</atom:title>
      <atom:summary xml:lang="en">New application description</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/application-favorites/1F_AESU3F54007AE0IOJUVMU40003-9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="edit" type="application/atom+xml"/>
      <atom:link ca:rel="application"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/applications/1F_AESU3F54007AE0IOJUVMU40003"
         rel="related" type="application/atom+xml"/>
      <atom:link ca:rel="user-profile"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/um/secure/users/profiles/9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:28.750Z</atom:updated>
      <atom:content type="application/xml">
         <ca:application-favorite
            ca:app-id="1F_AESU3F54007AE0IOJUVMU40003" ca:user-id="9eAePPC2JP8C2ROIJMG6M1D8JMG6PPD0JM0723P8JM06KPOC6IH66BOCMQC6N1"/>
      </atom:content>
   </atom:entry>
</atom:feed>

Parent topic:

Composite Applications REST services