Composite Applications REST services

Application developers can use Representational State Transfer (REST) services to obtain and modify composite application resources remotely, that is from clients that are outside the Java Virtual Machine (JVM) of the server. These services use feeds that are based on the Atom Syndication Format and on HTTP-based Atom Publishing Protocol (APP) to expose and update resources. With composite applications REST services, use the following HTTP verbs:

• To obtain resources: HTTP GET

• To modify existing resources: HTTP PUT

• To create resources: HTTP POST

• To delete resources: HTTP DELETE

The following resources are supported:

• Templates (Entry Point)

• Template Folders

• Applications (Entry Point)

• Application Folders

• Application-Favorites (Entry Point)

• Roles

• Members

• Virtual Principals

• System Role Types

Use feeds to submit requests

When you access a REST service to get information or to modify a composite applications resource, the response and in some cases also the request works by means of a feed. A feed contains information about one or more resources in a specific format. Learn how to obtain feeds for composite application resources and about the format of such feeds. The following entry points are currently supported:

• 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)

• Template REST services

  Use these REST services to retrieve, export, import, update, move, and delete templates.

• Application REST services

  Use these REST services to get information about applications, export an application for use as a template, instantiate new applications, update an application, or delete an application.

• Application Favorites REST services

  Use these REST services to retrieve application favorites.

• Roles REST services

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

• Members REST services

  Use these REST services to get the members for a particular role, search for members, add members to a role, grant a role to all authenticated users, and remove members from a role.

• REST service examples

  See examples of different service requests that work with composite applications resources.

Parent topic:

Assembling composite applications

Related information

Atom Publishing Protocol (APP)
Atom Syndication Format

---