REST API - startBusinessService

Request

Format	POST <baseurl>/businessservice/start/<modulename>/<processname>/<version>
Path parameters	modulename: Name of the module that contains the business service. processname: Name of the business service. version: Version number of the business service. moduleName, processName and version can be obtained by using listBusinessServices .
Query parameters	`responsetype=``string` (optional, default = JSON): Enumerated value defining the format of the data payload to be used in the response message - either XML or JSON.
Body	formalParams element (required if the business service has formal parameters): Specifies the page data for the formal parameters associated with the processname business service. 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 business service has no formal parameters.

Response

JSON	Returns a JSON representation of the contents of a startBusinessServiceResponse element.
XML	Returns the contents of a startBusinessServiceResponse element (from the BusinessService schema)

Example

Request

POST <baseurl>/businessservice/start/%2FRestSample1%2FProcessPackages%2FRestSample1.xpdl/StartClaimProcess/1.0.0.201301031722

Response

{

    "xml-fragment": {

        "@executionState": "IN_PROGRESS",

        "context": {

            "pageFlowTemplate": {

                "@moduleName": "/RestSample1/ProcessPackages/RestSample1.xpdl",

                "@processName": "StartClaimProcess",

                "@version": "1.0.0.201301031722"

            },

            "processReference": {

                "id": "pvm:0a10l",

                "name": "StartClaimProcess"

            }

        },

        "pageData": {

            "pageReference": {

                "@activityId": "pvm:001gl.3",

                "@activityName": "ClaimReceived",

                "@activityModelId": "_Q1Ayo1W_EeKxvfo_dvnJww",

                "@moduleName": "/RestSample1/ProcessPackages/RestSample1.xpdl",

                "@moduleVersion": "1.0.0.201301031722",

                "@processName": "StartClaimProcess"

            },

            "payload": {

                "@payloadMode": "JSON",

                "serializedPayload": "{\"items\":[{\"$param\":\"Datachecked\",\"$value\":[],\"type\":\"Boolean\",\"mode\":\"INOUT\"}]}"

            }

        }

    }

}