Roles REST services

Use these REST services to get and add roles to applications.

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. Get roles

Description URL HTTP Method Input Type Return Code Return Type Links Supported URL Parameters
Loads the feed of all roles defined by the application. Provided by ca:rel="roles" link in application's feed GET - HTTP 200 application/atom+xml

ac:rel="members"

Link to member feed for this role.

rel="first"

Link to the first feed fragment. This link is served only if a feed fragment was served.

rel="last"

Link to the last feed fragment. This link is served only if a feed fragment was served.

rel="previous"

Link to the feed fragment that precedes the given feed fragment.
This link is served only if a feed fragment was served that does not start at the beginning of the feed.

rel="next"

Link to the next feed fragment. This link is served only if a feed fragment was served that does not contain the last entry of the feed.

[resolve-membership]

false: Membership information is not merged into the role feed. (Default)
true: Individual role elements served by this request do contain nested <member> elements for the principals assigned the individual roles.

[rep]

full: Returned role information is represented by <role> elements as defined in ca.xsd. (Default)
compact: Returned role information is represented by <role> elements as defined in ca.xsd without child elements.

[order-by]

type: Sorts this feed according to the "type" attribute of the role element.
updated: Sorts this feed according to the "atom:updated" entry. (Default)
title: Sorts this feed according to the "atom:title" entry.

[sort-order]

asc: Sorts this feed in ascending order. (Default)
desc: Sorts this feed in descending order.

[start-index]

XXX: Identifies the start index of the feed fragment to be served.
(Default: 0)

[max-results]

XXX: Identifies the maximum number of entries to be served by this request.
(Default: Configurable setting on the server)

[filter]

hide-admin-roles=true: Filters the administrator roles (roles that have application or community administrator permissions).
type=<filter-pattern>: Filters the entries of the roles feed based on roles type. The "<filter-pattern>" needs to be replaced by the a specific role type.
(Default: None)

