REST API - updateBusinessService

Request

Format	PUT <baseurl>/businessservice/update/<processid>/<activityid>
Path parameters	processid: Unique identifier of the business service instance. activityid: Unique identifier of the in-progress page activity. processid and activityid can be obtained from the previous startBusinessService or updateBusinessService response. See Displaying a Form in a Business Service for more information.
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: Contains the data to be updated for this page activity, as returned by the form. See Displaying a Form in a Business Service for more information.

Response

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

Example

Request

PUT <baseurl>/businessservice/update/pvm:0a10e/pvm:001ge.4

Request body

<payload payloadMode="JSON"> <serializedPayload>{"items":[{"$param":"UserName","$value":"Harrison","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.201302041238"

            },

            "processReference": {

                "id": "pvm:0a10e",

                "name": "UpdateDetails"

            }

        },

        "pageData": {

            "pageReference": {

                "@activityId": "pvm:001ge.5",

                "@activityModelId": "_M9nZIG6_EeKJYMjI6VIxTg",

                "@activityName": "ShowDetails",

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

                "@moduleVersion": "1.0.0.201302041238",

                "@processName": "UpdateDetails"

            },

            "payload": {

                "@payloadMode": "JSON",

                "serializedPayload": "{\"items\":[{\"$param\":\"UserName\",\"$value\":[\"Harrison\"],\"type\":\"String\",\"mode\":\"INOUT\"}]}"

            }

        }

    }

}