REST API - injectPageFlowEvent

The table summarizes the REST API - injectPageFlowEvent.

Request

Format 
POST <baseurl>/pageflow/inject/<eventname>/<modulename>/<processid>/<processname>
Path parameters
  • eventname: Name of the event to be injected into the pageflow process. Note: You cannot obtain this name programmatically. You must obtain it by examining the process in TIBCO Business Studio.
  • modulename: Name of the module that contains the pageflow process.
  • processid: Unique identifier of the pageflow process instance.
  • processname: Name of the pageflow process.

modulename, processID and processname can be obtained from the previous startPageFlow or updatePageFlow response.
Query parameters responsetype=long (optional, default=JSON): Enumerated value defining the format of the data payload to be used in the response message - either XML or JSON.
Body dataPayload element: Specifies the page data for the formal parameters associated with the eventname event.

Note: You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio.

Response

JSON Returns a JSON representation of the contents of an injectPageFlowResponse element.
XML Returns the contents of an injectPageFlowResponse element (from the PageFlowService schema).

Example

Request 
POST <baseurl>/pageflow/inject/Override/%2FUpdateDetails%2FProcessPackages%2FUpdateDetails.xpdl/pvm%3A0a10i/UpdateDetails
Request body 
<payload payloadMode="JSON"> <serializedPayload>{"items":[{"$param":"UserName","$value":"Catesby","type":"String","mode":"INOUT"}]}</serializedPayload>
    </payload>
Response 
{
    "xml-fragment": {
        "@executionState": "IN_PROGRESS",
        "context": {
            "pageFlowTemplate": {
                "@moduleName": "/UpdateDetails/ProcessPackages/UpdateDetails.xpdl",
                "@processName": "UpdateDetails",
                "@version": "1.0.0.201302041444"
            },
            "processReference": {
                "id": "pvm:0a10i",
                "name": "UpdateDetails"
            }
        },
        "pageData": {
            "payload": {
                "@payloadMode": "JSON",
                "serializedPayload": "{\"items\":[{\"$param\":\"UserName\",\"$value\":[\"Catesby\"],\"type\":\"String\",\"mode\":\"INOUT\"}]}"
            }
        }
    }
}