Table 1. Get roles
Description	URL	HTTP Method	Input Type	Return Code	Return Type	Links	Supported URL Parameters
Loads the feed of all roles defined by the application.	Provided by ca:rel="roles" link in application's feed	GET	-	HTTP 200	application/atom+xml	ac:rel="members" Link to member feed for this role. rel="first" Link to the first feed fragment. This link is served only if a feed fragment was served. rel="last" Link to the last feed fragment. This link is served only if a feed fragment was served. rel="previous" Link to the feed fragment that precedes the given feed fragment. This link is served only if a feed fragment was served that does not start at the beginning of the feed. rel="next" Link to the next feed fragment. This link is served only if a feed fragment was served that does not contain the last entry of the feed.	[resolve-membership] false: Membership information is not merged into the role feed. (Default) true: Individual role elements served by this request do contain nested <member> elements for the principals assigned the individual roles. [rep] full: Returned role information is represented by <role> elements as defined in ca.xsd. (Default) compact: Returned role information is represented by <role> elements as defined in ca.xsd without child elements. [order-by] type: Sorts this feed according to the "type" attribute of the role element. updated: Sorts this feed according to the "atom:updated" entry. (Default) title: Sorts this feed according to the "atom:title" entry. [sort-order] asc: Sorts this feed in ascending order. (Default) desc: Sorts this feed in descending order. [start-index] XXX: Identifies the start index of the feed fragment to be served. (Default: 0) [max-results] XXX: Identifies the maximum number of entries to be served by this request. (Default: Configurable setting on the server) [filter] hide-admin-roles=true: Filters the administrator roles (roles that have application or community administrator permissions). type=<filter-pattern>: Filters the entries of the roles feed based on roles type. The "<filter-pattern>" needs to be replaced by the a specific role type. (Default: None)

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/applications/1F_AESU3F54007AE0IOJUVMU40041/roles"
   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/applications/1F_AESU3F54007AE0IOJUVMU40041/roles"
      rel="self" type="application/atom+xml"/>
   <atom:id>ai:applications/1F_AESU3F54007AE0IOJUVMU40041/roles</atom:id>
   <atom:updated>2009-09-25T12:27:28.921Z</atom:updated>
   <opensearch:totalResults>2</opensearch:totalResults>
   <atom:entry>
      <atom:id>ai:roles/1C_AESU3F54007AE0IOJUVMU400S2</atom:id>
      <atom:title>Administrators</atom:title>
      <atom:summary>Can edit the application and control membership.</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S2"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S2"
         rel="edit" type="application/atom+xml"/>
      <atom:link ac:rel="members" ac:roletype="manager"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S2/members"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:28.890Z</atom:updated>
      <atom:content type="application/xml">
         <ac:role ac:id="1C_AESU3F54007AE0IOJUVMU400S2"
            ac:type="manager" xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0">
            <ac:title xml:lang="zh_TW">ç¡ç†è€…</ac:title>
            <ac:title xml:lang="ar">Ù…ÙˆØ¬Ù‡ÙŠ Ø§Ù„Ù†Ø¸Ø§Ù…</ac:title>
            <ac:title xml:lang="es">Administradores</ac:title>
            <ac:title xml:lang="el">Î”Î¹Î±Ï‡ÎµÎ¹ÏÎ¹ÏƒÏ„ÎÏ‚</ac:title>
            <ac:title xml:lang="it">Amministratori</ac:title>
            <ac:title xml:lang="fi">PÃ¤Ã¤kÃ¤yttÃ¤jÃ¤t</ac:title>
            <ac:title xml:lang="tr">Denetimciler</ac:title>
            <ac:title xml:lang="pl">Administratorzy</ac:title>
            <ac:title xml:lang="uk">ÐÐ´Ð¼Ñ–Ð½Ñ–ÑÑ‚Ñ€Ð°Ñ‚Ð¾Ñ€Ð¸</ac:title>
            <ac:title xml:lang="cs">AdministrÃ¡toÅ™i</ac:title>
            <ac:title xml:lang="hr">Administratori</ac:title>
            <ac:title xml:lang="pt">Administradores</ac:title>
            <ac:title xml:lang="pt_BR">Administradores</ac:title>
            <ac:title xml:lang="iw">×ž× ×”×œ× ×™×</ac:title>
            <ac:title xml:lang="da">Administratorer</ac:title>
            <ac:title xml:lang="sv">AdministratÃ¶rer</ac:title>
            <ac:title xml:lang="ru">ÐÐ´Ð¼Ð¸Ð½Ð¸ÑÑ‚Ñ€Ð°Ñ‚Ð¾Ñ€Ñ‹</ac:title>
            <ac:title xml:lang="sk">AdministrÃ¡tori</ac:title>
            <ac:title xml:lang="fr">Administrateurs</ac:title>
            <ac:title xml:lang="de">Administratoren</ac:title>
            <ac:title xml:lang="hu">AdminisztrÃ¡torok</ac:title>
            <ac:title xml:lang="ca">Administradors</ac:title>
            <ac:title xml:lang="ko">ìš´ì˜ìž</ac:title>
            <ac:title xml:lang="nl">Beheerders</ac:title>
            <ac:title xml:lang="sl">Skrbniki</ac:title>
            <ac:title xml:lang="ro">Administratori</ac:title>
            <ac:title xml:lang="en">Administrators</ac:title>
            <ac:title xml:lang="no">Administratorer</ac:title>
            <ac:title xml:lang="ja">ã‚¢ãƒ‰ãƒŸãƒ‹ã‚¹ãƒˆãƒ¬ãƒ¼ã‚¿ãƒ¼</ac:title>
            <ac:title xml:lang="zh">ç¡ç†å‘˜</ac:title>
            <ac:title xml:lang="th">à¸œà¸¹à¹‰à¸”à¸¹à¹à¸¥à¸£à¸°à¸šà¸š</ac:title>
            <ac:description xml:lang="zh_TW">å¯ä»¥ç·¨è¼¯æ‡‰ç”¨ç¨‹å¼å&apos;ŒæŽ§åˆ¶æˆå“¡è³‡æ ¼ã€‚</ac:description>
            <ac:description xml:lang="ar">ÙŠÙ…ÙƒÙ† ØªØ¹Ø¯ÙŠÙ„ Ø§Ù„ØªØ·Ø¨ÙŠÙ‚ ÙˆØ¹Ø¶ÙˆÙŠØ© Ø§Ù„ØªØÙƒÙ….</ac:description>
            <ac:description xml:lang="es">Pueden editar la aplicaciÃ³n y controlar a los miembros.</ac:description>
            <ac:description xml:lang="el">ÎœÏ€Î¿ÏÎ¿ÏÎ½ Î½Î± Ï„ÏÎ¿Ï€Î¿Ï€Î¿Î¹Î¿ÏÎ½ Ï„Î·Î½ ÎµÏ†Î±ÏÎ¼Î¿Î³Î ÎºÎ±Î¹ Î½Î± Î´Î¹Î±Ï‡ÎµÎ¹ÏÎ¯Î¶Î¿Î½Ï„Î±Î¹ Ï„Î± Î¼ÎÎ»Î· Ï„Î·Ï‚.</ac:description>
            <ac:description xml:lang="it">Possono modificare l'applicazione e controllare l'appartenenza.</ac:description>
            <ac:description xml:lang="fi">Voivat muokata sovellusta ja hallita jÃ¤senyyksiÃ¤.</ac:description>
            <ac:description xml:lang="tr">UygulamayÄ± dÃ¼zenleyebilir ve Ã¼yeliÄŸi denetleyebilirler.</ac:description>
            <ac:description xml:lang="pl">MogÄ… edytowaÄ‡ aplikacjÄ™ i sterowaÄ‡ czÅ‚onkostwem.</ac:description>
            <ac:description xml:lang="uk">ÐœÐ¾Ð¶ÑƒÑ‚ÑŒ Ñ€ÐµÐ´Ð°Ð³ÑƒÐ²Ð°Ñ‚Ð¸ Ð¿Ñ€Ð¸ÐºÐ»Ð°Ð´Ð½Ñƒ Ð¿Ñ€Ð¾Ð³Ñ€Ð°Ð¼Ñƒ Ñ– ÐºÐµÑ€ÑƒÐ²Ð°Ñ‚Ð¸ Ð´Ð¾ÑÑ‚ÑƒÐ¿Ð¾Ð¼ Ð´Ð¾ Ð½ÐµÑ—.</ac:description>
            <ac:description xml:lang="cs">Mohou upravovat aplikaci a Å™Ãdit ÄlenstvÃ.</ac:description>
            <ac:description xml:lang="hr">Mogu ureÄ‘ivati aplikacije i kontrolirati Älanstvo.</ac:description>
            <ac:description xml:lang="pt">Podem editar a aplicaÃ§Ã£o e controlar a filiaÃ§Ã£o.</ac:description>
            <ac:description xml:lang="pt_BR">Ã‰ possÃvel editar o aplicativo e controlar a associaÃ§Ã£o.</ac:description>
            <ac:description xml:lang="iw">×™×›×•×œ×™× ×œ×¢×¨×•×š ××ª ×”×™×™×©×•× ×•×œ×©×œ×•×˜ ×‘×¨×©×™×ž×ª ×”×—×‘×¨×™×.</ac:description>
            <ac:description xml:lang="da">Kan redigere programmet og styre medlemskab.</ac:description>
            <ac:description xml:lang="sv">FÃ¥r Ã¤ndra program och bestÃ¤mma medlemskap.</ac:description>
            <ac:description xml:lang="ru">ÐœÐ¾Ð³ÑƒÑ‚ Ð¸Ð·Ð¼ÐµÐ½ÑÑ‚ÑŒ Ð¿Ñ€Ð¸Ð»Ð¾Ð¶ÐµÐ½Ð¸Ðµ Ð¸ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÑÑ‚ÑŒ Ñ‡Ð»ÐµÐ½ÑÑ‚Ð²Ð¾Ð¼.</ac:description>
            <ac:description xml:lang="sk">MÃ´Å¾u upravovaÅ¥ aplikÃ¡ciu a riadiÅ¥ Älenstvo</ac:description>
            <ac:description xml:lang="fr">Peuvent modifier l'application et contrÃ´ler l'appartenance.</ac:description>
            <ac:description xml:lang="de">Ein Administrator kann die Anwendung bearbeiten und die ZugehÃ¶rigkeit steuern.</ac:description>
            <ac:description xml:lang="hu">Szerkeszthetik az alkalmazÃ¡st Ã©s felÃ¼gyelhetik a tagsÃ¡got.</ac:description>
            <ac:description xml:lang="ca">Poden editar l'aplicaciÃ³ i controlar la pertinenÃ§a.</ac:description>
            <ac:description xml:lang="ko">ì‘ìš©í”„ë¡œê·¸ëž¨ì„ íŽ¸ì§‘í•˜ê³  êµ¬ì„±ì›ì„ ì œì–´í•  ìˆ˜ ìžˆìŠµë‹ˆë‹¤.</ac:description>
            <ac:description xml:lang="nl">Kan de toepassing en het lidmaatschap besturen.</ac:description>
            <ac:description xml:lang="sl">Lahko urejajo aplikacije in nadzorujejo Älanstva.</ac:description>
            <ac:description xml:lang="ro">Se poate edita aplicaÅ£ia ÅŸi controla apartenenÅ£a.</ac:description>
            <ac:description xml:lang="en">Can edit the application and control membership.</ac:description>
            <ac:description xml:lang="no">Kan redigere applikasjonen og kontrollere medlemskap.</ac:description>
            <ac:description xml:lang="ja">ã‚¢ãƒ—ãƒªã‚±ãƒ¼ã‚·ãƒ§ãƒ³ãç·¨é›†ãŠã‚ˆã³ãƒ¡ãƒ³ãƒãƒ¼è³‡æ ¼ãç¡ç†ãŒå¯èƒ½ã€‚</ac:description>
            <ac:description xml:lang="zh">å¯ä»¥ç¼–è¾‘åº”ç”¨ç¨‹åºå¹¶æŽ§åˆ¶æˆå‘˜èµ„æ ¼ã€‚</ac:description>
            <ac:description xml:lang="th">à¸ªà¸²à¸¡à¸²à¸£à¸–à¹à¸à¹‰à¹„à¸‚à¹à¸à¹‡à¸žà¸žà¸¥à¸´à¹€à¸„à¸Šà¸±à¸™à¹à¸¥à¸°à¸„à¸§à¸šà¸„à¸¸à¸¡à¸„à¸§à¸²à¸¡à¹€à¸›à¹‡à¸™à¸ªà¸¡à¸²à¸Šà¸´à¸</ac:description>
         </ac:role>
      </atom:content>
   </atom:entry>
   <atom:entry>
      <atom:id>ai:roles/1C_AESU3F54007AE0IOJUVMU400S0</atom:id>
      <atom:title>Users</atom:title>
      <atom:summary>Can use the application.</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S0"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S0"
         rel="edit" type="application/atom+xml"/>
      <atom:link ac:rel="members" ac:roletype="user"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S0/members"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:28.890Z</atom:updated>
      <atom:content type="application/xml">
         <ac:role ac:id="1C_AESU3F54007AE0IOJUVMU400S0" ac:type="user" xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0">
            <ac:title xml:lang="zh_TW">ä½¿ç”¨è€…</ac:title>
            <ac:title xml:lang="ar">Ø§Ù„Ù…Ø³ØªØØ¯Ù…ÙˆÙ†</ac:title>
            <ac:title xml:lang="es">Usuarios</ac:title>
            <ac:title xml:lang="el">Î§ÏÎÏƒÏ„ÎµÏ‚</ac:title>
            <ac:title xml:lang="it">Utenti</ac:title>
            <ac:title xml:lang="fi">KÃ¤yttÃ¤jÃ¤t</ac:title>
            <ac:title xml:lang="tr">KullanÄ±cÄ±lar</ac:title>
            <ac:title xml:lang="pl">UÅ¼ytkownicy</ac:title>
            <ac:title xml:lang="uk">ÐšÐ¾Ñ€Ð¸ÑÑ‚ÑƒÐ²Ð°Ñ‡Ñ–</ac:title>
            <ac:title xml:lang="cs">UÅ¾ivatelÃ©</ac:title>
            <ac:title xml:lang="hr">Korisnici</ac:title>
            <ac:title xml:lang="pt">Utilizadores</ac:title>
            <ac:title xml:lang="pt_BR">UsuÃ¡rios</ac:title>
            <ac:title xml:lang="iw">×ž×©×ª×ž×©×™×</ac:title>
            <ac:title xml:lang="da">Brugere</ac:title>
            <ac:title xml:lang="sv">AnvÃ¤ndare</ac:title>
            <ac:title xml:lang="ru">ÐŸÐ¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ð¸</ac:title>
            <ac:title xml:lang="sk">UÅ¾Ãvatelia</ac:title>
            <ac:title xml:lang="fr">Utilisateurs</ac:title>
            <ac:title xml:lang="de">Benutzer</ac:title>
            <ac:title xml:lang="hu">FelhasznÃ¡lÃ³k</ac:title>
            <ac:title xml:lang="ca">Usuaris</ac:title>
            <ac:title xml:lang="ko">ì‚¬ìš©ìž</ac:title>
            <ac:title xml:lang="nl">Gebruikers</ac:title>
            <ac:title xml:lang="sl">Uporabniki</ac:title>
            <ac:title xml:lang="ro">Utilizatori</ac:title>
            <ac:title xml:lang="en">Users</ac:title>
            <ac:title xml:lang="no">Brukere</ac:title>
            <ac:title xml:lang="ja">ãƒ¦ãƒ¼ã‚¶ãƒ¼</ac:title>
            <ac:title xml:lang="zh">ç”¨æˆ·</ac:title>
            <ac:title xml:lang="th">à¸œà¸¹à¹‰à¹ƒà¸Šà¹‰</ac:title>
            <ac:description xml:lang="zh_TW">å¯ä»¥ä½¿ç”¨æ‡‰ç”¨ç¨‹å¼ã€‚</ac:description>
            <ac:description xml:lang="ar">ÙŠÙ…ÙƒÙ† Ø§Ø³ØªØØ¯Ø§Ù… Ø§Ù„ØªØ·Ø¨ÙŠÙ‚.</ac:description>
            <ac:description xml:lang="es">Pueden utilizar la aplicaciÃ³n.</ac:description>
            <ac:description xml:lang="el">ÎœÏ€Î¿ÏÎ¿ÏÎ½ Î½Î± Ï‡ÏÎ·ÏƒÎ¹Î¼Î¿Ï€Î¿Î¹Î¿ÏÎ½ Ï„Î·Î½ ÎµÏ†Î±ÏÎ¼Î¿Î³Î.</ac:description>
            <ac:description xml:lang="it">Possono utilizzare l'applicazione.</ac:description>
            <ac:description xml:lang="fi">Voivat kÃ¤yttÃ¤Ã¤ sovellusta.</ac:description>
            <ac:description xml:lang="tr">UygulamayÄ± kullanabilirler.</ac:description>
            <ac:description xml:lang="pl">MogÄ… uÅ¼ywaÄ‡ aplikacji.</ac:description>
            <ac:description xml:lang="uk">ÐœÐ¾Ð¶ÑƒÑ‚ÑŒ Ð¿Ñ€Ð°Ñ†ÑŽÐ²Ð°Ñ‚Ð¸ Ð· Ð¿Ñ€Ð¸ÐºÐ»Ð°Ð´Ð½Ð¾ÑŽ Ð¿Ñ€Ð¾Ð³Ñ€Ð°Ð¼Ð¾ÑŽ.</ac:description>
            <ac:description xml:lang="cs">Mohou pouÅ¾Ãvat aplikaci.</ac:description>
            <ac:description xml:lang="hr">Mogu koristiti aplikacije</ac:description>
            <ac:description xml:lang="pt">Pode utilizar a aplicaÃ§Ã£o.</ac:description>
            <ac:description xml:lang="pt_BR">Ã‰ possÃvel utilizar o aplicativo.</ac:description>
            <ac:description xml:lang="iw">×™×›×•×œ×™× ×œ×”×©×ª×ž×© ×‘×™×™×©×•×.</ac:description>
            <ac:description xml:lang="da">Kan bruge programmet.</ac:description>
            <ac:description xml:lang="sv">FÃ¥r anvÃ¤nda programmet.</ac:description>
            <ac:description xml:lang="ru">ÐœÐ¾Ð³ÑƒÑ‚ Ð¸ÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÑŒ Ð¿Ñ€Ð¸Ð»Ð¾Ð¶ÐµÐ½Ð¸Ðµ.</ac:description>
            <ac:description xml:lang="sk">MÃ´Å¾u pouÅ¾ÃvaÅ¥ aplikÃ¡ciu.</ac:description>
            <ac:description xml:lang="fr">Peuvent utiliser l'application.</ac:description>
            <ac:description xml:lang="de">Ein Benutzer kann die Anwendung verwenden.</ac:description>
            <ac:description xml:lang="hu">HasznÃ¡lhatjÃ¡k az alkalmazÃ¡st.</ac:description>
            <ac:description xml:lang="ca">Poden utilitzar l'aplicaciÃ³.</ac:description>
            <ac:description xml:lang="ko">ì‘ìš©í”„ë¡œê·¸ëž¨ì„ ì‚¬ìš©í•  ìˆ˜ ìžˆìŠµë‹ˆë‹¤.</ac:description>
            <ac:description xml:lang="nl">Kan de toepassing gebruiken.</ac:description>
            <ac:description xml:lang="sl">Lahko uporabljajo aplikacijo.</ac:description>
            <ac:description xml:lang="ro">PuteÅ£i folosi aplicaÅ£ia.</ac:description>
            <ac:description xml:lang="en">Can use the application.</ac:description>
            <ac:description xml:lang="no">Kan bruke applikasjonen.</ac:description>
            <ac:description xml:lang="ja">ã‚¢ãƒ—ãƒªã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã‚&apos;ä½¿ç”¨å¯èƒ½</ac:description>
            <ac:description xml:lang="zh">å¯ä»¥ä½¿ç”¨åº”ç”¨ç¨‹åºã€‚</ac:description>
            <ac:description xml:lang="th">à¸ªà¸²à¸¡à¸²à¸£à¸–à¹ƒà¸Šà¹‰à¹à¸à¹‡à¸žà¸žà¸¥à¸´à¹€à¸„à¸Šà¸±à¸™</ac:description>
         </ac:role>
      </atom:content>
   </atom:entry>
