Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows
Use remote actions
Remote actions are used in the query string of a URL to trigger actions from the IBM® Workplace Web Content Management™ application.
A remote action is triggered using the query string parameter ?wcmAuthoringAction=action, where action is one of the following:
- approve
- This is used to approve an item in a workflow. You must also specify the "docid" of the item.For example:
- ?wcmAuthoringAction=approve&docid=ID1
- ?wcmAuthoringAction=approve&docid=ID1&docid=ID2
- decline
- This is used to decline an item in a workflow. You must also specify the "docid" of the item.For example:
- ?wcmAuthoringAction=decline&docid=ID1
- ?wcmAuthoringAction=decline&docid=ID1&docid=ID2
- delete
- This is used to delete an item. You must also specify the "docid" of the item.For example:
- ?wcmAuthoringAction=delete&docid=ID1
- ?wcmAuthoringAction=delete&docid=ID1&docid=ID2
- edit
- This is used to open an item form in edit mode. You must also specify the "docid" of the item.For example:
- ?wcmAuthoringAction=edit&docid=ID1
- ?wcmAuthoringAction=edit&docid=ID1&docid=ID2
- read
- This is used to open an item form in read-only mode. You must also specify the "docid" of the item.For example:
- ?wcmAuthoringAction=read&docid=ID1
- ?wcmAuthoringAction=read&docid=ID1&docid=ID2
- openmainview
- This is used to open a view within an authoring portlet. You must also specify a "view" parameter.For example:
- ?wcmAuthoringAction=openmainview&view=contentbysitearea
The following view parameters can be used:
- contentbysitearea
- contentbytitle
- myrecentmydraft
- mypendingapproval
- mypublished
- myexpired
- mydeleted
- alldraftitems
- allexpireditems
- allpublisheditems
- alldeleteditems
- componentsbytype
- new
- This is used to open new item form. You must also specify a "type" parameter.For example:
- ?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_Content
The following type parameters can be used:
- com.ibm.workplace.wcm.api.WCM_AuthoringTemplate
- com.ibm.workplace.wcm.api.WCM_Category
- com.ibm.workplace.wcm.api.WCM_Content
- com.ibm.workplace.wcm.api.WCM_FileComponent
- com.ibm.workplace.wcm.api.WCM_HTMLComponent
- com.ibm.workplace.wcm.api.WCM_ImageComponent
- com.ibm.workplace.wcm.api.WCM_LibraryFileComponent
- com.ibm.workplace.wcm.api.WCM_LibraryImageComponent
- com.ibm.workplace.wcm.api.WCM_LibraryHTMLComponent
- com.ibm.workplace.wcm.api.WCM_LibraryDocumentManagerComponent
- com.ibm.workplace.wcm.api.WCM_LibraryDateComponent
- com.ibm.workplace.wcm.api.WCM_LibraryNumericComponent
- com.ibm.workplace.wcm.api.WCM_PresentationTemplate
- com.ibm.workplace.wcm.api.WCM_RichTextComponent
- com.ibm.workplace.wcm.api.WCM_Site
- com.ibm.workplace.wcm.api.WCM_SiteArea
- com.ibm.workplace.wcm.api.WCM_Taxonomy
- com.ibm.workplace.wcm.api.WCM_TextComponent
- com.ibm.workplace.wcm.api.WCM_Workflow
- com.ibm.workplace.wcm.api.WCM_WorkflowStage
When creating a new content item, you can specify a default authoring template by adding the "atid"of an authoring template:
- ?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_Content&atid=ID
When creating site areas, content items and categories, you can add the "pid" of the parent you would like to save the new item under:
- ?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_Content&pid=ID
- ?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_SiteArea&pid=ID
- ?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_Category&pid=ID