Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows

---

 

API Overview

Only a limited set of functions are available when using the IBM^® Workplace Web Content Management™ API.

• Web content libraries:

  • Moving or copying items within a library.

  • Moving or copying items between libraries.

• Sarch iterators of item IDs:

  • Find item of given type by name.

  • Find items of given type.

  • Find library components by name.

  • Find content by authoring template.

  • Find content by category.

  • Find content by path.

  • Find content by workflow stage.

  • Find content modified since date.

  • Find content modified between dates.

• Content search (similar to the Menu Component search criteria but using item parameters as ids).

• Retrieve via item IDs.

• The ability to create, delete and save the following items:

  • Content

  • Sites

  • Site Areas

  • File Resource components

  • HTML components

  • Image components

  • Date and Time components

  • Document Manager components

  • Link components

  • Number components

  • Style Sheet components

  • User Selection components

• The ability to retrieve the following items:

  • Content

  • Sites

  • Site areas

  • Taxonomies and categories

  • Workflows

  • Components

• The ability to retrieve the following items from searches, (but NOT as an item):

  • Authoring Template ID (Authoring Template)

  • Presentation Template ID (Presentation Template)

  • Workflow Stage ID

• The ability to approve or reject content items in a workflow stage. Other item-types do not support this function.

The following features are not available using the API:

• The creation, update or deleting of workflows, workflow stages, workflow actions, taxonomies, categories, syndicators, subscribers, presentation templates, authoring templates, and components not specified above.

The Web Content Management JavaDocs should be reviewed for a complete set of the features available using the API. The Javadoc HTML files are located under the was_profile_root\AppServer\profiles\wp_profile\installedApps\nodename\wcm.ear\ilwwcm.war\webinterface\ folder on your Web Content Management server.

 

API Samples

API samples are installed with the Web Content Management application to assist developers use the Web Content Management API. These are located under the portal_server_root\wcm\samples\Api\src folder on your Web Content Management server.

To use these samples, copy them to the was_profile_root\AppServer\profiles\wp_profile\installedApps\nodename\wcm.ear\ilwwcm.war .

 

Parent topic:

The IBM Workplace Web Content Management API

---