</atom:feed>

Table 2. Get role

Description URL HTTP Method Input Type Return Code Return Type Links Supported URL Parameters
Loads the feed of a role Provided by rel="self" link in entry of application's roles feed GET - HTTP 200 application/atom+xml

ac:rel="members"

Link to member feed for this role.

[resolve-membership]

false: Membership information is not merged into the role feed. (Default)
true: Individual role elements served by this request do contain nested <member> elements for the principals assigned the individual roles.

[rep]

full: Returned role information is represented by <role> elements as defined in ca.xsd. (Default)
compact: Returned role information is represented by <role> elements as defined in ca.xsd without child elements.

Table 2. Get role
Description	URL	HTTP Method	Input Type	Return Code	Return Type	Links	Supported URL Parameters
Loads the feed of a role	Provided by rel="self" link in entry of application's roles feed	GET	-	HTTP 200	application/atom+xml	ac:rel="members" Link to member feed for this role.	[resolve-membership] false: Membership information is not merged into the role feed. (Default) true: Individual role elements served by this request do contain nested <member> elements for the principals assigned the individual roles. [rep] full: Returned role information is represented by <role> elements as defined in ca.xsd. (Default) compact: Returned role information is represented by <role> elements as defined in ca.xsd without child elements.

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/roles/1C_AESU3F54007AE0IOJUVMU400S2"
   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/roles/1C_AESU3F54007AE0IOJUVMU400S2"
      rel="self" type="application/atom+xml"/>
   <atom:id>ai:roles/1C_AESU3F54007AE0IOJUVMU400S2</atom:id>
   <atom:updated>2009-09-25T12:27:29.062Z</atom:updated>
   <atom:entry>
      <atom:id>ai:roles/1C_AESU3F54007AE0IOJUVMU400S2</atom:id>
      <atom:title>Administrators</atom:title>
      <atom:summary>Can edit the application and control membership.</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S2"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S2"
         rel="edit" type="application/atom+xml"/>
      <atom:link ac:rel="members" ac:roletype="manager"
         href="/wps/mycontenthandler/!ut/p/digest!evdYOJkvct_YU87nO10CuQ/ai/roles/1C_AESU3F54007AE0IOJUVMU400S2/members"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:29.046Z</atom:updated>
      <atom:content type="application/xml">
         <ac:role ac:id="1C_AESU3F54007AE0IOJUVMU400S2"
            ac:type="manager" xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0">
            <ac:title xml:lang="zh_TW">ç¡ç†è€…</ac:title>
            <ac:title xml:lang="ar">Ù…ÙˆØ¬Ù‡ÙŠ Ø§Ù„Ù†Ø¸Ø§Ù…</ac:title>
            <ac:title xml:lang="es">Administradores</ac:title>
            <ac:title xml:lang="el">Î”Î¹Î±Ï‡ÎµÎ¹ÏÎ¹ÏƒÏ„ÎÏ‚</ac:title>
            <ac:title xml:lang="it">Amministratori</ac:title>
            <ac:title xml:lang="fi">PÃ¤Ã¤kÃ¤yttÃ¤jÃ¤t</ac:title>
            <ac:title xml:lang="tr">Denetimciler</ac:title>
            <ac:title xml:lang="pl">Administratorzy</ac:title>
            <ac:title xml:lang="uk">ÐÐ´Ð¼Ñ–Ð½Ñ–ÑÑ‚Ñ€Ð°Ñ‚Ð¾Ñ€Ð¸</ac:title>
            <ac:title xml:lang="cs">AdministrÃ¡toÅ™i</ac:title>
            <ac:title xml:lang="hr">Administratori</ac:title>
            <ac:title xml:lang="pt">Administradores</ac:title>
            <ac:title xml:lang="pt_BR">Administradores</ac:title>
            <ac:title xml:lang="iw">×ž× ×”×œ× ×™×</ac:title>
            <ac:title xml:lang="da">Administratorer</ac:title>
            <ac:title xml:lang="sv">AdministratÃ¶rer</ac:title>
            <ac:title xml:lang="ru">ÐÐ´Ð¼Ð¸Ð½Ð¸ÑÑ‚Ñ€Ð°Ñ‚Ð¾Ñ€Ñ‹</ac:title>
            <ac:title xml:lang="sk">AdministrÃ¡tori</ac:title>
            <ac:title xml:lang="fr">Administrateurs</ac:title>
            <ac:title xml:lang="de">Administratoren</ac:title>
            <ac:title xml:lang="hu">AdminisztrÃ¡torok</ac:title>
            <ac:title xml:lang="ca">Administradors</ac:title>
            <ac:title xml:lang="ko">ìš´ì˜ìž</ac:title>
            <ac:title xml:lang="nl">Beheerders</ac:title>
            <ac:title xml:lang="sl">Skrbniki</ac:title>
            <ac:title xml:lang="ro">Administratori</ac:title>
            <ac:title xml:lang="en">Administrators</ac:title>
            <ac:title xml:lang="no">Administratorer</ac:title>
            <ac:title xml:lang="ja">ã‚¢ãƒ‰ãƒŸãƒ‹ã‚¹ãƒˆãƒ¬ãƒ¼ã‚¿ãƒ¼</ac:title>
            <ac:title xml:lang="zh">ç¡ç†å‘˜</ac:title>
            <ac:title xml:lang="th">à¸œà¸¹à¹‰à¸”à¸¹à¹à¸¥à¸£à¸°à¸šà¸š</ac:title>
            <ac:description xml:lang="zh_TW">å¯ä»¥ç·¨è¼¯æ‡‰ç”¨ç¨‹å¼å&apos;ŒæŽ§åˆ¶æˆå“¡è³‡æ ¼ã€‚</ac:description>
            <ac:description xml:lang="ar">ÙŠÙ…ÙƒÙ† ØªØ¹Ø¯ÙŠÙ„ Ø§Ù„ØªØ·Ø¨ÙŠÙ‚ ÙˆØ¹Ø¶ÙˆÙŠØ© Ø§Ù„ØªØÙƒÙ….</ac:description>
            <ac:description xml:lang="es">Pueden editar la aplicaciÃ³n y controlar a los miembros.</ac:description>
            <ac:description xml:lang="el">ÎœÏ€Î¿ÏÎ¿ÏÎ½ Î½Î± Ï„ÏÎ¿Ï€Î¿Ï€Î¿Î¹Î¿ÏÎ½ Ï„Î·Î½ ÎµÏ†Î±ÏÎ¼Î¿Î³Î ÎºÎ±Î¹ Î½Î± Î´Î¹Î±Ï‡ÎµÎ¹ÏÎ¯Î¶Î¿Î½Ï„Î±Î¹ Ï„Î± Î¼ÎÎ»Î· Ï„Î·Ï‚.</ac:description>
            <ac:description xml:lang="it">Possono modificare l'applicazione e controllare l'appartenenza.</ac:description>
            <ac:description xml:lang="fi">Voivat muokata sovellusta ja hallita jÃ¤senyyksiÃ¤.</ac:description>
            <ac:description xml:lang="tr">UygulamayÄ± dÃ¼zenleyebilir ve Ã¼yeliÄŸi denetleyebilirler.</ac:description>
            <ac:description xml:lang="pl">MogÄ… edytowaÄ‡ aplikacjÄ™ i sterowaÄ‡ czÅ‚onkostwem.</ac:description>
            <ac:description xml:lang="uk">ÐœÐ¾Ð¶ÑƒÑ‚ÑŒ Ñ€ÐµÐ´Ð°Ð³ÑƒÐ²Ð°Ñ‚Ð¸ Ð¿Ñ€Ð¸ÐºÐ»Ð°Ð´Ð½Ñƒ Ð¿Ñ€Ð¾Ð³Ñ€Ð°Ð¼Ñƒ Ñ– ÐºÐµÑ€ÑƒÐ²Ð°Ñ‚Ð¸ Ð´Ð¾ÑÑ‚ÑƒÐ¿Ð¾Ð¼ Ð´Ð¾ Ð½ÐµÑ—.</ac:description>
            <ac:description xml:lang="cs">Mohou upravovat aplikaci a Å™Ãdit ÄlenstvÃ.</ac:description>
            <ac:description xml:lang="hr">Mogu ureÄ‘ivati aplikacije i kontrolirati Älanstvo.</ac:description>
            <ac:description xml:lang="pt">Podem editar a aplicaÃ§Ã£o e controlar a filiaÃ§Ã£o.</ac:description>
            <ac:description xml:lang="pt_BR">Ã‰ possÃvel editar o aplicativo e controlar a associaÃ§Ã£o.</ac:description>
            <ac:description xml:lang="iw">×™×›×•×œ×™× ×œ×¢×¨×•×š ××ª ×”×™×™×©×•× ×•×œ×©×œ×•×˜ ×‘×¨×©×™×ž×ª ×”×—×‘×¨×™×.</ac:description>
            <ac:description xml:lang="da">Kan redigere programmet og styre medlemskab.</ac:description>
            <ac:description xml:lang="sv">FÃ¥r Ã¤ndra program och bestÃ¤mma medlemskap.</ac:description>
            <ac:description xml:lang="ru">ÐœÐ¾Ð³ÑƒÑ‚ Ð¸Ð·Ð¼ÐµÐ½ÑÑ‚ÑŒ Ð¿Ñ€Ð¸Ð»Ð¾Ð¶ÐµÐ½Ð¸Ðµ Ð¸ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÑÑ‚ÑŒ Ñ‡Ð»ÐµÐ½ÑÑ‚Ð²Ð¾Ð¼.</ac:description>
            <ac:description xml:lang="sk">MÃ´Å¾u upravovaÅ¥ aplikÃ¡ciu a riadiÅ¥ Älenstvo</ac:description>
            <ac:description xml:lang="fr">Peuvent modifier l'application et contrÃ´ler l'appartenance.</ac:description>
            <ac:description xml:lang="de">Ein Administrator kann die Anwendung bearbeiten und die ZugehÃ¶rigkeit steuern.</ac:description>
            <ac:description xml:lang="hu">Szerkeszthetik az alkalmazÃ¡st Ã©s felÃ¼gyelhetik a tagsÃ¡got.</ac:description>
            <ac:description xml:lang="ca">Poden editar l'aplicaciÃ³ i controlar la pertinenÃ§a.</ac:description>
            <ac:description xml:lang="ko">ì‘ìš©í”„ë¡œê·¸ëž¨ì„ íŽ¸ì§‘í•˜ê³  êµ¬ì„±ì›ì„ ì œì–´í•  ìˆ˜ ìžˆìŠµë‹ˆë‹¤.</ac:description>
            <ac:description xml:lang="nl">Kan de toepassing en het lidmaatschap besturen.</ac:description>
            <ac:description xml:lang="sl">Lahko urejajo aplikacije in nadzorujejo Älanstva.</ac:description>
            <ac:description xml:lang="ro">Se poate edita aplicaÅ£ia ÅŸi controla apartenenÅ£a.</ac:description>
            <ac:description xml:lang="en">Can edit the application and control membership.</ac:description>
            <ac:description xml:lang="no">Kan redigere applikasjonen og kontrollere medlemskap.</ac:description>
            <ac:description xml:lang="ja">ã‚¢ãƒ—ãƒªã‚±ãƒ¼ã‚·ãƒ§ãƒ³ãç·¨é›†ãŠã‚ˆã³ãƒ¡ãƒ³ãƒãƒ¼è³‡æ ¼ãç¡ç†ãŒå¯èƒ½ã€‚</ac:description>
            <ac:description xml:lang="zh">å¯ä»¥ç¼–è¾‘åº”ç”¨ç¨‹åºå¹¶æŽ§åˆ¶æˆå‘˜èµ„æ ¼ã€‚</ac:description>
            <ac:description xml:lang="th">à¸ªà¸²à¸¡à¸²à¸£à¸–à¹à¸à¹‰à¹„à¸‚à¹à¸à¹‡à¸žà¸žà¸¥à¸´à¹€à¸„à¸Šà¸±à¸™à¹à¸¥à¸°à¸„à¸§à¸šà¸„à¸¸à¸¡à¸„à¸§à¸²à¸¡à¹€à¸›à¹‡à¸™à¸ªà¸¡à¸²à¸Šà¸´à¸</ac:description>
         </ac:role>
      </atom:content>
   </atom:entry>
