REST API - startProcessIncomingReceiveTask
The table summarizes the REST API - startProcessIncomingReceiveTask.
Request
Format | POST <baseurl>/process/start/<modulename>/<processname>/<version> |
Path parameters |
|
Query parameters | responsetype=string: Specifies the type of response data: XML or JSON (the default). |
Body | formalParams element (required if the process has formal parameters): Specifies the page data for the formal parameters associated with the process. Note: You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio. Do not supply a Body element if the process has no formal parameters. |
Example
Request | POST <baseurl>/process/start/%2FWelcomeUsersImplementSolution%2FProcess%20Packages%2FProcessPackage.xpdl/WelcomeUsers_StartEvent/1.0.0 |
Request body | <formalParams payloadMode="XML"> <XmlPayload> <inputs array="false" name="PhoneNumber" optional="false" type="string"> <simpleSpec> <value>378-823-2300</value> </simpleSpec> </inputs> <inputs array="false" name="UserName" optional="false" type="string"> <simpleSpec> <value>Frankie Doodle</value> </simpleSpec> </inputs> </XmlPayload> </formalParams> |
Response | { "xml-fragment": { "@payloadMode": "JSON", "serializedPayload": "{"items":[{"$param":"PhoneNumber","$value":["378-823-2300"],"type":"String","mode":"IN"},{"$param":"UserName","$value":["Frankie Doodle"],"type":"String","mode":"IN"}]}" } } |
Copyright © TIBCO Software Inc. All Rights Reserved.