REST API - openWorkItem

The table summarizes the REST API - openWorkItem.

Request

Format 
POST <baseurl>/workitem/presentation/open/<id>/<userid>
Path parameters
  • id: ID of the work item to be opened.
  • userid: GUID of the resource that wants to open the work item.
Query parameters
  • channelid=string (optional, default=openspaceGWTPull_DefaultChannel): Identifier of the channel to which the requesting client application is bound.
  • channeltype=string (optional, default=openspaceChannel): Enumerated value defining the channel type (technology) associated with the specified channelid. For a list of available enumerations, see channeltype enumerations.

    See Identifying the Client Channel in a Service Call for more information.

  • version=long (optional, default = -1): Version number of the work item to be opened. If set to -1 or omitted, the latest version of the work item is used.
  • 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.
  • getGlobalValues=boolean (optional, default=false) If you require the values or just the goref itself.

Response

JSON Returns a JSON representation of the contents of a workResponse element.
XML Returns a workResponse element (from the WorkPresentationService schema)

Example

Request 
POST <baseurl>/workitem/presentation/open/51/812935E2-06D5-4504-8621-6E5B901702C4
Response 
{

    "xml-fragment": {

        "payloadModel": {

            "@payloadMode": "JSON",

            "serializedPayload": "{items:[{\"$param\":\"UserName\",\"$value\":[\"Boris Gudenuf\"],\"type\":\"String\",\"mode\":\"IN\"},{\"$param\":\"PhoneNumber\",\"$value\":[\"123\"],\"type\":\"String\",\"mode\":\"IN\"},{\"$param\":\"Message\",\"$value\":[\"Please call Boris Gudenuf at 123.\"],\"type\":\"String\",\"mode\":\"INOUT\"}]}"

        },

        "workTypeDetail": {

            "@uid": "WT__UXUNYCIYEeCnP8eZZTCDGg",

            "@version": "1.0.0.201301111114",

            "@typePiled": "false",

            "@pilingLimit": "0",

            "dataModel": {

                "inputs": [

                    {

                        "@name": "UserName",

                        "@type": "String",

.

.

.

          }

        },

        "presentation": {

            "@type": "FORM"

        },

        "workItem": {

            "@id": "51",

            "@version": "1"

        },

        "pageFlowDetail": {

            "@moduleName": "/WelcomeUsersImplementSolution/Process Packages/ProcessPackage.xpdl",

            "@moduleVersion": "1.0.0.201301111114",

            "@name": "GetInfoFromCustomer",

            "@url": "WelcomeUsersImplementSolution/.bpm/.processOut/pageflow/ProcessPackage.xpdl/GetInfoFromCustomer.bpel",

            "@id": "_djDv4Eq5EeK_uIrE8tUWGA",

            "page-activity": [

                {

                    "@id": "_eYLaAEq5EeK_uIrE8tUWGA",

                    "@name": "Basicinfo",

                    "page-reference": {

                        "@guid": "",

                        "@name": "Basicinfo.gwt.json",

.

.

.

}
Contents
Search Results