</atom:feed>

Table 3. Add role to an application

Description URL HTTP Method Input Type Return Code Return Type Links Supported URL Parameters
Adds the role to this application. For ActionSet mapping a role-type has to be included as 'creation-context:role-types', supported parameter are: ADMIN, SECURITY_ADMIN, DELEGATOR, MANAGER, EDITOR, CONTRIBUTOR, PRIVILEGED_USER, USER. Optionally: An Object ID of a portal node/page can be given for ActionSet Mapping as 'creation-context:resource-id', default is the application root node. Optionally: If members are already included in the request ATOM they will be set to the created role (for syntax please take a look at Member REST services). Provided by ca:rel="roles" link of application feed.
For example: http://localhost:10040/wps/mycontenthandler/!ut/p/ai/applications/1F_AESU3F540GQL00IOCR30NG08T7/roles
POST application/atom+xml HTTP 201 application/atom+xml

ac:rel="members"

Link to member feed for this role.

rel="first"

Link to the first feed fragment. This link is served only if a feed fragment was served.

rel="last"

Link to the last feed fragment. This link is served only if a feed fragment was served.

rel="previous"

Link to the feed fragment that precedes the given feed fragment.
This link is served only if a feed fragment was served that does not start at the beginning of the feed.

rel="next"

Link to the next feed fragment. This link is served only if a feed fragment was served that does not contain the last entry of the feed.

-

Table 3. Add role to an application
Description	URL	HTTP Method	Input Type	Return Code	Return Type	Links	Supported URL Parameters
Adds the role to this application. For ActionSet mapping a role-type has to be included as 'creation-context:role-types', supported parameter are: ADMIN, SECURITY_ADMIN, DELEGATOR, MANAGER, EDITOR, CONTRIBUTOR, PRIVILEGED_USER, USER. Optionally: An Object ID of a portal node/page can be given for ActionSet Mapping as 'creation-context:resource-id', default is the application root node. Optionally: If members are already included in the request ATOM they will be set to the created role (for syntax please take a look at Member REST services).	Provided by ca:rel="roles" link of application feed. For example: http://localhost:10040/wps/mycontenthandler/!ut/p/ai/applications/1F_AESU3F540GQL00IOCR30NG08T7/roles	POST	application/atom+xml	HTTP 201	application/atom+xml	ac:rel="members" Link to member feed for this role. rel="first" Link to the first feed fragment. This link is served only if a feed fragment was served. rel="last" Link to the last feed fragment. This link is served only if a feed fragment was served. rel="previous" Link to the feed fragment that precedes the given feed fragment. This link is served only if a feed fragment was served that does not start at the beginning of the feed. rel="next" Link to the next feed fragment. This link is served only if a feed fragment was served that does not contain the last entry of the feed.	-

Input data example:

<?xml version="1.0" encoding="UTF-8"?>
<atom:feed xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
    xmlns:app="http://www.w3.org/2007/app" xmlns:xhtml="http://www.w3.org/1999/xhtml"
    xmlns:ca="http://www.ibm.com/xmlns/prod/composite-applications/v1.0"
    xmlns:portal="http://www.ibm.com/xmlns/prod/websphere/portal/v6.0.1/portal-model"
    xmlns:atom="http://www.w3.org/2005/Atom" xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0"
    xml:base="http://localhost:10040/wps/mypoc/!ut/p/ai/applications/1F_AESU3F540GQL00IOCR30NG08T7/roles?digest=wFsBSYzmEGX50hBc6nToYg!!" >
    <atom:entry>
        <atom:title>My special Role</atom:title>
        <atom:summary>My special Role description</atom:summary>
        <atom:content type="application/xml">
            <ac:role xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0"
                ac:type="My special user role again" xmlns:creation-context="http://www.ibm.com/xmlns/prod/websphere/portal/v6.1.0/portal-creation-context" creation-context:role-types="PRIVILEGED_USER">
                <ac:title xml:lang="en">My special Role</ac:title>
                <ac:description xml:lang="en">My special Role description</ac:description>
                <ac:member ac:DN="uid=adam,o=defaultWIMFileBasedRealm" ac:type="user"/>
            </ac:role>
        </atom:content>
    </atom:entry>
</atom:feed>

Return data example:

<?xml version="1.0" encoding="UTF-8"?>
<atom:feed
   xml:base="http://localhost:10040/wps/mypoc/!ut/p/digest!Zt06oJPV3igQXdULHVLCNQ/ai/roles/1C_AESU3F540OUAE0IOF4P56U10P1"
   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!Zt06oJPV3igQXdULHVLCNQ/ai/roles/1C_AESU3F540OUAE0IOF4P56U10P1"
      rel="self" type="application/atom+xml"/>
   <atom:id>ai:roles/1C_AESU3F540OUAE0IOF4P56U10P1</atom:id>
   <atom:updated>2009-09-25T12:27:29.203Z</atom:updated>
   <atom:entry>
      <atom:id>ai:roles/1C_AESU3F540OUAE0IOF4P56U10P1</atom:id>
      <atom:title>My special Role</atom:title>
      <atom:summary>My special Role description</atom:summary>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!Zt06oJPV3igQXdULHVLCNQ/ai/roles/1C_AESU3F540OUAE0IOF4P56U10P1"
         rel="self" type="application/atom+xml"/>
      <atom:link
         href="/wps/mycontenthandler/!ut/p/digest!Zt06oJPV3igQXdULHVLCNQ/ai/roles/1C_AESU3F540OUAE0IOF4P56U10P1"
         rel="edit" type="application/atom+xml"/>
      <atom:link ac:rel="members"
         ac:roletype="My special user role again"
         href="/wps/mycontenthandler/!ut/p/digest!Zt06oJPV3igQXdULHVLCNQ/ai/roles/1C_AESU3F540OUAE0IOF4P56U10P1/members"
         rel="related" type="application/atom+xml"/>
      <atom:updated>2009-09-25T12:27:29.203Z</atom:updated>
      <atom:content type="application/xml">
         <ac:role ac:id="1C_AESU3F540OUAE0IOF4P56U10P1"
            ac:type="My special user role again" xmlns:ac="http://www.ibm.com/xmlns/prod/lotus/access-control/v1.0">
            <ac:title xml:lang="en">My special Role</ac:title>
            <ac:description xml:lang="en">My special Role description</ac:description>
         </ac:role>
      </atom:content>
   </atom:entry>
</atom:feed>

Parent topic:

Composite Applications REST services